Files
gods-eye-view/src/render/rendererOf.js
T
Sameh Khamis 94b8b0bd30 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.
2026-11-06 16:33:40 -08:00

186 lines
6.2 KiB
JavaScript

/**
* @module render/rendererOf
* @description The renderer that draws a scene, found from the scene object
* the code already holds. It bridges the migration: code that still holds
* the scene reaches the renderer's ports through it, and the lookup goes
* once that code is handed the renderer itself.
*/
const renderers = new WeakMap();
/**
* Ports built for scene objects no renderer is bound to (a viewer of a
* made directly, say), per port: each `{port, dispose}` kept for as long
* as its scene object lives, or until a renderer is bound to it. The
* renderer adapter provides the factory each is built with as it loads.
*/
function unboundPorts(member) {
const built = new WeakMap();
let build = null;
return {
provide(factory) {
build = factory;
},
drop(host, port) {
const entry = built.get(host);
if (!entry || (port !== undefined && entry.port !== port)) return;
built.delete(host);
entry.dispose();
},
/**
* A renderer bound to `host` supersedes its built port: released when
* it can be (it stops working for new callers but keeps what it did),
* else disposed.
*/
supersede(host) {
const entry = built.get(host);
if (!entry) return;
built.delete(host);
if (entry.release) entry.release();
else entry.dispose();
},
find(host) {
const port = rendererOf(host)?.[member];
if (port) return port;
if (!host || typeof host !== 'object') return null;
if (host.isDestroyed?.()) {
// Gone with its scene: let the built port go with it.
this.drop(host);
return null;
}
let entry = built.get(host);
if (!entry && build) {
entry = build(host);
if (entry) built.set(host, entry);
}
return entry?.port ?? null;
},
};
}
const unboundCameras = unboundPorts('camera');
const unboundEffects = unboundPorts('effects');
/** Credits ports are `{port, dispose, release}`: see `bindRenderer`. */
const unboundCredits = unboundPorts('credits');
/**
* Provide the factory `cameraOf` builds a camera port with for a scene
* object no renderer is bound to. The renderer adapter provides it as it
* loads; a later call replaces it.
* @param {(host: object) => ({port: object, dispose: () => void} | null)} build
*/
export function provideUnboundCamera(build) {
unboundCameras.provide(build);
}
/**
* Provide the factory `findCredits` builds a credits port with for a scene
* object no renderer is bound to, as `provideUnboundCamera` does. `release`
* detaches a port a bound renderer supersedes, keeping its credits shown.
* @param {(host: object) => ({port: object, dispose: () => void,
* release: () => void} | null)} build
*/
export function provideUnboundCredits(build) {
unboundCredits.provide(build);
}
/**
* Provide the factory `findEffects` builds an effects port with for a
* scene object no renderer is bound to, as `provideUnboundCamera` does.
* @param {(host: object) => ({port: object, dispose: () => void} | null)} build
*/
export function provideUnboundEffects(build) {
unboundEffects.provide(build);
}
/**
* Let go of `port`, if it is the effects port `findEffects` built for
* `host`: its passes go and the scene's own settings come back. A
* renderer's own port, or one built later, is left alone.
* @param {object|null|undefined} host
* @param {object|null|undefined} port
*/
export function releaseUnboundEffects(host, port) {
if (host && typeof host === 'object' && port) unboundEffects.drop(host, port);
}
/**
* Bind a renderer to its scene object. A port `cameraOf` or `findEffects`
* built for it while it had no renderer is disposed: its listeners hear
* nothing more, and they answer with the renderer's ports from then on.
* A credits port `findCredits` built is released, not disposed: the
* credits added through it stay shown until their own Off.
* @param {object} host The scene object callers hold.
* @param {object} renderer
* @returns {() => void} Unbinds, if the binding is still this one.
*/
export function bindRenderer(host, renderer) {
if (renderers.has(host)) throw new Error('This scene already has a renderer');
// The renderer's ports supersede ones built while there was none.
unboundCameras.drop(host);
unboundEffects.drop(host);
unboundCredits.supersede(host);
renderers.set(host, renderer);
return () => {
if (renderers.get(host) === renderer) renderers.delete(host);
};
}
/**
* @param {object|null|undefined} host
* @returns {object|null} The renderer bound to `host`, or null.
*/
export const rendererOf = (host) => (host && renderers.get(host)) || null;
/**
* The camera port of the renderer bound to `host`; with no renderer bound,
* one built over `host` by the provided factory and kept with it while
* `host` lives.
* @param {object|null|undefined} host
* @returns {import('./contract/camera').CameraPort | null} Null when `host`
* has no renderer and no camera can be built for it, or is destroyed.
*/
export function findCamera(host) {
return unboundCameras.find(host);
}
/**
* The effects port of the renderer bound to `host`; with no renderer bound,
* one built over `host` by the provided factory and kept with it while
* `host` lives.
* @param {object|null|undefined} host
* @returns {import('./contract/effects').EffectsPort | null} Null when
* `host` has no renderer and no effects can be built for it, or is
* destroyed.
*/
export function findEffects(host) {
return unboundEffects.find(host);
}
/**
* The credits port of the renderer bound to `host`; with no renderer bound,
* one built over `host` by the provided factory and kept with it while
* `host` lives, as `findCamera` does.
* @param {object|null|undefined} host
* @returns {import('./contract/credits').CreditsPort | null}
*/
export function findCredits(host) {
return unboundCredits.find(host);
}
/**
* `findCamera`, for code that needs the camera.
* @param {object} host
* @returns {import('./contract/camera').CameraPort}
* @throws When there is no camera for `host`.
*/
export function cameraOf(host) {
const camera = findCamera(host);
if (camera) return camera;
throw new Error(
host?.isDestroyed?.()
? 'This scene has been destroyed'
: 'This scene has no renderer camera',
);
}