bruce-cesium 7.0.3 → 7.0.5

package/dist/bruce-cesium.es5.js

@@ -1,6 +1,6 @@
 import * as Cesium from 'cesium';
-import { Cartographic, Entity, DistanceDisplayCondition, ColorMaterialProperty, Color, Math as Math$1, Cartesian3, JulianDate, Quaternion, Transforms, HeadingPitchRoll, Matrix4, ClassificationType, ArcType, HeightReference, CornerType, ShadowMode, ConstantProperty, ConstantPositionProperty, CallbackProperty, HorizontalOrigin, VerticalOrigin, Primitive, Cesium3DTileFeature, ColorBlendMode, Model, ImageMaterialProperty, PolygonHierarchy, PolylineGraphics, Cartesian2, SceneTransforms, NearFarScalar, Matrix3, Rectangle, KmlDataSource, GeoJsonDataSource, SceneMode, Cesium3DTileStyle, HeadingPitchRange, Ion, IonResource, OrthographicFrustum, EasingFunction, Cesium3DTileColorBlendMode, EllipsoidTerrainProvider, IonImageryProvider, createWorldImagery, createWorldImageryAsync, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, CesiumTerrainProvider, Cesium3DTileset, EllipsoidGeodesic, sampleTerrainMostDetailed, defined, PolygonPipeline, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, CesiumInspector, ClockRange, BoundingSphere, GeometryInstance, ScreenSpaceEventHandler, ScreenSpaceEventType, CustomDataSource, Fullscreen, Intersect, CzmlDataSource } from 'cesium';
-import { Cartes, Entity as Entity$1, ENVIRONMENT, Calculator, Carto, EntityTag, EntityType, Geometry, ObjectUtils, Style, Api, ClientFile, LRUCache, EntityLod, MenuItem, ProjectView, ProjectViewBookmark, Tileset, ZoomControl, BruceEvent, EntityCoords, Bounds, Color as Color$1, DataLab, DelayQueue, EntityHistoricData, EntityRelation, AccountConcept, RecordChangeFeed, BruceApi, ProgramKey, EntitySource, Camera, ProjectViewTile, ProjectViewLegacyTile, Session, EntityAttachment, EntityAttachmentType, EntityAttribute, MathUtils, EntityRelationType } from 'bruce-models';
+import { Cartographic, ColorMaterialProperty, Entity, Color, ConstantProperty, CallbackProperty, Primitive, Cesium3DTileFeature, Math as Math$1, Cartesian3, JulianDate, Quaternion, Transforms, HeadingPitchRoll, Matrix4, DistanceDisplayCondition, HeightReference, HorizontalOrigin, VerticalOrigin, ClassificationType, ConstantPositionProperty, ImageMaterialProperty, PolygonHierarchy, ShadowMode, PolylineGraphics, ArcType, CornerType, ColorBlendMode, Model, SceneTransforms, NearFarScalar, Cartesian2, Matrix3, Rectangle, KmlDataSource, GeoJsonDataSource, SceneMode, Cesium3DTileStyle, HeadingPitchRange, Cesium3DTileColorBlendMode, Ion, IonResource, EllipsoidTerrainProvider, IonImageryProvider, createWorldImagery, createWorldImageryAsync, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, CesiumTerrainProvider, OrthographicFrustum, EasingFunction, Cesium3DTileset, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, EllipsoidGeodesic, sampleTerrainMostDetailed, defined, PolygonPipeline, CustomDataSource, BoundingSphere, GeometryInstance, CesiumInspector, ClockRange, ScreenSpaceEventHandler, ScreenSpaceEventType, Fullscreen, Intersect, CzmlDataSource } from 'cesium';
+import { Cartes, Entity as Entity$1, ENVIRONMENT, Api, Calculator, ClientFile, EntityTag, EntityType, LRUCache, ObjectUtils, Style, Bounds, Color as Color$1, Geometry, EntityLod, Carto, MenuItem, ProjectView, ProjectViewBookmark, Tileset, ZoomControl, BruceEvent, EntityCoords, DataLab, DelayQueue, EntityHistoricData, AccountConcept, RecordChangeFeed, EntityRelation, BruceApi, ProgramKey, EntitySource, ProjectViewLegacyTile, ProjectViewTile, Camera, EntityAttachment, EntityAttachmentType, EntityAttribute, MathUtils, Session, EntityRelationType } from 'bruce-models';
 
 /**
  * Ensures a number is returned from a given value.
@@ -6084,7 +6084,22 @@ function getValue$1(viewer, obj) {
     }
     return obj;
 }
+/*
+ * Cache identity for a terrain provider we cannot name, which is anything without our own metadata on it and not
+ * Cesium's own flat ellipsoid. Deliberately not FlatTerrain, see shouldCullEntity.
+ */
+const UNRECOGNISED_TERRAIN_ID = "unrecognised-terrain";
+// Keyed by entity id alone. A cached sphere is only as good as the geometry it was measured from, so anything
+// changing that geometry has to call InvalidateBounds, see it for why nothing can be inferred instead.
 const boundingSphereCache = new LRUCache(100000);
