Interface MetadataBoolean

All Superinterfaces:
X3DMetadataObject, X3DNode
All Known Implementing Classes:
MetadataBooleanObject

public interface MetadataBoolean
extends X3DNode, X3DMetadataObject
The metadata provided by this node is contained in the Boolean values of the value field.

X3D node tooltip: (X3D version 3.3 or later) [X3DNode,X3DMetadataObject] MetadataBoolean contains a typed list of values providing metadata information about its parent node. Further information about this specific Metadata* node may be provided by a single child Metadata* node with containerField="metadata".
  • Hint: use containerField="value" if the parent node is MetadataSet.
  • Hint: if a metadata node is needed as a top-level root node for the scene, first insert a parent WorldInfo (or WorldInfo/MetadataSet) to contain it.
  • Hint: if present, an IS statement is the first child within any other node.
  • Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any other sibling nodes.
  • Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo and Metadata* nodes are persistent and inspectable at run time.
  • Hint: X3D for Web Authors, Chapter 15, Metadata Information http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.html

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: MetadataBoolean, X3D Tooltips: MetadataBoolean, X3D Scene Authoring Hints: Metadata
  • Method Summary

    Modifier and Type Method Description
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String getName()
    Provide String value from inputOutput SFString field named name.
    java.lang.String getReference()
    Provide String value from inputOutput SFString field named reference.
    boolean[] getValue()
    Provide array of boolean results from inputOutput MFBool field named value.
    MetadataBoolean setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    MetadataBoolean setName​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named name.
    MetadataBoolean setReference​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named reference.
    MetadataBoolean setValue​(boolean[] newValue)
    Accessor method to assign boolean array to inputOutput MFBool field named value.
  • Method Details

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      MetadataBoolean setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      MetadataBoolean - 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
    • getName

      java.lang.String getName()
      Provide String value from inputOutput SFString field named name.

      Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes.
      Specified by:
      getName in interface X3DMetadataObject
      Returns:
      value of name field
    • setName

      MetadataBoolean setName​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named name.

      Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes.

      @see X3D Scene Authoring Hints: Naming Conventions
      Specified by:
      setName in interface X3DMetadataObject
      Parameters:
      newValue - is new value for the name field.
      Returns:
      MetadataBoolean - 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
    • getReference

      java.lang.String getReference()
      Provide String value from inputOutput SFString field named reference.

      Tooltip: Reference to the metadata standard or definition defining this particular metadata value. *
      Specified by:
      getReference in interface X3DMetadataObject
      Returns:
      value of reference field
    • setReference

      MetadataBoolean setReference​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named reference.

      Tooltip: Reference to the metadata standard or definition defining this particular metadata value. *
      Specified by:
      setReference in interface X3DMetadataObject
      Parameters:
      newValue - is new value for the reference field.
      Returns:
      MetadataBoolean - 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
    • getValue

      boolean[] getValue()
      Provide array of boolean results from inputOutput MFBool field named value.

      Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.
      • Warning: use lower-case values ("true false") for .x3d XML encoding, and upper-case values ("TRUE FALSE") for .x3dv ClassicVRML encoding.
      Returns:
      value of value field
    • setValue

      MetadataBoolean setValue​(boolean[] newValue)
      Accessor method to assign boolean array to inputOutput MFBool field named value.

      Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.
      • Warning: use lower-case values ("true false") for .x3d XML encoding, and upper-case values ("TRUE FALSE") for .x3dv ClassicVRML encoding.
      Parameters:
      newValue - is new value for the value field.
      Returns:
      MetadataBoolean - 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