Open Inventor Reference
SoPathSensor Class Reference

Sensor class that can be attached to Inventor paths. More...

#include <Inventor/sensors/SoPathSensor.h>

Inheritance diagram for SoPathSensor:
SoDataSensor SoDelayQueueSensor SoSensor

List of all members.

Public Member Functions

 SoPathSensor ()
 Creation methods.
 SoPathSensor (SoSensorCB *func, void *data)
 Creation methods.
virtual ~SoPathSensor ()
 Destroys the sensor, freeing up any memory associated with it after unscheduling it.
void attach (SoPath *path)
 Makes this sensor detect changes to the given path.
void detach ()
 Unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph.
SoPathgetAttachedPath () const
 Returns the path that this sensor is sensing, or NULL if it is not attached to any path.

Protected Member Functions

void notify (SoNotList *list)
 Propagates modification notification through an instance.

Detailed Description

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 em 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 Also
SoNodeSensor, SoPathSensor, SoDataSensor

Definition at line 81 of file SoPathSensor.h.


Constructor & Destructor Documentation

SoPathSensor::SoPathSensor ( )

The second method takes the callback function and data to be called when the sensor is triggered.

SoPathSensor::SoPathSensor ( SoSensorCB func,
void *  data 
)

The second method takes the callback function and data to be called when the sensor is triggered.

virtual SoPathSensor::~SoPathSensor ( ) [virtual]

Member Function Documentation

void SoPathSensor::attach ( SoPath path)
void SoPathSensor::detach ( )
SoPath* SoPathSensor::getAttachedPath ( ) const [inline]

Definition at line 106 of file SoPathSensor.h.

void SoPathSensor::notify ( SoNotList list) [protected, virtual]

By default, this schedules the sensor to be triggered and saves some information from the notification list for use by the callback function. Called by SoBase.

Reimplemented from SoDataSensor.


The documentation for this class was generated from the following file: