Documentation / scene / AnimationPlayback

Class: AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:236

Runtime handle for one playback of an AnimationClip.

Extends

• Observable<AnimationPlaybackEventMap>

Constructors

Constructor

new AnimationPlayback(animationSet, clip, options?): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:262

Parameters

animationSet

AnimationSet

clip

AnimationClip

options?

PlayAnimationOptions

Returns

AnimationPlayback

Overrides

Observable<AnimationPlaybackEventMap>.constructor

Accessors

id

Get Signature

get id(): string

Defined in: libs/scene/src/animation/animationset.ts:277

Returns

string

---

animationSet

Get Signature

get animationSet(): AnimationSet

Defined in: libs/scene/src/animation/animationset.ts:280

Returns

AnimationSet

---

clip

Get Signature

get clip(): AnimationClip

Defined in: libs/scene/src/animation/animationset.ts:283

Returns

AnimationClip

---

state

Get Signature

get state(): AnimationPlaybackState

Defined in: libs/scene/src/animation/animationset.ts:286

Returns

AnimationPlaybackState

---

time

Get Signature

get time(): number

Defined in: libs/scene/src/animation/animationset.ts:289

Returns

number

Set Signature

set time(value): void

Defined in: libs/scene/src/animation/animationset.ts:292

Parameters

value

number

Returns

void

---

normalizedTime

Get Signature

get normalizedTime(): number

Defined in: libs/scene/src/animation/animationset.ts:295

Returns

number

Set Signature

set normalizedTime(value): void

Defined in: libs/scene/src/animation/animationset.ts:298

Parameters

value

number

Returns

void

---

weight

Get Signature

get weight(): number

Defined in: libs/scene/src/animation/animationset.ts:301

Returns

number

Set Signature

set weight(value): void

Defined in: libs/scene/src/animation/animationset.ts:304

Parameters

value

number

Returns

void

---

speedRatio

Get Signature

get speedRatio(): number

Defined in: libs/scene/src/animation/animationset.ts:307

Returns

number

Set Signature

set speedRatio(value): void

Defined in: libs/scene/src/animation/animationset.ts:310

Parameters

value

number

Returns

void

---

layer

Get Signature

get layer(): string

Defined in: libs/scene/src/animation/animationset.ts:313

Returns

string

---

priority

Get Signature

get priority(): number

Defined in: libs/scene/src/animation/animationset.ts:316

Returns

number

---

interruptible

Get Signature

get interruptible(): boolean

Defined in: libs/scene/src/animation/animationset.ts:319

Returns

boolean

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:594

IEventTarget.on

Type Parameters

K

K extends keyof AnimationPlaybackEventMap

Parameters

type

K

listener

EventListener<AnimationPlaybackEventMap, K>

context?

unknown

Returns

void

Inherited from

Observable.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:598

IEventTarget.once

Type Parameters

K

K extends keyof AnimationPlaybackEventMap

Parameters

type

K

listener

EventListener<AnimationPlaybackEventMap, K>

context?

unknown

Returns

void

Inherited from

Observable.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:602

IEventTarget.off

Type Parameters

K

K extends keyof AnimationPlaybackEventMap

Parameters

type

K

listener?

EventListener<AnimationPlaybackEventMap>

context?

unknown

Returns

void

Inherited from

Observable.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:606

IEventTarget.dispatchEvent

Type Parameters

K

K extends keyof AnimationPlaybackEventMap

Parameters

type

K

args

...AnimationPlaybackEventMap[K]

Returns

void

Inherited from

Observable.dispatchEvent

---

play()

play(): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:322

Returns

AnimationPlayback

---

pause()

pause(): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:326

Returns

AnimationPlayback

---

resume()

resume(): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:330

Returns

AnimationPlayback

---

stop()

stop(options?): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:334

Parameters

options?

StopAnimationOptions

Returns

AnimationPlayback

---

seek()

seek(time, options?): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:338

Parameters

time

number

options?

emitEvents?

boolean

apply?

boolean

Returns

AnimationPlayback

---

fadeTo()

fadeTo(weight, duration): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:342

Parameters

weight

number

duration

number

Returns

AnimationPlayback

---

crossFadeTo()

crossFadeTo(name, options?): AnimationPlayback

Defined in: libs/scene/src/animation/animationset.ts:346

Parameters

name

string

options?

PlayAnimationOptions & object

Returns

AnimationPlayback

---

waitForComplete()

waitForComplete(): Promise<AnimationPlayback>

Defined in: libs/scene/src/animation/animationset.ts:351

Returns

Promise<AnimationPlayback>

---

waitForMarker()

waitForMarker(idOrName): Promise<any>

Defined in: libs/scene/src/animation/animationset.ts:356

Parameters

idOrName

string

Returns

Promise<any>

---

waitForFrame()

waitForFrame(frame): Promise<any>

Defined in: libs/scene/src/animation/animationset.ts:377

Parameters

frame

number

Returns

Promise<any>