Class AnimationUtils

Utility class for working with animations.

Index

Constructors

Methods

assignAnimationsFromFile tryGetActionsFromMixer tryGetAnimationClipsFromObjectHierarchy

Constructors

constructor

new AnimationUtils(): AnimationUtils
Returns AnimationUtils

Methods

`Static`assignAnimationsFromFile

assignAnimationsFromFile(file, opts?): void
Assigns animations from a GLTF file to the objects in the scene.
This method will look for objects in the scene that have animations and assign them to the correct objects.
Parameters
- file: Pick<GLTF, "animations" | "scene">
  The GLTF file to assign the animations from
- Optionalopts: {
  createAnimationComponent(obj: Object3D<Object3DEventMap>, animation: AnimationClip): IAnimationComponent;
  }
  - createAnimationComponent:function
    - createAnimationComponent(obj, animation): IAnimationComponent
    - Parameters
      obj: Object3D<Object3DEventMap>
      animation: AnimationClip
      Returns IAnimationComponent
Returns void

`Static`tryGetActionsFromMixer

tryGetActionsFromMixer(mixer): null | AnimationAction[]
Tries to get the animation actions from an animation mixer.
Parameters
- mixer: AnimationMixer
  The animation mixer to get the actions from
Returns null | AnimationAction[]
The actions or null if the mixer is invalid

`Static`tryGetAnimationClipsFromObjectHierarchy

tryGetAnimationClipsFromObjectHierarchy(obj, target?): AnimationClip[]
Parameters
- obj: Object3D<Object3DEventMap>
- Optionaltarget: AnimationClip[]
Returns AnimationClip[]