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

Public Member Functions
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

List of all members.

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)

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::SoFieldSensor ( void  )

Constructor.

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 ( void  ) [virtual]

Destructor.

References detach().


Member Function Documentation

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 detach(), SoField::addAuditor(), and SoField::evaluate().

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

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 SoField::removeAuditor(), SoDelayQueueSensor::isScheduled(), and SoDelayQueueSensor::unschedule().

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

SoField * SoFieldSensor::getAttachedField ( void  ) const
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 Wed Jan 11 2012 for Coin by Doxygen. 1.7.5