Class EasingCurve

The EasingCurve provides a convenient API to evaluate an easing function.

Index

Constructors

Properties

evaluate inBounce inCubic inElastic inOutBounce inOutCubic inOutElastic inOutQuadratic inOutQuartic inQuadratic inQuartic linear none outBounce outCubic outElastic outQuadratic outQuartic step

Methods

Constructors

constructor

new EasingCurve(easingFunction): EasingCurve
Creates a new easing curve with a custom easing function;
Parameters
- easingFunction: ((value: number) => number)
  The easing function. Given an input between [0, 1] varying linearly over time, the function should return another value in the range of [0, 1] that eases the input value.
  - - (value): number
    - Parameters
      value: number
      Returns number
Returns EasingCurve

Properties

`Readonly`evaluate

evaluate: ((value: number) => number)

Evaluates the easing function.

Type declaration

- (value): number
- Parameters
  - value: number
    The current progress of the animation. Must be between [0, 1].
  Returns number
  The evaluated value.

`Static` `Readonly`inBounce

inBounce: EasingCurve

`Static` `Readonly`inCubic

inCubic: EasingCurve

`Static` `Readonly`inElastic

inElastic: EasingCurve

`Static` `Readonly`inOutBounce

inOutBounce: EasingCurve

`Static` `Readonly`inOutCubic

inOutCubic: EasingCurve

`Static` `Readonly`inOutElastic

inOutElastic: EasingCurve

`Static` `Readonly`inOutQuadratic

inOutQuadratic: EasingCurve

`Static` `Readonly`inOutQuartic

inOutQuartic: EasingCurve

`Static` `Readonly`inQuadratic

inQuadratic: EasingCurve

`Static` `Readonly`inQuartic

inQuartic: EasingCurve

`Static` `Readonly`linear

linear: EasingCurve

Linearly interpolates between the starting value and the ending value.

`Static` `Readonly`none

none: EasingCurve

Placeholder for no active animation

`Static` `Readonly`outBounce

outBounce: EasingCurve

`Static` `Readonly`outCubic

outCubic: EasingCurve

`Static` `Readonly`outElastic

outElastic: EasingCurve

`Static` `Readonly`outQuadratic

outQuadratic: EasingCurve

`Static` `Readonly`outQuartic

outQuartic: EasingCurve

`Static` `Readonly`step

step: EasingCurve

A step function that returns the start value if the time is < 0.5 otherwise the end value.

Methods

`Static`smoothStep

smoothStep(x0, x1): EasingCurve
Parameters
- x0: number
- x1: number
Returns EasingCurve