.TH "SoFieldSensor" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoFieldSensor \- The \fBSoFieldSensor\fP class detects changes to a field\&.  

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

.in +1c
.ti -1c
.RI "\fBSoFieldSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoFieldSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoFieldSensor\fP (void)"
.br
.ti -1c
.RI "void \fBattach\fP (\fBSoField\fP *field)"
.br
.ti -1c
.RI "void \fBdetach\fP (void)"
.br
.ti -1c
.RI "\fBSoField\fP * \fBgetAttachedField\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBtrigger\fP (void)"
.br
.in -1c

Public Member Functions inherited from \fBSoDataSensor\fP
.in +1c
.ti -1c
.RI "\fBSoDataSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoDataSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoDataSensor\fP (void)"
.br
.ti -1c
.RI "void \fBsetDeleteCallback\fP (SoSensorCB *function, void *data=NULL)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTriggerNode\fP (void) const"
.br
.ti -1c
.RI "\fBSoField\fP * \fBgetTriggerField\fP (void) const"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBgetTriggerPath\fP (void) const"
.br
.ti -1c
.RI "void \fBsetTriggerPathFlag\fP (SbBool flag)"
.br
.ti -1c
.RI "SbBool \fBgetTriggerPathFlag\fP (void) const"
.br
.ti -1c
.RI "\fBSoNotRec::OperationType\fP \fBgetTriggerOperationType\fP (void) const"
.br
.ti -1c
.RI "int \fBgetTriggerIndex\fP (void) const"
.br
.ti -1c
.RI "int \fBgetTriggerFieldNumIndices\fP (void) const"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTriggerGroupChild\fP (void) const"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTriggerReplacedGroupChild\fP (void) const"
.br
.in -1c

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

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


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

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

Protected Member Functions inherited from \fBSoDataSensor\fP
.in +1c
.ti -1c
.RI "void \fBinvokeDeleteCallback\fP (void)"
.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 "void * \fBfuncData\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoFieldSensor\fP 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\&.

.PP
An \fBSoFieldSensor\fP can also act for delete-callback purposes alone and does not need a regular notification-based callback\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoFieldSensor::SoFieldSensor (void )"
Constructor\&. 
.SS "SoFieldSensor::SoFieldSensor (SoSensorCB * func, void * 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 "SoFieldSensor::~SoFieldSensor (void )\fR [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "void SoFieldSensor::attach (\fBSoField\fP * field)"
Attach sensor to a field\&. Whenever the field's value changes, the sensor will be triggered and call the callback function\&.

.PP
A field sensor can be attached to only a single field at a time\&. When this method is invoked multiple times, each subsequent call will replace the field the sensor is monitoring with the new \fIfield\fP\&.

.PP
When the given field is deleted, the sensor will automatically be detached\&.

.PP
\fBSee also\fP
.RS 4
\fBdetach()\fP 
.RE
.PP

.SS "void SoFieldSensor::detach (void )"
Detach sensor from field\&. As long as an \fBSoFieldSensor\fP is detached, it will never call its callback function\&.

.PP
\fBSee also\fP
.RS 4
\fBattach()\fP 
.RE
.PP

.SS "\fBSoField\fP * SoFieldSensor::getAttachedField (void ) const"
Returns a pointer to the field connected to the sensor\&.

.PP
\fBSee also\fP
.RS 4
\fBattach()\fP, \fBdetach()\fP 
.RE
.PP

.SS "void SoFieldSensor::trigger (void )\fR [virtual]\fP"
Trigger the sensor's callback function\&. 
.PP
Reimplemented from \fBSoDataSensor\fP\&.

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