Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
SoDelayQueueSensor Class Reference

Abstract base class for sensors not dependent on time. More...

#include <Inventor/sensors/SoDelayQueueSensor.h>

+ Inheritance diagram for SoDelayQueueSensor:

Public Member Functions

 SoDelayQueueSensor ()
 Constructor.
 
 SoDelayQueueSensor (SoSensorCB *func, void *data)
 Constructor that takes standard callback and data.
 
void setPriority (uint32_t pri)
 Sets the priority of the sensor.
 
uint32_t getPriority () const
 Gets the priority of the sensor.
 
virtual void schedule ()
 If this sensor's priority is non-zero, adds this sensor to the list of delay queue sensors ready to be triggered.
 
virtual void unschedule ()
 If this sensor is scheduled, removes it from the delay queue so that it will not be triggered.
 
virtual SbBool isIdleOnly () const
 
- Public Member Functions inherited from SoSensor
 SoSensor ()
 Constructor.
 
 SoSensor (SoSensorCB *f, void *d)
 Constructor that takes standard callback function and data.
 
void setFunction (SoSensorCB *f, void *userData)
 
void setFunction (SoSensorCB *f)
 Sets the callback function that is called when the sensor is triggered.
 
void setData (void *d)
 Sets the callback data passed to the callback function.
 
SoSensorCBgetFunction () const
 Returns the callback that will be called when the sensor is triggered.
 
void * getData () const
 Returns the user-supplied pointer that will be passed to the callback function.
 
virtual SbBool isScheduled () const
 Returns TRUE if this sensor has been scheduled and is waiting in a sensor queue to be triggered.
 

Static Public Member Functions

static uint32_t getDefaultPriority ()
 Returns the default delay queue sensor priority, which is 100.
 

Additional Inherited Members

- Public Types inherited from SoSensor
typedef void SoSensorCB(void *data, SoSensor *sensor)
 This typedef defines the calling sequence for all callbacks from sensors.
 

Detailed Description

Abstract base class for sensors not dependent on time.

Delay queue sensors are separate from timer queue sensors (see SoTimerQueueSensor) and provide methods for setting the relative priorities of the sensors in the delay queue (sensors with higher priorities will be triggered first).

Sensors with non-zero priorities are added to the delay queue when scheduled, and are all processed once, in order, when the delay queue is processed, which normally happens as part of your program's main loop (see SoWin::mainLoop() or SoDB::doSelect()). Typically, the delay queue is processed whenever there are no events waiting to be distributed and there are no timer queue sensors waiting to be triggered. The delay queue also has a timeout to ensure that delay queue sensors are triggered even if there are always events or timer sensors waiting; see SoDB::setDelaySensorTimeout().

Sensors with priority 0 are treated specially. Priority 0 sensors are triggered almost immediately after they are scheduled, before the program returns to the main loop. Priority 0 sensors are not necessarily triggered immediately when they are scheduled, however; if they are scheduled as part of the evaluation of a field connection network they may not be triggered until the evaluation of the network is complete. Also, if a priority 0 sensor is scheduled within the callback method of another priority 0 sensor, it will not be triggered until the callback method is complete (also note that if more than one priority 0 sensor is scheduled, the order in which they fire is undefined).

SEE ALSO

SoTimerQueueSensor, SoDataSensor, SoFieldSensor, SoIdleSensor, SoOneShotSensor, SoNodeSensor, SoPathSensor

Definition at line 106 of file SoDelayQueueSensor.h.

Constructor & Destructor Documentation

◆ SoDelayQueueSensor() [1/2]

SoDelayQueueSensor::SoDelayQueueSensor ( )

Constructor.

◆ SoDelayQueueSensor() [2/2]

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

Constructor that takes standard callback and data.

Member Function Documentation

◆ getDefaultPriority()

static uint32_t SoDelayQueueSensor::getDefaultPriority ( )
inlinestatic

Returns the default delay queue sensor priority, which is 100.

Definition at line 141 of file SoDelayQueueSensor.h.

◆ getPriority()

uint32_t SoDelayQueueSensor::getPriority ( ) const
inline

Gets the priority of the sensor.

Definition at line 135 of file SoDelayQueueSensor.h.

◆ isIdleOnly()

virtual SbBool SoDelayQueueSensor::isIdleOnly ( ) const
virtual

◆ schedule()

virtual void SoDelayQueueSensor::schedule ( )
virtual

If this sensor's priority is non-zero, adds this sensor to the list of delay queue sensors ready to be triggered.

This is a way of making a sensor fire without changing the thing it is sensing.

Calling schedule() within the callback function causes the sensor to be called repeatedly. Because sensors are processed only once every time the delay queue is processed (even if they reschedule themselves), timers and events will still be processed. This should not be done with a priority zero sensor because an infinite loop will result.

Implements SoSensor.

◆ setPriority()

void SoDelayQueueSensor::setPriority ( uint32_t  pri)

Sets the priority of the sensor.

Priorities can be changed at any time; if the priority is changed to zero and it is already scheduled, the sensor is immediately triggered and removed from the queue.

◆ unschedule()

virtual void SoDelayQueueSensor::unschedule ( )
virtual

If this sensor is scheduled, removes it from the delay queue so that it will not be triggered.

Implements SoSensor.

Reimplemented in SoDataSensor.


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