Camera.mode ​

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.

Method of Camera · stable · since 2.0.0 · called as session.camera.mode

ts
mode(mode: 'orbit' | 'pan' | 'fixed', options?: CameraCommitOptions<C> & SignalOption): Promise<Report>;

'pan': trucks only. 'fixed': the runtime's own camera input is off (drive it with set, or per frame with Frame.camera), and a wheel event over the element is left alone, as at dollySpeed: 0.

Options ​

Through Session:

Option Type Default What it does
actor Actor the expectGroup's actor when one is given, else 'app' Who made the write.
expectRevision number undefined (no check) If-match on session.revision.
origin string null Your tag, echoed unchanged in Report.origin and cause.origin.
signal AbortSignal undefined Cancels this call; the member's JSDoc says what an abort does.

Refused here (typed never, so passing one fails to compile): dryRun, expectGroup, supersede, undo.

Through Tx:

Option Type Default What it does
signal AbortSignal undefined Cancels this call; the member's JSDoc says what an abort does.

Refused here (typed never, so passing one fails to compile): actor, checkpoint, dryRun, expectGroup, expectRevision, origin, supersede, undo.

Abort (signal) ​

This call is a write (SignalOption.signal, the kinds of call).

A write: before the commit point it rolls back and rejects AbortError; after it, no effect, except that a running camera move stops where the last frame drew it (CameraMoveOptions).

Through a tx the commit point is the transaction's: aborting a write still loading rejects AbortError and stages nothing (catch it: unobserved, it rolls the transaction back, spec section 6.1, O6); aborting one already staged unstages it, its paths keeping the latest other write to them as after a failed savepoint (O7), and its Promise stays resolved 'staged'.

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: mode names no product
2. A precedent pass: Babylon.js ArcRotateCamera panningAxis (row G58); Babylon.js ArcRotateCamera lowerAlphaLimit, upperAlphaLimit, panning (row G7); Unity MonoBehaviour.LateUpdate (row K41)
3. Two apps, or labs pass: 18 apps (ledger: app-37356bf09f, app-4f16d2f6da, app-b362a81c85, app-b4ae2fce25, app-ddfb017681, app-f9a32142f1, app-fc07850558, app-fc306ec3dc and 1 more; fleet cross-check: app-04c2774145, app-37356bf09f, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-8675b3225c, app-b4ae2fce25, app-ceb4eccc72 and 8 more)
4. The cheaper fix first decided per need in Appendix B: rows G58, G7, K41 at tier stable (a member only where no rule, data, asset or app code serves the need)