bruce-cesium 2.0.0 → 2.0.2

package/dist/bruce-cesium.es5.js

@@ -1,6 +1,6 @@
-import { BruceEvent, Cartes, Carto, Entity as Entity$1, Geometry, Tileset, MathUtils, LRUCache, ZoomControl, Style, EntityTag, Calculator, EntityLod, EntityType, ClientFile, ObjectUtils, DelayQueue, BatchedDataGetter, EntityRelationType, EntityCoords, EntityFilterGetter, EntitySource, MenuItem, EntityRelation, ProjectView, ProjectViewBookmark, ProjectViewTile, ProjectViewLegacyTile, ProgramKey, Camera } from 'bruce-models';
+import { BruceEvent, Cartes, Carto, Entity as Entity$1, Geometry, Tileset, MathUtils, LRUCache, ZoomControl, Style, EntityTag, Calculator, EntityLod, EntityType, ClientFile, ObjectUtils, DelayQueue, BatchedDataGetter, EntityRelationType, EntityCoords, EntityFilterGetter, EntitySource, MenuItem, EntityRelation, ENVIRONMENT, ProjectView, ProjectViewBookmark, ProjectViewTile, ProjectViewLegacyTile, ProgramKey, Camera } from 'bruce-models';
 import * as Cesium from 'cesium';
-import { Cartesian2, Cartographic, CallbackProperty, Cartesian3, Color, Rectangle, Math as Math$1, HeightReference, Entity, HorizontalOrigin, VerticalOrigin, ClassificationType, ArcType, PolygonHierarchy, ShadowMode, PolylineGraphics, HeadingPitchRoll, Transforms, ColorBlendMode, SceneMode, Primitive, Cesium3DTileFeature, Cesium3DTileColorBlendMode, HeadingPitchRange, createOsmBuildings, Cesium3DTileStyle, KmlDataSource, createWorldTerrain, EllipsoidTerrainProvider, CesiumTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, UrlTemplateImageryProvider, TileMapServiceImageryProvider, IonImageryProvider, OrthographicFrustum, JulianDate, NearFarScalar, CesiumInspector, Cesium3DTileset, Matrix4, Matrix3, IonResource, PolygonPipeline, EllipsoidGeodesic, sampleTerrainMostDetailed, ColorMaterialProperty, EasingFunction, GeometryInstance } from 'cesium';
+import { Cartesian2, Cartographic, CallbackProperty, Cartesian3, Color, Rectangle, Math as Math$1, Entity, Primitive, Cesium3DTileFeature, SceneMode, HeightReference, HorizontalOrigin, VerticalOrigin, ClassificationType, ArcType, PolygonHierarchy, ShadowMode, PolylineGraphics, HeadingPitchRoll, Transforms, ColorBlendMode, HeadingPitchRange, Cesium3DTileColorBlendMode, createOsmBuildings, Cesium3DTileStyle, KmlDataSource, createWorldTerrain, EllipsoidTerrainProvider, CesiumTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, UrlTemplateImageryProvider, TileMapServiceImageryProvider, IonImageryProvider, CesiumInspector, EllipsoidGeodesic, sampleTerrainMostDetailed, PolygonPipeline, Cesium3DTileset, Matrix4, Matrix3, IonResource, ColorMaterialProperty, EasingFunction, GeometryInstance, JulianDate, OrthographicFrustum, NearFarScalar } from 'cesium';
 
 var TIME_LAG = 300;
 var POSITION_CHECK_TIMER = 950;
@@ -259,75 +259,6 @@ var CesiumViewMonitor = /** @class */ (function () {
     return CesiumViewMonitor;
 }());
 
