bruce-cesium 4.5.0 → 4.5.1

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, 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, PolygonHierarchy, PolylineGraphics, ColorMaterialProperty, HorizontalOrigin, VerticalOrigin, ColorBlendMode, HeadingPitchRoll, Transforms, Model, Primitive, Cesium3DTileFeature, SceneMode, GeoJsonDataSource, 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, EllipsoidGeodesic, sampleTerrainMostDetailed, defined, PolygonPipeline, BoundingSphere, GeometryInstance, CesiumInspector, ClockRange, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, ScreenSpaceEventHandler, ScreenSpaceEventType, Quaternion, CzmlDataSource, Intersect } from 'cesium';
+import { Cartographic, Cartesian2, Math as Math$1, Cartesian3, CallbackProperty, Color, HeightReference, Rectangle, JulianDate, Entity, HorizontalOrigin, VerticalOrigin, ConstantProperty, ConstantPositionProperty, ClassificationType, DistanceDisplayCondition, PolygonHierarchy, ShadowMode, PolylineGraphics, ArcType, CornerType, ColorMaterialProperty, ColorBlendMode, HeadingPitchRoll, Transforms, Model, Primitive, Cesium3DTileFeature, SceneMode, GeoJsonDataSource, Cesium3DTileColorBlendMode, HeadingPitchRange, Cesium3DTileStyle, Ion, KmlDataSource, SceneTransforms, OrthographicFrustum, EasingFunction, NearFarScalar, PolygonPipeline, EllipsoidTerrainProvider, CesiumInspector, defined, ClockRange, Cesium3DTileset, Matrix4, Matrix3, IonResource, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, IonImageryProvider, CesiumTerrainProvider, EllipsoidGeodesic, sampleTerrainMostDetailed, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, Quaternion, ScreenSpaceEventHandler, ScreenSpaceEventType, BoundingSphere, GeometryInstance, CzmlDataSource, Intersect } from 'cesium';
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation. All rights reserved.
@@ -21365,6 +21365,74 @@ var MenuItemCreator;
     MenuItemCreator.RenderBookmarkItems = RenderBookmarkItems;
 })(MenuItemCreator || (MenuItemCreator = {}));
 
+/**
+ * We had the need to emit info about viewer events while we load entities/tilesets/etc.
+ * This is to communicate to Navigator on anything the user needs to review.
+ */
+var ViewerEventTracker;
+(function (ViewerEventTracker) {
+    var EDomain;
+    (function (EDomain) {
+        // Terrain/Imagery.
+        EDomain["TileTerrain"] = "TileTerrain";
+        EDomain["TileImagery"] = "TileImagery";
+    })(EDomain = ViewerEventTracker.EDomain || (ViewerEventTracker.EDomain = {}));
+    // Type event.
+    var EType;
+    (function (EType) {
+        EType["Info"] = "info";
+        EType["Error"] = "error";
+        EType["Warn"] = "warn";
+    })(EType = ViewerEventTracker.EType || (ViewerEventTracker.EType = {}));
+    var Tracker = /** @class */ (function () {
+        function Tracker(logEnabled) {
+            if (logEnabled === void 0) { logEnabled = false; }
+            this.MAX_CACHE_ITEMS = 30;
+            this.cache = [];
+            this.OnEvent = new BruceEvent();
+            this.logEnabled = logEnabled;
+        }
+        Tracker.prototype.SetLogEnabled = function (enabled) {
+            this.logEnabled = enabled;
+        };
+        Tracker.prototype.Info = function (domain, message, data) {
+            if (this.logEnabled == true || (typeof this.logEnabled === "string" && this.logEnabled.includes("info"))) {
+                console.info("[ViewerEventTracker] ".concat(domain, ": ").concat(message), data);
+            }
+            var event = { type: EType.Info, domain: domain, message: message, data: data };
+            this.addToCache(event);
+            this.OnEvent.Trigger(event);
+        };
+        Tracker.prototype.Error = function (domain, message, data) {
+            if (this.logEnabled == true || (typeof this.logEnabled === "string" && this.logEnabled.includes("error"))) {
+                console.error("[ViewerEventTracker] ".concat(domain, ": ").concat(message), data);
+            }
+            var event = { type: EType.Error, domain: domain, message: message, data: data };
+            this.addToCache(event);
+            this.OnEvent.Trigger(event);
+        };
+        Tracker.prototype.Warn = function (domain, message, data) {
+            if (this.logEnabled == true || (typeof this.logEnabled === "string" && this.logEnabled.includes("warn"))) {
+                console.warn("[ViewerEventTracker] ".concat(domain, ": ").concat(message), data);
+            }
+            var event = { type: EType.Warn, domain: domain, message: message, data: data };
+            this.addToCache(event);
+            this.OnEvent.Trigger(event);
+        };
+        Tracker.prototype.addToCache = function (event) {
+            if (this.cache.length >= this.MAX_CACHE_ITEMS) {
+                this.cache.shift();
+            }
+            this.cache.push(event);
+        };
+        Tracker.prototype.GetCache = function () {
+            return this.cache;
+        };
+        return Tracker;
+    }());
+    ViewerEventTracker.Tracker = Tracker;
+})(ViewerEventTracker || (ViewerEventTracker = {}));
+
 // Used to track if a current in-progress render is the latest.
 // If we're midway through an async function that is rendering 10 imageries and this changes, then we stop the function.
 var ITERATION_KEY = "nextspace-tile-render-engine-iteration";
@@ -22269,21 +22337,30 @@ var TileRenderEngine;
                                 return [4 /*yield*/, renderDefaultMapTile(apiGetter, ProjectViewTile.EDefaultImagery.MapboxSatellite)];
                             case 6:
                                 provider = _d.sent();
-                                console.warn("Bing Maps Aerial failed to load. Falling back to Mapbox Satellite.");
+                                ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileImagery, "Bing Maps Aerial failed to load. Falling back to Mapbox Satellite.", {
+                                    tilesetId: ProjectViewTile.EDefaultImagery.BingMapsAerial,
+                                    exception: e_2
+                                });
                                 return [3 /*break*/, 12];
                             case 7:
                                 if (!(defaultImg.id === ProjectViewTile.EDefaultImagery.BingMapsAerialWithLabels)) return [3 /*break*/, 9];
                                 return [4 /*yield*/, renderDefaultMapTile(apiGetter, ProjectViewTile.EDefaultImagery.MapBoxStreets)];
                             case 8:
                                 provider = _d.sent();
-                                console.warn("Bing Maps Aerial with Labels failed to load. Falling back to Mapbox Streets.");
+                                ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileImagery, "Bing Maps Aerial with Labels failed to load. Falling back to Mapbox Streets.", {
+                                    tilesetId: ProjectViewTile.EDefaultImagery.BingMapsAerialWithLabels,
+                                    exception: e_2
+                                });
                                 return [3 /*break*/, 12];
                             case 9:
                                 if (!(defaultImg.id === ProjectViewTile.EDefaultImagery.BingMapsRoads)) return [3 /*break*/, 11];
                                 return [4 /*yield*/, renderDefaultMapTile(apiGetter, ProjectViewTile.EDefaultImagery.OpenStreetMap)];
                             case 10:
                                 provider = _d.sent();
-                                console.warn("Bing Maps Roads failed to load. Falling back to OpenStreetMap.");
+                                ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileImagery, "Bing Maps Roads failed to load. Falling back to OpenStreetMap.", {
+                                    tilesetId: ProjectViewTile.EDefaultImagery.BingMapsRoads,
+                                    exception: e_2
+                                });
                                 return [3 /*break*/, 12];
                             case 11: throw e_2;
                             case 12: return [3 /*break*/, 13];
