Class CameraPath

constructor

• new CameraPath(
      camera: CameraLike,
      cfg?: { frames?: CameraPathFrame[] },
  ): CameraPath

  Creates a camera path.

  Parameters

  • camera: CameraLike

    The camera to control with this path. The camera's eye, look, and up will be sampled when saving frames and updated when loading frames.
  • cfg: { frames?: CameraPathFrame[] } = {}

    Configuration options

    • Optionalframes?: CameraPathFrame[]

      Initial frames to add to the path

  Returns CameraPath

camera

eyeCurve

• get eyeCurve(): SplineCurve

  Spline for camera eye positions.

  Returns SplineCurve

frames

• get frames(): CameraPathFrame[]

  Frames in insertion order.

  Returns CameraPathFrame[]

lookCurve

• get lookCurve(): SplineCurve

  Spline for camera look positions.

  Returns SplineCurve

upCurve

• get upCurve(): SplineCurve

  Spline for camera up vectors.

  Returns SplineCurve

addFrame

• addFrame(t: number, eye: Vec3, look: Vec3, up: Vec3): void

  Adds a frame to the path.

  Vector values are copied before storage.

  Parameters

  • t: number

    Time for the new frame
  • eye: Vec3

    Eye position
  • look: Vec3

    Look position
  • up: Vec3

    Up vector

  Returns void

addFrames

• addFrames(frames: CameraPathFrame[]): void

  Adds multiple frames to the path.

  Parameters

  • frames: CameraPathFrame[]

    Frames to append

  Returns void

clearFrames

• clearFrames(): void

  Removes all frames and clears all spline control points.

  Returns void

loadFrame

• loadFrame(t: number): void

  Loads the interpolated camera state at the given path time.

  Input time is normalized using the first and last frame times.

  Parameters

  • t: number

    Time along the path

  Returns void

sampleFrame

• sampleFrame(t: number, eye: Vec3, look: Vec3, up: Vec3): void

  Samples the path at normalized parameter t.

  Parameters

  • t: number

    Normalized parameter in the range [0..1]
  • eye: Vec3

    Target eye vector to write into
  • look: Vec3

    Target look vector to write into
  • up: Vec3

    Target up vector to write into

  Returns void

saveFrame

• saveFrame(t: number): void

  Captures the current camera state as a new frame.

  Parameters

  • t: number

    Time for the new frame

  Returns void

smoothFrameTimes

• smoothFrameTimes(duration: number): void

  Redistributes frame times so camera motion is closer to constant speed.

  Uses distance between consecutive eye positions.

  Parameters

  • duration: number

    Total duration to distribute across all frames

  Returns void