Package org.web3d.x3d.jsail.Core

Class MetadataFloat

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Core.MetadataFloat
All Implemented Interfaces:
MetadataFloat, X3DMetadataObject, X3DNode
public class MetadataFloat extends X3DConcreteNode implements MetadataFloat
The metadata provided by this node is contained in the single-precision floating point numbers of the value field.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. X3D node tooltip: [X3DNode,X3DMetadataObject] MetadataFloat 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: typically use containerField="value" if the parent node is MetadataSet. Warning: default containerField="metadata" in X3D 3 changed to default containerField="value" in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures. Hint: explicitly defining containerField for Metadata nodes is always allowed and also unambiguous across each version of X3D. Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing that be sure to explicitly define containerField='metadata'. <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes</a> Warning: Metadata nodes can only contain other Metadata nodes. 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 <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.html" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.html</a> *


Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: MetadataFloat.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the MetadataFloat element: Core
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Core component level for this element: 1
      See Also:

    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

    • NAME_DEFAULT_VALUE

      public static final String NAME_DEFAULT_VALUE
      SFString field named name has default value equal to an empty string.
      See Also:

    • REFERENCE_DEFAULT_VALUE

      public static final String REFERENCE_DEFAULT_VALUE
      SFString field named reference has default value equal to an empty string.
      See Also:

    • VALUE_DEFAULT_VALUE

      public static final ArrayList<Float> VALUE_DEFAULT_VALUE
      MFFloat field named value has default value equal to an empty list.

    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:

    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:

    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:

    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:

    • fromField_NAME

      public static final String fromField_NAME
      fromField ROUTE name for SFString field named name.
      See Also:

    • toField_NAME

      public static final String toField_NAME
      toField ROUTE name for SFString field named name.
      See Also:

    • fromField_REFERENCE

      public static final String fromField_REFERENCE
      fromField ROUTE name for SFString field named reference.
      See Also:

    • toField_REFERENCE

      public static final String toField_REFERENCE
      toField ROUTE name for SFString field named reference.
      See Also:

    • fromField_VALUE

      public static final String fromField_VALUE
      fromField ROUTE name for MFFloat field named value.
      See Also:

    • toField_VALUE

      public static final String toField_VALUE
      toField ROUTE name for MFFloat field named value.
      See Also:

  • Constructor Details

    • MetadataFloat

      public MetadataFloat()
      Constructor for MetadataFloat to initialize member variables with default values.

    • MetadataFloat

      public MetadataFloat(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node

    • MetadataFloat

      public MetadataFloat(String DEFlabel, String newName)
      Utility constructor that assigns both DEF label and name, after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
      newName - name for this meta element
      See Also:

  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: MetadataFloat
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the MetadataFloat element: Core
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element

    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getFieldType

      public String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:

    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:

    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:

    • setIS

      public MetadataFloat setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearIS

      public MetadataFloat clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface MetadataFloat
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:


      • 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      • X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public MetadataFloat setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface MetadataFloat
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

      public MetadataFloat clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public MetadataFloat setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:

    • getName

      public 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. Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Specified by:
      getName in interface MetadataFloat
      Specified by:
      getName in interface X3DMetadataObject
      Overrides:
      getName in class X3DConcreteNode
      Returns:
      value of name field

    • setName

      public final MetadataFloat setName(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. Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


      @see X3D Scene Authoring Hints: Naming Conventions
      Specified by:
      setName in interface MetadataFloat
      Specified by:
      setName in interface X3DMetadataObject
      Parameters:
      newValue - is new value for the name field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setName

      public MetadataFloat setName(SFString newValue)
      Assign typed object value to SFString name field, similar to setName(String). // #0.e
      Parameters:
      newValue - is new value for the name field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getReference

      public 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 MetadataFloat
      Specified by:
      getReference in interface X3DMetadataObject
      Returns:
      value of reference field

    • setReference

      public MetadataFloat setReference(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 MetadataFloat
      Specified by:
      setReference in interface X3DMetadataObject
      Parameters:
      newValue - is new value for the reference field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setReference

      public MetadataFloat setReference(SFString newValue)
      Assign typed object value to SFString reference field, similar to setReference(String). // #0.e
      Parameters:
      newValue - is new value for the reference field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getValue

      public float[] getValue()
      Provide array of Float results from inputOutput MFFloat 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 &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      getValue in interface MetadataFloat
      Returns:
      value of value field

    • getValueList

      public ArrayList<Float> getValueList()
      Utility method to get ArrayList MFFloat value field, similar to getValue().
      Returns:
      value of value field

    • getValueString

      public String getValueString()
      Utility method to get String MFFloat value field, similar to getValue().
      Returns:
      value of value field

    • setValue

      public MetadataFloat setValue(float[] newValue)
      Accessor method to assign Float array to inputOutput MFFloat 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 &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      setValue in interface MetadataFloat
      Parameters:
      newValue - is new value for the value field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setValue

      public MetadataFloat setValue(MFFloat newValue)
      Assign typed object MFFloat value field, similar to setValue(float[]). // #0.e
      Parameters:
      newValue - is new value for the value field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setValue

      public MetadataFloat setValue(ArrayList<Float> newValue)
      Assign ArrayList MFFloat value field, similar to setValue(float[]).
      Parameters:
      newValue - is new value for the value field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearValue

      public MetadataFloat clearValue()
      Utility method to clear MFFloat value field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setValue

      public MetadataFloat setValue(int[] newValue)
      Assign floating-point array MFFloat value field, similar to setValue(float[]).
      Parameters:
      newValue - is new value for the value field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addValue

      public MetadataFloat addValue(float newValue)
      Add singleton float value to MFFloat value field.
      Parameters:
      newValue - is new value to add to the value field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addValue

      public MetadataFloat addValue(SFFloat newValue)
      Add singleton SFFloat value to MFFloat value field.
      Parameters:
      newValue - is new value to add to the value field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setValue

      public MetadataFloat setValue(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setValue(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final MetadataFloat setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setDEF

      public MetadataFloat setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUSE

      public String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene. *
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:

    • setUSE

      public final MetadataFloat setUSE(String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene. *


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setUSE

      public MetadataFloat setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final MetadataFloat setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

      public MetadataFloat setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
      Parameters:
      newValue - is new value for the class field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlID

      public final MetadataFloat setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlID

      public MetadataFloat setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
      Parameters:
      newValue - is new value for the id field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final MetadataFloat setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

      public MetadataFloat setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
      Parameters:
      newValue - is new value for the style field.
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public MetadataFloat setUSE(MetadataFloat DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

      public MetadataFloat addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

      public MetadataFloat addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public MetadataFloat addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      MetadataFloat - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:

    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:

    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:

    • hasNodeByDEF

      public boolean hasNodeByDEF(String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:

    • validate

      public String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)