SoPathSensor Class Reference
[Sensors]
Sensor class that can be attached to Open Inventor paths. More...
#include <Inventor/sensors/SoPathSensor.h>
Public Member Functions | |
| SoPathSensor () | |
| SoPathSensor (SoSensorCB *func, void *data) | |
| virtual | ~SoPathSensor () |
| void | attach (SoPath *path) |
| void | detach () |
| SoPath * | getAttachedPath () const |
Detailed Description
Sensor class that can be attached to Open Inventor paths.
Path sensors detect changes to paths, calling a callback function whenever the path or any node in the path changes.
The definition of "in the path" is the same as the definition used when applying an action to the path - any node that can possibly affect the node at the end of the path chain is considered in the path. See the SoPath manual page for more information on paths.
See SoDataSensor for general information and code example.
SEE ALSO
SoNodeSensor, SoPathSensor, SoDataSensor
Constructor & Destructor Documentation
| SoPathSensor::SoPathSensor | ( | ) |
Default constructor.
| SoPathSensor::SoPathSensor | ( | SoSensorCB * | func, | |
| void * | data | |||
| ) |
Constructor that takes the callback function and data to be called when the sensor is triggered.
| virtual SoPathSensor::~SoPathSensor | ( | ) | [virtual] |
Destroys the sensor, freeing up any memory associated with it after unscheduling it.
Member Function Documentation
| void SoPathSensor::attach | ( | SoPath * | path | ) |
Makes this sensor detect changes to the given path.
| void SoPathSensor::detach | ( | ) |
Unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph.
| SoPath* SoPathSensor::getAttachedPath | ( | ) | const [inline] |
Returns the path that this sensor is sensing, or NULL if it is not attached to any path.
The documentation for this class was generated from the following file:
- Inventor/sensors/SoPathSensor.h