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).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: BooleanToggle, X3D Tooltips: BooleanToggle, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    boolean getToggle()
    Provide boolean value from inputOutput SFBool field named toggle.
    BooleanToggle setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    BooleanToggle setToggle​(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.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      BooleanToggle setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      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

      BooleanToggle setToggle​(boolean newValue)
      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).