SoDelayQueueSensor Class Reference
[Sensors]

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

#include <Inventor/sensors/SoDelayQueueSensor.h>

Inheritance diagram for SoDelayQueueSensor:
SoSensor SoDataSensor SoIdleSensor SoOneShotSensor SoFieldSensor SoNodeSensor SoPathSensor

List of all members.

Public Member Functions

 SoDelayQueueSensor ()
 SoDelayQueueSensor (SoSensorCB *func, void *data)
void setPriority (uint32_t pri)
uint32_t getPriority () const
virtual void schedule ()
virtual void unschedule ()
virtual SbBool isIdleOnly () const

Static Public Member Functions

static uint32_t getDefaultPriority ()

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


Constructor & Destructor Documentation

SoDelayQueueSensor::SoDelayQueueSensor (  ) 

Constructor.

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

Constructor that takes standard callback and data.


Member Function Documentation

static uint32_t SoDelayQueueSensor::getDefaultPriority (  )  [inline, static]

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

uint32_t SoDelayQueueSensor::getPriority (  )  const [inline]

Gets the priority of the sensor.

virtual SbBool SoDelayQueueSensor::isIdleOnly (  )  const [virtual]
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.

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.

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:

Open Inventor Toolkit reference manual, generated on 18 Apr 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/