bruce-cesium 7.1.8 → 7.2.0

package/dist/bruce-cesium.umd.js

@@ -2969,8 +2969,30 @@
     const CESIUM_TIMELINE_INTERVAL_KEY = "_nextspace_timeline_interval";
     const CESIUM_MODEL_SPACE_KEY = "_nextspace_model_space";
     const DEFAULT_LIVE_PADDING_SECONDS = 30 * 60;
-    const DEFAULT_BRIGHTNESS_SHIFT = 0.2;
-    const DEFAULT_LIGHT_INTENSITY = 3;
+    // Atmosphere shifts are left alone by default. Tuning against a CAD scene showed the lift washing the
+    // sky without helping models, which are lit by the environment map rather than by the atmosphere.
+    const DEFAULT_BRIGHTNESS_SHIFT = 0;
+    /*
+     * Environment lighting defaults, arrived at by tuning against a white CAD model on CesiumJS 1.143.
+     */
+    function neutralEnvironmentMapOptions() {
+        return {
+            groundColor: Cesium.Color.WHITE.clone(),
+            groundAlbedo: 0.26,
+            brightness: 1.5,
+            atmosphereScatteringIntensity: 3.2
+        };
+    }
+    // Sun intensity used when the bookmark's lighting settings name none.
+    const DEFAULT_LIGHT_INTENSITY = 2;
+    // Current shape of a bookmark's lighting settings.
+    const LIGHTING_SETTINGS_VERSION = 2;
+    // Settings we apply when version is unset or <=1 to compensate for newer Cesium looking darker and more yellow.
+    const LIGHT_INTENSITY_COMPENSATION = 1.2;
+    const MAX_COMPENSATED_LIGHT_INTENSITY = 3;
+    // Set by a host that wants something other than the defaults above. Undefined means "not overridden".
+    let overriddenEnvironmentMapOptions;
+    let overriddenImageBasedLighting;
     (function (ViewUtils) {
         function GatherLegacyMapTiles(params) {
             const viewer = params.viewer;
@@ -3338,15 +3360,97 @@
                     SCENE.skyAtmosphere.brightnessShift = shift;
                 }
             }
+            // The environment map is built from the atmosphere, and lighting it from the scene's own light
+            // rather than from straight above is what stops it reading flat.
+            const CESIUM = Cesium;
+            if (EngineShadesModelsDarker() && SCENE.atmosphere && CESIUM.DynamicAtmosphereLightingType) {
+                SCENE.atmosphere.dynamicLighting = CESIUM.DynamicAtmosphereLightingType.SCENE_LIGHT;
+            }
         }
         ViewUtils.ApplyDefaultBrightness = ApplyDefaultBrightness;
         /**
-         * Options handed to every tileset and model this library creates.
+         * Options applied to the environment based lighting of every tileset and model this library creates.
+         * Null leaves CesiumJS's own defaults in place.
+         * @param options eg { enabled: false } to switch the lighting off, or { saturation: 0 } to keep the
+         * lift without the ground bounce tinting untextured geometry.
+         */
+        function SetDefaultEnvironmentMapOptions(options) {
+            overriddenEnvironmentMapOptions = options;
+        }
+        ViewUtils.SetDefaultEnvironmentMapOptions = SetDefaultEnvironmentMapOptions;
+        /**
+         * Whether the host app's CesiumJS is a build that shades models darker than the ones these bookmarks were set up against.
+         * DynamicEnvironmentMapManager arrived with that change, so its presence marks
          */
