bruce-cesium 1.5.0 → 1.5.2

package/dist/bruce-cesium.es5.js

@@ -1,5 +1,5 @@
 import { BruceEvent, Cartes, Carto, Geometry, ZoomControl, Style, EntityTag, Calculator, EntityLod, EntityType, ClientFile, ObjectUtils, DelayQueue, Entity as Entity$1, BatchedDataGetter, EntityRelationType, Tileset, EntityCoords, EntityFilterGetter, EntitySource, MenuItem, EntityRelation, ProjectView, ProjectViewBookmark, ProjectViewTile, ProjectViewLegacyTile, ProgramKey, Camera } from 'bruce-models';
-import { Cartesian2, Cartographic, Math as Math$1, Color, HeightReference, Cartesian3, EllipsoidTerrainProvider, Entity, HorizontalOrigin, VerticalOrigin, ClassificationType, ArcType, PolygonHierarchy, ShadowMode, PolylineGraphics, HeadingPitchRoll, Transforms, ColorBlendMode, Primitive, Cesium3DTileFeature, SceneMode, HeadingPitchRange, Cesium3DTileColorBlendMode, KmlDataSource, createOsmBuildings, Cesium3DTileStyle, Rectangle, CallbackProperty, OrthographicFrustum, JulianDate, createWorldTerrain, CesiumTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, UrlTemplateImageryProvider, TileMapServiceImageryProvider, IonImageryProvider, Matrix4, Cesium3DTileset, IonResource, EllipsoidGeodesic, sampleTerrainMostDetailed, PolygonPipeline, ColorMaterialProperty, Matrix3, EasingFunction, GeometryInstance } from 'cesium';
+import { Entity, Primitive, Cesium3DTileFeature, Color, Cartesian2, Cartographic, Math as Math$1, SceneMode, Cartesian3, HeadingPitchRange, Cesium3DTileColorBlendMode, HeightReference, EllipsoidTerrainProvider, HorizontalOrigin, VerticalOrigin, ClassificationType, ArcType, PolygonHierarchy, ShadowMode, PolylineGraphics, HeadingPitchRoll, Transforms, ColorBlendMode, createOsmBuildings, Cesium3DTileStyle, Rectangle, KmlDataSource, CallbackProperty, createWorldTerrain, CesiumTerrainProvider, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, UrlTemplateImageryProvider, TileMapServiceImageryProvider, IonImageryProvider, OrthographicFrustum, JulianDate, Matrix4, Cesium3DTileset, IonResource, PolygonPipeline, EllipsoidGeodesic, sampleTerrainMostDetailed, ColorMaterialProperty, Matrix3, EasingFunction, GeometryInstance } from 'cesium';
 
 var TIME_LAG = 300;
 var POSITION_CHECK_TIMER = 950;
@@ -359,6 +359,24 @@ function __generator(thisArg, body) {
     }
 }
 
