Hand the application the renderer's own engine

An application may draw with a renderer's engine directly beside the
contract. ApplicationHooks gains engine, whose kind names the engine;
Cesium's plugin hands {kind: 'cesium', viewer}. An application draws only
with engines whose kind it knows, and what it draws is its own to add,
update and remove.
This commit is contained in:
Sameh Khamis committed 2026-11-17 22:19:21 -08:00
1 parent 96fac711f4
commit 0e6973e0b2
5 files changed
+21 -1

No files matched your search

+5
View File
@@ -14,6 +14,11 @@
* - `viewerDrawsEntity(entity)`: whether an entity is one the renderer draws
* itself (Cockpit asks whether the aircraft it flies still draws).
* - `qaHandles`: values QA scripts read from `window.__godsEyeView`.
* - `engine`: the renderer's own engine, for an application that draws with
* it directly beside the contract: `kind` names it (`'cesium'`, with
* `viewer`, Cesium's `Viewer`). An application draws only with engines
* whose kind it knows; what it draws there is its own to add, update and
* remove.
* - `ownCreditDisplay`: true when the renderer shows its credits in a
* display of its own; otherwise the application shows what its credits
* port lists (`src/ui/creditsView.js`).
+2
View File
@@ -218,6 +218,8 @@ export function createCesiumRendererPlugin({
// Whether an entity is one of the viewer's own (Cockpit asks whether
// the aircraft it flies still draws).
viewerDrawsEntity: (entity) => viewer.entities.contains(entity),
// An application drawing with Cesium itself beside the contract.
engine: Object.freeze({ kind: 'cesium', viewer }),
// QA scripts drive and read the viewer itself.
qaHandles: {
viewer,
+2
View File
@@ -156,6 +156,8 @@ test('the plugin wraps the viewer it is given, behind the accessor only', async
);
assert.equal(hooks.ownCreditDisplay, true, 'Cesium shows its own credits');
assert.equal(hooks.qaHandles.viewer, viewer, 'QA scripts read the viewer');
assert.equal(hooks.engine.kind, 'cesium', 'the engine says what it is');
assert.equal(hooks.engine.viewer, viewer, 'an application may draw with it');
assert.equal(hooks.viewerDrawsEntity({ own: true }), true);
assert.equal(hooks.viewerDrawsEntity({}), false);
assert.equal(typeof hooks.trimStaleCommands, 'function');
+8
View File
@@ -58,6 +58,14 @@ export interface ApplicationHooks {
viewerDrawsEntity?(entity: unknown): boolean;
/** Values QA scripts read from the page's debug handle. */
qaHandles?: Readonly<Record<string, unknown>>;
/**
* The renderer's own engine, for an application that draws with it
* directly beside the contract: `kind` names the engine (`'cesium'` for
* Cesium, whose `Cesium.Viewer` is `viewer`) and the rest is that engine's
* own. An application draws only with engines whose kind it knows, and
* whatever it draws there is its own to add, update and remove.
*/
engine?: Readonly<{ kind: string; [key: string]: unknown }>;
/**
* Show a recoverable notice when the renderer stops drawing (an error, a
* lost context), with Retry and, if `allowReload`, Reset, by publishing it