official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: PositionInterpolator2D

X3D: 3.3
Component: Interpolation
Status:
fully implemented

Quick Links

➨ Fields
➨ Properties

.nodeTypes. PositionInterpolator2D

The PositionInterpolator2D node linearly interpolates among a list of 2D vectors to produce an SFVec2f value_changed event. The keyValue field shall contain exactly as many values as in the key field.

HTML Encoding and Default Values⤴

<PositionInterpolator2D buffer='""' duration='"1"' interpolation='"LINEAR"' key='[]' keyValue='[]' metadata='X3DMetadataObject' set_fraction='0' ></PositionInterpolator2D>

Inheritance⤴


Constructor⤴

PositionInterpolator2D(ctx)⤴

Constructor for PositionInterpolator2D

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
buffer SFString "" X3DInterpolatorNode The url to the binary file, that contains the buffer data.
duration SFString "1" X3DInterpolatorNode Specifies the duration
interpolation SFString "LINEAR" X3DInterpolatorNode Contains the interpolation method
key MFFloat [] X3DInterpolatorNode The key field contains the list of key times, the keyValue field contains values for the target field, one complete set of values for each key. Interpolator nodes containing no keys in the key field shall not produce any events. However, an input event that replaces an empty key field with one that contains keys will cause the interpolator node to produce events the next time that a set_fraction event is received.
keyValue MFVec3f [] Defines the set of data points, that are used for interpolation.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
set_fraction SFFloat 0 X3DInterpolatorNode The set_fraction inputOnly field receives an SFFloat event and causes the interpolator node function to evaluate, resulting in a value_changed output event of the specified type with the same timestamp as the set_fraction event.