+/**
+ * Ensures a number is returned from a given value.
+ * If given value cannot be parsed it will return defaultNum.
+ * @param value
+ * @param defaultNum default is 0.
+ * @returns
+ */
+function EnsureNumber(value, defaultNum) {
+    if (!defaultNum) {
+        defaultNum = 0;
+    }
+    value = Number(value);
+    if (isNaN(value)) {
+        return defaultNum;
+    }
+    return value;
+}
+
 var MeasureUtils;
 (function (MeasureUtils) {
     /**
@@ -525,25 +543,48 @@ var DrawingUtils;
         });
     }
     DrawingUtils.GetTerrainHeight = GetTerrainHeight;
-})(DrawingUtils || (DrawingUtils = {}));
-
-/**
- * Ensures a number is returned from a given value.
- * If given value cannot be parsed it will return defaultNum.
- * @param value
- * @param defaultNum default is 0.
- * @returns
- */
-function EnsureNumber(value, defaultNum) {
-    if (!defaultNum) {
-        defaultNum = 0;
-    }
-    value = Number(value);
-    if (isNaN(value)) {
-        return defaultNum;
+    function EnsurePosHeight(params) {
+        var pos3d = params.pos3d, viewer = params.viewer, desiredHeightRef = params.desiredHeightRef, heightRef = params.heightRef;
+        var carto = Cartes.ValidateCartes3(pos3d) ? Cartographic.fromCartesian(pos3d) : null;
+        if (heightRef == null) {
+            heightRef = HeightReference.CLAMP_TO_GROUND;
+        }
+        if (desiredHeightRef == null) {
+            desiredHeightRef = HeightReference.CLAMP_TO_GROUND;
+        }
+        if (heightRef == desiredHeightRef) {
+            return pos3d;
+        }
+        if (heightRef == HeightReference.NONE) {
+            // Turn absolute into clamped.
+            if (desiredHeightRef == HeightReference.CLAMP_TO_GROUND) {
+                return Cartesian3.fromRadians(carto.longitude, carto.latitude, 0);
+            }
+            // Turn absolute into relative (remove terrain height).
+            else if (desiredHeightRef == HeightReference.RELATIVE_TO_GROUND) {
+                var terrainHeight = EnsureNumber(viewer.scene.globe.getHeight(carto), 0);
+                return Cartesian3.fromRadians(carto.longitude, carto.latitude, carto.height - terrainHeight);
+            }
+        }
+        else if (heightRef == HeightReference.CLAMP_TO_GROUND) {
+            var terrainHeight = EnsureNumber(viewer.scene.globe.getHeight(carto), 0);
+            return Cartesian3.fromRadians(carto.longitude, carto.latitude, terrainHeight);
+        }
+        else if (heightRef == HeightReference.RELATIVE_TO_GROUND) {
+            // Turn relative into absolute (add terrain height).
+            if (desiredHeightRef == HeightReference.NONE) {
+                var terrainHeight = EnsureNumber(viewer.scene.globe.getHeight(carto), 0);
+                return Cartesian3.fromRadians(carto.longitude, carto.latitude, carto.height + terrainHeight);
+            }
+            // Turn relative into clamped.
+            else if (desiredHeightRef == HeightReference.CLAMP_TO_GROUND) {
+                return Cartesian3.fromRadians(carto.longitude, carto.latitude, 0);
+            }
+        }
+        return pos3d;
     }
-    return value;
-}
+    DrawingUtils.EnsurePosHeight = EnsurePosHeight;
+})(DrawingUtils || (DrawingUtils = {}));
 
 function traverseEntity(cEntity, arr, ignoreParent) {
     if (cEntity._parentEntity && !ignoreParent) {
@@ -681,8 +722,6 @@ var EntityUtils;
      */
     function GetPos(params) {
         var viewer = params.viewer, entity = params.entity, visualRegister = params.visualRegister;
-        // TODO: Tidy this up, move to a separate function.
-        // We need a generic "get pos AS blah height reference" function.
         function evaluateRendered() {
             var rego = visualRegister ? visualRegister.GetRego({
                 entityId: entity.Bruce.ID,
@@ -713,37 +752,12 @@ var EntityUtils;
                         else if (visual.point) {
                             visualHeightRef = GetValue(viewer, visual.point.heightReference);
                         }
-                        if (visualHeightRef == params.heightReference) {
-                            return pos3d_1;
-                        }
-                        var carto_1 = Cartographic.fromCartesian(pos3d_1);
-                        if (visualHeightRef == HeightReference.NONE) {
-                            // Turn absolute into clamped.
-                            if (params.heightReference == HeightReference.CLAMP_TO_GROUND) {
-                                return Cartesian3.fromRadians(carto_1.longitude, carto_1.latitude, 0);
-                            }
-                            // Turn absolute into relative (remove terrain height).
-                            else if (params.heightReference == HeightReference.RELATIVE_TO_GROUND) {
-                                var terrainHeight = EnsureNumber(viewer.scene.globe.getHeight(carto_1), 0);
-                                return Cartesian3.fromRadians(carto_1.longitude, carto_1.latitude, carto_1.height - terrainHeight);
-                            }
-                        }
-                        else if (visualHeightRef == HeightReference.CLAMP_TO_GROUND) {
-                            var terrainHeight = EnsureNumber(viewer.scene.globe.getHeight(carto_1), 0);
-                            return Cartesian3.fromRadians(carto_1.longitude, carto_1.latitude, terrainHeight);
-                        }
-                        else if (visualHeightRef == HeightReference.RELATIVE_TO_GROUND) {
-                            // Turn relative into absolute (add terrain height).
-                            if (params.heightReference == HeightReference.NONE) {
-                                var terrainHeight = EnsureNumber(viewer.scene.globe.getHeight(carto_1), 0);
-                                return Cartesian3.fromRadians(carto_1.longitude, carto_1.latitude, carto_1.height + terrainHeight);
-                            }
-                            // Turn relative into clamped.
-                            else if (params.heightReference == HeightReference.CLAMP_TO_GROUND) {
-                                return Cartesian3.fromRadians(carto_1.longitude, carto_1.latitude, 0);
-                            }
-                        }
-                        return pos3d_1;
+                        return DrawingUtils.EnsurePosHeight({
+                            desiredHeightRef: params.returnHeightRef,
+                            heightRef: visualHeightRef,
+                            pos3d: pos3d_1,
+                            viewer: viewer
+                        });
                     }
                 }
             }
@@ -814,14 +828,12 @@ var EntityUtils;
             return pos3d;
         }
         pos3d = evaluateRecord();
-        var carto = Cartes.ValidateCartes3(pos3d) ? Cartographic.fromCartesian(pos3d) : null;
-        if (carto) {
-            // Since we don't know height reference, we can't convert it.
-            // We will just clamp it to ground.
-            var terrainHeight = EnsureNumber(viewer.scene.globe.getHeight(carto), 0);
-            pos3d = Cartesian3.fromRadians(carto.longitude, carto.latitude, terrainHeight);
-        }
-        return pos3d;
+        return DrawingUtils.EnsurePosHeight({
+            desiredHeightRef: params.returnHeightRef,
+            heightRef: params.recordHeightRef,
+            pos3d: pos3d,
+            viewer: viewer
+        });
     }
     EntityUtils.GetPos = GetPos;
     /**
@@ -1049,7 +1061,7 @@ function getPolygonStyleExtrusion(pStyle, entity, tags, heightRef) {
             You need to extrude by 55 meters, if you extrude by 5 it will extrude from sea and look flat.
         */
         var height = (_a = entity.location) === null || _a === void 0 ? void 0 : _a.altitude;
-        return heightRef == HeightReference.RELATIVE_TO_GROUND ? extrusion + height : extrusion;
+        return heightRef != HeightReference.CLAMP_TO_GROUND ? extrusion + height : extrusion;
     }
     catch (e) {
         console.error(e);
@@ -1474,6 +1486,7 @@ var EntityRenderEngine;
                         iconScale = 1;
                     }
                     if (iconScale > 0) {
+                        var heightRef = getHeightRef(style);
                         cEntity = new Entity({
                             billboard: {
                                 horizontalOrigin: HorizontalOrigin.CENTER,
@@ -1484,7 +1497,9 @@ var EntityRenderEngine;
                             },
                             position: EntityUtils.GetPos({
                                 viewer: params.viewer,
-                                entity: entity
+                                entity: entity,
+                                recordHeightRef: heightRef,
+                                returnHeightRef: heightRef
                             }),
                             show: false
                         });
@@ -1515,7 +1530,9 @@ var EntityRenderEngine;
                 }
                 var pos = EntityUtils.GetPos({
                     viewer: params.viewer,
-                    entity: entity
+                    entity: entity,
+                    recordHeightRef: HeightReference.CLAMP_TO_GROUND,
+                    returnHeightRef: HeightReference.CLAMP_TO_GROUND
                 });
                 cEntity = new Entity({
                     ellipse: {
@@ -1563,6 +1580,7 @@ var EntityRenderEngine;
                 if (size <= 0) {
                     return null;
                 }
+                var heightRef = getHeightRef(style);
                 cEntity = new Entity({
                     point: {
                         pixelSize: size,
@@ -1571,7 +1589,9 @@ var EntityRenderEngine;
                     },
                     position: EntityUtils.GetPos({
                         viewer: params.viewer,
-                        entity: entity
+                        entity: entity,
+                        recordHeightRef: heightRef,
+                        returnHeightRef: heightRef
                     }),
                     show: false
                 });
@@ -1706,7 +1726,9 @@ var EntityRenderEngine;
                 },
                 position: EntityUtils.GetPos({
                     viewer: params.viewer,
-                    entity: entity
+                    entity: entity,
+                    recordHeightRef: heightRef,
+                    returnHeightRef: heightRef
                 }),
                 show: false
             });
@@ -1820,7 +1842,9 @@ var EntityRenderEngine;
                 },
                 position: EntityUtils.GetPos({
                     viewer: params.viewer,
-                    entity: entity
+                    entity: entity,
+                    recordHeightRef: heightRef,
+                    returnHeightRef: heightRef
                 }),
                 show: false
             });
