SoFieldSensor(3IV)NAMESoFieldSensor (SoFieldSens) - sensor class that can be attached to
Inventor fields
INHERITS FROM
SoSensor > SoDelayQueueSensor > SoDataSensor > SoFieldSensorSYNOPSIS
#include <Inventor_c/sensors/SoFieldSensor.h>
typedef SoFieldSensor SoFieldSens
Functions from class SoFieldSensor:
SoFieldSensor * SoFieldSensCreate()SoFieldSensor * SoFieldSensCreateCB(SoSensorCB *func, void *data)
void SoFieldSensDelete(SoFieldSens *this)
void SoFieldSensAttach(SoFieldSens *this, SoField *field)
void SoFieldSensDetach(SoFieldSens *this)
SoField * SoFieldSensGetAttachedField(const SoFieldSens *this)
Functions from class SoDataSensor:
void SoFieldSensSetDelCB(SoFieldSens *this, SoSensorCB
*function, void *data)
SoNode * SoFieldSensGetTrigNode(const SoFieldSens *this)
SoField * SoFieldSensGetTrigField(const SoFieldSens *this)
SoPath * SoFieldSensGetTrigPath(const SoFieldSens *this)
void SoFieldSensSetTrigPathFlag(SoFieldSens *this, SbBool
flag)
SbBool SoFieldSensGetTrigPathFlag(const SoFieldSens *this)
Functions from class SoDelayQueueSensor:
void SoFieldSensSetPri(SoFieldSens *this, uint32_t pri)
uint32_t SoFieldSensGetPri(SoFieldSens *this)
uint32_t SoFieldSensGetDefaultPriority()
void SoFieldSensSched(SoFieldSens *this)
void SoFieldSensUnsched(SoFieldSens *this)
SbBool SoFieldSensIsSched(SoFieldSens *this)
Functions from class SoSensor:
void SoFieldSensSetFunc(SoFieldSens *this, SoSensorCB
*callbackFunction)
SoSensorCB * SoFieldSensGetFunc(const SoFieldSens *this)
void SoFieldSensSetData(SoFieldSens *this, void
*callbackData)
void * SoFieldSensGetData(const SoFieldSens *this)
Page 1SoFieldSensor(3IV)DESCRIPTION
Field sensors detect changes to fields, calling a callback function
whenever the field changes. The field may be part of a node, an input of
an engine, or a global field.
FUNCTIONSSoFieldSensor * SoFieldSensCreate()SoFieldSensor * SoFieldSensCreateCB(SoSensorCB *func, void *data)
Creation methods. The second method takes the callback function and
data to be called when the sensor is triggered.
void SoFieldSensDelete(SoFieldSens *this)
Destroys the sensor, freeing up any memory associated with it after
unscheduling it.
void SoFieldSensAttach(SoFieldSens *this, SoField *field)
void SoFieldSensDetach(SoFieldSens *this)
SoField * SoFieldSensGetAttachedField(const SoFieldSens *this)
The attach() method makes this sensor detect changes to the given
field. The detach() method unschedules this sensor (if it is
scheduled) and makes it ignore changes to the scene graph. The
getAttachedField() method returns the field that this sensor is
sensing, or NULL if it is not attached to any field.
SEE ALSO
SoNodeSensor, SoPathSensor, SoDataSensor
Page 2