#include <Inventor/sensors/SoDelayQueueSensor.h>
Public Member Functions | |
SoDelayQueueSensor (void) | |
SoDelayQueueSensor (SoSensorCB *func, void *data) | |
virtual | ~SoDelayQueueSensor (void) |
void | setPriority (uint32_t pri) |
uint32_t | getPriority (void) const |
virtual void | schedule (void) |
virtual void | unschedule (void) |
virtual SbBool | isScheduled (void) const |
virtual SbBool | isIdleOnly (void) const |
virtual void | trigger (void) |
Static Public Member Functions | |
static uint32_t | getDefaultPriority (void) |
Protected Attributes | |
SbBool | scheduled |
Delay queue sensors are invoked upon various events not related to time occurs. See documentation of subclasses to see which types of events can be surveilled by the builtin sensor types.
The priority values can be used to queue events by their importance, so the sensors are triggered in the sequence you want.
SoDelayQueueSensor::SoDelayQueueSensor | ( | void | ) |
Default constructor.
SoDelayQueueSensor::SoDelayQueueSensor | ( | SoSensorCB * | func, | |
void * | data | |||
) |
Constructor taking as arguments the sensor callback function and the userdata which will be passed the callback.
SoDelayQueueSensor::~SoDelayQueueSensor | ( | void | ) | [virtual] |
Destructor.
void SoDelayQueueSensor::setPriority | ( | uint32_t | pri | ) |
uint32_t SoDelayQueueSensor::getPriority | ( | void | ) | const |
uint32_t SoDelayQueueSensor::getDefaultPriority | ( | void | ) | [static] |
void SoDelayQueueSensor::schedule | ( | void | ) | [virtual] |
Put the sensor in the global delay queue. This means it will be triggered either when the CPU is idle, or when the specified delay queue time-out is reached.
Implements SoSensor.
void SoDelayQueueSensor::unschedule | ( | void | ) | [virtual] |
Remove sensor from the delay queue, without triggering it first.
Implements SoSensor.
SbBool SoDelayQueueSensor::isScheduled | ( | void | ) | const [virtual] |
Check if this sensor is scheduled for triggering.
Implements SoSensor.
SbBool SoDelayQueueSensor::isIdleOnly | ( | void | ) | const [virtual] |
Returns a flag indicating whether or not the sensor should only be triggered if the application is truly idle, and not when the delay queue is processed because of the delay queue timeout.
void SoDelayQueueSensor::trigger | ( | void | ) | [virtual] |
Trigger the sensor's callback function.
Reimplemented from SoSensor.
Reimplemented in SoDataSensor, and SoFieldSensor.
SbBool SoDelayQueueSensor::scheduled [protected] |
TRUE
if the sensor is currently scheduled.