Class CameraPathAnimation

constructor

• new CameraPathAnimation(
      scene: SceneWithEvents,
      cfg?: { cameraPath?: CameraPath; playingRate?: number },
  ): CameraPathAnimation

  Creates a camera path animation.

  Parameters

  • scene: SceneWithEvents

    Scene containing the target camera
  • cfg: { cameraPath?: CameraPath; playingRate?: number } = {}

    Configuration options

    • OptionalcameraPath?: CameraPath

      Path to animate along

    • OptionalplayingRate?: number

      Playback rate in time units per second

  Returns CameraPathAnimation

scene

state

Static ReadonlyPLAYING

Static ReadonlyPLAYING_TO

Static ReadonlySCRUBBING

Static ReadonlySTOPPED

cameraPath

• get cameraPath(): CameraPath

  Returns CameraPath

• set cameraPath(value: CameraPath): void

  Path currently animated by this instance.

  Parameters

  • value: CameraPath

  Returns void

rate

• get rate(): number

  Returns number

• set rate(value: number): void

  Playback rate in time units per second.

  Parameters

  • value: number

  Returns void

destroy

• destroy(): void

  Releases scene event subscriptions.

  Returns void

flyToFrame

• flyToFrame(frameIdx: number, ok?: () => void): void

  Flies directly to a frame using CameraFlightAnimation.

  Parameters

  • frameIdx: number

    Frame index
  • Optionalok: () => void

    Callback fired when the flight completes

  Returns void

play

• play(): void

  Starts playback from the current time.

  Returns void

playToFrame

• playToFrame(frameIdx: number): void

  Plays from the current time to the given frame.

  Parameters

  • frameIdx: number

    Frame index

  Returns void

playToT

• playToT(t: number): void

  Plays from the current time to the target time.

  Parameters

  • t: number

    Target time on the path

  Returns void

scrubToFrame

• scrubToFrame(frameIdx: number): void

  Scrubs directly to a recorded frame.

  Parameters

  • frameIdx: number

    Frame index

  Returns void

scrubToT

• scrubToT(t: number): void

  Scrubs directly to a time on the path.

  Parameters

  • t: number

    Time on the path

  Returns void

stop

• stop(): void

  Stops playback.

  Returns void