Interface AnimationHandle

interface AnimationHandle {
    id: number;
    cancel(): void;
    isPaused(): boolean;
    pause(): void;
    resume(): void;
    setTimeScale(scale: number): void;
}

Hierarchy (View Summary)

AnimationHandle
- PhysicsHandle

Index

Properties

Methods

cancel isPaused pause resume setTimeScale

Properties

id

id: number

Monotonic id assigned by the animator.

Methods

cancel

cancel(): void
Cancel this animation. Idempotent — no-op once already finished/canceled.

Returns void
- Defined in packages/core/src/animation/types.ts:26

isPaused

isPaused(): boolean
True iff this handle is currently paused.

Returns boolean
- Defined in packages/core/src/animation/types.ts:34

pause

pause(): void
Freeze this animation's virtual clock. Idempotent.

Returns void
- Defined in packages/core/src/animation/types.ts:28

resume

resume(): void
Resume this animation's virtual clock. Idempotent.

Returns void
- Defined in packages/core/src/animation/types.ts:30

setTimeScale

setTimeScale(scale: number): void
Multiply this animation's virtual-clock rate by scale. 1 = normal.
Parameters
- scale: number
Returns void
- Defined in packages/core/src/animation/types.ts:32