@@ -1944,7 +1968,9 @@ var EntityRenderEngine;
             var heightRef = getHeightRef(style);
             var pos = EntityUtils.GetPos({
                 viewer: params.viewer,
-                entity: entity
+                entity: entity,
+                recordHeightRef: heightRef,
+                returnHeightRef: heightRef
             });
             if (heightRef == HeightReference.CLAMP_TO_GROUND) {
                 var carto = Cartographic.fromCartesian(pos);
@@ -2954,41 +2980,41 @@ var RelationRenderEngine;
     RelationRenderEngine.GetRenderGroupId = GetRenderGroupId;
     function Render(params) {
         return __awaiter(this, void 0, void 0, function () {
-            var apiGetter, viewer, visualRegister, menuItemId, relations, api, rendered, i, relation, fromEntity, toEntity, dataEntity, _a, relationType, styleId, entityType, style, _b, cEntity;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var apiGetter, viewer, visualRegister, menuItemId, relations, api, rendered, i, relation, fromEntity, toEntity, dataEntity, _a, relationType, styleId, typeId, entityType, _b, style, _c, cEntity;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         apiGetter = params.apiGetter, viewer = params.viewer, visualRegister = params.visualRegister, menuItemId = params.menuItemId, relations = params.relations;
                         api = apiGetter.getApi(apiGetter.accountId);
                         rendered = {};
                         i = 0;
-                        _c.label = 1;
+                        _d.label = 1;
                     case 1:
-                        if (!(i < relations.length)) return [3 /*break*/, 14];
+                        if (!(i < relations.length)) return [3 /*break*/, 16];
                         relation = relations[i];
                         return [4 /*yield*/, Entity$1.Get({
                                 api: api,
                                 entityId: relation["Principal.Entity.ID"],
                             })];
                     case 2:
-                        fromEntity = (_c.sent()).entity;
+                        fromEntity = (_d.sent()).entity;
                         return [4 /*yield*/, Entity$1.Get({
                                 api: api,
                                 entityId: relation["Related.Entity.ID"],
                             })];
                     case 3:
-                        toEntity = (_c.sent()).entity;
+                        toEntity = (_d.sent()).entity;
                         if (!relation["Data.Entity.ID"]) return [3 /*break*/, 5];
                         return [4 /*yield*/, Entity$1.Get({
                                 api: api,
                                 entityId: relation["Data.Entity.ID"]
                             })];
                     case 4:
-                        _a = (_c.sent()).entity;
+                        _a = (_d.sent()).entity;
                         return [3 /*break*/, 6];
                     case 5:
                         _a = null;
-                        _c.label = 6;
+                        _d.label = 6;
                     case 6:
                         dataEntity = _a;
                         return [4 /*yield*/, EntityRelationType.Get({
@@ -2996,31 +3022,39 @@ var RelationRenderEngine;
                                 relationTypeId: relation["Relation.Type.ID"]
                             })];
                     case 7:
-                        relationType = (_c.sent()).relationType;
+                        relationType = (_d.sent()).relationType;
                         styleId = Number(relationType === null || relationType === void 0 ? void 0 : relationType.EntityDisplaySettingID);
-                        if (!!styleId) return [3 /*break*/, 9];
+                        if (!!styleId) return [3 /*break*/, 11];
+                        typeId = relationType === null || relationType === void 0 ? void 0 : relationType["Relation.EntityType.ID"];
+                        if (!typeId) return [3 /*break*/, 9];
                         return [4 /*yield*/, EntityType.Get({
                                 api: api,
-                                entityTypeId: relationType === null || relationType === void 0 ? void 0 : relationType["Relation.EntityType.ID"]
+                                entityTypeId: typeId
                             })];
                     case 8:
-                        entityType = (_c.sent()).entityType;
-                        styleId = entityType === null || entityType === void 0 ? void 0 : entityType["DisplaySetting.ID"];
-                        _c.label = 9;
+                        _b = (_d.sent()).entityType;
+                        return [3 /*break*/, 10];
                     case 9:
-                        if (!styleId) return [3 /*break*/, 11];
+                        _b = null;
+                        _d.label = 10;
+                    case 10:
+                        entityType = _b;
+                        styleId = entityType === null || entityType === void 0 ? void 0 : entityType["DisplaySetting.ID"];
+                        _d.label = 11;
+                    case 11:
+                        if (!styleId) return [3 /*break*/, 13];
                         return [4 /*yield*/, Style.Get({
                                 api: api,
                                 styleId: styleId
                             })];
-                    case 10:
-                        _b = (_c.sent()).style;
-                        return [3 /*break*/, 12];
-                    case 11:
-                        _b = null;
-                        _c.label = 12;
                     case 12:
-                        style = _b;
+                        _c = (_d.sent()).style;
+                        return [3 /*break*/, 14];
+                    case 13:
+                        _c = null;
+                        _d.label = 14;
+                    case 14:
+                        style = _c;
                         cEntity = Parabola.Render({
                             dataEntity: dataEntity,
                             fromEntity: fromEntity,
@@ -3032,11 +3066,11 @@ var RelationRenderEngine;
                         });
                         cEntity._renderGroup = GetRenderGroupId(relation);
                         rendered[GetRenderGroupId(relation)] = cEntity;
-                        _c.label = 13;
-                    case 13:
+                        _d.label = 15;
+                    case 15:
                         i++;
                         return [3 /*break*/, 1];
-                    case 14: return [2 /*return*/, rendered];
+                    case 16: return [2 /*return*/, rendered];
                 }
             });
         });
@@ -3069,13 +3103,15 @@ var RelationRenderEngine;
                         entity: params.fromEntity,
                         viewer: params.viewer,
                         visualRegister: params.visualRegister,
-                        heightReference: HeightReference.NONE
+                        returnHeightRef: HeightReference.NONE,
+                        recordHeightRef: HeightReference.CLAMP_TO_GROUND
                     });
                     toPos = EntityUtils.GetPos({
                         entity: params.toEntity,
                         viewer: params.viewer,
                         visualRegister: params.visualRegister,
-                        heightReference: HeightReference.NONE
+                        returnHeightRef: HeightReference.NONE,
+                        recordHeightRef: HeightReference.CLAMP_TO_GROUND
                     });
                 }
                 catch (e) {
@@ -7048,6 +7084,8 @@ function renderDefaultTerrTile(id) {
             provider = new CesiumTerrainProvider({
                 url: "https://s3-ap-southeast-2.amazonaws.com/digitalnewzealand/PROD/Tilesets/nz-dem",
                 requestVertexNormals: true,
+                requestWaterMask: false,
+                requestMetadata: false
             });
             break;
     }