.TH "SoNodeSensor" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoNodeSensor \- The \fBSoNodeSensor\fP class detects changes to nodes\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/sensors/SoNodeSensor\&.h>\fP
.PP
Inherits \fBSoDataSensor\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSoNodeSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoNodeSensor\fP (SoSensorCB *\fBfunc\fP, \fBvoid\fP *data)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoNodeSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBattach\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdetach\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetAttachedNode\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoDataSensor\fP
.in +1c
.ti -1c
.RI "\fBSoDataSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoDataSensor\fP (SoSensorCB *\fBfunc\fP, \fBvoid\fP *data)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoDataSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDeleteCallback\fP (SoSensorCB *function, \fBvoid\fP *data=\fBNULL\fP)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTriggerNode\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoField\fP * \fBgetTriggerField\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBgetTriggerPath\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetTriggerPathFlag\fP (SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBgetTriggerPathFlag\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNotRec::OperationType\fP \fBgetTriggerOperationType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetTriggerIndex\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetTriggerFieldNumIndices\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTriggerGroupChild\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTriggerReplacedGroupChild\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBtrigger\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBl\fP)"
.br
.in -1c

Public Member Functions inherited from \fBSoDelayQueueSensor\fP
.in +1c
.ti -1c
.RI "\fBSoDelayQueueSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoDelayQueueSensor\fP (SoSensorCB *\fBfunc\fP, \fBvoid\fP *data)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoDelayQueueSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetPriority\fP (uint32_t \fBpri\fP)"
.br
.ti -1c
.RI "uint32_t \fBgetPriority\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBschedule\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBunschedule\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBisScheduled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBisIdleOnly\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "\fBSoSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoSensor\fP (SoSensorCB *\fBfunc\fP, \fBvoid\fP *data)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoSensor\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetFunction\fP (SoSensorCB *\fBcallbackfunction\fP)"
.br
.ti -1c
.RI "SoSensorCBPtr \fBgetFunction\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetData\fP (\fBvoid\fP *\fBcallbackdata\fP)"
.br
.ti -1c
.RI "\fBvoid\fP * \fBgetData\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetNextInQueue\fP (\fBSoSensor\fP *next)"
.br
.ti -1c
.RI "\fBSoSensor\fP * \fBgetNextInQueue\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Static Public Member Functions inherited from \fBSoDelayQueueSensor\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetDefaultPriority\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSoDataSensor\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBinvokeDeleteCallback\fP (\fBvoid\fP)"
.br
.in -1c

Protected Attributes inherited from \fBSoDelayQueueSensor\fP
.in +1c
.ti -1c
.RI "SbBool \fBscheduled\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "SoSensorCB * \fBfunc\fP"
.br
.ti -1c
.RI "\fBvoid\fP * \fBfuncData\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoNodeSensor\fP 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\&.
.PP
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\&.
.PP
An \fBSoNodeSensor\fP can also act for delete-callback purposes alone and does not need a regular notification-based callback\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoNodeSensor::SoNodeSensor (\fBvoid\fP)"
Default constructor\&. 
.SS "SoNodeSensor::SoNodeSensor (SoSensorCB * func, \fBvoid\fP * data)"
Constructor taking as parameters the sensor callback function and the userdata which will be passed to the callback\&.
.PP
\fBSee also\fP
.RS 4
\fBsetFunction()\fP, \fBsetData()\fP 
.RE
.PP

.SS "SoNodeSensor::~SoNodeSensor (\fBvoid\fP)\fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP SoNodeSensor::attach (\fBSoNode\fP * node)"
Attach sensor to a node\&. Whenever any data in the node (or its children, if it is an \fBSoGroup\fP or \fBSoGroup\fP derived node) changes, the sensor will be triggered and call the callback function\&.
.PP
Attaching a node sensor to a node will \fInot\fP increase the node's reference count (and conversely, \fBdetach()\fP'ing the node sensor will not decrease the reference count, either)\&.
.PP
When the attached node is deleted, the sensor will be automatically detached()\&.
.PP
\fBSee also\fP
.RS 4
\fBdetach()\fP 
.RE
.PP

.SS "\fBvoid\fP SoNodeSensor::detach (\fBvoid\fP)"
Detach sensor from node\&. As long as an \fBSoNodeSensor\fP is detached, it will never call its callback function\&.
.PP
\fBSee also\fP
.RS 4
\fBattach()\fP 
.RE
.PP

.SS "\fBSoNode\fP * SoNodeSensor::getAttachedNode (\fBvoid\fP) const"
Returns a pointer to the node connected to the sensor\&.
.PP
\fBSee also\fP
.RS 4
\fBattach()\fP, \fBdetach()\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.