Share the Cesium ports between the app and conformance renderers

The frame, draw, camera, query and capture ports move out of the
conformance scene renderer into src/render/cesium/ports.js, unchanged.
The app's transitional renderer, now src/render/cesium/appRenderer.js,
builds the same ports over the full viewer; it still leaves out globe,
whenSettled and setTime, which would misreport photoreal tiles and stop
the app clock.

Disposing the ports now settles a pending renderOnce and detaches the
draw sets, so a model that loads after destroy is destroyed rather than
added to a destroyed collection. A viewer whose ports fail to build is
destroyed with its credits.

Checked in a browser: the app boots with one credits element, and all
eleven conformance scenes match their references exactly.
This commit is contained in:
Sameh Khamis committed 2026-11-05 15:50:48 -08:00
1 parent db78d6a8e4
commit 6a8afe3009
7 files changed
+770 -561

No files matched your search

+123
View File
@@ -0,0 +1,123 @@
/**
* @module render/cesium/appRenderer
* @description The application's default renderer plugin: today's Cesium
* viewer, set up exactly as before, behind the contract's `RendererPlugin`
* (`src/render/contract/renderer.d.ts`).
*
* The renderer it makes is transitional. Its ports are the shared Cesium
* ports (`ports.js`), the ones the conformance renderer is checked with,
* less the members that would not be true of the application yet: the
* globe (it draws photoreal tiles the port does not know), `whenSettled`
* (it would not wait for them) and `frame.setTime` (it would stop the
* application's clock). Those arrive with the layer families that need
* them (phase 2 of the renderer plan); `checkRendererShape` lists what is
* still missing.
* Until a family is ported, its code reaches the Cesium viewer through
* `cesiumViewerOf`, never through a renderer member, so no engine type
* crosses the contract and each call marks code still to port.
*/
import { createApplicationViewer } from '../../app/viewer.js';
import { CONTRACT_VERSION } from '../contract/index.js';
import { createCesiumPorts } from './ports.js';
/**
* The members a transitional renderer has today.
* @typedef {Pick<import('../contract/renderer').Renderer,
* 'id' | 'contractVersion' | 'capabilities' | 'canvas' | 'frame' | 'draw'
* | 'camera' | 'query' | 'capture' | 'resize' | 'destroy'>}
* TransitionalRenderer
*/
const viewers = new WeakMap();
/** A Set no one can change once built, so `capabilities` stays true. */
export class ReadonlySet extends Set {
#sealed;
constructor(values = []) {
// Filled here, not by Set's constructor: it would call the guarded add
// before the private field exists.
super();
for (const value of values) super.add(value);
this.#sealed = true;
}
add(value) {
if (this.#sealed) throw new TypeError('capabilities are read-only');
return super.add(value);
}
delete() {
throw new TypeError('capabilities are read-only');
}
clear() {
throw new TypeError('capabilities are read-only');
}
}
/**
* The Cesium viewer behind a renderer this plugin made, or null for any
* renderer it did not make.
* @param {object} renderer
* @returns {object|null}
*/
export const cesiumViewerOf = (renderer) => viewers.get(renderer) ?? null;
/**
* The Cesium plugin over a viewer factory; tests pass a fake one.
* @param {{createViewer?: typeof createApplicationViewer}} [options]
*/
export function createCesiumRendererPlugin({
createViewer = createApplicationViewer,
} = {}) {
return Object.freeze({
id: 'cesium',
/**
* Credentials stay with the scene, which still loads the tiles; they
* move into the renderer with the globe port.
* @param {{container: HTMLElement, signal: AbortSignal}} options
* @returns {Promise<TransitionalRenderer>}
*/
async create({ container, signal }) {
signal?.throwIfAborted();
// Provider attribution stays visible, including clean-view and recording.
const creditContainer = document.createElement('div');
creditContainer.id = 'cesium-credits';
document.body.appendChild(creditContainer);
let viewer;
let ports;
try {
viewer = createViewer({ container, creditContainer });
ports = createCesiumPorts(viewer);
} catch (error) {
if (viewer && !viewer.isDestroyed()) viewer.destroy();
creditContainer.remove();
throw error;
}
const renderer = Object.freeze({
id: 'cesium',
contractVersion: CONTRACT_VERSION,
capabilities: new ReadonlySet(['models']),
canvas: viewer.canvas,
frame: ports.frame,
draw: ports.draw,
camera: ports.camera,
query: ports.query,
capture: ports.capture,
resize() {
viewer.resize();
},
destroy() {
try {
ports.dispose();
if (!viewer.isDestroyed()) viewer.destroy();
} finally {
creditContainer.remove();
}
},
});
viewers.set(renderer, viewer);
return renderer;
},
});
}
/** The default plugin. */
export const cesiumRenderer = createCesiumRendererPlugin();