Class AnimationMixer

JavaScript events for custom objects

Source

src/core/EventDispatcher.js

Hierarchy

EventDispatcher
- AnimationMixer

Index

Constructors

constructor

new AnimationMixer(root: Object3D<Event> | AnimationObjectGroup): AnimationMixer
Parameters
- root: Object3D<Event> | AnimationObjectGroup
Returns AnimationMixer
Overrides EventDispatcher.constructor
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:9

Properties

time

time: number

Default

timeScale

timeScale: number

Default

1.0

Methods

addEventListener

addEventListener<T>(type: T, listener: EventListener<Event, T, AnimationMixer>): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, AnimationMixer>
  
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:30

clipAction

clipAction(clip: AnimationClip, root?: Object3D<Event> | AnimationObjectGroup, blendMode?: AnimationBlendMode): AnimationAction
Parameters
- clip: AnimationClip
- Optional root: Object3D<Event> | AnimationObjectGroup
- Optional blendMode: AnimationBlendMode
Returns AnimationAction
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:21

dispatchEvent

dispatchEvent(event: Event): void
Fire an event type.
Parameters
- event: Event
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:50

existingAction

existingAction(clip: AnimationClip, root?: Object3D<Event> | AnimationObjectGroup): AnimationAction
Parameters
- clip: AnimationClip
- Optional root: Object3D<Event> | AnimationObjectGroup
Returns AnimationAction
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:26

getRoot

getRoot(): Object3D<Event> | AnimationObjectGroup
Returns Object3D<Event> | AnimationObjectGroup
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:30

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<Event, T, AnimationMixer>): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, AnimationMixer>
  
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:37

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<Event, T, AnimationMixer>): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event, T, AnimationMixer>
  
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:44

setTime

setTime(timeInSeconds: number): AnimationMixer
Parameters
- timeInSeconds: number
Returns AnimationMixer
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:29

stopAllAction

stopAllAction(): AnimationMixer
Returns AnimationMixer
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:27

uncacheAction

uncacheAction(clip: AnimationClip, root?: Object3D<Event> | AnimationObjectGroup): void
Parameters
- clip: AnimationClip
- Optional root: Object3D<Event> | AnimationObjectGroup
Returns void
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:33

uncacheClip

uncacheClip(clip: AnimationClip): void
Parameters
- clip: AnimationClip
Returns void
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:31

uncacheRoot

uncacheRoot(root: Object3D<Event> | AnimationObjectGroup): void
Parameters
- root: Object3D<Event> | AnimationObjectGroup
Returns void
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:32

update

update(deltaTime: number): AnimationMixer
Parameters
- deltaTime: number
Returns AnimationMixer
- Defined in node_modules/@types/three/src/animation/AnimationMixer.d.ts:28

Class AnimationMixer

Source

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

root: Object3D<Event> | AnimationObjectGroup

Returns AnimationMixer

Properties

time

Default

timeScale

Default

Methods

addEventListener

Type Parameters

T extends string

Parameters

type: T

listener: EventListener<Event, T, AnimationMixer>

Returns void

clipAction

Parameters

clip: AnimationClip

Optional root: Object3D<Event> | AnimationObjectGroup

Optional blendMode: AnimationBlendMode

Returns AnimationAction

dispatchEvent

Parameters

event: Event

Returns void

existingAction

Parameters

clip: AnimationClip

Optional root: Object3D<Event> | AnimationObjectGroup

Returns AnimationAction

getRoot

Returns Object3D<Event> | AnimationObjectGroup

hasEventListener

Type Parameters

T extends string

Parameters

type: T

listener: EventListener<Event, T, AnimationMixer>

Returns boolean

removeEventListener

Type Parameters

T extends string

Parameters

type: T

listener: EventListener<Event, T, AnimationMixer>

Returns void

setTime

Parameters

timeInSeconds: number

Returns AnimationMixer

stopAllAction

Returns AnimationMixer

uncacheAction

Parameters

clip: AnimationClip

Optional root: Object3D<Event> | AnimationObjectGroup

Returns void

uncacheClip

Parameters

clip: AnimationClip

Returns void

uncacheRoot

Parameters

root: Object3D<Event> | AnimationObjectGroup

Returns void

update

Parameters

deltaTime: number

Returns AnimationMixer

Settings

`Optional` root: Object3D<Event> | AnimationObjectGroup

`Optional` blendMode: AnimationBlendMode

`Optional` root: Object3D<Event> | AnimationObjectGroup

`Optional` root: Object3D<Event> | AnimationObjectGroup