SoNodeSensor Class Reference
Sensor class that can be attached to Inventor nodes. More...
#include <Inventor/sensors/SoNodeSensor.h>
Inheritance diagram for SoNodeSensor:
Public Member Functions | |
| SoNodeSensor () | |
| Creation methods. More... | |
| SoNodeSensor (SoSensorCB *func, void *data) | |
| Creation methods. More... | |
| virtual | ~SoNodeSensor () |
| Destroys the sensor, freeing up any memory associated with it after unscheduling it. More... | |
| void | attach (SoNode *node) |
| Makes this sensor detect changes to the given node. More... | |
| void | detach () |
| Unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph. More... | |
| SoNode * | getAttachedNode () const |
| Returns the node that this sensor is sensing, or NULL if it is not attached to any node. More... | |
 Public Member Functions inherited from SoDataSensor | |
| SoDataSensor () | |
| Constructors. The second form takes standard callback function and data. More... | |
| SoDataSensor (SoSensorCB *func, void *data) | |
| virtual | ~SoDataSensor () |
| Destructor. More... | |
| void | setDeleteCallback (SoSensorCB *f, void *data=NULL) |
| Sets a callback that will be called when the object the sensor is sensing is deleted. More... | |
| SoNode * | getTriggerNode () const |
| If this is a priority 0 data sensor, returns the node/field that was modified that caused this sensor to trigger. More... | |
| SoField * | getTriggerField () const |
| Like getTriggerNode(), but returns the field that started notification (NULL if the sensor isn't priority 0 or if notification didn't start at a field). More... | |
| SoPath * | getTriggerPath () const |
| Returns the path from the node to which this sensor is attached down to the child node that changed. More... | |
| void | setTriggerPathFlag (bool flag) |
| bool | getTriggerPathFlag () const |
| virtual void | unschedule () |
| Override unschedule() to reset trigNode and trigPath. More... | |
| virtual void | trigger () |
| Override trigger to reset trigNode and trigPath, if necessary. More... | |
| virtual void | notify (SoNotList *list) |
| Propagates modification notification through an instance. More... | |
| Public Member Functions inherited from SoDelayQueueSensor | |
| SoDelayQueueSensor () | |
| Constructors. The second form takes standard callback function and data. More... | |
| SoDelayQueueSensor (SoSensorCB *func, void *data) | |
| virtual | ~SoDelayQueueSensor () |
| Destructor. More... | |
| void | setPriority (uint32_t pri) |
| Sets the priority of the sensor. More... | |
| uint32_t | getPriority () const |
| Gets the priority of the sensor. More... | |
| 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. More... | |
| virtual bool | isScheduled () const |
| Returns TRUE if this sensor has been scheduled and is waiting in the delay queue to be triggered. More... | |
| virtual bool | 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). More... | |
| void | setCounter (uint32_t c) |
| Set/inquire counter when sensor was last triggered. More... | |
| uint32_t | getCounter () const |
| Public Member Functions inherited from SoSensor | |
| SoSensor () | |
| Constructors. The second form takes callback function and data. More... | |
| SoSensor (SoSensorCB *f, void *d) | |
| virtual | ~SoSensor () |
| Virtual destructor so that subclasses are deleted properly. More... | |
| void | setFunction (SoSensorCB *f) |
| Sets the callback function that is called when the sensor is triggered. More... | |
| void | setData (void *d) |
| Sets the callback data passed to the callback function. More... | |
| SoSensorCB * | getFunction () const |
| Returns the callback function that will be called when the sensor is triggered. More... | |
| void * | getData () const |
| Returns the user-supplied pointer that will be passed to the callback function. More... | |
| void | setNextInQueue (SoSensor *next) |
| Sets/returns the next sensor in whichever queue the sensor is in. More... | |
| SoSensor * | getNextInQueue () const |
Additional Inherited Members | |
| Static Public Member Functions inherited from SoDelayQueueSensor | |
| static uint32_t | getDefaultPriority () |
| Returns the default delay queue sensor priority, which is 100. More... | |
| Static Public Member Functions inherited from SoSensor | |
| static void | initClass () |
| Initialize static members, etc. More... | |
| Protected Member Functions inherited from SoDataSensor | |
| void | invokeDeleteCallback () |
| Invokes the delete callback. More... | |
| Protected Attributes inherited from SoDelayQueueSensor | |
| bool | scheduled |
| Whether sensor is scheduled. More... | |
| Protected Attributes inherited from SoSensor | |
| SoSensorCB * | func |
| Callback function. More... | |
| void * | funcData |
| Data to pass to callback. More... | |
Detailed Description
Node sensors detect changes to nodes, calling a callback function whenever any field of the node or, if the node is a group node, any children of the node change.
- See Also
Definition at line 77 of file SoNodeSensor.h.
Constructor & Destructor Documentation
◆ SoNodeSensor() [1/2]
| SoNodeSensor::SoNodeSensor | ( | ) |
The second method takes the callback function and data to be called when the sensor is triggered.
◆ SoNodeSensor() [2/2]
| SoNodeSensor::SoNodeSensor | ( | SoSensorCB * | func, |
| void * | data | ||
| ) |
The second method takes the callback function and data to be called when the sensor is triggered.
◆ ~SoNodeSensor()
|
virtual |
Member Function Documentation
◆ attach()
| void SoNodeSensor::attach | ( | SoNode * | node | ) |
◆ detach()
| void SoNodeSensor::detach | ( | ) |
◆ getAttachedNode()
|
inline |
Definition at line 102 of file SoNodeSensor.h.
The documentation for this class was generated from the following file:
- /home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/sensors/SoNodeSensor.h
