render: Cesium draws raster-shell fields; weather shells use the draw port

The Cesium draw port now implements draw.field for the rasterShell kind
and advertises the 'fields' capability. The shell surface (a raised
rectangle with a detail window, drawn in primitive order without depth
writes) moves from the weather layer into src/render/cesium/drawFields.js.
A new rectangle or height is drawn invisibly first and swapped in whole,
and 'drawn' is told in the frame of the swap. A stage of older content
never replaces the drawn one while newer content decodes. A field hidden
mid-stage keeps building it.

The weather shell (src/layers/weather/shellRendering.js) now drives one
field through the draw, camera, frame and globe ports and no longer
imports Cesium, so it leaves the Cesium allow list. The wind shell on
photoreal hosts also draws through draw.field. The conformance page runs
each visual scene on its own, so a kind the Cesium renderer does not draw
yet (scalarRaster) fails only its own scene.
This commit is contained in:
Sameh Khamis committed 2026-11-09 07:02:54 -08:00
1 parent 4fc7d66639
commit 50cb7bd5f4
16 files changed
+1765 -761

No files matched your search

+21 -2
View File
@@ -40,6 +40,7 @@ import { createGpuIcons, GPU_ICON_CAPABILITIES } from './gpuIcons.js';
import { createModelSets } from './drawModels.js';
import { createMeshSets } from './drawMeshes.js';
import { createQuadSets } from './drawQuads.js';
import { createCesiumFields } from './drawFields.js';
/** The contract's colour as Cesium's. */
export function toColor(color, alpha = 1) {
@@ -358,6 +359,8 @@ export function createCesiumDraw({
requestRender: requestFrame = null,
}) {
const sets = new Map();
// Fields share the sets' ids.
const fieldPart = createCesiumFields({ scene, report });
let setSeq = 0;
// Bumped whenever what height queries see through may have changed: a
// set made, rebuilt, restyled or gone, or items added or removed (icons
@@ -371,7 +374,8 @@ export function createCesiumDraw({
};
function makeSet(kind, spec, build) {
if (sets.has(spec.id)) throw new Error(`a set with id ${spec.id} is live`);
if (sets.has(spec.id) || fieldPart.has(spec.id))
throw new Error(`a set with id ${spec.id} is live`);
const items = new Map();
const listeners = {
ready: listenerList(report),
@@ -3868,6 +3872,15 @@ export function createCesiumDraw({
makeSet('quads', { ...spec }, (record) => quadSets.build(record)),
meshes: (spec) =>
makeSet('meshes', { ...spec }, (record) => meshSets.build(record)),
...(capabilities.has('fields')
? {
field(spec) {
if (sets.has(spec?.id))
throw new Error(`a set with id ${spec.id} is live`);
return fieldPart.field(spec);
},
}
: {}),
clampState,
on(event, cb) {
if (event !== 'clampState') return () => {};
@@ -3950,6 +3963,8 @@ export function createCesiumDraw({
*/
dispose({ removeHosts = false } = {}) {
clampListeners.clear();
// Fields go with the port, and their frame listeners with them.
fieldPart.dispose();
// Late model loads find no host and destroy themselves.
for (const record of sets.values()) {
if (removeHosts && !scene.isDestroyed?.()) {
@@ -3989,7 +4004,11 @@ provideUnboundDraw((viewer) => {
typeof scene.requestRender !== 'function'
)
return null;
const part = createCesiumDraw({ scene, report: uncaught });
const part = createCesiumDraw({
scene,
report: uncaught,
capabilities: new Set([...GPU_ICON_CAPABILITIES, 'fields']),
});
unboundParts.set(part.port, part);
const offs = [
scene.preRender?.addEventListener?.(() => part.beforeRender()),
+644
View File
@@ -0,0 +1,644 @@
/**
* @module render/cesium/drawFields
* @description The Cesium draw port's `field` handles. It draws one kind:
* `rasterShell`, a raster on a rectangle raised above the ellipsoid, drawn
* flat in the opaque pass in the scene's primitive order (ascending height),
* alpha-blended, without depth writes and never picked. Other kinds are
* refused loudly.
*
* Choices the contract leaves open, taken conservatively:
* - An image is read when it is first named, as a Cesium material reads
* one: to show new pixels, name another canvas. URL, SVG and blob images
* are decoded before they are handed over, so the frame they replace
* stays until they can be drawn; atlas slots are refused.
* - An `update` of `image` alone, inside the same rectangle and height,
* swaps the texture on the drawn surface: Cesium keeps drawing the old
* one until the new one is uploaded. A new `rectangle` or `heightM` is
* built as a second surface, drawn invisibly until its geometry and
* images are ready, and then takes the first one's place in one frame.
* - A `detail` in a new rectangle shows the full image there until the
* detail image has drawn, never the old detail at the new place; one in
* the same rectangle swaps only the image, the old one drawing until the
* new is uploaded.
* - `liftM` scales the shell about the Earth's centre, so every shell
* rises alike and keeps its order.
*/
import * as Cesium from 'cesium';
import { listenerList, uncaught } from './common.js';
const MATERIAL_TYPE = 'DrawRasterShell';
// Renders after an image swap: one queues the upload, one uploads and draws, one spare.
const UPLOAD_FRAMES = 3;
// An empty detail window: the full-extent image shows everywhere.
const NO_WINDOW = Object.freeze({ west: 0, south: 0, east: -1, north: -1 });
const shellHeights = new WeakMap();
// Cesium binds a 1×1 white texture to an image uniform until its first upload:
// draw nothing until the full-extent image has arrived, and sample the detail
// image only once it has arrived. The window is west, south, east, north in the
// full-extent image's texture coordinates.
const MATERIAL_SOURCE = `czm_material czm_getMaterial(czm_materialInput materialInput)
{
czm_material material = czm_getDefaultMaterial(materialInput);
vec2 st = materialInput.st;
vec4 coarse = texture(image, st);
vec2 dst = (st - window.xy) / max(window.zw - window.xy, vec2(1e-6));
float inside = float(all(greaterThanEqual(st, window.xy)) && all(lessThanEqual(st, window.zw)));
float useDetail = inside * step(1.5, float(detailDimensions.x));
vec4 c = mix(coarse, texture(detail, clamp(dst, 0.0, 1.0)), useDetail);
material.diffuse = czm_gammaCorrect(c.rgb);
material.alpha = c.a * alpha * step(1.5, float(imageDimensions.x));
return material;
}
`;
function registerMaterial(cesium) {
const cache = cesium.Material._materialCache;
if (cache.getMaterial(MATERIAL_TYPE)) return;
// A plain template: building the first material from a fabric would make that
// instance Cesium's shared template and keep its last image alive.
cache.addMaterial(MATERIAL_TYPE, {
fabric: {
type: MATERIAL_TYPE,
uniforms: {
image: cesium.Material.DefaultImageId,
detail: cesium.Material.DefaultImageId,
alpha: 1,
window: { type: 'vec4', x: 0, y: 0, z: -1, w: -1 },
},
// Diffuse and alpha share these samples, so one source, not components.
source: MATERIAL_SOURCE,
},
translucent: false,
});
}
const sameEdges = (a, b) =>
a.west === b.west &&
a.south === b.south &&
a.east === b.east &&
a.north === b.north;
/** Keep raster shells first in the primitive collection, in ascending height:
* higher shells draw over lower ones and other opaque content draws over both. */
export function orderShells(primitives, primitive, height) {
shellHeights.set(primitive, height);
if (typeof primitives.lowerToBottom !== 'function') return;
const shells = [];
for (let i = 0; i < primitives.length; i++) {
const item = primitives.get(i);
if (shellHeights.has(item)) shells.push(item);
}
const ordered = [...shells].sort(
(a, b) => shellHeights.get(a) - shellHeights.get(b),
);
if (ordered.every((item, i) => primitives.get(i) === item)) return;
for (const item of ordered.reverse()) primitives.lowerToBottom(item);
}
/** One raised rectangle drawing one full-extent image and, inside a window of
* it, an optional detail image. The owner calls destroy(). `onSettled` is
* told each time what it was last given has drawn. With `onWake` its owner
* runs its frames: it is told when the surface needs them, and calls
* `tick()` after each render while `awake()`; without, it listens itself. */
export function createShellSurface({
scene,
cesium = Cesium,
rectangle,
height,
onSettled = () => {},
onWake = null,
}) {
registerMaterial(cesium);
const primitives = scene.primitives;
// A scene destroyed under it asks for nothing.
const ask = () => {
if (!scene.isDestroyed?.()) scene.requestRender();
};
const material = new cesium.Material({
fabric: { type: MATERIAL_TYPE },
translucent: false,
});
// Flat shading keeps the product colours independent of the viewing angle.
const appearance = new cesium.EllipsoidSurfaceAppearance({
aboveGround: true,
flat: true,
translucent: false,
material,
});
// Cesium orders its translucent pass itself (weighted OIT or distance), which
// cannot honour stacked heights. Draw in the opaque pass in scene.primitives
// order, alpha-blended and without depth writes, so higher shells draw over
// lower ones and nothing is hidden or picked through a shell.
appearance.getRenderState = () => ({
depthTest: { enabled: true },
depthMask: false,
blending: cesium.BlendingState.ALPHA_BLEND,
});
const primitive = new cesium.Primitive({
geometryInstances: new cesium.GeometryInstance({
geometry: new cesium.RectangleGeometry({
rectangle,
height,
granularity: cesium.Math.toRadians(0.5),
vertexFormat: cesium.EllipsoidSurfaceAppearance.VERTEX_FORMAT,
}),
}),
appearance,
asynchronous: true,
allowPicking: false,
});
primitives.add(primitive);
orderShells(primitives, primitive, height);
let lift = 0;
let image = null;
let frames = 0;
// The detail image, its own upload count and a window waiting for it to draw.
let detail = null;
let detailFrames = 0;
let pendingWindow = null;
let offRender = null;
let awake = false;
let destroyed = false;
const fits = (size, value) =>
!size || (size.x === value.width && size.y === value.height);
const uploaded = () =>
image !== null && fits(material.uniforms.imageDimensions, image);
const detailDrawn = () =>
detail !== null &&
detailFrames === 0 &&
fits(material.uniforms.detailDimensions, detail);
const drawn = () =>
primitive.ready &&
uploaded() &&
frames === 0 &&
(detail === null || (detailDrawn() && pendingWindow === null));
function appliedWindow() {
const { x, y, z, w } = material.uniforms.window;
return z < x ? null : { west: x, south: y, east: z, north: w };
}
function setWindow(rect) {
const next = rect ?? NO_WINDOW;
const { x, y, z, w } = material.uniforms.window;
if (
x === next.west &&
y === next.south &&
z === next.east &&
w === next.north
)
return;
material.uniforms.window = new cesium.Cartesian4(
next.west,
next.south,
next.east,
next.north,
);
ask();
}
// The render governor may idle the scene; request frames only until the
// asynchronous geometry is ready and the latest images have been drawn.
function tick() {
// Cesium updates a material only while its primitive is shown, so hidden
// frames upload nothing and count for nothing.
if (primitive.ready && primitive.show) {
if (frames > 0) frames--;
if (detailFrames > 0) detailFrames--;
// A texture is never shown at another window's place.
if (pendingWindow && detailDrawn()) {
setWindow(pendingWindow);
pendingWindow = null;
}
}
if (primitive.show && !drawn()) {
ask();
return;
}
awake = false;
offRender?.();
offRender = null;
if (drawn()) onSettled();
}
function wake() {
if (destroyed || !primitive.show || image === null || drawn()) return;
awake = true;
if (onWake) onWake();
else offRender ??= scene.postRender.addEventListener(tick);
ask();
}
return {
setImage(next) {
if (destroyed || next === image) return;
image = next;
material.uniforms.image = next;
frames = UPLOAD_FRAMES;
wake();
},
setAlpha(value) {
if (destroyed || material.uniforms.alpha === value) return;
material.uniforms.alpha = value;
ask();
},
/** Metres the surface rises, by a uniform scale about the Earth's centre. */
setLift(value) {
const next = Number(value) || 0;
if (destroyed || next === lift) return;
lift = next;
primitive.modelMatrix = cesium.Matrix4.fromUniformScale(
1 + lift / cesium.Ellipsoid.WGS84.maximumRadius,
);
ask();
},
/** Draw `next` inside `rect` (west, south, east, north in the full-extent
* image's texture coordinates, 0–1); null clears it. In the same window only
* the image changes, and Cesium keeps drawing the previous texture until
* this one is uploaded. A different window applies once its image has
* drawn; until then the full-extent image covers it. */
setDetail(next, rect) {
if (destroyed) return;
if (!next) {
if (detail === null) return;
detail = null;
detailFrames = 0;
pendingWindow = null;
material.uniforms.detail = cesium.Material.DefaultImageId;
setWindow(null);
ask();
return;
}
if (next !== detail) {
detail = next;
material.uniforms.detail = next;
detailFrames = UPLOAD_FRAMES;
}
const applied = appliedWindow();
if (applied && sameEdges(applied, rect)) {
pendingWindow = null;
} else {
setWindow(null);
pendingWindow = rect;
}
wake();
},
/** Returns whether visibility changed. */
setShow(value) {
const show = Boolean(value);
if (destroyed || primitive.show === show) return false;
primitive.show = show;
wake();
ask();
return true;
},
/** Whether what it was last given has drawn. */
isDrawn: () => !destroyed && drawn(),
/** Whether it needs frames until what it was given has drawn. */
awake: () => awake && !destroyed,
tick,
getDiagnostics() {
return {
height,
lift,
ready: Boolean(primitive.ready),
uploaded: uploaded(),
show: primitive.show,
alpha: material.uniforms.alpha,
rendering: awake,
// `uploaded` once the detail image has drawn; the window applies after.
detail: { uploaded: detailDrawn(), window: appliedWindow() },
};
},
destroy() {
if (destroyed) return;
destroyed = true;
awake = false;
offRender?.();
offRender = null;
if (!primitives.isDestroyed?.() && primitives.contains(primitive))
primitives.remove(primitive);
if (!primitive.isDestroyed()) primitive.destroy();
// Primitive.destroy leaves the material and its texture alive.
if (!material.isDestroyed()) material.destroy();
image = null;
detail = null;
pendingWindow = null;
ask();
},
};
}
/** A rectangle's place inside another, in the outer one's texture coordinates. */
function placeIn(outer, inner) {
const x = outer.east - outer.west;
const y = outer.north - outer.south;
return {
west: (inner.west - outer.west) / x,
south: (inner.south - outer.south) / y,
east: (inner.east - outer.west) / x,
north: (inner.north - outer.south) / y,
};
}
/** Whether `ref` is drawn as it is, with no decode first. */
const immediate = (ref) => Boolean(ref?.canvas);
/** An image reference decoded into something a material uploads. */
async function decode(ref) {
if (ref?.atlas) throw new TypeError('a raster shell takes no atlas images');
const url = ref?.blob
? URL.createObjectURL(ref.blob)
: ref?.svg
? `data:image/svg+xml;charset=utf-8,${encodeURIComponent(ref.svg)}`
: String(ref);
try {
const image = new Image();
image.crossOrigin = 'anonymous';
image.src = url;
await image.decode();
return image;
} finally {
if (ref?.blob) URL.revokeObjectURL(url);
}
}
/**
* The fields part of a Cesium draw port.
* @param {{scene: object, report?: (error: unknown) => void,
* cesium?: object}} options `cesium` is for test doubles.
* @returns {{field: (spec: object) => object, has: (id: string) => boolean,
* dispose: () => void}}
*/
export function createCesiumFields({
scene,
report = uncaught,
cesium = Cesium,
}) {
const fields = new Map();
const live = () => !scene.isDestroyed?.();
const requestRender = () => {
if (live()) scene.requestRender();
};
function rasterShell(spec) {
const id = spec.id;
// The frame a change was put on the surface, so 'drawn' waits for the
// render after it. Scenes without a frame state count this field's
// renders.
let renders = 0;
const frameNumber = () => scene.frameState?.frameNumber ?? renders;
let content = {
image: spec.image,
rectangle: { ...spec.rectangle },
heightM: Number(spec.heightM) || 0,
detail: spec.detail ? { ...spec.detail } : null,
};
let liftM = Number(spec.liftM) || 0;
let alpha = spec.alpha ?? 1;
let shown = true;
let disposed = false;
// The surface drawn, and one being built for a new rectangle or height.
let drawing = null;
let staged = null;
// Each content change, so a late decode of an older one is dropped.
let contentSeq = 0;
let placedSeq = -1;
// 'drawn' is owed for the latest change, put on the surface at `placedAt`.
let owed = true;
let placedAt = Infinity;
let offRender = null;
const drawnListeners = listenerList(report);
const keyOf = (c) =>
`${c.rectangle.west},${c.rectangle.south},${c.rectangle.east},${c.rectangle.north}|${c.heightM}`;
function make(c) {
const entry = { key: keyOf(c), rectangle: c.rectangle, surface: null };
const { west, south, east, north } = c.rectangle;
entry.surface = createShellSurface({
scene,
cesium,
rectangle: cesium.Rectangle.fromDegrees(west, south, east, north),
height: c.heightM,
onSettled: () => settled(entry),
onWake: () => watch(),
});
entry.surface.setLift(liftM);
// Staged surfaces draw, invisibly, even while the field is hidden, so
// the new content is ready when it shows.
return entry;
}
function drop(entry) {
entry?.surface.destroy();
return null;
}
// A staged surface takes the drawn one's place once it has drawn.
function settled(entry) {
if (disposed) return;
if (entry === staged) {
drop(drawing);
drawing = staged;
staged = null;
drawing.surface.setAlpha(alpha);
drawing.surface.setShow(shown);
// It has drawn already, invisibly, so it shows from the next frame on,
// the frame the one it replaces stops: told now, so nothing comes
// between the swap and 'drawn'.
if (owed && shown && placedSeq === contentSeq) {
owed = false;
drawnListeners.fire();
return;
}
placed();
return;
}
// What it last applied (a detail window, say) draws in the next frame.
if (entry === drawing) placed();
else watch();
}
function placed() {
placedAt = frameNumber();
watch();
}
function put(entry, c, image, detailImage) {
entry.surface.setImage(image);
if (c.detail && detailImage)
entry.surface.setDetail(
detailImage,
placeIn(entry.rectangle, c.detail.rectangle),
);
else entry.surface.setDetail(null);
}
/** Draw `c` with its images decoded. */
function place(c, image, detailImage) {
const key = keyOf(c);
if (drawing?.key === key) {
staged = drop(staged);
put(drawing, c, image, detailImage);
placed();
return;
}
if (staged?.key !== key) {
staged = drop(staged);
staged = make(c);
// Invisible until it takes the drawn one's place.
staged.surface.setAlpha(0);
}
put(staged, c, image, detailImage);
// Its own settling promotes it.
watch();
}
function load(c) {
const seq = (contentSeq += 1);
const refs = [c.image, c.detail?.image];
if (refs.every((ref) => ref == null || immediate(ref))) {
placedSeq = seq;
place(c, c.image.canvas, c.detail?.image.canvas ?? null);
return;
}
// A stage of older content must not take the drawn one's place while
// this decodes.
staged = drop(staged);
Promise.all(
refs.map((ref) =>
ref == null ? null : immediate(ref) ? ref.canvas : decode(ref),
),
).then(
([image, detailImage]) => {
if (disposed || seq !== contentSeq || !live()) return;
placedSeq = seq;
place(c, image, detailImage);
},
(error) => {
// What it drew stays.
if (disposed || seq !== contentSeq) return;
report(error);
if (!busy()) unwatch();
},
);
}
// One listener runs the surfaces' frames and tells 'drawn'.
const busy = () =>
Boolean(drawing?.surface.awake() || staged?.surface.awake());
function notify() {
if (!owed || !shown || staged || placedSeq !== contentSeq || !drawing)
return;
if (!drawing.surface.isDrawn()) return;
// A frame number that has moved on (it wraps) has drawn the change.
if (frameNumber() === placedAt) {
requestRender();
return;
}
owed = false;
drawnListeners.fire();
}
function tick() {
renders += 1;
for (const entry of [drawing, staged])
if (entry?.surface.awake()) entry.surface.tick();
if (!disposed) notify();
if (disposed || (!busy() && !(owed && shown))) unwatch();
}
function watch() {
if (disposed || (!(owed && shown) && !busy())) return;
offRender ??= scene.postRender.addEventListener(tick);
requestRender();
}
function unwatch() {
offRender?.();
offRender = null;
}
const handle = {
id,
get show() {
return shown;
},
set show(value) {
const next = Boolean(value);
if (disposed || next === shown) return;
shown = next;
drawing?.surface.setShow(shown);
// A stage in progress keeps building, so it is ready when shown.
if (shown) watch();
else if (!busy()) unwatch();
requestRender();
},
update(patch = {}) {
if (disposed) return;
if (patch.kind !== undefined && patch.kind !== 'rasterShell')
throw new TypeError('a field keeps its kind');
const next = { ...content };
let reload = false;
if ('image' in patch && patch.image !== content.image) {
next.image = patch.image;
reload = true;
}
if (patch.rectangle && !sameEdges(patch.rectangle, content.rectangle)) {
next.rectangle = { ...patch.rectangle };
reload = true;
}
if ('heightM' in patch && Number(patch.heightM) !== content.heightM) {
next.heightM = Number(patch.heightM) || 0;
reload = true;
}
if ('detail' in patch) {
const was = content.detail;
const now = patch.detail ? { ...patch.detail } : null;
if (
(was === null) !== (now === null) ||
(now &&
(now.image !== was.image ||
!sameEdges(now.rectangle, was.rectangle)))
) {
next.detail = now;
reload = true;
}
}
if ('liftM' in patch) {
liftM = Number(patch.liftM) || 0;
drawing?.surface.setLift(liftM);
staged?.surface.setLift(liftM);
}
if ('alpha' in patch) {
alpha = patch.alpha ?? 1;
drawing?.surface.setAlpha(alpha);
}
owed = true;
content = next;
if (reload) load(content);
else placed();
requestRender();
},
on(event, cb) {
if (event !== 'drawn') return () => {};
return drawnListeners.on(cb);
},
dispose() {
if (disposed) return;
disposed = true;
unwatch();
drawnListeners.clear();
drawing = drop(drawing);
staged = drop(staged);
if (fields.get(id) === handle) fields.delete(id);
},
};
fields.set(id, handle);
load(content);
return handle;
}
return {
field(spec) {
if (fields.has(spec?.id))
throw new Error(`a field with id ${spec.id} is live`);
if (spec?.kind === 'rasterShell') return rasterShell(spec);
throw new TypeError(
`the Cesium renderer draws no ${spec?.kind} fields yet`,
);
},
has: (id) => fields.has(id),
dispose() {
for (const handle of [...fields.values()]) handle.dispose();
},
};
}
+645
View File
@@ -0,0 +1,645 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import * as Cesium from 'cesium';
import {
createCesiumFields,
createShellSurface,
orderShells,
} from './drawFields.js';
import {
createShellCesium,
createShellScene,
renderShells,
} from '../../layers/weather/shellFixture.mjs';
// The detail window uniform; NONE is the empty window.
const NONE = { x: 0, y: 0, z: -1, w: -1 };
const windowOf = (primitive) => {
const { x, y, z, w } = primitive.appearance.material.uniforms.window;
return { x, y, z, w };
};
test('surface builds a flat raised rectangle drawn in primitive order without depth writes', () => {
const cesium = createShellCesium();
const scene = createShellScene();
const rectangle = Cesium.Rectangle.fromDegrees(-130, 20, -60, 55);
const surface = createShellSurface({
scene,
cesium,
rectangle,
height: 6_200,
});
const template = cesium.templates.get('DrawRasterShell');
assert.ok(!(template instanceof cesium.Material), 'plain template');
assert.deepEqual(template.fabric.uniforms, {
image: Cesium.Material.DefaultImageId,
detail: Cesium.Material.DefaultImageId,
alpha: 1,
window: { type: 'vec4', x: 0, y: 0, z: -1, w: -1 },
});
const { source } = template.fabric;
assert.match(
source,
/material\.alpha = c\.a \* alpha \* step\(1\.5, float\(imageDimensions\.x\)\);/,
'nothing draws before the full-extent image',
);
assert.match(
source,
/float useDetail = inside \* step\(1\.5, float\(detailDimensions\.x\)\);/,
'the detail image is sampled only once it has arrived',
);
assert.match(
source,
/all\(greaterThanEqual\(st, window\.xy\)\) && all\(lessThanEqual\(st, window\.zw\)\)/,
);
assert.match(
source,
/mix\(coarse, texture\(detail, clamp\(dst, 0\.0, 1\.0\)\), useDetail\)/,
);
assert.match(source, /material\.diffuse = czm_gammaCorrect\(c\.rgb\);/);
const [primitive] = scene.primitives.items;
const appearance = primitive.appearance;
assert.equal(appearance.material.options.translucent, false);
assert.deepEqual(
{ ...appearance.options, material: undefined },
{
aboveGround: true,
flat: true,
translucent: false,
material: undefined,
},
);
assert.deepEqual(appearance.getRenderState(), {
depthTest: { enabled: true },
depthMask: false,
blending: Cesium.BlendingState.ALPHA_BLEND,
});
const geometry = primitive.options.geometryInstances.geometry.options;
assert.equal(geometry.rectangle, rectangle);
assert.equal(geometry.height, 6_200);
assert.equal(geometry.granularity, Cesium.Math.toRadians(0.5));
assert.equal(
geometry.vertexFormat,
Cesium.EllipsoidSurfaceAppearance.VERTEX_FORMAT,
);
assert.equal(primitive.options.asynchronous, true);
assert.equal(primitive.options.allowPicking, false);
const lower = createShellSurface({
scene,
cesium,
rectangle,
height: 5_000,
});
assert.equal(cesium.templates.size, 1, 'the template registers once');
assert.deepEqual(
scene.primitives.items.map(
(item) => item.options.geometryInstances.geometry.options.height,
),
[5_000, 6_200],
);
lower.destroy();
surface.destroy();
});
test('a surface applies a new detail window only once its image has drawn; the same window swaps only the image', () => {
const cesium = createShellCesium();
const scene = createShellScene();
const surface = createShellSurface({
scene,
cesium,
rectangle: Cesium.Rectangle.fromDegrees(-130, 20, -60, 55),
height: 6_200,
});
const [primitive] = scene.primitives.items;
const { uniforms } = primitive.appearance.material;
const render = (count) => renderShells(cesium, scene, count);
const image = () => ({ width: 4096, height: 2048 });
surface.setImage(image());
render();
assert.deepEqual(surface.getDiagnostics().detail, {
uploaded: false,
window: null,
});
const a = { west: 0.25, south: 0.5, east: 0.5, north: 0.75 };
const first = image();
surface.setDetail(first, a);
assert.equal(uniforms.detail, first);
assert.deepEqual(windowOf(primitive), NONE, 'the full-extent image covers');
assert.equal(scene.postRender.size, 1, 'renders until the detail has drawn');
render(2);
assert.deepEqual(windowOf(primitive), NONE);
render(1);
assert.deepEqual(windowOf(primitive), { x: 0.25, y: 0.5, z: 0.5, w: 0.75 });
assert.ok(uniforms.window instanceof Cesium.Cartesian4);
assert.deepEqual(surface.getDiagnostics().detail, {
uploaded: true,
window: a,
});
assert.equal(scene.postRender.size, 0);
// A time change in the same window: Cesium keeps drawing the previous
// texture until the new one is uploaded, so the window stays.
const applied = uniforms.window;
const second = image();
surface.setDetail(second, { ...a });
assert.equal(uniforms.detail, second);
assert.equal(uniforms.window, applied, 'only the image is written');
assert.equal(surface.getDiagnostics().detail.uploaded, false);
render();
assert.equal(surface.getDiagnostics().detail.uploaded, true);
assert.equal(uniforms.window, applied);
const renders = scene.renders;
surface.setDetail(second, { ...a });
assert.equal(scene.renders, renders, 'an unchanged detail costs nothing');
assert.equal(scene.postRender.size, 0);
// A different window empties at once and applies once its image has drawn.
const b = { west: 0.5, south: 0.25, east: 0.75, north: 0.5 };
surface.setDetail(image(), b);
assert.deepEqual(windowOf(primitive), NONE);
render(2);
assert.deepEqual(windowOf(primitive), NONE);
render(1);
assert.deepEqual(windowOf(primitive), { x: 0.5, y: 0.25, z: 0.75, w: 0.5 });
surface.setDetail(null);
assert.equal(uniforms.detail, Cesium.Material.DefaultImageId);
assert.deepEqual(windowOf(primitive), NONE);
assert.deepEqual(surface.getDiagnostics().detail, {
uploaded: false,
window: null,
});
render();
assert.deepEqual(
{ ...uniforms.detailDimensions },
{ type: 'ivec3', x: 1, y: 1 },
);
// Counted renders alone are not enough: the bound texture must be this image.
surface.setDetail(image(), a);
for (let i = 0; i < 4; i++) scene.postRender.emit();
assert.deepEqual(windowOf(primitive), NONE, 'still the 1×1 default');
render(1);
assert.deepEqual(windowOf(primitive), { x: 0.25, y: 0.5, z: 0.5, w: 0.75 });
surface.destroy();
surface.setDetail(image(), b);
assert.deepEqual(windowOf(primitive), { x: 0.25, y: 0.5, z: 0.5, w: 0.75 });
assert.equal(scene.postRender.size, 0);
});
test("a surface rises by a uniform scale about the Earth's centre", () => {
const scene = {
primitives: new Cesium.PrimitiveCollection(),
postRender: new Cesium.Event(),
requestRender() {},
};
const surface = createShellSurface({
scene,
cesium: Cesium,
rectangle: Cesium.Rectangle.fromDegrees(-130, 20, -60, 55),
height: 5_800,
});
const primitive = scene.primitives.get(0);
const identity = primitive.modelMatrix;
surface.setLift(0);
assert.equal(primitive.modelMatrix, identity, 'no lift, no new matrix');
surface.setLift(32_000);
const radius = Cesium.Ellipsoid.WGS84.maximumRadius;
assert.ok(
Math.abs(primitive.modelMatrix[0] * radius - (radius + 32_000)) < 1e-3,
);
const lifted = primitive.modelMatrix;
surface.setLift(32_000);
assert.equal(primitive.modelMatrix, lifted, 'the same lift keeps the matrix');
surface.destroy();
});
test('real Cesium builds the two-texture material, the opaque-pass appearance and the rectangle primitive', () => {
const scene = {
primitives: new Cesium.PrimitiveCollection(),
postRender: new Cesium.Event(),
requestRender() {},
};
const surface = createShellSurface({
scene,
cesium: Cesium,
rectangle: Cesium.Rectangle.fromDegrees(-130, 20, -60, 55),
height: 6_600,
});
const cached = Cesium.Material._materialCache.getMaterial('DrawRasterShell');
assert.ok(cached && !(cached instanceof Cesium.Material));
const primitive = scene.primitives.get(0);
const material = primitive.appearance.material;
assert.ok(primitive instanceof Cesium.Primitive);
assert.equal(material.type, 'DrawRasterShell');
assert.equal(material.isTranslucent(), false);
assert.equal(primitive.appearance.isTranslucent(), false, 'opaque pass');
assert.equal(primitive.appearance.getRenderState().depthMask, false);
assert.equal(
Cesium.Appearance.prototype.getRenderState.call(primitive.appearance)
.depthMask,
true,
'the default opaque render state would write depth',
);
assert.deepEqual(
[material.uniforms.imageDimensions.x, material.uniforms.detailDimensions.x],
[1, 1],
'Cesium tracks both bound texture sizes',
);
const shader = material.shaderSource;
for (const declaration of [
/uniform sampler2D image_\d+;/,
/uniform sampler2D detail_\d+;/,
/uniform float alpha_\d+;/,
/uniform vec4 window_\d+;/,
/uniform ivec3 imageDimensions_\d+;/,
/uniform ivec3 detailDimensions_\d+;/,
])
assert.match(shader, declaration);
assert.match(shader, /texture\(image_\d+, st\)/);
assert.match(shader, /texture\(detail_\d+, clamp\(dst, 0\.0, 1\.0\)\)/);
assert.match(shader, /lessThanEqual\(st, window_\d+\.zw\)/);
assert.match(shader, /step\(1\.5, float\(detailDimensions_\d+\.x\)\)/);
assert.match(
shader,
/material\.alpha = c\.a \* alpha_\d+ \* step\(1\.5, float\(imageDimensions_\d+\.x\)\);/,
'the uniform is renamed, the material field is not',
);
assert.match(shader, /float useDetail = inside \* step/, 'locals keep names');
const detail = { width: 4096, height: 2048 };
surface.setDetail(detail, { west: 0.1, south: 0.2, east: 0.3, north: 0.4 });
assert.equal(material.uniforms.detail, detail);
assert.deepEqual(
[material.uniforms.window.z, material.uniforms.window.w],
[-1, -1],
'no window before the image has drawn',
);
surface.setDetail(null);
assert.equal(material.uniforms.detail, Cesium.Material.DefaultImageId);
surface.setAlpha(0.4);
assert.equal(material.uniforms.alpha, 0.4);
surface.destroy();
assert.equal(scene.primitives.length, 0);
assert.equal(primitive.isDestroyed(), true);
assert.equal(material.isDestroyed(), true);
assert.equal(scene.postRender.numberOfListeners, 0);
});
test('shells draw first, in height order, regardless of add order', () => {
const scene = createShellScene();
const other = { name: 'other' };
scene.primitives.add(other);
const add = (name, height) => {
const primitive = { name };
scene.primitives.add(primitive);
orderShells(scene.primitives, primitive, height);
return primitive;
};
add('lightning', 6_600);
add('radar', 6_200);
add('wind', 5_000);
const later = { name: 'later' };
scene.primitives.add(later);
add('regional', 5_800);
assert.deepEqual(
scene.primitives.items.map(({ name }) => name),
['wind', 'regional', 'radar', 'lightning', 'other', 'later'],
);
const primitives = new Cesium.PrimitiveCollection({
destroyPrimitives: false,
});
const real = (name) => ({ name, update() {}, isDestroyed: () => false });
const tileset = primitives.add(real('tileset'));
const lightning = primitives.add(real('lightning'));
orderShells(primitives, lightning, 6_600);
const radar = primitives.add(real('radar'));
orderShells(primitives, radar, 6_200);
assert.deepEqual(
[0, 1, 2].map((i) => primitives.get(i).name),
['radar', 'lightning', 'tileset'],
'real Cesium collection order',
);
assert.equal(tileset.name, 'tileset');
});
test('hidden frames do not count towards a pending detail window', () => {
const cesium = createShellCesium();
const scene = createShellScene();
const surface = createShellSurface({
scene,
cesium,
rectangle: Cesium.Rectangle.fromDegrees(-130, 20, -60, 55),
height: 6_200,
});
const [primitive] = scene.primitives.items;
const render = (count) => renderShells(cesium, scene, count);
const image = () => ({ width: 4096, height: 2048 });
surface.setImage(image());
const a = { west: 0.25, south: 0.5, east: 0.5, north: 0.75 };
surface.setDetail(image(), a);
render();
assert.deepEqual(windowOf(primitive), { x: 0.25, y: 0.5, z: 0.5, w: 0.75 });
// A different window with a same-sized image: the dimensions alone cannot
// tell the textures apart, so only shown frames may count.
const b = { west: 0.5, south: 0.25, east: 0.75, north: 0.5 };
surface.setDetail(image(), b);
assert.deepEqual(windowOf(primitive), NONE);
for (let i = 0; i < 3; i++) {
surface.setShow(false);
scene.postRender.emit();
surface.setShow(true);
}
assert.deepEqual(windowOf(primitive), NONE, 'hidden frames counted nothing');
render(2);
assert.deepEqual(windowOf(primitive), NONE);
render(1);
assert.deepEqual(windowOf(primitive), { x: 0.5, y: 0.25, z: 0.75, w: 0.5 });
});
function fieldHarness() {
const cesium = createShellCesium();
const scene = createShellScene();
const fields = createCesiumFields({ scene, cesium });
const image = () => ({ canvas: { width: 64, height: 32 }, key: 'k' });
const render = (count = 4) => renderShells(cesium, scene, count);
const live = () => scene.primitives.items.filter((p) => !p.destroyed);
return { cesium, scene, fields, image, render, live };
}
const RECT = { west: -100, south: 20, east: -60, north: 40 };
test("a raster shell tells 'drawn' once its content is drawn, once per change", () => {
const h = fieldHarness();
const field = h.fields.field({
kind: 'rasterShell',
id: 'shell',
image: h.image(),
rectangle: RECT,
heightM: 6_000,
alpha: 0.5,
});
let drawn = 0;
field.on('drawn', () => (drawn += 1));
const [primitive] = h.live();
const { uniforms } = primitive.appearance.material;
assert.equal(uniforms.alpha, 0, 'invisible until drawable');
h.render();
assert.equal(drawn, 1);
assert.equal(uniforms.alpha, 0.5);
assert.equal(h.scene.postRender.size, 0, 'no frames once drawn');
field.update({ alpha: 0.3, liftM: 1_000 });
assert.equal(uniforms.alpha, 0.3);
assert.notEqual(primitive.modelMatrix, undefined, 'lifted');
assert.deepEqual(h.live(), [primitive], 'alpha and lift never rebuild');
h.render();
assert.equal(drawn, 2);
field.show = false;
field.update({ alpha: 0.4 });
h.render();
assert.equal(drawn, 2, 'never while hidden');
field.show = true;
h.render();
assert.equal(drawn, 3, 'told once shown');
h.render();
assert.equal(drawn, 3);
field.dispose();
assert.equal(h.live().length, 0);
assert.equal(h.scene.postRender.size, 0);
});
test('a raster shell keeps drawing its rectangle until a new one is drawn whole', () => {
const h = fieldHarness();
const first = h.image();
const field = h.fields.field({
kind: 'rasterShell',
id: 'shell',
image: first,
rectangle: RECT,
heightM: 6_000,
});
let drawn = 0;
field.on('drawn', () => (drawn += 1));
h.render();
const [old] = h.live();
const second = h.image();
field.update({
image: second,
rectangle: { west: -120, south: 10, east: -50, north: 50 },
});
const [, staged] = h.live();
assert.equal(old.appearance.material.uniforms.alpha, 1, 'the old one draws');
assert.equal(staged.appearance.material.uniforms.alpha, 0);
assert.equal(staged.appearance.material.uniforms.image, second.canvas);
h.render();
assert.equal(old.destroyed, true, 'swapped in one frame');
assert.deepEqual(h.live(), [staged]);
assert.equal(staged.appearance.material.uniforms.alpha, 1);
assert.equal(drawn, 2);
// Back to the drawn rectangle before a staged one is drawn: it goes.
field.update({ rectangle: RECT });
assert.equal(h.live().length, 2);
field.update({ rectangle: { west: -120, south: 10, east: -50, north: 50 } });
assert.deepEqual(h.live(), [staged]);
field.dispose();
});
test('a raster shell draws its detail in its own rectangle, in texture coordinates', () => {
const h = fieldHarness();
const field = h.fields.field({
kind: 'rasterShell',
id: 'shell',
image: h.image(),
rectangle: RECT,
heightM: 6_000,
});
h.render();
const [primitive] = h.live();
const detail = h.image();
field.update({
detail: {
image: detail,
rectangle: { west: -90, south: 25, east: -80, north: 30 },
},
});
assert.deepEqual(windowOf(primitive), NONE, 'the full image covers it');
h.render();
assert.equal(primitive.appearance.material.uniforms.detail, detail.canvas);
assert.deepEqual(windowOf(primitive), {
x: 0.25,
y: 0.25,
z: 0.5,
w: 0.5,
});
field.update({ detail: null });
assert.deepEqual(windowOf(primitive), NONE);
field.dispose();
});
test('a raster shell hidden while a new rectangle stages still swaps it in', () => {
const h = fieldHarness();
const field = h.fields.field({
kind: 'rasterShell',
id: 'shell',
image: h.image(),
rectangle: RECT,
heightM: 6_000,
});
let drawn = 0;
field.on('drawn', () => (drawn += 1));
h.render();
const [old] = h.live();
field.show = false;
field.update({
image: h.image(),
rectangle: { west: -120, south: 10, east: -50, north: 50 },
});
h.render();
const [staged] = h.live();
assert.equal(old.destroyed, true, 'drawn invisibly and swapped in');
assert.notEqual(staged, old);
assert.equal(staged.show, false, 'and kept hidden');
assert.equal(drawn, 1, 'never told while hidden');
field.show = true;
h.render();
assert.equal(staged.show, true);
assert.equal(drawn, 2);
field.dispose();
});
test("a raster shell tells 'drawn' for a detail only once its window is placed", () => {
const h = fieldHarness();
const field = h.fields.field({
kind: 'rasterShell',
id: 'shell',
image: h.image(),
rectangle: RECT,
heightM: 6_000,
});
h.render();
const [primitive] = h.live();
const windows = [];
field.on('drawn', () => windows.push(windowOf(primitive)));
field.update({
detail: {
image: h.image(),
rectangle: { west: -90, south: 25, east: -80, north: 30 },
},
});
h.render();
assert.deepEqual(windows, [{ x: 0.25, y: 0.25, z: 0.5, w: 0.5 }]);
field.dispose();
});
test("a raster shell tells 'drawn' in the frame its new rectangle replaces the old", () => {
const h = fieldHarness();
const field = h.fields.field({
kind: 'rasterShell',
id: 'shell',
image: h.image(),
rectangle: RECT,
heightM: 6_000,
});
h.render();
const [old] = h.live();
let drawnAt = null;
let render = 0;
field.on('drawn', () => (drawnAt = render));
field.update({ rectangle: { west: -120, south: 10, east: -50, north: 50 } });
let swappedAt = null;
for (render = 1; render <= 6; render++) {
h.render(1);
if (old.destroyed && swappedAt === null) swappedAt = render;
}
assert.ok(swappedAt > 1, 'staged while uploading');
assert.equal(drawnAt, swappedAt, 'nothing comes between the swap and drawn');
field.dispose();
});
test('a raster shell hidden after a new rectangle stages still builds and swaps it', () => {
const h = fieldHarness();
const field = h.fields.field({
kind: 'rasterShell',
id: 'shell',
image: h.image(),
rectangle: RECT,
heightM: 6_000,
});
let drawn = 0;
field.on('drawn', () => (drawn += 1));
h.render();
const [old] = h.live();
field.update({ rectangle: { west: -120, south: 10, east: -50, north: 50 } });
field.show = false;
h.render();
const [staged] = h.live();
assert.equal(old.destroyed, true);
assert.notEqual(staged, old);
assert.equal(staged.show, false);
assert.equal(h.scene.postRender.size, 0, 'no frames once built');
assert.equal(drawn, 1);
field.show = true;
h.render();
assert.equal(drawn, 2);
field.dispose();
});
test('a raster shell never swaps in a stage superseded by content still decoding', async (t) => {
const pending = [];
const Image = globalThis.Image;
globalThis.Image = class {
decode() {
return new Promise((resolve, reject) =>
pending.push({ resolve, reject }),
);
}
};
t.after(() => (globalThis.Image = Image));
const reported = [];
const cesium = createShellCesium();
const scene = createShellScene();
const fields = createCesiumFields({
scene,
cesium,
report: (error) => reported.push(error),
});
const live = () => scene.primitives.items.filter((p) => !p.destroyed);
const field = fields.field({
kind: 'rasterShell',
id: 'shell',
image: { canvas: { width: 64, height: 32 } },
rectangle: RECT,
heightM: 6_000,
});
renderShells(cesium, scene);
const [old] = live();
field.update({
image: { canvas: { width: 64, height: 32 } },
rectangle: { west: -120, south: 10, east: -50, north: 50 },
});
assert.equal(live().length, 2);
field.update({ image: 'https://example.test/next.png' });
assert.deepEqual(live(), [old], 'the superseded stage goes');
pending[0].reject(new Error('no image'));
await new Promise((resolve) => setTimeout(resolve, 0));
renderShells(cesium, scene);
assert.deepEqual(live(), [old], 'what it drew stays');
assert.equal(reported.length, 1);
field.dispose();
});
test('the Cesium fields refuse kinds they cannot draw and live ids', () => {
const h = fieldHarness();
assert.throws(
() => h.fields.field({ kind: 'scalarRaster', id: 'x' }),
/no scalarRaster fields/,
);
const spec = {
kind: 'rasterShell',
id: 'shell',
image: h.image(),
rectangle: RECT,
heightM: 1,
};
const field = h.fields.field(spec);
assert.throws(() => h.fields.field(spec), /is live/);
field.dispose();
h.fields.field(spec).dispose();
});
+1
View File
@@ -40,6 +40,7 @@ export const CESIUM_CHECKS = new Set([
'draw.columns.shown',
'draw.drawOrder',
'draw.drillPick',
'draw.field.rasterShell',
'draw.icons.distance',
'draw.icons.update',
'draw.lines.depthFailDash',
+2
View File
@@ -66,6 +66,8 @@ export function cesiumCapabilities(scene, only) {
'models',
'quads',
'meshes',
// Raster shells; other field kinds are refused.
'fields',
'followFrame',
'cameraChangeThreshold',
...GPU_ICON_CAPABILITIES,
+1 -1
View File
@@ -29,7 +29,7 @@ test('capabilities follow what the scene supports', () => {
'surfaceShading',
];
const globe = { show: true };
const draw = ['models', 'quads', 'meshes'];
const draw = ['models', 'quads', 'meshes', 'fields'];
assert.deepEqual(cesiumCapabilities({}), [...draw, ...effects]);
// A scene with a globe reads its visibility back.
assert.deepEqual(cesiumCapabilities({ globe }), [
-1
View File
@@ -5,7 +5,6 @@
"src/app/scene.js",
"src/app/viewer.js",
"src/data/geoImportPins.js",
"src/layers/weather/shellRendering.js",
"src/layers/wind/gpuRendering.js",
"src/layers/wind/relief.js",
"src/layers/wind/rendering.js",