Linux Certif

Toute la documentation sur la certification Linux LPI

SoFieldSensor

NAME

SoFieldSensor -

SYNOPSIS

#include <Inventor/sensors/SoFieldSensor.h>

Inherits SoDataSensor.

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.

Public Member Functions

SoFieldSensor (void)

SoFieldSensor (SoSensorCB *func, void *data)

virtual ~SoFieldSensor (void)

void attach (SoField *field)

void detach (void)

SoField * getAttachedField (void) const

virtual void trigger (void)

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 SoFile::search(), SoTranslate2Dragger::setUpConnections(), SoTranslate1Dragger::setUpConnections(), SoScaleUniformDragger::setUpConnections(), SoScale2UniformDragger::setUpConnections(), SoScale2Dragger::setUpConnections(), SoScale1Dragger::setUpConnections(), SoRotateSphericalDragger::setUpConnections(), SoRotateDiscDragger::setUpConnections(), SoRotateCylindricalDragger::setUpConnections(), SoCenterballDragger::setUpConnections(), SoPointLightManip::transferFieldValues(), and SoDirectionalLightManip::transferFieldValues().

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(), SoFile::search(), SoPointLightManip::transferFieldValues(), SoDirectionalLightManip::transferFieldValues(), and ~SoFieldSensor().

SoField * SoFieldSensor::getAttachedField (void) const

Returns a pointer to the field connected to the sensor.

See also:

attach(), detach()

Referenced by SoTranslate2Dragger::setUpConnections(), SoTranslate1Dragger::setUpConnections(), SoScaleUniformDragger::setUpConnections(), SoScale2UniformDragger::setUpConnections(), SoScale2Dragger::setUpConnections(), SoScale1Dragger::setUpConnections(), SoRotateSphericalDragger::setUpConnections(), SoRotateDiscDragger::setUpConnections(), SoRotateCylindricalDragger::setUpConnections(), and SoCenterballDragger::setUpConnections().

void SoFieldSensor::trigger (void) [virtual]

Trigger the sensor's callback function.

Reimplemented from SoDataSensor.

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

Author

Generated automatically by Doxygen for Coin from the source code.