bruce-cesium 7.7.1 → 7.7.3

package/dist/bruce-cesium.es5.js

@@ -1,6 +1,6 @@
 import * as Cesium from 'cesium';
-import { Cartographic, ColorMaterialProperty, Entity, Color, ConstantProperty, CallbackProperty, Primitive, Cesium3DTileFeature, ShaderSource, Cartesian3, Math as Math$1, Ellipsoid, Transforms, Matrix4, Geometry, GeometryAttribute, ComponentDatatype, PrimitiveType, BoundingSphere, GeometryPipeline, Cartesian2, Cartesian4, sampleTerrain, Texture, PixelFormat, Sampler, TextureWrap, TextureMinificationFilter, TextureMagnificationFilter, PixelDatatype, VertexArray, BufferUsage, ShaderProgram, RenderState, BlendingState, DrawCommand, Pass, HeightReference, ColorBlendMode, HeadingPitchRoll, ShadowMode, ClassificationType, Model, HorizontalOrigin, VerticalOrigin, ConstantPositionProperty, DistanceDisplayCondition, JulianDate, Quaternion, ArcType, CornerType, SceneMode, IntersectionTests, Ray, SceneTransforms, ImageMaterialProperty, PolygonHierarchy, PolylineGraphics, Rectangle, FeatureDetection, Matrix3, NearFarScalar, KmlDataSource, GeoJsonDataSource, Cesium3DTileStyle, HeadingPitchRange, Cesium3DTileColorBlendMode, Ion, IonResource, Cesium3DTileset, OrthographicFrustum, EasingFunction, Intersect, EllipsoidTerrainProvider, IonImageryProvider, createWorldImagery, createWorldImageryAsync, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, CesiumTerrainProvider, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, EllipsoidGeodesic, sampleTerrainMostDetailed, defined, CustomDataSource, PolygonPipeline, CesiumInspector, ClockRange, DynamicEnvironmentMapManager, GeometryInstance, ScreenSpaceEventHandler, ScreenSpaceEventType, Fullscreen, CzmlDataSource } from 'cesium';
-import { Cartes, LRUCache, Carto, ProjectViewTile, EntityHistoricData, BruceEvent, DelayQueue, Entity as Entity$1, EntityTag, ClientFile, ENVIRONMENT, EntityAttachmentType, EntityRelationType, EntityType, Tileset, Calculator, DataLab, Style, ObjectUtils, MenuItem, AccountConcept, RecordChangeFeed, EntityLod, UrlUtils, Api, Geometry as Geometry$1, ClientFileValueMap, Color as Color$1, ProjectView, ProjectViewBookmark, ZoomControl, Bounds, Assembly, EntityCoords, BruceApi, EntityRelation, EntitySource, Camera, ProgramKey, ProjectViewLegacyTile, Account, AccountLimits, Session, EntityAttachment, EntityAttribute, MathUtils, ProjectViewBookmarkGroup } from 'bruce-models';
+import { Cartographic, ColorMaterialProperty, Entity, Color, ConstantProperty, CallbackProperty, Primitive, Cesium3DTileFeature, ShaderSource, Cartesian3, Math as Math$1, Ellipsoid, Transforms, Matrix4, Geometry, GeometryAttribute, ComponentDatatype, PrimitiveType, BoundingSphere, GeometryPipeline, Cartesian2, Cartesian4, sampleTerrain, Texture, PixelFormat, Sampler, TextureWrap, TextureMinificationFilter, TextureMagnificationFilter, PixelDatatype, VertexArray, BufferUsage, ShaderProgram, RenderState, BlendingState, DrawCommand, Pass, ConstantPositionProperty, HeightReference, DistanceDisplayCondition, JulianDate, Quaternion, HeadingPitchRoll, ColorBlendMode, ShadowMode, ClassificationType, Model, HorizontalOrigin, VerticalOrigin, ArcType, CornerType, ImageMaterialProperty, PolygonHierarchy, PolylineGraphics, Rectangle, SceneMode, IntersectionTests, Ray, SceneTransforms, FeatureDetection, Matrix3, NearFarScalar, KmlDataSource, GeoJsonDataSource, Cesium3DTileStyle, HeadingPitchRange, Cesium3DTileColorBlendMode, Ion, IonResource, Cesium3DTileset, OrthographicFrustum, EasingFunction, EllipsoidTerrainProvider, IonImageryProvider, createWorldImagery, createWorldImageryAsync, BingMapsImageryProvider, BingMapsStyle, MapboxImageryProvider, MapboxStyleImageryProvider, ArcGisMapServerImageryProvider, OpenStreetMapImageryProvider, UrlTemplateImageryProvider, GridImageryProvider, GeographicTilingScheme, ImageryLayer, TileMapServiceImageryProvider, CesiumTerrainProvider, Intersect, ModelGraphics, PolygonGraphics, CorridorGraphics, PointGraphics, BillboardGraphics, EllipseGraphics, PolylineDashMaterialProperty, EllipsoidGeodesic, sampleTerrainMostDetailed, defined, CustomDataSource, GeometryInstance, PolygonPipeline, CesiumInspector, ClockRange, DynamicEnvironmentMapManager, ScreenSpaceEventHandler, ScreenSpaceEventType, Fullscreen, CzmlDataSource } from 'cesium';
+import { Cartes, LRUCache, Carto, ProjectViewTile, EntityHistoricData, BruceEvent, DelayQueue, Entity as Entity$1, EntityTag, ClientFile, ENVIRONMENT, EntityAttachmentType, EntityRelationType, EntityType, Tileset, Calculator, DataLab, Style, ObjectUtils, MenuItem, AccountConcept, RecordChangeFeed, EntityLod, UrlUtils, Api, Geometry as Geometry$1, Bounds, ClientFileValueMap, Color as Color$1, ProjectView, ProjectViewBookmark, ZoomControl, Assembly, EntityCoords, BruceApi, EntityRelation, EntitySource, Camera, ProgramKey, ProjectViewLegacyTile, Account, AccountLimits, Session, EntityAttachment, EntityAttribute, MathUtils, ProjectViewBookmarkGroup } from 'bruce-models';
 
 /**
  * Ensures a number is returned from a given value.
@@ -45593,6 +45593,45 @@ function calcAssemblyRootFrame(entity, modelSpace) {
     const hpr = HeadingPitchRoll.fromDegrees(EnsureNumber(transform.heading), EnsureNumber(transform.pitch), EnsureNumber(transform.roll));
     return Matrix4.multiply(frame, Matrix4.fromRotation(Matrix3.fromHeadingPitchRoll(hpr)), frame);
 }
+// Assembly parts are always drawn at the heights their records hold.
+const ASSEMBLY_HEIGHT_REFS = {
+    point: HeightReference.NONE,
+    polyline: HeightReference.NONE,
+    polygon: HeightReference.NONE
+};
+/*
+ * Reads how an Entity Type's default Style draws its records, or null when the type cannot be read.
+ */
+async function getStyledHeightRefs(api, entityTypeId) {
+    var _a, _b;
+    let styleId;
+    try {
+        const { entityType } = await EntityType.Get({ api, entityTypeId });
+        if (!entityType) {
+            return null;
+        }
+        styleId = entityType["DisplaySetting.ID"];
+    }
+    catch (e) {
+        console.error(e);
+        return null;
+    }
+    let settings = {};
+    if (styleId && styleId > 0) {
+        try {
+            settings = ((_b = (_a = (await Style.Get({ api, styleId })).style) === null || _a === void 0 ? void 0 : _a.Settings) !== null && _b !== void 0 ? _b : {});
+        }
+        catch (e) {
+            // A deleted Style leaves the records drawn with the defaults, as the render engines do.
+            console.error(e);
+        }
+    }
+    return {
+        point: EntityRenderEngine.GetHeightRef(settings.pointStyle),
+        polyline: EntityRenderEngine.GetHeightRefPolyline(EntityRenderEngine.GetHeightRef(settings.polylineStyle)),
+        polygon: EntityRenderEngine.GetHeightRef(settings.polygonStyle)
+    };
+}
 // Records created within about this long ago are the ones the oversized GeometryRadius bug could have written.
 const GEOMETRY_RADIUS_SUSPECT_AGE_MS = 1000 * 60 * 60 * 24 * 183;
 // Above this a recent record's radius is treated as that bug rather than a real size.
