table of contents
other sections
SoDelayQueueSensor(3IV)() | SoDelayQueueSensor(3IV)() |
NAME¶
SoDelayQueueSensor — abstract base class for sensors not dependent on timeINHERITS FROM¶
SoSensor > SoDelayQueueSensorSYNOPSIS¶
#include <Inventor/sensors/SoDelayQueueSensor.h>Methods from class SoDelayQueueSensor:
void setPriority(uint32_t pri)
uint32_t getPriority()
static uint32_t getDefaultPriority()
virtual void schedule()
virtual void unschedule()
virtual SbBool isScheduled()
Methods from class SoSensor:
void setFunction(SoSensorCB *callbackFunction)
SoSensorCB * getFunction() const
void setData(void *callbackData)
void * getData() const
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).METHODS¶
void setPriority(uint32_t pri)
uint32_t getPriority()
Sets/gets 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.
static uint32_t getDefaultPriority()
Returns the default delay queue sensor priority, which is 100.
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. This is a way of making a sensor fire without changing the thing it is sensing.
virtual void unschedule()
If this sensor is scheduled, removes it from the delay queue so that it will not be triggered.
virtual SbBool isScheduled()
Returns TRUE if this sensor has been scheduled and is waiting in the delay queue to be triggered. Sensors are removed from the queue before their callback function is triggered.