Class TweenOptions<Value, Obj>

Tween takes the following options:

Obj

  • an actual object, a function that returns an object, or null (in which case the value is internal only)

Obj

is set

From

  • defaults to current value

To

  • required

Duration

  • Time in ms. Defaults to 1000

Easing

  • Function of t in [0, 1]. Defaults to easing.linear

Interpolate

  • Function to use for setting a new value. Depends on data type, such as color, vector, angle, ...

Type Parameters

  • Value

  • Obj extends object = undefined

Constructors

constructor

Properties

duration easing from? interpolate obj? onSetup? onTeardown? onUpdate? property? to

Constructors

constructor

Properties

duration

duration: number = 1000

easing

easing: "linear" | EasingFunction | "easeInSine" | "easeOutSine" | "easeInOutSine" | "easeInQuad" | "easeOutQuad" | "easeInOutQuad" | "easeInCubic" | "easeOutCubic" | "easeInOutCubic" | "easeInQuart" | "easeOutQuart" | "easeInOutQuart" | "easeInQuint" | "easeOutQuint" | "easeInOutQuint" | "easeInExpo" | "easeOutExpo" | "easeInOutExpo" | "easeInCirc" | "easeOutCirc" | "easeInOutCirc" | "easeInBack" | "easeOutBack" | "easeInOutBack" | "easeInElastic" | "easeOutElastic" | "easeInOutElastic" | "easeOutBounce" | "easeInBounce" | "easeInOutBounce" = "linear"

Optional from

from?: Value

interpolate

interpolate: ((from, to, easeProgress) => Value)

Type declaration

Optional obj

obj?: Obj

Optional onSetup

onSetup?: (() => unknown)

Type declaration

    • (): unknown

    • Returns unknown

Optional onTeardown

onTeardown?: (() => unknown)

Type declaration

    • (): unknown

    • Returns unknown

Optional onUpdate

onUpdate?: ((value) => unknown)

Type declaration

    • (value): unknown

    • Parameters

      Returns unknown

Optional property

property?: keyof Obj

to

to: Value

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc