Class TextObject

java.lang.Object
All Implemented Interfaces:
X3DNode, X3DGeometryNode, Text

public class TextObject
extends X3DConcreteNode
implements Text
Text is a 2D (flat) geometry node that can contain multiple lines of string values.

X3D node tooltip: [X3DGeometryNode] Text is a 2D (flat) geometry node that can contain multiple lines of string values. Layout and styling is controlled by a contained FontStyle node.
  • Hint: String (computer science) https://en.wikipedia.org/wiki/String_(computer_science)
  • Hint: full internationalization (i18n) and localization (l10n) features are available for any written language.
  • Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
  • Hint: insert a Shape node before adding geometry or Appearance.
  • Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance node (with correct containerField value) for contained node content.

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:
X3D Abstract Specification: Text, X3D Tooltips: Text, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • TextObject

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

      public TextObject​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: Text
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the Text element: Text
      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 java.lang.String getFieldType​(java.lang.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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.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:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

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

      public X3DFontStyleNode getFontStyle()
      Provide X3DFontStyleNode instance (using a properly typed node) from inputOutput SFNode field fontStyle.
      Specified by:
      getFontStyle in interface Text
      Returns:
      value of fontStyle field
      See Also:
      getFontStyleProtoInstance()
    • setFontStyle

      public TextObject setFontStyle​(X3DFontStyleNode newValue)
      Accessor method to assign X3DFontStyleNode instance (using a properly typed node) to inputOutput SFNode field fontStyle.
      Specified by:
      setFontStyle in interface Text
      Parameters:
      newValue - is new value for the fontStyle field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setFontStyle(ProtoInstanceObject)
    • clearFontStyle

      public TextObject clearFontStyle()
      Utility method to clear SFNode value of fontStyle field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setFontStyle

      public TextObject setFontStyle​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fontStyle.
      Parameters:
      newValue - is new value for the fontStyle field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setFontStyle(X3DFontStyleNode)
    • hasFontStyle

      public boolean hasFontStyle()
      Indicate whether an object is available for inputOutput SFNode field fontStyle.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getFontStyle(), getFontStyleProtoInstance()
    • getIS

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

      public TextObject setIS​(ISObject newValue)
      Accessor method to assign ISObject 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:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public TextObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      TextObject - 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:
      getIS()
    • getLength

      public float[] getLength()
      Provide array of Float results within allowed range of [0,infinity) from inputOutput MFFloat field named length.

      Tooltip: Array of length values for each text string in the local coordinate system. Each string is stretched or compressed to fit. *
      Specified by:
      getLength in interface Text
      Returns:
      value of length field
    • getLengthList

      public java.util.ArrayList<java.lang.Float> getLengthList()
      Utility method to get ArrayList value of MFFloat length field, similar to getLength().
      Returns:
      value of length field
    • setLength

      public TextObject setLength​(float[] newValue)
      Accessor method to assign Float array to inputOutput MFFloat field named length.

      Tooltip: Array of length values for each text string in the local coordinate system. Each string is stretched or compressed to fit. *
      Specified by:
      setLength in interface Text
      Parameters:
      newValue - is new value for the length field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLength

      public TextObject setLength​(MFFloatObject newValue)
      Assign typed object value to MFFloat length field, similar to setLength(float[]).
      Parameters:
      newValue - is new value for the length field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLength

      public TextObject setLength​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat length field, similar to setLength(float[]).
      Parameters:
      newValue - is new value for the length field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearLength

      public TextObject clearLength()
      Utility method to clear MFFloat value of length field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setLength

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

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

      public TextObject addLength​(SFFloatObject newValue)
      Add singleton SFFloatObject value to MFFloat length field.
      Parameters:
      newValue - is new value to add to the length field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLength

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

      public float[] getLineBounds()
      Provide array of 2-tuple float results from outputOnly MFVec2f field named lineBounds.

      Tooltip: Array of 2D bounding box values for each line of text in the local coordinate system.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getLineBounds in interface Text
      Returns:
      value of lineBounds field
    • getMaxExtent

      public float getMaxExtent()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxExtent.

      Tooltip: Limits/compresses all text strings if max string length is longer than maxExtent, as measured in local coordinate system. *
      Specified by:
      getMaxExtent in interface Text
      Returns:
      value of maxExtent field
    • setMaxExtent

      public TextObject setMaxExtent​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named maxExtent.

      Tooltip: Limits/compresses all text strings if max string length is longer than maxExtent, as measured in local coordinate system. *
      Specified by:
      setMaxExtent in interface Text
      Parameters:
      newValue - is new value for the maxExtent field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMaxExtent

      public TextObject setMaxExtent​(SFFloatObject newValue)
      Assign typed object value to SFFloat maxExtent field, similar to setMaxExtent(float).
      Parameters:
      newValue - is new value for the maxExtent field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMaxExtent

      public TextObject setMaxExtent​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxExtent(float).
      Parameters:
      newValue - is new value for field
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

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

      public TextObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface Text
      Specified by:
      setMetadata in interface X3DGeometryNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public TextObject setMetadata​(ProtoInstanceObject 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:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)
    • 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:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getOrigin

      public float[] getOrigin()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named origin.

      Tooltip: origin of the text local coordinate system, in units of the coordinate system in which the Text node is embedded. The value of the origin field represents the upper left corner of the textBounds.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getOrigin in interface Text
      Returns:
      value of origin field
    • getSolid

      public boolean getSolid()
      Provide boolean value from initializeOnly SFBool field named solid.

      Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      • Warning: solid false not supported in VRML97.
      Specified by:
      getSolid in interface Text
      Returns:
      value of solid field
    • setSolid

      public TextObject setSolid​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named solid.

      Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).
      • Warning: default value true can completely hide geometry if viewed from wrong side!
      • Hint: if in doubt, use solid='false' for maximum visibility.
      • Warning: solid false not supported in VRML97.
      Specified by:
      setSolid in interface Text
      Parameters:
      newValue - is new value for the solid field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSolid

      public TextObject setSolid​(SFBoolObject newValue)
      Assign typed object value to SFBool solid field, similar to setSolid(boolean).
      Parameters:
      newValue - is new value for the solid field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getString

      public java.lang.String[] getString()
      Provide array of String results from inputOutput MFString field named string.

      Tooltip: Single or multiple string values to present as Text. Each value in the string array (including empty strings) gets displayed on a separate line.
      Specified by:
      getString in interface Text
      Returns:
      value of string field
    • getStringList

      public java.util.ArrayList<java.lang.String> getStringList()
      Utility method to get ArrayList value of MFString string field, similar to getString().
      Returns:
      value of string field
    • setString

      public TextObject setString​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named string.

      Tooltip: Single or multiple string values to present as Text. Each value in the string array (including empty strings) gets displayed on a separate line.
      Specified by:
      setString in interface Text
      Parameters:
      newValue - is new value for the string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setString

      public TextObject setString​(MFStringObject newValue)
      Assign typed object value to MFString string field, similar to setString(String[]).
      Parameters:
      newValue - is new value for the string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setString

      public TextObject setString​(SFStringObject newValue)
      Assign single SFString object value to MFString string field, similar to setString(String[]).
      Parameters:
      newValue - is new value for the string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setString

      public TextObject setString​(java.lang.String newValue)
      Assign singleton String value to MFString string field, similar to setString(String[]).
      Parameters:
      newValue - is new value for the string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setString

      public TextObject setString​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString string field, similar to setString(String[]).
      Parameters:
      newValue - is new value for the string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearString

      public TextObject clearString()
      Utility method to clear MFString value of string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addString

      public TextObject addString​(java.lang.String newValue)
      Add singleton String value to MFString string field.
      Parameters:
      newValue - is new value to add to the string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addString

      public TextObject addString​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString string field.
      Parameters:
      newValue - is new value to add to the string field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getTextBounds

      public float[] getTextBounds()
      Provide array of 2-tuple float results from outputOnly SFVec2f field named textBounds.

      Tooltip: 2D bounding box value for all lines of text in the local coordinate system.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getTextBounds in interface Text
      Returns:
      value of textBounds field
    • getDEF

      public java.lang.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.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final TextObject setDEF​(java.lang.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.

      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:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final TextObject setUSE​(java.lang.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:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final TextObject setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

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

      public TextObject setUSE​(TextObject 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:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public TextObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      TextObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

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

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

      public java.lang.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:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.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:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.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:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.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:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.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:
      findNodeByDEF(String)
    • validate

      public java.lang.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)