bruce-cesium 7.1.9 → 7.2.0

package/dist/bruce-cesium.es5.js

@@ -1,6 +1,6 @@
 import * as Cesium from 'cesium';
-import { Cartographic, ColorMaterialProperty, Entity, Color, ConstantProperty, CallbackProperty, Primitive, Cesium3DTileFeature, ShaderSource, Cartesian3, Math as Math$1, Ellipsoid, Transforms, Matrix4, Geometry, GeometryAttribute, ComponentDatatype, PrimitiveType, BoundingSphere, GeometryPipeline, sampleTerrain, Texture, PixelFormat, Sampler, TextureWrap, TextureMinificationFilter, TextureMagnificationFilter, VertexArray, BufferUsage, ShaderProgram, RenderState, BlendingState, DrawCommand, Pass, Cartesian2, JulianDate, Quaternion, HeadingPitchRoll, HeightReference, ColorBlendMode, ShadowMode, ClassificationType, Model, DistanceDisplayCondition, ArcType, CornerType, ConstantPositionProperty, HorizontalOrigin, VerticalOrigin, ImageMaterialProperty, PolygonHierarchy, PolylineGraphics, Rectangle, SceneTransforms, NearFarScalar, Matrix3, KmlDataSource, GeoJsonDataSource, SceneMode, Cesium3DTileStyle, HeadingPitchRange, Ion, IonResource, Cesium3DTileColorBlendMode, Cesium3DTileset, EllipsoidTerrainProvider, IonImageryProvider, createWorldImagery, createWorldImageryAsync, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, CesiumTerrainProvider, Intersect, OrthographicFrustum, EasingFunction, EllipsoidGeodesic, sampleTerrainMostDetailed, defined, PolygonPipeline, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, CustomDataSource, CesiumInspector, ClockRange, GeometryInstance, ScreenSpaceEventHandler, ScreenSpaceEventType, Fullscreen, CzmlDataSource } from 'cesium';
-import { Cartes, Entity as Entity$1, ProjectViewTile, ENVIRONMENT, Calculator, ClientFile, EntityLod, EntityTag, EntityType, LRUCache, ObjectUtils, Style, Carto, Geometry as Geometry$1, MenuItem, ProjectView, ProjectViewBookmark, Tileset, ZoomControl, Api, BruceEvent, EntityCoords, Bounds, Color as Color$1, DataLab, DelayQueue, EntityHistoricData, BruceApi, EntityRelation, AccountConcept, RecordChangeFeed, EntitySource, ProgramKey, ProjectViewLegacyTile, Camera, Account, AccountLimits, Session, UrlUtils, ProjectViewBookmarkGroup, EntityAttachment, EntityAttachmentType, EntityAttribute, MathUtils, EntityRelationType } from 'bruce-models';
+import { Cartographic, ColorMaterialProperty, Entity, Color, ConstantProperty, CallbackProperty, Primitive, Cesium3DTileFeature, ShaderSource, Cartesian3, Math as Math$1, Ellipsoid, Transforms, Matrix4, Geometry, GeometryAttribute, ComponentDatatype, PrimitiveType, BoundingSphere, GeometryPipeline, sampleTerrain, Texture, PixelFormat, Sampler, TextureWrap, TextureMinificationFilter, TextureMagnificationFilter, VertexArray, BufferUsage, ShaderProgram, RenderState, BlendingState, DrawCommand, Pass, Cartesian2, DistanceDisplayCondition, JulianDate, Quaternion, HeadingPitchRoll, HeightReference, ColorBlendMode, ShadowMode, ClassificationType, Model, HorizontalOrigin, VerticalOrigin, ConstantPositionProperty, ArcType, CornerType, ImageMaterialProperty, PolygonHierarchy, PolylineGraphics, Rectangle, SceneTransforms, NearFarScalar, Matrix3, KmlDataSource, SceneMode, GeoJsonDataSource, Cesium3DTileStyle, HeadingPitchRange, Ion, IonResource, Cesium3DTileColorBlendMode, Cesium3DTileset, OrthographicFrustum, EasingFunction, EllipsoidTerrainProvider, IonImageryProvider, createWorldImagery, createWorldImageryAsync, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, CesiumTerrainProvider, Intersect, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, EllipsoidGeodesic, sampleTerrainMostDetailed, defined, CustomDataSource, PolygonPipeline, CesiumInspector, ClockRange, DynamicEnvironmentMapManager, GeometryInstance, ScreenSpaceEventHandler, ScreenSpaceEventType, Fullscreen, CzmlDataSource } from 'cesium';
+import { Cartes, Entity as Entity$1, ProjectViewTile, ENVIRONMENT, Calculator, ClientFile, EntityLod, EntityTag, EntityType, LRUCache, ObjectUtils, Style, Api, Carto, Geometry as Geometry$1, MenuItem, ProjectView, ProjectViewBookmark, Tileset, ZoomControl, Bounds, Color as Color$1, BruceEvent, EntityCoords, DataLab, DelayQueue, EntityHistoricData, EntityRelation, AccountConcept, RecordChangeFeed, BruceApi, EntitySource, Camera, ProgramKey, ProjectViewLegacyTile, Account, AccountLimits, Session, UrlUtils, ProjectViewBookmarkGroup, EntityAttachment, EntityAttachmentType, EntityAttribute, MathUtils, EntityRelationType } from 'bruce-models';
 
 /**
  * Ensures a number is returned from a given value.
@@ -2975,9 +2975,30 @@ const CESIUM_TIMELINE_LIVE_PADDING_KEY = "_nextspace_timeline_live_padding";
 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: 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;
 var ViewUtils;
 (function (ViewUtils) {
     function GatherLegacyMapTiles(params) {
@@ -3346,33 +3367,97 @@ var ViewUtils;
                 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 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 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 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) {
+    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;
-        // An unreadable or missing colour would otherwise leave the light undefined.
         const parsed = raw ? Color.fromCssColorString(raw) : null;
-        const version = Number(lighting === null || lighting === void 0 ? void 0 : lighting.lightingVer);
-        const stale = !Number.isFinite(version) || version <= 1;
         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 || Color.WHITE,
-            intensity: stale || !Number.isFinite(intensity) ? DEFAULT_LIGHT_INTENSITY : intensity
+            intensity: legacy && engineShadesDarker ? compensated : named
         };
     }
     ViewUtils.ResolveLightSettings = ResolveLightSettings;
-    /**
-     * Options handed to every tileset and model this library creates.
-     */
-    function DefaultEnvironmentMapOptions() {
-        return { enabled: false };
-    }
-    ViewUtils.DefaultEnvironmentMapOptions = DefaultEnvironmentMapOptions;
     function SetGlobeDetails(params) {
         let { viewer, hidden, baseColor } = params;
         const scene = viewer === null || viewer === void 0 ? void 0 : viewer.scene;
@@ -14731,8 +14816,8 @@ async function createTileset(url, props, noMemoryLimit) {
     const defaultProps = {
         // "Optimization option. Reduce the screen space error for tiles that are further away from the camera.".
         dynamicScreenSpaceError: true,
-        environmentMapOptions: ViewUtils.DefaultEnvironmentMapOptions()
     };
+    Object.assign(defaultProps, ViewUtils.DefaultLightingProps());
     if (noMemoryLimit != true) {
         // "The maximum amount of memory in MB that can be used by the tileset.".
         defaultProps.maximumMemoryUsage = 512;
@@ -21469,7 +21554,7 @@ var TilesetGooglePhotosRenderManager;
                             }
                             this.cTileset = await CESIUM.Cesium3DTileset.fromUrl(proxyRootUrl, {
                                 showCreditsOnScreen: true,
-                                environmentMapOptions: ViewUtils.DefaultEnvironmentMapOptions()
+                                ...ViewUtils.DefaultLightingProps()
                             });
                         }
                         else {
@@ -23013,7 +23098,7 @@ var AssemblyRenderManager;
                     const cEntity = this.viewer.entities.add({
                         model: {
                             uri: lod["ClientFile"].URL,
-                            environmentMapOptions: ViewUtils.DefaultEnvironmentMapOptions(),
+                            ...ViewUtils.DefaultLightingProps(),
                             heightReference: HeightReference.NONE
                         },
                         // point: {
@@ -38768,7 +38853,7 @@ var EntityRenderEngineModel3d;
                 id: ObjectUtils.UId(15),
                 model: {
                     uri: params.lodUrl,
-                    environmentMapOptions: ViewUtils.DefaultEnvironmentMapOptions(),
+                    ...ViewUtils.DefaultLightingProps(),
                     heightReference: heightRef,
                     scale: new CallbackProperty(() => scale * styleScale, true),
                     shadows: ShadowMode.ENABLED,
@@ -39411,7 +39496,7 @@ async function getModelEntity(url, scale) {
             url: url,
             asynchronous: true,
             scale: scale,
-            environmentMapOptions: ViewUtils.DefaultEnvironmentMapOptions()
+            ...ViewUtils.DefaultLightingProps()
         });
     }
     // Older versions of Cesium have a fromGltf method.
@@ -43573,7 +43658,7 @@ var StyleUtils;
     StyleUtils.ApplyTypeStyle = ApplyTypeStyle;
 })(StyleUtils || (StyleUtils = {}));
 
-const VERSION = "7.1.9";
+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.
@@ -43590,5 +43675,5 @@ const getENVIRONMENT = () => {
     return ENVIRONMENT;
 };
 
-export { VERSION, setENVIRONMENT, getENVIRONMENT, CesiumAnimatedInOut, DisplacedSurfacePrimitive, CesiumAnimatedProperty, isStyleChanged, isOutlineChanged$1 as isOutlineChanged, StyleEffective, EntityRenderEngine, EntityRenderEngineModel3d, EntityRenderEnginePoint, EntityRenderEnginePolygon, EntityRenderEnginePolyline, MenuItemCreator, MenuItemManager, CesiumParabola, EntityLabel, LiveCursor, SharedGetters, DataSourceStaticKmlManager, DataLabRenderManager, EntitiesIdsRenderManager, EntitiesLoadedRenderManager, EntitiesRenderManager, EntityRenderManager, AssemblyRenderManager, GoogleSearchRenderManager, RelationsRenderManager, RenderManager, TilesetArbRenderManager, TilesetCadRenderManager, TilesetEntitiesRenderManager, TilesetGooglePhotosRenderManager, TilesetOsmRenderManager, TilesetPointcloudRenderManager, TileRenderEngine, createTileset, TilesetRenderEngine, ViewRenderEngine, VisualRegisterCuller, VisualsRegister, XGridsRenderEngine, CesiumEntityStyler, DrawingUtils, EntityUtils, MeasureUtils, StyleUtils, CESIUM_INSPECTOR_KEY, CESIUM_TIMELINE_KEY, CESIUM_TIMELINE_LIVE_KEY, CESIUM_TIMELINE_LIVE_PADDING_KEY, CESIUM_TIMELINE_INTERVAL_KEY, CESIUM_MODEL_SPACE_KEY, DEFAULT_LIVE_PADDING_SECONDS, DEFAULT_BRIGHTNESS_SHIFT, DEFAULT_LIGHT_INTENSITY, LIGHTING_SETTINGS_VERSION, ViewUtils, CesiumViewMonitor, ViewGroundArea, ViewerEventTracker, ViewerUtils, Draw3dPolygon, Draw3dPolyline, MeasureCreator, Walkthrough, WidgetControlViewBar, WidgetControlViewBarSearch, WidgetLeftPanelTab, WidgetLeftPanelTabBookmarks, WidgetLeftPanelTabDashboard, EMenuItemState, WidgetLeftPanelTabMenuItems, Widget, VIEWER_BOOKMARKS_WIDGET_KEY, WidgetBookmarks, WidgetBranding, WidgetCursorBar, WidgetEmbeddedInfoView, WidgetInfoView, VIEWER_LEFT_PANEL_WIDGET_KEY, VIEWER_LEFT_PANEL_CSS_VAR_LEFT, WidgetLeftPanel, WidgetNavCompass$$1 as WidgetNavCompass, VIEWER_VIEW_BAR_WIDGET_KEY, WidgetViewBar };
+export { VERSION, setENVIRONMENT, getENVIRONMENT, CesiumAnimatedInOut, DisplacedSurfacePrimitive, CesiumAnimatedProperty, isStyleChanged, isOutlineChanged$1 as isOutlineChanged, StyleEffective, EntityRenderEngine, EntityRenderEngineModel3d, EntityRenderEnginePoint, EntityRenderEnginePolygon, EntityRenderEnginePolyline, MenuItemCreator, MenuItemManager, CesiumParabola, EntityLabel, LiveCursor, SharedGetters, DataSourceStaticKmlManager, DataLabRenderManager, EntitiesIdsRenderManager, EntitiesLoadedRenderManager, EntitiesRenderManager, EntityRenderManager, AssemblyRenderManager, GoogleSearchRenderManager, RelationsRenderManager, RenderManager, TilesetArbRenderManager, TilesetCadRenderManager, TilesetEntitiesRenderManager, TilesetGooglePhotosRenderManager, TilesetOsmRenderManager, TilesetPointcloudRenderManager, TileRenderEngine, createTileset, TilesetRenderEngine, ViewRenderEngine, VisualRegisterCuller, VisualsRegister, XGridsRenderEngine, CesiumEntityStyler, DrawingUtils, EntityUtils, MeasureUtils, StyleUtils, CESIUM_INSPECTOR_KEY, CESIUM_TIMELINE_KEY, CESIUM_TIMELINE_LIVE_KEY, CESIUM_TIMELINE_LIVE_PADDING_KEY, CESIUM_TIMELINE_INTERVAL_KEY, CESIUM_MODEL_SPACE_KEY, DEFAULT_LIVE_PADDING_SECONDS, DEFAULT_BRIGHTNESS_SHIFT, DEFAULT_LIGHT_INTENSITY, LIGHTING_SETTINGS_VERSION, LIGHT_INTENSITY_COMPENSATION, MAX_COMPENSATED_LIGHT_INTENSITY, ViewUtils, CesiumViewMonitor, ViewGroundArea, ViewerEventTracker, ViewerUtils, Draw3dPolygon, Draw3dPolyline, MeasureCreator, Walkthrough, WidgetControlViewBar, WidgetControlViewBarSearch, WidgetLeftPanelTab, WidgetLeftPanelTabBookmarks, WidgetLeftPanelTabDashboard, EMenuItemState, WidgetLeftPanelTabMenuItems, Widget, VIEWER_BOOKMARKS_WIDGET_KEY, WidgetBookmarks, WidgetBranding, WidgetCursorBar, WidgetEmbeddedInfoView, WidgetInfoView, VIEWER_LEFT_PANEL_WIDGET_KEY, VIEWER_LEFT_PANEL_CSS_VAR_LEFT, WidgetLeftPanel, WidgetNavCompass$$1 as WidgetNavCompass, VIEWER_VIEW_BAR_WIDGET_KEY, WidgetViewBar };
 //# sourceMappingURL=bruce-cesium.es5.js.map