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

Referenced by SoTransformManip::attachSensors(), SoFile::copyContents(), SoTexture3::readInstance(), SoImage::readInstance(), SoFile::readInstance(), SoTranslate2Dragger::setUpConnections(), SoTranslate1Dragger::setUpConnections(), SoTransformerDragger::setUpConnections(), SoTransformBoxDragger::setUpConnections(), SoTrackballDragger::setUpConnections(), SoTabPlaneDragger::setUpConnections(), SoTabBoxDragger::setUpConnections(), SoSpotLightDragger::setUpConnections(), SoScaleUniformDragger::setUpConnections(), SoScale2UniformDragger::setUpConnections(), SoScale2Dragger::setUpConnections(), SoScale1Dragger::setUpConnections(), SoRotateSphericalDragger::setUpConnections(), SoRotateDiscDragger::setUpConnections(), SoRotateCylindricalDragger::setUpConnections(), SoPointLightDragger::setUpConnections(), SoJackDragger::setUpConnections(), SoHandleBoxDragger::setUpConnections(), SoDragPointDragger::setUpConnections(), SoDirectionalLightDragger::setUpConnections(), SoCenterballDragger::setUpConnections(), SoFile::SoFile(), SoImage::SoImage(), SoTexture3::SoTexture3(), SoCenterballDragger::transferCenterDraggerMotion(), SoTranslate2Dragger::valueChangedCB(), SoTranslate1Dragger::valueChangedCB(), SoTransformerDragger::valueChangedCB(), SoTransformBoxDragger::valueChangedCB(), SoTrackballDragger::valueChangedCB(), SoTabBoxDragger::valueChangedCB(), SoSpotLightDragger::valueChangedCB(), SoScaleUniformDragger::valueChangedCB(), SoScale2UniformDragger::valueChangedCB(), SoScale2Dragger::valueChangedCB(), SoScale1Dragger::valueChangedCB(), SoRotateSphericalDragger::valueChangedCB(), SoRotateDiscDragger::valueChangedCB(), SoRotateCylindricalDragger::valueChangedCB(), SoPointLightDragger::valueChangedCB(), SoJackDragger::valueChangedCB(), SoHandleBoxDragger::valueChangedCB(), SoDragPointDragger::valueChangedCB(), SoDirectionalLightDragger::valueChangedCB(), and SoCenterballDragger::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 SoDelayQueueSensor::isScheduled(), SoField::removeAuditor(), and SoDelayQueueSensor::unschedule().

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

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 Mon Feb 28 2011 10:12:11 for Coin by Doxygen. 1.7.3