Package org.web3d.x3d.sai.EventUtilities
Interface BooleanToggle
- All Superinterfaces:
X3DChildNode,X3DNode
- All Known Implementing Classes:
BooleanToggleObject
public interface BooleanToggle extends X3DChildNode
BooleanToggle maintains state and negates output when a true input is provided.
X3D node tooltip: [X3DChildNode] BooleanToggle maintains state and negates output when a true input is provided.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: [X3DChildNode] BooleanToggle maintains state and negates output when a true input is provided.
- Hint: example scenes and authoring assets at http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
- Hint: X3D Event-Utility Node Diagrams http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.booleangetToggle()Provide boolean value from inputOutput SFBool field named toggle.BooleanTogglesetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.BooleanTogglesetToggle(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named toggle.
-
Method Details
-
getMetadata
X3DMetadataObject getMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
getMetadatain interfaceX3DChildNode- Specified by:
getMetadatain interfaceX3DNode- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
setMetadatain interfaceX3DChildNode- Specified by:
setMetadatain interfaceX3DNode- Parameters:
newValue- is new value for the metadata field.- Returns:
BooleanToggle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
getToggle
boolean getToggle()Provide boolean value from inputOutput SFBool field named toggle.
Tooltip: Persistent state value that gets toggled or reset.- Hint: directly setting a new value for the toggle field generates a corresponding toggle_changed output event.
- Returns:
- value of toggle field
-
setToggle
Accessor method to assign boolean value to inputOutput SFBool field named toggle.
Tooltip: Persistent state value that gets toggled or reset.- Hint: directly setting a new value for the toggle field generates a corresponding toggle_changed output event.
- Parameters:
newValue- is new value for the toggle field.- Returns:
BooleanToggle- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-