@@ -46029,6 +46068,44 @@ var EntityUtils;
             }
             return [];
         };
+        // Entity Type ID -> how its default Style draws each kind of geometry, read once per call.
+        const styledRefs = new Map();
+        /*
+         * How the scene would draw an undrawn record's geometry, or null to fall back to the sample's heightRef.
+         */
+        const getStyledRefs = (entity) => {
+            var _a, _b, _c;
+            // Assembly parts are drawn at absolute heights whatever their type's Style says, read with a root or not.
+            if (((_a = entity === null || entity === void 0 ? void 0 : entity.Bruce) === null || _a === void 0 ? void 0 : _a.AssemblyPosition) || ((_b = entity === null || entity === void 0 ? void 0 : entity.Bruce) === null || _b === void 0 ? void 0 : _b.AssemblyRootLocation)) {
+                return Promise.resolve(ASSEMBLY_HEIGHT_REFS);
+            }
+            const typeId = (_c = entity === null || entity === void 0 ? void 0 : entity.Bruce) === null || _c === void 0 ? void 0 : _c["EntityType.ID"];
+            if (!api || !typeId) {
+                return Promise.resolve(null);
+            }
+            if (!styledRefs.has(typeId)) {
+                styledRefs.set(typeId, getStyledHeightRefs(api, typeId));
+            }
+            return styledRefs.get(typeId);
+        };
+        /*
+         * Makes a record's positions absolute as a Style draws them, sampling terrain as none may be loaded there.
+         */
+        const placeStyled = async (posses, heightRef, sample) => {
+            if (heightRef != HeightReference.NONE) {
+                for (let i = 0; i < posses.length; i++) {
+                    const carto = Cartographic.fromCartesian(posses[i]);
+                    if (!carto) {
+                        continue;
+                    }
+                    const { height: terrainHeight } = await DrawingUtils.GetTerrainHeight({ pos3d: posses[i], viewer });
+                    const ground = EnsureNumber(terrainHeight, 0);
+                    carto.height = heightRef == HeightReference.CLAMP_TO_GROUND ? ground : carto.height + ground;
+                    posses[i] = Cartographic.toCartesian(carto);
+                }
+            }
+            await ensureHeightRefs(posses, { ...sample, heightRef: HeightReference.NONE });
+        };
         /**
          * Returns an array of positions for a given sampled entity.
          * This will include the location, and geometry positions.
@@ -46043,6 +46120,9 @@ var EntityUtils;
              */
             const evaluateRecord = async () => {
                 let posses = [];
+                const refs = await getStyledRefs(entity);
+                // The record's own point, kept apart so a Style can say what its altitude means.
+                const pointPosses = [];
                 const location = Entity$1.GetValue({
                     entity: entity,
                     path: ["Bruce", "Location"]
@@ -46053,7 +46133,7 @@ var EntityUtils;
                     // Disallowing 0.
                     if (latitude && longitude) {
                         const pos3d = Cartesian3.fromDegrees(longitude, latitude, EnsureNumber(location.altitude));
-                        posses.push(pos3d);
+                        pointPosses.push(pos3d);
                     }
                 }
                 const geometry = Entity$1.GetValue({
@@ -46069,7 +46149,7 @@ var EntityUtils;
                         const point = points.length > 0 ? points[0] : null;
                         if (point && Carto.ValidateCarto(point)) {
                             const pos3d = Cartesian3.fromDegrees(EnsureNumber(point.longitude), EnsureNumber(point.latitude), EnsureNumber(point.altitude));
-                            posses.push(pos3d);
+                            pointPosses.push(pos3d);
                         }
                     }
                     const lineStr = geometry.LineString;
@@ -46077,7 +46157,12 @@ var EntityUtils;
                         const points = Geometry$1.ParsePoints(lineStr);
                         if (points.length > 0) {
                             const pPosses = points.map(x => Cartesian3.fromDegrees(EnsureNumber(x.longitude), EnsureNumber(x.latitude), EnsureNumber(x.altitude)));
-                            await ensureHeightRefs(pPosses, sample);
+                            if (refs) {
+                                await placeStyled(pPosses, refs.polyline, sample);
+                            }
+                            else {
+                                await ensureHeightRefs(pPosses, sample);
+                            }
                             posses = posses.concat(pPosses);
                         }
                     }
@@ -46087,7 +46172,12 @@ var EntityUtils;
                         if (boundary === null || boundary === void 0 ? void 0 : boundary.LinearRing) {
                             const points = Geometry$1.ParsePoints(boundary.LinearRing);
                             const pPosses = points.map(x => Cartesian3.fromDegrees(EnsureNumber(x.longitude), EnsureNumber(x.latitude), EnsureNumber(x.altitude)));
-                            await ensureHeightRefs(pPosses, sample);
+                            if (refs) {
+                                await placeStyled(pPosses, refs.polygon, sample);
+                            }
+                            else {
+                                await ensureHeightRefs(pPosses, sample);
+                            }
                             posses = posses.concat(pPosses);
                         }
                     }
@@ -46108,11 +46198,22 @@ var EntityUtils;
                             Cartesian3.fromDegrees(EnsureNumber(boundaries.minLongitude), EnsureNumber(boundaries.minLatitude), EnsureNumber(boundaries.minAltitude)),
                             Cartesian3.fromDegrees(EnsureNumber(boundaries.maxLongitude), EnsureNumber(boundaries.maxLatitude), EnsureNumber(boundaries.maxAltitude))
                         ];
