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

#include <Inventor/sensors/SoFieldSensor.h>

Inheritance diagram for SoFieldSensor:

Public Member Functions
	SoFieldSensor ()
	Creation methods.

	SoFieldSensor (SoSensorCB func, void data)
	Creation methods.

virtual	~SoFieldSensor ()
	Destroys the sensor, freeing up any memory associated with it after unscheduling it.

void	attach (SoField *field)
	Makes this sensor detect changes to the given field.

void	detach ()
	Unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph.

SoField *	getAttachedField () const
	Returns the field that this sensor is sensing, or NULL if it is not attached to any field.

virtual void	trigger ()
	Override trigger to evaluate the field we're connected to, just in case the trigger method doesn't get the value.

Public Member Functions inherited from SoDataSensor
	SoDataSensor ()
	Constructors. The second form takes standard callback function and data.

	SoDataSensor (SoSensorCB func, void data)

virtual	~SoDataSensor ()
	Destructor.

void	setDeleteCallback (SoSensorCB f, void data=NULL)
	Sets a callback that will be called when the object the sensor is sensing is deleted.

SoNode *	getTriggerNode () const
	If this is a priority 0 data sensor, returns the node/field that was modified that caused this sensor to trigger.

SoField *	getTriggerField () const
	Like getTriggerNode(), but returns the field that started notification (NULL if the sensor isn't priority 0 or if notification didn't start at a field).

SoPath *	getTriggerPath () const
	Returns the path from the node to which this sensor is attached down to the child node that changed.

void	setTriggerPathFlag (bool flag)

bool	getTriggerPathFlag () const

virtual void	unschedule ()
	Override unschedule() to reset trigNode and trigPath.

virtual void	trigger ()
	Override trigger to reset trigNode and trigPath, if necessary.

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

virtual void	dyingReference ()=0
	This is called when the base (path, field, node, whatever) is deleted.

Public Member Functions inherited from SoDelayQueueSensor
	SoDelayQueueSensor ()
	Constructors. The second form takes standard callback function and data.

	SoDelayQueueSensor (SoSensorCB func, void data)

virtual	~SoDelayQueueSensor ()
	Destructor.

void	setPriority (uint32_t pri)
	Sets the priority of the sensor.

uint32_t	getPriority () const
	Gets the priority of the sensor.

virtual void	schedule ()
	If this sensor's priority is non-zero, adds this sensor to the list of delay queue sensors ready to be triggered.

virtual void	unschedule ()
	If this sensor is scheduled, removes it from the delay queue so that it will not be triggered.

virtual bool	isScheduled () const
	Returns TRUE if this sensor has been scheduled and is waiting in the delay queue to be triggered.

virtual bool	isIdleOnly () const
	This method is overriden by IdleSensors to tell sensor manager that they should only be processed when there really is idle time (and not when the delay queue timeout expires).

void	setCounter (uint32_t c)
	Set/inquire counter when sensor was last triggered.

uint32_t	getCounter () const

Public Member Functions inherited from SoSensor
	SoSensor ()
	Constructors. The second form takes callback function and data.

	SoSensor (SoSensorCB f, void d)

virtual	~SoSensor ()
	Virtual destructor so that subclasses are deleted properly.

void	setFunction (SoSensorCB *f)
	Sets the callback function that is called when the sensor is triggered.

void	setData (void *d)
	Sets the callback data passed to the callback function.

SoSensorCB *	getFunction () const
	Returns the callback function that will be called when the sensor is triggered.

void *	getData () const
	Returns the user-supplied pointer that will be passed to the callback function.

virtual void	schedule ()=0
	Schedules the sensor for triggering at the appropriate time.

virtual void	unschedule ()=0
	Unschedules sensor to keep it from being triggered.

virtual bool	isScheduled () const =0
	Returns whether the sensor is scheduled.

virtual void	trigger ()
	Triggers the sensor, calling its callback function.

virtual bool	isBefore (const SoSensor *s) const =0
	This returns TRUE if this sensor should precede sensor s in whichever queue this sensor would be in.

void	setNextInQueue (SoSensor *next)
	Sets/returns the next sensor in whichever queue the sensor is in.

SoSensor *	getNextInQueue () const

Additional Inherited Members
Static Public Member Functions inherited from SoDelayQueueSensor
static uint32_t	getDefaultPriority ()
	Returns the default delay queue sensor priority, which is 100.

Static Public Member Functions inherited from SoSensor
static void	initClass ()
	Initialize static members, etc.

Protected Member Functions inherited from SoDataSensor
void	invokeDeleteCallback ()
	Invokes the delete callback.

virtual void	trigger ()
	Triggers the sensor, calling its callback function.

Protected Attributes inherited from SoDelayQueueSensor
bool	scheduled
	Whether sensor is scheduled.

Protected Attributes inherited from SoSensor
SoSensorCB *	func
	Callback function.

void *	funcData
	Data to pass to callback.

Detailed 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.

See Also

: SoNodeSensor, SoPathSensor, SoDataSensor

Definition at line 80 of file SoFieldSensor.h.

Constructor & Destructor Documentation

◆ SoFieldSensor() [1/2]

SoFieldSensor::SoFieldSensor ( )

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

◆ SoFieldSensor() [2/2]

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

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

◆ ~SoFieldSensor()

virtual SoFieldSensor::~SoFieldSensor ( )

virtual

Member Function Documentation

◆ attach()

void SoFieldSensor::attach ( SoField * field )

Referenced by SoCreateFieldSensor().

◆ detach()

void SoFieldSensor::detach ( )

◆ getAttachedField()

SoField * SoFieldSensor::getAttachedField ( ) const

inline

Definition at line 105 of file SoFieldSensor.h.

Referenced by SoFieldSensorCallback::call().

◆ trigger()

virtual void SoFieldSensor::trigger ( )