-var ViewerUtils;
-(function (ViewerUtils) {
-    /**
-     * Destroys all the junk that cesium viewer ships with.
-     * @param viewer
-     */
-    function InitViewer(params) {
-        var viewer = params.viewer, destroyWidgets = params.destroyWidgets, styleContainer = params.styleContainer;
-        if (destroyWidgets != false) {
-            ViewerUtils.DestroyWidget(viewer.timeline);
-            ViewerUtils.DestroyWidget(viewer.vrButton);
-            ViewerUtils.DestroyWidget(viewer.sceneModePicker);
-            ViewerUtils.DestroyWidget(viewer.homeButton);
-            ViewerUtils.DestroyWidget(viewer.fullscreenButton);
-            ViewerUtils.DestroyWidget(viewer.baseLayerPicker);
-        }
-        if (styleContainer != false) {
-            ViewerUtils.StyleContainer({ viewer: viewer });
-        }
-    }
-    ViewerUtils.InitViewer = InitViewer;
-    function DestroyWidget(widget) {
-        if (widget && !widget.isDestroyed()) {
-            widget.destroy();
-        }
-    }
-    ViewerUtils.DestroyWidget = DestroyWidget;
-    /**
-     * Hides all unnecessary elements from the Cesium viewer container.
-     * @param viewer
-     */
-    function StyleContainer(params) {
-        var _a;
-        var viewer = params.viewer;
-        var container = viewer.container;
-        var genContainer = (_a = container.getElementsByClassName("cesium-viewer")) === null || _a === void 0 ? void 0 : _a[0];
-        if (genContainer) {
-            var children = genContainer.children;
-            for (var i = 0; i < children.length; i++) {
-                var child = children[i];
-                if (!child.classList.contains("cesium-viewer-cesiumWidgetContainer")) {
-                    child.style.display = "none";
-                }
-            }
-        }
-        var canvas = viewer.canvas;
-        canvas.style.width = "100%";
-        canvas.style.height = "100%";
-        var widget = canvas.parentElement;
-        widget.style.width = "100%";
-        widget.style.height = "100%";
-        widget.style.touchAction = "none";
-        var widgetContainer = widget.parentElement;
-        widgetContainer.style.width = "100%";
-        widgetContainer.style.height = "100%";
-        var viewerContainer = widgetContainer.parentElement;
-        viewerContainer.style.fontFamily = "sans-serif";
-        viewerContainer.style.fontSize = "16px";
-        viewerContainer.style.overflow = "hidden";
-        viewerContainer.style.display = "block";
-        viewerContainer.style.position = "relative";
-        viewerContainer.style.top = "0";
-        viewerContainer.style.left = "0";
-        viewerContainer.style.width = "100%";
-        viewerContainer.style.height = "100%";
-    }
-    ViewerUtils.StyleContainer = StyleContainer;
-})(ViewerUtils || (ViewerUtils = {}));
-
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation. All rights reserved.
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
@@ -2609,10 +2540,18 @@ var EntitiesRenderManager;
             clearInterval(this.renderQueueInterval);
             this.renderQueueInterval = null;
             this.renderQueue = [];
