Files
gods-eye-view/src/render/conformance/checks/camera.js
T
Sameh Khamis 1d9c731c10 Orbit, move, look and zoom through the camera port
The Cesium camera port gains move, look, rotateAround and zoom, and the
browser conformance run now checks them, the lookAt-frame commands, the
changed thresholds and moveEnd (timed by the clock, not a frame count).
Orbit, the Bhote Koshi focus and cinematic, the launch zoom anchor and
replay chase, the camera verbs' motion tick and roll levelling, and
voice zoom write through the port.
2026-11-06 10:21:04 -08:00

536 lines
17 KiB
JavaScript

/**
* Camera checks: the reference traces, then flight, hold, event, follow and
* view rules the traces cannot show.
*/
import goldens from '../goldens/camera.json' with { type: 'json' };
import { CAMERA_SCRIPTS, SCRIPT_VIEWPORT } from '../cameraScripts.js';
import { contractDriver, runCameraScript } from '../cameraRunner.js';
import { deepEqual, equal, near, nearAngle, nearVec, ok } from '../expect.js';
const lonLatToEcef = (h) => h.toEcef;
function comparePose(actual, expected, tol, where) {
nearVec(actual.position, expected.position, tol.metres, `${where} position`);
nearVec(actual.direction, expected.direction, tol.unit, `${where} direction`);
nearVec(actual.up, expected.up, tol.unit, `${where} up`);
nearVec(actual.right, expected.right, tol.unit, `${where} right`);
nearAngle(actual.heading, expected.heading, tol.radians, `${where} heading`);
// Pitch is compared by its sine: straight up or down, the angle itself
// turns a last-bit difference in direction into ~1e-8 rad.
near(
Math.sin(actual.pitch),
Math.sin(expected.pitch),
tol.radians,
`${where} sin(pitch)`,
);
nearAngle(actual.roll, expected.roll, tol.radians, `${where} roll`);
near(actual.height, expected.height, tol.metres, `${where} height`);
equal(
actual.frameIsIdentity,
expected.frameIsIdentity,
`${where} frameIsIdentity`,
);
}
function compareRecord(actual, expected, tol, where, flightPaths) {
equal(actual.kind, expected.kind, `${where} kind`);
const a = actual.value;
const e = expected.value;
switch (expected.kind) {
case 'pose':
comparePose(a, e, tol, where);
break;
case 'project':
e.forEach((s, i) => nearVec(a[i], s, tol.pixels, `${where} point ${i}`));
break;
case 'pickEllipsoid':
e.forEach((p, i) => nearVec(a[i], p, tol.metres, `${where} pick ${i}`));
break;
case 'pickRay':
e.forEach((r, i) => {
nearVec(a[i].origin, r.origin, tol.metres, `${where} ray ${i} origin`);
nearVec(
a[i].direction,
r.direction,
tol.unit,
`${where} ray ${i} direction`,
);
});
break;
case 'occluded':
deepEqual(a, e, `${where} occluded`);
break;
case 'changed':
e.forEach((c, i) =>
near(
a[i].count,
c.count,
tol.changedCount,
`${where} changed at ${c.threshold}`,
),
);
break;
case 'viewRectangle':
equal(a === null, e === null, `${where} viewRectangle null`);
if (e)
for (const side of ['west', 'south', 'east', 'north'])
near(
a[side],
e[side],
(tol.radians * 180) / Math.PI,
`${where} viewRectangle ${side}`,
);
break;
case 'matrices': {
// The view's last column is a translation in metres; the rest is unit.
e.view.forEach((v, i) =>
near(
a.view[i],
v,
i >= 12 ? tol.metres : tol.unit,
`${where} view[${i}]`,
),
);
// Depth terms come from the renderer's own near and far planes (the
// contract fixes neither, and allows an infinite far plane).
const n = a.near;
const f = a.far;
ok(Number.isFinite(n) && n > 0, `${where} near is a positive number`);
ok(
f === null || (Number.isFinite(f) && f > n),
`${where} far is beyond near, or infinite`,
);
const depth =
f === null
? { 10: -1, 14: -2 * n }
: { 10: -(f + n) / (f - n), 14: (-2 * f * n) / (f - n) };
e.projection.forEach((v, i) =>
near(
a.projection[i],
depth[i] ?? v,
tol.unit * Math.max(1, Math.abs(depth[i] ?? v)),
`${where} projection[${i}]`,
),
);
break;
}
case 'flying':
equal(a.flying, e.flying, `${where} flying`);
if (flightPaths === 'trace') comparePose(a.pose, e.pose, tol, where);
break;
default:
throw new Error(`unknown record ${expected.kind}`);
}
}
/** @param {import('../index.js').ConformanceHarness} h */
async function fresh(h) {
return h.create({ viewport: SCRIPT_VIEWPORT });
}
export function cameraChecks() {
const traceChecks = CAMERA_SCRIPTS.map((script) => ({
id: `camera.trace.${script.name}`,
port: 'camera',
title: `reference trace: ${script.name}`,
async run(h) {
const expected = goldens.scripts[script.name];
ok(expected, `no reference trace for ${script.name}`);
const r = await fresh(h);
try {
const run = await runCameraScript(
contractDriver(r, {
frame: () => h.frame(r),
toEcef: lonLatToEcef(h),
}),
script,
);
equal(run.records.length, expected.records.length, 'record count');
run.records.forEach((record, i) =>
compareRecord(
record,
expected.records[i],
h.tolerance,
`${script.name} step ${expected.records[i].step}`,
h.flightPaths,
),
);
equal(run.flights.length, expected.flights.length, 'flight count');
run.flights.forEach((f, i) => {
equal(f.outcome, expected.flights[i].outcome, `flight ${i} outcome`);
near(f.frames, expected.flights[i].frames, 1, `flight ${i} frames`);
});
} finally {
r.destroy();
}
},
}));
return [
...traceChecks,
{
id: 'camera.flight.callbacks',
port: 'camera',
title: 'flight callbacks run synchronously; a new flight cancels the old',
async run(h) {
const r = await fresh(h);
const events = [];
const first = r.camera.flyTo(
{ lon: 0, lat: 0, height: 1e6 },
{
durationS: 1,
onCancel: () => events.push('cancel1'),
onComplete: () => events.push('done1'),
},
);
ok(r.camera.flying, 'flying after flyTo');
r.camera.flyTo(
{ lon: 1, lat: 1, height: 1e6 },
{ durationS: 0.5, onComplete: () => events.push('done2') },
);
deepEqual(
events,
['cancel1'],
'the first flight was cancelled inside the second flyTo',
);
equal(await first.done, 'cancelled', 'first outcome');
for (let i = 0; i < 40 && r.camera.flying; i++) await h.frame(r);
deepEqual(events, ['cancel1', 'done2'], 'the second completed');
ok(!r.camera.flying, 'not flying after completion');
const third = r.camera.flyTo(
{ lon: 2, lat: 2, height: 1e6 },
{ durationS: 1, onCancel: () => events.push('cancel3') },
);
r.camera.cancelFlight();
equal(
events.at(-1),
'cancel3',
'cancelFlight runs onCancel inside the call',
);
equal(await third.done, 'cancelled', 'third outcome');
r.destroy();
},
},
{
id: 'camera.controls.holds',
port: 'camera',
title:
'camera input holds are counted; a flight ending gives back only its own',
async run(h) {
const r = await fresh(h);
ok(r.camera.controls.enabled, 'enabled at start');
const release = r.input.suspendCameraControls('drag');
ok(!r.camera.controls.enabled, 'a hold disables input');
r.camera.flyTo({ lon: 0, lat: 0, height: 1e6 }, { durationS: 0.1 });
for (let i = 0; i < 20 && r.camera.flying; i++) await h.frame(r);
ok(!r.camera.flying, 'the flight ended');
ok(!r.camera.controls.enabled, 'the drag hold survives the flight end');
const second = r.camera.controls.suspend('cockpit');
release();
release();
ok(!r.camera.controls.enabled, 'one hold still out');
second();
ok(r.camera.controls.enabled, 'enabled with no holds out');
const [min, max] = r.camera.controls.pitchRange;
ok(
-Math.PI / 2 <= min && min <= max && max <= Math.PI / 2,
'pitchRange is an ordered range of pitches',
);
r.camera.controls.pitchRange = [-1.2, -0.1];
deepEqual(
[...r.camera.controls.pitchRange],
[-1.2, -0.1],
'pitchRange is settable',
);
const { coast } = r.camera.controls;
for (const key of ['drag', 'zoom'])
ok(
Number.isFinite(coast[key]) && coast[key] >= 0,
`coast.${key} is seconds`,
);
r.camera.controls.coast = { drag: 0.25, zoom: 0 };
// Within rounding: an engine may keep it as a decay coefficient.
near(
r.camera.controls.coast.drag,
0.25,
1e-9,
'coast.drag is settable',
);
near(
r.camera.controls.coast.zoom,
0,
1e-9,
'a coast of 0 stops at once',
);
r.destroy();
},
},
{
id: 'camera.onCommand',
port: 'camera',
title: 'every camera command is announced before it runs',
async run(h) {
const r = await fresh(h);
const seen = [];
const off = r.camera.onCommand((c) => seen.push(c.kind));
const target = h.toEcef({ lon: 0, lat: 0, height: 0 });
r.camera.setView({ destination: { lon: 0, lat: 0, height: 1000 } });
r.camera.lookAt(target, { heading: 0, pitch: -0.5, range: 1000 });
r.camera.release();
r.camera.flyTo({ lon: 1, lat: 1, height: 1000 }, { durationS: 1 });
r.camera.cancelFlight();
r.camera.flyToBounds({ center: target, radius: 10 }, { durationS: 1 });
r.camera.cancelFlight();
r.camera.follow({
key: 'k',
position: () => target,
frame: 'enu',
viewFrom: { x: 0, y: -100, z: 100 },
});
off();
r.camera.follow(null);
deepEqual(
seen,
[
'setView',
'lookAt',
'release',
'flyTo',
'cancelFlight',
'flyToBounds',
'cancelFlight',
'follow',
],
'commands',
);
r.destroy();
},
},
{
id: 'camera.moveEnd',
port: 'camera',
title: 'moveStart on movement; moveEnd 500 ms after the last change',
async run(h) {
const r = await fresh(h);
const events = [];
r.camera.on('moveStart', () => events.push(['start', h.now(r)]));
r.camera.on('moveEnd', () => events.push(['end', h.now(r)]));
await h.frame(r);
const movingAt = h.now(r);
r.camera.move('forward', 1000);
await h.frame(r);
equal(events[0]?.[0], 'start', 'moveStart after the move');
const movedAt = h.now(r);
// By the clock, not a frame count: a page's frames come at the
// display's rate.
// The event comes on the first frame past 500 ms, so the slack is
// two of the longest frames seen, never less than two at 60 Hz.
let longestFrame = 1000 / 60;
for (let i = 0; i < 600 && h.now(r) - movedAt < 750; i++) {
const before = h.now(r);
await h.frame(r);
longestFrame = Math.max(longestFrame, h.now(r) - before);
}
const end = events.find(([kind]) => kind === 'end');
ok(end, 'moveEnd fired');
ok(
end[1] - movingAt >= 500 - 1e-6,
`moveEnd waited 500 ms (${end[1] - movingAt})`,
);
ok(
end[1] - movedAt < 500 + 2 * longestFrame + 1e-6,
`moveEnd came within two frames of 500 ms (${end[1] - movedAt})`,
);
r.destroy();
},
},
{
id: 'camera.follow',
port: 'camera',
title: 'a follow keeps the eye at its offset from a moving target',
async run(h) {
const r = await fresh(h);
const changes = [];
r.camera.on('followChanged', () =>
changes.push(r.camera.followed?.key ?? null),
);
const base = h.toEcef({ lon: -97.74, lat: 30.27, height: 1000 });
const start = r.frame.time();
const target = {
key: 'test:mover',
position: (t) => ({
x: base.x + (t - start) * 0.2,
y: base.y,
z: base.z,
}),
frame: 'enu',
viewFrom: { x: 0, y: -800, z: 400 },
};
r.camera.follow(target);
equal(r.camera.followed, target, 'followed');
await h.frame(r);
ok(r.camera.followFramed, 'framed after a frame');
const range0 = dist(
r.camera.pose().position,
target.position(r.frame.time()),
);
near(range0, Math.hypot(800, 400), 1, 'starting range');
for (let i = 0; i < 30; i++) {
r.frame.setTime(r.frame.time() + 1000);
await h.frame(r);
near(
dist(r.camera.pose().position, target.position(r.frame.time())),
range0,
1e-3 * range0,
`range at frame ${i}`,
);
}
r.camera.follow(null);
equal(r.camera.followed, null, 'cleared');
ok(r.camera.pose().frameIsIdentity, 'back in the world frame');
deepEqual(changes, ['test:mover', null], 'followChanged');
r.destroy();
},
},
{
id: 'camera.rect',
port: 'camera',
title:
'a rectangle destination looks straight down and keeps the whole rectangle in view',
async run(h) {
const r = await fresh(h);
const rect = { west: -98, south: 30, east: -97.5, north: 30.4 };
r.camera.setView({ destination: { rect } });
await h.frame(r);
const pose = r.camera.pose();
near(pose.pitch, -Math.PI / 2, 1e-3, 'pitch');
for (const [lon, lat] of [
[rect.west, rect.north],
[rect.east, rect.north],
[rect.west, rect.south],
[rect.east, rect.south],
]) {
const s = r.query.project(h.toEcef({ lon, lat, height: 0 }));
ok(
s &&
s.x >= -1 &&
s.x <= SCRIPT_VIEWPORT.width + 1 &&
s.y >= -1 &&
s.y <= SCRIPT_VIEWPORT.height + 1,
`corner ${lon},${lat} in view (${JSON.stringify(s)})`,
);
}
r.destroy();
},
},
{
id: 'camera.viewRectangle',
port: 'camera',
title:
'viewRectangle holds the ground in view, is the whole globe from afar, null facing away',
async run(h) {
const r = await fresh(h);
const at = async (height, pitch = -Math.PI / 2) => {
r.camera.setView({
destination: { lon: -97.74, lat: 30.27, height },
orientation: { heading: 0, pitch, roll: 0 },
});
await h.frame(r);
return r.camera.viewRectangle();
};
const down = await at(5000);
ok(
down &&
down.west < -97.74 &&
down.east > -97.74 &&
down.south < 30.27 &&
down.north > 30.27 &&
down.east - down.west < 0.2,
`straight down holds the centre (${JSON.stringify(down)})`,
);
const tilted = await at(2000, -0.3);
ok(tilted && tilted.north > 30.3, 'tilted: cut at the horizon');
deepEqual(
await at(15000000),
{ west: -180, south: -90, east: 180, north: 90 },
'from afar: the whole globe',
);
equal(await at(15000000, Math.PI / 2), null, 'facing away: null');
r.destroy();
},
},
{
id: 'camera.followItem',
port: 'camera',
title: 'following a drawn item tracks where the renderer draws it',
async run(h) {
const r = await fresh(h);
if (!r.capabilities.has('motionSegments')) {
r.destroy();
return { skip: 'no motionSegments' };
}
const t0 = r.frame.time();
const from = h.toEcef({ lon: -97.74, lat: 30.27, height: 1000 });
const to = h.toEcef({ lon: -97.7, lat: 30.27, height: 1000 });
const set = r.draw.icons({
id: 'conf:follow',
motionClock: { kind: 'scene' },
});
set.set([
{
id: 'm',
pos: from,
image: 'data:,',
size: [16, 16],
motion: { kind: 'lerp', from, to, t0, t1: t0 + 60000 },
},
]);
r.camera.follow({
key: 'conf:follow:m',
// Deliberately stale: the drawn item is the answer.
position: () => from,
item: { set: 'conf:follow', id: 'm' },
frame: 'enu',
viewFrom: { x: 0, y: -500, z: 300 },
});
await h.frame(r);
const range0 = dist(r.camera.pose().position, from);
r.frame.setTime(t0 + 30000);
await h.frame(r);
const mid = {
x: (from.x + to.x) / 2,
y: (from.y + to.y) / 2,
z: (from.z + to.z) / 2,
};
near(
dist(r.camera.pose().position, mid),
range0,
1,
'the eye keeps its range from the drawn position',
);
set.dispose();
r.destroy();
},
},
{
id: 'camera.fov',
port: 'camera',
title: 'setFov sets the vertical field of view',
async run(h) {
const r = await fresh(h);
r.camera.setFov({ vertical: 0.5 });
near(r.camera.pose().fovy, 0.5, 1e-12, 'fovy');
near(
r.camera.pose().aspectRatio,
SCRIPT_VIEWPORT.width / SCRIPT_VIEWPORT.height,
1e-9,
'aspect',
);
r.destroy();
},
},
];
}
const dist = (a, b) => Math.hypot(a.x - b.x, a.y - b.y, a.z - b.z);