socallbacklist(3) [debian man page]

SoCallbackList(3)						       Coin							 SoCallbackList(3)

NAME

       SoCallbackList -

       The SoCallbackList is a container for callback function pointers.

       This list stores callback function pointers (along with user-specified extra data to pass to the callbacks) and provides a method for
       triggering the callback functions.

SYNOPSIS

       #include <Inventor/lists/SoCallbackList.h>

   Public Member Functions
       SoCallbackList (void)
       ~SoCallbackList ()
       void addCallback (SoCallbackListCB *f, void *userData=NULL)
       void removeCallback (SoCallbackListCB *f, void *userdata=NULL)
       void clearCallbacks (void)
       int getNumCallbacks (void) const
       void invokeCallbacks (void *callbackdata)

Detailed Description
       The SoCallbackList is a container for callback function pointers.

       This list stores callback function pointers (along with user-specified extra data to pass to the callbacks) and provides a method for
       triggering the callback functions.

Constructor &; Destructor Documentation
   SoCallbackList::SoCallbackList (void)
       Default constructor.

   SoCallbackList::~SoCallbackList (void)
       Destructor.

Member Function Documentation
   void SoCallbackList::addCallback (SoCallbackListCB *f, void *userdata = NULL)
       Append the callback function f to the list. It will be passed the userdata upon invocation.

   void SoCallbackList::removeCallback (SoCallbackListCB *f, void *userdata = NULL)
       Remove callback f from the list.

   void SoCallbackList::clearCallbacks (void)
       Remove all callbacks in the list.

   int SoCallbackList::getNumCallbacks (void) const
       Returns number of callback functions.

   void SoCallbackList::invokeCallbacks (void *callbackdata)
       Invoke all callback functions, passing the userdata and the callbackdata as the first and second argument, respectively.

       All callbacks registered when the method is invoked will be triggered, even though if the code in one callback removes another callback.

       It is safe for a callback to remove itself or any other callbacks during execution.

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						 SoCallbackList(3)

SoFieldSensor(3)						       Coin							  SoFieldSensor(3)

NAME

       SoFieldSensor -

       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.

SYNOPSIS

       #include <Inventor/sensors/SoFieldSensor.h>

       Inherits SoDataSensor.

   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)

   Additional Inherited Members
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.

       An SoFieldSensor can also act for delete-callback purposes alone and does not need a regular notification-based callback.

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.

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.

       When the given field is deleted, the sensor will automatically be detached.

       See also:
	   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()

   SoField * SoFieldSensor::getAttachedField (void) const
       Returns a pointer to the field connected to the sensor.

       See also:
	   attach(), detach()

   void SoFieldSensor::trigger (void) [virtual]
       Trigger the sensor's callback function.

       Reimplemented from SoDataSensor.

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						  SoFieldSensor(3)