Class Animator

Hierarchy

EventDispatcher
- Animator

Constructors

constructor

new Animator(): Animator

Overrides THREE.EventDispatcher.constructor
- Defined in packages/ore-three/src/utils/Animator.ts:38
Returns Animator

Properties

Protected animatingCount

animatingCount: number = 0

dataBase

dataBase: {}

Type declaration

[key: string]: AnimatorVariableType

Protected dispatchEvents

dispatchEvents: Function[] = []

isAnimating

isAnimating: boolean = false

Protected variables

variables: {}

Type declaration

[key: string]: AnimatorVariable<AnimatorVariableType>

Methods

add

add<T>(params: AnimatorVariableParams<T>): AnimatorVariable<T>

- Defined in packages/ore-three/src/utils/Animator.ts:47
Type parameters
- T: AnimatorVariableType
Parameters
- params: AnimatorVariableParams<T>
Returns AnimatorVariable<T>

addEventListener

addEventListener<T>(type: T, listener: EventListener<Event, T, Animator>): void

Inherited from THREE.EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:30
Adds a listener to an event type.

Type parameters
- T: string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, Animator>
  
  The function that gets called when the event is fired.
Returns void

animate

animate<T>(name: string, goalValue: T, duration?: number, callback?: Function, easing?: EasingFunc): Promise<unknown>

- Defined in packages/ore-three/src/utils/Animator.ts:129
Type parameters
- T: AnimatorVariableType
Parameters
- name: string
- goalValue: T
- duration: number = 1
- Optional callback: Function
- Optional easing: EasingFunc
Returns Promise<unknown>

applyToUniforms

applyToUniforms(uniforms: Uniforms): void

- Defined in packages/ore-three/src/utils/Animator.ts:250
Parameters
- uniforms: Uniforms
Returns void

cancelAnimate

cancelAnimate(name: string): void

- Defined in packages/ore-three/src/utils/Animator.ts:189
Parameters
- name: string
Returns void

dispatchEvent

dispatchEvent(event: Event): void

Inherited from THREE.EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:50
Fire an event type.

Parameters
- event: Event
Returns void

get

get<T>(name: string): null | T

- Defined in packages/ore-three/src/utils/Animator.ts:210
Type parameters
- T: AnimatorVariableType
Parameters
- name: string
Returns null | T

Private getValueClone

getValueClone<T>(value: T): T

- Defined in packages/ore-three/src/utils/Animator.ts:294
Type parameters
- T: AnimatorVariableType
Parameters
- value: T
Returns T

getVariableObject

getVariableObject<T>(name: string, mute?: boolean): null | AnimatorVariable<T>

- Defined in packages/ore-three/src/utils/Animator.ts:226
Type parameters
- T: AnimatorVariableType
Parameters
- name: string
- mute: boolean = false
Returns null | AnimatorVariable<T>

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<Event, T, Animator>): boolean

Inherited from THREE.EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:37
Checks if listener is added to an event type.

Type parameters
- T: string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, Animator>
  
  The function that gets called when the event is fired.
Returns boolean

isAnimatingVariable

isAnimatingVariable(name: string, mute?: boolean): null | boolean

- Defined in packages/ore-three/src/utils/Animator.ts:268
Parameters
- name: string
- mute: boolean = false
Returns null | boolean

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<Event, T, Animator>): void

Inherited from THREE.EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:44
Removes a listener from an event type.

Type parameters
- T: string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event, T, Animator>
  
  The listener function that gets removed.
Returns void

setEasing

setEasing(name: string, easing: EasingFunc): void

- Defined in packages/ore-three/src/utils/Animator.ts:76
Parameters
- name: string
- easing: EasingFunc
Returns void

setValue

setValue<T>(name: string, value: T): undefined | null

- Defined in packages/ore-three/src/utils/Animator.ts:92
Type parameters
- T: AnimatorVariableType
Parameters
- name: string
- value: T
Returns undefined | null

update

update(deltaTime?: number): void

- Defined in packages/ore-three/src/utils/Animator.ts:334
Parameters
- Optional deltaTime: number
Returns void

updateDataBase

updateDataBase(target?: string): void

- Defined in packages/ore-three/src/utils/Animator.ts:448
Parameters
- Optional target: string
Returns void

wait

wait(t: number): Promise<void>

- Defined in packages/ore-three/src/utils/Animator.ts:314
Parameters
- t: number
Returns Promise<void>

Generated using TypeDoc