Class SplinePositionInterpolator2DObject

    • Field Detail

      • NAME

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

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

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Interpolation component level for this element: 4
        See Also:
        Constant Field Values
      • CLOSED_DEFAULT_VALUE

        public static final boolean CLOSED_DEFAULT_VALUE
        SFBool field named closed has default value false (Java syntax) or false (XML syntax).
        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).
      • KEY_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Float> KEY_DEFAULT_VALUE
        MFFloat field named key has default value equal to an empty list.
      • KEYVALUE_DEFAULT_VALUE

        public static final float[] KEYVALUE_DEFAULT_VALUE
        MFVec2f field named keyValue has default value equal to an empty list.
      • KEYVELOCITY_DEFAULT_VALUE

        public static final float[] KEYVELOCITY_DEFAULT_VALUE
        MFVec2f field named keyVelocity has default value equal to an empty list.
      • METADATA_DEFAULT_VALUE

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

        public static final boolean NORMALIZEVELOCITY_DEFAULT_VALUE
        SFBool field named normalizeVelocity has default value false (Java syntax) or false (XML syntax).
        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_KEY

        public static final java.lang.String fromField_KEY
        fromField ROUTE name for MFFloat field named key.
        See Also:
        Constant Field Values
      • toField_KEY

        public static final java.lang.String toField_KEY
        toField ROUTE name for MFFloat field named key.
        See Also:
        Constant Field Values
      • fromField_KEYVALUE

        public static final java.lang.String fromField_KEYVALUE
        fromField ROUTE name for MFVec2f field named keyValue.
        See Also:
        Constant Field Values
      • toField_KEYVALUE

        public static final java.lang.String toField_KEYVALUE
        toField ROUTE name for MFVec2f field named keyValue.
        See Also:
        Constant Field Values
      • fromField_KEYVELOCITY

        public static final java.lang.String fromField_KEYVELOCITY
        fromField ROUTE name for MFVec2f field named keyVelocity.
        See Also:
        Constant Field Values
      • toField_KEYVELOCITY

        public static final java.lang.String toField_KEYVELOCITY
        toField ROUTE name for MFVec2f field named keyVelocity.
        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_NORMALIZEVELOCITY

        public static final java.lang.String fromField_NORMALIZEVELOCITY
        fromField ROUTE name for SFBool field named normalizeVelocity.
        See Also:
        Constant Field Values
      • toField_NORMALIZEVELOCITY

        public static final java.lang.String toField_NORMALIZEVELOCITY
        toField ROUTE name for SFBool field named normalizeVelocity.
        See Also:
        Constant Field Values
      • toField_SET_FRACTION

        public static final java.lang.String toField_SET_FRACTION
        toField ROUTE name for SFFloat field named set_fraction.
        See Also:
        Constant Field Values
      • fromField_VALUE_CHANGED

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

      • SplinePositionInterpolator2DObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the SplinePositionInterpolator2D element: Interpolation
        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: 4
        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
      • getClosed

        public boolean getClosed()
        Provide boolean value from initializeOnly SFBool field named closed.

        Tooltip: Whether or not the curve is closed (i.e. matching end values), with continuous velocity vectors as the interpolator transitions from the last key to the first key.
        • Warning: if velocity vectors at first and last keys are specified, the closed field is ignored.
        • Warning: if keyValues at first and last key are not identical, the closed field is ignored.
        Specified by:
        getClosed in interface SplinePositionInterpolator2D
        Returns:
        value of closed field
      • setClosed

        public SplinePositionInterpolator2DObject setClosed​(boolean newValue)
        Accessor method to assign boolean value to initializeOnly SFBool field named closed.

        Tooltip: Whether or not the curve is closed (i.e. matching end values), with continuous velocity vectors as the interpolator transitions from the last key to the first key.
        • Warning: if velocity vectors at first and last keys are specified, the closed field is ignored.
        • Warning: if keyValues at first and last key are not identical, the closed field is ignored.
        Specified by:
        setClosed in interface SplinePositionInterpolator2D
        Parameters:
        newValue - is new value for the closed field.
        Returns:
        SplinePositionInterpolator2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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()
      • getKey

        public float[] getKey()
        Provide array of Float results from inputOutput MFFloat field named key.

        Tooltip: Definition parameters for nonlinear-interpolation function time intervals, listed in non-decreasing order and corresponding to keyValue, keyVelocity array values.
        • Warning: number of keys must match number of keyValues!
        • Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
        • Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
        Specified by:
        getKey in interface SplinePositionInterpolator2D
        Specified by:
        getKey in interface X3DInterpolatorNode
        Returns:
        value of key field
      • getKeyList

        public java.util.ArrayList<java.lang.Float> getKeyList()
        Utility method to get ArrayList value of MFFloat key field, similar to getKey().
        Returns:
        value of key field
      • setKey

        public SplinePositionInterpolator2DObject setKey​(float[] newValue)
        Accessor method to assign Float array to inputOutput MFFloat field named key.

        Tooltip: Definition parameters for nonlinear-interpolation function time intervals, listed in non-decreasing order and corresponding to keyValue, keyVelocity array values.
        • Warning: number of keys must match number of keyValues!
        • Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
        • Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
        Specified by:
        setKey in interface SplinePositionInterpolator2D
        Specified by:
        setKey in interface X3DInterpolatorNode
        Parameters:
        newValue - is new value for the key field.
        Returns:
        SplinePositionInterpolator2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addKey

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

        public float[] getKeyValue()
        Provide array of 2-tuple float results from inputOutput MFVec2f field named keyValue.

        Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array.
        • Warning: number of keys must match number of keyValues!.
        Specified by:
        getKeyValue in interface SplinePositionInterpolator2D
        Returns:
        value of keyValue field
      • setKeyValue

        public SplinePositionInterpolator2DObject setKeyValue​(float[] newValue)
        Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named keyValue.

        Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array.
        • Warning: number of keys must match number of keyValues!.
        Specified by:
        setKeyValue in interface SplinePositionInterpolator2D
        Parameters:
        newValue - is new value for the keyValue field.
        Returns:
        SplinePositionInterpolator2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getKeyVelocity

        public float[] getKeyVelocity()
        Provide array of 2-tuple float results from inputOutput MFVec2f field named keyVelocity.

        Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array.
        • Warning: number of keys must match number of keyVelocity values!.
        Specified by:
        getKeyVelocity in interface SplinePositionInterpolator2D
        Returns:
        value of keyVelocity field
      • setKeyVelocity

        public SplinePositionInterpolator2DObject setKeyVelocity​(float[] newValue)
        Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named keyVelocity.

        Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array.
        • Warning: number of keys must match number of keyVelocity values!.
        Specified by:
        setKeyVelocity in interface SplinePositionInterpolator2D
        Parameters:
        newValue - is new value for the keyVelocity field.
        Returns:
        SplinePositionInterpolator2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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 2-tuple float results from outputOnly SFVec2f field named value_changed.

        Tooltip: Nonlinearly interpolated output value computed by using current time fraction along with corresponding key, keyValue and keyVelocity values.
        • 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 SplinePositionInterpolator2D
        Returns:
        value of value_changed field
      • setDEF

        public final SplinePositionInterpolator2DObject 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:
        SplinePositionInterpolator2DObject - 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 SplinePositionInterpolator2DObject 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:
        SplinePositionInterpolator2DObject - 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 SplinePositionInterpolator2DObject 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:
        SplinePositionInterpolator2DObject - 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 SplinePositionInterpolator2DObject setUSE​(SplinePositionInterpolator2DObject 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:
        SplinePositionInterpolator2DObject - 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)