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

SoFieldSensor Class Reference

The SoFieldSensor class detects changes to a 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()

References SoSensor::func.

◆ ~SoFieldSensor()

SoFieldSensor::~SoFieldSensor ( void )
virtual

Destructor.

References detach().

Member Function Documentation

◆ attach()

◆ detach()

◆ getAttachedField()

SoField * SoFieldSensor::getAttachedField ( void ) const

Returns a pointer to the field connected to the sensor.

See also
attach(), detach()

◆ 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 Thu Jan 16 2025 for Coin by Doxygen. 1.13.2