com.openinventor.inventor.fields

Class SoSFEngine

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoSField

com.openinventor.inventor.fields.SoSFEngine

public class SoSFEngine
extends SoSField

Field containing an engine instance. This field maintains an SoEngine instance.

SoSFEngines are written to file as the engine they are maintaining. For example:

   mySoSFEngineField ElapsedTime

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

   anotherSoSFEngineField USE calculator

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

See also:

SoField, SoSField, SoMFEngine, SoEngine

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.fields.SoField

SoField.FieldTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoSFEngine() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoSFEngine(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType, SoEngine defaultValue) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
SoEngine	getValue() Returns this field's value.
long	getValueSize() Get size of the value.
void	setValue(SoEngine newValue) Sets this field to newValue.

Methods inherited from class com.openinventor.inventor.fields.SoField

appendConnection, appendConnection, appendConnection, connectFrom, connectFrom, connectFrom, disconnect, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getConnectedVRMLInterp, getContainer, getNumConnections, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoSFEngine

@Deprecated
public SoSFEngine()

Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.

SoSFEngine

public SoSFEngine(SoFieldContainer fieldContainer,
                  java.lang.String fieldName,
                  SoField.FieldTypes fieldType,
                  SoEngine defaultValue)

Default constructor.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

getValueSize

public long getValueSize()

Get size of the value.

getValue

public SoEngine getValue()

Returns this field's value.

setValue

public void setValue(SoEngine newValue)

Sets this field to newValue.