uē-tôo

Appearance

@ue-too/board / RawUserInputPublisher

Class: RawUserInputPublisher ​

Defined in: packages/board/src/input-interpretation/raw-input-publisher/raw-input-publisher.ts:214

Publisher for broadcasting raw user input events to observers.

Remarks ​

This class implements the observable pattern to distribute user input events to external subscribers. It operates in parallel to camera control - the orchestrator both sends events to this publisher AND controls the camera.

Architecture:

Orchestrator → Publisher → Observers (UI, analytics, etc.)
            ↓
         CameraMux → CameraRig

Event Streams:

  • Specific streams: Subscribe to "pan", "zoom", or "rotate" for typed events
  • Unified stream: Subscribe to "all" for all events with type discriminator

Use Cases:

  • Update UI elements based on user interactions
  • Log analytics about user gestures
  • Synchronize secondary views or previews
  • Implement custom gesture reactions independent of camera

Observable Implementation: Uses AsyncObservable for asynchronous event delivery, preventing observers from blocking the input processing pipeline.

Example ​

typescript
const publisher = new RawUserInputPublisher();

// Subscribe to pan events
const unsubscribe = publisher.on("pan", (event) => {
  console.log("User panned by:", event.diff);
  updateMinimap(event.diff);
});

// Subscribe to all events
publisher.on("all", (event) => {
  switch (event.type) {
    case "pan":
      analytics.log("pan", event.diff);
      break;
    case "zoom":
      analytics.log("zoom", event.deltaZoomAmount, event.anchorPoint);
      break;
    case "rotate":
      analytics.log("rotate", event.deltaRotation);
      break;
  }
});

// Later, unsubscribe
unsubscribe();

Implements ​

Constructors ​

Constructor ​

new RawUserInputPublisher(): RawUserInputPublisher

Defined in: packages/board/src/input-interpretation/raw-input-publisher/raw-input-publisher.ts:220

Returns ​

RawUserInputPublisher

Methods ​

notifyPan() ​

notifyPan(diff): void

Defined in: packages/board/src/input-interpretation/raw-input-publisher/raw-input-publisher.ts:235

Notifies subscribers of a pan gesture

Parameters ​

diff ​

Point

Returns ​

void

Implementation of ​

UserInputPublisher.notifyPan

notifyRotate() ​

notifyRotate(deltaRotation): void

Defined in: packages/board/src/input-interpretation/raw-input-publisher/raw-input-publisher.ts:252

Notifies subscribers of a rotate gesture

Parameters ​

deltaRotation ​

number

Returns ​

void

Implementation of ​

UserInputPublisher.notifyRotate

notifyZoom() ​

notifyZoom(deltaZoomAmount, anchorPoint): void

Defined in: packages/board/src/input-interpretation/raw-input-publisher/raw-input-publisher.ts:240

Notifies subscribers of a zoom gesture

Parameters ​

deltaZoomAmount ​

number

anchorPoint ​

Point

Returns ​

void

Implementation of ​

UserInputPublisher.notifyZoom

on() ​

on<K>(eventName, callback): UnsubscribeToUserRawInput

Defined in: packages/board/src/input-interpretation/raw-input-publisher/raw-input-publisher.ts:257

Subscribes to input events

Type Parameters ​

K ​

K extends keyof RawUserInputEventMap

Parameters ​

eventName ​

K

callback ​

(event) => void

Returns ​

UnsubscribeToUserRawInput

Implementation of ​

UserInputPublisher.on