Camera.limits ​

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.limits

ts
limits(limits: CameraLimits | null, options?: CameraCommitOptions<C> & SignalOption): Promise<Report>;

Merges into your app limits (see CameraLimits); null drops them all, restoring the document's. Clamps the current view. Look-only; merging; not in the write queue.

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'.

Example ​

Imports: values (has, validate, the Holo*Error classes, the pure helpers) from @holostep-configurators/runtime-client, types from @holostep-configurators/runtime-client/contract, /math and /testing names from those entries; boot from the runtime module the root's loadRuntimeAtFloor resolves to. A type your page defines is your app's: declare it there, never import it from the package.

Compiled under the contract's strict settings (examples/declaration/10-Camera.limits.ts):

ts
import type { Session } from '@holostep-configurators/runtime-client/contract';
declare const session: Session;
declare const signal: AbortSignal;
await session.camera.limits({ minAzimuthDeg: -70, maxAzimuthDeg: 70 });
// merges: the azimuth limits stay
await session.camera.limits({ collision: true });
// the document's azimuth limits again
await session.camera.limits({ minAzimuthDeg: null, maxAzimuthDeg: null });

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: limits names no product
2. A precedent pass: Babylon.js ArcRotateCamera lowerAlphaLimit, upperAlphaLimit, panning (row G7); Unity Camera.fieldOfView (row K40); Unity Camera.lensShift (row K40); Babylon.js ArcRotateCamera limits (row K40)
3. Two apps, or labs pass: 27 apps (ledger: app-378d190f1b, app-4f16d2f6da, app-59c5b5751e, app-b362a81c85, app-b4ae2fce25, app-bcb7ef21da, app-ddfb017681, app-e3b47169bc and 5 more; fleet cross-check: app-04c2774145, app-37356bf09f, app-378d190f1b, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508, app-59c5b5751e and 17 more)
4. The cheaper fix first decided per need in Appendix B: rows G7, K40 at tier stable (a member only where no rule, data, asset or app code serves the need)