mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-16 08:12:24 +00:00
Give a viewer with no renderer an effects port, as cameras get
The renderer bridge builds and keeps an effects port over a viewer no renderer is bound to, with a factory the Cesium effects module provides, so visual settings on a caller's own viewer draw their styles, bloom and sharpen as before and give the scene's bloom back when destroyed. The application shell loads the factory; a test checks every export that reaches the effects lookup loads it.
This commit is contained in:
1 parent
6a7905fc49
commit
94b8b0bd30
8 files changed
+333
-64
No files matched your search
Vendored
+68
-9
@@ -22,7 +22,8 @@
|
||||
* in its own shader, not the frame.
|
||||
*/
|
||||
import * as Cesium from 'cesium';
|
||||
import { listenerList } from './common.js';
|
||||
import { provideUnboundEffects } from '../rendererOf.js';
|
||||
import { listenerList, uncaught } from './common.js';
|
||||
|
||||
/** Below this a style, bloom or sharpen draws nothing, so it runs no pass. */
|
||||
const OFF = 0.001;
|
||||
@@ -135,6 +136,9 @@ export function createCesiumEffects(
|
||||
let disposed = false;
|
||||
const started = performance.now();
|
||||
|
||||
// Disposed, or the scene went first and took its stages with it.
|
||||
const gone = () => disposed || scene.isDestroyed?.() === true;
|
||||
|
||||
const drawing = (record) =>
|
||||
(record.id === current || fading.has(record.id)) && record.intensity > OFF;
|
||||
|
||||
@@ -197,7 +201,7 @@ export function createCesiumEffects(
|
||||
}
|
||||
|
||||
function changed(reason) {
|
||||
if (disposed) return;
|
||||
if (gone()) return;
|
||||
apply();
|
||||
frame.requestRender(reason);
|
||||
listeners.fire(port.diagnostics());
|
||||
@@ -217,7 +221,7 @@ export function createCesiumEffects(
|
||||
: [],
|
||||
defineStyle(definition) {
|
||||
if (
|
||||
disposed ||
|
||||
gone() ||
|
||||
!capabilities.has('styles') ||
|
||||
typeof definition?.shader?.glsl !== 'string'
|
||||
)
|
||||
@@ -260,7 +264,7 @@ export function createCesiumEffects(
|
||||
return () => {
|
||||
if (removed) return;
|
||||
removed = true;
|
||||
if (disposed || styles.get(id) !== record) return;
|
||||
if (gone() || styles.get(id) !== record) return;
|
||||
styles.delete(id);
|
||||
stages.remove(record.stage);
|
||||
fading.delete(id);
|
||||
@@ -269,7 +273,7 @@ export function createCesiumEffects(
|
||||
};
|
||||
},
|
||||
setStyle(id, params) {
|
||||
if (disposed || !capabilities.has('styles')) return;
|
||||
if (gone() || !capabilities.has('styles')) return;
|
||||
const next = id === null || id === undefined ? null : String(id);
|
||||
if (next !== null && !styles.has(next)) return;
|
||||
if (next !== current) {
|
||||
@@ -282,19 +286,19 @@ export function createCesiumEffects(
|
||||
changed('effects-style');
|
||||
},
|
||||
setStyleIntensity(id, intensity) {
|
||||
if (disposed || !known(id)) return;
|
||||
if (gone() || !known(id)) return;
|
||||
const record = styles.get(id);
|
||||
record.intensity = clamp01(intensity);
|
||||
if (record.intensity <= OFF) fading.delete(id);
|
||||
changed('effects-style');
|
||||
},
|
||||
setStyleParams(id, params) {
|
||||
if (disposed || !known(id)) return;
|
||||
if (gone() || !known(id)) return;
|
||||
assignParams(styles.get(id), params);
|
||||
changed('effects-style');
|
||||
},
|
||||
bloom({ enabled, strength } = {}) {
|
||||
if (disposed || !capabilities.has('bloom')) return;
|
||||
if (gone() || !capabilities.has('bloom')) return;
|
||||
const bloom = scene.postProcessStages.bloom;
|
||||
if (!bloomTaken) {
|
||||
bloomTaken = {
|
||||
@@ -311,7 +315,7 @@ export function createCesiumEffects(
|
||||
changed('effects-bloom');
|
||||
},
|
||||
sharpen({ enabled, amount } = {}) {
|
||||
if (disposed || !capabilities.has('sharpen')) return;
|
||||
if (gone() || !capabilities.has('sharpen')) return;
|
||||
sharpenEnabled = Boolean(enabled);
|
||||
if (amount !== undefined) sharpenAmount = clamp01(amount);
|
||||
if (!sharpenStage) makeSharpen();
|
||||
@@ -352,6 +356,13 @@ export function createCesiumEffects(
|
||||
disposed = true;
|
||||
stopClock();
|
||||
listeners.clear();
|
||||
// A destroyed scene took its stages with it.
|
||||
if (scene.isDestroyed?.()) {
|
||||
styles.clear();
|
||||
sharpenStage = null;
|
||||
bloomTaken = null;
|
||||
return;
|
||||
}
|
||||
for (const record of styles.values()) stages.remove(record.stage);
|
||||
styles.clear();
|
||||
if (sharpenStage) stages.remove(sharpenStage);
|
||||
@@ -365,3 +376,51 @@ export function createCesiumEffects(
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* The frame port's members the effects port uses, straight over a scene no
|
||||
* renderer drives: a hold asks for the next frame after each one drawn.
|
||||
* @param {object} scene
|
||||
*/
|
||||
function sceneFrame(scene) {
|
||||
return {
|
||||
on: (phase, cb) =>
|
||||
scene[phase].addEventListener(() => cb({ now: performance.now() })),
|
||||
requestRender: () => scene.requestRender(),
|
||||
holdContinuous() {
|
||||
const off = scene.postRender.addEventListener(() =>
|
||||
scene.requestRender(),
|
||||
);
|
||||
scene.requestRender();
|
||||
let released = false;
|
||||
return () => {
|
||||
if (released) return;
|
||||
released = true;
|
||||
off();
|
||||
if (!scene.isDestroyed?.()) scene.requestRender();
|
||||
};
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
// A Cesium viewer with no renderer bound to it gets an
|
||||
// effects port over its scene when code first asks `findEffects` for one.
|
||||
provideUnboundEffects((viewer) => {
|
||||
const scene = viewer.scene;
|
||||
// By shape, not `instanceof`: the viewer may come from another
|
||||
// copy of Cesium.
|
||||
if (
|
||||
typeof scene?.postProcessStages?.add !== 'function' ||
|
||||
typeof scene.postProcessStages.remove !== 'function' ||
|
||||
!scene.postProcessStages.bloom ||
|
||||
typeof scene.preRender?.addEventListener !== 'function' ||
|
||||
typeof scene.postRender?.addEventListener !== 'function' ||
|
||||
typeof scene.requestRender !== 'function'
|
||||
)
|
||||
return null;
|
||||
return createCesiumEffects(scene, {
|
||||
capabilities: new Set(['styles', 'bloom', 'sharpen']),
|
||||
frame: sceneFrame(scene),
|
||||
report: uncaught,
|
||||
});
|
||||
});
|
||||
@@ -1,6 +1,7 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import test from 'node:test';
|
||||
import { bloomUniforms, createCesiumEffects } from './effects.js';
|
||||
import { findEffects, releaseUnboundEffects } from '../rendererOf.js';
|
||||
|
||||
const ALL = new Set(['styles', 'bloom', 'sharpen']);
|
||||
|
||||
@@ -300,3 +301,90 @@ test('dispose removes every stage and releases the clock', () => {
|
||||
f.effects.setStyle('anim');
|
||||
assert.equal(f.stages.length, 0);
|
||||
});
|
||||
|
||||
test('a viewer with no renderer gets an effects port over its scene', () => {
|
||||
const events = () => {
|
||||
const cbs = new Set();
|
||||
return {
|
||||
cbs,
|
||||
addEventListener(cb) {
|
||||
cbs.add(cb);
|
||||
return () => cbs.delete(cb);
|
||||
},
|
||||
raise: () => [...cbs].forEach((cb) => cb()),
|
||||
};
|
||||
};
|
||||
const stages = [];
|
||||
let requests = 0;
|
||||
const scene = {
|
||||
postProcessStages: {
|
||||
bloom: { enabled: false, uniforms: {} },
|
||||
add: (stage) => stages.push(stage),
|
||||
remove: (stage) => stages.splice(stages.indexOf(stage), 1),
|
||||
},
|
||||
preRender: events(),
|
||||
postRender: events(),
|
||||
requestRender: () => (requests += 1),
|
||||
};
|
||||
const viewer = { scene };
|
||||
const effects = findEffects(viewer);
|
||||
assert.ok(effects, 'built');
|
||||
assert.equal(findEffects(viewer), effects, 'kept');
|
||||
assert.equal(findEffects({ scene: {} }), null, 'not a Cesium scene');
|
||||
effects.bloom({ enabled: true, strength: 1 });
|
||||
assert.equal(scene.postProcessStages.bloom.enabled, true);
|
||||
// An animated style draws every frame while it shows.
|
||||
effects.defineStyle(style('anim', { animated: true }));
|
||||
effects.setStyle('anim');
|
||||
assert.equal(scene.postRender.cbs.size, 1, 'held');
|
||||
const before = requests;
|
||||
scene.postRender.raise();
|
||||
assert.equal(requests, before + 1, 'the next frame is asked for');
|
||||
effects.setStyleIntensity('anim', 0);
|
||||
assert.equal(scene.postRender.cbs.size, 0, 'released');
|
||||
assert.equal(scene.preRender.cbs.size, 0);
|
||||
releaseUnboundEffects(viewer, {});
|
||||
assert.ok(stages.length > 0, 'another port is not let go of');
|
||||
releaseUnboundEffects(viewer, effects);
|
||||
assert.equal(stages.length, 0, 'let go: its passes are gone');
|
||||
assert.equal(
|
||||
scene.postProcessStages.bloom.enabled,
|
||||
false,
|
||||
'bloom given back',
|
||||
);
|
||||
assert.notEqual(findEffects(viewer), effects, 'a later lookup builds anew');
|
||||
});
|
||||
|
||||
test('a destroyed scene is let go of without touching it', () => {
|
||||
let destroyed = false;
|
||||
const scene = {
|
||||
isDestroyed: () => destroyed,
|
||||
postProcessStages: {
|
||||
bloom: { enabled: false, uniforms: {} },
|
||||
add() {},
|
||||
remove() {
|
||||
if (destroyed) throw new Error('destroyed');
|
||||
},
|
||||
},
|
||||
preRender: { addEventListener: () => () => {} },
|
||||
postRender: { addEventListener: () => () => {} },
|
||||
requestRender() {
|
||||
if (destroyed) throw new Error('destroyed');
|
||||
},
|
||||
};
|
||||
const viewer = { scene, isDestroyed: () => destroyed };
|
||||
const effects = findEffects(viewer);
|
||||
effects.defineStyle(style('anim', { animated: true }));
|
||||
effects.setStyle('anim');
|
||||
effects.bloom({ enabled: true, strength: 1 });
|
||||
effects.sharpen({ enabled: true, amount: 1 });
|
||||
const off = effects.defineStyle(style('plain'));
|
||||
destroyed = true;
|
||||
// The app's own teardown after the scene went: nothing throws.
|
||||
off();
|
||||
effects.bloom({ enabled: false });
|
||||
effects.sharpen({ enabled: false });
|
||||
effects.setStyle(null);
|
||||
releaseUnboundEffects(viewer, effects);
|
||||
assert.equal(findEffects(viewer), null);
|
||||
});
|
||||
Reference in new issue
Block a user