Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SoNodeSensor Class Reference
Sensor Classes

The SoNodeSensor class detects changes to nodes. More...

#include <Inventor/sensors/SoNodeSensor.h>

Inheritance diagram for SoNodeSensor:
SoDataSensor SoDelayQueueSensor SoSensor

Public Member Functions

 SoNodeSensor (SoSensorCB *func, void *data)
 
 SoNodeSensor (void)
 
virtual ~SoNodeSensor (void)
 
void attach (SoNode *node)
 
void detach (void)
 
SoNode * getAttachedNode (void) const
 
- Public Member Functions inherited from SoDataSensor
 SoDataSensor (SoSensorCB *func, void *data)
 
 SoDataSensor (void)
 
virtual ~SoDataSensor (void)
 
SoField * getTriggerField (void) const
 
int getTriggerFieldNumIndices (void) const
 
SoNode * getTriggerGroupChild (void) const
 
int getTriggerIndex (void) const
 
SoNode * getTriggerNode (void) const
 
SoNotRec::OperationType getTriggerOperationType (void) const
 
SoPath * getTriggerPath (void) const
 
SbBool getTriggerPathFlag (void) const
 
SoNode * getTriggerReplacedGroupChild (void) const
 
virtual void notify (SoNotList *l)
 
void setDeleteCallback (SoSensorCB *function, void *data=NULL)
 
void setTriggerPathFlag (SbBool flag)
 
virtual void trigger (void)
 
- Public Member Functions inherited from SoDelayQueueSensor
 SoDelayQueueSensor (SoSensorCB *func, void *data)
 
 SoDelayQueueSensor (void)
 
virtual ~SoDelayQueueSensor (void)
 
uint32_t getPriority (void) const
 
virtual SbBool isIdleOnly (void) const
 
virtual SbBool isScheduled (void) const
 
virtual void schedule (void)
 
void setPriority (uint32_t pri)
 
virtual void unschedule (void)
 
- Public Member Functions inherited from SoSensor
 SoSensor (SoSensorCB *func, void *data)
 
 SoSensor (void)
 
virtual ~SoSensor (void)
 
void * getData (void) const
 
SoSensorCBPtr getFunction (void) const
 
SoSensor * getNextInQueue (void) const
 
void setData (void *callbackdata)
 
void setFunction (SoSensorCB *callbackfunction)
 
void setNextInQueue (SoSensor *next)
 

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 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() [1/2]

SoNodeSensor::SoNodeSensor ( void )

Default constructor.

◆ SoNodeSensor() [2/2]

SoNodeSensor::SoNodeSensor ( SoSensorCB * func,
void * data )

Constructor taking as parameters the sensor callback function and the userdata which will be passed to the callback.

See also
setFunction(), setData()

◆ ~SoNodeSensor()

SoNodeSensor::~SoNodeSensor ( void )
virtual

Destructor.

Member Function Documentation

◆ attach()

void SoNodeSensor::attach ( SoNode * node)

Attach sensor to a node. Whenever any data in the node (or its children, if it is 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()

◆ 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()

◆ getAttachedNode()

SoNode * SoNodeSensor::getAttachedNode ( void ) const

Returns a pointer to the node connected to the sensor.

See also
attach(), detach()
The documentation for this class was generated from the following files: