Name the surface heights answer against: globe.surfaceVersion and the surface settle kind

A new capability, surfaceIdentity, adds globe.surfaceVersion(): a number
that changes whenever what surface heights answer against changes (base,
terrain or photoreal swapped, the globe shown or hidden) and never on
camera moves or tile loads, so the app can key cached heights by it. The
settle kind 'surface' says whether that surface has loaded what is in
view: the terrain while the globe is shown, otherwise the drawn tiles,
false with neither; a renderer without the capability answers it as base.

The Cesium globe port reads both off the scene, so a base changed around
the port counts too; its versions come from one counter shared by every
port. The stub bumps on real base, terrain, photoreal and visibility
changes. A conformance check and a globe port test cover them.
This commit is contained in:
Sameh Khamis committed 2026-11-08 13:31:03 -08:00
1 parent e15cfb3e32
commit 456645f291
11 files changed
+165 -3

No files matched your search

+6
View File
@@ -42,6 +42,12 @@ optional, so a renderer written before it still conforms:
target's east-north-up frame, or the identity. `setView` keeps that frame target's east-north-up frame, or the identity. `setView` keeps that frame
while it places a world pose. A share link's follow offset is while it places a world pose. A share link's follow offset is
re-expressed in it, satellites included. re-expressed in it, satellites included.
- `globe.surfaceVersion()` (capability `surfaceIdentity`) is a number that
changes whenever what surface heights answer against changes (base,
terrain or photoreal route swapped, the globe shown or hidden) and never
otherwise (not on camera moves or tile loads), so the application can key cached
heights by it. `isSettled('surface')` says whether that surface has
loaded what is in view; a renderer without it answers `surface` as `base`.
- `camera.on('changed', cb, { threshold })` measures each listener by its - `camera.on('changed', cb, { threshold })` measures each listener by its
own threshold under the capability `cameraChangeThreshold`; a renderer own threshold under the capability `cameraChangeThreshold`; a renderer
without it fires every `changed` listener at 0.5. without it fires every `changed` listener at 0.5.
+59 -1
View File
@@ -114,6 +114,9 @@ async function terrainProvider(spec, { worldDataToken }) {
throw new TypeError(`Unknown terrain kind: ${spec.kind}`); throw new TypeError(`Unknown terrain kind: ${spec.kind}`);
} }
/** The last `surfaceVersion` any globe port handed out. */
let surfaceVersions = 0;
/** /**
* @param {object} widget A Cesium `CesiumWidget` or `Viewer`. * @param {object} widget A Cesium `CesiumWidget` or `Viewer`.
* @param {{capabilities: ReadonlySet<string>, * @param {{capabilities: ReadonlySet<string>,
@@ -370,7 +373,56 @@ export function createCesiumGlobe(
}; };
const imageryLoaded = () => imagery.pending() === 0 && terrainLoaded(); const imageryLoaded = () => imagery.pending() === 0 && terrainLoaded();
/**
* `surface`: what surface heights answer from has loaded what is in view:
* the globe's terrain while it is shown, otherwise the shown 3D tiles;
* false with neither drawn.
*/
function surfaceLoaded() {
if (scene.globe?.show) return scene.globe.tilesLoaded !== false;
let found = false;
for (const tileset of tilesets()) {
if (!tileset.show || tileset.isDestroyed?.()) continue;
found = true;
if (tileset.tilesLoaded === false) return false;
}
return found;
}
// `surfaceVersion`: bumped when what heights answer against changes, read
// off the scene (so a base changed around the port counts too): whether
// the globe is shown, its terrain provider, and the shown 3D tilesets.
// Taken from one counter for every port, so no two surfaces share one.
let surfaceVersion = 0;
const surfaceSeen = { globe: null, terrain: null, tiles: new Set() };
function readSurfaceVersion() {
const globe = Boolean(scene.globe?.show);
const terrain = scene.globe?.terrainProvider ?? null;
let changed =
surfaceSeen.globe !== globe || surfaceSeen.terrain !== terrain;
// The shown tilesets as a set: their order among the primitives is no
// change to the surface.
let count = 0;
for (const tileset of tilesets()) {
if (!tileset.show || tileset.isDestroyed?.()) continue;
count += 1;
if (!surfaceSeen.tiles.has(tileset)) changed = true;
}
if (count !== surfaceSeen.tiles.size) changed = true;
if (changed) {
surfaceSeen.globe = globe;
surfaceSeen.terrain = terrain;
surfaceSeen.tiles.clear();
for (const tileset of tilesets())
if (tileset.show && !tileset.isDestroyed?.())
surfaceSeen.tiles.add(tileset);
surfaceVersion = ++surfaceVersions;
}
return surfaceVersion;
}
function isSettled(kind) { function isSettled(kind) {
if (kind === 'surface' && can('surfaceIdentity')) return surfaceLoaded();
if (kind === 'terrain') return terrainLoaded(); if (kind === 'terrain') return terrainLoaded();
if (kind === 'tiles') return tilesLoaded(); if (kind === 'tiles') return tilesLoaded();
if (kind === 'imagery') return imageryLoaded(); if (kind === 'imagery') return imageryLoaded();
@@ -440,6 +492,7 @@ export function createCesiumGlobe(
}; };
if (can('globeVisibility')) if (can('globeVisibility'))
port.isGlobeVisible = () => scene.globe?.show === true; port.isGlobeVisible = () => scene.globe?.show === true;
if (can('surfaceIdentity')) port.surfaceVersion = readSurfaceVersion;
if (can('splitSwipe')) { if (can('splitSwipe')) {
// Cesium's split starts at the canvas's left edge, as the scene was // Cesium's split starts at the canvas's left edge, as the scene was
// made: a `left` layer shows once the split moves. // made: a `left` layer shows once the split moves.
@@ -473,7 +526,12 @@ provideUnboundGlobe((viewer) => {
if (!viewer?.scene) return null; if (!viewer?.scene) return null;
// Visibility reads back only from a globe that keeps it: a scene made // Visibility reads back only from a globe that keeps it: a scene made
// without one gives no reading, so its callers keep their own default. // without one gives no reading, so its callers keep their own default.
const capabilities = new Set(['imageHooks', 'imageryOnTiles', 'splitSwipe']); const capabilities = new Set([
'imageHooks',
'imageryOnTiles',
'splitSwipe',
'surfaceIdentity',
]);
if (typeof viewer.scene.globe?.show === 'boolean') if (typeof viewer.scene.globe?.show === 'boolean')
capabilities.add('globeVisibility'); capabilities.add('globeVisibility');
const { port, dispose } = createCesiumGlobe(viewer, { const { port, dispose } = createCesiumGlobe(viewer, {
+27
View File
@@ -602,3 +602,30 @@ test('a provider that fails to build is told as an error of its root tile', asyn
assert.deepEqual(errors, [{ tile: { x: 0, y: 0, level: 0 } }]); assert.deepEqual(errors, [{ tile: { x: 0, y: 0, level: 0 } }]);
layer.remove(); layer.remove();
}); });
test('surfaceVersion follows what heights answer against; surface settles on it', () => {
const { scene, port } = setup(new Set([...ALL, 'surfaceIdentity']));
const first = port.surfaceVersion();
assert.equal(port.surfaceVersion(), first, 'steady while nothing changes');
assert.equal(port.isSettled('surface'), true, 'the globe has loaded');
scene.globe.tilesLoaded = false;
assert.equal(port.isSettled('surface'), false, 'the globe still loading');
assert.equal(port.surfaceVersion(), first, 'tile loads are not a change');
scene.globe.show = false;
const hidden = port.surfaceVersion();
assert.notEqual(hidden, first, 'the globe hidden');
assert.equal(port.isSettled('surface'), false, 'no globe and no tiles');
const tileset = fakeTileset();
scene.primitives.add(tileset);
const tiled = port.surfaceVersion();
assert.notEqual(tiled, hidden, 'tiles shown');
assert.equal(port.isSettled('surface'), true, 'the tiles have loaded');
scene.globe.show = true;
scene.globe.terrainProvider = {};
assert.notEqual(port.surfaceVersion(), tiled, 'new terrain under the globe');
// Without the capability there is no version and surface answers as base.
const plain = setup();
assert.equal(plain.port.surfaceVersion, undefined);
plain.scene.globe.show = false;
assert.equal(plain.port.isSettled('surface'), plain.port.isSettled('base'));
});
+1
View File
@@ -76,6 +76,7 @@ export const CESIUM_CHECKS = new Set([
'globe.imagery', 'globe.imagery',
'globe.sky', 'globe.sky',
'globe.split', 'globe.split',
'globe.surfaceVersion',
'globe.visible', 'globe.visible',
'globe.withoutImageHooks', 'globe.withoutImageHooks',
'input.behaviours', 'input.behaviours',
+1
View File
@@ -44,6 +44,7 @@ const GLOBE_CAPABILITIES = [
'imageryOnTiles', 'imageryOnTiles',
'splitSwipe', 'splitSwipe',
'imageHooks', 'imageHooks',
'surfaceIdentity',
'globeVisibility', 'globeVisibility',
]; ];
+1
View File
@@ -23,6 +23,7 @@ test('capabilities follow what the scene supports', () => {
'imageryOnTiles', 'imageryOnTiles',
'splitSwipe', 'splitSwipe',
'imageHooks', 'imageHooks',
'surfaceIdentity',
]; ];
const globe = { show: true }; const globe = { show: true };
const draw = ['models', 'quads', 'meshes']; const draw = ['models', 'quads', 'meshes'];
+33
View File
@@ -3053,6 +3053,39 @@ export function portChecks() {
}, },
{ capability: 'globeVisibility' }, { capability: 'globeVisibility' },
), ),
check(
'globe.surfaceVersion',
'the surface version changes with what heights answer against, only',
async (h, r) => {
await overAustin(h, r);
await drawn(h, r);
const first = r.globe.surfaceVersion();
equal(typeof first, 'number', 'a number');
r.camera.setView({
destination: { ...AUSTIN, height: 9000 },
orientation: { heading: 1, pitch: -1, roll: 0 },
});
await drawn(h, r, 4);
equal(
r.globe.surfaceVersion(),
first,
'steady across frames and moves',
);
r.globe.setGlobeVisible(false);
await drawn(h, r);
const hidden = r.globe.surfaceVersion();
ok(hidden !== first, 'the globe hidden changes it');
equal(
r.globe.isSettled('surface'),
false,
'with no globe and no tiles there is no surface to settle',
);
r.globe.setGlobeVisible(true);
await drawn(h, r);
ok(r.globe.surfaceVersion() !== hidden, 'shown again changes it');
},
{ capability: 'surfaceIdentity' },
),
check( check(
'globe.sky', 'globe.sky',
'sky settings round-trip and keep unchanged keys', 'sky settings round-trip and keep unchanged keys',
+2
View File
@@ -160,6 +160,8 @@ export type Capability =
| 'imageryFrames' | 'imageryFrames'
/** Wind-relief and similar shading of the globe surface. */ /** Wind-relief and similar shading of the globe surface. */
| 'surfaceShading' | 'surfaceShading'
/** A version of what surface heights answer against (`globe.surfaceVersion`). */
| 'surfaceIdentity'
/** Volumetric clouds (`globe.setClouds`). */ /** Volumetric clouds (`globe.setClouds`). */
| 'clouds' | 'clouds'
/** A water surface on the oceans (`globe.setWater`). */ /** A water surface on the oceans (`globe.setWater`). */
+14 -1
View File
@@ -248,7 +248,13 @@ export interface LoadProgress {
terrainPending: number; terrainPending: number;
} }
export type SettleKind = 'base' | 'tiles' | 'terrain' | 'imagery'; /**
* `surface`: what `against: 'surface'` heights answer from has loaded what
* is in view: the terrain while the globe is shown, otherwise the drawn
* tiles; false when neither is drawn. A renderer that predates it answers
* as `base`.
*/
export type SettleKind = 'base' | 'tiles' | 'terrain' | 'imagery' | 'surface';
export interface GlobePort { export interface GlobePort {
/** Switch the whole base at once; resolves when the new base has settled. */ /** Switch the whole base at once; resolves when the new base has settled. */
@@ -265,6 +271,13 @@ export interface GlobePort {
* drawn. * drawn.
*/ */
isGlobeVisible?(): boolean; isGlobeVisible?(): boolean;
/**
* `surfaceIdentity`: a number that changes whenever what heights answer
* against changes (base, terrain or photoreal route swapped, the globe
* shown or hidden) and never otherwise (not on camera moves or tile
* loads). The application keys cached surface heights by it.
*/
surfaceVersion?(): number;
/** `surfaceShading`. */ /** `surfaceShading`. */
setSurfaceShading?(shading: SurfaceShading | null): void; setSurfaceShading?(shading: SurfaceShading | null): void;
/** `clouds`: the renderer's volumetric clouds, or none. */ /** `clouds`: the renderer's volumetric clouds, or none. */
+2
View File
@@ -23,6 +23,7 @@ export const CAPABILITIES = Object.freeze([
'splitSwipe', 'splitSwipe',
'imageryFrames', 'imageryFrames',
'surfaceShading', 'surfaceShading',
'surfaceIdentity',
'clouds', 'clouds',
'water', 'water',
'imageHooks', 'imageHooks',
@@ -151,6 +152,7 @@ export const PORTS = deepFreeze({
'on', 'on',
), ),
['isGlobeVisible', 'globeVisibility'], ['isGlobeVisible', 'globeVisibility'],
['surfaceVersion', 'surfaceIdentity'],
['setSurfaceShading', 'surfaceShading'], ['setSurfaceShading', 'surfaceShading'],
['setClouds', 'clouds'], ['setClouds', 'clouds'],
['setWater', 'water'], ['setWater', 'water'],
+19 -1
View File
@@ -1142,6 +1142,9 @@ export function createStubRenderer(options = {}) {
return layer; return layer;
} }
// `surfaceIdentity`: bumped by whatever changes what heights answer against.
let surfaceVersion = 0;
let terrainKey = 'null';
const globe = { const globe = {
async setBase(base) { async setBase(base) {
log('globe', 'setBase', [base]); log('globe', 'setBase', [base]);
@@ -1153,19 +1156,26 @@ export function createStubRenderer(options = {}) {
}, },
async setPhotoreal(spec) { async setPhotoreal(spec) {
log('globe', 'setPhotoreal', [spec]); log('globe', 'setPhotoreal', [spec]);
const route = photorealStatus.route;
photorealStatus = photorealStatus =
spec && capabilities.has('photoreal') spec && capabilities.has('photoreal')
? { route: 'google' } ? { route: 'google' }
: { route: 'none' }; : { route: 'none' };
if (photorealStatus.route !== route || spec) surfaceVersion += 1;
requestRender('base'); requestRender('base');
return photorealStatus; return photorealStatus;
}, },
async setTerrain(spec) { async setTerrain(spec) {
log('globe', 'setTerrain', [spec]); log('globe', 'setTerrain', [spec]);
// The stub keeps no terrain: a spec unlike the last is a new surface.
const key = JSON.stringify(spec ?? null);
if (key !== terrainKey) surfaceVersion += 1;
terrainKey = key;
requestRender('base'); requestRender('base');
}, },
setGlobeVisible(visible) { setGlobeVisible(visible) {
log('globe', 'setGlobeVisible', [visible]); log('globe', 'setGlobeVisible', [visible]);
if (globeVisible !== Boolean(visible)) surfaceVersion += 1;
globeVisible = Boolean(visible); globeVisible = Boolean(visible);
requestRender('base'); requestRender('base');
}, },
@@ -1180,7 +1190,13 @@ export function createStubRenderer(options = {}) {
requestRender('sky'); requestRender('sky');
}, },
}, },
isSettled: (kind) => settled[kind] ?? true, isSettled(kind) {
if (kind !== 'surface') return settled[kind] ?? true;
if (!capabilities.has('surfaceIdentity')) return settled.base;
// Heights answer from the globe, else the tiles; neither drawn, none.
if (!globeVisible && photorealStatus.route === 'none') return false;
return settled.surface ?? settled[globeVisible ? 'terrain' : 'tiles'];
},
on(event, cb) { on(event, cb) {
if (event !== 'progress') return () => {}; if (event !== 'progress') return () => {};
progressListeners.push(cb); progressListeners.push(cb);
@@ -1192,6 +1208,8 @@ export function createStubRenderer(options = {}) {
}; };
if (capabilities.has('globeVisibility')) if (capabilities.has('globeVisibility'))
globe.isGlobeVisible = () => globeVisible; globe.isGlobeVisible = () => globeVisible;
if (capabilities.has('surfaceIdentity'))
globe.surfaceVersion = () => surfaceVersion;
if (capabilities.has('surfaceShading')) if (capabilities.has('surfaceShading'))
globe.setSurfaceShading = (shading) => { globe.setSurfaceShading = (shading) => {
log('globe', 'setSurfaceShading', [shading]); log('globe', 'setSurfaceShading', [shading]);