Interface PositionInterpolator2D

All Superinterfaces:
X3DChildNode, X3DInterpolatorNode, X3DNode
All Known Implementing Classes:
PositionInterpolator2D

public interface PositionInterpolator2D extends X3DInterpolatorNode
PositionInterpolator2D generates a series of SFVec2f values.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. X3D node tooltip: [X3DInterpolatorNode] PositionInterpolator2D generates a series of SFVec2f values. Authors can ROUTE value_changed output events to a SFVec2f attribute. 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 &lt;component name='Interpolation' level='3'/&gt; Hint: example scenes and authoring assets at <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation</a> *


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    float[]
    Provide array of float results from inputOutput MFFloat field named key.
    float[]
    Provide array of 2-tuple float results from inputOutput MFVec2f field named keyValue.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[]
    Provide array of 2-tuple float results from outputOnly SFVec2f field named value_changed.
    setKey(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named key.
    setKeyValue(float[] newValue)
    Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named keyValue.
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  • Method Details

    • getKey

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

      Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array. Hint: number of keyValues must be an integer multiple of the number of keys! Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys. 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

      PositionInterpolator2D setKey(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named key.

      Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array. Hint: number of keyValues must be an integer multiple of the number of keys! Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys. 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:
      PositionInterpolator2D - 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 linear interpolation, each corresponding to an input-fraction value in the key array. Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. <a href="https://en.wikipedia.org/wiki/Step_function" target="_blank">https://en.wikipedia.org/wiki/Step_function</a> Hint: number of keyValues must be an integer multiple of the number of keys! Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys. *
      Returns:
      value of keyValue field
    • setKeyValue

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

      Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array. Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. <a href="https://en.wikipedia.org/wiki/Step_function" target="_blank">https://en.wikipedia.org/wiki/Step_function</a> Hint: number of keyValues must be an integer multiple of the number of keys! Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys. *
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      PositionInterpolator2D - 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. Hint: X3D Architecture 7.2.4 Metadata <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      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:
    • setMetadata

      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. Hint: X3D Architecture 7.2.4 Metadata <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      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:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • getValue

      float[] getValue()
      Provide array of 2-tuple float results from outputOnly SFVec2f field named value_changed.

      Tooltip: Linearly interpolated output value determined by current key time and corresponding keyValue pair. Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect. Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys. 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