Class SceneAnimationPlayer

constructor

• new SceneAnimationPlayer(
      params: {
          animation?: SceneAnimation;
          applier?: SceneAnimationStateApplier;
          currentTime?: number;
          evaluator?: SceneAnimationEvaluator;
          loop?: boolean;
          model: SceneModel;
          speed?: number;
      },
  ): SceneAnimationPlayer

  Parameters

  • params: {
        animation?: SceneAnimation;
        applier?: SceneAnimationStateApplier;
        currentTime?: number;
        evaluator?: SceneAnimationEvaluator;
        loop?: boolean;
        model: SceneModel;
        speed?: number;
    }

  Returns SceneAnimationPlayer

animation

Readonlyapplier

currentTime

Readonlyevaluator

loop

Readonlymodel

playing

speed

apply

• apply(): SDKResult<void>

  Evaluates currentTime and applies the resulting state to the live model.

  Returns SDKResult<void>

destroy

• destroy(): void

  Stops the player and releases its scheduled task.

  Returns void

pause

• pause(): void

  Stops automatic time advancement without changing currentTime.

  Returns void

play

• play(): void

  Starts advancing currentTime on the SDK animation task stage.

  Returns void

seek

• seek(time: number): SDKResult<void>

  Moves to an authored time and applies the evaluated state.

  When looping is enabled the time wraps into the animation range. Otherwise the time clamps to the authored range.

  Parameters

  • time: number

  Returns SDKResult<void>

setAnimation

• setAnimation(animation: SceneAnimation): void

  Selects the animation to play and resets currentTime to its start time.

  Parameters

  • animation: SceneAnimation

  Returns void

stop

• stop(): void

  Stops playback and applies the animation at its authored start time.

  Returns void

update

• update(deltaSeconds?: number): SDKResult<void>

  Advances playback by deltaSeconds, or by wall-clock time when omitted.

  Parameters

  • OptionaldeltaSeconds: number

  Returns SDKResult<void>