SoPathSensor(3IV)NAMESoPathSensor (SoPathSens) - sensor class that can be attached to Inventor
paths
INHERITS FROM
SoSensor > SoDelayQueueSensor > SoDataSensor > SoPathSensorSYNOPSIS
#include <Inventor_c/sensors/SoPathSensor.h>
typedef SoPathSensor SoPathSens
Functions from class SoPathSensor:
SoPathSensor * SoPathSensCreate()SoPathSensor * SoPathSensCreateCB(SoSensorCB *func, void *data)
void SoPathSensDelete(SoPathSens *this)
void SoPathSensAttach(SoPathSens *this, SoPath *path)
void SoPathSensDetach(SoPathSens *this)
SoPath * SoPathSensGetAttachedPath(const SoPathSens *this)
Functions from class SoDataSensor:
void SoPathSensSetDelCB(SoPathSens *this, SoSensorCB
*function, void *data)
SoNode * SoPathSensGetTrigNode(const SoPathSens *this)
SoField * SoPathSensGetTrigField(const SoPathSens *this)
SoPath * SoPathSensGetTrigPath(const SoPathSens *this)
void SoPathSensSetTrigPathFlag(SoPathSens *this, SbBool
flag)
SbBool SoPathSensGetTrigPathFlag(const SoPathSens *this)
Functions from class SoDelayQueueSensor:
void SoPathSensSetPri(SoPathSens *this, uint32_t pri)
uint32_t SoPathSensGetPri(SoPathSens *this)
uint32_t SoPathSensGetDefaultPriority()
void SoPathSensSched(SoPathSens *this)
void SoPathSensUnsched(SoPathSens *this)
SbBool SoPathSensIsSched(SoPathSens *this)
Functions from class SoSensor:
void SoPathSensSetFunc(SoPathSens *this, SoSensorCB
*callbackFunction)
SoSensorCB * SoPathSensGetFunc(const SoPathSens *this)
void SoPathSensSetData(SoPathSens *this, void
*callbackData)
void * SoPathSensGetData(const SoPathSens *this)
Page 1SoPathSensor(3IV)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 - 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.
FUNCTIONSSoPathSensor * SoPathSensCreate()SoPathSensor * SoPathSensCreateCB(SoSensorCB *func, void *data)
Creation methods. The second method takes the callback function and
data to be called when the sensor is triggered.
void SoPathSensDelete(SoPathSens *this)
Destroys the sensor, freeing up any memory associated with it after
unscheduling it.
void SoPathSensAttach(SoPathSens *this, SoPath *path)
void SoPathSensDetach(SoPathSens *this)
SoPath * SoPathSensGetAttachedPath(const SoPathSens *this)
The attach() method makes this sensor detect changes to the given
path. The detach() method unschedules this sensor (if it is
scheduled) and makes it ignore changes to the scene graph. The
getAttachedPath() method returns the path that this sensor is
sensing, or NULL if it is not attached to any path.
SEE ALSO
SoNodeSensor, SoPathSensor, SoDataSensor
Page 2