Follow, drape and read the camera through the ports, not the viewer

- What the camera follows is the camera port's target only: no layer
  tracks an entity of its own any more, so followed.js stops reading and
  writing viewer.trackedEntity and the viewer's clock.
- Draped imagery's host is the globe port's imagery while the globe is
  shown (isGlobeVisible, or no shown base tileset where a renderer cannot
  say), else the shown base tileset; weather uses the same resolver.
- The World Packet reads the eye from the camera port's pose, and vessels
  ask again for the view on the camera port's moveEnd.
- The stub's canvas takes event listeners, and in a page is a real canvas
  filling the container it is given; createStubRendererPlugin makes it a
  renderer plugin.

The viewer access record is now empty.
This commit is contained in:
Sameh Khamis committed 2026-11-10 17:18:10 -08:00
1 parent ebbe006924
commit a72d4c3b1f
11 files changed
+229 -212

No files matched your search

+4 -4
View File
@@ -1,4 +1,4 @@
import { toLonLatH } from '../geo/index.js'; import { findCamera } from '../render/rendererOf.js';
import { import {
feedProvenanceEnvelope, feedProvenanceEnvelope,
layerSnapshot, layerSnapshot,
@@ -104,12 +104,12 @@ export function getWorldPacket(options = {}) {
// A default parameter only covers undefined; null or NaN would age every // A default parameter only covers undefined; null or NaN would age every
// feed against the epoch and report stale data as "just now". // feed against the epoch and report stale data as "just now".
const now = Number.isFinite(requestedNow) ? requestedNow : Date.now(); const now = Number.isFinite(requestedNow) ? requestedNow : Date.now();
if (!viewer?.camera?.positionWC) const pose = findCamera(viewer)?.pose();
throw new TypeError('World Packet requires a viewer camera'); if (!pose) throw new TypeError('World Packet requires a viewer camera');
if (!dataManager || typeof dataManager.getAll !== 'function') if (!dataManager || typeof dataManager.getAll !== 'function')
throw new TypeError('World Packet requires a data manager'); throw new TypeError('World Packet requires a data manager');
const eye = toLonLatH(viewer.camera.positionWC); const eye = { lon: pose.lon, lat: pose.lat, height: pose.height };
// Read the roster once. Voice must not rewalk disabled layers: preserving the // Read the roster once. Voice must not rewalk disabled layers: preserving the
// current enabled-only view keeps the model's context budget bounded. // current enabled-only view keeps the model's context budget bounded.
const rows = dataManager.getAll(); const rows = dataManager.getAll();
+10
View File
@@ -3,6 +3,8 @@ import assert from 'node:assert/strict';
import * as Cesium from 'cesium'; import * as Cesium from 'cesium';
import { getWorldPacket } from './worldPacket.js'; import { getWorldPacket } from './worldPacket.js';
import { bindRenderer } from '../render/rendererOf.js';
import { createStubRenderer } from '../render/stub/index.js';
import { createGevActionRunner } from '../voice/gevActions.js'; import { createGevActionRunner } from '../voice/gevActions.js';
function withoutVoicePresentation(result) { function withoutVoicePresentation(result) {
@@ -63,6 +65,14 @@ function harness() {
getCockpitState: () => null, getCockpitState: () => null,
getControlState: () => ({ hud: { visible: 'auto' } }), getControlState: () => ({ hud: { visible: 'auto' } }),
}; };
// The packet reads the eye from the camera port of the renderer bound to
// the scene object.
const renderer = createStubRenderer();
renderer.camera.setView({
destination: { lon: -97.74, lat: 30.26, height: 500 },
orientation: { heading: 0, pitch: Cesium.Math.toRadians(-45), roll: 0 },
});
bindRenderer(viewer, renderer);
return { viewer, dataManager, styleManager }; return { viewer, dataManager, styleManager };
} }
+15 -34
View File
@@ -4,17 +4,13 @@
* *
* A layer follows through the camera port with a FollowTarget that also * A layer follows through the camera port with a FollowTarget that also
* carries what the app shows about it (key, display position, sprite, label). * carries what the app shows about it (key, display position, sprite, label).
* Until every layer does, a layer may still track an entity of its own * A layer that keeps its target as a holder of its own (an entity record)
* through Cesium's `trackedEntity`; that entity is seen here through the * follows through the port with `entityFollowTarget`, whose presentation
* same fields, read from its entity record. Readers ask this module, never * fields read that record. Readers ask this module, never the renderer.
* `trackedEntity`, so they work either way. A layer that still draws its
* target as an entity follows through the port with `entityFollowTarget`,
* whose presentation fields read that same record.
* *
* Its readers (the tracked card, Cockpit, the share link's thing view, * Its readers (the tracked card, Cockpit, the share link's thing view,
* north-up) still read the drawn entity and its `displayPosition`: a port * north-up) read the target's `displayPosition`: a port target without one
* target without them is followed by the camera but not shown by them, * is followed by the camera but not shown by them.
* until those readers move with the drawing to the renderer.
*/ */
import { findCamera } from '../render/rendererOf.js'; import { findCamera } from '../render/rendererOf.js';
import { readEntityRecord } from './entityRecords.js'; import { readEntityRecord } from './entityRecords.js';
@@ -29,8 +25,8 @@ import { readEntityRecord } from './entityRecords.js';
* @property {object} [sprite] Size of the drawn billboard. * @property {object} [sprite] Size of the drawn billboard.
* @property {object} [labelModel] * @property {object} [labelModel]
* @property {string} [selectionOrigin] * @property {string} [selectionOrigin]
* @property {object} [entity] The tracked entity, for a layer that still * @property {object} [entity] The holder whose entity record the
* tracks one itself. * presentation fields read (`entityFollowTarget`).
*/ */
/** @type {WeakMap<object, Followed>} */ /** @type {WeakMap<object, Followed>} */
@@ -78,10 +74,7 @@ function entityView(entity) {
*/ */
export function followedOf(viewer) { export function followedOf(viewer) {
if (!viewer) return null; if (!viewer) return null;
const target = findCamera(viewer)?.followed; return findCamera(viewer)?.followed ?? null;
if (target) return target;
const entity = viewer.trackedEntity;
return entity ? entityView(entity) : null;
} }
/** Whether `viewer`'s camera follows anything. */ /** Whether `viewer`'s camera follows anything. */
@@ -100,8 +93,7 @@ export function onFollowChanged(viewer, cb) {
let port = null; let port = null;
let offPort = null; let offPort = null;
// The port is looked up again on every change: a renderer bound after // The port is looked up again on every change: a renderer bound after
// this subscribed replaces the one it listened to. A Cesium port's follow // this subscribed replaces the one it listened to.
// also sets `trackedEntity`, so the change still arrives through it.
const listenToPort = () => { const listenToPort = () => {
const current = findCamera(viewer); const current = findCamera(viewer);
if (current === port) return; if (current === port) return;
@@ -117,20 +109,17 @@ export function onFollowChanged(viewer, cb) {
cb(now); cb(now);
} }
listenToPort(); listenToPort();
const offTracking = viewer.trackedEntityChanged?.addEventListener(check);
return () => { return () => {
offPort?.(); offPort?.();
offPort = null; offPort = null;
offTracking?.();
}; };
} }
/** Stop the camera following anything, a layer's own tracking included. */ /** Stop the camera following anything. */
export function stopFollowing(viewer) { export function stopFollowing(viewer) {
if (!viewer) return; if (!viewer) return;
const camera = findCamera(viewer); const camera = findCamera(viewer);
if (camera?.followed) camera.follow(null); if (camera?.followed) camera.follow(null);
else if (viewer.trackedEntity) viewer.trackedEntity = undefined;
} }
/** /**
@@ -157,30 +146,22 @@ export function entityFollowTarget(entity, camera) {
} }
/** /**
* Follow `followed` again after `stopFollowing`: a port target through the * Follow `followed` again after `stopFollowing`, through the camera port.
* camera port, a layer's own tracked entity through `trackedEntity`.
* @param {object} viewer * @param {object} viewer
* @param {Followed|null} followed What `followedOf` gave. * @param {Followed|null} followed What `followedOf` gave.
*/ */
export function resumeFollowing(viewer, followed) { export function resumeFollowing(viewer, followed) {
if (!viewer || !followed) return; if (!viewer || !followed) return;
if (entityViews.get(followed.entity) === followed) findCamera(viewer)?.follow(followed);
viewer.trackedEntity = followed.entity;
else findCamera(viewer)?.follow(followed);
} }
/** /**
* Where `followed` is shown this frame: the layer's display cache, else its * Where `followed` is shown this frame: the layer's display cache; null
* entity's position at the viewer's time; null when neither answers. * when it has none, or it answers nothing.
* @param {object} viewer * @param {object} viewer
* @param {Followed|null} followed * @param {Followed|null} followed
*/ */
export function followedPosition(viewer, followed) { export function followedPosition(viewer, followed) {
const display = followed?.displayPosition; const display = followed?.displayPosition;
const shown = typeof display === 'function' ? display() : null; return (typeof display === 'function' ? display() : null) || null;
return (
shown ||
followed?.entity?.position?.getValue?.(viewer?.clock?.currentTime) ||
null
);
} }
+20 -85
View File
@@ -14,23 +14,6 @@ import {
import { bindRenderer } from '../render/rendererOf.js'; import { bindRenderer } from '../render/rendererOf.js';
import { createCameraEvents } from '../render/camera/events.js'; import { createCameraEvents } from '../render/camera/events.js';
/** A viewer whose `trackedEntity` behaves as Cesium's setter does. */
function trackingViewer() {
const trackedEntityChanged = new Cesium.Event();
let tracked;
return {
trackedEntityChanged,
get trackedEntity() {
return tracked;
},
set trackedEntity(value) {
if (tracked === value) return;
tracked = value;
trackedEntityChanged.raiseEvent(value);
},
};
}
/** A camera port that follows, for a viewer bound to a renderer. */ /** A camera port that follows, for a viewer bound to a renderer. */
function followingPort() { function followingPort() {
const events = createCameraEvents({ pose: () => ({}), report: () => {} }); const events = createCameraEvents({ pose: () => ({}), report: () => {} });
@@ -48,62 +31,37 @@ function followingPort() {
}; };
} }
test('a layer’s own tracked entity is seen through its entity record', () => { test('what the camera port follows is the target itself', (t) => {
const viewer = trackingViewer(); const viewer = {};
assert.equal(followedOf(viewer), null); assert.equal(followedOf(viewer), null, 'nothing without a renderer');
assert.equal(isFollowing(viewer), false);
const entity = new Cesium.Entity({ id: 'e1', name: 'N1' });
const record = entityRecord(entity);
record.trackedId = 'flights:abc';
record.displayPosition = () => ({ x: 1, y: 2, z: 3 });
record.sprite = { width: 28 };
viewer.trackedEntity = entity;
const followed = followedOf(viewer);
assert.equal(followed, followedOf(viewer), 'the same view each time');
assert.equal(followed.key, 'flights:abc');
assert.equal(followed.name, 'N1');
assert.deepEqual(followed.displayPosition(), { x: 1, y: 2, z: 3 });
assert.equal(followed.sprite.width, 28);
assert.equal(followed.entity, entity);
viewer.trackedEntity = new Cesium.Entity({ id: 'plain' });
assert.equal(followedOf(viewer).key, 'entity:plain', 'no tracked id');
});
test('a port follow comes before any tracked entity, and is the target itself', (t) => {
const viewer = trackingViewer();
const camera = followingPort(); const camera = followingPort();
t.after(bindRenderer(viewer, { camera })); t.after(bindRenderer(viewer, { camera }));
viewer.trackedEntity = new Cesium.Entity({ id: 'helper' }); assert.equal(followedOf(viewer), null);
assert.equal(isFollowing(viewer), false);
const target = { key: 'flights:abc', position: () => null }; const target = { key: 'flights:abc', position: () => null };
camera.follow(target); camera.follow(target);
assert.equal(followedOf(viewer), target); assert.equal(followedOf(viewer), target);
assert.equal(isFollowing(viewer), true);
}); });
test('onFollowChanged fires once per change, from either source', (t) => { test('onFollowChanged fires once per change', (t) => {
const viewer = trackingViewer(); const viewer = {};
const camera = followingPort(); const camera = followingPort();
t.after(bindRenderer(viewer, { camera })); t.after(bindRenderer(viewer, { camera }));
const seen = []; const seen = [];
const off = onFollowChanged(viewer, (f) => seen.push(f?.key ?? null)); const off = onFollowChanged(viewer, (f) => seen.push(f?.key ?? null));
const target = { key: 'flights:abc' }; const target = { key: 'flights:abc' };
// A port follow on Cesium sets trackedEntity too: still one change.
camera.follow(target); camera.follow(target);
// Ending it, Cesium clears its tracking before the port announces. camera.follow(target);
viewer.trackedEntity = undefined;
camera.follow(null); camera.follow(null);
const entity = new Cesium.Entity({ id: 'legacy' });
viewer.trackedEntity = entity;
viewer.trackedEntity = entity;
off(); off();
viewer.trackedEntity = undefined; camera.follow({ key: 'after' });
assert.deepEqual(seen, ['flights:abc', null, 'entity:legacy']); assert.deepEqual(seen, ['flights:abc', null]);
}); });
test('stopFollowing ends a port follow, or a layer’s own tracking', (t) => { test('stopFollowing ends a port follow', (t) => {
const viewer = trackingViewer(); const viewer = {};
viewer.trackedEntity = new Cesium.Entity({ id: 'legacy' });
stopFollowing(viewer); stopFollowing(viewer);
assert.equal(viewer.trackedEntity, undefined);
const camera = followingPort(); const camera = followingPort();
t.after(bindRenderer(viewer, { camera })); t.after(bindRenderer(viewer, { camera }));
camera.follow({ key: 'k' }); camera.follow({ key: 'k' });
@@ -112,19 +70,6 @@ test('stopFollowing ends a port follow, or a layer’s own tracking', (t) => {
stopFollowing(null); stopFollowing(null);
}); });
test('a renderer bound after subscribing is still heard', (t) => {
const viewer = { trackedEntityChanged: new Cesium.Event() };
const seen = [];
onFollowChanged(viewer, (f) => seen.push(f?.key ?? null));
const camera = followingPort();
t.after(bindRenderer(viewer, { camera }));
// Any change re-resolves the port; a Cesium follow raises one.
viewer.trackedEntityChanged.raiseEvent();
camera.follow({ key: 'k' });
camera.follow(null);
assert.deepEqual(seen, ['k', null]);
});
test('an entity follow target reads its entity record live', () => { test('an entity follow target reads its entity record live', () => {
const entity = new Cesium.Entity({ id: 'drawn', name: 'N2' }); const entity = new Cesium.Entity({ id: 'drawn', name: 'N2' });
const position = () => ({ x: 1, y: 2, z: 3 }); const position = () => ({ x: 1, y: 2, z: 3 });
@@ -142,16 +87,8 @@ test('an entity follow target reads its entity record live', () => {
assert.equal(keyed.labelModel.title, 'N2'); assert.equal(keyed.labelModel.title, 'N2');
}); });
test('resumeFollowing follows a port target again, or re-tracks an entity', (t) => { test('resumeFollowing follows a port target again', (t) => {
const viewer = trackingViewer(); const viewer = {};
const entity = new Cesium.Entity({ id: 'legacy' });
viewer.trackedEntity = entity;
const legacy = followedOf(viewer);
stopFollowing(viewer);
resumeFollowing(viewer, legacy);
assert.equal(viewer.trackedEntity, entity);
assert.equal(followedOf(viewer), legacy);
viewer.trackedEntity = undefined;
const camera = followingPort(); const camera = followingPort();
t.after(bindRenderer(viewer, { camera })); t.after(bindRenderer(viewer, { camera }));
const target = entityFollowTarget(new Cesium.Entity({ id: 'p' }), {}); const target = entityFollowTarget(new Cesium.Entity({ id: 'p' }), {});
@@ -163,13 +100,11 @@ test('resumeFollowing follows a port target again, or re-tracks an entity', (t)
assert.equal(camera.followed, target); assert.equal(camera.followed, target);
}); });
test('followedPosition prefers the display cache over the entity position', () => { test('followedPosition reads the display cache', () => {
const at = new Cesium.Cartesian3(4, 5, 6); const entity = new Cesium.Entity({ id: 'e' });
const viewer = { clock: { currentTime: Cesium.JulianDate.now() } };
const entity = new Cesium.Entity({ id: 'e', position: at });
const view = entityFollowTarget(entity, {}); const view = entityFollowTarget(entity, {});
assert.deepEqual(followedPosition(viewer, view), at); assert.equal(followedPosition({}, view), null, 'none without a cache');
entityRecord(entity).displayPosition = () => ({ x: 7, y: 8, z: 9 }); entityRecord(entity).displayPosition = () => ({ x: 7, y: 8, z: 9 });
assert.deepEqual(followedPosition(viewer, view), { x: 7, y: 8, z: 9 }); assert.deepEqual(followedPosition({}, view), { x: 7, y: 8, z: 9 });
assert.equal(followedPosition(viewer, null), null); assert.equal(followedPosition({}, null), null);
}); });
+4 -3
View File
@@ -1,5 +1,6 @@
import { VESSEL_OVERLAY_SOURCE_ID } from '../../data/vesselLabels.js'; import { VESSEL_OVERLAY_SOURCE_ID } from '../../data/vesselLabels.js';
import { msg, t } from '../../i18n/index.js'; import { msg, t } from '../../i18n/index.js';
import { findCamera } from '../../render/rendererOf.js';
import { AIS_FIRST_CONNECT_GRACE_MS, AIS_HEALTHY_STATUSES } from './policy.js'; import { AIS_FIRST_CONNECT_GRACE_MS, AIS_HEALTHY_STATUSES } from './policy.js';
export function createLifecycle({ export function createLifecycle({
@@ -190,9 +191,9 @@ export function createLifecycle({
); );
// Vessels are asked for by view, so ask again when the view moves away. // Vessels are asked for by view, so ask again when the view moves away.
removeViewListener(); removeViewListener();
const moveEnd = activeViewer?.camera?.moveEnd; const camera = findCamera(activeViewer);
if (typeof moveEnd?.addEventListener === 'function') if (camera)
state.feed.removeViewListener = moveEnd.addEventListener(() => { state.feed.removeViewListener = camera.on('moveEnd', () => {
components.ingestion.refreshIfMoved(activeViewer); components.ingestion.refreshIfMoved(activeViewer);
}); });
return components.ingestion.loadLivePositions(activeViewer); return components.ingestion.loadLivePositions(activeViewer);
+6 -13
View File
@@ -1,17 +1,10 @@
import { msg } from '../../i18n/index.js'; import { NO_IMAGERY_HOST } from '../../maps/imageryHost.js';
/** Resolve the visible surface that can own weather imagery without scene mutation. */ /**
export function resolveImageryHost({ viewer, tileset }) { * Resolve the visible surface that can own weather imagery without scene
if (viewer?.scene?.globe?.show === true) * mutation: the map stack's imagery host (`src/maps/imageryHost.js`).
return { collection: viewer.imageryLayers, kind: 'globe' }; */
if (tileset?.imageryLayers) export { NO_IMAGERY_HOST, resolveImageryHost } from '../../maps/imageryHost.js';
return { collection: tileset.imageryLayers, kind: 'tileset' };
return { collection: null, kind: 'none' };
}
export const NO_IMAGERY_HOST = msg(
'Hidden by this map source · choose a globe map',
);
/** Report imagery suspension without changing or detaching the resolved host. */ /** Report imagery suspension without changing or detaching the resolved host. */
export function imageryHostStatus(host) { export function imageryHostStatus(host) {
+16 -20
View File
@@ -5,6 +5,8 @@ import {
imageryHostStatus, imageryHostStatus,
NO_IMAGERY_HOST, NO_IMAGERY_HOST,
} from './imageryHost.js'; } from './imageryHost.js';
import { bindRenderer } from '../../render/rendererOf.js';
import { createStubRenderer } from '../../render/stub/index.js';
test('only a missing host suspends weather; 3D Tiles has no height gate', () => { test('only a missing host suspends weather; 3D Tiles has no height gate', () => {
assert.equal(imageryHostStatus({ kind: 'tileset' }), null); assert.equal(imageryHostStatus({ kind: 'tileset' }), null);
@@ -12,28 +14,22 @@ test('only a missing host suspends weather; 3D Tiles has no height gate', () =>
assert.equal(imageryHostStatus({ kind: 'none' }), NO_IMAGERY_HOST); assert.equal(imageryHostStatus({ kind: 'none' }), NO_IMAGERY_HOST);
}); });
test('visible globe takes precedence over a tileset', () => { test('weather drapes on the map stack imagery host', () => {
const viewer = { imageryLayers: {}, scene: { globe: { show: true } } }; const renderer = createStubRenderer();
assert.deepEqual( const viewer = {};
resolveImageryHost({ viewer, tileset: { imageryLayers: {} } }), bindRenderer(viewer, renderer);
{ collection: viewer.imageryLayers, kind: 'globe' }, const tileset = { id: 'tiles' };
);
});
test('hidden globe uses the supplied tileset imagery collection', () => {
const tileset = { imageryLayers: {} };
const viewer = { scene: { globe: { show: false } } };
assert.deepEqual(resolveImageryHost({ viewer, tileset }), { assert.deepEqual(resolveImageryHost({ viewer, tileset }), {
collection: tileset.imageryLayers, collection: renderer.globe.imagery,
kind: 'globe',
});
renderer.globe.setGlobeVisible(false);
assert.deepEqual(resolveImageryHost({ viewer, tileset }), {
collection: tileset,
kind: 'tileset', kind: 'tileset',
}); });
assert.deepEqual(resolveImageryHost({ viewer, tileset: null }), {
collection: null,
kind: 'none',
}); });
test('hidden globe without an imagery-capable tileset has no host', () => {
for (const tileset of [null, {}])
assert.deepEqual(
resolveImageryHost({
viewer: { scene: { globe: { show: false } } },
tileset,
}),
{ collection: null, kind: 'none' },
);
}); });
+19 -11
View File
@@ -1,28 +1,36 @@
/** /**
* Where draped imagery can go on the current map stack. A globe stack drapes * Where draped imagery can go on the current map stack. A globe stack drapes
* on `viewer.imageryLayers`; a 3D-tiles stack hides the globe, and Cesium * on the globe port's imagery; a 3D-tiles stack hides the globe, and the
* 1.138 drapes imagery onto the tileset's own `imageryLayers` instead. When * renderer drapes that imagery onto the shown base tileset instead. When
* neither exists there is nowhere to drape and the caller says so. * neither is drawn there is nowhere to drape and the caller says so.
*/ */
import { msg } from '../i18n/marker.js'; import { msg } from '../i18n/marker.js';
import { findGlobe } from '../render/rendererOf.js';
/** Guidance shown when the active map stack cannot host draped imagery. */ /** Guidance shown when the active map stack cannot host draped imagery. */
export const NO_IMAGERY_HOST = msg( export const NO_IMAGERY_HOST = msg(
'Hidden by this map source · choose a globe map', 'Hidden by this map source · choose a globe map',
); );
const NONE = Object.freeze({ collection: null, kind: 'none' });
/** /**
* Resolve the imagery layer collection for the active map stack. * Resolve the imagery host for the active map stack: the globe port's
* imagery while the globe is shown, else the shown base tileset (the map
* stack's `getImageryHostTileset()`), else none. `collection` names the host
* (one value per host, so a change of host is a change of it). A renderer
* that does not say whether its globe is shown (no `globeVisibility`) has it
* shown whenever no base tileset is.
* @param {{ viewer?: object, tileset?: object }} scene * @param {{ viewer?: object, tileset?: object }} scene
* @returns {{ collection: object | null, kind: 'globe' | 'tileset' | 'none' }} * @returns {{ collection: object | null, kind: 'globe' | 'tileset' | 'none' }}
*/ */
export function resolveImageryHost({ viewer, tileset } = {}) { export function resolveImageryHost({ viewer, tileset } = {}) {
if (viewer?.scene?.globe?.show === true && viewer.imageryLayers) { const globe = findGlobe(viewer);
return { collection: viewer.imageryLayers, kind: 'globe' }; const shownTileset =
} tileset && tileset.isDestroyed?.() !== true ? tileset : null;
if (tileset?.imageryLayers && !tileset.isDestroyed?.()) { const globeShown = globe?.isGlobeVisible?.() ?? (globe && !shownTileset);
return { collection: tileset.imageryLayers, kind: 'tileset' }; if (globe && globeShown) return { collection: globe.imagery, kind: 'globe' };
} if (shownTileset) return { collection: shownTileset, kind: 'tileset' };
return { collection: null, kind: 'none' }; return NONE;
} }
+41 -24
View File
@@ -1,39 +1,56 @@
import test from 'node:test'; import test from 'node:test';
import assert from 'node:assert/strict'; import assert from 'node:assert/strict';
import { NO_IMAGERY_HOST, resolveImageryHost } from './imageryHost.js'; import { NO_IMAGERY_HOST, resolveImageryHost } from './imageryHost.js';
import { bindRenderer } from '../render/rendererOf.js';
import { createStubRenderer } from '../render/stub/index.js';
test('a shown globe hosts imagery on the viewer collection', () => { /** A scene object bound to a stub renderer, its globe shown or hidden. */
const imageryLayers = { id: 'globe' }; function scene({ globeShown, capabilities } = {}) {
const host = resolveImageryHost({ const renderer = createStubRenderer(
viewer: { scene: { globe: { show: true } }, imageryLayers }, capabilities ? { capabilities } : undefined,
tileset: { imageryLayers: { id: 'tiles' } }, );
}); if (globeShown !== undefined) renderer.globe.setGlobeVisible(globeShown);
assert.deepEqual(host, { collection: imageryLayers, kind: 'globe' }); const viewer = {};
bindRenderer(viewer, renderer);
return { viewer, renderer };
}
test('a shown globe hosts imagery on the globe port', () => {
const { viewer, renderer } = scene({ globeShown: true });
const host = resolveImageryHost({ viewer, tileset: { id: 'tiles' } });
assert.deepEqual(host, { collection: renderer.globe.imagery, kind: 'globe' });
}); });
test('a hidden globe hands imagery to the tileset collection', () => { test('a hidden globe hands imagery to the shown base tileset', () => {
const imageryLayers = { id: 'tiles' }; const { viewer } = scene({ globeShown: false });
const host = resolveImageryHost({ const tileset = { id: 'tiles', isDestroyed: () => false };
viewer: { scene: { globe: { show: false } }, imageryLayers: {} }, const host = resolveImageryHost({ viewer, tileset });
tileset: { imageryLayers, isDestroyed: () => false }, assert.deepEqual(host, { collection: tileset, kind: 'tileset' });
});
test('without globe visibility, the globe hosts unless a tileset is shown', () => {
const { viewer, renderer } = scene({ capabilities: [] });
assert.equal(renderer.globe.isGlobeVisible, undefined);
const tileset = { id: 'tiles' };
assert.deepEqual(resolveImageryHost({ viewer, tileset }), {
collection: tileset,
kind: 'tileset',
});
assert.deepEqual(resolveImageryHost({ viewer, tileset: null }), {
collection: renderer.globe.imagery,
kind: 'globe',
}); });
assert.deepEqual(host, { collection: imageryLayers, kind: 'tileset' });
}); });
test('no globe and no tileset means nowhere to drape', () => { test('no globe and no tileset means nowhere to drape', () => {
assert.deepEqual( const { viewer } = scene({ globeShown: false });
resolveImageryHost({ assert.deepEqual(resolveImageryHost({ viewer, tileset: null }), {
viewer: { scene: { globe: { show: false } }, imageryLayers: {} }, collection: null,
tileset: null, kind: 'none',
}), });
{ collection: null, kind: 'none' },
);
assert.deepEqual(resolveImageryHost({}), { collection: null, kind: 'none' }); assert.deepEqual(resolveImageryHost({}), { collection: null, kind: 'none' });
assert.deepEqual( assert.deepEqual(
resolveImageryHost({ resolveImageryHost({ viewer, tileset: { isDestroyed: () => true } }),
viewer: { scene: { globe: { show: false } } },
tileset: { imageryLayers: {}, isDestroyed: () => true },
}),
{ collection: null, kind: 'none' }, { collection: null, kind: 'none' },
); );
assert.match(NO_IMAGERY_HOST, /globe map/); assert.match(NO_IMAGERY_HOST, /globe map/);
+93 -11
View File
@@ -89,9 +89,69 @@ function uncaught(error) {
}); });
} }
/** Size the stub's viewport and its canvas to `size` (CSS pixels). */
function sizeCanvas(canvas, viewport, size) {
Object.assign(viewport, size);
canvas.width = viewport.width;
canvas.height = viewport.height;
// A page's canvas measures itself; a stand-in reports the viewport.
if (!canvas.ownerDocument) {
canvas.clientWidth = viewport.width;
canvas.clientHeight = viewport.height;
}
}
/**
* The stub's canvas: in a page (`container` given), a real canvas filling
* the container, which the viewport follows; otherwise a stand-in that
* takes event listeners and measures as the viewport does.
*/
function createCanvas(container, viewport) {
const document = container?.ownerDocument;
if (document) {
const canvas = document.createElement('canvas');
canvas.style.width = '100%';
canvas.style.height = '100%';
canvas.style.display = 'block';
container.appendChild(canvas);
if (container.clientWidth > 0 && container.clientHeight > 0)
Object.assign(viewport, {
width: container.clientWidth,
height: container.clientHeight,
});
canvas.width = viewport.width;
canvas.height = viewport.height;
return canvas;
}
const canvas = /** @type {HTMLCanvasElement} */ (
/** @type {unknown} */ (
Object.assign(new EventTarget(), {
width: viewport.width,
height: viewport.height,
clientWidth: viewport.width,
clientHeight: viewport.height,
style: {},
getBoundingClientRect: () => ({
x: 0,
y: 0,
left: 0,
top: 0,
width: viewport.width,
height: viewport.height,
right: viewport.width,
bottom: viewport.height,
}),
})
)
);
return canvas;
}
/** /**
* @param {object} [options] * @param {object} [options]
* @param {Iterable<import('../contract/common').Capability>} [options.capabilities] Default: all. * @param {Iterable<import('../contract/common').Capability>} [options.capabilities] Default: all.
* @param {HTMLElement} [options.container] In a page: the element the stub's
* canvas fills, as a plugin's `CreateOptions.container`.
* @param {{width: number, height: number}} [options.viewport] CSS size; default 1280 × 720. * @param {{width: number, height: number}} [options.viewport] CSS size; default 1280 × 720.
* @param {number} [options.time] Scene time, epoch ms. * @param {number} [options.time] Scene time, epoch ms.
* @returns {import('../contract/renderer').Renderer & {testing: StubTesting}} * @returns {import('../contract/renderer').Renderer & {testing: StubTesting}}
@@ -1460,14 +1520,7 @@ export function createStubRenderer(options = {}) {
// --- Renderer -------------------------------------------------------------- // --- Renderer --------------------------------------------------------------
const canvas = /** @type {HTMLCanvasElement} */ ( const canvas = createCanvas(options.container, viewport);
/** @type {unknown} */ ({
width: viewport.width,
height: viewport.height,
clientWidth: viewport.width,
clientHeight: viewport.height,
})
);
const renderer = { const renderer = {
id: 'stub', id: 'stub',
@@ -1518,6 +1571,13 @@ export function createStubRenderer(options = {}) {
return { state: blockers.length ? 'timeout' : 'settled', blockers }; return { state: blockers.length ? 'timeout' : 'settled', blockers };
}, },
resize() { resize() {
// In a page, the stub's canvas follows its container's size.
const container = options.container;
if (container?.clientWidth > 0 && container?.clientHeight > 0)
sizeCanvas(canvas, viewport, {
width: container.clientWidth,
height: container.clientHeight,
});
requestRender('resize'); requestRender('resize');
}, },
releaseUnused() { releaseUnused() {
@@ -1540,6 +1600,7 @@ export function createStubRenderer(options = {}) {
// A flight in progress ends cancelled and gives back its input hold. // A flight in progress ends cancelled and gives back its input hold.
camera.endFlight(); camera.endFlight();
destroyed = true; destroyed = true;
if (options.container) canvas.remove?.();
for (const clear of onceTimers) clear(); for (const clear of onceTimers) clear();
onceTimers.clear(); onceTimers.clear();
sets.clear(); sets.clear();
@@ -1588,9 +1649,7 @@ export function createStubRenderer(options = {}) {
settled[kind] = value; settled[kind] = value;
}, },
setViewport(size) { setViewport(size) {
Object.assign(viewport, size); sizeCanvas(canvas, viewport, size);
canvas.width = viewport.width;
canvas.height = viewport.height;
}, },
/** /**
* Where a drawn item is drawn now (or `aheadMs` from now), ECEF, or * Where a drawn item is drawn now (or `aheadMs` from now), ECEF, or
@@ -1630,3 +1689,26 @@ export function createStubRenderer(options = {}) {
* @property {() => object} effects * @property {() => object} effects
* @property {(error: Error) => void} emitError * @property {(error: Error) => void} emitError
*/ */
/**
* The stub as a renderer plugin (`RendererPlugin`), for running the whole
* application on it: each renderer it makes fills the container it is given
* with a canvas, as any plugin's does. Nothing runs on its own: the caller
* drives the loop (`testing.tick()`), each frame or as a test needs.
* @param {Parameters<typeof createStubRenderer>[0]} [options] For each
* renderer it makes (`capabilities`, `viewport`, `time`...).
* @param {(renderer: ReturnType<typeof createStubRenderer>) => void} [onCreate]
* Hears each renderer it makes.
* @returns {import('../contract/renderer').RendererPlugin}
*/
export function createStubRendererPlugin(options = {}, onCreate) {
return Object.freeze({
id: 'stub',
async create({ container, signal }) {
signal?.throwIfAborted();
const renderer = createStubRenderer({ ...options, container });
onCreate?.(renderer);
return renderer;
},
});
}
+1 -7
View File
@@ -1,7 +1 @@
{ {}
"src/agent/worldPacket.js": 2,
"src/data/followed.js": 5,
"src/layers/vessels/lifecycle.js": 1,
"src/layers/weather/imageryHost.js": 3,
"src/maps/imageryHost.js": 4
}