Keep the draw port's version when icons only change in place

The Cesium draw port's version tells height queries when the pick ids
they see through may have changed. Icons changed in place keep their
billboards and pick id objects (meta and LOD group are written into
them), so only icons added or removed change what queries see through.
An in-place icon update, such as the tracked aircraft's icon every
frame, no longer bumps the version, so the see-through cache is no
longer rebuilt each frame. Re-registering an atlas whose images change
in place keeps it too, and still rebuilds a set it cannot patch.
This commit is contained in:
Sameh Khamis committed 2026-11-07 20:25:15 -08:00
1 parent 6861632b96
commit 333c9b39fe
2 files changed
+52 -18

No files matched your search

+37 -17
View File
@@ -236,9 +236,14 @@ function flowTime(speed) {
return (cells - Math.floor(cells)) / speed;
}
/** What `syncIcons` did: icons added or removed, or only changed in place. */
const ICONS_CHANGED = 'changed';
const ICONS_KEPT = 'kept';
/**
* The draw port over `scene`, and what the other ports read of it: the live
* sets by id, a version that changes with them, the scene's 3D tilesets and
* sets by id, a version that changes with what height queries see through
* in them, the scene's 3D tilesets and
* the clamp-state watch the frame loop runs after each draw.
* @param {{scene: object, report: (error: unknown) => void,
* capabilities?: ReadonlySet<string>,
@@ -255,7 +260,9 @@ export function createCesiumDraw({
requestRender: requestFrame = null,
}) {
const sets = new Map();
// Bumped on every change to the sets or what they hold.
// Bumped whenever what height queries see through may have changed: a
// set made, rebuilt, restyled or gone, or items added or removed (icons
// changed in place keep their pick ids, so they do not bump it).
let setsVersion = 0;
// A viewer can be destroyed before the layers drawing on it
// let their sets go; those calls then have nothing left to do.
@@ -305,6 +312,12 @@ export function createCesiumDraw({
setsVersion += 1;
requestRender();
};
// Icons changed in place: height queries see through the sets' pick
// ids, which an icon keeps, so only icons added or gone change them.
const iconsPatched = (synced) => {
if (synced === ICONS_CHANGED) setsVersion += 1;
requestRender();
};
const handle = {
id: spec.id,
set(list) {
@@ -317,7 +330,8 @@ export function createCesiumDraw({
items.clear();
for (const item of list) items.set(item.id, item);
// Icons are changed where they are, when they can be.
if (syncIcons(record, items.keys(), true)) return patched();
const synced = syncIcons(record, items.keys(), true);
if (synced) return iconsPatched(synced);
rebuild();
requestRender();
},
@@ -343,13 +357,11 @@ export function createCesiumDraw({
return;
}
for (const item of list) items.set(item.id, item);
if (
syncIcons(
record,
list.map((item) => item.id),
)
)
return patched();
const synced = syncIcons(
record,
list.map((item) => item.id),
);
if (synced) return iconsPatched(synced);
rebuild();
requestRender();
},
@@ -359,7 +371,8 @@ export function createCesiumDraw({
record.gpu.drop(ids);
return patched();
}
if (syncIcons(record, [])) return patched();
const synced = syncIcons(record, []);
if (synced) return iconsPatched(synced);
rebuild();
requestRender();
},
@@ -369,7 +382,8 @@ export function createCesiumDraw({
record.gpu.sync();
return patched();
}
if (syncIcons(record, [])) return patched();
const synced = syncIcons(record, []);
if (synced) return iconsPatched(synced);
rebuild();
requestRender();
},
@@ -814,7 +828,8 @@ export function createCesiumDraw({
* than it draws, when it is emptied, and when a generated image under a
* key it has comes as a new canvas (its key's texture would not change).
* False, changing nothing, otherwise, and when the set has no live
* collection of its own.
* collection of its own. When done, `ICONS_CHANGED` if icons were added
* or removed (the set's pick ids changed), else `ICONS_KEPT`.
* @param {object} record
* @param {Iterable<string>} touched Ids of items that may have changed.
* @param {boolean} [reordered] The items were replaced, in a new order.
@@ -893,14 +908,18 @@ export function createCesiumDraw({
const ids = new Set([...gone].map((billboard) => billboard.id));
record.pickIds = record.pickIds.filter((id) => !ids.has(id));
}
let added = false;
for (const [id, item] of record.items) {
const image = images.get(id);
if (image === undefined) continue;
const entry = drawn.get(id);
if (entry) patchIcon(record, entry, item, image);
else addIcon(record, item, image);
else {
addIcon(record, item, image);
added = true;
}
}
return true;
return added || gone.size ? ICONS_CHANGED : ICONS_KEPT;
}
function buildPoints(record) {
@@ -2254,8 +2273,9 @@ export function createCesiumDraw({
const drawing = [];
for (const [itemId, item] of record.items)
if (item.image?.atlas === id) drawing.push(itemId);
if (syncIcons(record, drawing)) setsVersion += 1;
else record.rebuild();
const synced = syncIcons(record, drawing);
if (!synced) record.rebuild();
else if (synced === ICONS_CHANGED) setsVersion += 1;
changed = true;
}
if (changed) scene.requestRender();
+15 -1
View File
@@ -1970,7 +1970,11 @@ test('icon sets change their billboards in place: restyled, moved, re-imaged, ad
assert.deepEqual(a.id.meta, { n: 1 }, 'picks read the new meta');
const moved = Cesium.Cartographic.fromCartesian(a.position);
assert.ok(Math.abs(Cesium.Math.toDegrees(moved.longitude) - 2) < 1e-9);
assert.ok(part.version() > version, 'height queries see the change');
assert.equal(
part.version(),
version,
'changed in place, the pick ids height queries see through are the same',
);
// Back to the defaults it dropped.
set.upsert([icon('a', 2)]);
@@ -1980,9 +1984,12 @@ test('icon sets change their billboards in place: restyled, moved, re-imaged, ad
set.upsert([icon('c', 3)]);
assert.equal(scene.added[0], host, 'a new icon is added to it');
assert.equal(host.length, 3);
const added = part.version();
assert.ok(added > version, 'a new pick id for height queries to see');
set.remove(['b']);
assert.equal(scene.added[0], host, 'and one removed from it');
assert.equal(host.length, 2);
assert.ok(part.version() > added, 'and one gone');
assert.deepEqual(
record.pickIds.map((id) => id.id).sort(),
['a', 'c'],
@@ -2035,8 +2042,15 @@ test('an icon drawn from an atlas slot takes a re-registered slot in place', ()
assert.equal(host.get(0), one, 'the same billboard');
assert.equal(one.image, 'next.png');
assert.equal(host.get(1).image, 'ring.png', 'the slot that came draws');
const version = part.version();
part.port.atlas('marks', { dot: 'again.png', ring: 'ring.png' });
assert.equal(scene.added[0], host, 'new images only: not rebuilt');
assert.equal(host.get(0), one, 'the same billboard');
assert.equal(one.image, 'again.png');
assert.equal(part.version(), version, 'the same pick ids');
part.port.atlas('marks', { ring: 'ring.png' });
assert.equal(host.length, 1, 'a slot gone takes its icon down');
assert.ok(part.version() > version, 'one pick id fewer');
assert.equal(host.get(0).id.id, 'two');
// A slot that comes for an icon ahead of one drawn rebuilds, in order.
part.port.atlas('marks', { dot: 'dot.png', ring: 'ring.png' });