-                        await ensureHeightRefs(bPosses, sample);
+                        if (refs) {
+                            // The bounds span the record's main geometry, so they are drawn the way it is.
+                            const boundsRef = (geometry === null || geometry === void 0 ? void 0 : geometry.Polygon) ? refs.polygon : (geometry === null || geometry === void 0 ? void 0 : geometry.LineString) ? refs.polyline : refs.point;
+                            await placeStyled(bPosses, boundsRef, sample);
+                        }
+                        else {
+                            await ensureHeightRefs(bPosses, sample);
+                        }
                         posses = posses.concat(bPosses);
                     }
                 }
-                return posses;
+                if (refs) {
+                    await placeStyled(pointPosses, refs.point, sample);
+                }
+                // Points first, since a lone record is placed by its first position.
+                return pointPosses.concat(posses);
             };
             if (isAssemblyEntity) {
                 // See if we have tileset coords to use.
@@ -46271,6 +46372,8 @@ var EntityUtils;
                 sample.entity = (_e = simulation === null || simulation === void 0 ? void 0 : simulation.GetEntity(sample.entityId)) !== null && _e !== void 0 ? _e : sample.entity;
             }
         }
+        // Read here at the scene's time with their location; records a caller supplied may be of another time.
+        const readHere = new Set();
         // Bulk requesting Entity records.
         try {
             const toSearchIds = recordSamples.filter(x => !x.entity && x.entityId).map(x => x.entityId);
@@ -46292,6 +46395,9 @@ var EntityUtils;
                     const sample = recordSamples[i];
                     if (!sample.entity && sample.entityId) {
                         const read = entitiesMap.get(sample.entityId);
+                        if (read) {
+                            readHere.add(sample.entityId);
+                        }
                         sample.entity = read && simulation ? simulation.Overlay(read) : read;
                     }
                 }
