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,