Class Animator

Hierarchy

EventEmitter
- Animator

Index

Constructors

Properties

Methods

add animate cancel emit get getValue hasEvent off on once update

Constructors

constructor

new Animator(): Animator
Returns Animator
Overrides EventEmitter.constructor
- Defined in Animation/Animator.ts:89

Properties

`Protected` variables

variables: Map<string, AnimatorVariable<AnimatorVariableType>>

Methods

add

add(name: string, init: AnimatorVariableType, easing?: EasingFunc, type?: UniformType): void
Parameters
- name: string
- init: AnimatorVariableType
- easing: EasingFunc = Easings.easeInOutCubic
- Optional type: UniformType
Returns void
- Defined in Animation/Animator.ts:97

animate

animate(name: string, value: AnimatorVariableType, duration?: number, cb?: (() => void)): void
Parameters
- name: string
- value: AnimatorVariableType
- duration: number = 1
- Optional cb: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in Animation/Animator.ts:139

cancel

cancel(name: string): void
Parameters
- name: string
Returns void
- Defined in Animation/Animator.ts:129

emit

emit(event: string, args?: any[]): void
Parameters
- event: string
- Optional args: any[]
Returns void
Inherited from EventEmitter.emit
- Defined in utils/EventEmitter.ts:55

get

get<T>(name: string): null | AnimatorVariable<T>
Type Parameters
- T extends AnimatorVariableType
Parameters
- name: string
Returns null | AnimatorVariable<T>
- Defined in Animation/Animator.ts:113

getValue

getValue<T>(name: string): null | T
Type Parameters
- T extends AnimatorVariableType
Parameters
- name: string
Returns null | T
- Defined in Animation/Animator.ts:119

hasEvent

hasEvent(event: string): boolean
Parameters
- event: string
Returns boolean
Inherited from EventEmitter.hasEvent
- Defined in utils/EventEmitter.ts:79

off

off(event: string, cb?: Function): void
Parameters
- event: string
- Optional cb: Function
Returns void
Inherited from EventEmitter.off
- Defined in utils/EventEmitter.ts:39

on

on(event: string, cb: Function): void
Parameters
- event: string
- cb: Function
Returns void
Inherited from EventEmitter.on
- Defined in utils/EventEmitter.ts:20

once

once(event: string, cb: Function): void
Parameters
- event: string
- cb: Function
Returns void
Inherited from EventEmitter.once
- Defined in utils/EventEmitter.ts:29

update

update(deltaTime: number): void
Parameters
- deltaTime: number
Returns void
- Defined in Animation/Animator.ts:162

Generated using TypeDoc