man SoFieldSensor () - sensor class that can be attached to Inventor fields

NAME

SoFieldSensor - sensor class that can be attached to Inventor fields

INHERITS FROM

SoSensor > SoDelayQueueSensor > SoDataSensor > SoFieldSensor

SYNOPSIS

#include <Inventor/sensors/SoFieldSensor.h> Methods from class SoFieldSensor: c } c } SoFieldSensor()

c } c } SoFieldSensor(SoSensorCB *func, void *data)

c } c } ~SoFieldSensor()

c } c } attach(SoField *field)

c } c } detach()

c } c } getAttachedField() const Methods from class SoDataSensor: c } c } setDeleteCallback(SoSensorCB *function, void *data)

c } c } getTriggerNode() const

c } c } getTriggerField() const

c } c } getTriggerPath() const

c } c } setTriggerPathFlag(SbBool flag)

c } c } getTriggerPathFlag() const Methods from class SoDelayQueueSensor: c } c } setPriority(uint32_t pri)

c } c } getPriority()

c } c } getDefaultPriority()

c } c } schedule()

c } c } unschedule()

c } c } isScheduled() Methods from class SoSensor: c } c } setFunction(SoSensorCB *callbackFunction)

c } c } getFunction() const

c } c } setData(void *callbackData)

c } c } getData() const

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.

METHODS

c } c } SoFieldSensor()

c } c } SoFieldSensor(SoSensorCB *func, void *data)

Creation methods. The second method takes the callback function and data to be called when the sensor is triggered. c } c } ~SoFieldSensor()

Destroys the sensor, freeing up any memory associated with it after unscheduling it. c } c } attach(SoField *field)

c } c } detach()

c } c } getAttachedField() const

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