Package org.web3d.x3d.sai.Interpolation

Interface SplinePositionInterpolator2D

All Superinterfaces:
X3DChildNode, X3DInterpolatorNode, X3DNode
All Known Implementing Classes:
SplinePositionInterpolator2D
public interface SplinePositionInterpolator2D
extends X3DInterpolatorNode
SplinePositionInterpolator2D performs non-linear interpolation among paired lists of 2-tuple values and velocities to produce an SFVec2f value_changed output event.

X3D node tooltip: (X3D version 3.2 or later) [X3DInterpolatorNode] SplinePositionInterpolator2D performs non-linear interpolation among paired lists of 2-tuple values and velocities to produce an SFVec2f value_changed output event.
  • Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
  • Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
  • Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='4'/>

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification: SplinePositionInterpolator2D, X3D Tooltips: SplinePositionInterpolator2D, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    boolean getClosed()
    Provide boolean value from initializeOnly SFBool field named closed.
    float[] getKey()
    Provide array of float results from inputOutput MFFloat field named key.
    float[] getKeyValue()
    Provide array of 2-tuple float results from inputOutput MFVec2f field named keyValue.
    float[] getKeyVelocity()
    Provide array of 2-tuple float results from inputOutput MFVec2f field named keyVelocity.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    boolean getNormalizeVelocity()
    Provide boolean value from inputOutput SFBool field named normalizeVelocity.
    float[] getValue()
    Provide array of 2-tuple float results from outputOnly SFVec2f field named value_changed.
    SplinePositionInterpolator2D setClosed​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named closed.
    SplinePositionInterpolator2D setKey​(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named key.
    SplinePositionInterpolator2D setKeyValue​(float[] newValue)
    Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named keyValue.
    SplinePositionInterpolator2D setKeyVelocity​(float[] newValue)
    Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named keyVelocity.
    SplinePositionInterpolator2D setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    SplinePositionInterpolator2D setNormalizeVelocity​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named normalizeVelocity.

  • Method Details

    • getClosed

      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.
      Returns:
      value of closed field

    • setClosed

      SplinePositionInterpolator2D 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.
      Parameters:
      newValue - is new value for the closed field.
      Returns:
      SplinePositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getKey

      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 X3DInterpolatorNode
      Returns:
      value of key field

    • setKey

      SplinePositionInterpolator2D 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 X3DInterpolatorNode
      Parameters:
      newValue - is new value for the key field.
      Returns:
      SplinePositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getKeyValue

      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!.
      Returns:
      value of keyValue field

    • setKeyValue

      SplinePositionInterpolator2D 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!.
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      SplinePositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getKeyVelocity

      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!.
      Returns:
      value of keyVelocity field

    • setKeyVelocity

      SplinePositionInterpolator2D 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!.
      Parameters:
      newValue - is new value for the keyVelocity field.
      Returns:
      SplinePositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DInterpolatorNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      SplinePositionInterpolator2D setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DInterpolatorNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      SplinePositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getNormalizeVelocity

      boolean getNormalizeVelocity()
      Provide boolean value from inputOutput SFBool field named normalizeVelocity.

      Tooltip: normalizeVelocity field specifies whether the velocity vectors are normalized to produce smooth speed transitions, or transformed into tangency vectors.
      Returns:
      value of normalizeVelocity field

    • setNormalizeVelocity

      SplinePositionInterpolator2D setNormalizeVelocity​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named normalizeVelocity.

      Tooltip: normalizeVelocity field specifies whether the velocity vectors are normalized to produce smooth speed transitions, or transformed into tangency vectors.
      Parameters:
      newValue - is new value for the normalizeVelocity field.
      Returns:
      SplinePositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getValue

      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.
      Returns:
      value of value_changed field