mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-16 16:22:20 +00:00
refactor(credits): use the globe engine
Map credits (maps/credits.js) are shown through a credits capability (engine.credits.addStatic) instead of the scene's credit display; the shared map scene takes the engine's credits, so the Cesium engine's maps and its credits part share one owner. Data credits (registerDataCredits, registerDynamicCredit, show/hideOsmCredit) take the globe engine and keep accepting a viewer from layers that still hold one; the scene registers the data credits on its engine. The Cesium credits part reads Viewer.creditDisplay, else the scene frame state display it aliases.
This commit is contained in:
1 parent
be56144d75
commit
83c13f330d
11 files changed
+169
-59
No files matched your search
+11
-11
@@ -1,21 +1,21 @@
|
||||
import * as Cesium from 'cesium';
|
||||
|
||||
/** Static credits follow the source actually on screen, including fallback. */
|
||||
export function createMapCredits(viewer) {
|
||||
let active = null;
|
||||
/**
|
||||
* Static credits follow the source actually on screen, including fallback.
|
||||
* @param {{ addStatic: (html: string, options?: { onScreen?: boolean }) => () => void }} credits
|
||||
* A globe engine's credits capability.
|
||||
*/
|
||||
export function createMapCredits(credits) {
|
||||
let remove = null;
|
||||
let markup = null;
|
||||
return {
|
||||
show(html) {
|
||||
if (html === markup) return;
|
||||
const display = viewer?.scene?.frameState?.creditDisplay;
|
||||
if (!display) return;
|
||||
try {
|
||||
if (active) display.removeStaticCredit(active);
|
||||
active = html ? new Cesium.Credit(html, true) : null;
|
||||
remove?.();
|
||||
remove = null;
|
||||
if (html) remove = credits.addStatic(html, { onScreen: true });
|
||||
markup = html;
|
||||
if (active) display.addStaticCredit(active);
|
||||
} catch {
|
||||
/* Switching remains usable on older credit displays. */
|
||||
/* Switching remains usable without a credit display. */
|
||||
}
|
||||
},
|
||||
destroy() {
|
||||
|
||||
+11
-3
@@ -1,4 +1,5 @@
|
||||
import * as Cesium from 'cesium';
|
||||
import { createCesiumCredits } from '../globe/cesium/credits.js';
|
||||
import { createMapCredits } from './credits.js';
|
||||
|
||||
/**
|
||||
@@ -7,13 +8,20 @@ import { createMapCredits } from './credits.js';
|
||||
* Shared by MapSourceController and the Cesium globe engine's `maps`, so
|
||||
* both apply sources the same way. Creating it touches nothing.
|
||||
* @param {Cesium.Viewer} viewer
|
||||
* @param {{ createImageryLayer?: (provider: object) => object }} [options]
|
||||
* @param {{
|
||||
* createImageryLayer?: (provider: object) => object,
|
||||
* credits?: import('../globe/contract.js').GlobeEngine['credits'],
|
||||
* }} [options] `credits`: the globe engine's credits (default: the viewer's
|
||||
* credit display through the Cesium engine's credits).
|
||||
*/
|
||||
export function createMapScene(
|
||||
viewer,
|
||||
{ createImageryLayer = (provider) => new Cesium.ImageryLayer(provider) } = {},
|
||||
{
|
||||
createImageryLayer = (provider) => new Cesium.ImageryLayer(provider),
|
||||
credits: engineCredits = createCesiumCredits(viewer).credits,
|
||||
} = {},
|
||||
) {
|
||||
const credits = createMapCredits(viewer);
|
||||
const credits = createMapCredits(engineCredits);
|
||||
let layer = null;
|
||||
let provider = null;
|
||||
const scene = {
|
||||
|
||||
@@ -89,3 +89,21 @@ test('removeBaseImagery, tilesets, globe and credits', () => {
|
||||
assert.deepEqual(layers, []);
|
||||
assert.deepEqual(credits, []);
|
||||
});
|
||||
|
||||
test('the map scene shows its credit through a given credits capability', async () => {
|
||||
const { createFakeEngine } = await import('../globe/testing/fakeEngine.js');
|
||||
const engine = createFakeEngine();
|
||||
const { viewer, credits } = fixture();
|
||||
const scene = createMapScene(viewer, {
|
||||
createImageryLayer: (provider) => ({ provider }),
|
||||
credits: engine.credits,
|
||||
});
|
||||
scene.showCredit('Esri');
|
||||
scene.showCredit('Esri');
|
||||
assert.deepEqual(engine.fake.credits, [{ html: 'Esri', onScreen: true }]);
|
||||
scene.showCredit('OSM');
|
||||
assert.deepEqual(engine.fake.credits, [{ html: 'OSM', onScreen: true }]);
|
||||
scene.destroy();
|
||||
assert.deepEqual(engine.fake.credits, []);
|
||||
assert.deepEqual(credits, [], 'nothing on the viewer display');
|
||||
});
|
||||
Reference in new issue
Block a user