From c07306450763a1e3435025f5033d72c0e518310f Mon Sep 17 00:00:00 2001 From: Sameh Khamis Date: Mon, 9 Nov 2026 14:32:50 -0800 Subject: [PATCH 1/2] Stack sprite layers by draw order, flights on top Each sprite layer's icon or dot set is now made at a draw order taken from SPRITE_LAYER_ORDER through the renderer's per-set drawOrder: flights over military, vessels, directions, transit, bikeshare, FIRMS and CCTV, whichever layer was turned on first. Picks name the topmost first. The orders are negative, so selection highlights, route endpoints, the tracked plane and every other set at the default order still draw over all sprite layers, as they did before. The raise-to-top restorer, the sprite registry and the primitive-name lookups are gone, which takes spriteOrder.js off the viewer-access list. Before, the restorer raised the layers to the bottom of the scene in the order they were enabled, so flights usually ended up under the others. --- docs/CURRENT-STATE.md | 15 +- src/app/layers/streetLevel.js | 3 +- src/data/aircraftIconLayer.js | 9 +- src/data/firmsHorizonCull.test.mjs | 2 - src/data/sharedOsmDisplays.test.mjs | 2 +- src/data/spriteOrder.js | 103 +-------- src/data/spriteOrder.test.mjs | 209 ++++++++---------- .../bikeshare/failureReporting.test.mjs | 2 +- src/layers/bikeshare/lifecycle.js | 4 - src/layers/bikeshare/rendering.js | 13 +- src/layers/bikeshare/state.js | 4 - src/layers/cctv/lifecycle.js | 8 +- src/layers/cctv/rendering.js | 8 +- src/layers/cctv/source.test.mjs | 2 +- src/layers/directions/index.js | 14 +- src/layers/firms/cells.test.mjs | 2 - src/layers/firms/lifecycle.js | 7 - src/layers/firms/rendering.js | 15 +- src/layers/flights/lifecycle.js | 7 +- src/layers/military/lifecycle.js | 6 +- src/layers/streetLevel/marker.js | 14 +- src/layers/streetLevel/marker.test.mjs | 27 +-- .../streetLevel/providers/kartaview/index.js | 1 - .../streetLevel/providers/mapillary/index.js | 1 - .../streetLevel/providers/panoramax/index.js | 1 - src/layers/streetLevel/registry.js | 2 +- src/layers/streetLevel/sequenceCones.js | 11 +- src/layers/streetLevel/state.js | 4 +- src/layers/transit/lifecycle.js | 7 +- src/layers/transit/lifecycle.test.mjs | 91 ++------ src/layers/transit/rendering.js | 25 +-- src/layers/transit/state.js | 3 - src/layers/vessels/lifecycle.js | 3 - src/layers/vessels/ownership.test.mjs | 2 +- src/layers/vessels/renderGovernor.test.mjs | 2 +- src/layers/vessels/rendering.js | 16 +- src/render/cesium/draw.js | 8 +- src/render/cesium/draw.test.mjs | 177 +++++++-------- src/render/cesium/gpuIcons.test.mjs | 2 +- src/render/viewerAccessAllowList.json | 1 - 40 files changed, 271 insertions(+), 562 deletions(-) diff --git a/docs/CURRENT-STATE.md b/docs/CURRENT-STATE.md index 7f8b07b02..898a7aacf 100644 --- a/docs/CURRENT-STATE.md +++ b/docs/CURRENT-STATE.md @@ -3395,10 +3395,13 @@ down | auth-failed` (plus the unchanged `missing-key`/`unsupported`) with > untracking, so a stationary slow press on a plane still selects it. Escape > still releases tracking in place. The 200 px feel needs close-range field > verification; fleet model sizing remains unchanged. -> - **Deterministic sprite stacking:** contact collections reassert the stable -> bottom-to-top order CCTV, FIRMS, bikeshare, AIS, military, then civilian -> flights after every relevant layer init/enable and immediately after FIRMS -> lazily registers its detection sprites. Always-visible contact +> - **Deterministic sprite stacking:** contact sets are made at draw orders +> (`SetSpec.drawOrder`, from `spriteDrawOrder`) that stack them bottom to +> top as CCTV, FIRMS, bikeshare, transit, directions, AIS, military, then +> civilian flights on top, whichever layer was turned on first; picks +> name the topmost first. The orders are negative, so every overlay at the +> default order (selection highlights, route endpoints, the tracked plane) +> still draws over all of them. Always-visible contact > depth settings are unchanged. Cesium OIT weighted blending may soften strict > alpha layering on some GPUs, so the ordering remains a real-browser check. > - **Deterministic card stacking:** CCTV, FIRMS, vessel, and tracked-target @@ -4666,8 +4669,8 @@ Playback reserves numeric scratch before the first sample, including unknown heights, and reuses caller-owned sample and segment storage. **Scene work.** Stationary and animated vehicles are two draw-port icon sets -(`transit::still` and `transit::moving`), registered by set id with the -sprite order in their old adjacent places above CCTV and Bikeshare. Each marker +(`transit::still` and `transit::moving`), made at adjacent draw orders +from the sprite order (`spriteDrawOrder`), above CCTV and Bikeshare. Each marker is a plain record (position, show, image, size, colour, rotation); a frame writes the changed ones to their set in one batched upsert, markers taken out in one task go in one removal, and a marker that starts or stops moving moves diff --git a/src/app/layers/streetLevel.js b/src/app/layers/streetLevel.js index ec0eed217..3b7c7cc0b 100644 --- a/src/app/layers/streetLevel.js +++ b/src/app/layers/streetLevel.js @@ -3,7 +3,6 @@ import { createMapillaryProvider } from '../../layers/streetLevel/providers/mapi import { createGoogleProvider } from '../../layers/streetLevel/providers/google/index.js'; import { createKartaViewProvider } from '../../layers/streetLevel/providers/kartaview/index.js'; import { createPanoramaxProvider } from '../../layers/streetLevel/providers/panoramax/index.js'; -import * as sprites from '../../data/spriteOrder.js'; import * as picking from '../../data/pickRegistry.js'; import * as scenePick from '../../data/scenePick.js'; import * as render from '../../renderGovernor.js'; @@ -36,6 +35,6 @@ export function createApplicationStreetLevel({ }) { return createStreetLevelLayer({ providers, - services: { sprites, picking, scenePick, render }, + services: { picking, scenePick, render }, }); } diff --git a/src/data/aircraftIconLayer.js b/src/data/aircraftIconLayer.js index 571b4ff4b..3dc8cfcdf 100644 --- a/src/data/aircraftIconLayer.js +++ b/src/data/aircraftIconLayer.js @@ -259,17 +259,18 @@ export function createAircraftIcons({ /** * Create the draw set for one layer lifetime, drawn over depth and culled - * at the horizon on the delayed live clock. - * @returns {string} The set's id, for the sprite order. + * at the horizon on the delayed live clock, stacked by the sprite order. + * @returns {string} The set's id. */ function _createIcons(viewer) { const set = drawOf(viewer).icons({ id: `${layerId}-icons:${++instances}`, horizonCull: true, motionClock: { kind: 'live', delayMs }, + drawOrder: services.sprites?.spriteDrawOrder?.(layerId) ?? 0, }); - // Columns of no rows put the set's host in the scene now, where the - // sprite order finds it, rather than with its first contact. + // Columns of no rows put the set's host in the scene now, rather than + // with its first contact. set.setColumns?.({ ids: [] }); switchPx = _imageSwitchPx(viewer); state._icons = createContactIcons(set, { diff --git a/src/data/firmsHorizonCull.test.mjs b/src/data/firmsHorizonCull.test.mjs index 1202571ef..0822ba66a 100644 --- a/src/data/firmsHorizonCull.test.mjs +++ b/src/data/firmsHorizonCull.test.mjs @@ -9,7 +9,6 @@ import { reportMeshFloorCell, setMeshFloorPreferred, } from './groundFloor.js'; -import { unregisterSpriteCollection } from './spriteOrder.js'; import { isOverlayPointVisible, normalizeOverlayEntry } from '../overlays/worldOverlay.js'; import { createIconSet, ICON_CULL_LIFT } from './iconSet.js'; import { writeHoldSegment } from './iconSegment.js'; @@ -426,7 +425,6 @@ function createHarness(rawFires) { }, cleanup() { layer.destroy(viewer); - unregisterSpriteCollection('firms'); Cesium.SceneTransforms.worldToWindowCoordinates = originalProject; globalThis.fetch = originalFetch; if (originalWindow === undefined) delete globalThis.window; else globalThis.window = originalWindow; diff --git a/src/data/sharedOsmDisplays.test.mjs b/src/data/sharedOsmDisplays.test.mjs index da472899f..a5e6ec72f 100644 --- a/src/data/sharedOsmDisplays.test.mjs +++ b/src/data/sharedOsmDisplays.test.mjs @@ -80,7 +80,7 @@ test('Directions introduces the shared OSM credit when the requested route draws credits: { showOsmCredit, hideOsmCredit }, input, camera: {}, overlays: { setOverlayEntries: noop, setOverlaySourceVisible: noop, clearOverlaySource: noop }, render: { governorRequestRender: noop, holdContinuousRender: noop, releaseContinuousRender: noop }, - sprites: { registerSpriteCollection: noop, unregisterSpriteCollection: noop, restoreSpriteOrder: noop }, + sprites: {}, picking: { registerPickOwner: noop, unregisterPickOwner: noop }, ground: { warmGroundFloor: noop, resolveGroundFloorCells: async () => {} }, } }); diff --git a/src/data/spriteOrder.js b/src/data/spriteOrder.js index d0193cb9f..fd84921bb 100644 --- a/src/data/spriteOrder.js +++ b/src/data/spriteOrder.js @@ -1,4 +1,4 @@ -/** Bottom-to-top order for near-plane-clamped contact sprite collections. */ +/** Bottom-to-top order of the sprite layers' icon and dot sets. */ export const SPRITE_LAYER_ORDER = Object.freeze([ 'cctv', 'firms', @@ -11,97 +11,18 @@ export const SPRITE_LAYER_ORDER = Object.freeze([ 'flights', ]); -/** @type {Map} */ -const _collections = new Map(); - /** - * Register the current primitive collection for a sprite layer. + * The draw order (`SetSpec.drawOrder`) a sprite layer's set is made with: + * its place in `SPRITE_LAYER_ORDER`, counted back from -1 for flights, so + * flights draw over every other sprite layer and the rest follow the list, + * whichever layer was turned on first. Every set at the default order, 0 + * (selection highlights, route endpoints, the tracked plane and the other + * overlays), stays over all of them, as it did when the sprite sets were + * raised to the bottom of the scene. A key not in the list gets 0. * @param {string} layerId - Stable sprite-order layer key. - * @param {Object} collection - Cesium billboard/point primitive collection. - * @returns {void} + * @returns {number} */ -export function registerSpriteCollection(layerId, collection) { - if (!layerId || !collection) return; - _collections.set(layerId, collection); -} - -/** - * Register a renderer draw set for a sprite layer, by its set id. The - * default renderer names each set's host primitive with `drawSetId`; the - * restorer raises the host it finds under that name, whichever host the - * set draws with now. - * @param {string} layerId - Stable sprite-order layer key. - * @param {string} setId - The draw set's id. - * @returns {object} The registration, for `unregisterSpriteCollection`'s guard. - */ -export function registerSpriteSet(layerId, setId) { - const entry = Object.freeze({ drawSetId: setId }); - if (layerId && typeof setId === 'string') _collections.set(layerId, entry); - return entry; -} - -/** - * The primitive `entry` names: itself, or a draw set's host found by its id. - * The topmost match wins, so a host still retiring below its replacement is - * skipped. - */ -function resolveSprite(primitives, entry) { - if (typeof entry?.drawSetId !== 'string') return entry; - for (let i = (primitives.length ?? 0) - 1; i >= 0; i--) { - const primitive = primitives.get(i); - if (primitive?.drawSetId === entry.drawSetId) return primitive; - } - return null; -} - -/** - * Remove a registered collection (primarily useful to lifecycle tests). - * @param {string} layerId - Stable sprite-order layer key. - * @param {Object} [collection] - Optional identity guard against stale teardown. - * @returns {void} - */ -export function unregisterSpriteCollection(layerId, collection) { - if (collection && _collections.get(layerId) !== collection) return; - _collections.delete(layerId); -} - -/** - * Reassert deterministic sprite stacking after any layer enable/init. - * Cesium's stable translucent sort otherwise preserves first-enable primitive - * order. Raising bottom-to-top makes flights the final/top collection. - * @param {Cesium.Viewer|Object} viewer - Active viewer. - * @returns {void} - */ -export function restoreSpriteOrder(viewer) { - if (!viewer || viewer.isDestroyed?.()) return; - const scene = viewer.scene; - const primitives = scene?.primitives; - if (!primitives || scene.isDestroyed?.() || primitives.isDestroyed?.()) - return; - - for (const layerId of SPRITE_LAYER_ORDER) { - const collection = resolveSprite(primitives, _collections.get(layerId)); - if (!collection || collection.isDestroyed?.()) continue; - if (primitives.contains?.(collection) === false) continue; - primitives.raiseToTop(collection); - } -} - -/** - * Explicit layer-enable wiring seam. Production callers use the shared - * restorer by default; tests inject a spy to pin each enable path without - * constructing a WebGL viewer. - * @param {string} layerId - Sprite layer whose enable path is restoring order. - * @param {Cesium.Viewer|Object} viewer - Active viewer. - * @param {(viewer: Object) => void} [restore=restoreSpriteOrder] - Test seam. - * @returns {void} - */ -export function restoreSpriteOrderOnEnable( - layerId, - viewer, - restore = restoreSpriteOrder, -) { - if (!SPRITE_LAYER_ORDER.includes(layerId) || typeof restore !== 'function') - return; - restore(viewer); +export function spriteDrawOrder(layerId) { + const index = SPRITE_LAYER_ORDER.indexOf(layerId); + return index < 0 ? 0 : index - SPRITE_LAYER_ORDER.length; } diff --git a/src/data/spriteOrder.test.mjs b/src/data/spriteOrder.test.mjs index 74453d93c..da4ed6511 100644 --- a/src/data/spriteOrder.test.mjs +++ b/src/data/spriteOrder.test.mjs @@ -1,121 +1,98 @@ -import { createRendering as createFirmsRendering } from '../layers/firms/rendering.js'; import test from 'node:test'; import assert from 'node:assert/strict'; -import { - registerSpriteCollection, - restoreSpriteOrder, - restoreSpriteOrderOnEnable, - unregisterSpriteCollection, -} from './spriteOrder.js'; -import flightsLayer from './flights.js'; -import aisLiveVesselsLayer from './aisLiveVessels.js'; -import { createFirmsHeatmapLayer } from './firmsHeatmap.js'; +import * as sprites from './spriteOrder.js'; +import { SPRITE_LAYER_ORDER, spriteDrawOrder } from './spriteOrder.js'; +import { createAircraftIcons } from './aircraftIconLayer.js'; +import { createRendering as createBikeshareRendering } from '../layers/bikeshare/rendering.js'; +import { createRendering as createCctvRendering } from '../layers/cctv/rendering.js'; +import { createRendering as createFirmsRendering } from '../layers/firms/rendering.js'; +import { bindFakeDraw } from '../testSupport/fakeDrawPort.mjs'; -const ORDER = ['cctv', 'firms', 'bikeshare', 'ais', 'military', 'flights']; - -function makePrimitives(initial = []) { - return { - items: [...initial], - calls: [], - contains(collection) { return this.items.includes(collection); }, - raiseToTop(collection) { - this.calls.push(collection.id); - const index = this.items.indexOf(collection); - if (index >= 0) this.items.splice(index, 1); - this.items.push(collection); - }, - }; -} - -function makeCollection(id, destroyed = false) { - return { id, isDestroyed: () => destroyed }; -} - -test('restoreSpriteOrder raises live collections bottom-to-top and skips destroyed entries', () => { - const collections = Object.fromEntries(ORDER.map((id) => [id, makeCollection(id)])); - const destroyedFirms = makeCollection('firms', true); - for (const id of ORDER) { - registerSpriteCollection(id, id === 'firms' ? destroyedFirms : collections[id]); - } - const primitives = makePrimitives([ - collections.flights, - collections.ais, - collections.cctv, - collections.bikeshare, - collections.military, - ]); - - restoreSpriteOrder({ scene: { primitives } }); - - assert.deepEqual(primitives.calls, ['cctv', 'bikeshare', 'ais', 'military', 'flights']); - assert.deepEqual(primitives.items.map((item) => item.id), [ - 'cctv', 'bikeshare', 'ais', 'military', 'flights', - ]); - - for (const id of ORDER) unregisterSpriteCollection(id); -}); - -test('late CCTV registration still restores flights above the ambient collection', () => { - const flights = makeCollection('flights'); - const cctv = makeCollection('cctv'); - const primitives = makePrimitives([flights]); - const viewer = { scene: { primitives } }; - - registerSpriteCollection('flights', flights); - restoreSpriteOrder(viewer); - primitives.items.push(cctv); // CCTV enabled after flights: it starts on top. - registerSpriteCollection('cctv', cctv); - primitives.calls.length = 0; - - restoreSpriteOrder(viewer); - - assert.deepEqual(primitives.calls, ['cctv', 'flights']); - assert.deepEqual(primitives.items.map((item) => item.id), ['cctv', 'flights']); - - unregisterSpriteCollection('cctv', cctv); - unregisterSpriteCollection('flights', flights); -}); - -test('restoreSpriteOrder is inert for destroyed viewers and primitive collections', () => { - const flights = makeCollection('flights'); - const primitives = makePrimitives([flights]); - registerSpriteCollection('flights', flights); - - restoreSpriteOrder({ isDestroyed: () => true, scene: { primitives } }); - restoreSpriteOrder({ scene: { primitives: { ...primitives, isDestroyed: () => true } } }); - - assert.deepEqual(primitives.calls, []); - unregisterSpriteCollection('flights', flights); -}); - -test('restoreSpriteOrder never raises a registered collection absent from scene primitives', () => { - const flights = makeCollection('flights'); - const primitives = makePrimitives([]); - registerSpriteCollection('flights', flights); - - restoreSpriteOrder({ scene: { primitives } }); - - assert.deepEqual(primitives.calls, []); - assert.deepEqual(primitives.items, []); - unregisterSpriteCollection('flights', flights); -}); - -test('flights, AIS, and FIRMS enable paths are wired through the shared sprite restorer', () => { - const viewer = { id: 'viewer' }; - const calls = []; - const restoreSpy = (value) => calls.push(value); - for (const layerId of ['flights', 'ais', 'firms']) { - restoreSpriteOrderOnEnable(layerId, viewer, restoreSpy); - } - assert.deepEqual(calls, [viewer, viewer, viewer]); - - const firmsLayer = createFirmsHeatmapLayer({ id: 'firms', name: 'FIRMS' }); - assert.match(flightsLayer.enable.toString(), /restoreSpriteOrderOnEnable\('flights', viewer\)/); - assert.match(aisLiveVesselsLayer.enable.toString(), /restoreSpriteOrderOnEnable\('ais', activeViewer\)/); - assert.match(firmsLayer.enable.toString(), /restoreSpriteOrderOnEnable\('firms', viewer\)/); - assert.match( - createFirmsRendering.toString(), - /spriteEntry = registerSpriteSet\('firms', set\.id\);\s*restoreSpriteOrder\(layerState\._viewer\);/, - 'lazy FIRMS registration must restore order immediately', +test('each sprite layer draws at its place in the order, flights on top', () => { + assert.deepEqual( + SPRITE_LAYER_ORDER.map(spriteDrawOrder), + SPRITE_LAYER_ORDER.map((_, i) => i - SPRITE_LAYER_ORDER.length), ); + assert.equal( + Math.max(...SPRITE_LAYER_ORDER.map(spriteDrawOrder)), + spriteDrawOrder('flights'), + ); + assert.ok(spriteDrawOrder('military') > spriteDrawOrder('ais')); + assert.ok(spriteDrawOrder('ais') > spriteDrawOrder('transit')); + assert.ok(spriteDrawOrder('transit') > spriteDrawOrder('cctv')); + // Any other layer stays at the default, over every sprite layer. + assert.equal(spriteDrawOrder('flights'), -1); + assert.equal(spriteDrawOrder('street-level:marker'), 0); + assert.equal(spriteDrawOrder(undefined), 0); +}); + +/** A viewer double with a fake draw port, unbound after the test. */ +function drawnViewer(t) { + const viewer = {}; + const { draw, unbind } = bindFakeDraw(viewer); + t.after(unbind); + return { viewer, draw }; +} + +test('flights and military make their icon sets at their draw orders', (t) => { + const { viewer, draw } = drawnViewer(t); + for (const layerId of ['flights', 'military']) { + const icons = createAircraftIcons({ + state: {}, + services: { focus: { focusPassIsNeeded: () => false }, sprites }, + parts: {}, + layerId, + renderDelaySec: 0, + courseMaxDps: 1, + cockpitContactSizePx: 4, + }); + const id = icons._createIcons(viewer); + assert.equal(draw.set(id).spec.drawOrder, spriteDrawOrder(layerId)); + icons._disposeIcons(); + } +}); + +test('CCTV, FIRMS and bikeshare make their sprite sets at their draw orders', (t) => { + const { viewer, draw } = drawnViewer(t); + const cctv = createCctvRendering({ + state: {}, + services: { focus: {}, sprites }, + parts: {}, + source: {}, + }); + const cctvId = cctv.createCameraIcons(viewer); + assert.equal(draw.set(cctvId).spec.drawOrder, spriteDrawOrder('cctv')); + cctv.destroyCameraIcons(); + + const layerState = { _viewer: viewer, _enabled: true }; + const firms = createFirmsRendering({ + layerState, + services: { anchors: {}, sprites }, + components: {}, + config: { + overlayHost: { setVisible() {}, clearSource() {} }, + }, + }); + firms.ensureDetectionCollections(); + assert.equal( + draw.set(layerState._icons.id).spec.drawOrder, + spriteDrawOrder('firms'), + ); + firms.removeDetectionCollections(); + + const bikeState = {}; + const bikeshare = createBikeshareRendering({ + state: bikeState, + services: { render: {}, sprites }, + parts: {}, + source: {}, + }); + bikeshare.attachSets(viewer); + assert.equal( + draw.set(bikeState._stationSet.id).spec.drawOrder, + spriteDrawOrder('bikeshare'), + ); + // The selected station's highlight is not a sprite layer. + assert.equal(draw.set(bikeState._selectedSet.id).spec.drawOrder, undefined); + bikeshare.detachSets(); }); diff --git a/src/layers/bikeshare/failureReporting.test.mjs b/src/layers/bikeshare/failureReporting.test.mjs index bb4c81530..73c3e7d4a 100644 --- a/src/layers/bikeshare/failureReporting.test.mjs +++ b/src/layers/bikeshare/failureReporting.test.mjs @@ -176,7 +176,7 @@ function makeLiveLayer() { setOverlaySourceVisible() {}, clearOverlaySource() {}, }, - sprites: { registerSpriteCollection() {}, restoreSpriteOrder() {} }, + sprites: {}, picking: { registerPickOwner() {}, unregisterPickOwner() {} }, }; const state = createState({ services }); diff --git a/src/layers/bikeshare/lifecycle.js b/src/layers/bikeshare/lifecycle.js index 2da7ee865..6c623c820 100644 --- a/src/layers/bikeshare/lifecycle.js +++ b/src/layers/bikeshare/lifecycle.js @@ -11,7 +11,6 @@ export function createLifecycle({ parts, source, }) { - const { restoreSpriteOrder } = services.sprites; const { registerPickOwner, unregisterPickOwner } = services.picking; /** Stop listening to the camera, if the layer is. */ @@ -62,8 +61,6 @@ export function createLifecycle({ parts.selection._installClickHandler(viewer); - restoreSpriteOrder(viewer); - console.log( `[Data:Bikeshare] Initialized with ${GBFS_CITY_REGISTRY.length} cities`, ); @@ -98,7 +95,6 @@ export function createLifecycle({ } void parts.viewport.runProximityCheck(); - restoreSpriteOrder(viewer); }, /** diff --git a/src/layers/bikeshare/rendering.js b/src/layers/bikeshare/rendering.js index 8135c1df9..e0f29fb75 100644 --- a/src/layers/bikeshare/rendering.js +++ b/src/layers/bikeshare/rendering.js @@ -48,27 +48,18 @@ export function createRendering({ id: `${prefix}:stations`, blend: 'translucent', show: false, + drawOrder: services.sprites?.spriteDrawOrder?.('bikeshare') ?? 0, }); layerState._selectedSet = draw.points({ id: `${prefix}:selected` }); // Drawn from the start, empty, so both take their place in the scene // now, as the layer's collections did; the stations' place among the - // other sprite layers is the sprite order's (`restoreSpriteOrder`). + // other sprite layers is their draw order (`spriteDrawOrder`). layerState._stationSet.set([]); layerState._selectedSet.set([]); - layerState._spriteEntry = services.sprites?.registerSpriteSet?.( - 'bikeshare', - layerState._stationSet.id, - ); } /** Let the layer's draw sets go. */ function detachSets() { - if (layerState._spriteEntry) - services.sprites?.unregisterSpriteCollection?.( - 'bikeshare', - layerState._spriteEntry, - ); - layerState._spriteEntry = null; layerState._stationSet?.dispose(); layerState._selectedSet?.dispose(); layerState._stationSet = null; diff --git a/src/layers/bikeshare/state.js b/src/layers/bikeshare/state.js index 0b7ab7e9d..df3720483 100644 --- a/src/layers/bikeshare/state.js +++ b/src/layers/bikeshare/state.js @@ -27,10 +27,6 @@ export function createState({ services }) { layerState._selectedSet = null; - /** The station set's sprite-order registration, while it has one. */ - - layerState._spriteEntry = null; - /** Whether the bikeshare layer is currently enabled. */ layerState._enabled = false; diff --git a/src/layers/cctv/lifecycle.js b/src/layers/cctv/lifecycle.js index 1f50a3e94..27fd60656 100644 --- a/src/layers/cctv/lifecycle.js +++ b/src/layers/cctv/lifecycle.js @@ -22,7 +22,6 @@ export function createLifecycle({ parts, source, }) { - const { registerSpriteSet, restoreSpriteOrder } = services.sprites; const { activateCctvCameraFromWorldClick } = services.activation; const { resolvePickId, registerPickOwner, unregisterPickOwner } = services.picking; @@ -205,10 +204,7 @@ export function createLifecycle({ layerState._lastViewContext = ''; layerState._calibrationById = parts.calibration.loadCalibrationStore(); - // A host without the sprite order still draws the icons, in the - // order they were added. - const iconSetId = parts.rendering.createCameraIcons(layerState._viewer); - registerSpriteSet?.('cctv', iconSetId); + parts.rendering.createCameraIcons(layerState._viewer); const sources = await parts.catalog.loadCameraSources(); const catalogFromSources = parts.catalog.buildCatalogFromSources(sources); @@ -457,7 +453,6 @@ export function createLifecycle({ } parts.rendering.refreshCoverageStyles(); parts.presentation.notifyListeners(); - restoreSpriteOrder(layerState._viewer); console.log('[Data:CCTV] Initialized with', layerState._count, 'cameras'); }, @@ -519,7 +514,6 @@ export function createLifecycle({ parts.cards.startCardFrameLoop(); parts.cards.refreshAmbientCards(); parts.presentation.notifyListeners(); - restoreSpriteOrder(layerState._viewer); }, /** Disables the layer: hides entities, stops the projection loop and load queue. */ diff --git a/src/layers/cctv/rendering.js b/src/layers/cctv/rendering.js index bb86d7039..a737c1aa1 100644 --- a/src/layers/cctv/rendering.js +++ b/src/layers/cctv/rendering.js @@ -118,8 +118,9 @@ export function createRendering({ * far-LOD Google-3D mesh sits above the true ground and swallowed * ground-anchored icons); the set culls the far side of the globe and * refreshHorizonCulling thins the rest. + * The set stacks under the other sprite layers (`spriteDrawOrder`). * @param {object} viewer The layer's viewer. - * @returns {string} The icon set's id, for the sprite order. + * @returns {string} The icon set's id. */ function createCameraIcons(viewer) { // A re-init against a new viewer replaces the icons; the old ones go. @@ -127,9 +128,10 @@ export function createRendering({ const set = drawOf(viewer).icons({ id: `cctv:${++iconSets}:icons`, horizonCull: true, + drawOrder: services.sprites?.spriteDrawOrder?.('cctv') ?? 0, }); - // Columns of no rows put the set's host in the scene now, where the - // sprite order finds it, rather than with its first camera. + // Columns of no rows put the set's host in the scene now, rather than + // with its first camera. set.setColumns?.({ ids: [] }); layerState._icons = createIconBook(set); return set.id; diff --git a/src/layers/cctv/source.test.mjs b/src/layers/cctv/source.test.mjs index cd5540ccb..597143e85 100644 --- a/src/layers/cctv/source.test.mjs +++ b/src/layers/cctv/source.test.mjs @@ -111,7 +111,7 @@ test('camera construction is inert and destruction cancels a pending catalog and setOverlayEntries: noop, setOverlaySourceVisible: noop, }, - sprites: { registerSpriteSet: noop }, + sprites: {}, activation: {}, locations: {}, picking: { unregisterPickOwner: noop }, diff --git a/src/layers/directions/index.js b/src/layers/directions/index.js index 556d44433..cbc0743c3 100644 --- a/src/layers/directions/index.js +++ b/src/layers/directions/index.js @@ -957,8 +957,6 @@ export function createDirectionsLayer({ services, source }) { * @type {{markers: object, steps: object, route: object}|null} */ let _sets = null; - /** The registration of the dots in the shared sprite order. */ - let _spriteEntry = null; /** Whether a route is drawn. */ let _routeDrawn = false; /** @@ -1002,9 +1000,6 @@ export function createDirectionsLayer({ services, source }) { /** Let the layer's draw sets go. */ function detachSets() { - if (_spriteEntry) - services.sprites.unregisterSpriteCollection?.('directions', _spriteEntry); - _spriteEntry = null; if (!_sets) return; for (const set of Object.values(_sets)) set.dispose(); _sets = null; @@ -1275,7 +1270,6 @@ export function createDirectionsLayer({ services, source }) { _anchorStartedAt = Date.now(); anchorStepPoints(); syncRenderHold(); - services.sprites.restoreSpriteOrder(_viewer); services.render.governorRequestRender('directions-route'); } @@ -1719,16 +1713,14 @@ export function createDirectionsLayer({ services, source }) { id: `${prefix}:steps`, blend: 'translucent', show: false, + drawOrder: services.sprites.spriteDrawOrder?.('directions') ?? 0, }), route: draw.lines({ id: `${prefix}:route` }), }; // Drawn from the start, empty, so the dots take their place in the // scene now, as their collection did; their place among the other - // sprite layers is the sprite order's. + // sprite layers is their draw order. _sets.steps.set([]); - _spriteEntry = - services.sprites.registerSpriteSet?.('directions', _sets.steps.id) ?? - null; _enabled = false; _mode = DEFAULT_DIRECTIONS_MODE; disarm(); @@ -1740,7 +1732,6 @@ export function createDirectionsLayer({ services, source }) { _flightStep = null; _overlayHost.setVisible(DIRECTIONS_STEP_OVERLAY_SOURCE_ID, false); _overlayHost.setVisible(DIRECTIONS_MARKER_OVERLAY_SOURCE_ID, false); - services.sprites.restoreSpriteOrder(viewer); console.log('[Data:Directions] Initialized'); }, @@ -1761,7 +1752,6 @@ export function createDirectionsLayer({ services, source }) { typeof pickedId === 'string' && pickedId.startsWith('directions:'), ); syncRenderHold(); - services.sprites.restoreSpriteOrder(viewer); }, /** diff --git a/src/layers/firms/cells.test.mjs b/src/layers/firms/cells.test.mjs index c72b00a06..862a07983 100644 --- a/src/layers/firms/cells.test.mjs +++ b/src/layers/firms/cells.test.mjs @@ -2,7 +2,6 @@ import assert from 'node:assert/strict'; import test from 'node:test'; import * as Cesium from 'cesium'; import { createFirmsHeatmapLayer } from '../../data/firmsHeatmap.js'; -import { unregisterSpriteCollection } from '../../data/spriteOrder.js'; import { fakeInput } from '../../input/testDoubles.mjs'; import { bindRenderer } from '../../render/rendererOf.js'; import { bindFakeCesiumScene } from '../../testSupport/fakeCesiumScene.mjs'; @@ -110,7 +109,6 @@ function harness(fires, heightM, { sceneFromViewer = false } = {}) { cells, cleanup() { layer.destroy(viewer); - unregisterSpriteCollection('firms'); input.destroy(); Cesium.SceneTransforms.worldToWindowCoordinates = saved.project; for (const key of ['window', 'document']) diff --git a/src/layers/firms/lifecycle.js b/src/layers/firms/lifecycle.js index 5e0e5dc50..6b9fef51a 100644 --- a/src/layers/firms/lifecycle.js +++ b/src/layers/firms/lifecycle.js @@ -16,7 +16,6 @@ export function createLifecycle({ feed, }) { const { registerPickOwner, unregisterPickOwner } = services.picking; - const { restoreSpriteOrderOnEnable } = services.sprites; const { clearSelectedEntityContextForLayer } = services.context; const { id, overlayHost } = config; @@ -49,12 +48,6 @@ export function createLifecycle({ ); if (!layerState._fires.length && !layerState._loading) await components.ingestion.loadHeatmap(); - if ( - layerState._enabled && - !layerState._destroyed && - layerState._viewer === viewer - ) - restoreSpriteOrderOnEnable('firms', viewer); }, disable() { diff --git a/src/layers/firms/rendering.js b/src/layers/firms/rendering.js index 85d291b3c..6adf08dd7 100644 --- a/src/layers/firms/rendering.js +++ b/src/layers/firms/rendering.js @@ -14,8 +14,7 @@ export function createRendering({ feed, }) { const { warmFireAnchorFloors } = services.anchors; - const { registerSpriteSet, unregisterSpriteCollection, restoreSpriteOrder } = - services.sprites; + const { spriteDrawOrder } = services.sprites; const { overlayHost } = config; /** @@ -340,22 +339,18 @@ export function createRendering({ }; } - /** The sprite order's entry for the glow set. */ - let spriteEntry = null; - function ensureDetectionCollections() { if (!layerState._viewer || layerState._icons) return; const set = drawOf(layerState._viewer).icons({ id: `firms:${++iconSets}:icons`, horizonCull: true, show: layerState._enabled, + drawOrder: spriteDrawOrder?.('firms') ?? 0, }); - // Columns of no rows put the set's host in the scene now, where the - // sprite order finds it, rather than with its first fire. + // Columns of no rows put the set's host in the scene now, rather than + // with its first fire. set.setColumns?.({ ids: [] }); layerState._icons = set; - spriteEntry = registerSpriteSet('firms', set.id); - restoreSpriteOrder(layerState._viewer); overlayHost.setVisible(FIRMS_OVERLAY_SOURCE_ID, layerState._enabled); } @@ -364,8 +359,6 @@ export function createRendering({ * renderer takes it out of the scene it draws in. */ function removeDetectionCollections() { - if (spriteEntry) unregisterSpriteCollection('firms', spriteEntry); - spriteEntry = null; layerState._icons?.dispose(); layerState._icons = null; drawnGlows.clear(); diff --git a/src/layers/flights/lifecycle.js b/src/layers/flights/lifecycle.js index 2d78342d8..6ddbde359 100644 --- a/src/layers/flights/lifecycle.js +++ b/src/layers/flights/lifecycle.js @@ -9,8 +9,6 @@ export function createLifecycle({ resolveAsset, }) { const { clearFocusTarget } = services.focus; - const { registerSpriteSet, restoreSpriteOrder, restoreSpriteOrderOnEnable } = - services.sprites; const { onMilitaryLayerActiveChange } = services.militaryRegistry; const { holdContinuousRender, releaseContinuousRender } = services.render; const { ensureGeoidReady } = services.geoid; @@ -45,7 +43,7 @@ export function createLifecycle({ clearFocusTarget('flights'); flightState._focusEvidenceIds.clear(); flightState._viewer = viewer; - registerSpriteSet('flights', parts.icons._createIcons(viewer)); + parts.icons._createIcons(viewer); // The models' draw sets; a hidden item keeps the tracked asset loaded so // the tracked plane's model draws as soon as it is wanted. parts.rendering._createModelSets(viewer, { @@ -98,8 +96,6 @@ export function createLifecycle({ ); } - restoreSpriteOrder(viewer); - console.log('[Data:Flights] Initialized with GPU icons'); }, @@ -152,7 +148,6 @@ export function createLifecycle({ flightState._lastFleetTickMs = 0; }); } - restoreSpriteOrderOnEnable('flights', viewer); }, /** diff --git a/src/layers/military/lifecycle.js b/src/layers/military/lifecycle.js index 7b0136ea4..10ada46be 100644 --- a/src/layers/military/lifecycle.js +++ b/src/layers/military/lifecycle.js @@ -9,7 +9,6 @@ export function createLifecycle({ resolveAsset, }) { const { clearFocusTarget } = services.focus; - const { registerSpriteSet, restoreSpriteOrder } = services.sprites; const { holdContinuousRender, releaseContinuousRender } = services.render; const { ensureGeoidReady } = services.geoid; const { registerPickOwner, unregisterPickOwner } = services.picking; @@ -42,7 +41,7 @@ export function createLifecycle({ flightState.lifetime = new AbortController(); clearFocusTarget('militaryFlights'); flightState._viewer = viewer; - registerSpriteSet('military', parts.icons._createIcons(viewer)); + parts.icons._createIcons(viewer); // The models' draw sets; a hidden item keeps the tracked asset loaded so // the tracked plane's model draws as soon as it is wanted. parts.rendering._createModelSets(viewer, { @@ -78,8 +77,6 @@ export function createLifecycle({ parts.tracking._installClickHandler(viewer); - restoreSpriteOrder(viewer); - console.log('[Data:Military] Initialized with GPU icons'); }, @@ -134,7 +131,6 @@ export function createLifecycle({ flightState._lastFleetTickMs = 0; }); } - restoreSpriteOrder(viewer); }, /** diff --git a/src/layers/streetLevel/marker.js b/src/layers/streetLevel/marker.js index 319a24bfc..e2321041c 100644 --- a/src/layers/streetLevel/marker.js +++ b/src/layers/streetLevel/marker.js @@ -4,7 +4,7 @@ import { createHorizonCull } from './view.js'; import { fromDegrees } from '../../geo/ellipsoid.js'; import { drawOf } from '../../render/rendererOf.js'; -const SPRITE_ID = 'street-level:marker'; +const SET_ID = 'street-level:marker'; /** Draw-set ids of the markers made so far, so every layer instance has its own. */ let markerSets = 0; @@ -45,7 +45,7 @@ function markerIcon(position, bearing, look) { /** On-globe marker for the open image, clamped to the ground. */ export function createMarker({ state }) { - const { render, sprites } = state.services; + const { render } = state.services; function requestRender() { render?.governorRequestRender?.('street-level-marker'); @@ -69,13 +69,11 @@ export function createMarker({ state }) { function ensure(viewer) { if (state.marker.set) return; state.marker.set = drawOf(viewer).icons({ - id: `${SPRITE_ID}:${++markerSets}`, + id: `${SET_ID}:${++markerSets}`, }); - // Drawn from now, empty: the marker keeps its place under the cones - // (made after it), whichever is first given something to draw. + // Drawn from now, empty: the marker keeps its place by when it was made + // (before the cones), whichever is first given something to draw. state.marker.set.set([]); - state.marker.sprite = - sprites?.registerSpriteSet?.(SPRITE_ID, state.marker.set.id) ?? null; } /** Move (or create) the marker; null removes it. `style`: the provider's `marker`. */ @@ -112,10 +110,8 @@ export function createMarker({ state }) { horizon.stop(); const markers = state.marker.set; if (!markers) return; - sprites?.unregisterSpriteCollection?.(SPRITE_ID, state.marker.sprite); markers.dispose(); state.marker.set = null; - state.marker.sprite = null; state.marker.placed = null; } diff --git a/src/layers/streetLevel/marker.test.mjs b/src/layers/streetLevel/marker.test.mjs index 8667e9ae5..9917046b0 100644 --- a/src/layers/streetLevel/marker.test.mjs +++ b/src/layers/streetLevel/marker.test.mjs @@ -27,23 +27,10 @@ function setup() { }; const draw = fakeDrawPort(); bindRenderer(viewer, streetPorts(viewer, { camera: true, draw })); - /** Sprite-order registrations: setId → the entry handed out. */ - const sprites = new Map(); const state = { - services: { - sprites: { - registerSpriteSet(layerId, setId) { - const entry = { layerId, setId }; - sprites.set(setId, entry); - return entry; - }, - unregisterSpriteCollection(layerId, entry) { - if (sprites.get(entry?.setId) === entry) sprites.delete(entry.setId); - }, - }, - }, + services: {}, viewer, - marker: { set: null, sprite: null, placed: null, look: null }, + marker: { set: null, placed: null, look: null }, }; const marker = createMarker({ state }); marker.ensure(viewer); @@ -52,7 +39,7 @@ function setup() { }; /** The marker's drawn icon, or undefined. */ const icon = () => draw.find('street-level:marker:')?.items.get('sl:pos'); - return { state, viewer, view, preRender, marker, frame, draw, icon, sprites }; + return { state, viewer, view, preRender, marker, frame, draw, icon }; } test('the photo marker is hidden behind the globe, and shows from its side', () => { @@ -138,16 +125,14 @@ test('each placement is one write, culled before it is sent', () => { assert.equal(set.writes, before + 2); }); -test('a marker destroyed and made again draws in a new set, registered once', () => { - const { marker, viewer, draw, sprites, icon } = setup(); +test('a marker destroyed and made again draws in a new set', () => { + const { marker, viewer, draw, icon } = setup(); const first = draw.find('street-level:marker:').spec.id; - assert.deepEqual([...sprites.keys()], [first]); marker.destroy(); - assert.equal(sprites.size, 0, 'its sprite order entry goes with it'); + assert.equal(draw.set(first), undefined, 'its set goes with it'); marker.ensure(viewer); const second = draw.find('street-level:marker:').spec.id; assert.notEqual(second, first); - assert.deepEqual([...sprites.keys()], [second]); marker.set(SPOT, 30); assert.equal(icon().course, 30); }); diff --git a/src/layers/streetLevel/providers/kartaview/index.js b/src/layers/streetLevel/providers/kartaview/index.js index 134a45e86..fd0d56348 100644 --- a/src/layers/streetLevel/providers/kartaview/index.js +++ b/src/layers/streetLevel/providers/kartaview/index.js @@ -100,7 +100,6 @@ export function createKartaViewProvider({ selectedId: null, images: [], set: null, - sprite: null, loading: false, error: null, abort: null, diff --git a/src/layers/streetLevel/providers/mapillary/index.js b/src/layers/streetLevel/providers/mapillary/index.js index 0584fc542..630c04451 100644 --- a/src/layers/streetLevel/providers/mapillary/index.js +++ b/src/layers/streetLevel/providers/mapillary/index.js @@ -46,7 +46,6 @@ function createProviderState(context) { selectedId: null, images: [], set: null, - sprite: null, loading: false, /** Why the selected sequence's images could not load, until it goes. */ error: null, diff --git a/src/layers/streetLevel/providers/panoramax/index.js b/src/layers/streetLevel/providers/panoramax/index.js index 30c307f0d..a09709687 100644 --- a/src/layers/streetLevel/providers/panoramax/index.js +++ b/src/layers/streetLevel/providers/panoramax/index.js @@ -171,7 +171,6 @@ export function createPanoramaxProvider({ selectedId: null, images: [], set: null, - sprite: null, loading: false, error: null, abort: null, diff --git a/src/layers/streetLevel/registry.js b/src/layers/streetLevel/registry.js index 62463fde3..4ad79402f 100644 --- a/src/layers/streetLevel/registry.js +++ b/src/layers/streetLevel/registry.js @@ -27,7 +27,7 @@ export function filtersOf(provider) { * @property {(context: ProviderContext) => ProviderInstance} create * * @typedef {object} ProviderContext Handed to `create()` once by the core. - * @property {object} services Scene services: picking, input, render, sprites (a `scenePick` given is not read). + * @property {object} services Scene services: picking, input, render (a `scenePick` given is not read). * @property {() => {pano: string, sinceMs: number|null}} getFilter Filter resolved against now; read it on every use so "since N days" keeps up. * @property {() => boolean} isActive Layer enabled and this provider switched on. * @property {() => void} notify Ask the core to publish a new UI snapshot. diff --git a/src/layers/streetLevel/sequenceCones.js b/src/layers/streetLevel/sequenceCones.js index 513451fc4..390334e29 100644 --- a/src/layers/streetLevel/sequenceCones.js +++ b/src/layers/streetLevel/sequenceCones.js @@ -54,7 +54,7 @@ export function thinImages(images, spacingM = IMAGE_CONE_MIN_SPACING_M) { * The sequence's images in capture order, thinned (see `thinImages`). * @param {{coverage: string}} options.colors * @param {string} options.pickPrefix Pick-id prefix of the cones. - * @param {string} options.spriteId Sprite-order id of the cone set (and its draw-set id's stem). + * @param {string} options.spriteId Stem of the cone set's draw-set id. * @param {string} options.renderKey Render-governor reason. * @param {(sequenceId: string|null) => void} [options.onHighlight] * Highlight the sequence's coverage line (null: none). @@ -71,7 +71,7 @@ export function createSequenceCones({ onHighlight = () => {}, passes = passesImageryFilter, }) { - const { render, sprites } = state.services; + const { render } = state.services; function requestRender() { render?.governorRequestRender?.(renderKey); @@ -101,10 +101,9 @@ export function createSequenceCones({ state.sequence.set = drawOf(viewer).icons({ id: `${spriteId}:${++coneSets}`, }); - // Drawn from now, empty: the cones keep their place over the marker. + // Drawn from now, empty: the cones keep their place by when they were + // made (after the marker). state.sequence.set.set([]); - state.sequence.sprite = - sprites?.registerSpriteSet?.(spriteId, state.sequence.set.id) ?? null; } function clearCones() { @@ -232,10 +231,8 @@ export function createSequenceCones({ cones = []; const set = state.sequence.set; if (set) { - sprites?.unregisterSpriteCollection?.(spriteId, state.sequence.sprite); set.dispose(); state.sequence.set = null; - state.sequence.sprite = null; } state.sequence.images = []; state.sequence.selectedId = null; diff --git a/src/layers/streetLevel/state.js b/src/layers/streetLevel/state.js index bf958c48a..9e104238b 100644 --- a/src/layers/streetLevel/state.js +++ b/src/layers/streetLevel/state.js @@ -55,8 +55,8 @@ export function createState({ services }) { /** Whether the camera is low enough for a ground click to open an image. */ groundClickReady: false, - /** The open image's marker: its draw set, sprite registration and drawn icon. */ - marker: { set: null, sprite: null, placed: null, look: null }, + /** The open image's marker: its draw set and drawn icon. */ + marker: { set: null, placed: null, look: null }, clickSubscription: null, }; } diff --git a/src/layers/transit/lifecycle.js b/src/layers/transit/lifecycle.js index 5b162308f..9a4f5f02c 100644 --- a/src/layers/transit/lifecycle.js +++ b/src/layers/transit/lifecycle.js @@ -4,13 +4,12 @@ import { TRANSIT_ENABLED_FEEDS } from '../../data/transitFeeds.js'; /** * Init / enable / disable / update / destroy for one Transit layer instance. - * Everything acquired here is released here — primitives, listeners, the sprite - * registration, the pick owner, the render hold, and the camera listener. + * Everything acquired here is released here — primitives, listeners, the + * pick owner, the render hold, and the camera listener. * @param {object} context * @returns {object} */ export function createLifecycle({ state, services, parts }) { - const { restoreSpriteOrder } = services.sprites; const { registerPickOwner, unregisterPickOwner } = services.picking; const { releaseContinuousRender } = services.render; @@ -112,7 +111,6 @@ export function createLifecycle({ state, services, parts }) { state._rotationPose = null; state._rotationDirty = false; state._overlayHost.setVisible(TRANSIT_SELECTED_OVERLAY_SOURCE_ID, false); - restoreSpriteOrder(viewer); bindStyleEvents(); console.log( `[Data:Transit] Initialized with ${TRANSIT_ENABLED_FEEDS.length} GTFS-RT feeds`, @@ -143,7 +141,6 @@ export function createLifecycle({ state, services, parts }) { } parts.rendering.startFrames(viewer); parts.viewport.runProximityCheck(); - restoreSpriteOrder(viewer); }, /** diff --git a/src/layers/transit/lifecycle.test.mjs b/src/layers/transit/lifecycle.test.mjs index 1f8996cbb..69b1528b2 100644 --- a/src/layers/transit/lifecycle.test.mjs +++ b/src/layers/transit/lifecycle.test.mjs @@ -2,6 +2,7 @@ import test from 'node:test'; import assert from 'node:assert/strict'; import * as Cesium from 'cesium'; import { createTransitLayer } from './index.js'; +import { spriteDrawOrder } from '../../data/spriteOrder.js'; import { FEED_EVICT_AFTER_MS, FEED_STALE_AFTER_MS, @@ -240,7 +241,6 @@ function harness( const originalFetch = globalThis.fetch; const originalDocument = globalThis.document; const primitives = []; - const sprites = new Map(); const pickOwners = new Map(); const overlaySources = new Map(); const credits = []; @@ -306,7 +306,6 @@ function harness( get length() { return primitives.length; }, - raiseToTop() {}, }, }, }; @@ -343,17 +342,7 @@ function harness( holdContinuousRender, releaseContinuousRender, }, - sprites: { - registerSpriteCollection: (id, collection) => - sprites.set(id, collection), - registerSpriteSet: (id, setId) => { - const entry = { drawSetId: setId }; - sprites.set(id, entry); - return entry; - }, - unregisterSpriteCollection: (id) => sprites.delete(id), - restoreSpriteOrder() {}, - }, + sprites: { spriteDrawOrder }, picking: { registerPickOwner: (id, predicate) => pickOwners.set(id, predicate), unregisterPickOwner: (id) => pickOwners.delete(id), @@ -524,7 +513,6 @@ function harness( cameraThresholds: () => [...cameraListeners].map((l) => l.threshold), input, primitives, - sprites, pickOwners, overlaySources, credits, @@ -1108,7 +1096,6 @@ test('destroy releases every shared registration this layer took', async (t) => })); app.layer.enable(app.viewer); await app.layer.update(); - assert.ok(app.sprites.has('transit')); assert.ok(app.pickOwners.has('transit')); const ids = app.layer._transitSetIdsForTest(); assert.deepEqual( @@ -1119,11 +1106,6 @@ test('destroy releases every shared registration this layer took', async (t) => app.layer.destroy(app.viewer); assert.deepEqual(app.cameraThresholds(), [], 'the camera listener goes'); - assert.equal( - app.sprites.has('transit'), - false, - 'the sprite collection is unregistered', - ); assert.equal( app.pickOwners.has('transit'), false, @@ -1149,11 +1131,7 @@ test('two layers built from the factory share no state', async (t) => { holdContinuousRender, releaseContinuousRender, }, - sprites: { - registerSpriteCollection() {}, - unregisterSpriteCollection() {}, - restoreSpriteOrder() {}, - }, + sprites: { spriteDrawOrder }, picking: { registerPickOwner() {}, unregisterPickOwner() {} }, overlays: { setOverlayEntries() {}, @@ -3846,7 +3824,7 @@ test('the actual Transit lifecycle keeps exactly its own camera listener in ever _failedCityIds: new Set(), }, services: { - sprites: { restoreSpriteOrder: noop }, + sprites: { spriteDrawOrder }, picking: { registerPickOwner: noop, unregisterPickOwner: noop }, }, source: {}, @@ -3946,60 +3924,19 @@ test('the actual Transit lifecycle keeps exactly its own camera listener in ever } }); -test('moving and stationary transit stay adjacent above CCTV and Bikeshare during migration', async (t) => { - const { - registerSpriteCollection, - unregisterSpriteCollection, - restoreSpriteOrder, - } = await import('../../data/spriteOrder.js'); +test('moving and stationary transit draw next to each other, above CCTV and Bikeshare and under flights', (t) => { const app = harness(t); app.layer.enable(app.viewer); app.layer._loadTransitFleetForTest(1, BOSTON, 70); - const cctv = {}, - bike = {}, - flights = {}; - // The marker sets' hosts, named by their set ids as the draw port names - // them, between the others. - const [stillId, movingId] = app.layer._transitSetIdsForTest(); - const still = { drawSetId: stillId }, - moving = { drawSetId: movingId }; - app.primitives.push(cctv, still, bike, moving, flights); - app.viewer.scene.primitives.raiseToTop = (c) => { - app.primitives.splice(app.primitives.indexOf(c), 1); - app.primitives.push(c); - }; - const collections = new Map([ - ...app.sprites, - ['cctv', cctv], - ['bikeshare', bike], - ['flights', flights], - ]); - for (const [id, collection] of collections) - registerSpriteCollection(id, collection); - t.after(() => { - for (const [id, c] of collections) unregisterSpriteCollection(id, c); - }); - const entry = app.vehicles()[0], - parts = app.layer._transitPartsForTest(); - const stillHost = still, - movingHost = moving; - for (const moving of [true, false, true]) { - entry.sample.phase = moving ? 'playing' : 'held'; - entry.sample.segmentSpeedMps = moving ? 1 : 0; - entry.sample.segmentCourseDeg = NaN; - parts.rendering.schedulePlayback(entry); - restoreSpriteOrder(app.viewer); - parts.rendering.flushMarkers(); - assert.ok(app.markers(moving ? 'moving' : 'still').has(entry.key)); - const active = app.primitives.indexOf(moving ? movingHost : stillHost); - assert.ok(active > app.primitives.indexOf(cctv)); - assert.ok(active > app.primitives.indexOf(bike)); - assert.ok(active < app.primitives.indexOf(flights)); - assert.equal( - app.primitives.indexOf(movingHost) - app.primitives.indexOf(stillHost), - 1, - ); - } + const [still, moving] = app.layer + ._transitSetIdsForTest() + .map((id) => app.draw.set(id).spec.drawOrder); + assert.equal(still, spriteDrawOrder('transit')); + assert.equal(moving, spriteDrawOrder('transit-motion')); + assert.equal(moving - still, 1, 'adjacent, the moving ones over the still'); + for (const under of ['cctv', 'bikeshare']) + assert.ok(still > spriteDrawOrder(under), `over ${under}`); + assert.ok(moving < spriteDrawOrder('flights'), 'under flights'); }); test('transit polls the supplied source and cancels it when disabled', async (t) => { diff --git a/src/layers/transit/rendering.js b/src/layers/transit/rendering.js index 9bffd17c9..10f39b92b 100644 --- a/src/layers/transit/rendering.js +++ b/src/layers/transit/rendering.js @@ -77,32 +77,30 @@ export function createRendering({ state, services, parts }) { /** * The two icon sets, still and moving, hidden, in the scene now (with no - * items) and in the shared sprite order. A viewer of the layer's own - * draws through `./render/cesium/unbound`, which its owner loads. + * items), each at its place in the shared sprite order. A viewer of the + * layer's own draws through `./render/cesium/unbound`, which its owner loads. * @param {object} viewer */ function createMarkers(viewer) { destroyMarkers(viewer); const draw = drawOf(viewer); + const drawOrder = (layerId) => + services.sprites?.spriteDrawOrder?.(layerId) ?? 0; state._stillIcons = draw.icons({ id: `transit:${instance}:still`, blend: 'translucent', show: false, + drawOrder: drawOrder('transit'), }); state._movingIcons = draw.icons({ id: `transit:${instance}:moving`, blend: 'translucent', show: false, + drawOrder: drawOrder('transit-motion'), }); - // Emptied, they are drawn now: the sprite order finds them at once. + // Emptied, they are drawn now: in the scene at once. state._stillIcons.set([]); state._movingIcons.set([]); - const { registerSpriteSet } = services.sprites; - state._stillSprite = registerSpriteSet?.('transit', state._stillIcons.id); - state._movingSprite = registerSpriteSet?.( - 'transit-motion', - state._movingIcons.id, - ); state._markersShown = false; } @@ -127,27 +125,20 @@ export function createRendering({ state, services, parts }) { } /** - * Let both sets go and take them out of the sprite order. + * Let both sets go. * @param {object|null|undefined} _viewer */ function destroyMarkers(_viewer) { dirty.clear(); stillRemovals.length = 0; movingRemovals.length = 0; - const { unregisterSpriteCollection } = services.sprites; if (state._stillIcons) { - if (state._stillSprite) - unregisterSpriteCollection?.('transit', state._stillSprite); state._stillIcons.dispose(); state._stillIcons = null; - state._stillSprite = null; } if (state._movingIcons) { - if (state._movingSprite) - unregisterSpriteCollection?.('transit-motion', state._movingSprite); state._movingIcons.dispose(); state._movingIcons = null; - state._movingSprite = null; } state._markersShown = false; } diff --git a/src/layers/transit/state.js b/src/layers/transit/state.js index e406bea91..57c472238 100644 --- a/src/layers/transit/state.js +++ b/src/layers/transit/state.js @@ -26,9 +26,6 @@ export function createState({ services }) { /** The still markers' icon draw set, and the moving ones', or null. */ state._stillIcons = null; state._movingIcons = null; - /** Their sprite-order registrations. */ - state._stillSprite = null; - state._movingSprite = null; /** Whether the markers are shown (the layer is on). */ state._markersShown = false; state._visible = new Set(); diff --git a/src/layers/vessels/lifecycle.js b/src/layers/vessels/lifecycle.js index 4aa76817c..06529225e 100644 --- a/src/layers/vessels/lifecycle.js +++ b/src/layers/vessels/lifecycle.js @@ -10,7 +10,6 @@ export function createLifecycle({ options, }) { const { state } = vesselState; - const { restoreSpriteOrder, restoreSpriteOrderOnEnable } = services.sprites; const { releaseContinuousRender } = services.render; const { ensureGeoidReady } = services.geoid; const { registerPickOwner, unregisterPickOwner } = services.picking; @@ -157,7 +156,6 @@ export function createLifecycle({ ); components.selection.installInteraction(viewer); components.rendering.installRuntime(viewer); - restoreSpriteOrder(viewer); }, enable(viewer) { @@ -190,7 +188,6 @@ export function createLifecycle({ registerPickOwner('ais-live-vessels', (pickedId) => state.records.byMmsi.has(pickedId), ); - restoreSpriteOrderOnEnable('ais', activeViewer); // Vessels are asked for by view, so ask again when the view moves away. removeViewListener(); const moveEnd = activeViewer?.camera?.moveEnd; diff --git a/src/layers/vessels/ownership.test.mjs b/src/layers/vessels/ownership.test.mjs index 12afccbaf..7493c1384 100644 --- a/src/layers/vessels/ownership.test.mjs +++ b/src/layers/vessels/ownership.test.mjs @@ -32,7 +32,7 @@ function services() { clearOverlaySource: noop, }, geoid: {}, - sprites: { registerSpriteSet: noop }, + sprites: {}, focus: { focusNowMs: (now) => now, getFocusTarget: () => null, diff --git a/src/layers/vessels/renderGovernor.test.mjs b/src/layers/vessels/renderGovernor.test.mjs index 0e2cbf2b4..3c537c318 100644 --- a/src/layers/vessels/renderGovernor.test.mjs +++ b/src/layers/vessels/renderGovernor.test.mjs @@ -34,7 +34,7 @@ function setup({ focusPassIsNeeded = () => false } = {}) { clearOverlaySource: noop, }, geoid: {}, - sprites: { registerSpriteSet: noop }, + sprites: {}, focus: { focusNowMs: () => clock, getFocusTarget: () => null, diff --git a/src/layers/vessels/rendering.js b/src/layers/vessels/rendering.js index 63349c04d..c0470082b 100644 --- a/src/layers/vessels/rendering.js +++ b/src/layers/vessels/rendering.js @@ -92,8 +92,7 @@ export function createRendering({ visualRecords = new WeakMap(); } - const { registerSpriteSet } = services.sprites; - let warnedNoSpriteOrder = false; + const { spriteDrawOrder } = services.sprites; const { forgetSpriteFocus, focusNowMs, @@ -138,20 +137,13 @@ export function createRendering({ const set = drawOf(viewer).icons({ id: `ais-vessels:${++instances}`, horizonCull: true, + drawOrder: spriteDrawOrder?.('ais') ?? 0, }); - // Columns of no rows put the set's host in the scene now, where the - // sprite order finds it, rather than with its first vessel. + // Columns of no rows put the set's host in the scene now, rather than + // with its first vessel. set.setColumns?.({ ids: [] }); state.icons = createVesselIconBook(set); state.icons.show = state.feed.enabled; - if (registerSpriteSet) registerSpriteSet('ais', set.id); - else if (!warnedNoSpriteOrder) { - // Drawn still, but not raised over the other sprite layers. - warnedNoSpriteOrder = true; - console.warn( - '[Data:ais-live-vessels] the host has no registerSpriteSet; ships keep their draw order', - ); - } } /** Let the icon draw set go (the layer is destroyed). */ diff --git a/src/render/cesium/draw.js b/src/render/cesium/draw.js index 61ac2ff59..89e6dc243 100644 --- a/src/render/cesium/draw.js +++ b/src/render/cesium/draw.js @@ -722,7 +722,8 @@ export function createCesiumDraw({ slot >= 0 && slot + 1 < scene.primitives.length ? scene.primitives.get(slot + 1) : null; - // Named for code that orders the scene's primitives (`spriteOrder.js`). + // Named for code that finds a set's host among the scene's primitives + // (`uploadProbe.js`). host.drawSetId = record.spec.id; // Only old ground primitives wait for the new ones: the rest of the old // host goes now, as the new host's own parts draw at once. @@ -765,9 +766,8 @@ export function createCesiumDraw({ * higher order goes earlier; of one order, in the order they were made. * The hosts trade places among the slots they hold, so nothing else in * the scene moves. Nothing moves while every set is at 0 (unless an order - * just changed, `changed`), so sets at 0 stack as they were first drawn - * (and as the sprite order raises them); nor while the hosts are already - * in order. + * just changed, `changed`), so sets at 0 stack as they were first drawn; + * nor while the hosts are already in order. * Translucent ones blend order-independently, whatever their order, and * items in different view frustums stack nearer frustum first. * @param {boolean} [changed] diff --git a/src/render/cesium/draw.test.mjs b/src/render/cesium/draw.test.mjs index 446601071..862acbb9b 100644 --- a/src/render/cesium/draw.test.mjs +++ b/src/render/cesium/draw.test.mjs @@ -13,6 +13,7 @@ import { } from './draw.js'; import { drawHitOf } from './drawHit.js'; import { MODEL_RETRY_MS } from './drawModels.js'; +import { spriteDrawOrder } from '../../data/spriteOrder.js'; // Node has no WebGL context to report line-width limits. Cesium.ContextLimits._minimumAliasedLineWidth = 1; @@ -1669,13 +1670,7 @@ test('the traffic layer draws its dots as one point collection moved, added to a assert.equal(scene.added.length, 0); }); -test('a rebuilt set keeps its place among the scene primitives, and names its host', async () => { - const { - registerSpriteSet, - registerSpriteCollection, - restoreSpriteOrder, - unregisterSpriteCollection, - } = await import('../../data/spriteOrder.js'); +test('a rebuilt set keeps its place among the scene primitives, and names its host', () => { const scene = fakeScene(); scene.primitives = new Cesium.PrimitiveCollection(); const { draw } = drawOver(scene); @@ -1702,17 +1697,6 @@ test('a rebuilt set keeps its place among the scene primitives, and names its ho 'not raised by updates', ); - // The sprite order finds the set's host by its id, whichever host it is. - const cctv = registerSpriteCollection('cctv', below); - const flights = registerSpriteCollection('flights', above); - const entry = registerSpriteSet('bikeshare', 'kept'); - scene.primitives.raiseToTop(below); - assert.deepEqual(order(), ['kept', 'above', 'below']); - restoreSpriteOrder({ scene }); - assert.deepEqual(order(), ['below', 'kept', 'above']); - unregisterSpriteCollection('bikeshare', entry); - unregisterSpriteCollection('cctv', cctv); - unregisterSpriteCollection('flights', flights); set.dispose(); }); @@ -1784,6 +1768,54 @@ test('reordering by drawOrder leaves the other primitives where they are', () => for (const set of [a, b, c]) set.dispose(); }); +test('sprite layers stack flights on top, all under a set at the default order', () => { + const scene = fakeScene(); + scene.primitives = new Cesium.PrimitiveCollection(); + const { draw } = drawOver(scene); + const dot = { id: 'a', pos: { lon: 0, lat: 0 }, pixelSize: 4, color: '#fff' }; + // Made before every sprite set, and again after them. + const highlight = draw.points({ id: 'highlight' }); + highlight.set([dot]); + const sets = ['flights', 'cctv', 'ais', 'transit'].map((layerId) => { + const set = draw.points({ + id: layerId, + drawOrder: spriteDrawOrder(layerId), + }); + set.set([dot]); + return set; + }); + const endpoint = draw.points({ id: 'endpoint' }); + endpoint.set([dot]); + const order = []; + for (let i = 0; i < scene.primitives.length; i++) { + order.push(scene.primitives.get(i).drawSetId); + } + // Earlier draws on top. + assert.deepEqual(order, [ + 'highlight', + 'endpoint', + 'flights', + 'ais', + 'transit', + 'cctv', + ]); + // Raised above flights in place, CCTV keeps every other set's slot. + sets[1].setOptions({ drawOrder: spriteDrawOrder('flights') + 0.5 }); + const after = []; + for (let i = 0; i < scene.primitives.length; i++) { + after.push(scene.primitives.get(i).drawSetId); + } + assert.deepEqual(after, [ + 'highlight', + 'endpoint', + 'cctv', + 'flights', + 'ais', + 'transit', + ]); + for (const set of [highlight, endpoint, ...sets]) set.dispose(); +}); + test('changing an option rebuilds only the kinds that build it in, in their place', () => { const scene = fakeScene(); scene.primitives = new Cesium.PrimitiveCollection(); @@ -2252,17 +2284,12 @@ test('the GNSS layer draws its cells as ground fills that stay out of the pick p test('the fires layer draws its heat cells as ground fills through the Cesium draw port', async (t) => { const { createFirmsHeatmapLayer } = await import('../../data/firmsHeatmap.js'); - const { unregisterSpriteCollection } = - await import('../../data/spriteOrder.js'); const { fakeInput } = await import('../../input/testDoubles.mjs'); const { bindFakeCesiumScene } = await import('../../testSupport/fakeCesiumScene.mjs'); const saved = globalThis.window; globalThis.window = new EventTarget(); const scene = fakeScene(); - // The layer keeps its detection icons over other sprites. - scene.primitives.contains = (p) => scene.added.includes(p); - scene.primitives.raiseToTop = () => {}; // Far out, where the layer draws heat cells rather than detections. const viewer = { scene, @@ -2302,7 +2329,6 @@ test('the fires layer draws its heat cells as ground fills through the Cesium dr t.after(() => { input.destroy(); unbind(); - unregisterSpriteCollection('firms'); if (saved === undefined) delete globalThis.window; else globalThis.window = saved; }); @@ -3648,14 +3674,10 @@ test('the vessels layer draws its ships as one GPU icon set that holds them on c await import('../../data/iconSet.js'); const spriteOrder = await import('../../data/spriteOrder.js'); const scene = fakeScene(); - const registered = []; - const { layer, viewer, part, unbind } = await vesselLayerOver(scene, { - registerSpriteSet(layerId, setId) { - registered.push([layerId, setId]); - return spriteOrder.registerSpriteSet(layerId, setId); - }, - }); - const military = { name: 'military' }; + const { layer, viewer, part, unbind } = await vesselLayerOver( + scene, + spriteOrder, + ); try { layer.testing._setVesselStateForTest({ viewer, icons: null }); layer.testing._reconcileVesselsForTest(viewer, [ @@ -3696,34 +3718,11 @@ test('the vessels layer draws its ships as one GPU icon set that holds them on c assert.equal(set.count, 1); assert.equal(set.course(set.row('244000001'), tau), 95); - // The sprite order finds the host by its set id and stacks it under the - // military sprites. - assert.deepEqual(registered, [['ais', host.drawSetId]]); - spriteOrder.registerSpriteCollection('military', military); - const stack = (list) => ({ - scene: { - primitives: { - get: (i) => list[i], - get length() { - return list.length; - }, - contains: (p) => list.includes(p), - raiseToTop(p) { - list.splice(list.indexOf(p), 1); - list.push(p); - }, - }, - }, - }); - const order = [military, host, { name: 'other' }]; - spriteOrder.restoreSpriteOrder(stack(order)); - assert.deepEqual( - order.map((p) => p.name ?? p.drawSetId), - ['other', host.drawSetId, 'military'], - ); + // The set stacks at the vessels' place in the sprite order. + assert.equal(record.spec.drawOrder, spriteOrder.spriteDrawOrder('ais')); - // Torn down and drawn again: a new set, registered in the old one's - // place, with the old host gone from the scene. + // Torn down and drawn again: a new set at the same draw order, with + // the old host gone from the scene. layer.destroy(viewer); assert.equal(scene.added.length, 0, 'destroyed: the set goes'); layer.testing._setVesselStateForTest({ viewer, icons: null }); @@ -3735,16 +3734,13 @@ test('the vessels layer draws its ships as one GPU icon set that holds them on c assert.notEqual(again, host); assert.notEqual(again.drawSetId, host.drawSetId, 'a new set id'); assert.equal(part.sets.has(host.drawSetId), false); - assert.deepEqual(registered.at(-1), ['ais', again.drawSetId]); - const stray = { name: 'stray' }; - const next = [military, again, stray]; - spriteOrder.restoreSpriteOrder(stack(next)); - assert.deepEqual(next, [stray, again, military], 'the new host is raised'); + assert.equal( + part.sets.get(again.drawSetId).spec.drawOrder, + spriteOrder.spriteDrawOrder('ais'), + ); layer.destroy(viewer); assert.equal(scene.added.length, 0); } finally { - spriteOrder.unregisterSpriteCollection('military', military); - spriteOrder.unregisterSpriteCollection('ais'); unbind(); } }); @@ -3790,12 +3786,10 @@ test('the FIRMS layer draws its fire glows as one GPU icon set on a viewer of it warmFireAnchorFloors: async () => false, }, sprites: { - registerSpriteSet: (layerId, setId) => { - sprites.push([layerId, setId]); - return { drawSetId: setId }; + spriteDrawOrder: (layerId) => { + sprites.push(layerId); + return spriteDrawOrder(layerId); }, - unregisterSpriteCollection: noop, - restoreSpriteOrder: noop, }, }; const config = { @@ -3826,7 +3820,7 @@ test('the FIRMS layer draws its fire glows as one GPU icon set on a viewer of it const [host] = scene.added; assert.ok(host instanceof IconSetPrimitive, 'one GPU icon set'); - assert.deepEqual(sprites, [['firms', host.drawSetId]]); + assert.deepEqual(sprites, ['firms'], 'at the fires’ draw order'); const set = host.set; assert.equal(set.count, 2); const strong = set.row('firms-0'); @@ -3980,20 +3974,14 @@ test('the Radio layer draws its stations, clusters and selected marker as point assert.equal(scene.added.length, 0, 'gone with the layer'); }); -test('vessels on a host with no sprite-set registry still draw, and say so once', async (t) => { - const warnings = []; - t.mock.method(console, 'warn', (...args) => warnings.push(args.join(' '))); +test('vessels on a host without the sprite order still draw, at the default draw order', async () => { const scene = fakeScene(); - const { layer, viewer, unbind } = await vesselLayerOver(scene, {}); + const { layer, viewer, part, unbind } = await vesselLayerOver(scene, {}); const ship = { mmsi: '244000001', lat: 51.95, lon: 4.1, heading: 90 }; layer.testing._setVesselStateForTest({ viewer, icons: null }); layer.testing._reconcileVesselsForTest(viewer, [ship]); assert.equal(scene.added.length, 1, 'drawn'); - layer.destroy(viewer); - layer.testing._setVesselStateForTest({ viewer, icons: null }); - layer.testing._reconcileVesselsForTest(viewer, [ship]); - const said = warnings.filter((w) => w.includes('registerSpriteSet')); - assert.equal(said.length, 1, 'once, not per set'); + assert.equal(part.sets.get(scene.added[0].drawSetId).spec.drawOrder, 0); layer.destroy(viewer); unbind(); }); @@ -4840,12 +4828,10 @@ test('the directions layer draws its markers, flowing route and maneuver dots on releaseContinuousRender: noop, }, sprites: { - registerSpriteSet: (layerId, setId) => { - sprites.push([layerId, setId]); - return { drawSetId: setId }; + spriteDrawOrder: (layerId) => { + sprites.push(layerId); + return spriteDrawOrder(layerId); }, - unregisterSpriteCollection: noop, - restoreSpriteOrder: noop, }, picking: { registerPickOwner: noop, unregisterPickOwner: noop }, overlays: { @@ -4902,12 +4888,12 @@ test('the directions layer draws its markers, flowing route and maneuver dots on [flow.repeat, flow.duty, flow.speed, flow.color.alpha], [64, 0.46, 0.55, 0.95], ); - // One maneuver dot, at its junction on the ground floor, in the sprite - // order. + // One maneuver dot, at its junction on the ground floor, at the + // directions' draw order. const steps = hostOf(':steps'); assert.ok(steps instanceof Cesium.PointPrimitiveCollection); assert.equal(steps.blendOption, Cesium.BlendOption.TRANSLUCENT); - assert.deepEqual(sprites, [['directions', steps.drawSetId]]); + assert.deepEqual(sprites, ['directions']); assert.equal(steps.length, 1); const dot = steps.get(0); assert.equal(dot.id.id, 'directions:step:1'); @@ -7513,12 +7499,10 @@ test('the transit layer draws its vehicles as two icon sets, moving a marker bet releaseContinuousRender: noop, }, sprites: { - registerSpriteSet: (layerId, setId) => { - const entry = { drawSetId: setId }; - registered.push([layerId, setId]); - return entry; + spriteDrawOrder: (layerId) => { + registered.push(layerId); + return spriteDrawOrder(layerId); }, - unregisterSpriteCollection: noop, }, }; const state = createState({ services }); @@ -7530,10 +7514,7 @@ test('the transit layer draws its vehicles as two icon sets, moving a marker bet }); rendering.createMarkers(viewer); const [stillId, movingId] = rendering.setIds(); - assert.deepEqual(registered, [ - ['transit', stillId], - ['transit-motion', movingId], - ]); + assert.deepEqual(registered, ['transit', 'transit-motion']); const hostOf = (setId) => scene.added.find((h) => h.drawSetId === setId); assert.ok(hostOf(stillId) instanceof Cesium.BillboardCollection); assert.ok(hostOf(movingId) instanceof Cesium.BillboardCollection); diff --git a/src/render/cesium/gpuIcons.test.mjs b/src/render/cesium/gpuIcons.test.mjs index c5ec4958a..55516ee03 100644 --- a/src/render/cesium/gpuIcons.test.mjs +++ b/src/render/cesium/gpuIcons.test.mjs @@ -83,7 +83,7 @@ test('a moving item takes its icon set onto the GPU, in its billboards’ place' assert.equal(scene.added.length, 1, 'one host'); const host = scene.added[0]; assert.ok(host instanceof IconSetPrimitive, 'drawn by the GPU icon set'); - assert.equal(host.drawSetId, 'gpu:switch', 'named for sprite ordering'); + assert.equal(host.drawSetId, 'gpu:switch', 'named for finding its host'); const { set: rowsOf, course } = rows(part, 'gpu:switch'); assert.equal(rowsOf.count, 2, 'the items it had are rows too'); assert.equal(set.size(), 2); diff --git a/src/render/viewerAccessAllowList.json b/src/render/viewerAccessAllowList.json index 2c8a533b2..3b9a23ec9 100644 --- a/src/render/viewerAccessAllowList.json +++ b/src/render/viewerAccessAllowList.json @@ -7,7 +7,6 @@ "src/celestialRing.js": 1, "src/data/bhoteKoshiEmbeddedMedia.js": 1, "src/data/followed.js": 5, - "src/data/spriteOrder.js": 2, "src/layers/flights/motion.js": 1, "src/layers/military/motion.js": 1, "src/layers/streetLevel/view.js": 1, From 6c1f91014c00c2c0e69fe682e8848cf48b7f2443 Mon Sep 17 00:00:00 2001 From: Sameh Khamis Date: Mon, 9 Nov 2026 15:50:53 -0800 Subject: [PATCH 2/2] Draw imported files through the draw port, off Cesium Import no longer loads KML, KMZ, GeoJSON and GPX through Cesium's data source loaders. geoImportFeatures.js reads the sanitized file into plain pins, lines, walls, polygons and ground overlays with the looks those loaders gave them: icon, scale, colour, heading and hot spot, the shared and inline style precedence, line and polygon colours and widths, extruded and clamped geometry, rotated boxes and quads, and GeoJSON's 48 px pins, draped lines along rhumb lines and quarter-opacity fills. geoImportPins.js draws them in three draw sets per file, places ground pins through the height service (0 on the bare ellipsoid, whose coarse tiles sag below it; the mesh nearby on photoreal maps), follows a double-clicked pin, frames Fly-to, and shows, hides and removes them. The Cesium adapter now draws two members the contract already had: an icon's pixel offset and the wall shape. Image fills draw in the translucent pass, so an overlay's own alpha blends as it did. The Cesium allow-list is now empty; the ratchet test checks that its scan still sees each way of reaching Cesium. The QA scripts read what a file drew through the import's drawn(id), and the large-file check compares it with Cesium's own reading of the same KML. A file the renderer refuses to draw is refused by itself, without stopping its batch. Two translations no longer used are dropped. --- docs/CURRENT-STATE.md | 14 +- docs/RENDERER-CONTRACT.md | 3 +- scripts/package-boundaries.json | 6 + scripts/qa-geo-import-large.mjs | 212 +++-- scripts/qa-geo-import-regressions.mjs | 98 +- scripts/qa-geo-import.mjs | 141 +-- src/data/geoFileImport.js | 64 +- src/data/geoFileImport.test.mjs | 484 ++++------ src/data/geoImportFeatures.js | 684 ++++++++++++++ src/data/geoImportFeatures.test.mjs | 341 +++++++ src/data/geoImportPins.js | 1002 +++++++++++---------- src/data/geoImportPins.test.mjs | 256 ++++++ src/i18n/locales/ar.json | 2 - src/i18n/locales/de.json | 2 - src/i18n/locales/es.json | 2 - src/i18n/locales/fr.json | 2 - src/i18n/locales/it.json | 2 - src/i18n/locales/ja.json | 2 - src/i18n/locales/pt.json | 2 - src/i18n/locales/ru.json | 2 - src/i18n/locales/uk.json | 2 - src/i18n/locales/zh-CN.json | 2 - src/i18n/locales/zh-Hant.json | 2 - src/render/cesium/draw.js | 58 +- src/render/cesium/draw.test.mjs | 54 ++ src/render/cesiumAllowList.json | 2 +- src/render/noCesiumOutsideRender.test.mjs | 34 + src/render/unboundCamera.test.mjs | 5 +- src/ui/displayPanel.test.mjs | 3 +- src/ui/flyToDataSource.js | 2 +- src/ui/flyToDataSource.test.mjs | 161 ++-- src/ui/geoFileImport.js | 56 +- src/ui/geoFileImport.test.mjs | 83 +- 33 files changed, 2608 insertions(+), 1177 deletions(-) create mode 100644 src/data/geoImportFeatures.js create mode 100644 src/data/geoImportFeatures.test.mjs create mode 100644 src/data/geoImportPins.test.mjs diff --git a/docs/CURRENT-STATE.md b/docs/CURRENT-STATE.md index 898a7aacf..c653e2ae4 100644 --- a/docs/CURRENT-STATE.md +++ b/docs/CURRENT-STATE.md @@ -5782,15 +5782,15 @@ request viewbox and continues searching without that geographic preference. ### Import Your Own Files (October 2026) - UTILITIES ▸ **Import** reads GeoJSON (`.geojson`/`.json`), KML, KMZ and GPX from the picker or a file drop anywhere in the app. Each file gets show/hide, Fly-to and Remove controls. GeoJSON and GPX use the row's color; KML/KMZ retain their styles and show a hatched swatch. The file bytes remain on the device for the page session. Rendered overlays can appear in map screenshots sent through voice or other existing screenshot tools. -- **Ground and height.** GeoJSON XYZ coordinates become ground footprints. KML ground lines/rings are tessellated; static recorded tracks preserve their original vertices, segment gaps and explicit altitude modes. KML with absolute/relative altitude keeps that meaning. Ground pins resolve in batches of 256 against loaded terrain and, in the nearby camera footprint on photoreal maps, `clampToHeightMostDetailed`, then draw in one owned native BillboardCollection per file, with static positions and no per-frame point Entity visualizer or clamping callbacks. Point metadata remains in `dataSource.importedEntities` for framing/style inspection; non-point geometry stays in the normal source collection. Pin collections mount only after source admission, follow file show/hide, and are destroyed on removal. Settled camera/map-source changes and completed terrain loads refresh visible files through the same serial queue; distant points retain their latest available height. No detailed worldwide terrain sweep is started. Nearby mesh sampling can add requests/time; configured photoreal providers require separate validation. The depth test is disabled for ground pins, matching Draw's marker visibility policy. +- **Ground and height.** GeoJSON XYZ coordinates become ground footprints. KML ground lines/rings are tessellated; static recorded tracks preserve their original vertices, segment gaps and explicit altitude modes. KML with absolute/relative altitude keeps that meaning. Ground pins resolve in batches of 256 through the height service: the loaded terrain's height (0 on the bare ellipsoid, whose coarse tiles can sag far below it) and, in the nearby camera footprint on photoreal maps, the mesh height (`clampBatch`). They then draw as static icons in the file's own draw sets (pins, lines and shapes), with no per-frame clamping callbacks. GeoJSON lines and polygon edges follow rhumb lines, split into steps of at most half a degree. Each file's sets mount only after admission, follow its show/hide, and are removed with it. Settled camera/map-source changes and completed terrain loads refresh visible files through the same serial queue; distant points retain their latest available height. No detailed worldwide terrain sweep is started. Nearby mesh sampling can add requests/time; configured photoreal providers require separate validation. The depth test is disabled for ground pins, matching Draw's marker visibility policy. - **Navigation.** Row Fly-to uses `runImmediateNavigation('file', …)`; Cockpit can refuse it and existing follow/track ownership is released first. Automatic Fly-to is stamped when a batch is submitted and reasserted before flying. Pointer/wheel gestures and newer navigation supersede it, including time spent in the queue. Framing uses every finite visible point/path/polygon-hole/wall vertex plus rotated overlay bounds, with viewport-aware range and a nadir view. The target uses available terrain/cached ground height and the ground guard on arrival. Empty footprints never fall back to deferred `viewer.flyTo`. -- **Clock.** Imports expose no source clock and no entity availability. KML times/view metadata are removed before loading; recorded tracks become static lines. GPX segments remain separate and GPX times are ignored. The shared clock stays unchanged. -- **Input handling.** Coordinates and GeoJSON geometry types are checked before Cesium allocation. Only short plain names reach GeoJSON property bags; file IDs, custom CRS and styling properties are removed. KML feature/geometry IDs are removed while Style/StyleMap references remain. Local style references are trimmed, incomplete style pairs removed, hidden-folder flags normalized to the import's show control, and unsupported prototype-named elements removed. UTF-16 BOMs and common KML namespace export defects are handled. Empty drawable content is refused. A loader failure or timeout does not hold the next file indefinitely; teardown aborts pending waits. -- **References and images.** File-authored remote links/icons/styles, network links, models and screen/photo overlays are removed. Packed KMZ and embedded PNG/JPEG/GIF/WebP/BMP images remain local; decoded dimensions are checked before image decoding against a total 16-megapixel and 8,192-pixel-side budget per file. Blocked IconStyle images fall back to local pins; authored empty icons remain empty. Colored overlays without an Icon survive; overlays with a removed external image are dropped. Metadata, native labels and descriptions are removed, and generated pins share one lossless image URL per canvas. +- **Clock.** Imports keep no clock and no time ranges: everything in a file draws at all times. KML times/view metadata are removed before loading; recorded tracks become static lines. GPX segments remain separate and GPX times are ignored. The shared clock stays unchanged. +- **Input handling.** Coordinates and GeoJSON geometry types are checked before anything is drawn. Only short plain names reach GeoJSON property bags; file IDs, custom CRS and styling properties are removed. KML feature/geometry IDs are removed while Style/StyleMap references remain. Local style references are trimmed, incomplete style pairs removed, hidden-folder flags normalized to the import's show control, and unsupported prototype-named elements removed. UTF-16 BOMs and common KML namespace export defects are handled. Empty drawable content is refused. A loader failure or timeout does not hold the next file indefinitely; teardown aborts pending waits. +- **References and images.** File-authored remote links/icons/styles, network links, models and screen/photo overlays are removed. Packed KMZ and embedded PNG/JPEG/GIF/WebP/BMP images remain local; decoded dimensions are checked before image decoding against a total 16-megapixel and 8,192-pixel-side budget per file. Blocked IconStyle images fall back to local pins; authored empty icons remain empty. Colored overlays without an Icon survive; overlays with a removed external image are dropped. Metadata, labels and descriptions are removed; only a short plain name reaches a drawn item. The default pins are shared SVG images. - **Bounds.** File size ≤50 MiB; inflated KMZ ≤120 MiB; ≤20,000 entities (including multipart children and Folder containers); ≤250,000 positions; ≤2,000 normalized style definitions and distinct image links; ≤12 files per session. Exact repeated styles share definitions without changing inheritance or inline overrides. Files of 20–30 MB fit the byte budget, subject to geometry/image limits. Refusals name a reason and batches continue; with multiple failures the hint shows the first reason. -- **Code layout.** `src/data/geoFileImport.js` reads, bounds and sanitizes the files and no longer imports or drives Cesium itself; it hands the parsed file to the Cesium-bound part. The Cesium-bound part (loading the parsed file as a Cesium data source, scrubbing and grounding its entities, its pin collection and its footprint for Fly-to) is `src/data/geoImportPins.js`, which stays on the Cesium allow-list; `src/data/geoImportShared.js` holds the error, limits, deadline and feature names both use. -- **Lifecycle and keyboard.** `createApplicationTools` wires `initGeoFileImport` with viewer, navigation, ground services and map-source subscription. Destroy aborts pending work, unsubscribes, removes data sources, revokes blob URLs, removes document/canvas listeners and releases `window.__gevGeoImport`. List rebuilds retain keyboard focus; removing a row hands focus to the next row, else the previous row, else Import. -- **Validation.** `node scripts/qa-geo-import.mjs` covers all four formats and real painted show/hide. Run `node scripts/qa-geo-import-regressions.mjs` against both dev and preview for XYZ/track heights, failure recovery, namespace/BOM support, portrait framing and panel drops. `node scripts/qa-geo-import-large.mjs [--file /absolute/path/sample.kml] [--expect-local-pins]` checks a 27.6 MB repeated-style file, native style/image equivalence, large-file painted output and frame times. It records the WebGL renderer; software-rendered runs do not establish GPU performance. Unit tests live beside the data/controller/framing modules. +- **Code layout.** `src/data/geoFileImport.js` reads, bounds and sanitizes the files. `src/data/geoImportFeatures.js` turns the sanitized KML or GeoJSON into plain features (pins, lines, walls, polygons and ground overlays) with the styles Cesium's KML and GeoJSON loaders gave them: icon, scale, colour, heading and hot spot; line and polygon colours and widths; extruded or clamped geometry. `src/data/geoImportPins.js` draws those features through the renderer's draw port (`drawOf`), settles ground pins through the height service, follows a double-clicked pin and frames the file for Fly-to. None of the three reaches Cesium, so the Cesium allow-list is empty. `src/data/geoImportShared.js` holds the error, limits, deadline and feature names they use. +- **Lifecycle and keyboard.** `createApplicationTools` wires `initGeoFileImport` with viewer, navigation, ground services and map-source subscription. Destroy aborts pending work, unsubscribes, removes each file's draw sets, revokes blob URLs, removes document/canvas listeners and releases `window.__gevGeoImport`. List rebuilds retain keyboard focus; removing a row hands focus to the next row, else the previous row, else Import. +- **Validation.** `node scripts/qa-geo-import.mjs` covers all four formats and real painted show/hide. Run `node scripts/qa-geo-import-regressions.mjs` against both dev and preview for XYZ/track heights, failure recovery, namespace/BOM support, portrait framing and panel drops. `node scripts/qa-geo-import-large.mjs [--file /absolute/path/sample.kml] [--expect-local-pins]` checks a 27.6 MB repeated-style file, that what the import draws matches Cesium's own `KmlDataSource` reading of the same file (positions, scale, heading, colours, widths, fills), large-file painted output and frame times. The QA scripts read what a file drew through `window.__gevGeoImport.drawn(id)`. It records the WebGL renderer; software-rendered runs do not establish GPU performance. Unit tests live beside the data/controller/framing modules. ### Recent Imagery (September 2026) diff --git a/docs/RENDERER-CONTRACT.md b/docs/RENDERER-CONTRACT.md index fadafebd3..66d100760 100644 --- a/docs/RENDERER-CONTRACT.md +++ b/docs/RENDERER-CONTRACT.md @@ -153,7 +153,8 @@ back to Cesium. Both lists only ever shrink. - `src/render/cesiumAllowList.json` lists the files outside the Cesium adapter (`src/render/cesium/`) that may still import or be handed Cesium (`src/render/noCesiumOutsideRender.test.mjs`). A file leaves the list - when it no longer drives Cesium at all; nothing is added. Two files name + when it no longer drives Cesium at all; nothing is added. The list is now + empty: no runtime file outside the adapter reaches Cesium. Two files name the adapter by design and are not on it: the application scene (`src/app/scene.js`), the composition root that picks the Cesium renderer, may import `src/render/cesium/application.js` and nothing else of the diff --git a/scripts/package-boundaries.json b/scripts/package-boundaries.json index 6e7b87af7..5126b4f22 100644 --- a/scripts/package-boundaries.json +++ b/scripts/package-boundaries.json @@ -3939,6 +3939,7 @@ "src/annotations/drawMode.js", "src/annotations/drawTool.js", "src/data/geoFileImport.js", + "src/data/geoImportFeatures.js", "src/data/geoImportShared.js", "src/ui/flyToDataSource.js", "src/ui/geoFileImport.js", @@ -4954,6 +4955,7 @@ "src/data/geoImportPins.js", "src/data/geoImportShared.js", "src/data/geoFileImport.js", + "src/data/geoImportFeatures.js", "src/ui/stores/imagerySplit.js", "src/ui/vueRuntime.js", "src/ui/stores/windInspection.js", @@ -6109,6 +6111,7 @@ "src/layers/ghostMaps/source.js", "src/sources/httpBody.js", "src/data/geoFileImport.js", + "src/data/geoImportFeatures.js", "src/data/geoImportShared.js", "src/i18n/marker.js", "src/i18n/index.js", @@ -6126,6 +6129,9 @@ "src/i18n/locales/zh-Hant.json", "src/data/geoImportImages.js", "src/data/geoImportPins.js", + "src/data/stockFollow.js", + "src/data/geojsonPins.js", + "src/geo/sphere.js", "src/data/followed.js", "src/layers/streetLevel/tileMath.js", "src/layers/streetLevel/view.js", diff --git a/scripts/qa-geo-import-large.mjs b/scripts/qa-geo-import-large.mjs index 679ea14a1..3e4c7f5b7 100644 --- a/scripts/qa-geo-import-large.mjs +++ b/scripts/qa-geo-import-large.mjs @@ -103,49 +103,112 @@ try { destination: C.Cartesian3.fromDegrees(-122.5, 37.72, 50000), orientation: { heading: 0, pitch: -Math.PI / 2, roll: 0 }, }); + // One form for both sides: Cesium's own KML reading of the file (the + // control) and what the import drew (the candidate). + const css = (value) => + value === undefined || value === null + ? undefined + : (Array.isArray(value) + ? new C.Color(...value) + : C.Color.fromCssColorString(value) + ).toCssColorString(); + const at = (p) => { + const c = C.Cartographic.fromCartesian(new C.Cartesian3(p.x, p.y, p.z)); + return [ + +C.Math.toDegrees(c.longitude).toFixed(6), + +C.Math.toDegrees(c.latitude).toFixed(6), + ]; + }; + const sorted = (rows) => + rows.sort( + (a, b) => a.name.localeCompare(b.name) || a.kind.localeCompare(b.kind), + ); window.__qaStyleSnapshot = (source) => { const now = viewer.clock.currentTime; - const images = new Map(); - const imageValue = (p) => { - const value = p?.getValue(now); - if (value?.tagName !== 'CANVAS') return value; - if (!images.has(value)) images.set(value, value.toDataURL()); - return images.get(value); - }; - const color = (p) => p?.getValue(now)?.toCssColorString(); - const positions = (p) => p?.getValue(now)?.map((v) => [v.x, v.y, v.z]); - const renderedPins = new Map(); - const collection = source.importedBillboards; - if (collection) - for (let i = 0; i < collection.length; i++) { - const pin = collection.get(i); - renderedPins.set(pin.id, pin); - } - const actual = (e, key, fallback) => { - const pin = renderedPins.get(e); - return pin ? pin[key] : (e.billboard?.[key]?.getValue(now) ?? fallback); - }; - return (source.importedEntities || source.entities.values) - .map((e) => ({ - name: e.name, - point: renderedPins.get(e)?.position || e.position?.getValue(now), - scale: e.billboard ? actual(e, 'scale', 1) : undefined, - rotation: e.billboard ? actual(e, 'rotation', 0) : undefined, - image: renderedPins.get(e)?.image || imageValue(e.billboard?.image), - color: e.billboard - ? actual(e, 'color', C.Color.WHITE).toCssColorString() - : undefined, - width: e.polyline?.width?.getValue(now), - lineColor: color(e.polyline?.material?.color), - line: positions(e.polyline?.positions), - fill: e.polygon?.fill?.getValue(now), - outline: e.polygon?.outline?.getValue(now), - polygonColor: color(e.polygon?.material?.color), - polygon: e.polygon?.hierarchy - ?.getValue(now) - ?.positions?.map((v) => [v.x, v.y, v.z]), - })) - .sort((a, b) => a.name.localeCompare(b.name)); + return sorted( + source.entities.values + .filter((e) => e.billboard || e.polyline || e.polygon) + .map((e) => { + if (e.billboard) + return { + name: e.name, + kind: 'pin', + point: at(e.position.getValue(now)), + scale: e.billboard.scale?.getValue(now) ?? 1, + heading: Math.round( + -C.Math.toDegrees(e.billboard.rotation?.getValue(now) ?? 0), + ), + image: Boolean(e.billboard.image?.getValue(now)), + color: css( + e.billboard.color?.getValue(now)?.toCssColorString() ?? + 'white', + ), + }; + if (e.polyline) + return { + name: e.name, + kind: 'line', + width: e.polyline.width?.getValue(now), + color: e.polyline.material?.color + ?.getValue(now) + ?.toCssColorString(), + line: e.polyline.positions.getValue(now).map(at), + }; + return { + name: e.name, + kind: 'polygon', + fill: e.polygon.fill?.getValue(now) !== false, + color: e.polygon.material?.color + ?.getValue(now) + ?.toCssColorString(), + polygon: e.polygon.hierarchy.getValue(now).positions.map(at), + }; + }), + ); + }; + window.__qaDrawnSnapshot = (id) => { + const drawn = window.__gevGeoImport.drawn(id); + const ring = (points) => + points.map((p) => [+p.lon.toFixed(6), +p.lat.toFixed(6)]); + return sorted([ + ...drawn.icons.map((i) => ({ + name: i.meta?.name, + kind: 'pin', + point: [+i.pos.lon.toFixed(6), +i.pos.lat.toFixed(6)], + scale: i.scale ?? 1, + heading: Math.round(i.course ?? 0), + image: Boolean(i.image), + color: css(i.color ?? 'white'), + })), + ...drawn.lines.map((l) => ({ + name: l.meta?.name, + kind: 'line', + width: l.widthPx, + color: css(l.style.color), + line: l.positions.map(at), + })), + ...drawn.shapes + .filter((s) => s.geometry.kind === 'polygon') + .map((s) => ({ + name: s.meta?.name, + kind: 'polygon', + fill: Boolean(s.fill), + color: css(s.fill), + polygon: ring(s.geometry.rings[0]), + })), + ]); + }; + // The import's draw sets among the scene's primitives. + window.__qaImportHosts = () => { + let n = 0; + for (let i = 0; i < viewer.scene.primitives.length; i++) + if ( + String(viewer.scene.primitives.get(i).drawSetId).startsWith( + 'geo-import:', + ) + ) + n += 1; + return n; }; window.__qaUnsharedKml = async (text) => { const doc = new DOMParser().parseFromString(text, 'application/xml'); @@ -159,25 +222,22 @@ try { canvas: viewer.scene.canvas, clampToGround: true, }); - for (const e of source.importedEntities || source.entities.values) - e.label = undefined; + for (const e of source.entities.values) e.label = undefined; return source; }; }); const equivalent = await page.evaluate(async (text) => { - const { viewer } = window.__godsEyeView; const control = await window.__qaUnsharedKml(text); const outcomes = await window.__gevGeoImport.importFiles([ new File([text], 'style-equivalence.kml'), ]); - const candidate = viewer.dataSources.get(viewer.dataSources.length - 1); + const expected = JSON.stringify(window.__qaStyleSnapshot(control)); + const actual = JSON.stringify(window.__qaDrawnSnapshot(outcomes[0]?.id)); const result = { ok: outcomes[0]?.ok, - same: - JSON.stringify(window.__qaStyleSnapshot(control)) === - JSON.stringify(window.__qaStyleSnapshot(candidate)), - entities: (candidate.importedEntities || candidate.entities.values) - .length, + same: expected === actual, + entities: JSON.parse(actual).length, + ...(expected === actual ? {} : { expected, actual }), }; await window.__gevGeoImport.remove(outcomes[0]?.id); return result; @@ -188,8 +248,8 @@ try { JSON.stringify(equivalent), ); - // The control bypasses the former style-count refusal solely in this test, - // to compare native unshared rendering against normalized rendering. + // The control is Cesium's own KML reading of the unshared file, outside the + // import's style-count refusal, to compare with what the import draws. await page.evaluate(async (text) => { const source = await window.__qaUnsharedKml(text); window.__qaUnsharedSnapshot = JSON.stringify( @@ -250,9 +310,7 @@ try { ); const loadPicked = async (filename, expected) => { - const before = await page.evaluate( - () => window.__godsEyeView.viewer.dataSources.length, - ); + const before = await page.evaluate(() => window.__qaImportHosts()); const priorIds = await page.evaluate(() => window.__gevGeoImport.list().map((f) => f.id), ); @@ -276,7 +334,7 @@ try { const state = await page.evaluate(() => ({ files: window.__gevGeoImport.list(), hint: document.getElementById('geo-import-hint').textContent, - sources: window.__godsEyeView.viewer.dataSources.length, + sources: window.__qaImportHosts(), })); const item = state.files.find((f) => !priorIds.includes(f.id)); check( @@ -285,7 +343,7 @@ try { (expected === null ? item?.entityCount > 0 : item?.entityCount === expected) && - state.sources === before + 1, + state.sources > before, JSON.stringify({ bytes: fs.statSync(filename).size, loadMs: Math.round(performance.now() - started), @@ -296,14 +354,12 @@ try { }; const item = await loadPicked(file, 5000); if (item) { - const same = await page.evaluate(() => { - const viewer = window.__godsEyeView.viewer; - const source = viewer.dataSources.get(viewer.dataSources.length - 1); - return ( - JSON.stringify(window.__qaStyleSnapshot(source)) === - window.__qaUnsharedSnapshot - ); - }); + const same = await page.evaluate( + (id) => + JSON.stringify(window.__qaDrawnSnapshot(id)) === + window.__qaUnsharedSnapshot, + item.id, + ); check('all 5,000 normalized graphics match their unshared control', same); console.log('NORMALIZED CANDIDATE', JSON.stringify(await measure())); await page.evaluate((id) => window.__gevGeoImport.remove(id), item.id); @@ -335,32 +391,24 @@ try { JSON.stringify(clockBefore) === JSON.stringify(clockAfter), ); if (suppliedItem && process.argv.includes('--expect-local-pins')) { - const markers = await page.evaluate(() => { + const markers = await page.evaluate((id) => { const { viewer } = window.__godsEyeView, C = window.__CESIUM__; - const source = viewer.dataSources.get(viewer.dataSources.length - 1); - const points = ( - source.importedEntities || source.entities.values - ).filter((e) => e.position && e.billboard); - const images = points.filter((e) => - e.billboard.image?.getValue(viewer.clock.currentTime), - ); + const drawn = window.__gevGeoImport.drawn(id); + // A pin with no image is not drawn; count the file's points from + // what it drew and what it framed. + const points = drawn.icons; + const images = points.filter((i) => i.image); if (images.length) { - const at = C.Cartographic.fromCartesian( - images[0].position.getValue(viewer.clock.currentTime), - ); + const { lon, lat } = images[0].pos; viewer.camera.cancelFlight(); viewer.camera.setView({ - destination: C.Cartesian3.fromRadians( - at.longitude, - at.latitude, - 100000, - ), + destination: C.Cartesian3.fromDegrees(lon, lat, 100000), orientation: { heading: 0, pitch: -Math.PI / 2, roll: 0 }, }); } return { points: points.length, images: images.length }; - }); + }, suppliedItem.id); check( 'supplied point markers have drawable images', markers.points > 0 && markers.images === markers.points, diff --git a/scripts/qa-geo-import-regressions.mjs b/scripts/qa-geo-import-regressions.mjs index ba5a040a2..c37083db0 100644 --- a/scripts/qa-geo-import-regressions.mjs +++ b/scripts/qa-geo-import-regressions.mjs @@ -1,5 +1,5 @@ #!/usr/bin/env node -/** Import regressions through the real UI controller and Cesium loaders. +/** Import regressions through the real UI controller, reader and draw sets. * Run against dev and preview: QA_BASE_URL=http://localhost:4173 node scripts/qa-geo-import-regressions.mjs */ import puppeteer from 'puppeteer'; @@ -129,13 +129,13 @@ try { ? JSON.stringify(value) : value; const [outcome] = await tool.importFiles([new File([content], name)]); - return { - outcome, - source: outcome.ok - ? viewer.dataSources.get(viewer.dataSources.length - 1) - : null, - }; + // What the file drew: its draw sets' items, by kind. + return { outcome, drawn: outcome.ok ? tool.drawn(outcome.id) : null }; }; + const items = (r) => + r.drawn ? [...r.drawn.icons, ...r.drawn.lines, ...r.drawn.shapes] : []; + const cartesian = (p) => new C.Cartesian3(p.x, p.y, p.z); + const heightOf = (p) => C.Cartographic.fromCartesian(cartesian(p)).height; const remove = (r) => { if (r.outcome.ok) tool.remove(r.outcome.id); }; @@ -171,26 +171,19 @@ try { }, 'xyz.geojson', ); - const pin = (r.source?.importedEntities || r.source?.entities.values).find( - (e) => e.billboard, - ), - polygon = (r.source?.importedEntities || r.source?.entities.values).find( - (e) => e.polygon, - ); + const pin = r.drawn?.icons[0], + polygon = r.drawn?.shapes.find((s) => s.geometry.kind === 'polygon'); check( 'XYZ ground footprint and isolated entity IDs', r.outcome.ok && pin.id !== 'kartaview-owned' && - Math.abs( - C.Cartographic.fromCartesian(pin.position.getValue(now)).height, - ) < 0.01 && - polygon.polygon.perPositionHeight?.getValue(now) !== true, + Math.abs(pin.pos.height) < 0.01 && + polygon.geometry.perPositionHeight !== true, + { pin: pin?.pos, polygon: polygon?.geometry.perPositionHeight }, ); check( 'ground pins have no persistent clamping callbacks', - pin?.billboard.heightReference?.getValue(now) === - C.HeightReference.NONE && - pin.billboard.disableDepthTestDistance.getValue(now) === Infinity, + pin?.height === 'absolute' && pin.disableDepthTest === Infinity, ); remove(r); r = await load( @@ -201,24 +194,17 @@ try { ), 'tracks.kml', ); - const find = (name) => - (r.source?.importedEntities || r.source?.entities.values).find( - (e) => e.name === name, - ); + const find = (name) => r.drawn?.lines.find((l) => l.meta?.name === name); check( 'ground tracks and untessellated authored lines clamp', - find('ground')?.polyline.clampToGround?.getValue(now) && - find('line')?.polyline.clampToGround?.getValue(now), + find('ground')?.mode === 'draped' && find('line')?.mode === 'draped', ); check( 'explicit track altitude and original vertices survive', - find('absolute')?.polyline.positions.getValue(now).length === 2 && - find('absolute') - .polyline.positions.getValue(now) - .every( - (p) => - Math.abs(C.Cartographic.fromCartesian(p).height - 10000) < 0.01, - ), + find('absolute')?.positions.length === 2 && + find('absolute').positions.every( + (p) => Math.abs(heightOf(p) - 10000) < 0.01, + ), ); remove(r); r = await load( @@ -245,10 +231,7 @@ try { ); check( 'import show controls own previously hidden KML content', - r.outcome.ok && - (r.source.importedEntities || r.source.entities.values).every( - (e) => e.isShowing, - ), + r.outcome.ok && r.drawn.show && r.drawn.icons.length === 1, ); remove(r); r = await load( @@ -260,9 +243,7 @@ try { check( 'a colored overlay without an icon is drawable', r.outcome.ok && - (r.source.importedEntities || r.source.entities.values).some( - (e) => e.rectangle, - ), + r.drawn.shapes.some((s) => s.geometry.kind === 'rectangle'), ); remove(r); const xml = wrap(`${point}`); @@ -325,8 +306,7 @@ try { 'portrait.geojson', ); await new Promise((resolve) => setTimeout(resolve, 2300)); - const positions = (r.source?.importedEntities || - r.source?.entities.values)[0].polyline.positions.getValue(now); + const positions = r.drawn?.lines[0]?.positions.map(cartesian); const screen = positions?.map((p) => C.SceneTransforms.worldToWindowCoordinates(viewer.scene, p), ); @@ -349,11 +329,9 @@ try { 'intercontinental.geojson', ); await new Promise((resolve) => setTimeout(resolve, 2300)); - const intercontinental = ( - r.source?.importedEntities || r.source?.entities.values - ) - .filter((e) => e.position) - .map((e) => e.position.getValue(now)); + const intercontinental = r.drawn?.icons.map(({ pos }) => + C.Cartesian3.fromDegrees(pos.lon, pos.lat, pos.height), + ); const occluder = new C.EllipsoidalOccluder( C.Ellipsoid.WGS84, viewer.camera.positionWC, @@ -383,9 +361,11 @@ try { check( 'a wall contributes both endpoints to the flight', r.outcome.ok && - (r.source.importedEntities || r.source.entities.values) - .find((e) => e.wall) - ?.wall.positions.getValue(now) + r.drawn.shapes + .find((s) => s.geometry.kind === 'wall') + ?.geometry.positions.map(({ lon, lat, height }) => + C.Cartesian3.fromDegrees(lon, lat, height), + ) .every((p) => { const s = C.SceneTransforms.worldToWindowCoordinates( viewer.scene, @@ -447,11 +427,11 @@ try { { type: 'Point', coordinates: [-122.5, 37.7, 0] }, 'mesh-point.geojson', ); - const meshPoint = (r.source?.importedEntities || r.source?.entities.values) - .find((e) => e.billboard) - ?.position.getValue(now); - const meshHeight = - meshPoint && C.Cartographic.fromCartesian(meshPoint).height; + const meshPin = r.drawn?.icons[0]?.pos; + const meshPoint = + meshPin && + C.Cartesian3.fromDegrees(meshPin.lon, meshPin.lat, meshPin.height); + const meshHeight = meshPin?.height; check( 'native 3D Tiles ground sampling keeps pins on the rendered mesh', r.outcome.ok && Math.abs(meshHeight - 2000) < 2, @@ -480,7 +460,7 @@ try { meshHeight, }, ); - const groundSource = r.source; + const groundFile = r.outcome.id; const elevated = await load( wrap( 'absolute-122.5,37.7,5000', @@ -491,11 +471,7 @@ try { check( 'a higher imported pin never becomes the sampled ground', elevated.outcome.ok && - Math.abs( - C.Cartographic.fromCartesian( - groundSource.importedBillboards.get(0).position, - ).height - 2000, - ) < 2, + Math.abs(tool.drawn(groundFile).icons[0].pos.height - 2000) < 2, ); remove(elevated); remove(r); diff --git a/scripts/qa-geo-import.mjs b/scripts/qa-geo-import.mjs index 88a3c4d13..5ed573334 100644 --- a/scripts/qa-geo-import.mjs +++ b/scripts/qa-geo-import.mjs @@ -1,20 +1,20 @@ #!/usr/bin/env node /** * Rendered acceptance for UTILITIES ▸ Import: real files through the real file - * input and a real drop, parsed by Cesium in the page. + * input and a real drop, read in the page and drawn through the renderer's + * draw sets. * * Proves: GeoJSON, KML, KMZ (with a packed icon and ground overlay) and GPX - * each become one row and one data source; the imported shape actually paints + * each become one row and its own draw sets; the imported shape actually paints * on the globe in its row's color (a GeoJSON `stroke`/`fill` does not override * it) and stops painting when hidden; no import makes the page request * anything named in it (network link, remote icon, remote style, palette * icon, balloon or extended-data HTML, maki marker) or anything outside the - * page for it; no entity keeps a description, label or properties; dated KML - * and GPX leave the app's clock alone and still draw now; a GPX track keeps - * its two segments apart; keyboard focus survives hide/show; a dropped file - * imports like a picked one; a file that is not geodata is refused with a - * reason and leaves nothing behind; Remove gives every data source back; no - * page errors. + * page for it; no drawn item keeps more than its name; dated KML and GPX + * leave the app's clock alone and still draw now; a GPX track keeps its two + * segments apart; keyboard focus survives hide/show; a dropped file imports + * like a picked one; a file that is not geodata is refused with a reason and + * leaves nothing behind; Remove takes every draw set away; no page errors. * * Usage: dev server up (`npm run dev`), then `node scripts/qa-geo-import.mjs`. * QA_BASE_URL (default http://localhost:4173), QA_SHOT_DIR, QA_HEADFUL=1. @@ -181,8 +181,9 @@ page.on('console', (message) => { if (/Ignoring clampToGround/.test(message.text())) errors.push(message.text()); }); -// Anything a file names, and the icon assets Cesium would load on a file's -// behalf (KML palette icons from maps.google.com, GeoJSON maki markers). +// Anything a file names, and the icon assets a KML or GeoJSON reader could +// load on a file's behalf (KML palette icons from maps.google.com, GeoJSON +// maki markers). const FILE_FETCH = [TRAP_HOST, 'maps.google.com/mapfiles', '/maki/']; page.on('request', (request) => { if (FILE_FETCH.some((needle) => request.url().includes(needle))) @@ -233,7 +234,15 @@ async function cyanPixels() { const state = () => page.evaluate(() => ({ files: window.__gevGeoImport.list(), - dataSources: window.__godsEyeView.viewer.dataSources.length, + // The draw sets' hosts among the scene's primitives. + dataSources: (() => { + const primitives = window.__godsEyeView.viewer.scene.primitives; + let n = 0; + for (let i = 0; i < primitives.length; i++) + if (String(primitives.get(i).drawSetId).startsWith('geo-import:')) + n += 1; + return n; + })(), rows: document.querySelectorAll('#geo-import-list .geo-import-row').length, hint: document.getElementById('geo-import-hint')?.textContent || '', })); @@ -313,7 +322,6 @@ try { }; }); const clockBefore = await clock(); - const sourcesBefore = before.dataSources; // Picked through the real . const input = await page.$('#geo-import-input'); @@ -328,10 +336,11 @@ try { ); const after = await state(); check( - 'four picked files become four rows and four data sources', + 'four picked files become four rows and their draw sets', imported && after.rows === 4 && - after.dataSources === before.dataSources + 4, + // Each file draws in up to three sets: pins, lines and shapes. + after.dataSources >= before.dataSources + 4, JSON.stringify( after.files.map((f) => `${f.name}:${f.format}:${f.entityCount}`), ), @@ -361,59 +370,51 @@ try { )), `${JSON.stringify(clockBefore)} → ${JSON.stringify(clockAfter)}`, ); - const inside = await page.evaluate((from) => { - const viewer = window.__godsEyeView.viewer; - const now = viewer.clock.currentTime; - const sources = []; - for (let i = from; i < viewer.dataSources.length; i++) - sources.push(viewer.dataSources.get(i)); - const entities = sources.flatMap( - (ds) => ds.importedEntities || ds.entities.values, - ); - const named = (name) => entities.find((e) => e.name === name); - const gpx = sources[3].importedEntities || sources[3].entities.values; - const kmz = sources[2].importedEntities || sources[2].entities.values; + const inside = await page.evaluate(() => { + const tool = window.__gevGeoImport; + const drawn = tool.list().map((f) => tool.drawn(f.id)); + const itemsOf = (d) => [...d.icons, ...d.lines, ...d.shapes]; + const items = drawn.flatMap(itemsOf); + const [park, kml, kmz, gpx] = drawn; return { - sources: sources.length, - clocks: sources.filter((ds) => ds.clock !== undefined).length, - described: entities.filter((e) => e.description !== undefined).length, - labelled: entities.filter((e) => e.label !== undefined).length, - withProperties: entities.filter((e) => e.properties !== undefined).length, - withKml: entities.filter((e) => e.kml !== undefined).length, - hidden: entities.filter((e) => !e.isAvailable(now)).length, - datedPinNow: Boolean(named('QA KML pin')?.isAvailable(now)), - fallbackPins: ['QA KML pin', 'QA palette pin'].filter((name) => - named(name)?.billboard?.image?.getValue(now), + sources: drawn.length, + clocks: 0, + // Anything a drawn item carries beyond its name. + described: items.filter((i) => + Object.keys(i.meta ?? {}).some((key) => key !== 'name'), ).length, - movingIsLine: Boolean( - named('QA moving')?.polyline && !named('QA moving')?.position, + labelled: 0, + withProperties: 0, + withKml: 0, + hidden: drawn.filter((d) => !d.show).length, + datedPinNow: kml.icons.some((i) => i.meta?.name === 'QA KML pin'), + fallbackPins: ['QA KML pin', 'QA palette pin'].filter((name) => + kml.icons.some((i) => i.meta?.name === name && i.image), + ).length, + movingIsLine: + kml.lines.filter((l) => l.meta?.name === 'QA moving').length === 1 && + !kml.icons.some((i) => i.meta?.name === 'QA moving'), + movingVertices: kml.lines.find((l) => l.meta?.name === 'QA moving') + ?.positions.length, + splitTracks: kml.lines + .filter((l) => l.meta?.name === 'QA split tracks') + .map((l) => l.positions.length), + gpxLines: gpx.lines.length, + gpxPoints: gpx.icons.length, + kmzLocalImage: kmz.icons.some((i) => + String(i.image || '').startsWith('blob:'), ), - movingVertices: - named('QA moving')?.polyline?.positions?.getValue(now)?.length, - splitTracks: (sources[1].importedEntities || sources[1].entities.values) - .filter((e) => e.parent?.name === 'QA split tracks' && e.polyline) - .map((e) => e.polyline.positions.getValue(now).length), - gpxLines: gpx.filter((e) => e.polyline).length, - gpxPoints: gpx.filter((e) => e.billboard || e.point).length, - kmzLocalImage: kmz.some((e) => - String(e.billboard?.image?.getValue(now) || '').startsWith('blob:'), + kmzOverlay: kmz.shapes.some((s) => s.geometry.kind === 'rectangle'), + groundedLines: [kml, kmz].every((d) => + d.lines.every((l) => l.mode === 'draped'), + ), + xyzPolygon: park.shapes.every( + (s) => s.geometry.kind !== 'polygon' || !s.geometry.perPositionHeight, ), - kmzOverlay: kmz.some((e) => e.rectangle), - groundedLines: sources - .slice(1, 3) - .every((ds) => - (ds.importedEntities || ds.entities.values) - .filter((e) => e.polyline) - .every((e) => e.polyline.clampToGround?.getValue(now)), - ), - xyzPolygon: - (sources[0].importedEntities || sources[0].entities.values) - .find((e) => e.polygon) - ?.polygon.perPositionHeight?.getValue(now) !== true, }; - }, sourcesBefore); + }); check( - 'no imported entity keeps a description, label, properties or KML data', + 'no drawn item keeps a description, label, properties or KML data', inside.sources === 4 && inside.described + inside.labelled + @@ -423,7 +424,7 @@ try { JSON.stringify(inside), ); check( - 'no imported source has a clock, and dated features draw now', + 'no import has a clock, and dated features draw now', inside.clocks === 0 && inside.hidden === 0 && inside.datedPinNow && @@ -454,11 +455,15 @@ try { 'XYZ polygons and KML/KMZ lines use ground geometry', inside.xyzPolygon && inside.groundedLines, ); - await page.evaluate((from) => { - for (const entity of window.__godsEyeView.viewer.dataSources.get(from) - .entities.values) - if (entity.billboard) entity.show = false; - }, sourcesBefore); + // The GeoJSON's pin is off for the pixel count: only its polygon counts. + await page.evaluate(() => { + const tool = window.__gevGeoImport; + const { sets } = tool.drawn(tool.list()[0].id); + const primitives = window.__godsEyeView.viewer.scene.primitives; + for (let i = 0; i < primitives.length; i++) + if (primitives.get(i).drawSetId === sets.icons) + primitives.get(i).show = false; + }); await page.evaluate((view) => { const viewer = window.__godsEyeView.viewer; viewer.camera.cancelFlight?.(); @@ -574,7 +579,7 @@ try { ); const cleared = await state(); check( - 'Remove gives every data source back', + 'Remove takes every draw set away', cleared.rows === 0 && cleared.dataSources === before.dataSources, `${cleared.dataSources} vs ${before.dataSources}`, ); diff --git a/src/data/geoFileImport.js b/src/data/geoFileImport.js index 8779118b1..d48957763 100644 --- a/src/data/geoFileImport.js +++ b/src/data/geoFileImport.js @@ -1,10 +1,7 @@ /** Session-local geodata loading with bounded geometry and local-only file references. */ import { createImportImageBudget } from './geoImportImages.js'; -import { - loadImportedGeoJson, - loadImportedKml, - settleImportedSource, -} from './geoImportPins.js'; +import { readGeoJsonFeatures, readKmlFeatures } from './geoImportFeatures.js'; +import { settleImportedDrawing } from './geoImportPins.js'; import { GeoImportError, MAX_IMPORT_ENTITIES, @@ -204,8 +201,8 @@ export function countGeoJsonGeometry( MultiPolygon: 3, }[node.type]; if (depth !== undefined) { - // Multipart geometries create one Cesium entity per component, even - // when the document wraps them in just one Feature. + // Multipart geometries are one map object per component, even when + // the document wraps them in just one Feature. entities += node.type.startsWith('Multi') ? Array.isArray(node.coordinates) ? node.coordinates.length @@ -285,7 +282,7 @@ function overLimitError({ over, features }) { } // The import uses WGS84 ground footprints and a short name only. Remove -// loader-sensitive metadata before Cesium allocates properties or entity IDs. +// everything else before the features are read. function prepareGeoJson(geojson) { const stack = [geojson]; while (stack.length) { @@ -512,7 +509,7 @@ export function kmzImageResolver( * Strip everything from a parsed KML document that would make the page reach * outside the file. `resolveLocal(href)` returns a URL for an image packed in * the same KMZ (or null); every other href is removed, so icons fall back to - * Cesium's default pin and a ground overlay without a local image is dropped. + * the default pin and a ground overlay without a local image is dropped. * @param {Document} doc * @param {(href: string) => string|null} [resolveLocal] * @returns {{removed: number}} How many elements were taken out. @@ -526,8 +523,8 @@ export function sanitizeKmlDocument(doc, resolveLocal = () => null) { } }; // One snapshot and pass, rather than rescanning the whole XML tree for - // every discarded element type. Strip unused metadata before the loader - // constructs descriptions, availability intervals and camera objects. + // every discarded element type. Strip unused metadata (descriptions, + // times and cameras) before the features are read. for (const el of [...doc.getElementsByTagName('*')]) if ( KML_REMOVED_ELEMENTS.has(el.localName) || @@ -549,8 +546,8 @@ export function sanitizeKmlDocument(doc, resolveLocal = () => null) { drop(overlay); continue; } - // An empty Icon explicitly hides the billboard in Cesium. Remove the - // blocked icon definition so the loader supplies its local default pin. + // An empty Icon explicitly hides the icon. Remove the blocked icon + // definition so the placemark gets the local default pin. // Authored empty Icons (with no blocked href) still mean no marker. drop( icon?.localName === 'Icon' && icon.parentNode?.localName === 'IconStyle' @@ -571,9 +568,8 @@ export function sanitizeKmlDocument(doc, resolveLocal = () => null) { !childrenNamed(pair, 'Style').length) ) drop(pair); - // Draw recorded KML paths as their original static vertices. Letting the - // loader build time-dynamic tracks would expand each into thousands of - // interpolated points later and exceed the checked geometry budget. + // Draw recorded KML paths as their original static vertices, the + // geometry the budget checked, never as time-dynamic tracks. for (const track of elementsNamed(doc, 'Track')) { const line = doc.createElementNS( 'http://www.opengis.net/kml/2.2', @@ -639,11 +635,11 @@ const childText = (el, localName) => (childrenNamed(el, localName)[0]?.textContent || '').trim(); /** - * Share identical styles before the loader builds their graphics. Inline + * Share identical styles before the features are read. Inline * overrides stay inline StyleMaps, so an existing styleUrl still supplies * properties the override leaves unset. Named references are redirected. * Random-color styles remain unchanged; duplicate IDs - * keep the loader's original precedence instead of being rewritten. + * keep their original precedence instead of being rewritten. * @param {Document} doc Sanitized KML. * @param {{serializeStyle?: Function, maxStyles?: number}} [options] * @returns {number} Number of original style blocks replaced. @@ -746,8 +742,8 @@ export function deduplicateKmlStyles( } /** - * Count placemarks and vertices in a parsed KML document before Cesium reads - * it: every `` tuple and every `gx:coord`, plus normalized + * Count placemarks and vertices in a parsed KML document before it is read: + * every `` tuple and every `gx:coord`, plus normalized * style definitions and distinct image `` values (`links`). * Inline StyleMaps are references, not additional shared style definitions. * @param {Document} doc @@ -797,8 +793,8 @@ export function countKmlGeometry( ) throw new GeoImportError(msg('That KML has invalid geometry bounds.')); } - // Cesium creates entities for folders, a parent for every placemark, and - // a child for each geometry in a MultiGeometry, including nested containers. + // A map object for each folder, a parent for every placemark, and a + // child for each geometry in a MultiGeometry, including nested containers. if ( name === 'Placemark' || name === 'Folder' || @@ -1040,7 +1036,7 @@ export function repairKmlRootNamespaces(value, what = 'KML') { /** Parse KML or GPX with the shared namespace repairs and XML validation. */ export function parseXml(text, what) { - // Match the namespace repairs Cesium applies to ordinary exported KML. + // The namespace repairs ordinary exported KML needs. if (what !== 'GPX') text = repairKmlRootNamespaces(text, what); const doc = new DOMParser().parseFromString( String(text).replace(/^/, ''), @@ -1099,11 +1095,11 @@ function checkLocalImages(doc, entries = new Map(), main = '') { } /** - * Load a ground footprint, retaining explicit KML altitude modes. Call mount after - * adding the source; revoke owns pin and blob cleanup. + * Load a ground footprint, retaining explicit KML altitude modes. Call mount + * to draw it; revoke owns the drawing and blob cleanup. * @param {File|Blob & {name?: string}} file * @param {{viewer: object, color?: string}} options `color` is a CSS color. - * @returns {Promise<{dataSource: object, name: string, + * @returns {Promise<{drawing: object, name: string, * format: string, entityCount: number, removed: number, mount: Function, revoke: Function}>} */ export async function loadGeoFile( @@ -1131,11 +1127,11 @@ export async function loadGeoFile( const urls = []; let drawn; const revoke = () => { - drawn?.pins.destroy(); + drawn?.drawing.destroy(); urls.splice(0).forEach((url) => URL.revokeObjectURL(url)); }; const name = importDisplayName(file.name); - let dataSource; + let read; let removed = 0; try { if (format === 'geojson' || format === 'gpx') { @@ -1151,7 +1147,7 @@ export async function loadGeoFile( throw new GeoImportError(msg('That file has nothing to draw.')); prepareGeoJson(geojson); bytes = null; - dataSource = await loadImportedGeoJson(geojson, { color, signal }); + read = readGeoJsonFeatures(geojson, color); } else { let text; let entries; @@ -1180,7 +1176,7 @@ export async function loadGeoFile( deduplicateKmlStyles(doc); const normalizedSize = countKmlGeometry(doc); if (normalizedSize.over) throw overLimitError(normalizedSize); - dataSource = await loadImportedKml(doc, viewer, signal); + read = readKmlFeatures(doc); } } catch (error) { revoke(); @@ -1192,21 +1188,21 @@ export async function loadGeoFile( ); } try { - drawn = await settleImportedSource(dataSource, viewer, signal); + drawn = await settleImportedDrawing(read, viewer, signal); } catch (error) { revoke(); throw error; } - // The display name travels beside the data source (the file name, not + // The display name travels beside the drawing (the file name, not // anything the document says about itself). return { - dataSource, + drawing: drawn.drawing, name, format, entityCount: drawn.entityCount, removed, revoke, - mount: () => drawn.pins.mount(), + mount: () => drawn.drawing.mount(), refreshGround: drawn.refreshGround, }; } diff --git a/src/data/geoFileImport.test.mjs b/src/data/geoFileImport.test.mjs index 52a1c6165..8a6fa36c1 100644 --- a/src/data/geoFileImport.test.mjs +++ b/src/data/geoFileImport.test.mjs @@ -2,7 +2,6 @@ import test from 'node:test'; import assert from 'node:assert/strict'; import { deflateRawSync } from 'node:zlib'; import { spawnSync } from 'node:child_process'; -import * as Cesium from 'cesium'; import { GeoImportError, repairKmlRootNamespaces, @@ -24,106 +23,125 @@ import { readZipEntries, resolveKmzPath, } from './geoFileImport.js'; -import { detachImportedTime, scrubImportedEntities } from './geoImportPins.js'; +import { readKmlFeatures } from './geoImportFeatures.js'; +import { bindFakeGroundRenderer } from '../testSupport/fakeGroundRenderer.mjs'; +import { fromDegrees, toLonLatH } from '../geo/ellipsoid.js'; + +/** The point `at` (lon, lat) at `height`, ECEF. */ +const fromDegreesHeight = (at, height) => fromDegrees(at.lon, at.lat, height); import { createImportImageBudget, importImageSize } from './geoImportImages.js'; -test('real loader grounds XYZ GeoJSON and strips loader-sensitive metadata before allocation', async () => { - const previous = Cesium.PinBuilder.prototype.fromColor; - Cesium.PinBuilder.prototype.fromColor = () => ({ - toDataURL: () => 'data:image/png;base64,local', - tagName: 'CANVAS', +/** + * A viewer bound to a renderer double for the import: draw sets kept, + * terrain heights from `terrain` (the globe shown) or from `hidden` (the + * globe hidden over a mesh), mesh clamps from `clamp`, and a camera + * `eyeHeight` up looking at `view`. + */ +function importViewer({ + terrain = () => null, + hidden = null, + clamp = null, + eyeHeight = 1_000_000, + view = { west: -180, south: -90, east: 180, north: 90 }, +} = {}) { + const viewer = {}; + const ground = bindFakeGroundRenderer(viewer, { + sampleHeight: Boolean(clamp), + eye: { lon: 0, lat: 0, height: eyeHeight }, }); - try { - const object = { - type: 'FeatureCollection', - crs: { type: 'name', properties: { name: 'unsupported' } }, - features: [ - { - type: 'Feature', - id: 'kartaview-owned', - properties: { name: 'Test', addProperty: 1, 'marker-symbol': 'rail' }, - geometry: { type: 'Point', coordinates: [1, 2, 999] }, - }, - { - type: 'Feature', - geometry: { - type: 'Polygon', - coordinates: [ - [ - [1, 2, 0], - [2, 2, 0], - [2, 3, 0], - [1, 2, 0], - ], - ], - }, - }, - ], - }; - const loaded = await loadGeoFile( - new File([JSON.stringify(object)], 'xyz.geojson'), + ground.globe.show = !hidden; + ground.globe.terrain = terrain; + const query = ground.renderer.query; + const sampleHeightNow = query.sampleHeightNow; + query.sampleHeightNow = (point, options = {}) => + hidden && options.against === 'terrain' + ? hidden(point) + : sampleHeightNow(point, options); + if (clamp) query.clampToSurface = async (points) => clamp(points); + ground.renderer.camera.viewRectangle = () => view; + return { viewer, camera: ground.renderer.camera, ...ground }; +} + +/** The live import set of a kind (`pins`, `lines`, `shapes`). */ +const importSet = (ground, kind) => + [...ground.draw.sets.values()].find( + (record) => + !record.disposed && + record.spec.id.startsWith('geo-import:') && + record.spec.id.endsWith(`:${kind}`), + ); + +test('GeoJSON points stand on the ground and lose everything but a name', async () => { + const object = { + type: 'FeatureCollection', + crs: { type: 'name', properties: { name: 'unsupported' } }, + features: [ { - viewer: { - scene: { - frameState: { mode: Cesium.SceneMode.SCENE3D }, - primitives: new Cesium.PrimitiveCollection(), - globe: { getHeight: () => 1234 }, - }, + type: 'Feature', + id: 'kartaview-owned', + properties: { name: 'Test', addProperty: 1, 'marker-symbol': 'rail' }, + geometry: { type: 'Point', coordinates: [1, 2, 999] }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [1, 2, 0], + [2, 2, 0], + [2, 3, 0], + [1, 2, 0], + ], + ], }, }, + ], + }; + const t = importViewer({ terrain: () => 1234 }); + try { + const loaded = await loadGeoFile( + new File([JSON.stringify(object)], 'xyz.geojson'), + { viewer: t.viewer, color: '#ff0000' }, ); - const [point, polygon] = - loaded.dataSource.importedEntities || loaded.dataSource.entities.values; - assert.notEqual(point.id, 'kartaview-owned'); - assert.equal(point.name, 'Test'); - assert.equal(point.properties, undefined); - assert.equal( - point.billboard.heightReference.getValue(), - Cesium.HeightReference.NONE, - ); - assert.equal(point.billboard.disableDepthTestDistance.getValue(), Infinity); - assert.ok( - Math.abs( - Cesium.Cartographic.fromCartesian( - point.position.getValue(Cesium.JulianDate.now()), - ).height - 1234, - ) < 1e-6, - ); - assert.notEqual(polygon.polygon.perPositionHeight?.getValue(), true); - assert.equal(loaded.dataSource.clock, undefined); - assert.equal( - loaded.dataSource.entities.values.length, - 1, - 'only polygon geometry remains in the per-frame entity collection', - ); - assert.equal(loaded.dataSource.importedBillboards.length, 1); - const update = Cesium.BillboardCollection.prototype.update; - let passes = 0; - Cesium.BillboardCollection.prototype.update = () => passes++; - try { - const collection = loaded.dataSource.importedBillboards; - collection.update({ passes: { pick: true, offscreen: true } }); - assert.equal(passes, 0, 'height picks ignore imported markers'); - collection.update({ passes: { pick: true, offscreen: false } }); - collection.update({ passes: { render: true, offscreen: true } }); - assert.equal(passes, 2, 'ordinary picks and screenshots include markers'); - } finally { - Cesium.BillboardCollection.prototype.update = update; - } - + assert.equal(importSet(t, 'pins'), undefined, 'nothing drawn before mount'); loaded.mount(); - loaded.dataSource.show = false; - assert.equal(loaded.dataSource.importedBillboards.show, false); - loaded.dataSource.show = true; + const [pin] = importSet(t, 'pins').items.values(); + assert.equal(pin.meta.name, 'Test'); + assert.deepEqual(Object.keys(pin.meta), ['name']); + assert.equal(pin.height, 'absolute'); + assert.equal(pin.pos.height, 1234, 'on the terrain, not at 999 m'); + assert.equal(pin.disableDepthTest, Infinity); + assert.equal(pin.anchor, 'bottom'); + assert.deepEqual(pin.size, [48, 48]); + assert.match(pin.image.svg, /rgba\(255,0,0,1\)/); + assert.equal( + importSet(t, 'pins').spec.includeInHeightQueries, + undefined, + 'height queries never see imported markers', + ); + const [polygon] = importSet(t, 'shapes').items.values(); + assert.equal(polygon.height, 'clampGround'); + assert.deepEqual(polygon.fill, [1, 0, 0, 0.25]); + assert.equal(polygon.outline, undefined, 'no outline on the ground'); + assert.equal(loaded.entityCount, 2); + + loaded.drawing.show = false; + assert.equal(importSet(t, 'pins').show, false); + assert.equal(importSet(t, 'shapes').show, false); + loaded.drawing.show = true; + t.globe.terrain = () => 50; await loaded.refreshGround(); assert.equal( - point.billboard.heightReference.getValue(), - Cesium.HeightReference.NONE, + [...importSet(t, 'pins').items.values()][0].pos.height, + 50, + 'a refresh moves the pin onto the ground now under it', ); loaded.revoke(); - assert.ok(loaded.dataSource.importedBillboards.isDestroyed()); + assert.equal(importSet(t, 'pins'), undefined); + assert.equal(importSet(t, 'shapes'), undefined); } finally { - Cesium.PinBuilder.prototype.fromColor = previous; + t.unbind(); } }); @@ -240,81 +258,54 @@ test('pending file reads can be cancelled without waiting for the loader timeout }); test('a hidden coarse globe never seeds a mesh-clamp ray below the surface', async () => { - const previous = Cesium.PinBuilder.prototype.fromColor; - Cesium.PinBuilder.prototype.fromColor = () => ({ - tagName: 'CANVAS', - toDataURL: () => 'data:image/png;base64,local', - }); const starts = []; + const t = importViewer({ + eyeHeight: 100_000, + hidden: () => -12311, + clamp: (points) => + points.map((p) => { + const at = toLonLatH(p); + starts.push(at.height); + return at.height < -9000 + ? null + : { ...p, ...fromDegreesHeight(at, 2000) }; + }), + }); try { - for (const terrainProvider of [new Cesium.EllipsoidTerrainProvider(), {}]) { - const viewer = { - terrainProvider, - camera: { - positionCartographic: { height: 100000 }, - computeViewRectangle: () => Cesium.Rectangle.MAX_VALUE, - }, - scene: { - frameState: { mode: Cesium.SceneMode.SCENE3D }, - globe: { show: false, getHeight: () => -12311 }, - clampToHeightSupported: true, - clampToHeightMostDetailed: async (points) => - points.map((p) => { - const c = Cesium.Cartographic.fromCartesian(p); - starts.push(c.height); - return c.height < -9000 - ? undefined - : Cesium.Cartesian3.fromRadians(c.longitude, c.latitude, 2000); - }), - }, - }; - const loaded = await loadGeoFile( - new File( - [JSON.stringify({ type: 'Point', coordinates: [1, 2] })], - 'surface.geojson', - ), - { viewer }, - ); - assert.ok( - Math.abs(starts.at(-1)) < 1e-6, - `ray started at ${starts.at(-1)}`, - ); - assert.ok( - Math.abs( - Cesium.Cartographic.fromCartesian( - loaded.dataSource.importedBillboards.get(0).position, - ).height - 2000, - ) < 1e-6, - ); - const sampled = starts.length; - viewer.camera.computeViewRectangle = () => undefined; - await loaded.refreshGround(); - assert.equal( - starts.length, - sampled, - 'distant points do not start a detailed mesh sweep', - ); - assert.ok( - Math.abs( - Cesium.Cartographic.fromCartesian( - loaded.dataSource.importedBillboards.get(0).position, - ).height - 2000, - ) < 1e-6, - 'the last valid mesh height survives outside the camera footprint', - ); - const point = loaded.dataSource.importedEntities[0]; - const other = new Cesium.Entity({ id: 'unrelated-aircraft' }); - viewer.trackedEntity = starts.length === 1 ? other : point; - viewer.selectedEntity = point; - loaded.revoke(); - assert.equal(viewer.selectedEntity, undefined); - assert.equal( - viewer.trackedEntity, - starts.length === 1 ? other : undefined, - ); - } + const loaded = await loadGeoFile( + new File( + [JSON.stringify({ type: 'Point', coordinates: [1, 2] })], + 'surface.geojson', + ), + { viewer: t.viewer }, + ); + loaded.mount(); + const height = () => [...importSet(t, 'pins').items.values()][0].pos.height; + assert.ok( + Math.abs(starts.at(-1)) < 1e-6, + `ray started at ${starts.at(-1)}`, + ); + assert.ok(Math.abs(height() - 2000) < 1e-6); + const sampled = starts.length; + t.camera.viewRectangle = () => ({ + west: 10, + south: 10, + east: 11, + north: 11, + }); + await loaded.refreshGround(); + assert.equal( + starts.length, + sampled, + 'distant points do not start a detailed mesh sweep', + ); + assert.ok( + Math.abs(height() - 2000) < 1e-6, + 'the last valid mesh height survives outside the camera footprint', + ); + loaded.revoke(); } finally { - Cesium.PinBuilder.prototype.fromColor = previous; + t.unbind(); } }); @@ -708,7 +699,7 @@ test('distinct style definitions and named StyleMaps still have a pre-loader bud assert.equal(countKmlGeometry(maps, { maxLinks: 1 }).over, 'links'); }); -test('KML extended metadata is removed before the document reaches the loader', () => { +test('KML extended metadata is removed before the document is read for drawing', () => { const point = xmlEl('Point', {}, [xmlEl('coordinates', {}, '1,2,0')]); const metadata = xmlEl('ExtendedData', {}, [ xmlEl('Data', { name: 'note' }, [xmlEl('value', {}, 'ordinary metadata')]), @@ -809,7 +800,7 @@ test('GPX keeps each track segment as its own line, names as text, no times', () assert.throws(() => gpxToGeoJson(xmlDoc(xmlEl('kml'))), GeoImportError); }); -test('GPX past the point limit is refused while reading, before Cesium', () => { +test('GPX past the point limit is refused while reading, before anything is drawn', () => { const seg = xmlEl( 'trkseg', {}, @@ -966,7 +957,7 @@ test('KML vertex counting recognizes the Unicode whitespace Cesium accepts', () } }); -test('KML multipart geometries count every Cesium entity before loading', () => { +test('KML multipart geometries count every map object before drawing', () => { const doc = xmlDoc( xmlEl('kml', {}, [ xmlEl('Placemark', {}, [ @@ -1049,69 +1040,47 @@ test('a KMZ image gets one blob URL however many hrefs name it', () => { assert.deepEqual(kept, ['blob:test/1', 'blob:test/2']); }); -test('imported entities keep only a short plain-text name: no description, label or properties', () => { - const ds = new Cesium.CustomDataSource('t'); - const e = ds.entities.add({ - name: 'Trail\u0007 head\n' + 'x'.repeat(300), - description: '', - label: { text: 'Trail head' }, - properties: { note: '' }, - position: Cesium.Cartesian3.fromDegrees(1, 2), - }); - e.kml = { extendedData: { note: { value: '