Class Vector2Curve

Animation spline represented by a set of keyframes, each representing an endpoint of a cubic hermite curve. The spline can be evaluated at any time, and uses caching to speed up multiple sequential evaluations.

Note

Curves are expected to be immutable for threading purposes

Hierarchy

  • FrameworkObject
    • Vector2Curve

Constructors

constructor

Accessors

keyFrames

Methods

evaluate isEqual

Constructors

constructor

  • new Vector2Curve(keyframes?, isInternalConstructor?): Vector2Curve

  • Creates a new animation curve.

    Parameters

    • Optionalkeyframes: readonly Immutable<KeyFrameVec2>[]

      If TKeyframe<TVector2>: Keyframes to initialize the curve with. They must be sorted by time.

    • OptionalisInternalConstructor: boolean

    Returns Vector2Curve

Accessors

keyFrames

Methods

evaluate

  • evaluate(time, loop?): Vector2

  • Evaluate the animation curve at the specified time. If evaluating multiple values in a sequential order consider using the cached version of evaluate() for better performance.

    Parameters

    • time: number

      %Time to evaluate the curve at.

    • Optionalloop: boolean

      If true the curve will loop when it goes past the end or beggining. Otherwise the curve value will be clamped.

    Returns Vector2

    Interpolated value from the curve at provided time.

isEqual

  • isEqual(other): boolean

  • Compares the current animation curve against another one.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods