Class StepsTween

StepsTween defines a step-wise movement between 2 values.

Hierarchy

Constructors

constructor

Accessors

from steps to typeName

Methods

then toJSON tweenEquation update

Constructors

constructor

  • Parameters

    • from: number

      The value to start the tween from.

    • to: number

      The value to end the tween at.

    • steps: number

      How many step movements to take in getting to the destination value.

    Returns StepsTween

Accessors

from

  • get from(): number

  • The value to start the tween from.

    Returns number

steps

  • get steps(): number

  • How many step movements to take in getting to the destination value.

    Returns number

  • set steps(value: number): void

  • Parameters

    • value: number

    Returns void

to

  • get to(): number

  • The value to end the tween at.

    Returns number

typeName

  • get typeName(): string

  • Returns the name of this type. This can be used rather than instanceof which is sometimes unreliable.

    Returns string

Methods

then

  • Allows for tweens to be chained one after another.

    Parameters

    • tween: ITween

      The next tween to follow after the current one.

    • weight: number = 1

      Weighting to determine how much of the tweening time that the new tween gets.

    Returns ITween

toJSON

  • Used by the library for the custom serialization of tween objects

    Returns { from: number; steps: number; to: number; type: string }

    • from: number
    • steps: number
    • to: number
    • type: string

tweenEquation

  • Represents the equation of how the tween value changes over time. Think of a cartesian graph, where the x-axis is time as a percent, and the y-axis is how far in its journey as a percent from from to to the tween is.

    Returns

    Should return a value ranging from 0 to 1

    Parameters

    • percent: number

      Expects a value ranging from 0 to 1

    Returns number

update

  • Accepts a percent value and returns a corresponding value somewhere between the from and to values.

    Parameters

    • percent: number

      Expects a value ranging from 0 to 1.

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc