bruce-cesium 2.1.4 → 2.1.5

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, 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, SceneMode, HeightReference, Entity, HorizontalOrigin, VerticalOrigin, ClassificationType, ArcType, PolygonHierarchy, ShadowMode, PolylineGraphics, HeadingPitchRoll, Transforms, ColorBlendMode, Primitive, Cesium3DTileFeature, Cesium3DTileColorBlendMode, HeadingPitchRange, createOsmBuildings, Cesium3DTileStyle, KmlDataSource, OrthographicFrustum, JulianDate, NearFarScalar, Cesium3DTileset, Matrix4, Matrix3, IonResource, CesiumInspector, createWorldTerrain, EllipsoidTerrainProvider, CesiumTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, UrlTemplateImageryProvider, TileMapServiceImageryProvider, IonImageryProvider, PolygonPipeline, ColorMaterialProperty, EasingFunction, GeometryInstance, EllipsoidGeodesic, sampleTerrainMostDetailed } from 'cesium';
+import { Cartesian2, Cartographic, CallbackProperty, Cartesian3, Color, Rectangle, Math as Math$1, SceneMode, Entity, Primitive, Cesium3DTileFeature, HeightReference, HorizontalOrigin, VerticalOrigin, ClassificationType, ArcType, PolygonHierarchy, ShadowMode, PolylineGraphics, HeadingPitchRoll, Transforms, ColorBlendMode, Cesium3DTileColorBlendMode, HeadingPitchRange, createOsmBuildings, Cesium3DTileStyle, KmlDataSource, OrthographicFrustum, JulianDate, NearFarScalar, EllipsoidGeodesic, EllipsoidTerrainProvider, sampleTerrainMostDetailed, CesiumInspector, PolygonPipeline, createWorldTerrain, CesiumTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, UrlTemplateImageryProvider, TileMapServiceImageryProvider, IonImageryProvider, Cesium3DTileset, Matrix4, Matrix3, IonResource, ColorMaterialProperty, EasingFunction, GeometryInstance } from 'cesium';
 
 var TIME_LAG = 300;
 var POSITION_CHECK_TIMER = 950;
@@ -4761,6 +4761,8 @@ function correctStyle(style) {
     }
     return style;
 }
+var VIEWER_WATCH_KEY = "bruce-viewer-watch";
+var WATCH_KEY = "bruce-tileset-watch";
 /**
  * Creates and returns a tileset instance from a given url.
  * This is made to handle the difference between old and new cesium versions.
@@ -4771,15 +4773,21 @@ function correctStyle(style) {
  */
 function createTileset(url, props) {
     return __awaiter(this, void 0, void 0, function () {
-        var C3DT;
+        var defaultProps, C3DT;
         return __generator(this, function (_a) {
+            defaultProps = {
+                // "Optimization option. Reduce the screen space error for tiles that are further away from the camera.".
+                dynamicScreenSpaceError: true,
+                // "The maximum amount of memory in MB that can be used by the tileset.".
+                maximumMemoryUsage: 512
+            };
             C3DT = Cesium3DTileset;
             if (C3DT.fromUrl) {
                 // New cesium is running.
-                return [2 /*return*/, C3DT.fromUrl(url, __assign({}, props))];
+                return [2 /*return*/, C3DT.fromUrl(url, __assign(__assign({}, defaultProps), props))];
             }
             // Old cesium is running.
-            return [2 /*return*/, new C3DT(__assign({ url: url }, props))];
+            return [2 /*return*/, new C3DT(__assign(__assign({ url: url }, defaultProps), props))];
         });
     });
 }
@@ -4949,11 +4957,12 @@ var TilesetRenderEngine;
                         cTileset_1 = _a.sent();
                         params.viewer.scene.primitives.add(cTileset_1);
                         cTileset_1.readyPromise.then(function () {
-                            var _a, _b, _c;
+                            var _a, _b, _c, _d;
                             try {
                                 if (!isAlive(params.viewer, cTileset_1)) {
                                     return;
                                 }
+                                (_a = GetMemoryWatcher(params.viewer)) === null || _a === void 0 ? void 0 : _a.Watch(cTileset_1);
                                 var settings = params.tileset.settings;
                                 ApplySettings({
                                     cTileset: cTileset_1,
@@ -4964,9 +4973,9 @@ var TilesetRenderEngine;
                                 ApplyPosition({
                                     cTileset: cTileset_1,
                                     position: {
-                                        ucs: (_a = params.coords) === null || _a === void 0 ? void 0 : _a.ucs,
-                                        location: ((_b = params.coords) === null || _b === void 0 ? void 0 : _b.location) == null ? settings.location : params.coords.location,
-                                        transform: ((_c = params.coords) === null || _c === void 0 ? void 0 : _c.transform) == null ? settings.transform : params.coords.transform
+                                        ucs: (_b = params.coords) === null || _b === void 0 ? void 0 : _b.ucs,
+                                        location: ((_c = params.coords) === null || _c === void 0 ? void 0 : _c.location) == null ? settings.location : params.coords.location,
+                                        transform: ((_d = params.coords) === null || _d === void 0 ? void 0 : _d.transform) == null ? settings.transform : params.coords.transform
                                     }
                                 });
                             }
@@ -4997,10 +5006,12 @@ var TilesetRenderEngine;
                         cTileset_2 = _a.sent();
                         params.viewer.scene.primitives.add(cTileset_2);
                         cTileset_2.readyPromise.then(function () {
+                            var _a;
                             try {
                                 if (!isAlive(params.viewer, cTileset_2)) {
                                     return;
                                 }
+                                (_a = GetMemoryWatcher(params.viewer)) === null || _a === void 0 ? void 0 : _a.Watch(cTileset_2);
                                 var settings = params.tileset.settings;
                                 ApplySettings({
                                     cTileset: cTileset_2,
@@ -5073,10 +5084,12 @@ var TilesetRenderEngine;
                         cTileset = _a.sent();
                         viewer.scene.primitives.add(cTileset);
                         cTileset.readyPromise.then(function () {
+                            var _a;
                             try {
                                 if (!isAlive(viewer, cTileset)) {
                                     return;
                                 }
+                                (_a = GetMemoryWatcher(params.viewer)) === null || _a === void 0 ? void 0 : _a.Watch(cTileset);
                                 if (tileset) {
                                     var settings_1 = tileset.Settings;
                                     settings_1 = __assign({}, settings_1);
@@ -5523,6 +5536,89 @@ var TilesetRenderEngine;
         return Styler;
     }());
     TilesetRenderEngine.Styler = Styler;
+    /**
+     * The maximum memory in MB that can be used by all tilesets.
+     * This is distributed evenly between all loaded tilesets.
+     */
+    TilesetRenderEngine.MAX_TILESET_MEMORY = 1024;
+    /**
+     * Watches tilesets in the viewer.
+     * This will regulate their max memory param.
+     * As more get watched their memory will be reduced.
+     */
+    var MemoryWatcher = /** @class */ (function () {
+        function MemoryWatcher(viewer) {
+            this.watched = [];
+            this.viewer = viewer;
+        }
+        MemoryWatcher.prototype.distributeMemory = function () {
+            this.clean();
+            // Total 1gb as default.
+            // We'll need to allow user to change this somehow.
+            var maxMemory = TilesetRenderEngine.MAX_TILESET_MEMORY;
+            // Minimum memory in MB per tileset.
+            var minMemory = 80;
+            var totalPerTileset = Math.max(this.watched.length ? maxMemory / this.watched.length : maxMemory, minMemory);
+            this.watched.forEach(function (x) {
+                x.maximumMemoryUsage = totalPerTileset;
+            });
+        };
+        MemoryWatcher.prototype.destroy = function () {
+            this.watched = [];
+        };
+        /**
+         * Remove all dead tilesets.
+         */
+        MemoryWatcher.prototype.clean = function () {
+            var _this = this;
+            // Remove all dead tilesets.
+            this.watched = this.watched.filter(function (x) { return isAlive(_this.viewer, x); });
+            // Check if viewer is destroyed.
+            if (!this.viewer || this.viewer.isDestroyed()) {
+                this.destroy();
+            }
+        };
+        MemoryWatcher.prototype.Watch = function (tileset) {
+            if (!tileset) {
+                return;
+            }
+            if (!tileset[WATCH_KEY]) {
+                tileset[WATCH_KEY] = ObjectUtils.UId();
+            }
+            var index = this.watched.findIndex(function (x) { return x[WATCH_KEY] === tileset[WATCH_KEY]; });
+            if (index >= 0) {
+                return;
+            }
+            this.watched.push(tileset);
+            this.distributeMemory();
+        };
+        MemoryWatcher.prototype.Unwatch = function (tileset) {
+            if (!tileset) {
+                return;
+            }
+            if (!tileset[WATCH_KEY]) {
+                tileset[WATCH_KEY] = ObjectUtils.UId();
+            }
+            var index = this.watched.findIndex(function (x) { return (x === null || x === void 0 ? void 0 : x[WATCH_KEY]) === tileset[WATCH_KEY]; });
+            if (index > -1) {
+                this.watched.splice(index, 1);
+            }
+            this.distributeMemory();
+        };
+        return MemoryWatcher;
+    }());
+    TilesetRenderEngine.MemoryWatcher = MemoryWatcher;
+    function GetMemoryWatcher(viewer) {
+        // If viewer is dead return nothing.
+        if (!viewer || viewer.isDestroyed()) {
+            return null;
+        }
+        if (!viewer[VIEWER_WATCH_KEY]) {
+            viewer[VIEWER_WATCH_KEY] = new MemoryWatcher(viewer);
+        }
+        return viewer[VIEWER_WATCH_KEY];
+    }
+    TilesetRenderEngine.GetMemoryWatcher = GetMemoryWatcher;
 })(TilesetRenderEngine || (TilesetRenderEngine = {}));
 
 /**
@@ -5803,16 +5899,17 @@ var TilesetCadRenderManager;
             this.doDispose();
         };
         Manager.prototype.doDispose = function () {
-            var _a;
+            var _a, _b;
             if (this.cTileset) {
                 var viewer = this.viewer;
                 if (!(viewer === null || viewer === void 0 ? void 0 : viewer.isDestroyed()) && this.viewer.scene.primitives.contains(this.cTileset)) {
                     this.cTileset.show = false;
                     this.viewer.scene.primitives.remove(this.cTileset);
+                    (_a = TilesetRenderEngine.GetMemoryWatcher(viewer)) === null || _a === void 0 ? void 0 : _a.Unwatch(this.cTileset);
                 }
                 this.cTileset = null;
             }
-            (_a = this.styler) === null || _a === void 0 ? void 0 : _a.Dispose();
+            (_b = this.styler) === null || _b === void 0 ? void 0 : _b.Dispose();
             this.visualsManager.RemoveRegos({
                 menuItemId: this.item.id
             });
@@ -6353,11 +6450,13 @@ var TilesetEntitiesRenderManager;
             this.doDispose();
         };
         Manager.prototype.doDispose = function () {
+            var _a;
             if (this.cTileset) {
                 var viewer = this.viewer;
                 if (!(viewer === null || viewer === void 0 ? void 0 : viewer.isDestroyed()) && this.viewer.scene.primitives.contains(this.cTileset)) {
                     this.cTileset.show = false;
                     this.viewer.scene.primitives.remove(this.cTileset);
+                    (_a = TilesetRenderEngine.GetMemoryWatcher(viewer)) === null || _a === void 0 ? void 0 : _a.Unwatch(this.cTileset);
                 }
                 this.cTileset = null;
             }
@@ -6505,11 +6604,13 @@ var TilesetPointcloudRenderManager;
             this.doDispose();
         };
         Manager.prototype.doDispose = function () {
+            var _a;
             if (this.cTileset) {
                 var viewer = this.viewer;
                 if (!(viewer === null || viewer === void 0 ? void 0 : viewer.isDestroyed()) && this.viewer.scene.primitives.contains(this.cTileset)) {
                     this.cTileset.show = false;
                     this.viewer.scene.primitives.remove(this.cTileset);
+                    (_a = TilesetRenderEngine.GetMemoryWatcher(viewer)) === null || _a === void 0 ? void 0 : _a.Unwatch(this.cTileset);
                 }
                 this.cTileset = null;
             }
@@ -6855,16 +6956,17 @@ var TilesetArbRenderManager;
             this.doDispose();
         };
         Manager.prototype.doDispose = function () {
-            var _a;
+            var _a, _b;
             if (this.cTileset) {
                 var viewer = this.viewer;
                 if (!(viewer === null || viewer === void 0 ? void 0 : viewer.isDestroyed()) && this.viewer.scene.primitives.contains(this.cTileset)) {
                     this.cTileset.show = false;
                     this.viewer.scene.primitives.remove(this.cTileset);
+                    (_a = TilesetRenderEngine.GetMemoryWatcher(viewer)) === null || _a === void 0 ? void 0 : _a.Unwatch(this.cTileset);
                 }
                 this.cTileset = null;
             }
-            (_a = this.styler) === null || _a === void 0 ? void 0 : _a.Dispose();
+            (_b = this.styler) === null || _b === void 0 ? void 0 : _b.Dispose();
             this.visualsManager.RemoveRegos({
                 menuItemId: this.item.id
             });