com.openinventor.inventor.engines

Class SoOnOff

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.SoOnOff

All Implemented Interfaces:

SafeDisposable

public class SoOnOff
extends SoEngine

Engine that functions as an on/off switch. This engine has three triggers as input and two Boolean values as output. The isOn output is a switch that can be turned on or off by triggering the corresponding input. You can toggle the value by triggering the toggle input. By default isOn is false. The isOff output value is the inverse of isOn

File format/default:

OnOff {

on
off
toggle

}

See also:

SoEngineOutput

Nested Class Summary

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoEngineOutput	isOff ( SoSFBool ) The inverse of isOn.
SoEngineOutput	isOn ( SoSFBool ) Switch value.
SoSFTrigger	off Turn the isOn switch off.
SoSFTrigger	on Turn the isOn switch on.
SoSFTrigger	toggle Toggle the switch value.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoOnOff() 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

on

public final SoSFTrigger on

Turn the isOn switch on.

off

public final SoSFTrigger off

Turn the isOn switch off.

toggle

public final SoSFTrigger toggle

Toggle the switch value.

isOn

public final SoEngineOutput isOn

( SoSFBool ) Switch value.

isOff

public final SoEngineOutput isOff

( SoSFBool ) The inverse of isOn.

Constructor Detail

SoOnOff

public SoOnOff()

Constructor.