Interface PhysicsHandle<T>

interface PhysicsHandle<T = unknown> {
    id: number;
    cancel(): void;
    isPaused(): boolean;
    pause(): void;
    resume(): void;
    setTarget(to: T | null): void;
    setTimeScale(scale: number): void;
    setVelocity(v: T): void;
}

Type Parameters

T = unknown

Hierarchy (View Summary)

AnimationHandle
- PhysicsHandle

Index

Properties

Methods

cancel isPaused pause resume setTarget setTimeScale setVelocity

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
Inherited from AnimationHandle.cancel
- Defined in packages/core/src/animation/types.ts:26

isPaused

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

Returns boolean
Inherited from AnimationHandle.isPaused
- Defined in packages/core/src/animation/types.ts:34

pause

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

Returns void
Inherited from AnimationHandle.pause
- Defined in packages/core/src/animation/types.ts:28

resume

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

Returns void
Inherited from AnimationHandle.resume
- Defined in packages/core/src/animation/types.ts:30

setTarget

setTarget(to: T | null): void
Retarget mid-flight. null ⇒ switch to decay-mode (no spring force).
Parameters
- to: T | null
Returns void
- Defined in packages/core/src/animation/types.ts:101

setTimeScale

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

setVelocity

setVelocity(v: T): void
Replace the current velocity in T-units per second.
Parameters
- v: T
Returns void
- Defined in packages/core/src/animation/types.ts:103