MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/sensors/SoSensorManager.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */


/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Manager for scheduling and triggering sensors. The manager
 |      maintains a queue of delay sensors (derived from SoDelayQueueSensor)
 |      and timer sensors (derived from SoTimerQueueSensor).
 |
 |   Classes
 |      SoSensorManager
 |
 |   Author(s)          : Nick Thompson, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_SENSOR_MANAGER_
#define  _SO_SENSOR_MANAGER_

#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbTime.h>

class SoSensor;
class SoDelayQueueSensor;
class SoTimerQueueSensor;
class SoTimerSensor;
class SoAlarmSensor;

SoINTERNAL class INVENTOR_API SoSensorManager {
  public:

    SoSensorManager();
    ~SoSensorManager();

    void                setChangedCallback(void (*func)(void *), void *data)
        { changedFunc = func; changedFuncData = data; }

    void                insertDelaySensor(SoDelayQueueSensor *s);
    void                insertTimerSensor(SoTimerQueueSensor *s);
    void                removeDelaySensor(SoDelayQueueSensor *s);
    void                removeTimerSensor(SoTimerQueueSensor *s);

    void                rescheduleTimer(SoTimerSensor *s);
    void                removeRescheduledTimer(SoTimerQueueSensor *s);

    void                setDelaySensorTimeout(const SbTime &t);
    const SbTime        &getDelaySensorTimeout();

    void                processDelayQueue(SbBool isIdle);

    void                processImmediateQueue();

    void                processTimerQueue();

    SbBool              isDelaySensorPending()
                                { return (delayQueue != NULL); }

    SbBool              isTimerSensorPending(SbTime &tm);

    int                 doSelect(int nfds, fd_set *readfds, fd_set *writefds,
                                 fd_set *exceptfds,
                                 struct timeval *userTimeOut);
  private:
    SoSensor            *delayQueue;    
    SoSensor            *timerQueue;    
    SoSensor            *rescheduleQueue;

    SbTime              delayQTimeout;
    SoAlarmSensor       *delayQTimeoutSensor;
    static void         delayQTimeoutCB(void *, SoSensor *);

    int                 processingQueue;

    uint32_t            delayQCount;    

    void                insert(SoSensor *s, SoSensor *&head);
    void                remove(SoSensor *s, SoSensor *&head);

    void                (*changedFunc)(void *);
    void                *changedFuncData;

    void                notifyChanged();
};

#endif /* _SO_SENSOR_MANAGER_ */