Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyframeTrack

A KeyframeTrack is a timed sequence of keyframes, which are composed of lists of times and related values, and which are used to animate a specific property of an object. 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. In contrast to the animation hierarchy of the JSON model format a KeyframeTrack doesn't store its single keyframes as objects in a "keys" array (holding the times and the values for each frame together in one place). Instead of this there are always two arrays in a KeyframeTrack: the .times array stores the time values for all keyframes of this track in sequential order, and the .values array contains the corresponding changing values of the animated property. A single value, belonging to a certain point of time, can not only be a simple number, but (for example) a vector (if a position is animated) or a quaternion (if a rotation is animated). For this reason the values array (which is a flat array, too) might be three or four times as long as the times array. Corresponding to the different possible types of animated values there are several subclasses of KeyframeTrack, inheriting the most properties and methods:

BooleanKeyframeTrack ColorKeyframeTrack NumberKeyframeTrack QuaternionKeyframeTrack StringKeyframeTrack VectorKeyframeTrack

Some examples of how to manually create AnimationClips with different sorts of KeyframeTracks can be found in the AnimationClipCreator file. Since explicit values are only specified for the discrete points of time stored in the times array, all values in between have to be interpolated. The track's name is important for the connection of this track with a specific property of the animated node (done by PropertyBinding).

Hierarchy

Index

Constructors

constructor

Properties

DefaultInterpolation

DefaultInterpolation: InterpolationModes
default

THREE.InterpolateLinear

TimeBufferType

TimeBufferType: Float32Array

Float32Array, the type of the buffer internally used for the times.

ValueBufferType

ValueBufferType: Float32Array

Float32Array, the type of the buffer internally used for the values.

ValueTypeName

ValueTypeName: string

The default interpolation type: InterpolateLinear.

name

name: string

The track's name can refer to morph targets or bones or possibly other values within an animated object. See PropertyBinding.parseTrackName for the forms of strings that can be parsed for property binding: The name can specify the node either using its name or its uuid (although it needs to be in the subtree of the scene graph node passed into the mixer). Or, if the track name starts with a dot, the track applies to the root node that was passed into the mixer. Usually after the node a property will be specified directly. But you can also specify a subproperty, such as .rotation[x], if you just want to drive the X component of the rotation via a float track. You can also specify bones or multimaterials by using an object name, for example: .bones[R_hand].scale; the red channel of the diffuse color of the fourth material in a materials array - as a further example - can be accessed with .materials[3].diffuse[r]. PropertyBinding will also resolve morph target names, for example: .morphTargetInfluences[run]. Note: The track's name does not necessarily have to be unique. Multiple tracks can drive the same property. The result should be based on a weighted blend between the multiple tracks according to the weights of their respective actions.

times

times: Float32Array

A Float32Array, converted from the times array which is passed in the constructor.

values

values: Float32Array

A Float32Array, converted from the values array which is passed in the constructor.

Methods

InterpolantFactoryMethodDiscrete

InterpolantFactoryMethodLinear

InterpolantFactoryMethodSmooth

clone

createInterpolant

getInterpolation

getValueSize

  • getValueSize(): number

optimize

scale

setInterpolation

shift

toJSON

trim

validate

  • validate(): boolean
  • Performs minimal validation on the tracks. Returns true if valid. This method logs errors to the console, if a track is empty, if the .valueSize is not valid, if an item in the .times or .values array is not a valid number or if the items in the times array are out of order.

    Returns boolean

Generated using TypeDoc