com.openinventor.inventor.vrmlnodes

Class SoVRMLBooleanToggle

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLBooleanToggle

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLBooleanToggle
extends SoVRMLNode

Stores a boolean value for toggling on/off. See the X3D Specification, below.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML X3D SPECIFICATION

This section describes the expected behavior of the node in a conforming X3D browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the X3D specification that are not present in this help file. The complete X3D spec is available at http://www.web3d.org.

This utility event stores a boolean value for toggling on and off.

When a set_boolean true event is received, the BooleanToggle negates the value of the toggle field and generates the corresponding toggle field output event. set_boolean false events are ignored.

The BooleanToggle can be reset to a specific state by directly setting the value of the inputOutput toggle field.

Refer to "Event Utilities Component" for a more detailed discussion.

File format/default:

VRMLBooleanToggle {

toggle	false
metadata	NULL

}

EVENTS

eventIn

SoSFBool	set_boolean
SoSFBool	set_toggle
SoSFNode	set_metadata

eventOut

SoSFBool	toggle_changed
SoSFNode	metadata_changed

Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

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	set_boolean Deprecated. Output event on toggle changes.
SoSFBool	toggle Deprecated. The boolean value for toggling on/off.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLBooleanToggle() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

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

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

toggle

public final SoSFBool toggle

Deprecated.

The boolean value for toggling on/off.

set_boolean

public final SoSFBool set_boolean

Deprecated.

Output event on toggle changes.

Constructor Detail

SoVRMLBooleanToggle

public SoVRMLBooleanToggle()

Deprecated.

Constructor.