Skip to content

Documentation / scene / AnimationTimeline

Class: AnimationTimeline ​

Defined in: libs/scene/src/animation/animationtimeline.ts:371

Serializable animation timeline definition.

Constructors ​

Constructor ​

new AnimationTimeline(definition): AnimationTimeline

Defined in: libs/scene/src/animation/animationtimeline.ts:386

Create a timeline from a definition object or a root step array.

Parameters ​

definition ​

AnimationTimelineStep[] | AnimationTimelineDefinition

Timeline definition, or a shorthand array used as the root steps.

Returns ​

AnimationTimeline

Properties ​

steps ​

readonly steps: AnimationTimelineStep[]

Defined in: libs/scene/src/animation/animationtimeline.ts:375

Root step sequence executed by runners created from this timeline.


responses ​

readonly responses: AnimationTimelineEventResponse[]

Defined in: libs/scene/src/animation/animationtimeline.ts:379

Event responses declared on this timeline.

Methods ​

createRunner() ​

createRunner(animationSet): AnimationTimelineRunner

Defined in: libs/scene/src/animation/animationtimeline.ts:402

Create a runtime runner for this timeline.

Parameters ​

animationSet ​

AnimationSet

Animation set used to create and update playbacks.

Returns ​

AnimationTimelineRunner

A new stopped runner bound to this timeline and animation set.

Released under the MIT License.