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: Pick<Model, "animations" | "scene">,
    opts?: {
        createAnimationComponent(
            obj: Object3D,
            animation: AnimationClip,
        ): IAnimationComponent;
    },
): 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<Model, "animations" | "scene">
  The GLTF file to assign the animations from
- Optionalopts: {
      createAnimationComponent(
          obj: Object3D,
          animation: AnimationClip,
      ): IAnimationComponent;
  }
Returns void

`Static`tryGetActionsFromMixer

tryGetActionsFromMixer(mixer: AnimationMixer): 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: Object3D,
target?: AnimationClip[],
): AnimationClip[]
Parameters
- obj: Object3D
- Optionaltarget: AnimationClip[]
Returns AnimationClip[]