@@ -22729,7 +22806,7 @@ var TileRenderEngine;
             function Render(params) {
                 var _a;
                 return __awaiter(this, void 0, void 0, function () {
-                    var iteration, CESIUM, enabledMeta, provider_1, leave, defaultTerr, provider, shouldCreate, api, tileset, url, vertexes, settings;
+                    var iteration, CESIUM, enabledMeta, provider_1, leave, defaultTerr, provider, shouldCreate, api, tileset, e_4, url, vertexes, settings;
                     return __generator(this, function (_b) {
                         switch (_b.label) {
                             case 0:
@@ -22763,7 +22840,7 @@ var TileRenderEngine;
                                 }
                                 defaultTerr = params.tile.accountId ? null : ProjectViewTile.DefaultTerrains.find(function (x) { return x.id === params.tile.tilesetId; });
                                 provider = null;
-                                if (!defaultTerr) return [3 /*break*/, 5];
+                                if (!defaultTerr) return [3 /*break*/, 6];
                                 shouldCreate = true;
                                 if (!(defaultTerr.id == ProjectViewTile.EDefaultTerrain.CesiumWorldTerrain)) return [3 /*break*/, 2];
                                 return [4 /*yield*/, ViewerUtils.AssertIonToken(Ion.defaultAccessToken)];
@@ -22775,15 +22852,20 @@ var TileRenderEngine;
                                 return [4 /*yield*/, renderDefaultTerrTile(defaultTerr.id)];
                             case 3:
                                 provider = (_b.sent());
-                                _b.label = 4;
-                            case 4: return [3 /*break*/, 10];
-                            case 5:
+                                return [3 /*break*/, 5];
+                            case 4:
+                                ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileTerrain, "Cesium Ion token not set, Cesium World Terrain will not be enabled.", {
+                                    tilesetId: ProjectViewTile.EDefaultTerrain.CesiumWorldTerrain
+                                });
+                                _b.label = 5;
+                            case 5: return [3 /*break*/, 14];
+                            case 6:
                                 api = params.apiGetter.getApi(params.tile.accountId);
                                 // Ensure regional url is loaded.
                                 // When loading stuff in the same account as the default it's likely already loaded,
                                 // but if we just made an API instance for some external account then it won't be loaded yet.
                                 return [4 /*yield*/, api.Loading];
-                            case 6:
+                            case 7:
                                 // Ensure regional url is loaded.
                                 // When loading stuff in the same account as the default it's likely already loaded,
                                 // but if we just made an API instance for some external account then it won't be loaded yet.
@@ -22791,15 +22873,32 @@ var TileRenderEngine;
                                 if (!assertIteration(params.viewer, iteration)) {
                                     return [2 /*return*/];
                                 }
+                                tileset = void 0;
+                                _b.label = 8;
+                            case 8:
+                                _b.trys.push([8, 10, , 11]);
                                 return [4 /*yield*/, Tileset.Get({
                                         api: api,
                                         tilesetId: params.tile.tilesetId
                                     })];
-                            case 7:
+                            case 9:
                                 tileset = (_b.sent()).tileset;
                                 if (!assertIteration(params.viewer, iteration)) {
                                     return [2 /*return*/];
                                 }
+                                if (tileset == null) {
+                                    throw new Error("Tileset not found.");
+                                }
+                                return [3 /*break*/, 11];
+                            case 10:
+                                e_4 = _b.sent();
+                                ViewerUtils.GetEventTracker(params.viewer).Error(ViewerEventTracker.EDomain.TileTerrain, "Failed to retreieve terrain Tileset record.", {
+                                    tilesetId: params.tile.tilesetId,
+                                    accountId: params.tile.accountId,
+                                    exception: e_4
+                                });
+                                return [3 /*break*/, 11];
+                            case 11:
                                 url = void 0;
                                 vertexes = true;
                                 if (tileset.type === Tileset.EType.Terrain) {
@@ -22819,21 +22918,21 @@ var TileRenderEngine;
                                 else {
                                     console.error("Invalid tileset type.", tileset);
                                 }
-                                if (!url) return [3 /*break*/, 10];
-                                if (!CESIUM.CesiumTerrainProvider.hasOwnProperty("fromUrl")) return [3 /*break*/, 9];
+                                if (!url) return [3 /*break*/, 14];
+                                if (!CESIUM.CesiumTerrainProvider.hasOwnProperty("fromUrl")) return [3 /*break*/, 13];
                                 return [4 /*yield*/, CESIUM.CesiumTerrainProvider.fromUrl(url, {
                                         requestVertexNormals: vertexes
                                     })];
-                            case 8:
+                            case 12:
                                 provider = (_b.sent());
-                                return [3 /*break*/, 10];
-                            case 9:
+                                return [3 /*break*/, 14];
+                            case 13:
                                 provider = new CESIUM.CesiumTerrainProvider({
                                     url: url,
                                     requestVertexNormals: vertexes
                                 });
-                                _b.label = 10;
-                            case 10:
+                                _b.label = 14;
+                            case 14:
                                 if (provider) {
                                     provider._bMeta = {
                                         accountId: params.tile.accountId,
@@ -23460,7 +23559,9 @@ function renderNavigator(iteration, params, bookmark, view, getters) {
                         terrain = {
                             tilesetId: ProjectViewTile.EDefaultTerrain.FlatTerrain
                         };
-                        console.warn("Cesium Ion token not set, using flat terrain instead of cesium world terrain.");
+                        ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileTerrain, "Cesium Ion token not set, using flat terrain instead of Cesium World Terrain.", {
+                            tilesetId: ProjectViewTile.EDefaultTerrain.CesiumWorldTerrain
+                        });
                     }
                     return [4 /*yield*/, TileRenderEngine.Terrain.Navigator.Render({
                             apiGetter: params.apiGetter,
@@ -23717,15 +23818,21 @@ function renderNavigator(iteration, params, bookmark, view, getters) {
                                 layer = imagery[i];
                                 if (layer.tilesetId == ProjectViewTile.EDefaultImagery.BingMapsAerial) {
                                     layer.tilesetId = ProjectViewTile.EDefaultImagery.MapboxSatellite;
-                                    console.warn("Cesium Ion token not set, using mapbox satellite instead of bing maps aerial.");
+                                    ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileImagery, "Cesium Ion token not set, using Mapbox Satellite instead of Bing Maps Aerial.", {
+                                        tilesetId: ProjectViewTile.EDefaultImagery.BingMapsAerial
+                                    });
                                 }
                                 else if (layer.tilesetId == ProjectViewTile.EDefaultImagery.BingMapsAerialWithLabels) {
                                     layer.tilesetId = ProjectViewTile.EDefaultImagery.MapboxSatellite;
-                                    console.warn("Cesium Ion token not set, using mapbox satellite instead of bing maps aerial with labels.");
+                                    ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileImagery, "Cesium Ion token not set, using Mapbox Satellite instead of Bing Maps Aerial with labels.", {
+                                        tilesetId: ProjectViewTile.EDefaultImagery.BingMapsAerialWithLabels
+                                    });
                                 }
                                 else if (layer.tilesetId == ProjectViewTile.EDefaultImagery.BingMapsRoads) {
                                     layer.tilesetId = ProjectViewTile.EDefaultImagery.MapBoxStreets;
-                                    console.warn("Cesium Ion token not set, using mapbox streets instead of bing maps roads.");
+                                    ViewerUtils.GetEventTracker(params.viewer).Warn(ViewerEventTracker.EDomain.TileImagery, "Cesium Ion token not set, using Mapbox Satellite instead of Bing Maps Roads.", {
+                                        tilesetId: ProjectViewTile.EDefaultImagery.BingMapsRoads
+                                    });
                                 }
                             }
                         }
@@ -26967,6 +27074,7 @@ var WidgetEmbeddedInfoView = /** @class */ (function (_super) {
 }(Widget.AWidget));
 
 var CESIUM_VIEWER_MANAGER_KEY = "_cesiumViewerManager";
+var CESIUM_VIEWER_EVENT_TRACKER_KEY = "_cesiumViewerEventTracker";
 /**
  * Bug related to entities not being visible after they were added then a render was requested.
  * It was 4 point entities in York. They would not appear until a request render was recalled.
@@ -27238,9 +27346,24 @@ var ViewerUtils;
         });
     }
     ViewerUtils.AssertIonToken = AssertIonToken;
+    /**
+     * Gets or creates a viewer event tracker.
+     * This will log and emit events that are tracked.
+     * @param viewer
+     * @returns
+     */
+    function GetEventTracker(viewer) {
+        var tracker = viewer[CESIUM_VIEWER_EVENT_TRACKER_KEY];
+        if (!tracker) {
+            tracker = new ViewerEventTracker.Tracker("warn,error");
+        }
+        viewer[CESIUM_VIEWER_EVENT_TRACKER_KEY] = tracker;
+        return tracker;
+    }
+    ViewerUtils.GetEventTracker = GetEventTracker;
 })(ViewerUtils || (ViewerUtils = {}));
 
-var VERSION = "4.5.0";
+var VERSION = "4.5.1";
 
-export { VERSION, CesiumViewMonitor, ViewerUtils, MenuItemManager, EntityRenderEngine, EntityRenderEnginePoint, EntityRenderEnginePolyline, EntityRenderEnginePolygon, EntityRenderEngineModel3d, MenuItemCreator, VisualsRegister, RenderManager, EntitiesIdsRenderManager, 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, WidgetSearchBar, VIEWER_LEFT_PANEL_WIDGET_KEY, VIEWER_LEFT_PANEL_CSS_VAR_LEFT, WidgetLeftPanel, WidgetLeftPanelTab, WidgetLeftPanelTabBookmarks };
+export { VERSION, CesiumViewMonitor, ViewerUtils, ViewerEventTracker, MenuItemManager, EntityRenderEngine, EntityRenderEnginePoint, EntityRenderEnginePolyline, EntityRenderEnginePolygon, EntityRenderEngineModel3d, MenuItemCreator, VisualsRegister, RenderManager, EntitiesIdsRenderManager, 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, WidgetSearchBar, VIEWER_LEFT_PANEL_WIDGET_KEY, VIEWER_LEFT_PANEL_CSS_VAR_LEFT, WidgetLeftPanel, WidgetLeftPanelTab, WidgetLeftPanelTabBookmarks };
 //# sourceMappingURL=bruce-cesium.es5.js.map