Merge branch 'sameh/renderer-camera-support' into sameh/renderer-seam

# Conflicts:
#	src/render/cesiumAllowList.json
This commit is contained in:
Sameh Khamis committed 2026-11-08 21:23:46 -08:00
commit 6eb9ceef46
33 files changed
+2227 -222

No files matched your search

+24
View File
@@ -0,0 +1,24 @@
/**
* @module render/baseTilesets
* @description Tilesets the application draws as its base outside the
* renderer's globe port, marked so the port drapes imagery on them while
* they are shown. Cesium-free: code that loads its own base, or hands
* a layer one (`recentImagery.attachTileset`), marks it here without
* reaching the renderer; the renderer's globe port reads the marks.
*/
const marked = new WeakSet();
/**
* Mark a tileset as a base the application draws outside the port, so
* imagery drapes on it while it is shown. The port's own photoreal tileset
* needs no mark.
* @param {object} tileset The renderer's tileset object.
*/
export function markBaseTileset(tileset) {
if (tileset && typeof tileset === 'object') marked.add(tileset);
}
/** Whether `tileset` was marked as a base (`markBaseTileset`). */
export const isBaseTileset = (tileset) =>
Boolean(tileset && typeof tileset === 'object' && marked.has(tileset));
+111 -8
View File
@@ -1,15 +1,22 @@
/**
* @module render/camera/events
* @description The camera port's events, shared by the Cesium port and the stub: the
* listener lists, delivery (a throwing listener is reported, the rest still
* run), and the contract's per-listener `changed` measure. A renderer calls
* `stepChanged()` once per frame and `emit()` for the events its engine
* @description The camera port's events, shared by the renderer, the stub and
* camera controllers (the package's `./render/camera/events`
* export):
* the listener lists, delivery (a throwing listener is reported, the rest
* still run), the contract's per-listener `changed` measure, move detection
* (`moveStart` on a change, `moveEnd` 500 ms after the last one, never
* while following) and the command hooks (`onCommand`). A renderer calls
* `stepChanged()` and `stepMoveDetection()` once per frame, `command()`
* before each camera command, and `emit()` for the events its engine
* raises.
*/
import { acosClamped, distance, dot } from '../../geo/index.js';
const TWO_PI = Math.PI * 2;
/** `moveEnd` waits this long after the last change, ms, as the reference does. */
export const MOVE_END_WAIT_MS = 500;
/** The contract's camera events. */
export const CAMERA_EVENTS = Object.freeze([
@@ -26,15 +33,43 @@ const angleDelta = (a, b) => {
return (d > Math.PI ? TWO_PI - d : d) / Math.PI;
};
/**
* Whether two world views are the same: the same position, and directions
* and ups whose dot products are each one's own.
*/
function sameView(a, b) {
return (
a &&
b &&
distance(a.position, b.position) === 0 &&
dot(a.direction, b.direction) === dot(a.direction, a.direction) &&
dot(a.up, b.up) === dot(a.up, a.up)
);
}
/**
* @param {{pose: () => import('../contract/camera').CameraPose,
* world?: () => {position: object, direction: object, up: object},
* following?: () => boolean,
* report: (error: unknown) => void, thresholds?: boolean}} options `pose`
* is read only while a `changed` listener is registered; `thresholds`
* is read only while a `changed` listener is registered; `world` (the
* eye in world coordinates; `pose()` when omitted) and `following` (no
* `moveEnd` while true) are read by `stepMoveDetection`; `thresholds`
* false (a renderer without `cameraChangeThreshold`) ignores a listener's
* own threshold, so every listener fires at 0.5.
*/
export function createCameraEvents({ pose, report, thresholds = true }) {
export function createCameraEvents({
pose,
world = pose,
following = () => false,
report,
thresholds = true,
}) {
const listeners = Object.fromEntries(CAMERA_EVENTS.map((e) => [e, []]));
const commandHooks = [];
let lastView = null;
let moving = false;
let lastMovedAt = 0;
function deliver(entry) {
if (!entry.live) return;
@@ -109,13 +144,81 @@ export function createCameraEvents({ pose, report, thresholds = true }) {
}
}
/** Drop every listener, including those of an event under way. */
/**
* Once a frame, after `preUpdate`: `moveStart` when the eye changed since
* the last frame, `moveEnd` once it has not for 500 ms (`now`, ms) and
* nothing is followed.
* @param {number} now
*/
function stepMoveDetection(now) {
const v = world();
const current = { position: v.position, direction: v.direction, up: v.up };
const changed = lastView && !sameView(lastView, current);
lastView = current;
if (changed) {
lastMovedAt = now;
if (!moving) {
moving = true;
emit('moveStart');
}
} else if (
moving &&
!following() &&
now - lastMovedAt >= MOVE_END_WAIT_MS
) {
moving = false;
emit('moveEnd');
}
}
/**
* Tell every command hook about a command before it runs.
* @param {import('../contract/camera').CameraCommand['kind']} kind
*/
function command(kind) {
for (const entry of commandHooks.slice()) {
if (!entry.live) continue;
try {
entry.cb({ kind });
} catch (error) {
report(error);
}
}
}
/**
* The contract's `onCommand`. Each registration is its own: its `Off`
* removes only it, once.
* @param {(command: import('../contract/camera').CameraCommand) => void} cb
* @returns {() => void}
*/
function onCommand(cb) {
const entry = { cb, live: true };
commandHooks.push(entry);
return () => {
entry.live = false;
const i = commandHooks.indexOf(entry);
if (i >= 0) commandHooks.splice(i, 1);
};
}
/** Drop every listener and hook, including those of an event under way. */
function clear() {
for (const list of Object.values(listeners)) {
for (const entry of list) entry.live = false;
list.length = 0;
}
for (const entry of commandHooks) entry.live = false;
commandHooks.length = 0;
}
return { on, emit, stepChanged, clear };
return {
on,
emit,
stepChanged,
stepMoveDetection,
command,
onCommand,
clear,
};
}
+90
View File
@@ -0,0 +1,90 @@
import assert from 'node:assert/strict';
import test from 'node:test';
import { createCameraEvents, MOVE_END_WAIT_MS } from './events.js';
import { geodesicAt, horizonFrom } from '../../geo/index.js';
const view = (x) => ({
position: { x, y: 0, z: 0 },
direction: { x: -1, y: 0, z: 0 },
up: { x: 0, y: 0, z: 1 },
});
test('moveStart on a change, moveEnd once nothing moved for 500 ms and nothing is followed', () => {
let eye = view(7e6);
let following = false;
const seen = [];
const events = createCameraEvents({
pose: () => eye,
world: () => eye,
following: () => following,
report: (error) => assert.fail(error),
});
events.on('moveStart', () => seen.push('start'));
events.on('moveEnd', () => seen.push('end'));
events.stepMoveDetection(0);
eye = view(7e6 + 1);
events.stepMoveDetection(16);
assert.deepEqual(seen, ['start']);
events.stepMoveDetection(16 + MOVE_END_WAIT_MS - 1);
assert.deepEqual(seen, ['start']);
// A later change starts the wait again, and moveStart is not repeated.
eye = view(7e6 + 2);
events.stepMoveDetection(400);
events.stepMoveDetection(16 + MOVE_END_WAIT_MS);
assert.deepEqual(seen, ['start']);
events.stepMoveDetection(400 + MOVE_END_WAIT_MS - 1);
assert.deepEqual(seen, ['start']);
following = true;
events.stepMoveDetection(400 + MOVE_END_WAIT_MS);
assert.deepEqual(seen, ['start'], 'never while following');
following = false;
events.stepMoveDetection(401 + MOVE_END_WAIT_MS);
assert.deepEqual(seen, ['start', 'end']);
});
test('command hooks run before each command, each registration on its own', () => {
const events = createCameraEvents({ pose: () => view(1), report() {} });
const seen = [];
const hook = (c) => seen.push(c.kind);
const offFirst = events.onCommand(hook);
events.onCommand(hook);
events.command('setView');
assert.deepEqual(seen, ['setView', 'setView']);
offFirst();
offFirst();
events.command('flyTo');
assert.deepEqual(seen, ['setView', 'setView', 'flyTo'], 'one twin is left');
// A hook removed by an earlier one in the same delivery does not run.
const order = [];
const removing = createCameraEvents({ pose: () => view(1), report() {} });
let offSecond = null;
removing.onCommand(() => {
order.push('first');
offSecond();
});
offSecond = removing.onCommand(() => order.push('second'));
removing.command('setView');
removing.command('setView');
assert.deepEqual(order, ['first', 'first']);
const reported = [];
const throwing = createCameraEvents({
pose: () => view(1),
report: (error) => reported.push(error.message),
});
throwing.onCommand(() => {
throw new Error('boom');
});
throwing.onCommand(() => seen.push('after'));
throwing.command('flyTo');
assert.deepEqual(reported, ['boom']);
assert.equal(seen.at(-1), 'after');
});
test('the geo export has the geodesic point and the horizon test', () => {
const half = geodesicAt(0, 0, Math.PI / 2, 0, 0.5);
assert.ok(Math.abs(half.lon - Math.PI / 4) < 1e-12);
assert.ok(Math.abs(half.lat) < 1e-12);
const horizon = horizonFrom({ x: 7e6, y: 0, z: 0 });
assert.equal(horizon.isPointVisible({ x: 6378137, y: 0, z: 0 }), true);
assert.equal(horizon.isPointVisible({ x: -6378137, y: 0, z: 0 }), false);
});
+129 -7
View File
@@ -10,11 +10,20 @@
* Cesium has one `changed` threshold per camera, where the contract has one
* per listener, so a script that listens at several thresholds is run once
* per threshold and each count is taken from its own run.
*
* A script with `input` steps runs a real `ScreenSpaceCameraController`
* over a stand-in canvas: its pointer and wheel events go to the
* controller's own event handler as the DOM would give them (mouse events,
* Cesium's choice where there are no pointer events), and the controller
* updates each frame where Cesium's scene updates it, after the tweens.
* `Date`, which the controller's inertia reads, runs on the virtual clock
* too.
*/
import * as Cesium from 'cesium';
import {
CAMERA_SCRIPTS,
SCRIPT_VIEWPORT,
usesInput,
} from '../conformance/cameraScripts.js';
import { runCameraScript } from '../conformance/cameraRunner.js';
import { updateCameraChanged } from './internals.js';
@@ -36,23 +45,79 @@ const EASINGS = {
/** One frame of the virtual clock, ms. */
export const FRAME_MS = 1000 / 60;
/** Run `fn` with `performance.now()` reading the virtual clock. */
/** The epoch `Date` reads at virtual time 0. */
const VIRTUAL_EPOCH_MS = Date.UTC(2026, 0, 1);
/** Run `fn` with `performance.now()` and `Date` reading the virtual clock. */
export async function withVirtualClock(fn) {
const real = Object.getOwnPropertyDescriptor(globalThis, 'performance');
const RealDate = globalThis.Date;
const clock = { now: 0 };
Object.defineProperty(globalThis, 'performance', {
configurable: true,
value: { now: () => clock.now, mark() {}, measure() {} },
});
// A function, not a subclass: `Date()` called plainly still gives a
// string, and dates made before stay `instanceof Date`.
function VirtualDate(...args) {
if (!new.target)
return new RealDate(VIRTUAL_EPOCH_MS + clock.now).toString();
return args.length
? new RealDate(...args)
: new RealDate(VIRTUAL_EPOCH_MS + clock.now);
}
Object.setPrototypeOf(VirtualDate, RealDate);
VirtualDate.prototype = RealDate.prototype;
VirtualDate.now = () => VIRTUAL_EPOCH_MS + clock.now;
globalThis.Date = VirtualDate;
try {
return await fn(clock);
} finally {
globalThis.Date = RealDate;
if (real) Object.defineProperty(globalThis, 'performance', real);
}
}
/** A Cesium camera on a scene with no globe, sized as the scripts' viewport. */
export function headlessCamera() {
/**
* A canvas for a controller's event handler: it keeps the listeners the
* handler adds, and `dispatch` calls them as the DOM would. Its root
* events stay on it (`disableRootEvents`), as there is no document; the
* handler still compares its element with one, so a `document` stands in
* while an event is handled, where there is none.
*/
function standInCanvas() {
const listeners = new Map();
return {
clientWidth: SCRIPT_VIEWPORT.width,
clientHeight: SCRIPT_VIEWPORT.height,
disableRootEvents: true,
onwheel: null,
getBoundingClientRect: () => ({ left: 0, top: 0 }),
addEventListener(type, fn) {
if (!listeners.has(type)) listeners.set(type, new Set());
listeners.get(type).add(fn);
},
removeEventListener(type, fn) {
listeners.get(type)?.delete(fn);
},
dispatch(type, event) {
const own = typeof globalThis.document === 'undefined';
if (own) globalThis.document = {};
try {
for (const fn of [...(listeners.get(type) ?? [])]) fn(event);
} finally {
if (own) delete globalThis.document;
}
},
};
}
/**
* A Cesium camera on a scene with no globe, sized as the scripts' viewport.
* With `input`, the scene has a real controller over a stand-in canvas.
* @param {{input?: boolean}} [options]
*/
export function headlessCamera({ input = false } = {}) {
const scene = {
canvas: {
clientWidth: SCRIPT_VIEWPORT.width,
@@ -75,9 +140,58 @@ export function headlessCamera() {
const camera = new Cesium.Camera(scene);
scene.camera = camera;
camera.frustum.aspectRatio = SCRIPT_VIEWPORT.width / SCRIPT_VIEWPORT.height;
if (input) {
scene.canvas = standInCanvas();
// What the controller's update reads off a real scene.
scene.verticalExaggeration = 1;
scene.verticalExaggerationRelativeHeight = 0;
scene.screenSpaceCameraController = new Cesium.ScreenSpaceCameraController(
scene,
);
}
return { scene, camera };
}
/**
* Send a script pointer event (`ScriptPointer`, `cameraRunner.js`) to a
* scene made by `headlessCamera({ input: true })`, as the DOM mouse or
* wheel event Cesium reads.
*/
export function dispatchPointer(scene, ev) {
scene.canvas.dispatch(DOM_TYPES[ev.type], domEvent(ev));
}
function domEvent(ev) {
const at = ev.endPosition ?? ev.position;
return {
button: ev.button,
clientX: at.x,
clientY: at.y,
shiftKey: ev.modifiers.shift,
ctrlKey: ev.modifiers.ctrl,
altKey: ev.modifiers.alt,
metaKey: ev.modifiers.meta,
...(ev.wheel
? {
deltaX: 0,
deltaY: ev.wheel.deltaY,
deltaMode: ev.wheel.deltaMode,
DOM_DELTA_PIXEL: 0,
DOM_DELTA_LINE: 1,
DOM_DELTA_PAGE: 2,
}
: {}),
preventDefault() {},
};
}
const DOM_TYPES = {
down: 'mousedown',
move: 'mousemove',
up: 'mouseup',
wheel: 'wheel',
};
const cart = (p) => new Cesium.Cartesian3(p.x, p.y, p.z);
const toEcef = (p) =>
'lon' in p
@@ -101,8 +215,9 @@ function orientationOf(orientation) {
}
/** A driver for {@link runCameraScript} over a headless Cesium camera. */
function cesiumDriver(clock, threshold) {
const { scene, camera } = headlessCamera();
function cesiumDriver(clock, threshold, input = false) {
const { scene, camera } = headlessCamera({ input });
const controller = input ? scene.screenSpaceCameraController : null;
let flying = false;
let changedCount = 0;
camera.percentageChanged = threshold ?? 0.5;
@@ -223,8 +338,14 @@ function cesiumDriver(clock, threshold) {
frame() {
clock.now += FRAME_MS;
scene.tweens.update();
controller?.update();
updateCameraChanged(camera);
},
...(input
? {
pointer: (ev) => dispatchPointer(scene, ev),
}
: {}),
listen: () => () => changedCount,
pose() {
const c = camera.positionCartographic;
@@ -295,14 +416,15 @@ async function recordScript(script) {
const thresholds = script.steps
.filter((step) => step.do === 'listen')
.map((step) => step.threshold);
const input = usesInput(script);
const base = await withVirtualClock((clock) =>
runCameraScript(cesiumDriver(clock, undefined), script),
runCameraScript(cesiumDriver(clock, undefined, input), script),
);
if (!thresholds.length) return base;
const counts = [];
for (const threshold of thresholds) {
const run = await withVirtualClock((clock) =>
runCameraScript(cesiumDriver(clock, threshold), script),
runCameraScript(cesiumDriver(clock, threshold, input), script),
);
const changed = run.records.find((r) => r.kind === 'changed');
counts.push({ threshold, count: changed.value[0].count });
+58 -10
View File
@@ -11,8 +11,14 @@ import {
CAMERA_SCRIPTS,
DEFAULT_TOLERANCE,
runConformance,
usesInput,
} from '../conformance/index.js';
import { FRAME_MS, headlessCamera, withVirtualClock } from './cameraGoldens.js';
import {
FRAME_MS,
dispatchPointer,
headlessCamera,
withVirtualClock,
} from './cameraGoldens.js';
import { createCesiumCamera } from './camera.js';
import { createCesiumPorts } from './ports.js';
import { cameraOf } from '../rendererOf.js';
@@ -27,14 +33,20 @@ const QUERY_RECORDS = new Set([
/** Commands and records the port does not have yet. */
const MISSING = new Set([]);
const runnable = CAMERA_SCRIPTS.filter((script) =>
script.steps.every(
(step) =>
!MISSING.has(step.do) &&
!MISSING.has(step.record) &&
!QUERY_RECORDS.has(step.record),
),
const runnable = CAMERA_SCRIPTS.filter(
(script) =>
!usesInput(script) &&
script.steps.every(
(step) =>
!MISSING.has(step.do) &&
!MISSING.has(step.record) &&
!QUERY_RECORDS.has(step.record),
),
).map((script) => `camera.trace.${script.name}`);
/** The scripts that drive the camera by pointer and wheel. */
const INPUT_CHECKS = new Set(
CAMERA_SCRIPTS.filter(usesInput).map((s) => `camera.trace.${s.name}`),
);
const CHECKS = new Set([
...runnable,
@@ -42,11 +54,11 @@ const CHECKS = new Set([
'camera.controls.settings',
]);
function headlessHarness(clock) {
function headlessHarness(clock, { input = false } = {}) {
return {
name: 'cesium (headless camera)',
async create() {
const { scene } = headlessCamera();
const { scene } = headlessCamera({ input });
for (const name of ['preUpdate', 'postUpdate', 'preRender', 'postRender'])
scene[name] = new Cesium.Event();
scene.primitives = { add() {}, remove() {} };
@@ -65,10 +77,30 @@ function headlessHarness(clock) {
frameScene() {
clock.now += FRAME_MS;
scene.tweens.update();
if (input) scene.screenSpaceCameraController.update();
scene.postUpdate.raiseEvent(scene);
},
scene,
};
},
...(input
? {
cameraInput: true,
// The contract's event back as the DOM's, a wheel in lines: at 40
// px a line, Cesium reads the pixels the script scrolled.
pointer: (r, type, x, y, extra) =>
dispatchPointer(r.scene, {
type,
position: { x, y },
endPosition: extra.endPosition,
button: extra.button ?? 0,
modifiers: extra.modifiers,
...(type === 'wheel'
? { wheel: { deltaY: extra.delta, deltaMode: 1 } }
: {}),
}),
}
: {}),
frame: async (r) => r.frameScene(),
now: () => clock.now,
toEcef: (p) => {
@@ -96,6 +128,22 @@ test('the camera port retraces the reference flights, views and frames', async (
assert.equal(report.passed, CHECKS.size);
});
test('Cesium’s own controls under the camera port retrace the drags and wheels, each wheel sent back in the input port’s lines', async () => {
assert.ok(INPUT_CHECKS.size >= 4, `only ${INPUT_CHECKS.size} input scripts`);
const report = await withVirtualClock((clock) =>
runConformance(headlessHarness(clock, { input: true }), {
only: (id) => INPUT_CHECKS.has(id),
}),
);
assert.deepEqual(
report.results
.filter((r) => r.status !== 'pass')
.map((r) => `${r.id}: ${r.status} ${r.detail}`),
[],
);
assert.equal(report.passed, INPUT_CHECKS.size);
});
test('a cancelled flight has let go before its callbacks, so they can fly again', async () => {
await withVirtualClock(async (clock) => {
const { scene, camera } = headlessCamera();
+206 -10
View File
@@ -323,6 +323,13 @@ export const SETTLE_FRAMES = 30;
export const FEW_LOOSE_LINES = 64;
export const LONG_SETTLE_FRAMES = 300;
/**
* Clamped fills a set draws alone at most, each where it last moved
* (`moveShape`): an upsert that would draw more alone rebuilds the set's
* batches instead, as each costs a primitive and is built in the frame.
*/
export const MOVING_SHAPES = 16;
/** What `syncIcons` did: icons added or removed, or only changed in place. */
const ICONS_CHANGED = 'changed';
const ICONS_KEPT = 'kept';
@@ -446,8 +453,8 @@ export function createCesiumDraw({
return;
}
// Lines that only change how they show or where an undraped one
// runs, and clamped shapes that only show or hide, are changed
// where they are.
// runs, and clamped shapes that only show or hide, or a few colour
// fills that only move (`moveShape`), are changed where they are.
if (
patchLines(record, list) ||
patchShapes(record, list) ||
@@ -661,7 +668,12 @@ export function createCesiumDraw({
) {
record.retiring = old;
if (record.own) old.remove(record.own);
} else if (old) scene.primitives.remove(old);
} else if (old) {
scene.primitives.remove(old);
// Shapes drawn alone in the host that goes show again where the host
// still retiring draws them, until the new one is ready.
showRetiringShapes(record);
}
if (!waiting || !groundShown) retire(record);
// Hidden one by one: a hidden collection would not build them.
if (waiting) for (const primitive of waiting) primitive.show = false;
@@ -754,6 +766,8 @@ export function createCesiumDraw({
record.retiring = null;
record.retiringFlows = null;
record.retiringParts = null;
record.retiringShapeParts = null;
record.retiringHiddenShapes = null;
}
/**
@@ -2627,7 +2641,10 @@ export function createCesiumDraw({
* and the lines drawn alone since, hidden in their batches.
*/
function showPending(record) {
for (const part of record.shapeParts?.values() ?? [])
for (const part of record.shapeParts?.values() ?? []) {
// A shape drawn alone since it moved stays hidden in its batch.
if (part.batchHidden && part.batch && !part.batch.isDestroyed())
showOn(part.batch, part.id, false);
if (
part.pendingShow !== undefined &&
part.ground &&
@@ -2636,6 +2653,7 @@ export function createCesiumDraw({
showOn(part.ground, part.id, part.pendingShow);
part.pendingShow = undefined;
}
}
for (const part of record.lineParts?.values() ?? []) {
if (part.batchHidden && part.batch && !part.batch.isDestroyed())
showOn(part.batch, part.id, false);
@@ -2871,6 +2889,9 @@ export function createCesiumDraw({
// Each clamped item as drawn, for upserts that only show or hide it;
// the set keeps them once every one is built.
const parts = new Map();
// The shapes as the host this build replaces draws them, while it
// still draws; a host already retiring keeps its own.
if (!record.retiring) record.retiringShapeParts = record.shapeParts ?? null;
record.shapeParts = null;
for (const item of items) {
if (item.outline)
@@ -3086,29 +3107,198 @@ export function createCesiumDraw({
* Upsert clamped shapes in place, without a rebuild, when every item is
* drawn now and looks the same: then only whether it shows and its
* `meta` change. A ground primitive still building takes the show once
* it is ready (`swapReady`). False, changing nothing, otherwise.
* it is ready (`swapReady`). A plain colour fill whose geometry alone
* changed is drawn alone where it now is (`moveShape`), while no more
* than `MOVING_SHAPES` would be. False, changing nothing, otherwise.
*/
function patchShapes(record, list) {
const parts = record.shapeParts;
if (record.kind !== 'shapes' || !parts) return false;
// Each item's way in: `true` moves it (`moveShape`), else it only
// shows, hides or takes its `meta`.
const moves = [];
for (const item of list) {
const was = parts.get(item.id);
if (!was || !sameLook(was, item)) return false;
if (was.ground?.isDestroyed()) return false;
if (!was) return false;
if (was.ground?.isDestroyed() || was.batch?.isDestroyed()) return false;
if (sameLook(was, item)) {
moves.push(false);
continue;
}
if (!movable(record, was, item)) return false;
moves.push(true);
}
for (const item of list) {
// Drawn alone after this upsert: a few at most, or the batches rebuild.
const alone = new Set();
for (const [id, part] of parts) if (part.solo) alone.add(id);
list.forEach((item, k) => moves[k] && alone.add(item.id));
// Those the host still retiring draws alone count too, until it goes.
let retiringAlone = 0;
if (record.retiring)
for (const part of record.retiringShapeParts?.values() ?? [])
if (part.solo && part.ground && !part.ground.isDestroyed())
retiringAlone += 1;
if (alone.size + retiringAlone > MOVING_SHAPES) return false;
list.forEach((item, k) => {
const was = parts.get(item.id);
if (!was.ground) continue;
if (moves[k]) return moveShape(record, was, item);
if (!was.ground) return;
was.id.meta = item.meta;
const show = item.show !== false;
if (was.ground.ready) {
showOn(was.ground, was.id, show);
was.pendingShow = undefined;
} else if (was.solo) {
// Not yet drawn, it is built again showing as asked.
moveShape(record, was, item);
} else was.pendingShow = show;
}
});
return true;
}
/** Whether a clamped item is a plain colour fill, drawn in a batch. */
const colourFill = (item) =>
item.height === 'clampGround' &&
Boolean(item.fill) &&
!item.outlineOnly &&
!item.outline &&
item.extrudeHeight === undefined &&
(typeof item.fill !== 'object' || Array.isArray(item.fill));
/** How a clamped shape draws, but for its geometry, show and `meta`. */
const placedLookOf = (item) => {
const { show, meta, geometry, ...look } = item;
return plainCopy(look);
};
/**
* Whether a clamped colour fill's upsert moves or reshapes it and nothing
* else: then it is drawn alone where it now is, built in this frame,
* which needs Cesium's terrain heights loaded.
*/
function movable(record, was, item) {
if (!was.id || !was.ground || !colourFill(item)) return false;
if (!colourFill(was.look)) return false;
if (!sameValues(placedLookOf(was.look), placedLookOf(item))) return false;
// Refused geometry (an ellipse radius by camera height) rebuilds, to throw.
const g = item.geometry;
if (
g?.kind === 'ellipse' &&
(typeof g.semiMajor !== 'number' || typeof g.semiMinor !== 'number')
)
return false;
if (!['polygon', 'ellipse', 'rectangle'].includes(g?.kind)) return false;
return groundSyncs() && typeof record.host?.add === 'function';
}
/**
* Draw a clamped colour fill where it now is, in this frame: on a ground
* primitive of its own built at once, in place of its own one (or of its
* place in its batch, hidden there), as a moved draped line is drawn
* (`moveDraped`). A shape dragged every frame draws every frame, where a
* rebuild would build its batch anew each time and never finish.
*/
function moveShape(record, part, item) {
const host = record.host;
if (part.solo) {
if (part.ground && !part.ground.isDestroyed()) host.remove(part.ground);
} else {
part.batch = part.ground;
part.batchHidden = true;
// Its batch draws on without it, hidden now or once it is ready.
if (part.batch.ready) showOn(part.batch, part.id, false);
}
hideRetiringShape(record, item.id);
record.shapesStill = 0;
part.solo = true;
part.pendingShow = undefined;
part.look = lookOf(item);
part.id.meta = item.meta;
const pickable = record.spec.pickable !== false;
const Ground = pickable
? Cesium.GroundPrimitive
: UnpickableGroundPrimitive;
part.ground = new Ground({
geometryInstances: [
new Cesium.GeometryInstance({
geometry: groundGeometry(item),
attributes: {
color: Cesium.ColorGeometryInstanceAttribute.fromColor(
toColor(item.fill),
),
show: new Cesium.ShowGeometryInstanceAttribute(item.show !== false),
},
id: part.id,
}),
],
classificationType: classificationOf(
item.clampTo ?? record.spec.clampTo ?? 'both',
),
allowPicking: pickable,
asynchronous: false,
});
host.add(part.ground);
}
/**
* Hide where the host a set is rebuilding from still draws a clamped
* shape, once it is drawn where it now is: else both would draw (and
* pick) until the rebuild is ready.
*/
function hideRetiringShape(record, id) {
const part = record.retiring && record.retiringShapeParts?.get(id);
const ground = part?.ground;
if (!ground || ground.isDestroyed() || !ground.ready) return;
const hidden = (record.retiringHiddenShapes ??= new Set());
// Only one it drew: one hidden there already stays hidden.
if (!hidden.has(id) && !shownOn(ground, part.id)) return;
showOn(ground, part.id, false);
hidden.add(id);
}
/** Whether the instance under pick id `id` in a ready ground primitive shows. */
const shownOn = (ground, id) =>
ground.getGeometryInstanceAttributes(id).show[0] !== 0;
/**
* Show again the shapes `hideRetiringShape` hid where the retiring host
* draws them: the host that drew them alone is gone before it was ready.
*/
function showRetiringShapes(record) {
const hidden = record.retiringHiddenShapes;
record.retiringHiddenShapes = null;
if (!record.retiring || !hidden) return;
for (const id of hidden) {
const ground = record.retiringShapeParts?.get(id)?.ground;
if (!ground || ground.isDestroyed() || !ground.ready) continue;
// As it is now: one since hidden or removed stays hidden.
const item = record.items.get(id);
if (!item || item.show === false) continue;
showOn(ground, record.retiringShapeParts.get(id).id, true);
}
}
/**
* After a draw: a shape set whose shapes drawn alone have not moved for
* `SETTLE_FRAMES` drawn frames rebuilds, so they go back into its
* batches; the host drawing them alone draws until the rebuild is ready.
*/
function settleShapes(record) {
if (record.pending || !record.shapeParts) return;
let alone = false;
for (const part of record.shapeParts.values())
if (part.solo) {
alone = true;
break;
}
if (!alone) return;
record.shapesStill = (record.shapesStill ?? 0) + 1;
if (record.shapesStill < SETTLE_FRAMES) return;
record.shapesStill = 0;
record.rebuild();
requestRender();
}
/** Whether a hidden clamped item is a plain colour fill `groundFills` builds. */
const hiddenFillBuilds = (item) =>
Boolean(item.fill) &&
@@ -3397,6 +3587,12 @@ export function createCesiumDraw({
record.lineBox = null;
report(error);
}
else if (record.kind === 'shapes')
try {
settleShapes(record);
} catch (error) {
report(error);
}
// Rows moving on a live clock, and flowing lines, draw on in the
// frames that follow.
const playing = quadSets.afterRender(sets.values());
+385
View File
@@ -6,6 +6,7 @@ import {
createCesiumDraw,
FEW_LOOSE_LINES,
LONG_SETTLE_FRAMES,
MOVING_SHAPES,
revealUniform,
SETTLE_FRAMES,
unboundDrawPart,
@@ -6075,3 +6076,387 @@ test('a clamped ellipse filled with a radial rim drapes its material, finely cut
assert.deepEqual([...shows.show], [0]);
set.dispose();
}));
test('a clamped fill that moves or resizes is drawn where it now is in the same frame, once terrain heights are loaded', () =>
withTerrainHeights(() => {
const { scene, draw, frame } = drawOver();
const set = draw.shapes({ id: 'dragged' });
const box = (id, east, extra = {}) => ({
id,
geometry: {
kind: 'rectangle',
rect: { west: 0, south: 0, east, north: 1 },
},
fill: [0.5, 0.9, 1, 0.12],
height: 'clampGround',
...extra,
});
set.set([
box('a', 1),
box('b', 3, {
geometry: {
kind: 'rectangle',
rect: { west: 2, south: 0, east: 3, north: 1 },
},
}),
]);
const host = scene.added[0];
const groundOf = (h) => {
for (let i = 0; i < h.length; i++)
if (h.get(i) instanceof Cesium.GroundPrimitive) return h.get(i);
return null;
};
const batch = groundOf(host);
const shows = new Map();
const attributesOf = (primitive) => {
primitive.getGeometryInstanceAttributes = (id) => {
const key = `${primitive.geometryInstances.length}:${id.id}`;
if (!shows.has(key)) shows.set(key, { show: new Uint8Array([1]) });
return shows.get(key);
};
};
attributesOf(batch);
// Resized while its batch still builds: drawn alone, built at once.
set.upsert([box('a', 1.5, { meta: 'dragged' })]);
assert.equal(scene.added[0], host, 'the set is not rebuilt');
const solo = host.get(host.length - 1);
assert.ok(solo instanceof Cesium.GroundPrimitive);
assert.equal(solo.asynchronous, false, 'built in the frame it is drawn');
const instance = solo.geometryInstances[0];
assert.equal(instance.id.id, 'a');
assert.equal(instance.id.meta, 'dragged');
assert.equal(
instance.id,
batch.geometryInstances.find((i) => i.id.id === 'a').id,
'the same pick id',
);
assert.ok(
Cesium.Rectangle.equalsEpsilon(
instance.geometry._rectangle,
Cesium.Rectangle.fromDegrees(0, 0, 1.5, 1),
1e-12,
),
);
// Its place in the batch is hidden once the batch is ready; the rest draws.
Object.defineProperty(batch, 'ready', { value: true });
frame();
assert.deepEqual([...shows.get('2:a').show], [0], 'hidden in the batch');
assert.equal(shows.get('2:b'), undefined, 'the other untouched');
// Moved again: the one built for it is replaced.
set.upsert([box('a', 2)]);
const again = host.get(host.length - 1);
assert.notEqual(again, solo);
assert.ok(solo.isDestroyed(), 'the old one goes');
// A show change on a ready one is in place; one not yet drawn is built again.
Object.defineProperty(again, 'ready', { value: true });
attributesOf(again);
set.upsert([box('a', 2, { show: false })]);
assert.equal(host.get(host.length - 1), again);
assert.deepEqual([...shows.get('1:a').show], [0]);
// A new colour is a new look: the set rebuilds.
set.upsert([box('a', 2, { fill: [1, 0, 0, 0.5] })]);
assert.notEqual(scene.added.at(-1), host, 'rebuilt');
set.dispose();
assert.equal(scene.added.length, 0);
}));
test('a moved clamped fill is hidden where a rebuild in flight still draws it', () =>
withTerrainHeights(() => {
const { scene, draw, frame } = drawOver();
const set = draw.shapes({ id: 'retiring' });
const box = (id, east, fill = [0.5, 0.9, 1, 0.12]) => ({
id,
geometry: {
kind: 'rectangle',
rect: { west: 0, south: 0, east, north: 1 },
},
fill,
height: 'clampGround',
});
set.set([box('a', 1)]);
const first = scene.added[0];
const groundOf = (h) => {
for (let i = 0; i < h.length; i++)
if (h.get(i) instanceof Cesium.GroundPrimitive) return h.get(i);
return null;
};
const old = groundOf(first);
Object.defineProperty(old, 'ready', { value: true });
frame();
const shown = { show: new Uint8Array([1]) };
old.getGeometryInstanceAttributes = () => shown;
// A new colour rebuilds; the old host draws on until the new is ready.
set.upsert([box('a', 1, [1, 0, 0, 0.5])]);
const second = scene.added.find((p) => p !== first);
assert.ok(
second && scene.added.includes(first),
'both drawn while it builds',
);
// Moved meanwhile: drawn alone in the new host, and gone from the old one.
set.upsert([box('a', 2, [1, 0, 0, 0.5])]);
assert.ok(second.get(second.length - 1).asynchronous === false);
assert.deepEqual(
[...shown.show],
[0],
'hidden where the old host draws it',
);
set.dispose();
}));
/** A clamped colour rectangle from 0° to `east`°, for the move tests. */
const groundBox = (id, east, extra = {}) => ({
id,
geometry: {
kind: 'rectangle',
rect: { west: 0, south: 0, east, north: 1 },
},
fill: [0.5, 0.9, 1, 0.12],
height: 'clampGround',
...extra,
});
/** Every ground primitive in a host built, with a show to read and set. */
const groundsReady = (host) => {
for (let i = 0; i < host.length; i++) {
const ground = host.get(i);
if (!(ground instanceof Cesium.GroundPrimitive)) continue;
Object.defineProperty(ground, 'ready', { value: true });
const show = { show: new Uint8Array([1]) };
ground.getGeometryInstanceAttributes = () => show;
}
};
/** The first ground primitive in a host, or null. */
const firstGround = (host) => {
for (let i = 0; i < host.length; i++)
if (host.get(i) instanceof Cesium.GroundPrimitive) return host.get(i);
return null;
};
test('moved clamped fills go back into a rebuilt batch once they have been still for a while', () =>
withTerrainHeights(() => {
const { scene, draw, frame } = drawOver();
const set = draw.shapes({ id: 'settling' });
set.set([groundBox('a', 1), groundBox('b', 2)]);
const host = scene.added[0];
groundsReady(host);
frame();
set.upsert([groundBox('a', 1.5)]);
for (let i = 0; i < SETTLE_FRAMES - 1; i++) frame();
// Moved again before it settled: it waits from there.
set.upsert([groundBox('a', 1.6)]);
for (let i = 0; i < SETTLE_FRAMES - 1; i++) frame();
assert.deepEqual(scene.added, [host], 'not rebuilt while it moves');
frame();
assert.equal(scene.added.length, 2, 'rebuilt once still');
const rebuilt = scene.added.find((p) => p !== host);
const instances = [];
for (let i = 0; i < rebuilt.length; i++)
if (rebuilt.get(i) instanceof Cesium.GroundPrimitive)
instances.push(...rebuilt.get(i).geometryInstances);
assert.deepEqual(
instances.map((i) => i.id.id).sort(),
['a', 'b'],
'both in the new batches',
);
assert.ok(
rebuilt.get(0).asynchronous !== false,
'built as a batch, not alone',
);
assert.ok(
Cesium.Rectangle.equalsEpsilon(
instances.find((i) => i.id.id === 'a').geometry._rectangle,
Cesium.Rectangle.fromDegrees(0, 0, 1.6, 1),
1e-12,
),
'where it last moved',
);
// The host drawing it alone draws until the rebuild is ready.
assert.ok(scene.added.includes(host));
for (let i = 0; i < SETTLE_FRAMES * 2; i++) frame();
assert.equal(scene.added.length, 2, 'it settles once');
set.dispose();
}));
test('an upsert that would draw more clamped fills alone than MOVING_SHAPES rebuilds instead', () =>
withTerrainHeights(() => {
const { scene, draw, frame } = drawOver();
const set = draw.shapes({ id: 'many', pickable: false });
const ids = Array.from({ length: MOVING_SHAPES + 1 }, (_, i) => `s${i}`);
set.set(ids.map((id) => groundBox(id, 1)));
const host = scene.added[0];
groundsReady(host);
frame();
// A set that does not pick draws one alone without picking.
set.upsert([groundBox('s0', 1.5)]);
const solo = host.get(host.length - 1);
assert.equal(solo.asynchronous, false);
assert.equal(solo.allowPicking, false);
assert.deepEqual(scene.added, [host]);
set.upsert(ids.slice(1, MOVING_SHAPES).map((id) => groundBox(id, 1.5)));
assert.deepEqual(scene.added, [host], 'MOVING_SHAPES alone at most');
set.upsert([groundBox(ids.at(-1), 1.5)]);
assert.equal(scene.added.length, 2, 'one more rebuilds the set');
set.dispose();
}));
test('a clamped fill moved before terrain heights load rebuilds its set', () => {
const heights = Cesium.ApproximateTerrainHeights;
if (heights.initialized) return;
const { scene, draw } = drawOver();
const set = draw.shapes({ id: 'no-heights' });
set.set([groundBox('a', 1)]);
const host = scene.added[0];
set.upsert([groundBox('a', 1.5)]);
assert.ok(
!scene.added.includes(host) || scene.added.length > 1,
'rebuilt, not drawn alone',
);
set.dispose();
});
test('a moved clamped fill shows again where the retiring host draws it when the host drawing it alone goes unbuilt', () =>
withTerrainHeights(() => {
const { scene, draw, frame } = drawOver();
const set = draw.shapes({ id: 'twice' });
set.set([groundBox('a', 1)]);
const first = scene.added[0];
const old = firstGround(first);
Object.defineProperty(old, 'ready', { value: true });
frame();
const shown = { show: new Uint8Array([1]) };
old.getGeometryInstanceAttributes = () => shown;
set.upsert([groundBox('a', 1, { fill: [1, 0, 0, 0.5] })]);
set.upsert([groundBox('a', 2, { fill: [1, 0, 0, 0.5] })]);
assert.deepEqual([...shown.show], [0], 'hidden while drawn alone');
// A second rebuild drops the host drawing it alone, still building.
set.upsert([groundBox('a', 2, { fill: [0, 1, 0, 0.5] })]);
assert.ok(scene.added.includes(first), 'the retiring host draws on');
assert.equal(scene.added.length, 2);
assert.deepEqual([...shown.show], [1], 'drawn where it was, not gone');
set.dispose();
}));
/** Ground primitives in a host built, each instance's show kept by id. */
const groundsReadyById = (host, shows = new Map()) => {
for (let i = 0; i < host.length; i++) {
const ground = host.get(i);
if (!(ground instanceof Cesium.GroundPrimitive)) continue;
Object.defineProperty(ground, 'ready', { value: true });
ground.getGeometryInstanceAttributes = (id) => {
if (!shows.has(id.id)) {
const shown = ground.geometryInstances.find((g) => g.id === id)
?.attributes.show.value[0];
shows.set(id.id, { show: new Uint8Array([shown ?? 1]) });
}
return shows.get(id.id);
};
}
return shows;
};
test('a hidden clamped fill moved while its set rebuilds stays hidden when a second rebuild comes', () =>
withTerrainHeights(() => {
const { scene, draw, frame } = drawOver();
const set = draw.shapes({ id: 'hidden-twice' });
set.set([
groundBox('a', 1, { show: false }),
groundBox('b', 1, {
geometry: {
kind: 'rectangle',
rect: { west: 5, south: 0, east: 6, north: 1 },
},
}),
]);
const first = scene.added[0];
const shows = groundsReadyById(first);
frame();
const b = (fill) =>
groundBox('b', 1, {
geometry: {
kind: 'rectangle',
rect: { west: 5, south: 0, east: 6, north: 1 },
},
fill,
});
set.upsert([b([1, 0, 0, 0.5])]);
set.upsert([groundBox('a', 2, { show: false })]);
set.upsert([b([0, 1, 0, 0.5])]);
assert.ok(scene.added.includes(first), 'the retiring host draws on');
assert.deepEqual([...shows.get('a').show], [0], 'a stays hidden');
set.dispose();
}));
test('clamped fills drawn alone by a host still retiring count toward MOVING_SHAPES', () =>
withTerrainHeights(() => {
const { scene, draw, frame } = drawOver();
const set = draw.shapes({ id: 'cap-retiring' });
const ids = Array.from(
{ length: MOVING_SHAPES * 2 + 1 },
(_, i) => `s${i}`,
);
set.set(ids.map((id) => groundBox(id, 1)));
const first = scene.added[0];
groundsReady(first);
frame();
// Half the cap moved, then a rebuild while they are drawn alone.
set.upsert(ids.slice(0, MOVING_SHAPES).map((id) => groundBox(id, 1.5)));
set.upsert([groundBox(ids.at(-1), 1, { fill: [1, 0, 0, 0.5] })]);
assert.equal(scene.added.length, 2, 'rebuilding, the old host retiring');
const second = scene.added.find((p) => p !== first);
const before = second.length;
// Others moved while it builds: over the cap counted with the retiring
// host's, so the set rebuilds rather than draw them alone.
set.upsert([groundBox(ids[MOVING_SHAPES], 1.5)]);
assert.ok(
!scene.added.includes(second) || second.length === before,
'nothing more drawn alone',
);
set.dispose();
}));
test('the recent imagery box preview drags its ground fill and dashed edge frame by frame on a viewer of its own', async () => {
const { createImageryBoxPreview } =
await import('../../layers/recentImagery/rendering.js');
const destroyed = withImageClasses(() =>
withTerrainHeights(() => {
const scene = fakeScene();
const viewer = { scene, isDestroyed: () => false };
let box = { west: -98, south: 30, east: -97.95, north: 30.05 };
const preview = createImageryBoxPreview(viewer, () => box);
preview.setVisible(true);
const hosts = scene.added.slice();
assert.equal(hosts.length, 2, 'a fill set and an edge set');
const groundIn = (host) => {
for (let i = 0; i < host.length; i++)
if (host.get(i) instanceof Cesium.GroundPrimitive) return host.get(i);
return null;
};
const fillHost = hosts.find((h) => groundIn(h));
assert.ok(fillHost, 'the fill is a ground primitive');
// Each move of the drag is drawn in the frame it is made, in place.
for (const east of [-97.9, -97.85, -97.8]) {
box = { ...box, east };
preview.changed();
const solo = fillHost.get(fillHost.length - 1);
assert.ok(solo instanceof Cesium.GroundPrimitive);
assert.equal(solo.asynchronous, false);
assert.ok(
Cesium.Rectangle.equalsEpsilon(
solo.geometryInstances[0].geometry._rectangle,
Cesium.Rectangle.fromDegrees(-98, 30, east, 30.05),
1e-12,
),
);
}
assert.deepEqual(scene.added, hosts, 'no set rebuilt');
const edgeHost = hosts.find((h) => h !== fillHost);
const edge = edgeHost.get(edgeHost.length - 1);
assert.ok(edge instanceof Cesium.GroundPolylinePrimitive);
assert.equal(edge.asynchronous, false);
assert.equal(edge.appearance.material.type, 'PolylineDash');
return preview.destroy().then(() => scene.added.length);
}),
);
assert.equal(await destroyed, 0, 'both sets let go');
});
+8 -16
View File
@@ -7,9 +7,9 @@
*
* Imagery drapes on the globe, or on the drawn base tileset: the photoreal
* tileset this port loaded, or one the application's map stack marked as
* its base (`markBaseTileset`) while it still loads its own. Where each
* layer drapes follows what is drawn, looked at every frame, so a base
* switched outside the port moves the layers with it.
* its base (`markBaseTileset`, `../baseTilesets.js`) while it still loads
* its own. Where each layer drapes follows what is drawn, looked at every
* frame, so a base switched outside the port moves the layers with it.
*
* The sky reads the scene as it was set up and writes through to it; what
* the scene has no part for (stars without a sky box, say) is kept as set.
@@ -17,21 +17,13 @@
import * as Cesium from 'cesium';
import { loadPhotorealisticTileset } from '../../maps/google3d.js';
import { provideUnboundGlobe } from '../rendererOf.js';
import { isBaseTileset, markBaseTileset } from '../baseTilesets.js';
import { listenerList, uncaught } from './common.js';
import { createCesiumImagery } from './imagery.js';
/** Tilesets the application's map stack draws as its base. */
const baseTilesets = new WeakSet();
/**
* Mark a tileset as a base the application draws outside the port, so
* imagery drapes on it while it is shown. For code that still loads its
* own base; the port's own photoreal tileset needs no mark.
* @param {object} tileset Cesium `Cesium3DTileset`.
*/
export function markBaseTileset(tileset) {
if (tileset && typeof tileset === 'object') baseTilesets.add(tileset);
}
// The base marks live outside the adapter, so code that is not Cesium's can
// mark a base; they are re-exported here for the code that still is.
export { markBaseTileset };
/** Ion's world terrain asset. */
const WORLD_TERRAIN_ASSET = 1;
@@ -195,7 +187,7 @@ export function createCesiumGlobe(
if (photoreal && !photoreal.isDestroyed() && photoreal.show)
return photoreal;
for (const tileset of tilesets())
if (baseTilesets.has(tileset) && tileset.show && !tileset.isDestroyed())
if (isBaseTileset(tileset) && tileset.show && !tileset.isDestroyed())
return tileset;
return null;
}
+3 -9
View File
@@ -26,6 +26,7 @@ import * as Cesium from 'cesium';
import { createInputRouter } from '../input/router.js';
import { acquireCameraInput } from './cameraInput.js';
import { installTrackpadPinchZoom } from './ctrlWheelZoom.js';
import { wheelLines } from '../input/wheel.js';
const T = Cesium.ScreenSpaceEventType;
const MODIFIERS = [
@@ -52,8 +53,6 @@ const DOM_EVENTS = [
'touchcancel',
'dblclick',
];
/** A wheel notch scrolls 100 px in Chrome, which it counts as three lines. */
const PX_PER_LINE = 100 / 3;
/** A drill is run at least this deep and sliced, so asks share one pass. */
const DRILL_DEPTH = 16;
const NO_MODIFIERS = Object.freeze({
@@ -440,16 +439,11 @@ export function createCesiumInput(
const onWheel = (event) => {
const rect = canvas.getBoundingClientRect?.() ?? { left: 0, top: 0 };
const lines =
event.deltaMode === 1
? event.deltaY
: event.deltaMode === 2
? (event.deltaY * (canvas.clientHeight || 0)) / PX_PER_LINE
: event.deltaY / PX_PER_LINE;
deliver(
'wheel',
{ x: event.clientX - rect.left, y: event.clientY - rect.top },
{ delta: lines },
// Lines as the reference counts them (`../input/wheel.js`).
{ delta: wheelLines(event) },
event,
);
};
+10 -2
View File
@@ -240,7 +240,7 @@ test('ctrlWheelZoom installs the zoom and takes it out again', () => {
assert.deepEqual(s.wheelZoom, ['on', 'off', 'on', 'off']);
});
test('wheel is in lines, where the pointer is over the canvas', () => {
test('wheel is in lines as the reference counts them, where the pointer is over the canvas', () => {
const s = setup();
const wheels = [];
s.port.on('wheel', (ev) =>
@@ -259,10 +259,18 @@ test('wheel is in lines, where the pointer is over the canvas', () => {
deltaY: -3,
deltaMode: 1,
});
s.canvas.dispatch('wheel', {
clientX: 10,
clientY: 20,
deltaY: 1,
deltaMode: 2,
});
assert.deepEqual(wheels[0][0], { x: 100, y: 200 });
assert.equal(wheels[0][1], 3);
// 40 px a line, 3 lines a page: Cesium's own 40 px a line and 120 a page.
assert.equal(wheels[0][1], 2.5);
assert.equal(wheels[0][2].ctrl, true);
assert.equal(wheels[1][1], -3);
assert.equal(wheels[2][1], 3);
});
test('a pinch is the scale since the last event, at its midpoint', () => {
-1
View File
@@ -8,7 +8,6 @@
"src/cyberSonarScene.js",
"src/data/geoImportPins.js",
"src/input/dispatcher.js",
"src/layers/recentImagery/rendering.js",
"src/layers/traffic/rendering.js",
"src/layers/transit/rendering.js",
"src/layers/weather/shellRendering.js",
+63 -2
View File
@@ -5,6 +5,14 @@
* either a renderer through the contract ({@link contractDriver}) or the
* reference recorder's own.
*/
import { wheelLines } from '../input/wheel.js';
const NO_MODIFIERS = Object.freeze({
shift: false,
ctrl: false,
alt: false,
meta: false,
});
/**
* @typedef {object} CameraDriver
@@ -18,6 +26,20 @@
* @property {(position: object) => boolean} occluded
* @property {() => boolean} flying
* @property {(position: object) => object} toEcef
* @property {(ev: ScriptPointer) => void|Promise<void>} [pointer] For scripts with `input` steps.
*/
/**
* A script's pointer event: `position` is where it happened (for a move,
* where the pointer was) and `endPosition` where a move went; a wheel has
* the DOM's `deltaY` and `deltaMode`.
* @typedef {object} ScriptPointer
* @property {'down'|'move'|'up'|'wheel'} type
* @property {{x: number, y: number}} position
* @property {{x: number, y: number}} [endPosition]
* @property {0|1|2} button
* @property {{shift: boolean, ctrl: boolean, alt: boolean, meta: boolean}} modifiers
* @property {{deltaY: number, deltaMode: number}} [wheel]
*/
/** The parts of a pose a trace keeps. */
@@ -47,8 +69,33 @@ export async function runCameraScript(driver, script) {
const flights = [];
const listeners = [];
let frame = 0;
// Where the pointer is, for the next move's start, and the button held
// since the last press (a move carries it, as an input port reports it).
// Only a press or a move puts the pointer somewhere, as in the reference:
// a wheel or a release elsewhere leaves the next move starting where the
// pointer last went.
let pointerAt = null;
let held = null;
for (const [index, step] of script.steps.entries()) {
if (step.do === 'frames') {
if (step.input) {
const at = { x: step.x, y: step.y };
const ev = {
type: step.input,
position: step.input === 'move' ? (pointerAt ?? at) : at,
...(step.input === 'move' ? { endPosition: at } : {}),
button: step.button ?? (step.input === 'move' ? held : null) ?? 0,
modifiers: { ...NO_MODIFIERS, ...(step.modifiers ?? {}) },
...(step.input === 'wheel'
? { wheel: { deltaY: step.deltaY, deltaMode: step.deltaMode ?? 0 } }
: {}),
};
if (step.input === 'down' || step.input === 'move') pointerAt = at;
if (step.input === 'down') held = ev.button;
else if (step.input === 'up') held = null;
if (!driver.pointer)
throw new Error('this driver takes no pointer input');
await driver.pointer(ev);
} else if (step.do === 'frames') {
for (let i = 0; i < step.count; i++) {
frame += 1;
await driver.frame();
@@ -143,7 +190,10 @@ function resolveArgs(driver, name, args) {
/**
* A driver over a renderer, through the contract only.
* @param {import('../contract/renderer').Renderer} renderer
* @param {{frame: () => void|Promise<void>, toEcef: (p: object) => object}} hooks
* `hooks.pointer(type, x, y, extra)` sends a pointer event the way a
* harness's `pointer` does; a wheel goes as the input port's lines.
* @param {{frame: () => void|Promise<void>, toEcef: (p: object) => object,
* pointer?: (type: string, x: number, y: number, extra: object) => void|Promise<void>}} hooks
* @returns {CameraDriver}
*/
export function contractDriver(renderer, hooks) {
@@ -167,5 +217,16 @@ export function contractDriver(renderer, hooks) {
matrices: () => camera.matrices(),
viewRectangle: () => camera.viewRectangle(),
toEcef: hooks.toEcef,
...(hooks.pointer
? {
pointer: (ev) =>
hooks.pointer(ev.type, ev.position.x, ev.position.y, {
button: ev.button,
modifiers: ev.modifiers,
...(ev.endPosition ? { endPosition: ev.endPosition } : {}),
...(ev.wheel ? { delta: wheelLines(ev.wheel) } : {}),
}),
}
: {}),
};
}
@@ -0,0 +1,50 @@
import assert from 'node:assert/strict';
import test from 'node:test';
import { runCameraScript } from './cameraRunner.js';
/** A driver that only keeps the pointer events the runner sends. */
const pointerDriver = () => {
const events = [];
return {
events,
driver: {
pointer: async (ev) => {
events.push(ev);
},
frame: async () => {},
},
};
};
test('a move starts where the pointer last pressed or moved, not at a wheel or release', async () => {
const { events, driver } = pointerDriver();
await runCameraScript(driver, {
name: 'origins',
steps: [
{ input: 'down', x: 10, y: 10, button: 1 },
{ input: 'wheel', x: 20, y: 20, deltaY: -100 },
{ input: 'move', x: 30, y: 30 },
{ input: 'up', x: 40, y: 40 },
{ input: 'move', x: 50, y: 50 },
],
});
const [, wheel, held, up, free] = events;
assert.deepEqual(wheel.wheel, { deltaY: -100, deltaMode: 0 });
assert.deepEqual(held.position, { x: 10, y: 10 });
assert.deepEqual(held.endPosition, { x: 30, y: 30 });
assert.equal(held.button, 1, 'a move carries the held button');
assert.equal(up.button, 0);
assert.deepEqual(free.position, { x: 30, y: 30 });
assert.equal(free.button, 0, 'nothing is held after the release');
});
test('a first move with no earlier pointer starts where it ends', async () => {
const { events, driver } = pointerDriver();
await runCameraScript(driver, {
name: 'first',
steps: [{ input: 'move', x: 5, y: 6 }],
});
assert.deepEqual(events[0].position, { x: 5, y: 6 });
assert.deepEqual(events[0].endPosition, { x: 5, y: 6 });
});
+137
View File
@@ -19,6 +19,16 @@
* `{ record: 'pickEllipsoid', screen }`, `{ record: 'pickRay', screen }`,
* `{ record: 'occluded', points }`, `{ record: 'changed' }`,
* `{ record: 'flying' }`, `{ record: 'matrices' }`, `{ record: 'viewRectangle' }`.
* - `{ input: 'down' | 'move' | 'up', x, y, button?, modifiers? }`: the
* pointer, in CSS pixels; a move goes from where the pointer last was.
* - `{ input: 'wheel', x, y, deltaY, deltaMode?, modifiers? }`: a wheel as
* the DOM gives it (`deltaMode` 0 pixels, 1 lines, 2 pages); a renderer
* under test gets it as the input port's lines (`render/input/wheel.js`).
*
* A script with `input` steps moves the camera by user input, so it runs
* only where the renderer's camera answers pointer input (a harness with
* `pointer` and `cameraInput`). It starts with a frame, as a pointer event
* on the reference's clock at 0 would be dropped.
*/
/** Where the scripts, scenes and checks look: downtown Austin, degrees. */
@@ -60,9 +70,52 @@ const SCREEN_GRID = [
{ x: 320, y: 540 },
];
/** A drag from `from` to `to` in `moves` moves, a frame after each. */
const drag = ({
from,
to,
moves = 10,
button = 0,
modifiers,
holdFrames = 0,
}) => {
const mods = modifiers ? { modifiers } : {};
const steps = [{ input: 'down', ...from, button, ...mods }];
for (let i = 1; i <= moves; i++)
steps.push(
{
input: 'move',
x: from.x + ((to.x - from.x) * i) / moves,
y: from.y + ((to.y - from.y) * i) / moves,
...mods,
},
{ do: 'frames', count: 1 },
);
if (holdFrames) steps.push({ do: 'frames', count: holdFrames });
steps.push({ input: 'up', ...to, button, ...mods });
return steps;
};
/**
* `count` wheel notches at the centre, `frames` frames after each. The
* reference zooms towards where the pointer last moved, not where the wheel
* says it is, so a script moves the pointer to the centre first (`hover`).
*/
const notches = (count, deltaY, deltaMode, frames = 2) =>
Array.from({ length: count }, () => [
{ input: 'wheel', x: 640, y: 360, deltaY, deltaMode },
{ do: 'frames', count: frames },
]).flat();
/** The pointer moves to the centre with nothing held. */
const hover = { input: 'move', x: 640, y: 360 };
/** The viewport every script runs in, CSS pixels. */
export const SCRIPT_VIEWPORT = Object.freeze({ width: 1280, height: 720 });
/** Whether a script moves the camera by user input (`input` steps). */
export const usesInput = (script) => script.steps.some((step) => step.input);
/** @type {ReadonlyArray<{name: string, steps: object[]}>} */
export const CAMERA_SCRIPTS = Object.freeze([
{
@@ -442,6 +495,90 @@ export const CAMERA_SCRIPTS = Object.freeze([
{ record: 'changed' },
],
},
{
name: 'a left drag turns the globe under the pointer, then coasts',
steps: [
city(5000, 0.2, -1.2),
{ do: 'frames', count: 1 },
...drag({ from: { x: 640, y: 360 }, to: { x: 760, y: 420 } }),
{ record: 'pose' },
{ do: 'frames', count: 20 },
{ record: 'pose' },
{ do: 'frames', count: 60 },
{ record: 'pose' },
START,
{ do: 'frames', count: 1 },
...drag({ from: { x: 600, y: 300 }, to: { x: 500, y: 360 } }),
{ do: 'frames', count: 60 },
{ record: 'pose' },
],
},
{
name: 'thirty pixel-mode wheel notches from 5 km, then out again',
steps: [
city(5000, 0.2, -1.2),
{ do: 'frames', count: 1 },
hover,
...notches(10, -100, 0),
{ record: 'pose' },
...notches(10, -100, 0),
{ record: 'pose' },
...notches(10, -100, 0),
{ record: 'pose' },
{ do: 'frames', count: 60 },
{ record: 'pose' },
...notches(5, 100, 0),
{ do: 'frames', count: 60 },
{ record: 'pose' },
],
},
{
name: 'thirty line-mode wheel notches from 5 km',
steps: [
city(5000, 0.2, -1.2),
{ do: 'frames', count: 1 },
hover,
...notches(10, -3, 1),
{ record: 'pose' },
...notches(20, -3, 1),
{ do: 'frames', count: 60 },
{ record: 'pose' },
],
},
{
name: 'a middle drag tilts about the centre, then coasts',
steps: [
city(2000, 0.3, -1.0),
{ do: 'frames', count: 1 },
...drag({ from: { x: 640, y: 360 }, to: { x: 640, y: 300 }, button: 1 }),
{ record: 'pose' },
{ do: 'frames', count: 60 },
{ record: 'pose' },
],
},
{
name: 'modified drags: Shift looks, Ctrl tilts, held too long to coast',
steps: [
city(2000, 0.3, -0.5),
{ do: 'frames', count: 1 },
...drag({
from: { x: 640, y: 360 },
to: { x: 700, y: 330 },
modifiers: { shift: true },
holdFrames: 30,
}),
{ do: 'frames', count: 10 },
{ record: 'pose' },
...drag({
from: { x: 640, y: 360 },
to: { x: 640, y: 320 },
modifiers: { ctrl: true },
holdFrames: 30,
}),
{ do: 'frames', count: 10 },
{ record: 'pose' },
],
},
{
name: 'projection, picks and the horizon',
steps: [
+16 -1
View File
@@ -3,7 +3,11 @@
* view rules the traces cannot show.
*/
import goldens from '../goldens/camera.json' with { type: 'json' };
import { CAMERA_SCRIPTS, SCRIPT_VIEWPORT } from '../cameraScripts.js';
import {
CAMERA_SCRIPTS,
SCRIPT_VIEWPORT,
usesInput,
} from '../cameraScripts.js';
import { contractDriver, runCameraScript } from '../cameraRunner.js';
import { deepEqual, equal, near, nearAngle, nearVec, ok } from '../expect.js';
@@ -136,6 +140,11 @@ export function cameraChecks() {
async run(h) {
const expected = goldens.scripts[script.name];
ok(expected, `no reference trace for ${script.name}`);
const input = usesInput(script);
if (input && h.cameraInput && !h.pointer)
throw new Error('a harness with cameraInput needs pointer');
if (input && !h.cameraInput)
return { skip: 'the harness has no camera that answers pointer input' };
const r = await fresh(h);
try {
if (script.capability && !r.capabilities.has(script.capability))
@@ -144,6 +153,12 @@ export function cameraChecks() {
contractDriver(r, {
frame: () => h.frame(r),
toEcef: lonLatToEcef(h),
...(input
? {
pointer: (type, x, y, extra) =>
h.pointer(r, type, x, y, extra),
}
: {}),
}),
script,
);
+490
View File
@@ -2312,6 +2312,496 @@
],
"flights": []
},
"a left drag turns the globe under the pointer, then coasts": {
"records": [
{
"step": 24,
"kind": "pose",
"value": {
"position": {
"x": -743874.2827583898,
"y": -5467123.5663921,
"z": 3198867.771901153
},
"direction": {
"x": 0.20397712796409123,
"y": 0.9652906415976404,
"z": -0.1631174684438692
},
"up": {
"x": 0.2033249113752558,
"y": 0.12121518562266298,
"z": 0.9715790545234638
},
"right": {
"x": 0.9576284831195057,
"y": -0.2313457499468691,
"z": -0.17154250872525903
},
"heading": 0.19995498090715547,
"pitch": -1.1999997631348354,
"roll": 6.283185067768231,
"height": 5001.202022602089,
"frameIsIdentity": true
}
},
{
"step": 26,
"kind": "pose",
"value": {
"position": {
"x": -744179.2414489042,
"y": -5466945.298349385,
"z": 3199101.5023454726
},
"direction": {
"x": 0.2040230499283474,
"y": 0.9652742041266187,
"z": -0.1631573042975954
},
"up": {
"x": 0.20331111154933998,
"y": 0.12125033636499621,
"z": 0.971577556272245
},
"right": {
"x": 0.9576216304044657,
"y": -0.231395909166732,
"z": -0.1715131079608628
},
"heading": 0.199925453927559,
"pitch": -1.199999607856077,
"roll": 6.2831849106714515,
"height": 5001.990172385319,
"frameIsIdentity": true
}
},
{
"step": 28,
"kind": "pose",
"value": {
"position": {
"x": -744372.9914909918,
"y": -5466832.025336116,
"z": 3199249.992913194
},
"direction": {
"x": 0.20405222591363384,
"y": 0.9652637587817955,
"z": -0.1631826126832485
},
"up": {
"x": 0.20330234482603304,
"y": 0.1212726692625212,
"z": 0.9715766034020066
},
"right": {
"x": 0.9576172751616003,
"y": -0.23142777636313006,
"z": -0.171494427430424
},
"heading": 0.19990669247367698,
"pitch": -1.19999950921419,
"roll": 6.283184810827273,
"height": 5002.490919151834,
"frameIsIdentity": true
}
},
{
"step": 54,
"kind": "pose",
"value": {
"position": {
"x": 7805906.904869736,
"y": -14670498.917206015,
"z": 13440141.433819043
},
"direction": {
"x": -0.3655537074410778,
"y": 0.6843524703919436,
"z": -0.6308979182439318
},
"up": {
"x": 0.110917768366866,
"y": 0.7050070428413021,
"z": 0.7004729246763767
},
"right": {
"x": 0.9241578521208361,
"y": 0.18608268541862594,
"z": -0.3336247870749348
},
"heading": 0.443475027365972,
"pitch": -1.5693855130982848,
"roll": 0,
"height": 15003040.278641503,
"frameIsIdentity": true
}
}
],
"flights": []
},
"thirty pixel-mode wheel notches from 5 km, then out again": {
"records": [
{
"step": 23,
"kind": "pose",
"value": {
"position": {
"x": -742628.7924789503,
"y": -5463700.648822847,
"z": 3197887.172893453
},
"direction": {
"x": 0.20390710151866062,
"y": 0.9653157014443385,
"z": -0.1630567094457735
},
"up": {
"x": 0.2033459565896657,
"y": 0.12116157542641381,
"z": 0.971581337088575
},
"right": {
"x": 0.9576389277221831,
"y": -0.23126925689597005,
"z": -0.17158733906058854
},
"heading": 0.20002548249494634,
"pitch": -1.1997833418598227,
"roll": 6.283184995415831,
"height": 1432.7693523452285,
"frameIsIdentity": true
}
},
{
"step": 44,
"kind": "pose",
"value": {
"position": {
"x": -742405.2309695639,
"y": -5462642.287276622,
"z": 3197708.399305835
},
"direction": {
"x": 0.20390710151866057,
"y": 0.9653157014443385,
"z": -0.1630567094457731
},
"up": {
"x": 0.20334595658966526,
"y": 0.12116157542641454,
"z": 0.9715813370885751
},
"right": {
"x": 0.9576389277221832,
"y": -0.2312692568959699,
"z": -0.17158733906058796
},
"heading": 0.20003278999578278,
"pitch": -1.1997212353912805,
"roll": 6.283184906110748,
"height": 410.9902001027421,
"frameIsIdentity": true
}
},
{
"step": 65,
"kind": "pose",
"value": {
"position": {
"x": -742341.2056470874,
"y": -5462339.185282548,
"z": 3197657.2007044787
},
"direction": {
"x": 0.20390710151866076,
"y": 0.9653157014443386,
"z": -0.16305670944577244
},
"up": {
"x": 0.20334595658966534,
"y": 0.121161575426415,
"z": 0.971581337088575
},
"right": {
"x": 0.9576389277221832,
"y": -0.23126925689596994,
"z": -0.17158733906058796
},
"heading": 0.20003488343521703,
"pitch": -1.199703445182633,
"roll": 6.28318488053483,
"height": 118.36954505315934,
"frameIsIdentity": true
}
},
{
"step": 67,
"kind": "pose",
"value": {
"position": {
"x": -742333.1507133974,
"y": -5462301.052456831,
"z": 3197650.759482114
},
"direction": {
"x": 0.20390710151866143,
"y": 0.9653157014443386,
"z": -0.16305670944577194
},
"up": {
"x": 0.20334595658966512,
"y": 0.12116157542641479,
"z": 0.9715813370885751
},
"right": {
"x": 0.9576389277221832,
"y": -0.23126925689597047,
"z": -0.1715873390605877
},
"heading": 0.20003514682861567,
"pitch": -1.199701206906512,
"roll": 6.283184877317159,
"height": 81.55550603363947,
"frameIsIdentity": true
}
},
{
"step": 79,
"kind": "pose",
"value": {
"position": {
"x": -742361.5559644367,
"y": -5462435.52562931,
"z": 3197673.474074843
},
"direction": {
"x": 0.2039071015186621,
"y": 0.9653157014443386,
"z": -0.1630567094457709
},
"up": {
"x": 0.2033459565896656,
"y": 0.12116157542641448,
"z": 0.971581337088575
},
"right": {
"x": 0.957638927722183,
"y": -0.23126925689597097,
"z": -0.17158733906058815
},
"heading": 0.2000342180079615,
"pitch": -1.199709099940855,
"roll": 6.283184888664081,
"height": 211.37819848930863,
"frameIsIdentity": true
}
}
],
"flights": []
},
"thirty line-mode wheel notches from 5 km": {
"records": [
{
"step": 23,
"kind": "pose",
"value": {
"position": {
"x": -742556.7099509701,
"y": -5463359.40324807,
"z": 3197829.5312530524
},
"direction": {
"x": 0.20390710151866023,
"y": 0.9653157014443386,
"z": -0.1630567094457732
},
"up": {
"x": 0.203345956589666,
"y": 0.12116157542641305,
"z": 0.9715813370885751
},
"right": {
"x": 0.9576389277221831,
"y": -0.2312692568959697,
"z": -0.17158733906058904
},
"heading": 0.20002783824820192,
"pitch": -1.1997633191576402,
"roll": 6.283184966621368,
"height": 1103.3162549917931,
"frameIsIdentity": true
}
},
{
"step": 65,
"kind": "pose",
"value": {
"position": {
"x": -742322.8917203792,
"y": -5462252.485403653,
"z": 3197642.555757815
},
"direction": {
"x": 0.20390710151865987,
"y": 0.9653157014443383,
"z": -0.16305670944577555
},
"up": {
"x": 0.20334595658966786,
"y": 0.12116157542641243,
"z": 0.9715813370885749
},
"right": {
"x": 0.9576389277221826,
"y": -0.23126925689597005,
"z": -0.17158733906059095
},
"heading": 0.20003548230067558,
"pitch": -1.1996983561368815,
"roll": 6.2831848732190485,
"height": 34.668143935951555,
"frameIsIdentity": true
}
}
],
"flights": []
},
"a middle drag tilts about the centre, then coasts": {
"records": [
{
"step": 24,
"kind": "pose",
"value": {
"position": {
"x": -743241.7317811222,
"y": -5464487.455673964,
"z": 3195978.047404553
},
"direction": {
"x": 0.3675783291212823,
"y": 0.81316539817522,
"z": 0.4512739823776041
},
"up": {
"x": 0.08270178763465089,
"y": -0.5119037171950899,
"z": 0.8550526291661131
},
"right": {
"x": 0.9263080407091582,
"y": -0.27697765168400346,
"z": -0.2554149451092779
},
"heading": 0.3008134433902425,
"pitch": -0.5367351449364697,
"roll": 6.282589696577563,
"height": 1215.0821198795002,
"frameIsIdentity": true
}
},
{
"step": 26,
"kind": "pose",
"value": {
"position": {
"x": -743241.80671276,
"y": -5463765.475245942,
"z": 3195201.3342659683
},
"direction": {
"x": 0.36760985348731867,
"y": 0.5094221457939676,
"z": 0.7780437474806298
},
"up": {
"x": -0.0855345107763599,
"y": -0.8145571574843389,
"z": 0.5737425247071049
},
"right": {
"x": 0.9260382514158263,
"y": -0.2774629967503845,
"z": -0.2558660633007341
},
"heading": 0.3012445916881008,
"pitch": -0.08686439532730006,
"roll": 6.282451156320272,
"height": 205.77116965382524,
"frameIsIdentity": true
}
}
],
"flights": []
},
"modified drags: Shift looks, Ctrl tilts, held too long to coast": {
"records": [
{
"step": 26,
"kind": "pose",
"value": {
"position": {
"x": -743060.1500720647,
"y": -5464827.966102482,
"z": 3196999.1724985815
},
"direction": {
"x": 0.3198554534385449,
"y": 0.8196936321897058,
"z": 0.4751787434779361
},
"up": {
"x": 0.07739593213172483,
"y": -0.5224541754567694,
"z": 0.8491475161815223
},
"right": {
"x": 0.9442999304220479,
"y": -0.2348275620437983,
"z": -0.23055076991734758
},
"heading": 0.2406372218166659,
"pitch": -0.5226924574159404,
"roll": 0.028997148507913906,
"height": 2000.0000000013995,
"frameIsIdentity": true
}
},
{
"step": 51,
"kind": "pose",
"value": {
"position": {
"x": -743061.3004932855,
"y": -5464044.082279529,
"z": 3196047.0359984883
},
"direction": {
"x": 0.3201424713636519,
"y": 0.6241229075555551,
"z": 0.712726731849994
},
"up": {
"x": -0.02221334720207947,
"y": -0.7471697869219248,
"z": 0.66426190370751
},
"right": {
"x": 0.9471089510902393,
"y": -0.22849049384043377,
"z": -0.22533692327113536
},
"heading": 0.2408776874059173,
"pitch": -0.21383964601254024,
"roll": 0.028905924656936755,
"height": 849.3858537714274,
"frameIsIdentity": true
}
}
],
"flights": []
},
"projection, picks and the horizon": {
"records": [
{
+7 -2
View File
@@ -19,7 +19,8 @@
* ```
*
* Optional harness members widen what is checked: `pointer(r, type, x, y)`
* (synthetic input), `scriptHeights(r, fn)` (heights from a function),
* (synthetic input; with `cameraInput`, the camera scripts' drags and
* wheels too), `scriptHeights(r, fn)` (heights from a function),
* `wallTime(r)` (the wall clock a `live` motion clock reads),
* `assets.model` (a glTF URL). `create` may return null when it cannot
* make a renderer with fewer capabilities; those checks are then skipped.
@@ -46,6 +47,10 @@ import { portChecks } from './checks/ports.js';
* @property {ConformanceTolerance} tolerance
* @property {'trace'|'endpoints'} flightPaths Whether flight paths are compared frame by frame, or only where flights end.
* @property {(r: object, type: string, x: number, y: number, extra?: object) => void|Promise<void>} [pointer]
* A move's `x, y` is where it started and `extra.endPosition` where it
* went; `extra` also has `button` (a move's the one held), `modifiers`
* and, for a wheel, `delta` in the input port's lines.
* @property {boolean} [cameraInput] The renderer's camera moves on pointer input sent through `pointer` (its own gestures, or a camera controller's): the camera scripts with `input` steps run.
* @property {(r: object, fn: (point: {lon: number, lat: number}, against?: string) => number|null) => void} [scriptHeights]
* @property {(r: object) => number} [wallTime] Epoch ms the renderer's `live` motion clock reads.
* @property {{model?: string}} [assets]
@@ -111,7 +116,7 @@ export async function runConformance(harness, options = {}) {
};
}
export { CAMERA_SCRIPTS, SCRIPT_VIEWPORT } from './cameraScripts.js';
export { CAMERA_SCRIPTS, SCRIPT_VIEWPORT, usesInput } from './cameraScripts.js';
export { CALIBRATION_PATH, REFERENCE_SCENES, sceneSupport } from './scenes.js';
export {
VISUAL_TOLERANCE,
+6 -1
View File
@@ -57,7 +57,12 @@ export interface PointerEv {
pointerType: 'mouse' | 'touch' | 'pen';
/** `click`: how far the pointer travelled and how long the press lasted. */
gesture?: { travelPx: number; durationMs: number };
/** `wheel`: lines scrolled; `pinch`: scale since the last event. */
/**
* `wheel`: lines scrolled, down positive, counted as the reference
* renderer counts them: a pixel-mode wheel at 40 px a line, a page at 3
* lines (so 40 px a line turns either back into the reference's pixels);
* `pinch`: scale since the last event.
*/
delta?: number;
/** `click` and `dblclick`: the hit under the pointer, picked once for every subscriber. */
pick?(): Hit | null;
+29
View File
@@ -0,0 +1,29 @@
/**
* @module render/input/wheel
* @description A DOM wheel event as the input port's `wheel` delta: lines
* scrolled, counted as the reference renderer counts them, so a camera
* controller that turns lines back into pixels at `WHEEL_PX_PER_LINE`
* zooms exactly as the reference does in every browser.
*
* The reference takes a pixel-mode wheel as its pixels, a line-mode one at
* 40 px a line and a page-mode one at 120 px a page. Lines are those
* pixels over 40: a line-mode wheel is its own lines, a page is 3 lines,
* and a pixel-mode wheel (Chrome's notch is 100 px) is its pixels over 40
* (2.5 lines a notch).
*/
/** Pixels a wheel line stands for: the reference renderer's own count. */
export const WHEEL_PX_PER_LINE = 40;
/** Lines a wheel page stands for: the reference's 120 px a page. */
export const WHEEL_LINES_PER_PAGE = 3;
/**
* Lines scrolled by a DOM wheel event, down positive (as `deltaY`).
* @param {{deltaY: number, deltaMode?: number}} event
* @returns {number}
*/
export function wheelLines({ deltaY, deltaMode = 0 }) {
if (deltaMode === 1) return deltaY;
if (deltaMode === 2) return deltaY * WHEEL_LINES_PER_PAGE;
return deltaY / WHEEL_PX_PER_LINE;
}
+14 -53
View File
@@ -47,7 +47,6 @@ import { createCameraEvents } from '../camera/events.js';
import { geodesicAt } from '../../geo/geodesic.js';
const DEFAULT_FOV = Math.PI / 3;
const MOVE_END_WAIT_MS = 500;
const MINIMUM_ZOOM = 100;
const DEFAULT_SPHERE_OFFSET = Object.freeze({
heading: 0,
@@ -98,17 +97,23 @@ export function createStubCamera({
const near = 1;
const far = 5e8;
const events = createCameraEvents({ pose, report, thresholds });
const { emit, on, stepChanged } = events;
const commandHooks = [];
const events = createCameraEvents({
pose,
world: () => ({
position: positionWC(),
direction: directionWC(),
up: upWC(),
}),
following: () => Boolean(followed),
report,
thresholds,
});
const { emit, on, stepChanged, command, onCommand } = events;
const holds = new Map();
let holdSeq = 0;
let flight = null;
let followed = null;
let followFramed = false;
let lastPose = null;
let moving = false;
let lastMovedAt = 0;
let coast = Object.freeze({ drag: 0.4, zoom: 0.2 });
const controls = {
@@ -202,17 +207,6 @@ export function createStubCamera({
};
}
function command(kind) {
for (const hook of commandHooks.slice()) {
if (!commandHooks.includes(hook)) continue;
try {
hook({ kind });
} catch (error) {
report(error);
}
}
}
/** Place the eye at `destination` (world) with `orientation` in its east-north-up frame. */
function placeAt(destination, hpr) {
const kept = frame;
@@ -727,35 +721,8 @@ export function createStubCamera({
// --- Events ----------------------------------------------------------------
function sameView(a, b) {
return (
a &&
b &&
distance(a.position, b.position) === 0 &&
dot(a.direction, b.direction) === dot(a.direction, a.direction) &&
dot(a.up, b.up) === dot(a.up, a.up)
);
}
function stepMoveDetection() {
const current = {
position: positionWC(),
direction: directionWC(),
up: upWC(),
};
const changed = lastPose && !sameView(lastPose, current);
lastPose = current;
const t = now();
if (changed) {
lastMovedAt = t;
if (!moving) {
moving = true;
emit('moveStart');
}
} else if (moving && !followed && t - lastMovedAt >= MOVE_END_WAIT_MS) {
moving = false;
emit('moveEnd');
}
events.stepMoveDetection(now());
}
function matrices() {
@@ -844,13 +811,7 @@ export function createStubCamera({
followOffset,
controls,
on,
onCommand(cb) {
commandHooks.push(cb);
return () => {
const i = commandHooks.indexOf(cb);
if (i >= 0) commandHooks.splice(i, 1);
};
},
onCommand,
matrices,
};
+8
View File
@@ -1600,6 +1600,13 @@ export function createStubRenderer(options = {}) {
canvas.width = viewport.width;
canvas.height = viewport.height;
},
/**
* Where a drawn item is drawn now (or `aheadMs` from now), ECEF, or
* null: what the stub's own camera follows for a target's `item`, for
* a camera of someone else's driving the stub (the `camera.followItem`
* conformance check).
*/
drawnPosition: (ref, aheadMs = 0) => drawnPosition(ref, aheadMs),
/** What a set holds. */
setRecord: (id) => sets.get(id) ?? null,
sets: () => [...sets.keys()],
@@ -1624,6 +1631,7 @@ export function createStubRenderer(options = {}) {
* @property {(point: object, height: number) => void} cacheHeight
* @property {(kind: string, value: boolean) => void} setSettled
* @property {(size: {width?: number, height?: number}) => void} setViewport
* @property {(ref: {set: string, id: string|number}, aheadMs?: number) => {x: number, y: number, z: number}|null} drawnPosition
* @property {(id: string) => object|null} setRecord
* @property {() => string[]} sets
* @property {Array<{port: string, member: string, args: unknown[]}>} calls
+64 -2
View File
@@ -2,7 +2,11 @@ import { test } from 'node:test';
import assert from 'node:assert/strict';
import { createStubRenderer } from './index.js';
import { createStubHarness } from './harness.js';
import { runConformance } from '../conformance/index.js';
import {
CAMERA_SCRIPTS,
runConformance,
usesInput,
} from '../conformance/index.js';
import { toEcef } from './math.js';
test('the stub passes the conformance suite', async () => {
@@ -15,7 +19,12 @@ test('the stub passes the conformance suite', async () => {
const skipped = report.results
.filter((r) => r.status === 'skip')
.map((r) => r.id);
assert.deepEqual(skipped, []);
// Its camera takes no user gestures: the drag and wheel scripts are for
// a camera that does (a controller over it, say).
assert.deepEqual(
skipped,
CAMERA_SCRIPTS.filter(usesInput).map((s) => `camera.trace.${s.name}`),
);
});
test('a frame runs the contract’s steps in order', () => {
@@ -130,3 +139,56 @@ test('a draped rectangle across the antimeridian picks on both sides of it, turn
assert.ok(!picked(179.5, 0), 'and narrows it');
r.destroy();
});
test('the stub says where it draws an item, for a camera that is not its own', () => {
const r = createStubRenderer();
const t0 = r.frame.time();
const from = toEcef({ lon: -97.74, lat: 30.27, height: 1000 });
const to = toEcef({ lon: -97.7, lat: 30.27, height: 1000 });
const set = r.draw.icons({ id: 'drawn', motionClock: { kind: 'scene' } });
set.set([
{
id: 'm',
pos: from,
image: 'data:,',
size: [16, 16],
motion: { kind: 'lerp', from, to, t0, t1: t0 + 60000 },
},
]);
const at = (p) => [p.x, p.y, p.z];
assert.deepEqual(
at(r.testing.drawnPosition({ set: 'drawn', id: 'm' })),
at(from),
);
r.frame.setTime(t0 + 30000);
const mid = r.testing.drawnPosition({ set: 'drawn', id: 'm' });
for (const k of ['x', 'y', 'z'])
assert.ok(Math.abs(mid[k] - (from[k] + to[k]) / 2) < 1e-6, k);
const ahead = r.testing.drawnPosition({ set: 'drawn', id: 'm' }, 30000);
for (const k of ['x', 'y', 'z'])
assert.ok(Math.abs(ahead[k] - to[k]) < 1e-6, k);
assert.equal(r.testing.drawnPosition({ set: 'drawn', id: 'gone' }), null);
assert.equal(r.testing.drawnPosition({ set: 'nothing', id: 'm' }), null);
r.destroy();
});
test('the stub camera ends no move while it follows', () => {
const r = createStubRenderer();
const seen = [];
r.camera.on('moveStart', () => seen.push('start'));
r.camera.on('moveEnd', () => seen.push('end'));
r.testing.tick();
const target = toEcef({ lon: -97.74, lat: 30.27, height: 0 });
r.camera.follow({
key: 'still',
position: () => target,
frame: 'enu',
viewFrom: { x: 0, y: -500, z: 300 },
});
r.testing.advance(2000);
assert.deepEqual(seen, ['start'], 'moveEnd waits for the follow to end');
r.camera.follow(null);
r.testing.advance(1000);
assert.deepEqual(seen, ['start', 'end']);
r.destroy();
});
+4 -1
View File
@@ -52,7 +52,6 @@ const UNBOUND = 'src/render/cesium/unbound.js';
* both factories; without it, their styles keep records and draw nothing.
*/
const INJECTED = {
'./layers/recent-imagery': 'src/layers/recentImagery/rendering.js',
'./ui/visual-settings': 'src/ui/applicationShell.js',
};
@@ -141,6 +140,10 @@ const CAMERA_FROM_CALLER = new Set([
// constant from.
'./voice/actions',
'./voice/realtime-session',
// It flies through `findCamera` and drapes through `findGlobe`; the
// renderer the application gives it (`rendering.js`, which draws the box
// preview through `drawOf`) is Cesium-free too.
'./layers/recent-imagery',
]);
const pkg = JSON.parse(readFileSync(path.join(root, 'package.json'), 'utf8'));