Reusable collections of AnimationChannels, together representing a discrete animation clip.

One Animation represents one playable unit in an animation system. Each may contain channels affecting multiple paths (translation, rotation, scale, or weights) on multiple Nodes. An Animation's channels must be played together, and do not have any meaning in isolation.

Multiple Animations may be played together: for example, one character's Walk animation might play while another character's Run animation plays. Or a single character might have both an Idle and a Talk animation playing at the same time. However, glTF does not define any particular relationship between top-level Animations, or any particular playback behavior like looping or sequences of Animations. General-purpose viewers typically autoplay the first animation and provide UI controls for choosing another. Game engines may have significantly more advanced methods of playing and blending animations.

For example, a very simple skinned Mesh might have two Animations, Idle and Walk. Each of those Animations might affect the rotations of two bones, LegL and LegR, where the keyframes for each target-path pair are stored in AnimationChannel instances. In total, this model would contain two Animations and Four AnimationChannels.

Usage:

const animation = doc.createAnimation('machineRun')
    .addChannel(rotateCog1)
    .addChannel(rotateCog2)
    .addChannel(rotateCog3);

Reference

Hierarchy

Properties

propertyType: ANIMATION

Property type.

Methods

  • Events.

  • dispose(): void
  • Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

  • equals(other: Animation, skip?: Set<string>): boolean
  • Returns true if two properties are deeply equivalent, recursively comparing the attributes of the properties. Optionally, a 'skip' set may be included, specifying attributes whose values should not be considered in the comparison.

    Example: Two Primitives are equivalent if they have accessors and materials with equivalent content — but not necessarily the same specific accessors and materials.

  • getDefaults(): Nullable<IAnimation>
  • getExtension<Prop>(name: string): Prop
  • getExtras(): Record<string, unknown>
  • getName(): string
  • init(): void
  • isDisposed(): boolean
  • Returns true if the node has been permanently removed from the graph.

  • listChannels(): AnimationChannel[]
  • listExtensions(): ExtensionProperty<IProperty>[]
  • listParents(): Property<IProperty>[]
  • Returns a list of all properties that hold a reference to this property. For example, a material may hold references to various textures, but a texture does not hold references to the materials that use it.

    It is often necessary to filter the results for a particular type: some resources, like Accessors, may be referenced by different types of properties. Most properties include the Root as a parent, which is usually not of interest.

    Usage:

    const materials = texture
        .listParents()
        .filter((p) => p instanceof Material)
    
  • listSamplers(): AnimationSampler[]
  • setExtension<Prop>(name: string, extensionProperty: Prop): Animation
  • setExtras(extras: Record<string, unknown>): Animation
Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy TypeDoc documentation Copyright 2021 under MIT license