Package org.web3d.x3d.sai.Core

Interface WorldInfo

All Superinterfaces:
X3DChildNode, X3DInfoNode, X3DNode
All Known Implementing Classes:
WorldInfoObject
public interface WorldInfo
extends X3DInfoNode
WorldInfo contains a title and simple persistent metadata information about an X3D scene. This node is strictly for documentation purposes and has no effect on the visual appearance or behaviour of the world.

X3D node tooltip: [X3DInfoNode] WorldInfo contains a title and persistent documentation or simple metadata information about an X3D scene.
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: WorldInfo, X3D Tooltips: WorldInfo, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    java.lang.String[] getInfo()
    Provide array of String results from inputOutput MFString field named info.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String getTitle()
    Provide String value from inputOutput SFString field named title.
    WorldInfo setInfo​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named info.
    WorldInfo setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    WorldInfo setTitle​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named title.

  • Method Details

    • getInfo

      java.lang.String[] getInfo()
      Provide array of String results from inputOutput MFString field named info.

      Tooltip: Additional information about this model.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Returns:
      value of info field

    • setInfo

      WorldInfo setInfo​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named info.

      Tooltip: Additional information about this model.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Parameters:
      newValue - is new value for the info field.
      Returns:
      WorldInfo - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DInfoNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      WorldInfo setMetadata​(X3DMetadataObject newValue)
      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.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DInfoNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      WorldInfo - 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

    • getTitle

      java.lang.String getTitle()
      Provide String value from inputOutput SFString field named title.

      Tooltip: title of this world, placed in window title.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Returns:
      value of title field

    • setTitle

      WorldInfo setTitle​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named title.

      Tooltip: title of this world, placed in window title.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Parameters:
      newValue - is new value for the title field.
      Returns:
      WorldInfo - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).