Class AnimationClipState

Contains information about a currently playing animation clip.

Index

Constructors

Accessors

isStopped layer previousTime speed time weight wrapMode

Constructors

constructor

new AnimationClipState(
layer: AnimationLayer,
isInternalConstructor?: boolean,
): AnimationClipState
Parameters
- layer: AnimationLayer
- OptionalisInternalConstructor: boolean
Returns AnimationClipState

Overrides FrameworkObject.constructor

Accessors

isStopped

get isStopped(): boolean

Determines whether the time is advanced automatically. Certain type of animation clips don't involve playback (e.g. for blending where animation weight controls the animation).

Returns boolean
set isStopped(value: boolean): void
Parameters
- value: boolean
Returns void

layer

get layer(): AnimationLayer

Layer the clip is playing on. Multiple clips can be played simulatenously on different layers.

Returns AnimationLayer

previousTime

get previousTime(): number

The previous time the animation was playing from.

Returns number
set previousTime(value: number): void
Parameters
- value: number
Returns void

speed

get speed(): number

Speed at which the animation is playing.

Returns number
set speed(value: number): void
Parameters
- value: number
Returns void

time

get time(): number

Current time the animation is playing from.

Returns number
set time(value: number): void
Parameters
- value: number
Returns void

weight

get weight(): number

Determines how much of an influence does the clip have on the final pose.

Returns number
set weight(value: number): void
Parameters
- value: number
Returns void

wrapMode

get wrapMode(): EnumValue<AnimationWrapMode>

Determines what happens to other animation clips when a new clip starts playing.

Returns EnumValue<AnimationWrapMode>
set wrapMode(value: EnumValue<AnimationWrapMode>): void
Parameters
- value: EnumValue<AnimationWrapMode>
Returns void