docs(street-level): shorten comments and docs, drop audit references

Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
German KhokhlovandClaude Opus 5.5 committed 2026-10-08 17:44:32 +04:00
1 parent d59b4d05bb
commit 48b889590d
12 files changed
+41 -76

No files matched your search

+2 -4
View File
@@ -4,10 +4,8 @@ import { plausibleSurfaceHeight, sampledSurfaceHeight } from './view.js';
/** Fly the globe camera once to frame a photo after it opens. */
export function createCameraFraming({ state }) {
/**
* The application's camera authority (`attachNavigation`): `begin(noun)`
* takes a deferred ticket (a generation, or false when refused) that
* `reassert(generation)` honours, releasing tracking, only if nothing newer
* took the camera. Without it, framing flies directly.
* The application's camera authority: `reassert(begin())` succeeds only if
* nothing newer took the camera. Without it, framing flies directly.
*/
let navigation = null;
/** Our framing flight while it is current; Cesium calls `cancel` when another flight starts. */
+1 -5
View File
@@ -218,11 +218,7 @@ export function createStreetLevelLayer({
};
},
/**
* The application's camera authority, the deferred `begin(noun)` /
* `reassert(generation)` pair: a photo claims the camera when opening
* starts and frames only if it still owns it once loaded.
*/
/** A photo frames itself only if it still owns the camera once loaded. */
attachNavigation(navigation) {
parts.framing.attachNavigation(navigation);
},
+8 -13
View File
@@ -31,10 +31,9 @@ export function sampledSurfaceHeight(scene, carto) {
}
/**
* Ellipsoidal height (m) of the ground under the camera, or null. The globe
* answers where shown; Google 3D hides it, so the rendered surface does
* (roofs count: a building's height at most). A sample above the camera is
* ignored: a raised ground would put the camera underground.
* Ellipsoidal height (m) of the ground under the camera, or null. Under
* Google 3D (globe hidden) the rendered surface counts, minus any roof above
* the camera.
*/
export function groundUnderCamera(viewer) {
const carto = viewer?.camera?.positionCartographic;
@@ -81,11 +80,9 @@ function groundHit(camera, point, ellipsoid, maxRange) {
const BBOX_GRID = 5;
/**
* Visible [west, south, east, north] degrees, or null when fewer than four
* rays hit. Only hits count, so a horizon cannot inflate the box to the world.
* `groundHeight` raises the ellipsoid to the ground (rays to the bare
* ellipsoid under Denver land kilometres too far out) and `maxRange` (m)
* drops near-horizon hits.
* Visible [west, south, east, north] degrees from the rays that hit the
* ground, or null when fewer than four do. `groundHeight` raises the ellipsoid
* to the ground (Denver is 1,600 m up); `maxRange` (m) drops far hits.
*/
export function visibleBbox(
viewer,
@@ -158,10 +155,8 @@ export function cameraNadir(viewer) {
}
/**
* Where coverage tiles are ranked from: halfway between the ground under the
* camera and the ground at the centre of the screen, so a tilted view loads
* what it looks at as well as what is near. The nadir when the centre ray
* misses the ground within `maxRange`. Options as `visibleBbox`.
* Where coverage tiles are ranked from: halfway between the nadir and the
* screen centre's ground, or the nadir when that is out of `maxRange`.
*/
export function viewFocus(
viewer,
+1 -5
View File
@@ -1,10 +1,6 @@
import { freshStreet } from './state.js';
/**
* Owns the panel's viewer element and the photo viewer mounted in it (the
* MapillaryJS adapter, or a stand-in). Its poses update `state.street` and
* the marker; MapillaryJS loads on the first open.
*/
/** The panel's photo viewer: its poses update `state.street` and the marker. */
export function createViewerHost({ state, parts, adapter }) {
/** Set once mounted, until `unmount`. */
let unsubscribe = null;