Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | List of all members
SoFieldSensor Class Reference

The SoFieldSensor class detects changes to a field.Attach a field to a sensor of this type to put it under surveillance, so you can act upon changes to the field. More...

#include <Inventor/sensors/SoFieldSensor.h>

Inheritance diagram for SoFieldSensor:
SoDataSensor SoDelayQueueSensor SoSensor

Public Member Functions

 SoFieldSensor (void)
 
 SoFieldSensor (SoSensorCB *func, void *data)
 
virtual ~SoFieldSensor (void)
 
void attach (SoField *field)
 
void detach (void)
 
SoFieldgetAttachedField (void) const
 
virtual void trigger (void)
 
- Public Member Functions inherited from SoDataSensor
 SoDataSensor (void)
 
 SoDataSensor (SoSensorCB *func, void *data)
 
virtual ~SoDataSensor (void)
 
void setDeleteCallback (SoSensorCB *function, void *data=NULL)
 
SoNodegetTriggerNode (void) const
 
SoFieldgetTriggerField (void) const
 
SoPathgetTriggerPath (void) const
 
void setTriggerPathFlag (SbBool flag)
 
SbBool getTriggerPathFlag (void) const
 
- Public Member Functions inherited from SoDelayQueueSensor
 SoDelayQueueSensor (void)
 
 SoDelayQueueSensor (SoSensorCB *func, void *data)
 
virtual ~SoDelayQueueSensor (void)
 
void setPriority (uint32_t pri)
 
uint32_t getPriority (void) const
 
virtual void schedule (void)
 
virtual void unschedule (void)
 
virtual SbBool isScheduled (void) const
 
virtual SbBool isIdleOnly (void) const
 
- Public Member Functions inherited from SoSensor
 SoSensor (void)
 
 SoSensor (SoSensorCB *func, void *data)
 
virtual ~SoSensor (void)
 
void setFunction (SoSensorCB *callbackfunction)
 
SoSensorCBPtr getFunction (void) const
 
void setData (void *callbackdata)
 
void * getData (void) const
 
void setNextInQueue (SoSensor *next)
 
SoSensorgetNextInQueue (void) const
 

Additional Inherited Members

- Static Public Member Functions inherited from SoDelayQueueSensor
static uint32_t getDefaultPriority (void)
 
- Static Public Member Functions inherited from SoSensor
static void initClass (void)
 
- Protected Member Functions inherited from SoDataSensor
void invokeDeleteCallback (void)
 
- Protected Attributes inherited from SoDelayQueueSensor
SbBool scheduled
 
- Protected Attributes inherited from SoSensor
SoSensorCB * func
 
void * funcData
 

Detailed Description

The SoFieldSensor class detects changes to a field.

Attach a field to a sensor of this type to put it under surveillance, so you can act upon changes to the field.

Constructor & Destructor Documentation

◆ SoFieldSensor() [1/2]

SoFieldSensor::SoFieldSensor ( void  )

Constructor.

◆ SoFieldSensor() [2/2]

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

Constructor taking as parameters the sensor callback function and the userdata which will be passed the callback.

See also
setFunction(), setData()

◆ ~SoFieldSensor()

SoFieldSensor::~SoFieldSensor ( void  )
virtual

Destructor.

References detach().

Member Function Documentation

◆ attach()

void SoFieldSensor::attach ( SoField field)

Attach sensor to a field. Whenever the field's value changes, the sensor will be triggered and call the callback function.

A field sensor can be attached to only a single field at a time. When this method is invoked multiple times, each subsequent call will replace the field the sensor is monitoring with the new field.

See also
detach()

References SoField::addAuditor(), detach(), and SoField::evaluate().

