CameraControls

The contract between a viewport and its camera controls.

Implement this interface to drive a camera with custom input logic and assign it to a viewport through its cameraControls property. The viewport passes pointer and wheel events to onEvent unless a layer stops propagation.

class ClickToZoomControls implements CameraControls {
  constructor(private camera: OrthographicCamera) {}

  get isMoving() {
    return false;
  }

  onUpdate(dt: number) {}

  onEvent(event: EventContext) {
    if (event.type === "pointerdown") this.camera.zoom(2);
  }
}

viewport.cameraControls = new ClickToZoomControls(camera);

Implemented by

• OrbitControls
• PanZoomControls

Properties

isMoving

Whether the camera is in motion from user interaction. Layers may read this to reduce rendering quality while the view changes.

readonly isMoving: boolean;

Methods

onUpdate() void

Advances time-based motion such as damping. Called automatically by the render loop.

onUpdate(dt): void;

Parameter	Description
dt: number	Time since the last frame in seconds.

onEvent() void

Handles a pointer or wheel event. Called automatically by the owning viewport unless a layer stops propagation.

onEvent(event): void;

Parameter	Description
event: EventContext	The event with clip and world coordinates attached.