@@ -46302,10 +46408,10 @@ var EntityUtils;
         catch (e) {
             console.error(e);
         }
-        // Some records may still not be expanded.
-        // We have to detect whatever is an Assembly Entity and expand it.
+        // Assembly parts not read above with a location expand still need one, and the ones off the scene are dropped
+        // when others are in it, since category nodes without geometry would otherwise pull the result elsewhere.
         try {
-            const needsExpansion = recordSamples.filter(x => {
+            const assemblySamples = recordSamples.filter(x => {
                 var _a;
                 // Expanding reads the API's record, which would replace the stand-in or undo the patch.
                 if (simulation === null || simulation === void 0 ? void 0 : simulation.HasBlob((_a = x.entity.Bruce) === null || _a === void 0 ? void 0 : _a.ID)) {
@@ -46315,36 +46421,30 @@ var EntityUtils;
                     entity: x.entity,
                     path: ["Bruce", "AssemblyPosition"]
                 });
-                if (!assemblyPos) {
-                    return false;
-                }
-                const rootPos = Entity$1.GetValue({
-                    entity: x.entity,
-                    path: ["Bruce", "AssemblyRootPosition"]
-                });
-                return !rootPos;
+                return !!assemblyPos;
             });
+            const isInScene = (sample) => {
+                var _a;
+                return !!(visualRegister && visualRegister.GetRego({
+                    entityId: (_a = sample.entityId) !== null && _a !== void 0 ? _a : sample.entity.Bruce.ID,
+                    menuItemId: sample.menuItemId
+                }));
+            };
+            const sceneSamples = assemblySamples.filter(isInScene);
+            const offSceneSamples = sceneSamples.length ? assemblySamples.filter(x => !isInScene(x)) : [];
+            if (offSceneSamples.length) {
+                const offSceneIds = new Set(offSceneSamples.map(x => x.entity.Bruce.ID));
+                recordSamples = recordSamples.filter(x => !offSceneIds.has(x.entity.Bruce.ID));
+            }
+            const keptSamples = sceneSamples.length ? sceneSamples : assemblySamples;
+            const needsExpansion = keptSamples.filter(x => !readHere.has(x.entity.Bruce.ID) || !Entity$1.GetValue({
+                entity: x.entity,
+                path: ["Bruce", "AssemblyRootLocation"]
+            }));
             if (needsExpansion.length) {
                 const EXPAND_BATCH_SIZE = 30;
                 const EXPAND_MAX_IDS = 200;
-                // Figure out if any are in the scene.
-                // Helps us sort leaf-nodes away from category nodes thta don't have geometry.
-                const isInScene = (sample) => {
-                    var _a;
-                    return !!(visualRegister && visualRegister.GetRego({
-                        entityId: (_a = sample.entityId) !== null && _a !== void 0 ? _a : sample.entity.Bruce.ID,
-                        menuItemId: sample.menuItemId
-                    }));
-                };
-                // Trim to max 200 with a preference to those in the scene.
-                const sceneSamples = needsExpansion.filter(isInScene);
-                const offSceneSamples = sceneSamples.length ? needsExpansion.filter(x => !isInScene(x)) : [];
-                if (offSceneSamples.length) {
-                    const offSceneIds = new Set(offSceneSamples.map(x => x.entity.Bruce.ID));
-                    recordSamples = recordSamples.filter(x => !offSceneIds.has(x.entity.Bruce.ID));
-                }
-                const effectiveSamples = sceneSamples.length ? sceneSamples : needsExpansion;
-                const uniqueIds = Array.from(new Set(effectiveSamples.map(x => x.entity.Bruce.ID)));
+                const uniqueIds = Array.from(new Set(needsExpansion.map(x => x.entity.Bruce.ID)));
                 const expandIds = uniqueIds.slice(0, EXPAND_MAX_IDS);
                 // Anything we didn't expand will taint the overall result so we have to filter them out.
                 const droppedIds = new Set(uniqueIds.slice(EXPAND_MAX_IDS));
@@ -46373,8 +46473,8 @@ var EntityUtils;
                         expandedMap.set(entities[i].Bruce.ID, entities[i]);
                     }
                 }
-                for (let i = 0; i < effectiveSamples.length; i++) {
-                    const sample = effectiveSamples[i];
+                for (let i = 0; i < needsExpansion.length; i++) {
+                    const sample = needsExpansion[i];
                     const expanded = expandedMap.get(sample.entity.Bruce.ID);
                     if (expanded) {
                         sample.entity = expanded;
@@ -57167,7 +57267,7 @@ var StyleUtils;
     StyleUtils.ApplyTypeStyle = ApplyTypeStyle;
 })(StyleUtils || (StyleUtils = {}));
 
-const VERSION = "7.7.1";
+const VERSION = "7.7.3";
 /**
  * Updates the environment instance used by bruce-cesium to one specified.
  * This can be used to ensure that the instance a parent is referencing is shared between bruce-cesium, bruce-models, and the parent app.