Man Linux: Main Page and Category List

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

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.