Abstract base class for sensors not dependent on time. More...
#include <Inventor/sensors/SoDelayQueueSensor.h>
Public Member Functions | |
| SoDelayQueueSensor () | |
| Constructors. The second form takes standard callback function and data. | |
| SoDelayQueueSensor (SoSensorCB *func, void *data) | |
| virtual | ~SoDelayQueueSensor () |
| Destructor. | |
| 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 | isScheduled () const |
| Returns TRUE if this sensor has been scheduled and is waiting in the delay queue to be triggered. | |
| virtual SbBool | isIdleOnly () const |
| This method is overriden by IdleSensors to tell sensor manager that they should only be processed when there really is idle time (and not when the delay queue timeout expires). | |
| void | setCounter (uint32_t c) |
| Set/inquire counter when sensor was last triggered. | |
| uint32_t | getCounter () const |
Static Public Member Functions | |
| static uint32_t | getDefaultPriority () |
| Returns the default delay queue sensor priority, which is 100. | |
Protected Member Functions | |
| virtual void | trigger () |
| Triggers the sensor, calling its callback function. | |
Protected Attributes | |
| SbBool | scheduled |
| Whether sensor is scheduled. | |
Detailed Description
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. 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, SoSensorManager
Definition at line 110 of file SoDelayQueueSensor.h.
Constructor & Destructor Documentation
| SoDelayQueueSensor::SoDelayQueueSensor | ( | ) |
| SoDelayQueueSensor::SoDelayQueueSensor | ( | SoSensorCB * | func, |
| void * | data | ||
| ) |
| virtual SoDelayQueueSensor::~SoDelayQueueSensor | ( | ) | [virtual] |
Member Function Documentation
| uint32_t SoDelayQueueSensor::getCounter | ( | ) | const [inline] |
Definition at line 161 of file SoDelayQueueSensor.h.
| static uint32_t SoDelayQueueSensor::getDefaultPriority | ( | ) | [inline, static] |
Definition at line 129 of file SoDelayQueueSensor.h.
| uint32_t SoDelayQueueSensor::getPriority | ( | ) | const [inline] |
Definition at line 126 of file SoDelayQueueSensor.h.
| virtual SbBool SoDelayQueueSensor::isIdleOnly | ( | ) | const [virtual] |
| virtual SbBool SoDelayQueueSensor::isScheduled | ( | ) | const [virtual] |
Sensors are removed from the queue before their callback function is triggered.
Implements SoSensor.
| virtual void SoDelayQueueSensor::schedule | ( | ) | [virtual] |
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::setCounter | ( | uint32_t | c | ) | [inline] |
This allows the sensor manager to avoid triggering a sensor more than once during the same call to processDelayQueue().
Definition at line 160 of file SoDelayQueueSensor.h.
| void SoDelayQueueSensor::setPriority | ( | uint32_t | pri | ) |
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::trigger | ( | ) | [protected, virtual] |
This overrides the method in SoSensor because it has to reset the schedule flag before triggering.
Reimplemented from SoSensor.
Reimplemented in SoDataSensor, and SoFieldSensor.
| virtual void SoDelayQueueSensor::unschedule | ( | ) | [virtual] |
Implements SoSensor.
Reimplemented in SoDataSensor.
Member Data Documentation
SbBool SoDelayQueueSensor::scheduled [protected] |
Definition at line 169 of file SoDelayQueueSensor.h.
The documentation for this class was generated from the following file:
- MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/sensors/SoDelayQueueSensor.h
