SoTimerQueueSensor(3IV)NAMESoTimerQueueSensor (SoTimerQSens) - abstract base class for sensors
dependent on time
INHERITS FROM
SoSensor > SoTimerQueueSensorSYNOPSIS
#include <Inventor_c/sensors/SoTimerQueueSensor.h>
typedef SoTimerQueueSensor SoTimerQSens
Functions from class SoTimerQueueSensor:
const SbTime * SoTimerQSensGetTrigTime(SoTimerQSens *this)
void SoTimerQSensSched(SoTimerQSens *this)
void SoTimerQSensUnsched(SoTimerQSens *this)
SbBool SoTimerQSensIsSched(SoTimerQSens *this)
Functions from class SoSensor:
void SoTimerQSensSetFunc(SoTimerQSens *this, SoSensorCB
*callbackFunction)
SoSensorCB * SoTimerQSensGetFunc(const SoTimerQSens *this)
void SoTimerQSensSetData(SoTimerQSens *this, void
*callbackData)
void * SoTimerQSensGetData(const SoTimerQSens *this)
DESCRIPTION
Timer queue sensors are sensors that trigger themselves at specific
times. The timer queue is normally processed as part of a programs main
loop when the program is not busy doing something else. Note that
processing the timer queue is not asynchronous - the program must re-
enter its main loop for timers to be triggered. When the timer queue is
processed, all timers scheduled to go off at or before the current time
are triggered once, in order from earliest to latest.
FUNCTIONS
const SbTime * SoTimerQSensGetTrigTime(SoTimerQSens *this)
Returns the time at which this sensor is scheduled to be triggered.
If the sensor is not scheduled the results are undefined.
void SoTimerQSensSched(SoTimerQSens *this)
Adds this sensor to the timer queue. Subclasses provide methods for
setting when the sensor will be triggered.
void SoTimerQSensUnsched(SoTimerQSens *this)
If this sensor is scheduled, removes it from the timer queue so that
it will not be triggered.
Page 1SoTimerQueueSensor(3IV)
SbBool SoTimerQSensIsSched(SoTimerQSens *this)
Returns TRUE if this sensor has been scheduled and is waiting in the
timer queue to be triggered.
SEE ALSO
SoTimerSensor, SoAlarmSensor, SoIdleSensor, SoOneShotSensor, SoDataSensor
Page 2