1SoTimerQueueSensor(3IV)()                            SoTimerQueueSensor(3IV)()
2
3
4

NAME

6       SoTimerQueueSensor — abstract base class for sensors dependent on time
7

INHERITS FROM

9       SoSensor > SoTimerQueueSensor
10

SYNOPSIS

12       #include <Inventor/sensors/SoTimerQueueSensor.h>
13
14          Methods from class SoTimerQueueSensor:
15
16     const SbTime &      getTriggerTime()
17     virtual void        schedule()
18     virtual void        unschedule()
19     virtual SbBool      isScheduled()
20
21          Methods from class SoSensor:
22
23     void                setFunction(SoSensorCB *callbackFunction)
24     SoSensorCB *        getFunction() const
25     void                setData(void *callbackData)
26     void *              getData() const
27
28

DESCRIPTION

30       Timer  queue  sensors  are  sensors that trigger themselves at specific
31       times. The timer queue is normally processed as part of a programs main
32       loop  when the program is not busy doing something else. Note that pro‐
33       cessing the timer queue is not asynchronous — the program must re-enter
34       its  main loop for timers to be triggered. When the timer queue is pro‐
35       cessed, all timers scheduled to go off at or before  the  current  time
36       are triggered once, in order from earliest to latest.
37

METHODS

39     const SbTime &      getTriggerTime()
40          Returns  the time at which this sensor is scheduled to be triggered.
41          If the sensor is not scheduled the results are undefined.
42
43     virtual void        schedule()
44          Adds this sensor to the timer queue. Subclasses provide methods  for
45          setting when the sensor will be triggered.
46
47     virtual void        unschedule()
48          If this sensor is scheduled, removes it from the timer queue so that
49          it will not be triggered.
50
51     virtual SbBool      isScheduled()
52          Returns TRUE if this sensor has been scheduled and is waiting in the
53          timer queue to be triggered.
54
55

SEE ALSO

57       SoTimerSensor, SoAlarmSensor, SoIdleSensor, SoOneShotSensor, SoDataSen‐
58       sor
59
60
61
62
63                                                     SoTimerQueueSensor(3IV)()