man SoSFEngine () - field containing a pointer to a engine

NAME

SoSFEngine - field containing a pointer to a engine

INHERITS FROM

SoField > SoSField > SoSFEngine

SYNOPSIS

#include <Inventor/fields/SoSFEngine.h> Methods from class SoSFEngine: c } c } getClassTypeId()

c } c } getTypeId() const

c } c } getValue() const

c } c } operator =(SoEngine * newValue)

c } c } setValue(SoEngine * newValue)

c } c } operator ==(const SoSFEngine &f) const

c } c } operator !=(const SoSFEngine &f) const Methods from class SoField: c } c } setIgnored(SbBool ignore)

c } c } isIgnored() const

c } c } isDefault() const

c } c } isOfType(SoType type) const

c } c } set(const char *valueString)

c } c } get(SbString &valueString)

c } c } touch()

c } c } connectFrom(SoField *fromField)

c } c } connectFrom(SoEngineOutput *fromEngine)

c } c } disconnect()

c } c } isConnected() const

c } c } isConnectedFromField() const

c } c } getConnectedField(SoField *&writingField) const

c } c } isConnectedFromEngine() const

c } c } getConnectedEngine(SoEngineOutput *&engineOutput) const

c } c } enableConnection(SbBool flag)

c } c } isConnectionEnabled() const

c } c } getForwardConnections(SoFieldList &list) const

c } c } getContainer() const

DESCRIPTION

This field maintains a pointer to an SoEngine instance, correctly maintaining its reference count. SoSFEngines are written to file as the engine they are pointing to. For example:

mySoSFEngineField ElapsedTime {}

is an SoSFEngine field named 'mySoSFEngineField', pointing to an SoElapsedTime engine. If the engine is used elsewhere, the regular DEF/USE instancing mechanism applies:

anotherSoSFEngineField USE calculator

is an SoSFEngine field that points to a engine named 'calculator' that was DEF'ed earlier in the scene.

METHODS

c } c } getClassTypeId()

c } c } getTypeId() const

Returns the type for this class or a particular object of this class. c } c } getValue() const

Returns this field's value. c } c } operator =(SoEngine * newValue)

c } c } setValue(SoEngine * newValue)

Sets this field to newValue. c } c } operator ==(const SoSFEngine &f) const

c } c } operator !=(const SoSFEngine &f) const

Returns TRUE if f is of the same type and has the same value as this field.

SEE ALSO

SoField, SoSField, SoMFEngine, SoEngine