bruce-cesium 4.8.7 → 4.8.9

package/dist/bruce-cesium.es5.js

@@ -1,6 +1,6 @@
-import { BruceEvent, Cartes, Entity as Entity$1, Carto, Geometry, MathUtils, LRUCache, Api, Calculator, ClientFile, EntityTag, EntityType, ObjectUtils, Style, ProjectViewTile, DelayQueue, EntityLod, Bounds, ZoomControl, EntityRelationType, ENVIRONMENT, EntityHistoricData, Tileset, EntityCoords, DataLab, EntitySource, MenuItem, EntityRelation, ProgramKey, ProjectView, ProjectViewBookmark, Camera, ProjectViewLegacyTile, AbstractApi, Session, EntityAttribute, EntityAttachment, EntityAttachmentType } from 'bruce-models';
+import { BruceEvent, Cartes, Entity as Entity$1, Carto, Geometry, MathUtils, LRUCache, Api, Calculator, ClientFile, EntityTag, EntityType, ObjectUtils, Style, ProjectViewTile, DelayQueue, EntityLod, Bounds, ZoomControl, EntityRelationType, ENVIRONMENT, EntityHistoricData, Tileset, EntityCoords, DataLab, EntitySource, MenuItem, EntityRelation, ProgramKey, ProjectView, ProjectViewBookmark, Camera, ProjectViewLegacyTile, EntityAttribute, EntityAttachment, EntityAttachmentType, AbstractApi, Session } from 'bruce-models';
 import * as Cesium from 'cesium';
