Class AnchorObject

  • All Implemented Interfaces:
    X3DChildNode, X3DNode, X3DBoundedObject, X3DGroupingNode, Anchor, X3DUrlObject

    public class AnchorObject
    extends X3DConcreteNode
    implements Anchor
    X3D node tooltip: [X3DGroupingNode,X3DUrlObject] Anchor is a Grouping node that can contain most nodes. When the user selects any of the geometry contained by the Anchor node, the browser either jumps to another viewpoint (similar to HTML bookmark) or else loads content (such as X3D, an image or HTML) specified by the url field. Newly loaded content completely replaces current content, if the value of parameter field indicates using the same window.
    • Hint: insert a Shape node before adding geometry or Appearance.
    • Hint: apply containerField='watchList' when parent node is LoadSensor.

    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: Anchor, X3D Tooltips: Anchor, X3D Scene Authoring Hints
    • Field Detail

      • NAME

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

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

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Networking component level for this element: 2
        See Also:
        Constant Field Values
      • BBOXCENTER_DEFAULT_VALUE

        public static final float[] BBOXCENTER_DEFAULT_VALUE
        SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • BBOXSIZE_DEFAULT_VALUE

        public static final float[] BBOXSIZE_DEFAULT_VALUE
        SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
      • DESCRIPTION_DEFAULT_VALUE

        public static final java.lang.String DESCRIPTION_DEFAULT_VALUE
        SFString field named description has default value equal to an empty string.
        See Also:
        Constant Field Values
      • IS_DEFAULT_VALUE

        public static final ISObject 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).
      • PARAMETER_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> PARAMETER_DEFAULT_VALUE
        MFString field named parameter has default value equal to an empty list.
      • URL_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> URL_DEFAULT_VALUE
        MFString field named url has default value equal to an empty list.
      • toField_ADDCHILDREN

        public static final java.lang.String toField_ADDCHILDREN
        toField ROUTE name for MFNode field named addChildren.
        See Also:
        Constant Field Values
      • fromField_CHILDREN

        public static final java.lang.String fromField_CHILDREN
        fromField ROUTE name for MFNode field named children.
        See Also:
        Constant Field Values
      • toField_CHILDREN

        public static final java.lang.String toField_CHILDREN
        toField ROUTE name for MFNode field named children.
        See Also:
        Constant Field Values
      • fromField_DESCRIPTION

        public static final java.lang.String fromField_DESCRIPTION
        fromField ROUTE name for SFString field named description.
        See Also:
        Constant Field Values
      • toField_DESCRIPTION

        public static final java.lang.String toField_DESCRIPTION
        toField ROUTE name for SFString field named description.
        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_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_PARAMETER

        public static final java.lang.String fromField_PARAMETER
        fromField ROUTE name for MFString field named parameter.
        See Also:
        Constant Field Values
      • toField_PARAMETER

        public static final java.lang.String toField_PARAMETER
        toField ROUTE name for MFString field named parameter.
        See Also:
        Constant Field Values
      • toField_REMOVECHILDREN

        public static final java.lang.String toField_REMOVECHILDREN
        toField ROUTE name for MFNode field named removeChildren.
        See Also:
        Constant Field Values
      • fromField_URL

        public static final java.lang.String fromField_URL
        fromField ROUTE name for MFString field named url.
        See Also:
        Constant Field Values
      • toField_URL

        public static final java.lang.String toField_URL
        toField ROUTE name for MFString field named url.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AnchorObject

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

        public AnchorObject​(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: Anchor
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the Anchor element: Networking
        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: 2
        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
      • setBboxCenter

        public AnchorObject setBboxCenter​(float[] newValue)
        Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

        Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
        Specified by:
        setBboxCenter in interface Anchor
        Specified by:
        setBboxCenter in interface X3DBoundedObject
        Specified by:
        setBboxCenter in interface X3DGroupingNode
        Parameters:
        newValue - is new value for the bboxCenter field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxCenter

        public AnchorObject setBboxCenter​(SFVec3fObject newValue)
        Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
        Parameters:
        newValue - is new value for the bboxCenter field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxCenter

        public AnchorObject setBboxCenter​(float x,
                                          float y,
                                          float z)
        Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxCenter

        public AnchorObject setBboxCenter​(double x,
                                          double y,
                                          double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxCenter

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

        public float[] getBboxSize()
        Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

        Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
        Specified by:
        getBboxSize in interface Anchor
        Specified by:
        getBboxSize in interface X3DBoundedObject
        Specified by:
        getBboxSize in interface X3DGroupingNode
        Returns:
        value of bboxSize field
      • setBboxSize

        public AnchorObject setBboxSize​(float[] newValue)
        Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

        Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
        Specified by:
        setBboxSize in interface Anchor
        Specified by:
        setBboxSize in interface X3DBoundedObject
        Specified by:
        setBboxSize in interface X3DGroupingNode
        Parameters:
        newValue - is new value for the bboxSize field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxSize

        public AnchorObject setBboxSize​(SFVec3fObject newValue)
        Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
        Parameters:
        newValue - is new value for the bboxSize field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxSize

        public AnchorObject setBboxSize​(float x,
                                        float y,
                                        float z)
        Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxSize

        public AnchorObject setBboxSize​(double x,
                                        double y,
                                        double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBboxSize

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

        public X3DNode[] getChildren()
        Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.

        Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
        • Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
        • Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
        • Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
        • Hint: X3D Architecture 10.2.1 Grouping and children node types, http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes


        Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
        Specified by:
        getChildren in interface Anchor
        Specified by:
        getChildren in interface X3DGroupingNode
        Returns:
        value of children field
        See Also:
        X3DChildNode
      • getChildrenList

        public java.util.ArrayList<X3DNode> getChildrenList()
        Utility method to get ArrayList value of MFNode children field, similar to getChildren().
        Returns:
        value of children field
      • setChildren

        public AnchorObject setChildren​(X3DNode[] newValue)
        Accessor method to assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.

        Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
        • Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
        • Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
        • Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
        • Hint: X3D Architecture 10.2.1 Grouping and children node types, http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes


        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
        Specified by:
        setChildren in interface Anchor
        Specified by:
        setChildren in interface X3DGroupingNode
        Parameters:
        newValue - is new value for the children field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChildren

        public AnchorObject setChildren​(java.util.ArrayList<X3DChildNode> newValue)
        Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).
        Parameters:
        newValue - is new value for the children field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChildren

        public void addChildren​(X3DNode newValue)
        Add single node to existing array of children nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the children field.
      • addChildren

        public AnchorObject addChildren​(ProtoInstanceObject newValue)
        Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the parts field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChild

        public AnchorObject addChild​(X3DChildNode newValue)
        Utility method to add single child element to contained list of existing children nodes (if any).
        Parameters:
        newValue - is new node value to be appended the children field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChildren

        public void addChildren​(X3DNode[] newValue)
        Add array of children nodes to array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
        Specified by:
        addChildren in interface Anchor
        Specified by:
        addChildren in interface X3DGroupingNode
        Parameters:
        newValue - is new value array to be appended the children field.
      • setChildren

        public void setChildren​(X3DNode newValue)
        Set single children node, replacing prior array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.
        Specified by:
        setChildren in interface Anchor
        Specified by:
        setChildren in interface X3DGroupingNode
        Parameters:
        newValue - is new node for the children field (restricted to X3DChildNode)
      • clearChildren

        public AnchorObject clearChildren()
        Utility method to clear MFNode value of children field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasChildren

        public boolean hasChildren()
        Indicate whether an object is available for inputOutput MFNode field children.
        Returns:
        whether a properly typed node or ProtoInstance array or CommentsBlock is available.
        See Also:
        getChildren()
      • addComments

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

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

        public AnchorObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to children field
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getDescription

        public java.lang.String getDescription()
        Provide String value from inputOutput SFString field named description.

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • 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:
        getDescription in interface Anchor
        Returns:
        value of description field
      • setDescription

        public AnchorObject setDescription​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named description.

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • 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:
        setDescription in interface Anchor
        Parameters:
        newValue - is new value for the description field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDescription

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

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

        public AnchorObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        AnchorObject - 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
      • getParameter

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

        Tooltip: If provided, parameter tells the X3D player where to to redirect the loaded url.
        • Hint: set parameter value as target=_blank to load the target url into a new browser frame.
        • Hint: set parameter value as target=frame_name to load target url into another browser frame.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "http://www.web3d.org" "http://www.web3d.org/about" "etc." Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        getParameter in interface Anchor
        Returns:
        value of parameter field
      • getParameterList

        public java.util.ArrayList<java.lang.String> getParameterList()
        Utility method to get ArrayList value of MFString parameter field, similar to getParameter().
        Returns:
        value of parameter field
      • setParameter

        public AnchorObject setParameter​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named parameter.

        Tooltip: If provided, parameter tells the X3D player where to to redirect the loaded url.
        • Hint: set parameter value as target=_blank to load the target url into a new browser frame.
        • Hint: set parameter value as target=frame_name to load target url into another browser frame.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "http://www.web3d.org" "http://www.web3d.org/about" "etc." Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        setParameter in interface Anchor
        Parameters:
        newValue - is new value for the parameter field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setParameter

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

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

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

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

        public AnchorObject clearParameter()
        Utility method to clear MFString value of parameter field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addParameter

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

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

        Tooltip: Address of replacement world, or #ViewpointDEFName within the current scene, or alternate Web resource, activated by the user selecting Shape geometry within the Anchor children nodes.
        • Hint: jump to a world's internal viewpoint by appending viewpoint name (e.g. #ViewpointName, someOtherCoolWorld.x3d#GrandTour).
        • Hint: jump to a local viewpoint by only using viewpoint name (e.g. #GrandTour).
        • Hint: binding a different Viewpoint triggers an isBound event that can initiate other user-arrival reactions via event chains to interpolators or scripts.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
        • Hint: pop up a new window with url value as follows: "JavaScript:window.open('somePage.html','popup','width=240,height=240');location.href='HelloWorld.x3d'"
        • Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
        Specified by:
        getUrl in interface Anchor
        Specified by:
        getUrl in interface X3DUrlObject
        Returns:
        value of url field
      • getUrlList

        public java.util.ArrayList<java.lang.String> getUrlList()
        Utility method to get ArrayList value of MFString url field, similar to getUrl().
        Returns:
        value of url field
      • setUrl

        public AnchorObject setUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named url.

        Tooltip: Address of replacement world, or #ViewpointDEFName within the current scene, or alternate Web resource, activated by the user selecting Shape geometry within the Anchor children nodes.
        • Hint: jump to a world's internal viewpoint by appending viewpoint name (e.g. #ViewpointName, someOtherCoolWorld.x3d#GrandTour).
        • Hint: jump to a local viewpoint by only using viewpoint name (e.g. #GrandTour).
        • Hint: binding a different Viewpoint triggers an isBound event that can initiate other user-arrival reactions via event chains to interpolators or scripts.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
        • Hint: pop up a new window with url value as follows: "JavaScript:window.open('somePage.html','popup','width=240,height=240');location.href='HelloWorld.x3d'"
        • Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
        Specified by:
        setUrl in interface Anchor
        Specified by:
        setUrl in interface X3DUrlObject
        Parameters:
        newValue - is new value for the url field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUrl

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

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

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

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

        public AnchorObject clearUrl()
        Utility method to clear MFString value of url field.
        Returns:
        AnchorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addUrl

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

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

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

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

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