1SoIdleSensor(3IV)()                                        SoIdleSensor(3IV)()
2
3
4

NAME

6       SoIdleSensor  — sensor for one-time only callbacks when the application
7       is idle
8

INHERITS FROM

10       SoSensor > SoDelayQueueSensor > SoIdleSensor
11

SYNOPSIS

13       #include <Inventor/sensors/SoIdleSensor.h>
14
15          Methods from class SoIdleSensor:
16
17                         SoIdleSensor()
18                         SoIdleSensor(SoSensorCB *func, void *data)
19                         ~SoIdleSensor()
20
21          Methods from class SoDelayQueueSensor:
22
23     void                setPriority(uint32_t pri)
24     uint32_t            getPriority()
25     static uint32_t     getDefaultPriority()
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       An idle sensor is almost exactly like an SoOneShotSensor,  except  that
40       it  is  only triggered when there are no timer queue sensors waiting to
41       be triggered and there are no events waiting to be processed; that  is,
42       idle  sensors  will  not  be  triggered if the delay queue is processed
43       because the delay queue timeout expires. If the delay queue timeout  is
44       disabled  (see  SoDB::setDelaySensorTimeout().), idle and one-shot sen‐
45       sors are exactly the same.
46
47       Note that idle sensors do not reschedule themselves.  Inventor  1  idle
48       sensors were always scheduled; call schedule() in the callback function
49       to duplicate that behavior.
50
51       See the SoOneShotSensor manual page for more information.
52

METHODS

54                         SoIdleSensor()
55                         SoIdleSensor(SoSensorCB *func, void *data)
56          Creation methods. The second method takes the callback function  and
57          data to be called when the sensor is triggered.
58
59                         ~SoIdleSensor()
60          Destroys  the sensor, freeing up any memory associated with it after
61          unscheduling it.
62
63

SEE ALSO

65       SoOneShotSensor, SoDelayQueueSensor
66
67
68
69
70                                                           SoIdleSensor(3IV)()