-import { Cartographic, Cartesian2, Math as Math$1, Cartesian3, CallbackProperty, Color, HeightReference, Rectangle, JulianDate, Entity, DistanceDisplayCondition, ClassificationType, ArcType, CornerType, ShadowMode, ConstantProperty, ConstantPositionProperty, ColorBlendMode, HeadingPitchRoll, Transforms, Model, PolygonHierarchy, PolylineGraphics, ColorMaterialProperty, HorizontalOrigin, VerticalOrigin, SceneMode, Primitive, Cesium3DTileFeature, GeoJsonDataSource, Cesium3DTileColorBlendMode, HeadingPitchRange, Cesium3DTileStyle, Ion, KmlDataSource, SceneTransforms, OrthographicFrustum, EasingFunction, NearFarScalar, EllipsoidTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, IonImageryProvider, CesiumTerrainProvider, CesiumInspector, defined, ClockRange, Cesium3DTileset, Matrix4, Matrix3, IonResource, EllipsoidGeodesic, sampleTerrainMostDetailed, PolygonPipeline, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, BoundingSphere, GeometryInstance, Quaternion, ScreenSpaceEventHandler, ScreenSpaceEventType, CzmlDataSource, Intersect, Fullscreen } from 'cesium';
+import { Cartographic, Cartesian2, Math as Math$1, Cartesian3, CallbackProperty, Color, HeightReference, Rectangle, JulianDate, Entity, DistanceDisplayCondition, ClassificationType, ArcType, CornerType, ShadowMode, ConstantProperty, ConstantPositionProperty, ColorBlendMode, HeadingPitchRoll, Transforms, Model, HorizontalOrigin, VerticalOrigin, PolygonHierarchy, PolylineGraphics, ColorMaterialProperty, SceneMode, GeoJsonDataSource, Primitive, Cesium3DTileFeature, Cesium3DTileColorBlendMode, HeadingPitchRange, Cesium3DTileStyle, Ion, KmlDataSource, SceneTransforms, OrthographicFrustum, EasingFunction, NearFarScalar, EllipsoidTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, IonImageryProvider, CesiumTerrainProvider, Cesium3DTileset, Matrix4, Matrix3, IonResource, CesiumInspector, defined, ClockRange, PolygonPipeline, EllipsoidGeodesic, sampleTerrainMostDetailed, BoundingSphere, GeometryInstance, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, ScreenSpaceEventHandler, ScreenSpaceEventType, Quaternion, CzmlDataSource, Intersect, Fullscreen } from 'cesium';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation. All rights reserved.
@@ -10322,11 +10322,18 @@ var VisualsRegister;
     var Register = /** @class */ (function () {
         function Register(params) {
             this.id = ObjectUtils.UId();
+            this.disposed = false;
             this.rego = {};
             this.onUpdate = null;
             // Entity ID + Menu Item ID -> State.
             // If an Entity ID state is set without a Menu Item ID, then it acts as a default for all Menu Items.
             this.states = {};
+            // Queue of Entity updates to process in batches to avoid overloading the render loop.
+            this.updateQueue = [];
+            // Settings related to those Entities in the queue.
+            // This lets us modify the update without re-adding the item to the queue if it's already in it.
+            this.updateQueueSettings = {};
+            this.updateQueueInterval = null;
             this.viewer = params.viewer;
             this.apiGetters = params.apiGetters;
             this.cameraCullerDispose = VisualRegisterCuller.Monitor({
@@ -10340,6 +10347,13 @@ var VisualsRegister;
             enumerable: false,
             configurable: true
         });
+        Object.defineProperty(Register.prototype, "Disposed", {
+            get: function () {
+                return this.disposed;
+            },
+            enumerable: false,
+            configurable: true
+        });
         Object.defineProperty(Register.prototype, "Viewer", {
             get: function () {
                 return this.viewer;
@@ -10364,6 +10378,76 @@ var VisualsRegister;
             enumerable: false,
             configurable: true
         });
+        Register.prototype.queueUpdate = function (update) {
+            if (this.Disposed) {
+                return;
+            }
+            // Merge settings from existing queued item.
+            var settings = this.updateQueueSettings[update.entityId];
+            if (settings !== true) {
+                if (update.refresh === true) {
+                    settings = true;
+                }
+                else if (update.refresh === false) {
+                    if (!settings) {
+                        settings = false;
+                    }
+                }
+                else {
+                    if (!settings) {
+                        settings = {};
+                    }
+                    if (update.refresh.highlighted) {
+                        settings.highlighted = true;
+                    }
+                    if (update.refresh.selected) {
+                        settings.selected = true;
+                    }
+                    if (update.refresh.opacity) {
+                        settings.opacity = true;
+                    }
+                }
+            }
+            this.updateQueueSettings[update.entityId] = settings;
+            // Queue ID if it's not already in the queue.
+            if (!this.updateQueue.includes(update.entityId)) {
+                this.updateQueue.push(update.entityId);
+                this.pingUpdateQueue();
+            }
+        };
+        Register.prototype.pingUpdateQueue = function () {
+            var _this = this;
+            if (this.updateQueueInterval) {
+                return;
+            }
+            var BATCH_SIZE = 300;
+            if (this.updateQueue.length) {
+                this.updateQueueInterval = setInterval(function () {
+                    if (_this.Disposed || (!_this.viewer || !_this.viewer.scene || _this.viewer.isDestroyed())) {
+                        clearInterval(_this.updateQueueInterval);
+                        _this.updateQueueInterval = null;
+                        return;
+                    }
+                    var batch = _this.updateQueue.splice(0, BATCH_SIZE);
+                    var cache = {};
+                    for (var i = 0; i < batch.length; i++) {
+                        var entityId = batch[i];
+                        // Check if still registered.
+                        if (!_this.rego[entityId] || !_this.rego[entityId].length) {
+                            continue;
+                        }
+                        updateEntity(_this.viewer, entityId, _this, _this.updateQueueSettings[entityId] == null ? false : _this.updateQueueSettings[entityId], cache);
+                        _this.updateQueueSettings[entityId] = null;
+                        delete _this.updateQueueSettings[entityId];
+                    }
+                    _this.viewer.scene.requestRender();
+                    if (!_this.updateQueue.length) {
+                        clearInterval(_this.updateQueueInterval);
+                        _this.updateQueueInterval = null;
+                    }
+                }, 10);
+            }
+        };
         /**
          * Returns the applied visual state for a given Entity ID.
          * This is a combination of a Menu Item specific state and a general state.
@@ -10428,13 +10512,10 @@ var VisualsRegister;
                     });
                 }
                 else {
-                    var cache = {};
-                    var regos = this.GetRegos({
-                        entityId: state.entityId
+                    this.queueUpdate({
+                        entityId: state.entityId,
+                        refresh: refresh
                     });
-                    for (var i = 0; i < regos.length; i++) {
-                        updateEntity(this.viewer, state.entityId, this, refresh, cache);
-                    }
                 }
                 // Trigger update event.
                 if (this.onUpdate) {
@@ -10503,15 +10584,16 @@ var VisualsRegister;
             if (changed) {
                 if (updateAll) {
                     this.updateAllEntities({
-                        refresh: refresh
+                        refresh: __assign({}, refresh)
                     });
                 }
                 else {
-                    var cache = {};
                     for (var i = 0; i < entityIds.length; i++) {
-                        updateEntity(this.viewer, entityIds[i], this, refresh, cache);
+                        this.queueUpdate({
+                            entityId: entityIds[i],
+                            refresh: __assign({}, refresh)
+                        });
                     }
-                    this.viewer.scene.requestRender();
                 }
                 // Trigger update event.
                 if (this.onUpdate) {
@@ -10603,8 +10685,41 @@ var VisualsRegister;
          * Returns all visual state settings.
          * This is typically used for saving.
          */
-        Register.prototype.GetStates = function () {
-            return this.states;
+        Register.prototype.GetStates = function (params) {
+            if (!(params === null || params === void 0 ? void 0 : params.optimized)) {
+                return this.states;
+            }
+            var newStates = {};
+            var keys = Object.keys(this.states);
+            for (var i = 0; i < keys.length; i++) {
+                var key = keys[i];
+                var state = this.states[key];
+                // Dereference.
+                state = __assign({}, state);
+                if (state.opacity === 1) {
+                    delete state.opacity;
+                }
+                if (state.hidden === false) {
+                    delete state.hidden;
+                }
+                if (state.highlighted === false) {
+                    delete state.highlighted;
+                }
+                if (state.selected === false) {
+                    delete state.selected;
+                }
+                if (state.labelled === false) {
+                    delete state.labelled;
+                }
+                if (state.isolated === false) {
+                    delete state.isolated;
+                }
+                if (isBlankState(state)) {
+                    continue;
+                }
+                newStates[key] = state;
+            }
+            return newStates;
         };
         /**
          * Applies a set of new states to override the existing ones.
@@ -10710,22 +10825,24 @@ var VisualsRegister;
                 uncull: false
             });
             this.cameraCullerDispose = null;
+            clearInterval(this.updateQueueInterval);
+            this.updateQueueInterval = null;
+            this.disposed = true;
         };
         Register.prototype.ForceUpdate = function (params) {
             var _a;
             var entityIds = params.entityIds, requestRender = params.requestRender, refreshColors = params.refreshColors;
-            var cache = {};
             for (var i = 0; i < entityIds.length; i++) {
                 var entityId = entityIds[i];
-                updateEntity(this.viewer, entityId, this, true, cache);
+                this.queueUpdate({
+                    entityId: entityId,
+                    refresh: true
+                });
                 (_a = this.onUpdate) === null || _a === void 0 ? void 0 : _a.Trigger({
                     type: EVisualUpdateType.Update,
                     entityId: entityId
                 });
             }
-            if (requestRender != false) {
-                this.viewer.scene.requestRender();
-            }
         };
         /**
          * Marks given entityIds as either labelled or not labelled.
@@ -10734,7 +10851,6 @@ var VisualsRegister;
          */
         Register.prototype.SetLabelled = function (params) {
             var labelled = params.labelled, entityIds = params.entityIds, requestRender = params.requestRender, menuItemId = params.menuItemId;
-            var cache = {};
             for (var i = 0; i < entityIds.length; i++) {
                 var id = entityIds[i];
                 var state = this.GetState({
@@ -10749,12 +10865,12 @@ var VisualsRegister;
                     labelled: labelled ? true : null
                 });
                 if (doLabel) {
-                    updateEntity(this.viewer, id, this, false, cache);
+                    this.queueUpdate({
+                        entityId: id,
+                        refresh: false
+                    });
                 }
             }
-            if (requestRender != false) {
-                this.viewer.scene.requestRender();
-            }
         };
         /**
          * Returns if given entity id is labelled.
@@ -10773,7 +10889,6 @@ var VisualsRegister;
          * @param params
          */
         Register.prototype.ClearLabelled = function (params) {
-            var cache = {};
             var toUpdateIds = [];
             this.ForEachState(function (state) {
                 if (state.labelled == null || state.labelled === undefined) {
@@ -10786,10 +10901,10 @@ var VisualsRegister;
             });
             for (var i = 0; i < toUpdateIds.length; i++) {
                 var id = toUpdateIds[i];
-                updateEntity(this.viewer, id, this, false, cache);
-            }
-            if ((params === null || params === void 0 ? void 0 : params.requestRender) != false) {
-                this.viewer.scene.requestRender();
+                this.queueUpdate({
+                    entityId: id,
+                    refresh: false
+                });
             }
         };
         /**
@@ -11208,7 +11323,10 @@ var VisualsRegister;
             markEntity(this, rego, rego.visual, false);
             // Run any updates on the visual based on the calculated state.
             // Eg: visibility, opacity, selection, etc.
-            updateEntity(this.viewer, entityId, this, true);
+            this.queueUpdate({
+                entityId: entityId,
+                refresh: true
+            });
             (_b = this.onUpdate) === null || _b === void 0 ? void 0 : _b.Trigger({
                 rego: rego,
                 type: EVisualUpdateType.Add,
@@ -11297,7 +11415,6 @@ var VisualsRegister;
             if (retainTagIds == null || retainTagIds === undefined) {
                 retainTagIds = [];
             }
-            var cache = {};
             // TODO: refactor.
             // Currently this was made by merging two functions.
             if (menuItemId && !entityId) {
@@ -11330,7 +11447,10 @@ var VisualsRegister;
                             rego: rego
                         });
                         if (doesInclude) {
-                            updateEntity(this.viewer, entityId_4, this, false, cache);
+                            this.queueUpdate({
+                                entityId: entityId_4,
+                                refresh: false
+                            });
                         }
                     }
                 }
@@ -11361,7 +11481,10 @@ var VisualsRegister;
                     });
                     this_1.rego[entityId] = entityRegos.filter(function (r) { return r.menuItemId !== menuItemId_2; });
                     if (doUpdate && menuItemId_2) {
-                        updateEntity(this_1.viewer, entityId, this_1, false, cache);
+                        this_1.queueUpdate({
+                            entityId: entityId,
+                            refresh: false
+                        });
                     }
                 };
                 var this_1 = this;
@@ -11392,14 +11515,14 @@ var VisualsRegister;
                             rego: rego
                         });
                         if (doUpdate && menuItemId) {
-                            updateEntity(this.viewer, entityId_5, this, false, cache);
+                            this.queueUpdate({
+                                entityId: entityId_5,
+                                refresh: false
+                            });
                         }
                     }
                 }
             }
-            if (requestRender != false) {
-                this.viewer.scene.requestRender();
-            }
         };
         /**
          * Returns an array of drilled visuals associated with this register.
@@ -11469,16 +11592,15 @@ var VisualsRegister;
             }
         };
         Register.prototype.updateAllEntities = function (params) {
-            var cache = {};
             for (var entityId in this.rego) {
                 var regos = this.rego[entityId];
                 if (regos && regos.length) {
-                    updateEntity(this.viewer, entityId, this, (params === null || params === void 0 ? void 0 : params.refresh) == null ? true : params.refresh, cache);
+                    this.queueUpdate({
+                        entityId: entityId,
+                        refresh: (params === null || params === void 0 ? void 0 : params.refresh) == null ? true : params.refresh
+                    });
                 }
             }
-            if ((params === null || params === void 0 ? void 0 : params.requestRender) != false) {
-                this.viewer.scene.requestRender();
-            }
         };
         /**
          * Sets opacity for given set of entities.
@@ -11490,54 +11612,22 @@ var VisualsRegister;
             var opacity = params.opacity, entityIds = params.entityIds, menuItemId = params.menuItemId, requestRender = params.requestRender;
             for (var _i = 0, entityIds_2 = entityIds; _i < entityIds_2.length; _i++) {
                 var entityId = entityIds_2[_i];
-                if (!menuItemId) {
-                    this.setStateValues({
-                        entityId: entityId,
-                        // Null means it will be deleted from the object.
-                        opacity: opacity == 1 ? null : opacity
-                    });
-                }
-                var regos = this.rego[entityId];
-                if (regos && regos.length) {
-                    for (var _b = 0, regos_2 = regos; _b < regos_2.length; _b++) {
-                        var rego = regos_2[_b];
-                        if (rego.visual &&
-                            (!menuItemId || menuItemId.includes(rego.menuItemId))) {
-                            if (menuItemId) {
-                                this.setStateValues({
-                                    entityId: entityId,
-                                    menuItemId: menuItemId,
-                                    // Null means it will be deleted from the object.
-                                    opacity: opacity == 1 ? null : opacity
-                                });
-                            }
-                            if (opacity == 1 || opacity == null) {
-                                EntityUtils.RevertOpacity({
-                                    entity: rego.visual,
-                                    viewer: this.viewer,
-                                    requestRender: false
-                                });
-                            }
-                            else {
-                                EntityUtils.SetOpacity({
-                                    entity: rego.visual,
-                                    opacity: opacity,
-                                    viewer: this.viewer,
-                                    requestRender: false
-                                });
-                            }
-                            (_a = this.onUpdate) === null || _a === void 0 ? void 0 : _a.Trigger({
-                                rego: rego,
-                                type: EVisualUpdateType.Update,
-                                entityId: rego.entityId,
-                                opacity: opacity
-                            });
-                        }
+                this.setStateValues({
+                    entityId: entityId,
+                    menuItemId: menuItemId,
+                    opacity: opacity
+                });
+                (_a = this.onUpdate) === null || _a === void 0 ? void 0 : _a.Trigger({
+                    type: EVisualUpdateType.Update,
+                    entityId: entityId,
+                    opacity: opacity
+                });
+                this.queueUpdate({
+                    entityId: entityId,
+                    refresh: {
+                        opacity: true
                     }
-                }
-            }
-            if (requestRender != false) {
-                this.viewer.scene.requestRender();
+                });
             }
         };
         /**
@@ -11579,32 +11669,19 @@ var VisualsRegister;
         };
         Register.prototype.ClearOpacity = function (params) {
             var _this = this;
-            var changed = false;
-            var cleared = [];
+            var clearedIds = [];
             this.ForEachState(function (state, key) {
-                var regos = _this.rego[state.entityId];
-                if (regos && regos.length) {
-                    for (var _i = 0, regos_3 = regos; _i < regos_3.length; _i++) {
-                        var rego = regos_3[_i];
-                        if (state.menuItemId && rego.menuItemId !== state.menuItemId) {
-                            continue;
+                if (!clearedIds.includes(state.entityId) && state.opacity != null) {
+                    _this.queueUpdate({
+                        entityId: state.entityId,
+                        refresh: {
+                            opacity: true
                         }
-                        if ((rego === null || rego === void 0 ? void 0 : rego.visual) && !cleared.includes(rego)) {
-                            EntityUtils.RevertOpacity({
-                                entity: rego.visual,
-                                viewer: _this.viewer,
-                                requestRender: false
-                            });
-                            changed = true;
-                            cleared.push(rego);
-                        }
-                    }
+                    });
+                    clearedIds.push(state.entityId);
                 }
                 delete state.opacity;
             });
-            if ((params === null || params === void 0 ? void 0 : params.requestRender) != false && changed) {
-                this.viewer.scene.requestRender();
-            }
         };
         /**
          * Returns a dictionary containing entityId -> opacity values.
@@ -29264,7 +29341,7 @@ var WidgetViewBar = /** @class */ (function (_super) {
     return WidgetViewBar;
 }(Widget.AWidget));
 
-var VERSION = "4.8.7";
+var VERSION = "4.8.9";
 
 export { VERSION, CesiumViewMonitor, ViewerUtils, ViewerEventTracker, MenuItemManager, EntityRenderEngine, EntityRenderEnginePoint, EntityRenderEnginePolyline, EntityRenderEnginePolygon, EntityRenderEngineModel3d, MenuItemCreator, VisualsRegister, RenderManager, EntitiesIdsRenderManager, DataLabRenderManager, EntitiesLoadedRenderManager, EntitiesRenderManager, EntityRenderManager, TilesetCadRenderManager, TilesetArbRenderManager, TilesetEntitiesRenderManager, TilesetOsmRenderManager, TilesetPointcloudRenderManager, TilesetGooglePhotosRenderManager, DataSourceStaticKmlManager, GoogleSearchRenderManager, RelationsRenderManager, SharedGetters, CesiumParabola, EntityLabel, ViewRenderEngine, TileRenderEngine, TilesetRenderEngine, CESIUM_INSPECTOR_KEY, CESIUM_TIMELINE_KEY, ViewUtils, DrawingUtils, MeasureUtils, EntityUtils, CesiumEntityStyler, CesiumAnimatedProperty, CesiumAnimatedInOut, Draw3dPolygon, Draw3dPolyline, MeasureCreator, Widget, VIEWER_BOOKMARKS_WIDGET_KEY, WidgetBookmarks, WidgetBranding, WidgetCursorBar, WidgetEmbeddedInfoView, WidgetInfoView, WidgetNavCompass$$1 as WidgetNavCompass, VIEWER_VIEW_BAR_WIDGET_KEY, WidgetViewBar, WidgetControlViewBar, WidgetControlViewBarSearch, VIEWER_LEFT_PANEL_WIDGET_KEY, VIEWER_LEFT_PANEL_CSS_VAR_LEFT, WidgetLeftPanel, WidgetLeftPanelTab, WidgetLeftPanelTabBookmarks };
 //# sourceMappingURL=bruce-cesium.es5.js.map