Referenced by SoTransformManip::attachSensors(), SoFile::copyContents(), SoFile::readInstance(), SoTexture3::readInstance(), SoImage::readInstance(), SoPointLightDragger::setUpConnections(), SoRotateDiscDragger::setUpConnections(), SoDirectionalLightDragger::setUpConnections(), SoTranslate1Dragger::setUpConnections(), SoScale1Dragger::setUpConnections(), SoScale2Dragger::setUpConnections(), SoScaleUniformDragger::setUpConnections(), SoScale2UniformDragger::setUpConnections(), SoJackDragger::setUpConnections(), SoRotateCylindricalDragger::setUpConnections(), SoTranslate2Dragger::setUpConnections(), SoRotateSphericalDragger::setUpConnections(), SoSpotLightDragger::setUpConnections(), SoTabBoxDragger::setUpConnections(), SoCenterballDragger::setUpConnections(), SoTabPlaneDragger::setUpConnections(), SoTrackballDragger::setUpConnections(), SoTransformBoxDragger::setUpConnections(), SoDragPointDragger::setUpConnections(), SoHandleBoxDragger::setUpConnections(), SoTransformerDragger::setUpConnections(), SoFile::SoFile(), SoImage::SoImage(), SoTexture3::SoTexture3(), SoCenterballDragger::transferCenterDraggerMotion(), SoPointLightDragger::valueChangedCB(), SoDirectionalLightDragger::valueChangedCB(), SoJackDragger::valueChangedCB(), SoRotateDiscDragger::valueChangedCB(), SoScale1Dragger::valueChangedCB(), SoScale2Dragger::valueChangedCB(), SoTranslate1Dragger::valueChangedCB(), SoScaleUniformDragger::valueChangedCB(), SoScale2UniformDragger::valueChangedCB(), SoTranslate2Dragger::valueChangedCB(), SoRotateCylindricalDragger::valueChangedCB(), SoRotateSphericalDragger::valueChangedCB(), SoSpotLightDragger::valueChangedCB(), SoTabBoxDragger::valueChangedCB(), SoCenterballDragger::valueChangedCB(), SoTransformBoxDragger::valueChangedCB(), SoTrackballDragger::valueChangedCB(), SoDragPointDragger::valueChangedCB(), SoHandleBoxDragger::valueChangedCB(), and SoTransformerDragger::valueChangedCB().

◆ detach()

void SoFieldSensor::detach ( void  )

Detach sensor from field. As long as an SoFieldSensor is detached, it will never call its callback function.

See also
attach()

References SoDelayQueueSensor::isScheduled(), SoField::removeAuditor(), and SoDelayQueueSensor::unschedule().

Referenced by attach(), SoTransformManip::attachSensors(), SoFile::copyContents(), SoFile::readInstance(), SoTexture3::readInstance(), SoImage::readInstance(), SoPointLightDragger::setUpConnections(), SoRotateDiscDragger::setUpConnections(), SoDirectionalLightDragger::setUpConnections(), SoTranslate1Dragger::setUpConnections(), SoScale1Dragger::setUpConnections(), SoScale2Dragger::setUpConnections(), SoScaleUniformDragger::setUpConnections(), SoScale2UniformDragger::setUpConnections(), SoJackDragger::setUpConnections(), SoRotateCylindricalDragger::setUpConnections(), SoTranslate2Dragger::setUpConnections(), SoRotateSphericalDragger::setUpConnections(), SoSpotLightDragger::setUpConnections(), SoTabBoxDragger::setUpConnections(), SoCenterballDragger::setUpConnections(), SoTabPlaneDragger::setUpConnections(), SoTrackballDragger::setUpConnections(), SoTransformBoxDragger::setUpConnections(), SoDragPointDragger::setUpConnections(), SoHandleBoxDragger::setUpConnections(), SoTransformerDragger::setUpConnections(), SoCenterballDragger::transferCenterDraggerMotion(), SoPointLightDragger::valueChangedCB(), SoDirectionalLightDragger::valueChangedCB(), SoJackDragger::valueChangedCB(), SoScale2Dragger::valueChangedCB(), SoRotateDiscDragger::valueChangedCB(), SoScale1Dragger::valueChangedCB(), SoTranslate1Dragger::valueChangedCB(), SoScaleUniformDragger::valueChangedCB(), SoScale2UniformDragger::valueChangedCB(), SoTranslate2Dragger::valueChangedCB(), SoRotateCylindricalDragger::valueChangedCB(), SoRotateSphericalDragger::valueChangedCB(), SoSpotLightDragger::valueChangedCB(), SoTabBoxDragger::valueChangedCB(), SoCenterballDragger::valueChangedCB(), SoTransformBoxDragger::valueChangedCB(), SoTrackballDragger::valueChangedCB(), SoDragPointDragger::valueChangedCB(), SoHandleBoxDragger::valueChangedCB(), SoTransformerDragger::valueChangedCB(), and ~SoFieldSensor().

◆ getAttachedField()

SoField * SoFieldSensor::getAttachedField ( void  ) const

◆ trigger()

void SoFieldSensor::trigger ( void  )
virtual

Trigger the sensor's callback function.

Reimplemented from SoDataSensor.

References SoField::evaluate(), and SoDataSensor::trigger().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Fri Jul 20 2018 for Coin by Doxygen. 1.8.14