Camera.lens Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/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.lens
lens(lens: CameraLens | null, options?: CameraCommitOptions<C> & CameraMoveOptions): Promise<Report>;Sets the lens; null restores the document's lens. durationMs eases the change. Look-only;
target: the lens. A lens written in the task that resizes the element is drawn in the frame
that shows the new aspect (spec section 5.6).
Through Session:
| Option | Type | Default | What it does |
|---|---|---|---|
actor |
Actor |
the expectGroup's actor when one is given, else 'app' |
Who made the write. |
durationMs |
number |
0 | 0 lands exactly, without damping, before the next frame. |
easing |
Easing | 'damped' |
'easeInOut' | The move's time curve: an Easing, or 'damped', a critically damped spring with no overshoot, which is 1.x's transition: true glide. |
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 |
|---|---|---|---|
durationMs |
number |
0 | 0 lands exactly, without damping, before the next frame. |
easing |
Easing | 'damped' |
'easeInOut' | The move's time curve: an Easing, or 'damped', a critically damped spring with no overshoot, which is 1.x's transition: true glide. |
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.
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
txthe 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'.
| Rule | Result |
|---|---|
| 1. Neutral name | pass: lens 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: 26 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-378d190f1b, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508, app-59c5b5751e, app-822bb9d6aa and 18 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) |