Class: ColorInterpolator

X3D: 3.3
Component: Interpolation
Status:
fully implemented

x3dom.nodeTypes. ColorInterpolator

The ColorInterpolator node interpolates among a list of MFColor key values to produce an SFColor (RGB) value_changed event. The number of colours in the keyValue field shall be equal to the number of key frames in the key field. A linear interpolation using the value of set_fraction as input is performed in HSV space. The results are undefined when interpolating between two consecutive keys with complementary hues.

HTML Encoding and Default Values

<ColorInterpolator key='[]' keyValue='[]' metadata='X3DMetadataObject' set_fraction='0' ></ColorInterpolator>

Inheritance


Constructor

ColorInterpolator(ctx)

Constructor for ColorInterpolator

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
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 MFColor [] Defines the set of data points, that are used for interpolation.
metadata SFNode X3DMetadataObject X3DInterpolatorNode 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.