SoIdleSensor(3IV)

NAME
     SoIdleSensor (SoIdleSens) - sensor for one-time only callbacks when the
     application is idle

INHERITS FROM
     SoSensor > SoDelayQueueSensor > SoIdleSensor

SYNOPSIS
     #include <Inventor_c/sensors/SoIdleSensor.h>

     typedef SoIdleSensor  SoIdleSens

          Functions from class SoIdleSensor:

     SoIdleSensor *      SoIdleSensCreate()
     SoIdleSensor *      SoIdleSensCreateCB(SoSensorCB *func, void *data)
     void                SoIdleSensDelete(SoIdleSens *this)

          Functions from class SoDelayQueueSensor:

     void                SoIdleSensSetPri(SoIdleSens *this, uint32_t pri)
     uint32_t            SoIdleSensGetPri(SoIdleSens *this)
     uint32_t            SoIdleSensGetDefaultPriority()
     void                SoIdleSensSched(SoIdleSens *this)
     void                SoIdleSensUnsched(SoIdleSens *this)
     SbBool              SoIdleSensIsSched(SoIdleSens *this)

          Functions from class SoSensor:

     void                SoIdleSensSetFunc(SoIdleSens *this, SoSensorCB
                              *callbackFunction)
     SoSensorCB *        SoIdleSensGetFunc(const SoIdleSens *this)
     void                SoIdleSensSetData(SoIdleSens *this, void
                              *callbackData)
     void *              SoIdleSensGetData(const SoIdleSens *this)


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
     SoDBSetDelaySensorTimeout().), 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.
FUNCTIONS
     SoIdleSensor *      SoIdleSensCreate()
     SoIdleSensor *      SoIdleSensCreateCB(SoSensorCB *func, void *data)
          Creation methods. The second method takes the callback function and
          data to be called when the sensor is triggered.

     void                SoIdleSensDelete(SoIdleSens *this)
          Destroys the sensor, freeing up any memory associated with it after
          unscheduling it.


SEE ALSO
     SoOneShotSensor, SoDelayQueueSensor