Class CoordinateChaserObject

    • Field Detail

      • NAME

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

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

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

        public static final double DURATION_DEFAULT_VALUE
        SFTime field named duration has default value 1 (Java syntax) or 1 (XML syntax).
        See Also:
        Constant Field Values
      • INITIALDESTINATION_DEFAULT_VALUE

        public static final float[] INITIALDESTINATION_DEFAULT_VALUE
        MFVec3f field named initialDestination has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • INITIALVALUE_DEFAULT_VALUE

        public static final float[] INITIALVALUE_DEFAULT_VALUE
        MFVec3f field named initialValue has default value {0f,0f,0f} (Java syntax) or 0 0 0 (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).
      • METADATA_DEFAULT_VALUE

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

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

        public static final java.lang.String fromField_ISACTIVE
        fromField ROUTE name for SFBool field named isActive.
        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
      • toField_SET_DESTINATION

        public static final java.lang.String toField_SET_DESTINATION
        toField ROUTE name for MFVec3f field named set_destination.
        See Also:
        Constant Field Values
      • toField_SET_VALUE

        public static final java.lang.String toField_SET_VALUE
        toField ROUTE name for MFVec3f field named set_value.
        See Also:
        Constant Field Values
      • fromField_VALUE_CHANGED

        public static final java.lang.String fromField_VALUE_CHANGED
        fromField ROUTE name for MFVec3f field named value_changed.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CoordinateChaserObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the CoordinateChaser element: Followers
        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
      • getDuration

        public double getDuration()
        Provide double value in seconds within allowed range of [0,infinity) from initializeOnly SFTime field named duration.

        Tooltip: [0,+infinity) duration is the time interval for filter response in seconds.
        • Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
        Specified by:
        getDuration in interface CoordinateChaser
        Specified by:
        getDuration in interface X3DChaserNode
        Returns:
        value of duration field
      • setDuration

        public CoordinateChaserObject setDuration​(double newValue)
        Accessor method to assign double value in seconds to initializeOnly SFTime field named duration.

        Tooltip: [0,+infinity) duration is the time interval for filter response in seconds.
        • Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
        Specified by:
        setDuration in interface CoordinateChaser
        Specified by:
        setDuration in interface X3DChaserNode
        Parameters:
        newValue - is new value for the duration field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDuration

        public CoordinateChaserObject setDuration​(SFTimeObject newValue)
        Assign typed object value to SFTime duration field, similar to setDuration(double).
        Parameters:
        newValue - is new value for the duration field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getInitialDestination

        public float[] getInitialDestination()
        Provide array of 3-tuple float results from initializeOnly MFVec3f field named initialDestination.

        Tooltip: Initial destination value for this node. *
        Specified by:
        getInitialDestination in interface CoordinateChaser
        Returns:
        value of initialDestination field
      • setInitialDestination

        public CoordinateChaserObject setInitialDestination​(float[] newValue)
        Accessor method to assign 3-tuple float array to initializeOnly MFVec3f field named initialDestination.

        Tooltip: Initial destination value for this node. *
        Specified by:
        setInitialDestination in interface CoordinateChaser
        Parameters:
        newValue - is new value for the initialDestination field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setInitialDestination

        public CoordinateChaserObject setInitialDestination​(MFVec3fObject newValue)
        Assign typed object value to MFVec3f initialDestination field, similar to setInitialDestination(float[]).
        Parameters:
        newValue - is new value for the initialDestination field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addInitialDestination

        public CoordinateChaserObject addInitialDestination​(SFVec3fObject newValue)
        Add singleton SFVec3fObject value to MFVec3f initialDestination field.
        Parameters:
        newValue - is new value to add to the initialDestination field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setInitialDestination

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

        public float[] getInitialValue()
        Provide array of 3-tuple float results from initializeOnly MFVec3f field named initialValue.

        Tooltip: Initial starting value for this node. *
        Specified by:
        getInitialValue in interface CoordinateChaser
        Returns:
        value of initialValue field
      • setInitialValue

        public CoordinateChaserObject setInitialValue​(float[] newValue)
        Accessor method to assign 3-tuple float array to initializeOnly MFVec3f field named initialValue.

        Tooltip: Initial starting value for this node. *
        Specified by:
        setInitialValue in interface CoordinateChaser
        Parameters:
        newValue - is new value for the initialValue field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setInitialValue

        public CoordinateChaserObject setInitialValue​(MFVec3fObject newValue)
        Assign typed object value to MFVec3f initialValue field, similar to setInitialValue(float[]).
        Parameters:
        newValue - is new value for the initialValue field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addInitialValue

        public CoordinateChaserObject addInitialValue​(SFVec3fObject newValue)
        Add singleton SFVec3fObject value to MFVec3f initialValue field.
        Parameters:
        newValue - is new value to add to the initialValue field.
        Returns:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setInitialValue

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

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

        public boolean getIsActive()
        Provide boolean value from outputOnly SFBool field named isActive.

        Tooltip: isActive true/false events are sent when follower-node computation starts/stops.
        • 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:
        getIsActive in interface CoordinateChaser
        Specified by:
        getIsActive in interface X3DChaserNode
        Specified by:
        getIsActive in interface X3DFollowerNode
        Returns:
        value of isActive field
      • clearMetadata

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

        public float[] getValue()
        Provide array of 3-tuple float results from outputOnly MFVec3f field named value_changed.

        Tooltip: Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau.
        • 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:
        getValue in interface CoordinateChaser
        Returns:
        value of value_changed field
      • setDEF

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

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

        public CoordinateChaserObject 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:
        CoordinateChaserObject - 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 CoordinateChaserObject 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:
        CoordinateChaserObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setUSE

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

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

        public CoordinateChaserObject 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:
        CoordinateChaserObject - 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)