Class CanvasAnimation

A helper class providing utility methods for PIXI Canvas animation

Hierarchy

CanvasAnimation

Index

Constructors

constructor

Accessors

ticker

Properties

animations

Methods

Constructors

constructor

new CanvasAnimation(): CanvasAnimation

Returns CanvasAnimation

Accessors

Static ticker

get ticker(): any

Returns any

Properties

Static animations

animations: Object = {}

Track an object of active animations by name, context, and function This allows a currently playing animation to be referenced and terminated

Methods

Static animate

animate(attributes: CanvasAnimationAttribute[], options?: CanvasAnimationOptions): Promise<any>

Apply an animation from the current value of some attribute to a new value Resolve a Promise once the animation has concluded and the attributes have reached their new target
example
Animate Token Position
```
let animation = [
  {
    parent: token,
    attribute: "x",
    to: 1000
  },
  {
    parent: token,
    attribute: "y",
    to: 2000
  }
];
CanvasAnimation.animate(attributes, {duration:500});
```
Parameters
- attributes: CanvasAnimationAttribute[]
  
  An array of attributes to animate
- options: CanvasAnimationOptions = {}
  
  Additional options which customize the animation
Returns Promise<any>
A Promise which resolves to true once the animation has concluded or false if the animation was prematurely terminated

Static getAnimation

getAnimation(name: string): CanvasAnimationOptions

Retrieve an animation currently in progress by its name

Parameters
- name: string
  
  The animation name to retrieve
Returns CanvasAnimationOptions
The animation data, or undefined

Static terminateAnimation

terminateAnimation(name: string): void

If an animation using a certain name already exists, terminate it

Parameters
- name: string
  
  The animation name to terminate
Returns void

Static easeInOutCosine

easeInOutCosine(pt: number): number

Cosine based easing with smooth in-out.

Parameters
- pt: number
  
  The proportional animation timing on [0,1]
Returns number
The eased animation progress on [0,1]

Static easeOutCircle

easeOutCircle(pt: number): number

Shallow ease out.

Parameters
- pt: number
  
  The proportional animation timing on [0,1]
Returns number
The eased animation progress on [0,1]

Static easeInCircle

easeInCircle(pt: number): number

Shallow ease in.

Parameters
- pt: number
  
  The proportional animation timing on [0,1]
Returns number
The eased animation progress on [0,1]

Static Private _animateFrame

_animateFrame(deltaTime: number, animation: CanvasAnimationOptions): void

Generic ticker function to implement the animation. This animation wrapper executes once per frame for the duration of the animation event. Once the animated attributes have converged to their targets, it resolves the original Promise. The user-provided ontick function runs each frame update to apply additional behaviors.

Parameters
- deltaTime: number
  
  The incremental time which has elapsed
- animation: CanvasAnimationOptions
  
  The animation which is being performed
Returns void