sonodesensor(3) [debian man page]

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)

Sensor Classes(3)						       Coin							 Sensor Classes(3)

NAME

       Sensor Classes -

   Classes
       class SoAlarmSensor
	   The SoAlarmSensor class is a sensor which will trigger once at a specified time.

       SoAlarmSensor provides a convenient way of setting up triggers for jobs which should be executed only once when they are scheduled. "
   class SoDataSensor
       The SoDataSensor class is the abstract base class for sensors monitoring changes in a scene graph.

       If you need to know when a particular entity (as a field or a node) changes, subclasses of SoDataSensor can be used to monitor the entity
       and notify you when it changes. "
   class SoDelayQueueSensor
       The SoDelayQueueSensor class is the abstract base class for priority scheduled sensors.

       Delay queue sensors are invoked upon various events not related to time occurrences. See documentation of subclasses to see which types of
       events can be surveilled by the builtin sensor types. "
   class 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. "
   class SoIdleSensor
       The SoIdleSensor class is a sensor which will trigger as soon as the application is idle.

       An SoIdleSensor differs from an SoOneShotSensor in that it will not trigger if the delay queue processing is occurring due to the delay
       queue timeout, but only when the application is idle. "
   class 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. "
   class SoOneShotSensor
       The SoOneShotSensor class is a sensor which will trigger once.

       Since SoOneShotSensor is a subclass of SoDelayQueueSensor, it will trigger as soon as either the run-time system is idle, or if it is
       continually busy it will trigger within a fixed amount of time (this is by default 1/12th of a second, see
       SoSensorManager::setDelaySensorTimeout()). "
   class SoPathSensor
       The SoPathSensor class detects changes to paths.

       If you need to know when a path changes (i.e. nodes in the path has been removed, or new nodes is added), use this sensor to get a
       notification. "
   class SoSensor
       The SoSensor class is the abstract base class for all sensors.

       Sensors is a mechanism in Coin for scheduling jobs to be run upon specific events. The events in question could be particular points in
       time, or changes to entities in the scene graph. "
   class SoSensorManager
       The SoSensorManager class handles the sensor queues.

       There are two major sensor types in Coin, 'delay' sensors and 'timer' sensors: "
   class SoTimerQueueSensor
       The SoTimerQueueSensor class is the abstract base class for sensors triggering on certain timer events.

       Timer sensors triggers upon specific points in time. "
   class SoTimerSensor
       The SoTimerSensor class is a sensor which will trigger at given intervals.

       Use sensors of this class when you want a job repeated at a certain interval, without explicitly needing to reschedule the sensor (i.e.
       SoTimerSensor automatically re-schedules itself after it has been triggered). "

Detailed Description
       Sensors are objects that monitor other objects for changes and invoke callbacks when changes occur.

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

Version 3.1.3							  Wed May 23 2012						 Sensor Classes(3)