Skip to main content

AnimationClip

An AnimationClip is a reusable set of keyframe tracks which represent an animation.

For an overview of the different elements of the three.js animation system see the "Animation System" article in the "Next Steps" section of the manual.

Constructor​

AnimationClip​

function AnimationClip( name: String, duration: Number, tracks: Array ): void;

name - a name for this clip.
duration - the duration of this clip (in seconds). If a negative value is passed, the duration will be calculated from the passed tracks array.
tracks - an array of KeyframeTracks.
blendMode - defines how the animation is blended/combined when two or more animations are simultaneously played.

Note: Instead of instantiating an AnimationClip directly with the constructor, you can use one of its static methods to create AnimationClips: from JSON (.parse), from morph target sequences (.CreateFromMorphTargetSequence, .CreateClipsFromMorphTargetSequences) or from animation hierarchies (.parseAnimation) - if your model doesn't already hold AnimationClips in its geometry's animations array.

Properties​

blendMode​

blendMode: Number;

Defines how the animation is blended/combined when two or more animations are simultaneously played. Valid values are NormalAnimationBlendMode (default) and AdditiveAnimationBlendMode.

duration​

duration: Number;

The duration of this clip (in seconds). This can be calculated from the .tracks array via .resetDuration.

name​

name: String;

A name for this clip. A certain clip can be searched via .findByName.

tracks​

tracks: Array;

An array containing a KeyframeTrack for each property that are animated by this clip.

uuid​

uuid: String;

The UUID of this clip instance. It gets automatically assigned and shouldn't be edited.

Methods​

clone​

function clone( ): AnimationClip;

Returns a copy of this clip.

optimize​

function optimize( ): this;

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

resetDuration​

function resetDuration( ): this;

Sets the .duration of the clip to the duration of its longest KeyframeTrack.

toJSON​

function toJSON( ): Object;

Returns a JSON object representing the serialized animation clip.

trim​

function trim( ): this;

Trims all tracks to the clip's duration.

validate​

function validate( ): Boolean;

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

Static Methods​

CreateClipsFromMorphTargetSequences​

function CreateClipsFromMorphTargetSequences( name: String,
morphTargetSequence: Array, fps: Number, noLoop: Boolean ): Array;

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...".

CreateFromMorphTargetSequence​

function CreateFromMorphTargetSequence( name: String, morphTargetSequence:
Array, fps: Number, noLoop: Boolean ): AnimationClip;

Returns a new AnimationClip 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 in an AnimationAction via animationAction.setDuration.

findByName​

function findByName( objectOrClipArray: Object, name: String ): AnimationClip;

Searches for an AnimationClip by name, taking as its first parameter either an array of AnimationClips, or a mesh or geometry that contains an array named "animations".

parse​

function parse( json: Object ): AnimationClip;

Parses a JSON representation of a clip and returns an AnimationClip.

parseAnimation​

function parseAnimation( animation: Object, bones: Array ): AnimationClip;

Parses the animation.hierarchy format and returns an AnimationClip.

toJSON​

function toJSON( clip: AnimationClip ): Object;

Takes an AnimationClip and returns a JSON object.

Source​

src/animation/AnimationClip.js