com.openinventor.inventor.engines

Class SoGate

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.engines.SoEngine

com.openinventor.inventor.engines.SoGate

All Implemented Interfaces:

SafeDisposable

public class SoGate
extends SoEngine

Selectively copies its input to its output. This engine selectively copies its input to its output. The type of the input field can be any subclass of SoMField. The type is specified when an instance of the class is created. For example, SoGate( SoMFFloat.getClass()) creates an engine that copies floating-point values.

The enable input controls continuous flow-through of values. While enable is true, the input will be copied to the output. Alternatively, by touching the trigger input, you can copy a single value from the input to the output.

Note that by default input does not contain any values.

File format/default:

Gate {

type	<inputType>
input	[]
enable	false
trigger

}

See also:

SoEngineOutput, SoConcatenate, SoSelectOne

Nested Class Summary

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBool	enable Enable continous flow-through.
SoMField	input The value that is copied to the output when the gate is open.
SoEngineOutput	output ( lt ) Contains a copy of the input value if the gate is open.
SoSFTrigger	trigger Copy a single value.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoGate(java.lang.Class<? extends Inventor> mfInputType) Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.engines.SoEngine

copy, getByName, getOutput, getOutputName

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

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

enable

public final SoSFBool enable

Enable continous flow-through.

trigger

public final SoSFTrigger trigger

Copy a single value.

input

public final SoMField input

The value that is copied to the output when the gate is open.

output

public final SoEngineOutput output

( lt ) Contains a copy of the input value if the gate is open.

Constructor Detail

SoGate

public SoGate(java.lang.Class<? extends Inventor> mfInputType)

Constructor. The argument specifies the type of the input field.