SoSFTrigger Class Reference

Field used to trigger engines or connection networks. More...

#include <Inventor/fields/SoSFTrigger.h>

Inheritance diagram for SoSFTrigger:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
const SoSFTrigger &	operator= (const SoSFTrigger &f)
	Copy from another field of same type.
	SoSFTrigger ()
	Default constructor.
virtual	~SoSFTrigger ()
	Destructor.
void	setValue ()
	Starts the notification process; this is equivalent to calling touch().
void	getValue () const
	Forces any connected engines or fields to evaluate themselves.
virtual void	touch ()
	Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
int	operator== (const SoSFTrigger &t) const
	All trigger fields are equal.
int	operator!= (const SoSFTrigger &t) const
	All trigger fields are equal.
Public Member Functions inherited from SoField
void	setIgnored (SbBool ig)
	Sets the ignore flag for this field.
SbBool	isIgnored () const
	Gets the ignore flag for this field.
SbBool	isDefault () const
	Gets the state of default flag of the field.
void	enableConnection (SbBool flag)
	Field connections may be enabled and disabled.
SbBool	isConnectionEnabled () const
	Returns FALSE if connections to this field are disabled.
SbBool	connectFrom (SoEngineOutput *engineOutput)
	Connects this field from an engine output.
SbBool	connectFrom (SoField *field)
	Connects this field to another field.
SbBool	connectFrom (SoVRMLInterpOutput *interpOutput)
	Connects this field from an interpOutput.
SbBool	appendConnection (SoEngineOutput *engineOutput)
	Appends this field to the list of connections from another engineOutput.
SbBool	appendConnection (SoField *field)
	Appends this field to the list of connections from another field.
SbBool	appendConnection (SoVRMLInterpOutput *interpOutput)
	Appends this field to the list of connections from another interpOutput.
void	disconnect (SoEngineOutput *engineOutput)
	Disconnect the field from the requested engineOutput.
void	disconnect (SoField *field)
	Disconnect the field from the requested field.
void	disconnect (SoVRMLInterpOutput *interpOutput)
	Disconnect the field from the requested interpOutput.
int	getNumConnections () const
	Returns the number of connections to this field.
int	getConnections (SoFieldList &list)
	Returns a list of the connections to this field.
void	disconnect ()
	Disconnect the field from whatever it was connected to.
SbBool	isConnected () const
	Returns TRUE if the field is connected to anything.
SbBool	isConnectedFromVRMLInterp () const
	Returns TRUE if the field is connected to a VRML interpOutput.
SbBool	isConnectedFromEngine () const
	Returns TRUE if the field is connected to an engine's output.
SbBool	isConnectedFromField () const
	Returns TRUE if the field is connected to another field.
SbBool	getConnectedEngine (SoEngineOutput *&engineOutput) const
	Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.
SbBool	getConnectedField (SoField *&writingField) const
	Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.
SbBool	getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
	Returns the VRMLInterpolator output field is connected to.
int	getForwardConnections (SoFieldList &list) const
	Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.
SoFieldContainer *	getContainer () const
	Returns the object that contains this field.
SoNONUNICODE SbBool	set (const char *valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
SbBool	set (const SbString &valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
void	get (SbString &valueString)
	Returns the value of the field in the Open Inventor file format, even if the field has its default value.
virtual size_t	getValueSize () const
	Gets the size of the value.
int	operator== (const SoField &f) const
	Return TRUE if this field is of the same type and has the same value as f.
int	operator!= (const SoField &f) const
	Return FALSE if this field is of the same type and has the same value as f.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoSField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.
Static Public Member Functions inherited from SoField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Field used to trigger engines or connection networks.

This class can be used to start or to synchronize a network of field connections. It is the "null" field - a field with no values. It is typically used as the "start button" for engines that change over time.

Triggers can be connected from any other type of field, and will notify any engines or nodes they are part of (or any other triggers they are connected to) whenever the value of the field is set (even if it is set to its current value) or the field is touch()'ed.

Since they have no value, SoSFTriggers are not written to file. A node or engine containing an SoSFTrigger field will write only the field's name.

SEE ALSO

SoSFBool, SoMFBool

Definition at line 85 of file SoSFTrigger.h.

Constructor & Destructor Documentation

SoSFTrigger()

SoSFTrigger::SoSFTrigger

(

)

Default constructor.

~SoSFTrigger()

virtual SoSFTrigger::~SoSFTrigger ( )

virtual

Destructor.

Member Function Documentation

getClassTypeId()

static SoType SoSFTrigger::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoSFTrigger::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

getValue()

void SoSFTrigger::getValue ( ) const

inline

Forces any connected engines or fields to evaluate themselves.

Definition at line 100 of file SoSFTrigger.h.

operator!=()

int SoSFTrigger::operator!=

(

const SoSFTrigger &

t

)

const

All trigger fields are equal.

This method always returns FALSE.

operator=()

const SoSFTrigger & SoSFTrigger::operator=

(

const SoSFTrigger &

f

)

Copy from another field of same type.

operator==()

int SoSFTrigger::operator==

(

const SoSFTrigger &

t

)

const

All trigger fields are equal.

This method always returns TRUE.

setValue()

void SoSFTrigger::setValue ( )

inline

Starts the notification process; this is equivalent to calling touch().

Definition at line 95 of file SoSFTrigger.h.

touch()

virtual void SoSFTrigger::touch ( )

virtual

Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.

Calling touch() on an instance of a derived field class is equivalent to calling setValue(getValue()) using the derived class's methods, except that the field's isDefault() status remains unchanged.

Reimplemented from SoField.

---

The documentation for this class was generated from the following file:

• Inventor/fields/SoSFTrigger.h