mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-16 16:22:20 +00:00
feat(globe): camera.commanded, picker.pickGlobe, pose.aspectRatio and isDestroyed
Shell navigation needs to know when a new owner takes the camera (the arrival ground guard), where the globe surface is under a window position (orientation pivot, view-centred place search), the frustum aspect ratio (landmark framing) and whether the engine is gone. Each member has a contract suite check and is implemented by the Cesium engine, the Navara engine and the fake. On Cesium, commanded hooks the viewer camera's command methods and trackedEntityChanged only while it has listeners, so direct Cesium calls from layers still announce a new owner.
This commit is contained in:
1 parent
840e34a881
commit
a3e929870d
16 files changed
+459
-6
No files matched your search
@@ -3,6 +3,7 @@
|
||||
|
||||
import * as Cesium from 'cesium';
|
||||
import * as geo from '../../geo/index.js';
|
||||
import { createEngineEvent } from '../contract.js';
|
||||
import { bridgeEvent } from './events.js';
|
||||
import { toCesium2, toCesium3, toGeo3 } from './convert.js';
|
||||
|
||||
@@ -49,6 +50,86 @@ const cesiumOffset = (offset) =>
|
||||
? new Cesium.HeadingPitchRange(offset.heading, offset.pitch, offset.range)
|
||||
: toCesium3(offset);
|
||||
|
||||
// The Cesium camera entry points that hand the camera to a new owner. The
|
||||
// viewer's camera is shared with code that still calls Cesium directly
|
||||
// (layers, cockpit), so `commanded` hooks these methods themselves.
|
||||
const COMMANDS = Object.freeze([
|
||||
'flyTo',
|
||||
'flyToBoundingSphere',
|
||||
'setView',
|
||||
'lookAt',
|
||||
'cancelFlight',
|
||||
]);
|
||||
|
||||
/**
|
||||
* camera.commanded: raised before any COMMANDS call on the Cesium camera and
|
||||
* when the viewer's tracked entity changes. The hooks exist only while the
|
||||
* event has listeners and then restore each method exactly (unless something
|
||||
* newer replaced it), so an idle engine leaves the camera untouched.
|
||||
*/
|
||||
function commandedEvent(viewer, cesium) {
|
||||
const event = createEngineEvent();
|
||||
let unhook = null;
|
||||
const hook = () => {
|
||||
const removers = [];
|
||||
for (const name of COMMANDS) {
|
||||
const original = cesium[name];
|
||||
if (typeof original !== 'function') continue;
|
||||
const descriptor = Object.getOwnPropertyDescriptor(cesium, name);
|
||||
const wrapped = function (...args) {
|
||||
event.raiseEvent();
|
||||
return original.apply(this, args);
|
||||
};
|
||||
cesium[name] = wrapped;
|
||||
removers.push(() => {
|
||||
if (cesium[name] !== wrapped) return;
|
||||
if (descriptor) Object.defineProperty(cesium, name, descriptor);
|
||||
else delete cesium[name];
|
||||
});
|
||||
}
|
||||
const removeTracking = viewer.trackedEntityChanged?.addEventListener(() =>
|
||||
event.raiseEvent(),
|
||||
);
|
||||
if (removeTracking) removers.push(removeTracking);
|
||||
return () => {
|
||||
for (const remove of removers) remove();
|
||||
};
|
||||
};
|
||||
let detached = false;
|
||||
const sync = () => {
|
||||
const wanted = !detached && event.numberOfListeners > 0;
|
||||
if (wanted === (unhook !== null)) return;
|
||||
if (wanted) unhook = hook();
|
||||
else {
|
||||
const remove = unhook;
|
||||
unhook = null;
|
||||
remove();
|
||||
}
|
||||
};
|
||||
const add = event.addEventListener;
|
||||
const remove = event.removeEventListener;
|
||||
event.addEventListener = (listener) => {
|
||||
const removeListener = add(listener);
|
||||
sync();
|
||||
return () => {
|
||||
removeListener();
|
||||
sync();
|
||||
};
|
||||
};
|
||||
event.removeEventListener = (listener) => {
|
||||
const removed = remove(listener);
|
||||
sync();
|
||||
return removed;
|
||||
};
|
||||
return {
|
||||
event,
|
||||
detach() {
|
||||
detached = true;
|
||||
sync();
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {Cesium.Viewer} viewer
|
||||
* @returns {{ camera: import('../contract.js').GlobeCamera, destroy: () => void }}
|
||||
@@ -60,6 +141,7 @@ export function createCesiumCamera(viewer) {
|
||||
changed: bridgeEvent(cesium.changed),
|
||||
moveStart: bridgeEvent(cesium.moveStart),
|
||||
moveEnd: bridgeEvent(cesium.moveEnd),
|
||||
commanded: commandedEvent(viewer, cesium),
|
||||
};
|
||||
|
||||
// The engine's own flight, so flightActive is exact even for flights that
|
||||
@@ -109,6 +191,7 @@ export function createCesiumCamera(viewer) {
|
||||
up: toGeo3(cesium.upWC),
|
||||
right: toGeo3(cesium.rightWC),
|
||||
fovy: cesium.frustum.fovy,
|
||||
aspectRatio: cesium.frustum.aspectRatio,
|
||||
};
|
||||
},
|
||||
// Cesium updates positionWC in place; it is the live object.
|
||||
@@ -203,6 +286,7 @@ export function createCesiumCamera(viewer) {
|
||||
changed: bridges.changed.event,
|
||||
moveStart: bridges.moveStart.event,
|
||||
moveEnd: bridges.moveEnd.event,
|
||||
commanded: bridges.commanded.event,
|
||||
get percentageChanged() {
|
||||
return cesium.percentageChanged;
|
||||
},
|
||||
|
||||
@@ -360,3 +360,69 @@ test('the camera is the viewer camera (Viewer.camera is scene.camera)', () => {
|
||||
const { camera } = createCesiumCamera({ ...viewer, camera: own });
|
||||
assert.equal(camera.livePosition, own.positionWC);
|
||||
});
|
||||
|
||||
test('pose carries the frustum aspect ratio', () => {
|
||||
const { camera, cesium } = setup();
|
||||
assert.equal(camera.pose().aspectRatio, cesium.frustum.aspectRatio);
|
||||
});
|
||||
|
||||
test('commanded hooks the Cesium camera and tracking only while it has listeners', () => {
|
||||
const { viewer, camera, cesium, destroy } = setup();
|
||||
const names = [
|
||||
'flyTo',
|
||||
'flyToBoundingSphere',
|
||||
'setView',
|
||||
'lookAt',
|
||||
'cancelFlight',
|
||||
];
|
||||
const originals = Object.fromEntries(
|
||||
names.map((name) => [name, cesium[name]]),
|
||||
);
|
||||
const own = Object.fromEntries(
|
||||
names.map((name) => [name, Object.getOwnPropertyDescriptor(cesium, name)]),
|
||||
);
|
||||
let raised = 0;
|
||||
const listener = () => raised++;
|
||||
const remove = camera.commanded.addEventListener(listener);
|
||||
for (const name of names)
|
||||
assert.notEqual(cesium[name], originals[name], name);
|
||||
// Direct calls on the viewer camera (layers, cockpit) announce themselves.
|
||||
cesium.setView({});
|
||||
assert.equal(raised, 1);
|
||||
cesium.cancelFlight();
|
||||
assert.equal(raised, 2);
|
||||
// So do engine commands, once per Cesium entry point they reach.
|
||||
camera.lookAt(geo.cartesian3.fromDegrees(0, 0, 0), {
|
||||
heading: 0,
|
||||
pitch: -1,
|
||||
range: 10,
|
||||
});
|
||||
assert.equal(raised, 3);
|
||||
assert.equal(viewer.callsOf('camera.lookAt').length, 1);
|
||||
// A new tracked entity takes the camera too.
|
||||
viewer.trackedEntityChanged.raiseEvent({ id: 'contact' });
|
||||
assert.equal(raised, 4);
|
||||
camera.release();
|
||||
assert.equal(raised, 4, 'release is not a new owner');
|
||||
remove();
|
||||
for (const name of names) {
|
||||
assert.equal(cesium[name], originals[name], `${name} restored`);
|
||||
assert.deepEqual(Object.getOwnPropertyDescriptor(cesium, name), own[name]);
|
||||
}
|
||||
assert.equal(viewer.trackedEntityChanged.numberOfListeners, 0);
|
||||
cesium.setView({});
|
||||
assert.equal(raised, 4);
|
||||
camera.commanded.addEventListener(listener);
|
||||
destroy();
|
||||
assert.equal(cesium.setView, originals.setView, 'destroy unhooks');
|
||||
assert.equal(viewer.trackedEntityChanged.numberOfListeners, 0);
|
||||
});
|
||||
|
||||
test('commanded leaves a newer hook on the camera in place', () => {
|
||||
const { camera, cesium } = setup();
|
||||
const remove = camera.commanded.addEventListener(() => {});
|
||||
const newer = () => {};
|
||||
cesium.flyTo = newer;
|
||||
remove();
|
||||
assert.equal(cesium.flyTo, newer);
|
||||
});
|
||||
@@ -69,5 +69,6 @@ export function createCesiumEngine(viewer, options = {}) {
|
||||
destroyed = true;
|
||||
for (const part of Object.values(parts)) part.destroy();
|
||||
},
|
||||
isDestroyed: () => destroyed,
|
||||
};
|
||||
}
|
||||
@@ -77,8 +77,10 @@ test('destroy releases holds, listeners, handlers and engine-owned map state', a
|
||||
engine.render.setContinuous(true);
|
||||
engine.credits.addStatic('credit');
|
||||
await engine.maps.setBaseImagery({ kind: 'osm' });
|
||||
assert.equal(engine.isDestroyed(), false);
|
||||
engine.destroy();
|
||||
engine.destroy();
|
||||
assert.equal(engine.isDestroyed(), true);
|
||||
assert.equal(viewer.scene.camera.changed.numberOfListeners, 0);
|
||||
assert.equal(viewer.scene.postRender.numberOfListeners, 0);
|
||||
assert.equal(handlers.handlers[0].destroyed, true);
|
||||
|
||||
@@ -41,6 +41,16 @@ export function createCesiumPicker(viewer) {
|
||||
get pickPositionSupported() {
|
||||
return Boolean(scene.pickPositionSupported);
|
||||
},
|
||||
pickGlobe(screen) {
|
||||
if (!scene.globe) return undefined;
|
||||
try {
|
||||
const camera = viewer.camera ?? scene.camera;
|
||||
const ray = camera.getPickRay(toCesium2(screen));
|
||||
return ray ? toGeo3(scene.globe.pick(ray, scene)) : undefined;
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
},
|
||||
};
|
||||
return { picker, destroy() {} };
|
||||
}
|
||||
@@ -92,3 +92,24 @@ test('pick results carry 3D tile content for surface checks', () => {
|
||||
scene.pick = () => ({ id: 'entity', primitive: {} });
|
||||
assert.equal(picker.pick(geo.cartesian2.create(1, 1)).content, undefined);
|
||||
});
|
||||
|
||||
test('pickGlobe asks the globe along the camera pick ray and returns geo', () => {
|
||||
const { viewer, picker, scene } = setup();
|
||||
const hit = picker.pickGlobe(geo.cartesian2.create(3, 4));
|
||||
assert.ok(!(hit instanceof Cesium.Cartesian3));
|
||||
assert.deepEqual([hit.x, hit.y, hit.z], [6378137, 3, 4]);
|
||||
const [screen] = viewer.callsOf('camera.getPickRay')[0].args;
|
||||
assert.ok(screen instanceof Cesium.Cartesian2);
|
||||
assert.equal(screen.toString(), '(3, 4)');
|
||||
const [ray, pickedScene] = viewer.callsOf('globe.pick')[0].args;
|
||||
assert.ok(ray instanceof Cesium.Ray);
|
||||
assert.equal(pickedScene, scene);
|
||||
scene.globe.pick = () => undefined;
|
||||
assert.equal(picker.pickGlobe(geo.cartesian2.create(1, 1)), undefined);
|
||||
scene.globe.pick = () => {
|
||||
throw new Error('no ray');
|
||||
};
|
||||
assert.equal(picker.pickGlobe(geo.cartesian2.create(1, 1)), undefined);
|
||||
scene.globe = undefined;
|
||||
assert.equal(picker.pickGlobe(geo.cartesian2.create(1, 1)), undefined);
|
||||
});
|
||||
@@ -107,6 +107,7 @@ export function createFakeViewer({ width = 1024, height = 768 } = {}) {
|
||||
show: true,
|
||||
tilesLoaded: true,
|
||||
getHeight: record('globe.getHeight', () => 12.5),
|
||||
pick: record('globe.pick', () => new Cesium.Cartesian3(6378137, 3, 4)),
|
||||
};
|
||||
const scene = {
|
||||
camera,
|
||||
@@ -163,6 +164,7 @@ export function createFakeViewer({ width = 1024, height = 768 } = {}) {
|
||||
creditDisplay,
|
||||
staticCredits,
|
||||
primitiveList,
|
||||
trackedEntityChanged: new Cesium.Event(),
|
||||
imageryList,
|
||||
terrainProvider: undefined,
|
||||
imageryLayers: {
|
||||
|
||||
Reference in new issue
Block a user