Class TextObject

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: Text.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the Text element: Text
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Text component level for this element: 1
        See Also:
        Constant Field Values
      • FONTSTYLE_DEFAULT_VALUE

        public static final X3DFontStyleNode FONTSTYLE_DEFAULT_VALUE
        SFNode field named fontStyle has default value null (Java syntax) or NULL (XML syntax).
      • IS_DEFAULT_VALUE

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

        public static final java.util.ArrayList<java.lang.Float> LENGTH_DEFAULT_VALUE
        MFFloat field named length has default value equal to an empty list.
      • MAXEXTENT_DEFAULT_VALUE

        public static final float MAXEXTENT_DEFAULT_VALUE
        SFFloat field named maxExtent has default value 0.0f (Java syntax) or 0.0 (XML syntax).
        See Also:
        Constant Field Values
      • METADATA_DEFAULT_VALUE

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

        public static final boolean SOLID_DEFAULT_VALUE
        SFBool field named solid has default value false (Java syntax) or false (XML syntax).
        See Also:
        Constant Field Values
      • STRING_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> STRING_DEFAULT_VALUE
        MFString field named string has default value equal to an empty list.
      • fromField_FONTSTYLE

        public static final java.lang.String fromField_FONTSTYLE
        fromField ROUTE name for SFNode field named fontStyle.
        See Also:
        Constant Field Values
      • toField_FONTSTYLE

        public static final java.lang.String toField_FONTSTYLE
        toField ROUTE name for SFNode field named fontStyle.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_LENGTH

        public static final java.lang.String fromField_LENGTH
        fromField ROUTE name for MFFloat field named length.
        See Also:
        Constant Field Values
      • toField_LENGTH

        public static final java.lang.String toField_LENGTH
        toField ROUTE name for MFFloat field named length.
        See Also:
        Constant Field Values
      • fromField_LINEBOUNDS

        public static final java.lang.String fromField_LINEBOUNDS
        fromField ROUTE name for MFVec2f field named lineBounds.
        See Also:
        Constant Field Values
      • fromField_MAXEXTENT

        public static final java.lang.String fromField_MAXEXTENT
        fromField ROUTE name for SFFloat field named maxExtent.
        See Also:
        Constant Field Values
      • toField_MAXEXTENT

        public static final java.lang.String toField_MAXEXTENT
        toField ROUTE name for SFFloat field named maxExtent.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_ORIGIN

        public static final java.lang.String fromField_ORIGIN
        fromField ROUTE name for SFVec3f field named origin.
        See Also:
        Constant Field Values
      • fromField_STRING

        public static final java.lang.String fromField_STRING
        fromField ROUTE name for MFString field named string.
        See Also:
        Constant Field Values
      • toField_STRING

        public static final java.lang.String toField_STRING
        toField ROUTE name for MFString field named string.
        See Also:
        Constant Field Values
      • fromField_TEXTBOUNDS

        public static final java.lang.String fromField_TEXTBOUNDS
        fromField ROUTE name for SFVec2f field named textBounds.
        See Also:
        Constant Field Values
    • Constructor Detail

      • 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 Detail

      • 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
      • 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()
      • 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).
      • 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).
      • 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).
      • 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​(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)
      • 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
      • 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).
      • 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)
      • 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)