+/*
+ * Forgets what is known about an entity's extent, so the next check measures it again.
+ */
+function invalidateBounds(entityIds) {
+    for (let i = 0; i < entityIds.length; i++) {
+        boundingSphereCache.Delete(entityIds[i]);
+    }
+}
 function getPositionsFromEntity(viewer, entity) {
     let positions = [];
     let heightRef;
@@ -6201,10 +6216,11 @@ function shouldCullEntity(viewer, cEntity) {
     let boundingSphere;
     const terrainId = (_c = (_b = (_a = ViewUtils.GatherTerrainTile({
         viewer
-    })) === null || _a === void 0 ? void 0 : _a.terrain) === null || _b === void 0 ? void 0 : _b.tilesetId) !== null && _c !== void 0 ? _c : ProjectViewTile.EDefaultTerrain.FlatTerrain;
-    const cacheKey = terrainId + cEntity.id;
+    })) === null || _a === void 0 ? void 0 : _a.terrain) === null || _b === void 0 ? void 0 : _b.tilesetId) !== null && _c !== void 0 ? _c : UNRECOGNISED_TERRAIN_ID;
+    const cacheKey = cEntity.id;
     const cacheData = boundingSphereCache.Get(cacheKey);
-    if (cacheData) {
+    // A sphere measured under different terrain cannot be reused, since the height treatment differs.
+    if (cacheData && (cacheData == -1 || cacheData.terrainId == terrainId)) {
         boundingSphere = cacheData;
     }
     else {
@@ -6260,7 +6276,8 @@ function shouldCullEntity(viewer, cEntity) {
             }
             boundingSphere = {
                 heightRef: positions.heightRef,
-                sphere: sphere
+                sphere: sphere,
+                terrainId: terrainId
             };
             if (!doNotCache) {
                 boundingSphereCache.Set(cacheKey, boundingSphere);
@@ -6355,6 +6372,8 @@ function isCullingIgnored(viewer, rego) {
         rego.relation != null ||
         // Explicitly being either shown or hidden.
         rego.overrideShow != null ||
+        // Being dragged around right now, so its extent is changing faster than we could measure it.
+        rego.editing == true ||
         // Part of a collection we did not create, eg. a geojson data source, which may have its own rules for
         // what is in the scene. Our own per-menu-item data sources are fair game.
         (rego.collection && !IsCCollectionOwned(rego.collection)) ||
@@ -6643,6 +6662,38 @@ var VisualRegisterCuller;
         return isCullingIgnored(viewer, rego);
     }
     VisualRegisterCuller.IsCullingIgnored = IsCullingIgnored;
+    /**
+     * Discards what the culler knows about an entity's extent, so its next check measures the geometry again.
+     * @param visuals an entity, an entity id, or an array of either.
+     */
+    function InvalidateBounds(visuals) {
+        const list = Array.isArray(visuals) ? visuals : [visuals];
+        const ids = [];
+        for (let i = 0; i < list.length; i++) {
+            const item = list[i];
+            if (!item) {
+                continue;
+            }
+            if (typeof item == "string") {
+                ids.push(item);
+                continue;
+            }
+            const parts = EntityUtils.GatherEntity({
+                entity: item
+            });
+            for (let j = 0; j < parts.length; j++) {
+                const part = parts[j];
+                if (!(part instanceof Entity)) {
+                    continue;
+                }
+                ids.push(part.id);
+                // The per-entity answer is derived from the sphere, so it goes stale with it.
+                delete part[VisualRegisterCuller.VISUAL_CULL_KEY];
+            }
+        }
+        invalidateBounds(ids);
+    }
+    VisualRegisterCuller.InvalidateBounds = InvalidateBounds;
     function IsCulled(viewer, rego, visual) {
         if (isCullingIgnored(viewer, rego)) {
             return false;
@@ -8113,6 +8164,58 @@ var VisualsRegister;
                 CesiumEntityStyler.UpdateColorSetting("highlight", color);
             }
         }
+        /**
+         * Marks visuals as being actively edited, which exempts them from culling until it is turned back off.
+         */
+        SetEditing(params) {
+            var _a, _b;
+            const { entityIds, editing, menuItemId, requestRender } = params;
+            if (!(entityIds === null || entityIds === void 0 ? void 0 : entityIds.length)) {
+                return;
+            }
+            let changed = false;
+            for (let i = 0; i < entityIds.length; i++) {
+                const regos = this.rego[entityIds[i]];
+                if (!regos) {
+                    continue;
+                }
+                for (let j = 0; j < regos.length; j++) {
+                    const rego = regos[j];
+                    if (menuItemId && rego.menuItemId !== menuItemId) {
+                        continue;
+                    }
+                    if (Boolean(rego.editing) == Boolean(editing)) {
+                        continue;
+                    }
+                    // Null rather than false, so the rego does not carry a key for every visual ever edited.
+                    rego.editing = editing ? true : null;
+                    changed = true;
+                    if (editing) {
+                        const parts = EntityUtils.GatherEntity({
+                            entity: rego.visual
+                        });
+                        for (let k = 0; k < parts.length; k++) {
+                            const part = parts[k];
+                            if (!(part instanceof Entity)) {
+                                continue;
+                            }
+                            const wasCulled = part[VisualRegisterCuller.VISUAL_CULL_KEY];
+                            delete part[VisualRegisterCuller.VISUAL_CULL_KEY];
+                            if (wasCulled && !IsCEntityInScene(this.viewer, part)) {
+                                AddCEntityToScene(this.viewer, part, rego.collection);
+                            }
+                        }
+                    }
+                    else {
+                        // The geometry almost certainly moved, so what was measured before is worthless.
+                        VisualRegisterCuller.InvalidateBounds(rego.visual);
+                    }
+                }
+            }
+            if (changed && requestRender != false) {
+                (_b = (_a = this.viewer) === null || _a === void 0 ? void 0 : _a.scene) === null || _b === void 0 ? void 0 : _b.requestRender();
+            }
+        }
         SetSelected(params) {
             var _a;
             let { entityIds, selected, refreshIfSelected, requestRender, menuItemId, source } = params;
@@ -39542,6 +39645,7 @@ var EntityRenderEngine;
             if (bandCheck) {
                 cEntity._bandCheck = bandCheck;
             }
+            VisualRegisterCuller.InvalidateBounds(cEntity);
         });
         return {
             entities: cEntities,
@@ -40311,7 +40415,7 @@ var StyleUtils;
     StyleUtils.ApplyTypeStyle = ApplyTypeStyle;
 })(StyleUtils || (StyleUtils = {}));
 
-const VERSION = "7.0.3";
+const VERSION = "7.0.5";
 /**
  * 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.