.TH "SoSFTrigger" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoSFTrigger \- The \fBSoSFTrigger\fP class is the 'void' class used for detecting field changes\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/fields/SoSFTrigger\&.h>\fP
.PP
Inherits \fBSoSField\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyFrom\fP (\fBconst\fP \fBSoField\fP &\fBfield\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoSFTrigger\fP & \fBoperator=\fP (\fBconst\fP \fBSoSFTrigger\fP &\fBfield\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBisSame\fP (\fBconst\fP \fBSoField\fP &\fBfield\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetValue\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetValue\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSoSFTrigger\fP &trigger) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSoSFTrigger\fP &trigger) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBl\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.in -1c

Public Member Functions inherited from \fBSoSField\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoSField\fP ()"
.br
.in -1c

Public Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoField\fP ()"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetIgnored\fP (SbBool \fBignore\fP)"
.br
.ti -1c
.RI "SbBool \fBisIgnored\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDefault\fP (SbBool \fBdefaultVal\fP)"
.br
.ti -1c
.RI "SbBool \fBisDefault\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBconst\fP \fBSoType\fP type) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBenableConnection\fP (SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectionEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoEngineOutput\fP *master, SbBool \fBnotnotify\fP=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoEngineOutput\fP *master, SbBool \fBnotnotify\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBSoEngineOutput\fP *\fBengineoutput\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromEngine\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetConnectedEngine\fP (\fBSoEngineOutput\fP *&master) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBconnectFrom\fP (\fBSoField\fP *master, SbBool \fBnotnotify\fP=FALSE, SbBool append=FALSE)"
.br
.ti -1c
.RI "SbBool \fBappendConnection\fP (\fBSoField\fP *master, SbBool \fBnotnotify\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBSoField\fP *\fBfield\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnectedFromField\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetConnectedField\fP (\fBSoField\fP *&master) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetNumConnections\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetForwardConnections\fP (\fBSoFieldList\fP &\fBslavelist\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetConnections\fP (\fBSoFieldList\fP &\fBmasterlist\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBdisconnect\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisConnected\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetContainer\fP (\fBSoFieldContainer\fP *\fBcont\fP)"
.br
.ti -1c
.RI "\fBSoFieldContainer\fP * \fBgetContainer\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *\fBvaluestring\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &\fBvaluestring\fP)"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (SbBool on)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *f, \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSoField\fP &f) \fBconst\fP"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSoField\fP &f) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBconnectionStatusChanged\fP (int \fBnumconnections\fP)"
.br
.ti -1c
.RI "SbBool \fBisReadOnly\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBfixCopy\fP (SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreferencesCopy\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopyConnection\fP (\fBconst\fP \fBSoField\fP *fromfield)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoOutput\fP *\fBout\fP, \fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcountWriteRefs\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetFieldType\fP (int type)"
.br
.ti -1c
.RI "int \fBgetFieldType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetDirty\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDirty\fP (SbBool dirty)"
.br
.ti -1c
.RI "\fBvoid\fP \fBevaluate\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

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

Static Public Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "enum \fBFieldType\fP { \fBNORMAL_FIELD\fP = 0, \fBEVENTIN_FIELD\fP, \fBEVENTOUT_FIELD\fP, \fBEXPOSED_FIELD\fP }"
.br
.in -1c

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

Protected Member Functions inherited from \fBSoField\fP
.in +1c
.ti -1c
.RI "\fBSoField\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBvalueChanged\fP (SbBool \fBresetdefault\fP=TRUE)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBevaluateConnection\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadConnection\fP (\fBSoInput\fP *\fBin\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwriteConnection\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisDestructing\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBSoBase\fP *\fBcont\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoSFTrigger\fP class is the 'void' class used for detecting field changes\&. 

Connect this field to a master field (or engine output) to detect when the master field changes its value\&.
.PP
This is useful if you want to automatically trigger an update from the node or engine (or other field container) this field is part of whenever another field changes -- and you are not particularly interested in the actual value of the master field\&.
.PP
\fBSee also\fP
.RS 4
\fBSoFieldSensor\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP * SoSFTrigger::createInstance (\fBvoid\fP)\fC [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. 
.br
 
.SS "\fBSoType\fP SoSFTrigger::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoSFTrigger::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoField\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoField\fP\&.
.SS "\fBvoid\fP SoSFTrigger::copyFrom (\fBconst\fP \fBSoField\fP & f)\fC [virtual]\fP"
Copy value(s) from \fIf\fP into this field\&. \fIf\fP must be of the same type as this field\&. 
.PP
Implements \fBSoField\fP\&.
.SS "SbBool SoSFTrigger::isSame (\fBconst\fP \fBSoField\fP & f) const\fC [virtual]\fP"
Check for equal type and value(s)\&. 
.PP
Implements \fBSoField\fP\&.
.SS "\fBvoid\fP SoSFTrigger::initClass (\fBvoid\fP)\fC [static]\fP"
Internal method called upon initialization of the library (from \fBSoDB::init()\fP) to set up the type system\&.   
.SS "\fBvoid\fP SoSFTrigger::setValue (\fBvoid\fP)"
This field class does not actually contain any value, so we just trigger an update by calling \fBtouch()\fP within this method\&. 
.SS "\fBvoid\fP SoSFTrigger::getValue (\fBvoid\fP) const"
Field doesn't contain any value, so this method does nothing\&. 
.SS "int SoSFTrigger::operator== (\fBconst\fP \fBSoSFTrigger\fP & trigger) const"
Since \fBSoSFTrigger\fP fields doesn't have any value, they are all equal\&. So this method always returns \fCTRUE\fP\&. 
.SS "int SoSFTrigger::operator!= (\fBconst\fP \fBSoSFTrigger\fP & trigger) const"
Since \fBSoSFTrigger\fP fields doesn't have any value, they are all equal\&. So this method always returns \fCFALSE\fP\&. 
.SS "\fBvoid\fP SoSFTrigger::startNotify (\fBvoid\fP)\fC [virtual]\fP"
Trigger a notification sequence\&.
.PP
At the end of a notification sequence, all 'immediate' sensors (i\&.e\&. sensors set up with a zero priority) are triggered\&. 
.PP
Reimplemented from \fBSoField\fP\&.
.SS "\fBvoid\fP SoSFTrigger::notify (\fBSoNotList\fP * nlist)\fC [virtual]\fP"
Notify auditors that this field has changed\&. 
.PP
Reimplemented from \fBSoField\fP\&.
.SS "\fBvoid\fP SoSFTrigger::touch (\fBvoid\fP)\fC [virtual]\fP"
Notify the field as well as the field's owner / container that it has been changed\&.
.PP
Touching a field which is part of any component (engine or node) in a scene graph will lead to a forced redraw\&. This is useful if you have been doing several updates to the field wrapped in a pair of \fBenableNotify()\fP calls to notify the field's auditors that its value has changed\&.
.PP
\fBSee also\fP
.RS 4
\fBsetValue()\fP, \fBenableNotify()\fP 
.RE
.PP

.PP
Reimplemented from \fBSoField\fP\&.

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