#include <Inventor/sensors/SoDataSensor.h>
Inheritance diagram for SoDataSensor::
Public Methods | |
SoDataSensor (void) | |
SoDataSensor (SoSensorCB *func, void *data) | |
virtual | ~SoDataSensor (void) |
void | setDeleteCallback (SoSensorCB *function, void *data=NULL) |
SoNode * | getTriggerNode (void) const |
SoField * | getTriggerField (void) const |
SoPath * | getTriggerPath (void) const |
void | setTriggerPathFlag (SbBool flag) |
SbBool | getTriggerPathFlag (void) const |
virtual void | trigger (void) |
virtual void | notify (SoNotList *l) |
virtual void | dyingReference (void)=0 |
Protected Methods | |
void | invokeDeleteCallback (void) |
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.
|
Default constructor. |
|
Constructor taking as parameters the sensor callback function and the userdata which will be passed the callback.
|
|
Destructor. |
|
If an object monitored by a data sensor is deleted, the given callback function will be called with the given userdata. |
|
Returns a pointer to the node causing the sensor to trigger, or
The result is only valid within the scope of a trigger(), so if you need to use the pointer outside your sensor callback, you must store it.
|
|
Returns a pointer to the field causing the sensor to trigger, or
Only valid for immediate sensors (will return The result is only valid within the scope of a trigger(), so if you need to use the pointer outside your sensor callback, you must store it. |
|
Returns a pointer to the path from the node under the surveillance of this sensor (either directly or indirectly through a field watch) down to the node which caused the sensor to be triggered. Will only work for immediate mode sensors, for the same reason explained under getTriggerNode(). The resulting path is only valid within the scope of trigger(), so if you need to use the path outside your sensor callback, you must store the pointer and call SoPath::ref() to avoid its destruction at the end of SoDataSensor::trigger(). |
|
This flag indicates whether or not the path should be queried whenever a node triggers the data sensor. This flag is provided because finding a node path through a scene graph is an expensive operation.
|
|
Returns whether or not any node induced trigger operations will make the sensor find the path of the node which caused it.
|
|
Overloaded to clear scheduled flag before triggering. Reimplemented from SoDelayQueueSensor. Reimplemented in SoFieldSensor. |
|
Called from entity we are monitoring when it changes. If this is an immediate sensor, the field and node (if any) causing the change will be stored and can be fetched by getTriggerField() and getTriggerNode(). If the triggerpath flag has been set, the path down to the node is also found and stored for later retrieval by getTriggerPath().
Reimplemented in SoPathSensor. |
|
This method is called when the entity we are connected to is about to be deleted. |
|
Runs the callback set in setDeleteCallback(). Called from subclasses when the entity we're monitoring is about to be deleted. |