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

Index

Properties

action delta duration eases easing nextAnimations values

Methods

NextAnimation addEventListener addNextAnimations finish finishAll getFinalValues getTimeUntilFinish isOver removeEventListener start

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

addEventListener

addEventListener<K>(type: K, listener: ((event: AnimatorEventMap[K], info: unknown) => unknown), options?: LCJSAddEventListenerOptions): void
Type Parameters
- K extends keyof AnimatorEventMap
Parameters
- type: K
- listener: ((event: AnimatorEventMap[K], info: unknown) => unknown)
  - - (event: AnimatorEventMap[K], info: unknown): unknown
    - Parameters
      
      event: AnimatorEventMap[K]
      
      info: unknown
      
      Returns unknown
- Optional options: LCJSAddEventListenerOptions
Returns void

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

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

removeEventListener

removeEventListener<K>(type: K, listener: ((event: AnimatorEventMap[K], info: unknown) => unknown)): void
Type Parameters
- K extends keyof AnimatorEventMap
Parameters
- type: K
- listener: ((event: AnimatorEventMap[K], info: unknown) => unknown)
  - - (event: AnimatorEventMap[K], info: unknown): unknown
    - Parameters
      
      event: AnimatorEventMap[K]
      
      info: unknown
      
      Returns unknown
Returns void

start

start(): Animation
Starts an animation

Returns
Object itself for fluent interface

Returns Animation