sensors(3) [debian man page]
Sensor Classes(3) Coin Sensor Classes(3) NAME
Sensor Classes - Classes class SoAlarmSensor The SoAlarmSensor class is a sensor which will trigger once at a specified time. SoAlarmSensor provides a convenient way of setting up triggers for jobs which should be executed only once when they are scheduled. " class SoDataSensor The SoDataSensor class is the abstract base class for sensors monitoring changes in a scene graph. If you need to know when a particular entity (as a field or a node) changes, subclasses of SoDataSensor can be used to monitor the entity and notify you when it changes. " class SoDelayQueueSensor The SoDelayQueueSensor class is the abstract base class for priority scheduled sensors. Delay queue sensors are invoked upon various events not related to time occurrences. See documentation of subclasses to see which types of events can be surveilled by the builtin sensor types. " class SoFieldSensor The SoFieldSensor class detects changes to a field. Attach a field to a sensor of this type to put it under surveillance, so you can act upon changes to the field. " class SoIdleSensor The SoIdleSensor class is a sensor which will trigger as soon as the application is idle. An SoIdleSensor differs from an SoOneShotSensor in that it will not trigger if the delay queue processing is occurring due to the delay queue timeout, but only when the application is idle. " class SoNodeSensor The SoNodeSensor class detects changes to nodes. Attach a node to a sensor of this type to put it under surveillance, so you can act upon changes to the node. " class SoOneShotSensor The SoOneShotSensor class is a sensor which will trigger once. Since SoOneShotSensor is a subclass of SoDelayQueueSensor, it will trigger as soon as either the run-time system is idle, or if it is continually busy it will trigger within a fixed amount of time (this is by default 1/12th of a second, see SoSensorManager::setDelaySensorTimeout()). " class SoPathSensor The SoPathSensor class detects changes to paths. If you need to know when a path changes (i.e. nodes in the path has been removed, or new nodes is added), use this sensor to get a notification. " class SoSensor The SoSensor class is the abstract base class for all sensors. Sensors is a mechanism in Coin for scheduling jobs to be run upon specific events. The events in question could be particular points in time, or changes to entities in the scene graph. " class SoSensorManager The SoSensorManager class handles the sensor queues. There are two major sensor types in Coin, 'delay' sensors and 'timer' sensors: " class SoTimerQueueSensor The SoTimerQueueSensor class is the abstract base class for sensors triggering on certain timer events. Timer sensors triggers upon specific points in time. " class SoTimerSensor The SoTimerSensor class is a sensor which will trigger at given intervals. Use sensors of this class when you want a job repeated at a certain interval, without explicitly needing to reschedule the sensor (i.e. SoTimerSensor automatically re-schedules itself after it has been triggered). " Detailed Description Sensors are objects that monitor other objects for changes and invoke callbacks when changes occur. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 Sensor Classes(3)
Check Out this Related Man Page
SoDelayQueueSensor(3) Coin SoDelayQueueSensor(3) NAME
SoDelayQueueSensor - The SoDelayQueueSensor class is the abstract base class for priority scheduled sensors. Delay queue sensors are invoked upon various events not related to time occurrences. See documentation of subclasses to see which types of events can be surveilled by the builtin sensor types. SYNOPSIS
#include <Inventor/sensors/SoDelayQueueSensor.h> Inherits SoSensor. Inherited by SoDataSensor, SoIdleSensor, and SoOneShotSensor. 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 Detailed Description The SoDelayQueueSensor class is the abstract base class for priority scheduled sensors. Delay queue sensors are invoked upon various events not related to time occurrences. 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. The queue of delay sensors (i.e. instances of subclasses of SoDelayQueueSensor) will be processed as soon as either the run-time system is idle, or if it is continually busy they will be processed within a fixed amount of time. This time interval is by default 1/12th of a second, but can be controlled with the SoSensorManager::setDelaySensorTimeout() interface. Constructor &; Destructor Documentation 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. See also: setFunction(), setData() SoDelayQueueSensor::~SoDelayQueueSensor (void) [virtual] Destructor. Member Function Documentation void SoDelayQueueSensor::setPriority (uint32_tpri) Set this sensor's priority in the scheduling queue. When sensors are processed, high priority sensors will trigger before low priority sensors. Please note that a low number means a high priority. A sensor with priority 5 will trigger before a sensor with priority 6. Sensors with priority 0 have a special meaning in Coin/Inventor. They are called immediate sensors, and will trigger immediately after the current notification chain has finished. Priority 0 sensors should be used with care, since they might lead to bad performance if you do some processing in the sensor callback. This setting does not affect SoDataSensor delete-callback invocations, which always are immediate. See also: getPriority(), getDefaultPriority() uint32_t SoDelayQueueSensor::getPriority (void) const Returns sensor scheduling priority. See also: setPriority(), getDefaultPriority() uint32_t SoDelayQueueSensor::getDefaultPriority (void) [static] Returns the default scheduling priority value. The default sensor priority is 100. See also: getPriority() 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. See also: SoDB::setDelaySensorTimeout(), unschedule(), isScheduled() Implements SoSensor. void SoDelayQueueSensor::unschedule (void) [virtual] Remove sensor from the delay queue, without triggering it first. See also: schedule(), isScheduled() Implements SoSensor. SbBool SoDelayQueueSensor::isScheduled (void) const [virtual] Check if this sensor is scheduled for triggering. See also: schedule(), unschedule() 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. See also: SoDB::setDelaySensorTimeout() void SoDelayQueueSensor::trigger (void) [virtual] Trigger the sensor's callback function. Reimplemented from SoSensor. Reimplemented in SoDataSensor, and SoFieldSensor. Member Data Documentation SbBool SoDelayQueueSensor::scheduled [protected] TRUE if the sensor is currently scheduled. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoDelayQueueSensor(3)