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)

SoNodeSensor(3) 						       Coin							   SoNodeSensor(3)

NAME

       SoNodeSensor -

       The SoNodeSensor class detects changes to nodes.

       Attach a node to a sensor of this type to put it under surveillance, so you can act upon changes to the node.

SYNOPSIS

       #include <Inventor/sensors/SoNodeSensor.h>

       Inherits SoDataSensor.

   Public Member Functions
       SoNodeSensor (void)
       SoNodeSensor (SoSensorCB *func, void *data)
       virtual ~SoNodeSensor (void)
       void attach (SoNode *node)
       void detach (void)
       SoNode * getAttachedNode (void) const

   Additional Inherited Members
Detailed Description
       The SoNodeSensor class detects changes to nodes.

       Attach a node to a sensor of this type to put it under surveillance, so you can act upon changes to the node.

       Any modification to the node's fields will trigger the sensor, as will changes to node's children (if any), including if nodes are added or
       removed as children below the node in the subgraph.

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

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

   SoNodeSensor::SoNodeSensor (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()

   SoNodeSensor::~SoNodeSensor (void) [virtual]
       Destructor.

Member Function Documentation
   void SoNodeSensor::attach (SoNode *node)
       Attach sensor to a node. Whenever any data in the node (or its children, if it's an SoGroup or SoGroup derived node) changes, the sensor
       will be triggered and call the callback function.

       Attaching a node sensor to a node will not increase the node's reference count (and conversely, detach()'ing the node sensor will not
       decrease the reference count, either).

       When the attached node is deleted, the sensor will be automatically detached().

       See also:
	   detach()

   void SoNodeSensor::detach (void)
       Detach sensor from node. As long as an SoNodeSensor is detached, it will never call its callback function.

       See also:
	   attach()

   SoNode * SoNodeSensor::getAttachedNode (void) const
       Returns a pointer to the node connected to the sensor.

       See also:
	   attach(), detach()

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

Version 3.1.3							  Wed May 23 2012						   SoNodeSensor(3)