Selva Compute API Reference - v1.1.2
    Preparing search index...

    A reusable set of keyframe tracks which represent an animation.

    Index

    Constructors

    • Constructs a new animation clip.

      Note: Instead of instantiating an AnimationClip directly with the constructor, you can use the static interface of this class for creating clips. In most cases though, animation clips will automatically be created by loaders when importing animated 3D assets.

      Parameters

      • Optionalname: string

        The clip's name.

      • Optionalduration: number

        The clip's duration in seconds. If a negative value is passed, the duration will be calculated from the passed keyframes.

      • Optionaltracks: KeyframeTrack[]

        An array of keyframe tracks.

      • OptionalblendMode: AnimationBlendMode

        Defines how the animation is blended/combined when two or more animations are simultaneously played.

      Returns AnimationClip

    Properties

    Defines how the animation is blended/combined when two or more animations are simultaneously played.

    duration: number

    The clip's duration in seconds.

    name: string

    The clip's name.

    tracks: KeyframeTrack[]

    An array of keyframe tracks.

    userData: Record<string, unknown>

    An object that can be used to store custom data about the animation clip. It should not hold references to functions as these will not be cloned.

    uuid: string

    The UUID of the animation clip.

    Methods

    • Returns a new animation clip with copied values from this instance.

      Returns this

      A clone of this instance.

    • Optimizes each track by removing equivalent sequential keys (which are common in morph target sequences).

      Returns AnimationClip

      A reference to this animation clip.

    • Sets the duration of this clip to the duration of its longest keyframe track.

      Returns AnimationClip

      A reference to this animation clip.

    • Serializes this animation clip into JSON.

      Returns AnimationClipJSON

      The JSON object.

    • Trims all tracks to the clip's duration.

      Returns AnimationClip

      A reference to this animation clip.

    • Performs minimal validation on each track in the clip. Returns true if all tracks are valid.

      Returns boolean

      Whether the clip's keyframes are valid or not.

    • Returns an array of new AnimationClips created from the morph target sequences of a geometry, trying to sort morph target names into animation-group-based patterns like "Walk_001, Walk_002, Run_001, Run_002...".

      See MD2Loader#parse as an example for how the method should be used.

      Parameters

      • morphTargets: MorphTarget[]

        A sequence of morph targets.

      • fps: number

        The Frames-Per-Second value.

      • noLoop: boolean

        Whether the clip should be no loop or not.

      Returns AnimationClip[]

      An array of new animation clips.

    • Returns a new animation clip from the passed morph targets array of a geometry, taking a name and the number of frames per second.

      Note: The fps parameter is required, but the animation speed can be overridden via AnimationAction#setDuration.

      Parameters

      • name: string

        The name of the animation clip.

      • morphTargetSequence: MorphTarget[]

        A sequence of morph targets.

      • fps: number

        The Frames-Per-Second value.

      • noLoop: boolean

        Whether the clip should be no loop or not.

      Returns AnimationClip

      The new animation clip.

    • Searches for an animation clip by name, taking as its first parameter either an array of clips, or a mesh or geometry that contains an array named "animations" property.

      Parameters

      Returns AnimationClip | null

      The found animation clip. Returns null if no clip has been found.

    • Factory method for creating an animation clip from the given JSON.

      Parameters

      Returns AnimationClip

      The new animation clip.

    • Parses the animation.hierarchy format and returns a new animation clip.

      Parameters

      Returns AnimationClip | null

      The new animation clip.

      since r175.

    • Serializes the given animation clip into JSON.

      Parameters

      Returns AnimationClipJSON

      The JSON object.