mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-16 08:12:24 +00:00
Complete the Cesium frame port
The frame port now does everything the contract asks of it on Cesium: preUpdate says whether the tick draws (Cesium's own render test, read live until the tick is over), holds are counted per reason, and suspend, target fps, renderNow and diagnostics are real. Releasing the last hold asks for one more frame. whenSettled also waits until Cesium stops redrawing on its own. Each request or worker task Cesium completes queues a redraw (a terrain picker build after the camera moved, say), which no loading flag shows, so it now waits for quiet frames and then a short stretch in which the loop draws nothing by itself. It is bounded by its timeout, names a stopped loop, and ends on destroy. The app renderer still leaves out the members that steer the loop: the render governor and the page's visibility handling own those settings until they move onto the port. The new frame.prediction check compares the preUpdate answer with what each tick drew.
This commit is contained in:
1 parent
1a9bdd9b63
commit
e6d22e55d7
11 files changed
+842
-55
No files matched your search
@@ -1,4 +1,5 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import * as Cesium from 'cesium';
|
||||
import test from 'node:test';
|
||||
import { cesiumCapabilities, createCesiumPorts } from './ports.js';
|
||||
|
||||
@@ -186,3 +187,258 @@ test('clampToSurface misses a position it cannot read, not the batch', async ()
|
||||
assert.ok(Math.abs(Math.hypot(good.x, good.y, good.z) - 6378142) < 1e-6);
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
/** A widget whose scene events can be raised by hand. */
|
||||
function tickingWidget() {
|
||||
const events = {};
|
||||
const event = (name) => {
|
||||
const list = (events[name] = []);
|
||||
return {
|
||||
addEventListener(cb) {
|
||||
list.push(cb);
|
||||
return () => list.splice(list.indexOf(cb), 1);
|
||||
},
|
||||
};
|
||||
};
|
||||
const camera = new Cesium.Camera({
|
||||
canvas: { clientWidth: 100, clientHeight: 100 },
|
||||
drawingBufferWidth: 100,
|
||||
drawingBufferHeight: 100,
|
||||
mapProjection: new Cesium.GeographicProjection(),
|
||||
});
|
||||
const seen = Cesium.Camera.clone(camera);
|
||||
let requested = 0;
|
||||
const scene = {
|
||||
camera,
|
||||
_view: { _cameraClone: seen },
|
||||
_frameState: { afterRender: [] },
|
||||
requestRenderMode: true,
|
||||
maximumRenderTimeChange: Infinity,
|
||||
primitives: { add() {}, remove() {} },
|
||||
requestRender() {
|
||||
requested += 1;
|
||||
scene._renderRequested = true;
|
||||
},
|
||||
preUpdate: event('preUpdate'),
|
||||
preRender: event('preRender'),
|
||||
postRender: event('postRender'),
|
||||
};
|
||||
const widget = {
|
||||
scene,
|
||||
clock: { currentTime: Cesium.JulianDate.now() },
|
||||
useDefaultRenderLoop: true,
|
||||
_renderLoopRunning: true,
|
||||
};
|
||||
const raise = (name) => {
|
||||
// `end`: the tick empties its after-render queue, as Scene#render does.
|
||||
if (name === 'end') {
|
||||
for (const fn of scene._frameState.afterRender.splice(0)) fn();
|
||||
return;
|
||||
}
|
||||
for (const cb of [...events[name]]) cb(scene, widget.clock.currentTime);
|
||||
};
|
||||
return { widget, scene, raise, requests: () => requested };
|
||||
}
|
||||
|
||||
test('preUpdate says whether the tick draws, as Cesium decides it', () => {
|
||||
const { widget, scene, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
const seen = [];
|
||||
ports.frame.on('preUpdate', (t) => seen.push(t.rendering));
|
||||
raise('preUpdate');
|
||||
ports.frame.requestRender('r');
|
||||
raise('preUpdate');
|
||||
scene._renderRequested = false;
|
||||
scene.camera.position = new Cesium.Cartesian3(1, 2, 3);
|
||||
raise('preUpdate');
|
||||
scene.camera.position = Cesium.Cartesian3.clone(
|
||||
scene._view._cameraClone.position,
|
||||
);
|
||||
scene.requestRenderMode = false;
|
||||
raise('preUpdate');
|
||||
assert.deepEqual(seen, [false, true, true, true]);
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('preUpdate counts what earlier listeners did this tick', () => {
|
||||
const { widget, scene, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
const seen = [];
|
||||
ports.frame.on('preUpdate', (t) => seen.push(['before', t.rendering]));
|
||||
ports.frame.on('preUpdate', () => {
|
||||
scene.camera.position = new Cesium.Cartesian3(7, 8, 9);
|
||||
});
|
||||
ports.frame.on('preUpdate', (t) => seen.push(['after', t.rendering]));
|
||||
raise('preUpdate');
|
||||
assert.deepEqual(seen, [
|
||||
['before', false],
|
||||
['after', true],
|
||||
]);
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('holds are counted per reason and switch the loop to every frame', () => {
|
||||
const { widget, scene, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
const a = ports.frame.holdContinuous('a');
|
||||
const a2 = ports.frame.holdContinuous('a');
|
||||
assert.equal(scene.requestRenderMode, false);
|
||||
assert.deepEqual(ports.frame.diagnostics().holds, ['a', 'a']);
|
||||
a();
|
||||
a();
|
||||
assert.equal(scene.requestRenderMode, false, 'one hold of a still out');
|
||||
a2();
|
||||
assert.equal(scene.requestRenderMode, true);
|
||||
assert.deepEqual(ports.frame.diagnostics().holds, []);
|
||||
ports.frame.requestRender('x');
|
||||
ports.frame.requestRender('x');
|
||||
assert.deepEqual(ports.frame.diagnostics().pendingReasons, ['x']);
|
||||
raise('preUpdate');
|
||||
raise('preRender');
|
||||
raise('postRender');
|
||||
const d = ports.frame.diagnostics();
|
||||
assert.deepEqual(d.pendingReasons, [], 'a drawn frame answers them');
|
||||
assert.equal(d.frames, 1);
|
||||
assert.equal(d.rendered, 1);
|
||||
assert.equal(ports.frame.mode(), 'demand');
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('suspend stops the loop at once and resumes it; target fps caps it', () => {
|
||||
const { widget, requests } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
ports.frame.suspend(true);
|
||||
assert.equal(widget.useDefaultRenderLoop, false);
|
||||
assert.equal(
|
||||
widget._renderLoopRunning,
|
||||
true,
|
||||
'the queued callback stops the loop itself',
|
||||
);
|
||||
assert.equal(ports.frame.diagnostics().suspended, true);
|
||||
const before = requests();
|
||||
ports.frame.suspend(false);
|
||||
assert.equal(widget.useDefaultRenderLoop, true);
|
||||
assert.equal(requests(), before + 1, 'a frame on resume');
|
||||
ports.frame.setTargetFps(30);
|
||||
assert.equal(widget.targetFrameRate, 30);
|
||||
assert.equal(ports.frame.diagnostics().targetFps, 30);
|
||||
ports.frame.setTargetFps(0);
|
||||
assert.equal(widget.targetFrameRate, undefined, '0 is the display rate');
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('rendering holds the tick’s answer once the tick is over', () => {
|
||||
const { widget, scene, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
const kept = [];
|
||||
ports.frame.on('preUpdate', (t) => kept.push(t));
|
||||
ports.frame.requestRender('r');
|
||||
raise('preUpdate');
|
||||
raise('preRender');
|
||||
scene._renderRequested = false;
|
||||
raise('postRender');
|
||||
raise('preUpdate');
|
||||
scene.requestRenderMode = false;
|
||||
raise('preUpdate');
|
||||
assert.deepEqual(
|
||||
kept.map((t) => t.rendering),
|
||||
[true, false, true],
|
||||
'drawn, not drawn, and the live tick',
|
||||
);
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('a reason given while a frame draws waits for the next one', () => {
|
||||
const { widget, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
ports.frame.requestRender('before');
|
||||
ports.frame.on('preRender', () => ports.frame.requestRender('during'));
|
||||
raise('preUpdate');
|
||||
raise('preRender');
|
||||
raise('postRender');
|
||||
assert.deepEqual(ports.frame.diagnostics().pendingReasons, ['during']);
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('the same reason given again while it is answered stays pending', () => {
|
||||
const { widget, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
ports.frame.requestRender('animation');
|
||||
ports.frame.requestRender('animation');
|
||||
assert.deepEqual(ports.frame.diagnostics().pendingReasons, ['animation']);
|
||||
ports.frame.on('preRender', () => ports.frame.requestRender('animation'));
|
||||
raise('preUpdate');
|
||||
raise('preRender');
|
||||
raise('postRender');
|
||||
assert.deepEqual(ports.frame.diagnostics().pendingReasons, ['animation']);
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('scene time past maximumRenderTimeChange draws', () => {
|
||||
const { widget, scene, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
const seen = [];
|
||||
ports.frame.on('preUpdate', (t) => seen.push(t.rendering));
|
||||
scene.maximumRenderTimeChange = 1;
|
||||
scene._lastRenderTime = Cesium.JulianDate.addSeconds(
|
||||
widget.clock.currentTime,
|
||||
-0.5,
|
||||
new Cesium.JulianDate(),
|
||||
);
|
||||
raise('preUpdate');
|
||||
scene._lastRenderTime = Cesium.JulianDate.addSeconds(
|
||||
widget.clock.currentTime,
|
||||
-2,
|
||||
new Cesium.JulianDate(),
|
||||
);
|
||||
raise('preUpdate');
|
||||
assert.deepEqual(seen, [false, true]);
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('holds work from a scene that already draws every frame', () => {
|
||||
const { widget, scene } = tickingWidget();
|
||||
scene.requestRenderMode = false;
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
const release = ports.frame.holdContinuous('a');
|
||||
ports.frame.holdContinuous('b');
|
||||
ports.frame.holdContinuous('b');
|
||||
assert.deepEqual(ports.frame.diagnostics().holds.sort(), ['a', 'b', 'b']);
|
||||
release();
|
||||
assert.equal(scene.requestRenderMode, false, 'b still holds');
|
||||
ports.dispose();
|
||||
});
|
||||
|
||||
test('a tick that did not draw says so once it is over', () => {
|
||||
const { widget, scene, raise } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
let kept;
|
||||
ports.frame.on('preUpdate', (t) => (kept = t));
|
||||
raise('preUpdate');
|
||||
raise('end');
|
||||
assert.equal(kept.rendering, false);
|
||||
scene.requestRender();
|
||||
assert.equal(kept.rendering, false, 'a later request is the next tick’s');
|
||||
raise('preUpdate');
|
||||
assert.equal(kept.rendering, true, 'the request draws the next tick');
|
||||
const live = kept;
|
||||
ports.dispose();
|
||||
// The port no longer sees the tick through, so it does not claim a draw.
|
||||
assert.equal(live.rendering, false, 'disposal settles the tick under way');
|
||||
});
|
||||
|
||||
test('releasing the last hold asks for one more frame', () => {
|
||||
const { widget, scene, requests } = tickingWidget();
|
||||
const ports = createCesiumPorts(widget, { capabilities: all });
|
||||
const a = ports.frame.holdContinuous('a');
|
||||
const b = ports.frame.holdContinuous('b');
|
||||
const before = requests();
|
||||
a();
|
||||
assert.equal(requests(), before, 'a hold still out draws anyway');
|
||||
b();
|
||||
assert.equal(requests(), before + 1);
|
||||
assert.equal(scene.requestRenderMode, true);
|
||||
b();
|
||||
assert.equal(requests(), before + 1, 'a second release does nothing');
|
||||
ports.dispose();
|
||||
});
|
||||
Reference in new issue
Block a user