-            this.visualsManager.RemoveRegos({
-                menuItemId: this.item.id
-            });
-            if (!shouldRender) {
+            // Remove just the ones that shouldn't be rendered.
+            // Eg: for a tag menu item we can see what tags are selected and only render those.
+            if (shouldRender) {
+                this.visualsManager.RemoveRegos({
+                    menuItemId: this.item.id,
+                    retainTagIds: tagsToRender
+                });
+            }
+            else {
+                this.visualsManager.RemoveRegos({
+                    menuItemId: this.item.id
+                });
                 return;
             }
             var api = this.apiGetter.getApi();
@@ -4165,10 +4104,13 @@ var VisualsRegister;
          */
         Register.prototype.RemoveRegos = function (params) {
             var _a, _b, _c;
-            var entityId = params.entityId, menuItemId = params.menuItemId, doUpdate = params.doUpdate, relation = params.relation;
+            var entityId = params.entityId, menuItemId = params.menuItemId, doUpdate = params.doUpdate, relation = params.relation, retainTagIds = params.retainTagIds;
             if (doUpdate == null) {
                 doUpdate = true;
             }
+            if (retainTagIds == null) {
+                retainTagIds = [];
+            }
             // TODO: refactor.
             // Currently this was made by merging two functions.
             if (menuItemId && !entityId) {
@@ -4179,6 +4121,11 @@ var VisualsRegister;
                         if (!rego) {
                             continue;
                         }
+                        var regoTagIds = rego.tagIds ? rego.tagIds : [];
+                        var shouldRetain = regoTagIds.some(function (tagId) { return retainTagIds.includes(tagId); });
+                        if (shouldRetain) {
+                            continue;
+                        }
                         removeEntity(this.viewer, rego.visual);
                         var doesInclude = this.rego[entityId_3].find(function (r) { return r.menuItemId === menuItemId; });
                         if (doesInclude) {
@@ -7292,14 +7239,31 @@ var MenuItemManager;
          * @returns
          */
         Manager.prototype.RenderItem = function (params) {
-            var _a, _b, _c;
+            var _a, _b, _c, _d;
             if (this.viewer.isDestroyed()) {
                 return null;
             }
+            if (!params.apiGetter) {
+                params.apiGetter = ENVIRONMENT.GetGetters().GetBruceGetter();
+            }
             var rItem = this.items.find(function (x) { return x.id == params.item.id; });
-            if (!rItem) {
+            if (rItem) {
+                // This means we're updating a tag menu item.
+                // Tag menu items have alternative states based on bookmark settings.
+                // Eg: different tags that were enabled.
+                if (rItem.type == MenuItem.EType.Entities && params.item.Type == MenuItem.EType.Entities) {
+                    var eItem = rItem.item;
+                    if ((_a = eItem === null || eItem === void 0 ? void 0 : eItem.BruceEntity) === null || _a === void 0 ? void 0 : _a.ExpandLayers) {
+                        rItem.renderManager.Init({
+                            item: params.item,
+                        });
+                        rItem.item = params.item;
+                    }
+                }
+            }
+            else {
                 rItem = {
-                    id: (_a = params.item.id) !== null && _a !== void 0 ? _a : ObjectUtils.UId(),
+                    id: (_b = params.item.id) !== null && _b !== void 0 ? _b : ObjectUtils.UId(),
                     childIds: [],
                     item: params.item,
                     renderManager: null,
@@ -7434,8 +7398,8 @@ var MenuItemManager;
                     rItem.childIds.push(childId);
                 }
             }
-            if (!rItem.renderManager || !((_b = rItem.renderManager) === null || _b === void 0 ? void 0 : _b.Disposed)) {
-                (_c = this.onUpdate) === null || _c === void 0 ? void 0 : _c.Trigger({ isEnabling: true, itemId: rItem.id });
+            if (rItem.renderManager && !((_c = rItem.renderManager) === null || _c === void 0 ? void 0 : _c.Disposed)) {
+                (_d = this.onUpdate) === null || _d === void 0 ? void 0 : _d.Trigger({ isEnabling: true, itemId: rItem.id });
             }
             rItem.id;
         };
@@ -7533,6 +7497,95 @@ var MenuItemManager;
     MenuItemManager.Manager = Manager;
 })(MenuItemManager || (MenuItemManager = {}));
 
+var CESIUM_VIEWER_MANAGER_KEY = "_cesiumViewerManager";
+var ViewerUtils;
+(function (ViewerUtils) {
+    /**
+     * Destroys all the junk that cesium viewer ships with.
+     * @param viewer
+     */
+    function InitViewer(params) {
+        var viewer = params.viewer, destroyWidgets = params.destroyWidgets, styleContainer = params.styleContainer;
+        if (destroyWidgets != false) {
+            ViewerUtils.DestroyWidget(viewer.timeline);
+            ViewerUtils.DestroyWidget(viewer.vrButton);
+            ViewerUtils.DestroyWidget(viewer.sceneModePicker);
+            ViewerUtils.DestroyWidget(viewer.homeButton);
+            ViewerUtils.DestroyWidget(viewer.fullscreenButton);
+            ViewerUtils.DestroyWidget(viewer.baseLayerPicker);
+        }
+        if (styleContainer != false) {
+            ViewerUtils.StyleContainer({ viewer: viewer });
+        }
+    }
+    ViewerUtils.InitViewer = InitViewer;
+    function DestroyWidget(widget) {
+        if (widget && !widget.isDestroyed()) {
+            widget.destroy();
+        }
+    }
+    ViewerUtils.DestroyWidget = DestroyWidget;
+    /**
+     * Hides all unnecessary elements from the Cesium viewer container.
+     * @param viewer
+     */
+    function StyleContainer(params) {
+        var _a;
+        var viewer = params.viewer;
+        var container = viewer.container;
+        var genContainer = (_a = container.getElementsByClassName("cesium-viewer")) === null || _a === void 0 ? void 0 : _a[0];
+        if (genContainer) {
+            var children = genContainer.children;
+            for (var i = 0; i < children.length; i++) {
+                var child = children[i];
+                if (!child.classList.contains("cesium-viewer-cesiumWidgetContainer")) {
+                    child.style.display = "none";
+                }
+            }
+        }
+        var canvas = viewer.canvas;
+        canvas.style.width = "100%";
+        canvas.style.height = "100%";
+        var widget = canvas.parentElement;
+        widget.style.width = "100%";
+        widget.style.height = "100%";
+        widget.style.touchAction = "none";
+        var widgetContainer = widget.parentElement;
+        widgetContainer.style.width = "100%";
+        widgetContainer.style.height = "100%";
+        var viewerContainer = widgetContainer.parentElement;
+        viewerContainer.style.fontFamily = "sans-serif";
+        viewerContainer.style.fontSize = "16px";
+        viewerContainer.style.overflow = "hidden";
+        viewerContainer.style.display = "block";
+        viewerContainer.style.position = "relative";
+        viewerContainer.style.top = "0";
+        viewerContainer.style.left = "0";
+        viewerContainer.style.width = "100%";
+        viewerContainer.style.height = "100%";
+    }
+    ViewerUtils.StyleContainer = StyleContainer;
+    /**
+     * Returns a given Cesium viewer's menu item manager.
+     * If one is missing then it'll optionally create one before returning it.
+     * @param params
+     * @returns
+     */
+    function GetManager(params) {
+        var viewer = params.viewer, createIfMissing = params.createIfMissing;
+        if (viewer[CESIUM_VIEWER_MANAGER_KEY]) {
+            return viewer[CESIUM_VIEWER_MANAGER_KEY];
+        }
+        else if (createIfMissing != false) {
+            var manager = new MenuItemManager.Manager({ viewer: viewer });
+            viewer[CESIUM_VIEWER_MANAGER_KEY] = manager;
+            return manager;
+        }
+        return null;
+    }
+    ViewerUtils.GetManager = GetManager;
+})(ViewerUtils || (ViewerUtils = {}));
+
 /**
  * Utility to help generate menu items for rendering various data.
  */
@@ -7782,28 +7835,29 @@ var MenuItemCreator;
     }
     MenuItemCreator.RenderTileset = RenderTileset;
     function RenderBookmarkItems(params) {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var viewId, bookmarkId, api, view, _a, bookmark, _b, enabledIds, menuItems, version, vSettings, bSettings, vSettings, bSettings, renderedItemIds, traverseItems_1, i;
+            var viewId, bookmarkId, api, view, _b, bookmark, _c, enabledIds, menuItems, version, vSettings, bSettings, vSettings, bSettings, alternations, renderedItemIds, traverseItems_1, i;
             var _this = this;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         viewId = params.viewId, bookmarkId = params.bookmarkId;
                         api = params.apiGetter.getApi();
                         if (!params.view) return [3 /*break*/, 1];
-                        _a = params.view;
+                        _b = params.view;
                         return [3 /*break*/, 3];
                     case 1: return [4 /*yield*/, ProjectView.Get({
                             api: api,
                             viewId: viewId
                         })];
                     case 2:
-                        _a = (_c.sent()).view;
-                        _c.label = 3;
+                        _b = (_d.sent()).view;
+                        _d.label = 3;
                     case 3:
-                        view = _a;
+                        view = _b;
                         if (!params.bookmark) return [3 /*break*/, 4];
-                        _b = params.bookmark;
+                        _c = params.bookmark;
                         return [3 /*break*/, 6];
                     case 4: return [4 /*yield*/, ProjectViewBookmark.Get({
                             api: api,
@@ -7811,10 +7865,10 @@ var MenuItemCreator;
                             bookmarkId: bookmarkId
                         })];
                     case 5:
-                        _b = (_c.sent()).bookmark;
-                        _c.label = 6;
+                        _c = (_d.sent()).bookmark;
+                        _d.label = 6;
                     case 6:
-                        bookmark = _b;
+                        bookmark = _c;
                         if (view.DataVersion != bookmark.DataVersion) {
                             throw new Error("View and bookmark settings version mismatch.");
                         }
@@ -7835,32 +7889,48 @@ var MenuItemCreator;
                                 enabledIds = bSettings.selectedItemIds;
                             }
                         }
+                        alternations = (_a = bookmark.Settings) === null || _a === void 0 ? void 0 : _a.menuItemAlternations;
+                        if (!alternations) {
+                            alternations = {};
+                        }
                         renderedItemIds = [];
                         if (!((menuItems === null || menuItems === void 0 ? void 0 : menuItems.length) && (enabledIds === null || enabledIds === void 0 ? void 0 : enabledIds.length))) return [3 /*break*/, 10];
                         traverseItems_1 = function (item) { return __awaiter(_this, void 0, void 0, function () {
-                            var itemId, i;
-                            return __generator(this, function (_a) {
-                                switch (_a.label) {
+                            var eItem, eItemAlt, itemId, i;
+                            var _a;
+                            return __generator(this, function (_b) {
+                                switch (_b.label) {
                                     case 0:
+                                        if (alternations[item.id]) {
+                                            // The only alternation we support right now is tag menu item ones.
+                                            // The project view menu item contains the instruction to enable tags, the bookmark specifies which ones.
+                                            if (item.Type == MenuItem.EType.Entities) {
+                                                eItem = item;
+                                                if (eItem.BruceEntity.ExpandLayers) {
+                                                    eItemAlt = alternations[item.id];
+                                                    eItem.BruceEntity = __assign(__assign({}, eItem.BruceEntity), { SelectedExpandLayers: (_a = eItemAlt.BruceEntity) === null || _a === void 0 ? void 0 : _a.SelectedExpandLayers });
+                                                }
+                                            }
+                                        }
                                         if (!enabledIds.includes(item.id)) return [3 /*break*/, 2];
                                         return [4 /*yield*/, params.manager.RenderItem({
                                                 item: item,
                                                 apiGetter: params.apiGetter
                                             })];
                                     case 1:
-                                        itemId = _a.sent();
+                                        itemId = _b.sent();
                                         renderedItemIds.push(itemId);
-                                        _a.label = 2;
+                                        _b.label = 2;
                                     case 2:
                                         if (!item.Children) return [3 /*break*/, 6];
                                         i = 0;
-                                        _a.label = 3;
+                                        _b.label = 3;
                                     case 3:
                                         if (!(i < item.Children.length)) return [3 /*break*/, 6];
                                         return [4 /*yield*/, traverseItems_1(item.Children[i])];
                                     case 4:
-                                        _a.sent();
-                                        _a.label = 5;
+                                        _b.sent();
+                                        _b.label = 5;
                                     case 5:
                                         i++;
                                         return [3 /*break*/, 3];
@@ -7869,13 +7939,13 @@ var MenuItemCreator;
                             });
                         }); };
                         i = 0;
-                        _c.label = 7;
+                        _d.label = 7;
                     case 7:
                         if (!(i < menuItems.length)) return [3 /*break*/, 10];
                         return [4 /*yield*/, traverseItems_1(menuItems[i])];
                     case 8:
-                        _c.sent();
-                        _c.label = 9;
+                        _d.sent();
+                        _d.label = 9;
                     case 9:
                         i++;
                         return [3 /*break*/, 7];
@@ -9540,6 +9610,18 @@ var ViewRenderEngine;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
+                        if (!params.manager && params.viewer) {
+                            params.manager = ViewerUtils.GetManager({
+                                viewer: params.viewer,
+                                createIfMissing: true
+                            });
+                        }
+                        else if (!params.viewer && params.manager) {
+                            params.viewer = params.manager.Viewer;
+                        }
+                        if (!params.apiGetter) {
+                            params.apiGetter = ENVIRONMENT.GetGetters().GetBruceGetter();
+                        }
                         api = params.apiGetter.getApi();
                         if (!params.view) return [3 /*break*/, 1];
                         _a = params.view;