Open Inventor Reference
SoIdleSensor Class Reference

Sensor for one-time only callbacks when the application is idle. More...

#include <Inventor/sensors/SoIdleSensor.h>

Inheritance diagram for SoIdleSensor:
SoDelayQueueSensor SoSensor

List of all members.

Public Member Functions

 SoIdleSensor ()
 Creation methods.
 SoIdleSensor (SoSensorCB *func, void *data)
 Creation methods.
virtual ~SoIdleSensor ()
 Destroys the sensor, freeing up any memory associated with it after unscheduling it.

Detailed Description

An idle sensor is almost exactly like an SoOneShotSensor, except that it is only triggered when there are no timer queue sensors waiting to be triggered and there are no events waiting to be processed; that is, idle sensors will not be triggered if the delay queue is processed because the delay queue timeout expires. If the delay queue timeout is disabled (see SoDB::setDelaySensorTimeout().), idle and one-shot sensors are exactly the same.

Note that idle sensors do not reschedule themselves. Inventor 1 idle sensors were always scheduled; call schedule() in the callback function to duplicate that behavior.

See the SoOneShotSensor manual page for more information.

See Also
SoOneShotSensor, SoDelayQueueSensor

Definition at line 91 of file SoIdleSensor.h.


Constructor & Destructor Documentation

SoIdleSensor::SoIdleSensor ( )

The second method takes the callback function and data to be called when the sensor is triggered.

SoIdleSensor::SoIdleSensor ( SoSensorCB func,
void *  data 
)

The second method takes the callback function and data to be called when the sensor is triggered.

virtual SoIdleSensor::~SoIdleSensor ( ) [virtual]

The documentation for this class was generated from the following file: