1SoAlarmSensor(3IV)()                                      SoAlarmSensor(3IV)()
2
3
4

NAME

6       SoAlarmSensor — triggers a callback once sometime in the future
7

INHERITS FROM

9       SoSensor > SoTimerQueueSensor > SoAlarmSensor
10

SYNOPSIS

12       #include <Inventor/sensors/SoAlarmSensor.h>
13
14          Methods from class SoAlarmSensor:
15
16                         SoAlarmSensor()
17                         SoAlarmSensor(SoSensorCB *func, void *data)
18                         ~SoAlarmSensor()
19     void                setTime(const SbTime &absTime)
20     void                setTimeFromNow(const SbTime &relTime)
21     const SbTime &      getTime() const
22
23          Methods from class SoTimerQueueSensor:
24
25     const SbTime &      getTriggerTime()
26     virtual void        schedule()
27     virtual void        unschedule()
28     virtual SbBool      isScheduled()
29
30          Methods from class SoSensor:
31
32     void                setFunction(SoSensorCB *callbackFunction)
33     SoSensorCB *        getFunction() const
34     void                setData(void *callbackData)
35     void *              getData() const
36
37

DESCRIPTION

39       This  type  of  sensor  can be used to schedule a one-time callback for
40       some time in the future. The sensor is not guaranteed to be  called  at
41       exactly  that  time,  but  will  be called sometime after the specified
42       time.
43

METHODS

45                         SoAlarmSensor()
46                         SoAlarmSensor(SoSensorCB *func, void *data)
47          Creation methods. The second method takes the callback function  and
48          data to be called when the sensor is triggered.
49
50                         ~SoAlarmSensor()
51          Destroys  the sensor, freeing up any memory associated with it after
52          unscheduling it.
53
54     void                setTime(const SbTime &absTime)
55          Sets the sensor to go off at the specified time. You must also  call
56          schedule()  for the sensor to be triggered. If the sensor is already
57          scheduled, it must be  unscheduled  and  then  rescheduled  for  the
58          change in the trigger time to take effect.
59
60     void                setTimeFromNow(const SbTime &relTime)
61          Sets  the  sensor  to  go off the given amount of time from now. You
62          must also call schedule() for the sensor to  be  triggered.  If  the
63          sensor  is  already  scheduled,  it  must  be  unscheduled  and then
64          rescheduled for the change in the trigger time to take effect.
65
66     const SbTime &      getTime() const
67          Returns the time at which the sensor is set to be triggered. This is
68          similar  to  the getTriggerTime method, but returns the time even if
69          the sensor has not yet been scheduled.
70
71

SEE ALSO

73       SoOneShotSensor, SoTimerSensor, SoTimerQueueSensor, SbTime
74
75
76
77
78                                                          SoAlarmSensor(3IV)()
Impressum