com.openinventor.inventor.fields

Class SoSFTrigger

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoSField

com.openinventor.inventor.fields.SoSFTrigger

public class SoSFTrigger
extends SoSField

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

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
SoSFTrigger() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoSFTrigger(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
void	getValue() Forces any connected engines or fields to evaluate themselves.
void	setValue() Starts the notification process; this is equivalent to calling touch().

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

SoSFTrigger

@Deprecated
public SoSFTrigger()

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

SoSFTrigger

public SoSFTrigger(SoFieldContainer fieldContainer,
                   java.lang.String fieldName,
                   SoField.FieldTypes fieldType)

Default constructor.

Method Detail

getValue

public void getValue()

Forces any connected engines or fields to evaluate themselves.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setValue

public void setValue()

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