Camera ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Interface · import type { Camera } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 10. Camera

Camera writes are look-only and never undo steps; of the commit options they take only origin, actor and expectRevision (CameraCommitOptions). They are not in the write queue: outside a transaction each starts at once. Autocommit: resolves when the move ends (at rest); a newer view write takes over a move in progress, which then resolves 'committed', and so does a shopper's pointer or touch gesture ('camera:control-start'; a wheel is not one). Through a tx: resolves 'deferred' at once and starts when the commit is shown; a durationMs: 0 view write lands in the frame that presents the commit, so the reveal shows the new view. At the commit point, before queued writes start or the transaction's Promise resolves, its deferred commands take their place in each target's command order, though none draws before that frame: a later command to the same target, called before they start, takes them over as it takes over a running move, so a replaced command never replays at presentation, and a deferred durationMs: 0 write still gives a later eased move its start (CameraMoveOptions). A command through a later tx takes them over only at its own transaction's commit point, so one whose transaction rolls back (a timeout included), is aborted or is superseded takes nothing over. An equal transaction's deferred commands, which start at the next drawn frame, are ordered the same way. The view (set, fit, views.go), the lens, the limits, the mode and the rotation are separate targets: an eased lens doesn't delay a set, so run them together rather than awaiting one before the other.

Members ​

Declaration ​

export interface Camera<C extends object = NoCommitOptions> {
  readonly state: CameraState;
  set(view: CameraView | LookAtView, options?: CameraCommitOptions<C> & CameraMoveOptions): Promise<Report>;
  fit(query?: Query, options?: CameraCommitOptions<C> & CameraMoveOptions & {
    paddingM?: number;
    view?: Pick<CameraView, 'azimuthDeg' | 'polarDeg'>;
  }): Promise<Report>;
  readonly views: {
    go(name: string, options?: CameraCommitOptions<C> & CameraMoveOptions): Promise<Report>;
  };
  limits(limits: CameraLimits | null, options?: CameraCommitOptions<C> & SignalOption): Promise<Report>;
  lens(lens: CameraLens | null, options?: CameraCommitOptions<C> & CameraMoveOptions): Promise<Report>;
  mode(mode: 'orbit' | 'pan' | 'fixed', options?: CameraCommitOptions<C> & SignalOption): Promise<Report>;
  autoRotate(degPerSecond: number | null, options?: CameraCommitOptions<C> & SignalOption): Promise<Report>;
  project(points: readonly Point3[]): Array<ProjectedPoint | null>;
  ray(at: ScreenPoint): Ray;
}

Generic-API test (spec 3.1) ​