Interface MetadataDouble

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

public interface MetadataDouble
extends X3DNode, X3DMetadataObject
The metadata provided by this node is contained in the double-precision floating point numbers of the value field.

X3D node tooltip: [X3DNode,X3DMetadataObject] MetadataDouble 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: The choice of MetadataDouble versus MetadataFloat usually depends on the relevant tool utilizing the value, or else the relevant metadata reference defining the value.
  • 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: MetadataDouble, X3D Tooltips: MetadataDouble, 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.
    double[] getValue()
    Provide array of double results from inputOutput MFDouble field named value.
    MetadataDouble setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    MetadataDouble setName​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named name.
    MetadataDouble setReference​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named reference.
    MetadataDouble setValue​(double[] newValue)
    Accessor method to assign double array to inputOutput MFDouble 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

      MetadataDouble 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:
      MetadataDouble - 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

      MetadataDouble 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:
      MetadataDouble - 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

      MetadataDouble 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:
      MetadataDouble - 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

      double[] getValue()
      Provide array of double results from inputOutput MFDouble field named value.

      Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.
      • 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 value field
    • setValue

      MetadataDouble setValue​(double[] newValue)
      Accessor method to assign double array to inputOutput MFDouble field named value.

      Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.
      • 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 value field.
      Returns:
      MetadataDouble - 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