Class SceneAnimation

Immutable authored scene animation asset owned by a SceneModel.

SceneAnimation stores semantic sampled channels only. It has no runtime playback state such as play/pause, loop, speed or current time.

Use SceneAnimationEvaluator to evaluate this authored data into explicit SceneAnimationState values. Use SceneAnimationStateApplier or SceneAnimationPlayer when those values should affect live SceneTransform instances.

Index

Constructors

Properties

channels destroyed id model name?

Accessors

duration endTime startTime

Methods

destroy toParams validateParams

Constructors

constructor

new SceneAnimation(
model: SceneModel,
params: SceneAnimationParams,
): SceneAnimation
Parameters
- model: SceneModel
- params: SceneAnimationParams
Returns SceneAnimation
- Defined in packages/sdk/src/model/scene/animation/SceneAnimation.ts:124

Properties

`Readonly`channels

channels: readonly SceneAnimationChannelParams[]

destroyed

destroyed: boolean = false

`Readonly`id

id: string

`Readonly`model

model: SceneModel

`Optional` `Readonly`name

name?: string

Accessors

duration

get duration(): number
Difference between the first and last authored sample times.

Returns number
- Defined in packages/sdk/src/model/scene/animation/SceneAnimation.ts:154

endTime

get endTime(): number
Last authored sample time across all channels.

Returns number
- Defined in packages/sdk/src/model/scene/animation/SceneAnimation.ts:142

startTime

get startTime(): number
Returns number
- Defined in packages/sdk/src/model/scene/animation/SceneAnimation.ts:131

Methods

destroy

destroy(): SDKResult<void>
Removes this animation from its owning SceneModel.

Returns SDKResult<void>
- Defined in packages/sdk/src/model/scene/animation/SceneAnimation.ts:182

toParams

toParams(): SDKResult<SceneAnimationParams>
Serializes this immutable animation asset back to JSON-friendly params.

Returns SDKResult<SceneAnimationParams>
- Defined in packages/sdk/src/model/scene/animation/SceneAnimation.ts:161

`Static`validateParams

validateParams(params: SceneAnimationParams): string
Validates animation params without creating a SceneAnimation.
Parameters
- params: SceneAnimationParams
Returns string
- Defined in packages/sdk/src/model/scene/animation/SceneAnimation.ts:198