mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-21 10:42:22 +00:00
feat(globe): add the engine contract and its test suite
src/globe/contract.js defines the engine-neutral GlobeEngine capabilities (JSDoc), createEngineEvent with Cesium.Event semantics and assertGlobeEngine. src/globe/testing adds a geo-based fake engine for shell tests and an engine-agnostic contract suite that the fake passes in Node. check-import-directions keeps the contract free of cesium, three and @navaramap, and each engine directory free of the other engine.
This commit is contained in:
1 parent
f2fcd82290
commit
528ec75f32
9 files changed
+2036
-1
No files matched your search
@@ -0,0 +1,186 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import test from 'node:test';
|
||||
import * as geo from '../../geo/index.js';
|
||||
import { createFakeEngine } from './fakeEngine.js';
|
||||
|
||||
const close = (actual, expected, tolerance, message) =>
|
||||
assert.ok(
|
||||
Math.abs(actual - expected) <= tolerance,
|
||||
`${message ?? 'value'}: ${actual} is not within ${tolerance} of ${expected}`,
|
||||
);
|
||||
|
||||
test('the fake pose is controllable and returned as fresh geo values', () => {
|
||||
const engine = createFakeEngine({ width: 800, height: 600 });
|
||||
engine.fake.setPose({
|
||||
longitude: 0.5,
|
||||
latitude: 0.25,
|
||||
height: 2000,
|
||||
heading: 1,
|
||||
pitch: -0.4,
|
||||
});
|
||||
const pose = engine.camera.pose();
|
||||
close(pose.cartographic.longitude, 0.5, 1e-12, 'longitude');
|
||||
close(pose.cartographic.latitude, 0.25, 1e-12, 'latitude');
|
||||
close(pose.cartographic.height, 2000, 1e-6, 'height');
|
||||
close(pose.heading, 1, 1e-9, 'heading');
|
||||
close(pose.pitch, -0.4, 1e-9, 'pitch');
|
||||
close(pose.roll, 0, 1e-9, 'roll');
|
||||
pose.position.x = 0;
|
||||
assert.notEqual(engine.camera.pose().position.x, 0);
|
||||
assert.deepEqual(engine.host.size(), { width: 800, height: 600 });
|
||||
engine.fake.setSize(320, 200);
|
||||
assert.deepEqual(engine.host.size(), { width: 320, height: 200 });
|
||||
});
|
||||
|
||||
test('the fake records contract calls for shell-module tests', () => {
|
||||
const engine = createFakeEngine();
|
||||
const destination = geo.cartesian3.fromDegrees(10, 20, 3000);
|
||||
engine.camera.setView({ destination });
|
||||
engine.camera.flyTo({ destination, duration: 2 });
|
||||
engine.camera.cancelFlight();
|
||||
engine.render.request();
|
||||
engine.render.request();
|
||||
assert.deepEqual(
|
||||
engine.fake.calls.map((call) => call.method),
|
||||
[
|
||||
'camera.setView',
|
||||
'camera.flyTo',
|
||||
'camera.cancelFlight',
|
||||
'render.request',
|
||||
'render.request',
|
||||
],
|
||||
);
|
||||
assert.equal(engine.fake.callsOf('camera.flyTo')[0].args[0].duration, 2);
|
||||
assert.equal(engine.fake.renderRequests, 2);
|
||||
engine.fake.resetCalls();
|
||||
assert.deepEqual(engine.fake.calls, []);
|
||||
assert.equal(engine.fake.renderRequests, 0);
|
||||
});
|
||||
|
||||
test('fake flights advance with frames and finish or cancel exactly once', () => {
|
||||
const engine = createFakeEngine();
|
||||
const destination = geo.cartesian3.fromDegrees(30, 40, 5000);
|
||||
const outcomes = [];
|
||||
engine.camera.flyTo({
|
||||
destination,
|
||||
duration: 1,
|
||||
complete: () => outcomes.push('complete'),
|
||||
cancel: () => outcomes.push('cancel'),
|
||||
});
|
||||
assert.equal(engine.fake.flying(), true);
|
||||
engine.fake.frames(30, 16);
|
||||
assert.deepEqual(outcomes, []);
|
||||
engine.fake.frames(40, 16);
|
||||
assert.deepEqual(outcomes, ['complete']);
|
||||
assert.ok(
|
||||
geo.cartesian3.distance(engine.camera.pose().position, destination) < 1e-6,
|
||||
);
|
||||
engine.camera.cancelFlight();
|
||||
assert.deepEqual(outcomes, ['complete']);
|
||||
|
||||
engine.camera.flyTo({
|
||||
destination: geo.cartesian3.fromDegrees(0, 0, 1e6),
|
||||
cancel: () => outcomes.push('cancel'),
|
||||
});
|
||||
engine.camera.flyTo({
|
||||
destination,
|
||||
duration: 0,
|
||||
complete: () => outcomes.push('second'),
|
||||
});
|
||||
assert.deepEqual(outcomes, ['complete', 'cancel']);
|
||||
engine.fake.frame();
|
||||
assert.deepEqual(outcomes, ['complete', 'cancel', 'second']);
|
||||
});
|
||||
|
||||
test('fake events can be emitted by hand and frames fire in order', () => {
|
||||
const engine = createFakeEngine();
|
||||
const seen = [];
|
||||
engine.camera.changed.addEventListener((value) =>
|
||||
seen.push(['changed', value]),
|
||||
);
|
||||
engine.frames.preUpdate.addEventListener((time) =>
|
||||
seen.push(['preUpdate', time]),
|
||||
);
|
||||
engine.frames.preRender.addEventListener((time) =>
|
||||
seen.push(['preRender', time]),
|
||||
);
|
||||
engine.frames.postRender.addEventListener((time) =>
|
||||
seen.push(['postRender', time]),
|
||||
);
|
||||
engine.fake.emit('camera.changed', 0.7);
|
||||
engine.fake.frame(10);
|
||||
assert.deepEqual(seen, [
|
||||
['changed', 0.7],
|
||||
['preUpdate', 10],
|
||||
['preRender', 10],
|
||||
['postRender', 10],
|
||||
]);
|
||||
assert.throws(() => engine.fake.emit('camera.nope'), /Unknown engine event/);
|
||||
});
|
||||
|
||||
test('fake input dispatches to subscribers and off removes them', () => {
|
||||
const engine = createFakeEngine();
|
||||
const seen = [];
|
||||
const off = engine.input.on('click', (event) => seen.push(event.position));
|
||||
engine.fake.input('click', { position: geo.cartesian2.create(4, 5) });
|
||||
off();
|
||||
engine.fake.input('click', { position: geo.cartesian2.create(6, 7) });
|
||||
assert.deepEqual(seen, [geo.cartesian2.create(4, 5)]);
|
||||
assert.throws(() => engine.input.on('wheel', () => {}), /Unknown input type/);
|
||||
engine.input.setCameraInputs(false);
|
||||
assert.equal(engine.fake.cameraInputsEnabled, false);
|
||||
});
|
||||
|
||||
test('pick, sampleHeight and worldToWindow results can be scripted', () => {
|
||||
const engine = createFakeEngine();
|
||||
const screen = geo.cartesian2.create(10, 10);
|
||||
assert.equal(engine.picker.pick(screen), undefined);
|
||||
engine.fake.script('pick', { id: 'aircraft', primitive: {} });
|
||||
assert.equal(engine.picker.pick(screen).id, 'aircraft');
|
||||
engine.fake.script('pick', (position) =>
|
||||
position.x > 5 ? { id: 'x' } : undefined,
|
||||
);
|
||||
assert.equal(engine.picker.pick(screen).id, 'x');
|
||||
engine.fake.script('sampleHeight', 123);
|
||||
assert.equal(
|
||||
engine.surface.sampleHeight(geo.cartographic.fromDegrees(0, 0)),
|
||||
123,
|
||||
);
|
||||
engine.fake.script('worldToWindow', geo.cartesian2.create(1, 2));
|
||||
const result = geo.cartesian2.create();
|
||||
assert.equal(
|
||||
engine.projector.worldToWindow(geo.cartesian3.UNIT_X, result),
|
||||
result,
|
||||
);
|
||||
assert.deepEqual(result, geo.cartesian2.create(1, 2));
|
||||
engine.fake.unscript('worldToWindow');
|
||||
const { position, direction } = engine.camera.pose();
|
||||
const behind = geo.cartesian3.subtract(
|
||||
position,
|
||||
geo.cartesian3.multiplyByScalar(direction, 1000, geo.cartesian3.create()),
|
||||
geo.cartesian3.create(),
|
||||
);
|
||||
assert.equal(engine.projector.worldToWindow(behind), undefined);
|
||||
assert.throws(
|
||||
() => engine.fake.script('teleport', 1),
|
||||
/Unknown scripted result/,
|
||||
);
|
||||
});
|
||||
|
||||
test('fake credits, maps and destroy keep inspectable state', () => {
|
||||
const engine = createFakeEngine();
|
||||
const remove = engine.credits.addStatic('<b>OSM</b>', { onScreen: true });
|
||||
assert.deepEqual(engine.fake.credits, [
|
||||
{ html: '<b>OSM</b>', onScreen: true },
|
||||
]);
|
||||
remove();
|
||||
remove();
|
||||
assert.deepEqual(engine.fake.credits, []);
|
||||
engine.maps.setPhotorealTiles({ kind: 'google-3d' });
|
||||
assert.equal(engine.maps.photorealActive(), true);
|
||||
assert.deepEqual(engine.fake.maps.photoreal, { kind: 'google-3d' });
|
||||
engine.maps.setPhotorealTiles(null);
|
||||
assert.equal(engine.maps.photorealActive(), false);
|
||||
engine.destroy();
|
||||
assert.equal(engine.fake.destroyed, true);
|
||||
});
|
||||
Reference in new issue
Block a user