-        function DefaultEnvironmentMapOptions() {
-            return { enabled: false };
+        function GetDefaultEnvironmentMapOptions(
+        // Overridable so the tuned values can be asserted without swapping out CesiumJS.
+        engineShadesDarker = EngineShadesModelsDarker()) {
+            if (overriddenEnvironmentMapOptions !== undefined) {
+                return overriddenEnvironmentMapOptions ? { ...overriddenEnvironmentMapOptions } : null;
+            }
+            if (!engineShadesDarker) {
+                return null;
+            }
+            return neutralEnvironmentMapOptions();
+        }
+        ViewUtils.GetDefaultEnvironmentMapOptions = GetDefaultEnvironmentMapOptions;
+        /**
+         * The lighting options every tileset and model this library creates is built with.
+         * Spread into the construction options, since both are read once when a primitive is made.
+         */
+        function DefaultLightingProps(engineShadesDarker = EngineShadesModelsDarker()) {
+            const props = {};
+            const environmentMapOptions = GetDefaultEnvironmentMapOptions(engineShadesDarker);
+            if (environmentMapOptions) {
+                props.environmentMapOptions = environmentMapOptions;
+            }
+            const imageBasedLighting = GetDefaultImageBasedLighting();
+            if (imageBasedLighting) {
+                props.imageBasedLighting = imageBasedLighting;
+            }
+            return props;
+        }
+        ViewUtils.DefaultLightingProps = DefaultLightingProps;
+        /**
+         * ImageBasedLighting applied to every tileset and model this library creates. Null, the default,
+         * leaves CesiumJS's own in place.
+         * @param imageBasedLighting a Cesium.ImageBasedLighting, shared across primitives.
+         */
+        function SetDefaultImageBasedLighting(imageBasedLighting) {
+            overriddenImageBasedLighting = imageBasedLighting;
+        }
+        ViewUtils.SetDefaultImageBasedLighting = SetDefaultImageBasedLighting;
+        function GetDefaultImageBasedLighting() {
+            return overriddenImageBasedLighting || null;
+        }
+        ViewUtils.GetDefaultImageBasedLighting = GetDefaultImageBasedLighting;
+        function EngineShadesModelsDarker() {
+            return typeof Cesium.DynamicEnvironmentMapManager !== "undefined";
+        }
+        ViewUtils.EngineShadesModelsDarker = EngineShadesModelsDarker;
+        /**
+         * Resolves the sun colour and intensity to apply for a bookmark's lighting settings.
+         * @param lighting the bookmark's lighting settings, or null when it carries none.
+         * @returns the colour and intensity to put on the scene light.
+         */
+        function ResolveLightSettings(lighting, 
+        // Overridable so both branches can be exercised without swapping out CesiumJS.
+        engineShadesDarker = EngineShadesModelsDarker()) {
+            const raw = lighting === null || lighting === void 0 ? void 0 : lighting.color;
+            const parsed = raw ? Cesium.Color.fromCssColorString(raw) : null;
+            const intensity = Number(lighting === null || lighting === void 0 ? void 0 : lighting.intensity);
+            const named = Number.isFinite(intensity) ? intensity : DEFAULT_LIGHT_INTENSITY;
+            // No settings at all means nothing was carried over from the older engine, so there is nothing
+            // to compensate. A settings object with no version in it is the case that predates the field.
+            const version = Number(lighting === null || lighting === void 0 ? void 0 : lighting.lightingVer);
+            const legacy = lighting != null && (!Number.isFinite(version) || version <= 1);
+            const compensated = Math.min(named * LIGHT_INTENSITY_COMPENSATION, MAX_COMPENSATED_LIGHT_INTENSITY);
+            return {
+                color: parsed || Cesium.Color.WHITE,
+                intensity: legacy && engineShadesDarker ? compensated : named
+            };
         }
-        ViewUtils.DefaultEnvironmentMapOptions = DefaultEnvironmentMapOptions;
+        ViewUtils.ResolveLightSettings = ResolveLightSettings;
         function SetGlobeDetails(params) {
             let { viewer, hidden, baseColor } = params;
             const scene = viewer === null || viewer === void 0 ? void 0 : viewer.scene;
@@ -14671,8 +14775,8 @@
         const defaultProps = {
             // "Optimization option. Reduce the screen space error for tiles that are further away from the camera.".
             dynamicScreenSpaceError: true,
-            environmentMapOptions: exports.ViewUtils.DefaultEnvironmentMapOptions()
         };
+        Object.assign(defaultProps, exports.ViewUtils.DefaultLightingProps());
         if (noMemoryLimit != true) {
             // "The maximum amount of memory in MB that can be used by the tileset.".
             defaultProps.maximumMemoryUsage = 512;
@@ -21388,7 +21492,7 @@
                                 }
                                 this.cTileset = await CESIUM.Cesium3DTileset.fromUrl(proxyRootUrl, {
                                     showCreditsOnScreen: true,
-                                    environmentMapOptions: exports.ViewUtils.DefaultEnvironmentMapOptions()
+                                    ...exports.ViewUtils.DefaultLightingProps()
                                 });
                             }
                             else {
@@ -22924,7 +23028,7 @@
                         const cEntity = this.viewer.entities.add({
                             model: {
                                 uri: lod["ClientFile"].URL,
-                                environmentMapOptions: exports.ViewUtils.DefaultEnvironmentMapOptions(),
+                                ...exports.ViewUtils.DefaultLightingProps(),
                                 heightReference: Cesium.HeightReference.NONE
                             },
                             // point: {
@@ -28982,13 +29086,15 @@
         if (lighting == null) {
             lighting = {
                 color: Cesium.Color.WHITE.toCssColorString(),
-                intensity: DEFAULT_LIGHT_INTENSITY
+                intensity: DEFAULT_LIGHT_INTENSITY,
+                lightingVer: LIGHTING_SETTINGS_VERSION
             };
         }
         const light = viewer.scene.light;
         if (light) {
-            light.color = Cesium.Color.fromCssColorString(lighting.color);
-            light.intensity = EnsureNumber(lighting.intensity);
+            const resolved = exports.ViewUtils.ResolveLightSettings(lighting);
+            light.color = resolved.color;
+            light.intensity = resolved.intensity;
         }
         exports.ViewUtils.ApplyDefaultBrightness(viewer, EnsureNumber(lighting.brightnessShift, DEFAULT_BRIGHTNESS_SHIFT));
         let quality = bSettings === null || bSettings === void 0 ? void 0 : bSettings.quality;
@@ -38639,7 +38745,7 @@
                     id: BModels.ObjectUtils.UId(15),
                     model: {
                         uri: params.lodUrl,
-                        environmentMapOptions: exports.ViewUtils.DefaultEnvironmentMapOptions(),
+                        ...exports.ViewUtils.DefaultLightingProps(),
                         heightReference: heightRef,
                         scale: new Cesium.CallbackProperty(() => scale * styleScale, true),
                         shadows: Cesium.ShadowMode.ENABLED,
@@ -39282,7 +39388,7 @@
                 url: url,
                 asynchronous: true,
                 scale: scale,
-                environmentMapOptions: exports.ViewUtils.DefaultEnvironmentMapOptions()
+                ...exports.ViewUtils.DefaultLightingProps()
             });
         }
         // Older versions of Cesium have a fromGltf method.
@@ -43419,7 +43525,7 @@ void main() {
         StyleUtils.ApplyTypeStyle = ApplyTypeStyle;
     })(exports.StyleUtils || (exports.StyleUtils = {}));
 
-    const VERSION = "7.1.8";
+    const VERSION = "7.2.0";
     /**
      * Updates the environment instance used by bruce-cesium to one specified.
      * This can be used to ensure that the instance a parent is referencing is shared between bruce-cesium, bruce-models, and the parent app.
@@ -43452,6 +43558,9 @@ void main() {
     exports.DEFAULT_LIVE_PADDING_SECONDS = DEFAULT_LIVE_PADDING_SECONDS;
     exports.DEFAULT_BRIGHTNESS_SHIFT = DEFAULT_BRIGHTNESS_SHIFT;
     exports.DEFAULT_LIGHT_INTENSITY = DEFAULT_LIGHT_INTENSITY;
+    exports.LIGHTING_SETTINGS_VERSION = LIGHTING_SETTINGS_VERSION;
+    exports.LIGHT_INTENSITY_COMPENSATION = LIGHT_INTENSITY_COMPENSATION;
+    exports.MAX_COMPENSATED_LIGHT_INTENSITY = MAX_COMPENSATED_LIGHT_INTENSITY;
     exports.Draw3dPolygon = Draw3dPolygon;
     exports.Draw3dPolyline = Draw3dPolyline;
     exports.WidgetControlViewBarSearch = WidgetControlViewBarSearch;