Class ROUTEObject

    • Field Detail

      • NAME

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

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

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

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

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

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

        public static final java.lang.String TONODE_DEFAULT_VALUE
        SFString field named toNode has default value equal to an empty string.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ROUTEObject

        public ROUTEObject()
        Constructor for ROUTEObject to initialize member variables with default values.
    • Method Detail

      • getElementName

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

        public final java.lang.String getComponent()
        Defines X3D component for the ROUTE element: Core
        Specified by:
        getComponent in class X3DConcreteElement
        Returns:
        X3D component for this element
      • getComponentLevel

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

        public 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 statement
        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 statement
        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 X3DConcreteStatement
      • getFromField

        public java.lang.String getFromField()
        Provide String value from inputOutput SFString field named fromField.

        Tooltip: fromField is the field name in the source node which is originating an event.
        Returns:
        value of fromField field
      • setFromField

        public ROUTEObject setFromField​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named fromField.

        Tooltip: fromField is the field name in the source node which is originating an event.
        Parameters:
        newValue - is new value for the fromField field.
        Returns:
        ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFromField

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

        public java.lang.String getFromNode()
        Provide String value from inputOutput SFString field named fromNode.

        Tooltip: fromNode is the DEF name of the node originating an event. *
        Returns:
        value of fromNode field
      • setFromNode

        public ROUTEObject setFromNode​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named fromNode.

        Tooltip: fromNode is the DEF name of the node originating an event. *
        Parameters:
        newValue - is new value for the fromNode field.
        Returns:
        ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFromNode

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

        public java.lang.String getToField()
        Provide String value from inputOutput SFString field named toField.

        Tooltip: toField is the field name in the destination node which is receiving an event.
        Returns:
        value of toField field
      • setToField

        public ROUTEObject setToField​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named toField.

        Tooltip: toField is the field name in the destination node which is receiving an event.
        Parameters:
        newValue - is new value for the toField field.
        Returns:
        ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setToField

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

        public java.lang.String getToNode()
        Provide String value from inputOutput SFString field named toNode.

        Tooltip: toNode is the DEF name of the destination node receiving an event. *
        Returns:
        value of toNode field
      • setToNode

        public ROUTEObject setToNode​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named toNode.

        Tooltip: toNode is the DEF name of the destination node receiving an event. *
        Parameters:
        newValue - is new value for the toNode field.
        Returns:
        ROUTEObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setToNode

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

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

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

        public ROUTEObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        ROUTEObject - 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)
      • setDEF

        @Deprecated
        public ROUTEObject setDEF​(java.lang.String newValue)
        Deprecated.
        DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
        Parameters:
        newValue - ignored
        Returns:
        unmodified object, this method is deprecated and has no effect
      • setUSE

        @Deprecated
        public ROUTEObject setUSE​(java.lang.String newValue)
        Deprecated.
        DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
        Parameters:
        newValue - ignored
        Returns:
        unmodified object, this method is deprecated and has no effect
      • setCssClass

        @Deprecated
        public ROUTEObject setCssClass​(java.lang.String newValue)
        Deprecated.