Class Animation

Class for animation handling

Param

Delta time from start of animation

Param

Array of Eases animation functions

Param

Queue of future animations

Param

Function for handling of interframe modification

Param

Animation duration in milliseconds

Param

Ease animation function factory

Hierarchy

Animation

Properties

`Readonly` action

action: AnimationFrameCallback

delta

delta: number = 0

`Readonly` duration

duration: number

eases

eases: Ease[]

`Readonly` easing

easing: AnimationEasing = AnimationEasings.linear

`Readonly` nextAnimations

nextAnimations: Animation[] = ...

`Readonly` values

values: [number, number][]

Methods

NextAnimation

NextAnimation(values: [number, number][], action: AnimationFrameCallback, duration?: number, easing?: AnimationEasing): Animation
Add and create animation which has to be executed subsequently

Returns
new Animation
Parameters
- values: [number, number][]
  
  Array of start and end animation values
- action: AnimationFrameCallback
  
  Function for handling of interframe modification
- duration: number = ...
- easing: AnimationEasing = ...
Returns Animation

addNextAnimations

addNextAnimations(animations: Animation | Animation[]): Animation
Add animations which has to be executed subsequently

Returns
Object itself for fluent interface
Parameters
- animations: Animation | Animation[]
  
  Subsequent Animation or Array of them
Returns Animation

allOffAllAnimationEnd

allOffAllAnimationEnd(): Animation
Remove all listeners from All Animation End Event

Returns
Object itself for fluent interface

Returns Animation

allOffAnimationEnd

allOffAnimationEnd(): Animation
Remove all listeners from Animation End Event

Returns
Object itself for fluent interface

Returns Animation

allOffEveryAnimationEnd

allOffEveryAnimationEnd(): Animation
Remove all listeners from Every Animation End Event

Returns
Object itself for fluent interface

Returns Animation

finish

finish(emitEvents?: boolean): undefined | Animation
Finish current animation and start the next one on the sequence

Returns
Future animations or undefined
Parameters
- emitEvents: boolean = true
  
  Flag that tells whether the function should emit any events
Returns undefined | Animation

finishAll

finishAll(emitEvents?: boolean): void
Finish all animations
Parameters
- emitEvents: boolean = true
  
  Flag that tells whether the function should emit any events
Returns void

getFinalValues

getFinalValues(): number[]
Get final value of queued animations

Returns
Final values of the animations

Returns number[]

getTimeUntilFinish

getTimeUntilFinish(): number
Get time until all queued animations will finish

Returns number

isOver

isOver(): boolean
Get is animation over and there are no queued animations

Returns boolean

offAllAnimationEnd

offAllAnimationEnd(token: Token): boolean
Remove a listener from All Animation End Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of the listener
Returns boolean

offAnimationEnd

offAnimationEnd(token: Token): boolean
Remove a listener from Animation End Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of the listener
Returns boolean

offEveryAnimationEnd

offEveryAnimationEnd(token: Token): boolean
Remove a listener from Every Animation End Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of the listener
Returns boolean

onAllAnimationEnd

onAllAnimationEnd(action: VoidFunction, token?: Token): Token
Subscribe on all subsequent animations end event

Returns
Token of the event listener
Parameters
- action: VoidFunction
  
  Event listener
- Optional token: Token
Returns Token

onAnimationEnd

onAnimationEnd(action: ((nextAnimation?: Animation) => void), token?: Token): Token
Subscribe on current animation end event

Returns
Token of the event listener
Parameters
- action: ((nextAnimation?: Animation) => void)
  
  Event listener
  - - (nextAnimation?: Animation): void
    - Parameters
      
      Optional nextAnimation: Animation
      
      Returns void
- Optional token: Token
Returns Token

onAnimationStart

onAnimationStart(action: (() => void), token?: Token): Token
Subscribe on current animation start event

Returns
Token of the event listener
Parameters
- action: (() => void)
  
  Event listener
  - - (): void
    - Returns void
- Optional token: Token
Returns Token

onEveryAnimationEnd

onEveryAnimationEnd(action: ((nextAnimation?: Animation) => void), token?: Token): Token
Subscribe on every subsequent animations end event

Returns
Token of the event listener
Parameters
- action: ((nextAnimation?: Animation) => void)
  
  Event listener
  - - (nextAnimation?: Animation): void
    - Parameters
      
      Optional nextAnimation: Animation
      
      Returns void
- Optional token: Token
Returns Token

start

start(): Animation
Starts an animation

Returns
Object itself for fluent interface

Returns Animation