Package 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.
-
-
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 Description SoSFTrigger(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType)
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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, connectFrom, connectFrom, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getContainer, getNumConnections, getValueSize, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch
-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Constructor Detail
-
SoSFTrigger
public SoSFTrigger(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType)
Default constructor.
-
-