bruce-cesium 0.0.2 → 0.0.3

package/dist/bruce-cesium.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('bruce-models'), require('cesium')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'bruce-models', 'cesium'], factory) :
-    (factory((global.bruceCesium = {}),global.bruceModels,global.Cesium));
-}(this, (function (exports,bruceModels,Cesium) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('cesium'), require('bruce-models')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'cesium', 'bruce-models'], factory) :
+    (factory((global.bruceCesium = {}),global.Cesium,global.bruceModels));
+}(this, (function (exports,Cesium,bruceModels) { 'use strict';
 
     var TIME_LAG = 300;
     var POSITION_CHECK_TIMER = 950;
@@ -75,6 +75,9 @@
     function arePosEqual(a, b) {
         return a.latitude == b.latitude && a.longitude == b.longitude;
     }
+    /**
+     * Monitors and emits events when the Cesium view changes.
+     */
     var CesiumViewMonitor = /** @class */ (function () {
         function CesiumViewMonitor(viewer) {
             var _this = this;
@@ -221,6 +224,12 @@
     }());
 
     (function (ViewerUtils) {
+        /**
+         * Creates a Cesium viewer in a given HTML container and returns it.
+         * This will kill all widgets in the process.
+         * @param container
+         * @returns
+         */
         function InitViewer(container) {
             if (container._cViewer) {
                 throw new Error("Container already has a viewer.");
@@ -254,6 +263,10 @@
             }
         }
         ViewerUtils.DestroyWidget = DestroyWidget;
+        /**
+         * Hides all unnecessary elements from the Cesium viewer container.
+         * @param viewer
+         */
         function StyleContainer(viewer) {
             var _a;
             var container = viewer.container;
@@ -356,6 +369,14 @@
 
     var DrawingUtils;
     (function (DrawingUtils) {
+        /**
+         * Returns the point across a polyline at a given distance.
+         * If the distance exceeds the length of the line, the point will be placed at the end of the line.
+         * @param viewer
+         * @param positions
+         * @param distance
+         * @returns
+         */
         function PointAcrossPolyline(viewer, positions, distance) {
             if (positions.length > 1) {
                 var currentDistance = 0;
@@ -387,6 +408,12 @@
 
     var MeasureUtils;
     (function (MeasureUtils) {
+        /**
+         * Returns the total distance in meters between an array of points.
+         * This distance is NOT following the terrain.
+         * @param posses
+         * @returns
+         */
         function MeasurePolyline(posses) {
             if (posses.length < 2) {
                 return 0;
@@ -410,8 +437,27 @@
         MeasureUtils.MeasurePolyline = MeasurePolyline;
     })(MeasureUtils || (MeasureUtils = {}));
 
+    function traverseEntity(cEntity, arr) {
+        if (cEntity._parentEntity) {
+            traverseEntity(cEntity._parentEntity, arr);
+        }
+        if (cEntity._siblingGraphics) {
+            for (var i = 0; i < cEntity._siblingGraphics.length; i++) {
+                var sibling = cEntity._siblingGraphics[i];
+                traverseEntity(sibling, arr);
+            }
+        }
+        arr.push(cEntity);
+    }
     var EntityUtils;
     (function (EntityUtils) {
+        /**
+         * Returns an entity's position.
+         * This will attempt to calculate it from multiple sources of data.
+         * @param viewer
+         * @param entity
+         * @returns
+         */
         function GetPos(viewer, entity) {
             if (entity.location && bruceModels.Carto.ValidateCarto(entity.location)) {
                 var location_1 = entity.location;
@@ -468,6 +514,20 @@
             return null;
         }
         EntityUtils.GetPos = GetPos;
+        /**
+         * Returns entity and any associated parent/sibling entities as a flat array.
+         * @param entity
+         */
+        function GatherEntity(entity) {
+            if (entity instanceof Cesium.Entity) {
+                var cEntity = entity;
+                var items = [];
+                traverseEntity(cEntity, items);
+                return items;
+            }
+            return [entity];
+        }
+        EntityUtils.GatherEntity = GatherEntity;
     })(EntityUtils || (EntityUtils = {}));
 
     (function (RenderManager) {
@@ -1394,7 +1454,7 @@
                                             this.visualsManager.Add({
                                                 entityId: id,
                                                 menuItemId: this.item.id,
-                                                visuals: [cEntity],
+                                                visual: cEntity,
                                                 priority: 0
                                             });
                                         }
@@ -1486,7 +1546,7 @@
                                             this.visualsManager.Add({
                                                 entityId: id,
                                                 menuItemId: this.item.id,
-                                                visuals: [cEntity],
+                                                visual: cEntity,
                                                 priority: 0
                                             });
                                         }
@@ -1505,6 +1565,221 @@
         EntitiesLoadedRenderManager.Manager = Manager;
     })(exports.EntitiesLoadedRenderManager || (exports.EntitiesLoadedRenderManager = {}));
 
+    function removeEntity(viewer, visual) {
+        unmarkEntity(visual);
+        if (visual instanceof Cesium.Entity) {
+            exports.EntityRenderEngine.Remove(viewer, visual);
+        }
+        else if (visual instanceof Cesium.Primitive) {
+            if (viewer.scene.primitives.contains(visual)) {
+                viewer.scene.primitives.remove(visual);
+            }
+        }
+        else if (visual instanceof Cesium.Cesium3DTileFeature) {
+            // No way to tell if changing show will crash it!
+            try {
+                visual.show = false;
+            }
+            catch (e) {
+                console.error(e);
+            }
+        }
+    }
+    function updateCEntityShow(viewer, visual, show) {
+        if (visual._parentEntity) {
+            updateCEntityShow(viewer, visual._parentEntity, show);
+        }
+        if (visual._siblingGraphics) {
+            for (var i = 0; i < visual._siblingGraphics.length; i++) {
+                var sibling = visual._siblingGraphics[i];
+                updateCEntityShow(viewer, sibling, show);
+            }
+        }
+        if (viewer.entities.contains(visual)) {
+            visual.show = show;
+        }
+    }
+    function updateEntityShow(viewer, visual, show) {
+        if (visual instanceof Cesium.Entity) {
+            updateCEntityShow(viewer, visual, show);
+        }
+        else if (visual instanceof Cesium.Primitive) {
+            if (viewer.scene.primitives.contains(visual)) {
+                visual.show = show;
+            }
+        }
+        else if (visual instanceof Cesium.Cesium3DTileFeature) {
+            // No way to tell if changing show will crash it!
+            try {
+                visual.show = show;
+            }
+            catch (e) {
+                console.error(e);
+            }
+        }
+    }
+    function updateEntity(viewer, entityRegos) {
+        var highestPriority = null;
+        for (var i = 0; i < entityRegos.length; i++) {
+            var rego = entityRegos[i];
+            if (highestPriority === null || rego.priority > highestPriority.priority) {
+                highestPriority = rego;
+            }
+        }
+        for (var i = 0; i < entityRegos.length; i++) {
+            var rego = entityRegos[i];
+            updateEntityShow(viewer, rego.visual, rego === highestPriority);
+        }
+    }
+    function markEntity(register, rego, visual) {
+        var vis = visual;
+        vis._register = register;
+        vis._rego = rego;
+        if (visual instanceof Cesium.Entity) {
+            var visEnt = visual;
+            if (visEnt._parentEntity) {
+                markEntity(register, rego, visEnt._parentEntity);
+            }
+            if (visEnt._siblingGraphics) {
+                for (var i = 0; i < visEnt._siblingGraphics.length; i++) {
+                    markEntity(register, rego, visEnt._siblingGraphics[i]);
+                }
+            }
+        }
+    }
+    function unmarkEntity(visual) {
+        var vis = visual;
+        vis._register = null;
+        if (visual instanceof Cesium.Entity) {
+            var visEnt = visual;
+            if (visEnt._parentEntity) {
+                unmarkEntity(visEnt._parentEntity);
+            }
+            if (visEnt._siblingGraphics) {
+                for (var i = 0; i < visEnt._siblingGraphics.length; i++) {
+                    unmarkEntity(visEnt._siblingGraphics[i]);
+                }
+            }
+        }
+    }
+    (function (VisualsRegister) {
+        var Register = /** @class */ (function () {
+            function Register(viewer) {
+                this.id = bruceModels.ObjectUtils.UId();
+                this.rego = {};
+                this.onUpdate = null;
+                this.viewer = viewer;
+            }
+            Object.defineProperty(Register.prototype, "Id", {
+                get: function () {
+                    return this.id;
+                },
+                enumerable: false,
+                configurable: true
+            });
+            Object.defineProperty(Register.prototype, "OnUpdate", {
+                get: function () {
+                    return this.onUpdate;
+                },
+                enumerable: false,
+                configurable: true
+            });
+            Register.prototype.Add = function (rego) {
+                var _a, _b;
+                this.Remove(rego.entityId, rego.menuItemId, false);
+                var entityId = rego.entityId;
+                var entityRegos = (_a = this.rego[entityId]) !== null && _a !== void 0 ? _a : [];
+                entityRegos.push(rego);
+                this.rego[entityId] = entityRegos;
+                markEntity(this, rego, rego.visual);
+                updateEntity(this.viewer, this.rego[entityId]);
+                (_b = this.onUpdate) === null || _b === void 0 ? void 0 : _b.Trigger({ rego: rego, isAdding: true });
+            };
+            Register.prototype.GetVisuals = function (entityId, menuItemId) {
+                var _a;
+                var entityRegos = this.rego[entityId];
+                if (!entityRegos) {
+                    return [];
+                }
+                var visuals = (_a = entityRegos.find(function (r) { return r.menuItemId === menuItemId; })) === null || _a === void 0 ? void 0 : _a.visual;
+                return visuals !== null && visuals !== void 0 ? visuals : [];
+            };
+            Register.prototype.RemoveByEntityId = function (id) {
+                var _a;
+                var entityRegos = this.rego[id];
+                if (!entityRegos) {
+                    return;
+                }
+                for (var i = 0; i < entityRegos.length; i++) {
+                    var rego = entityRegos[i];
+                    (_a = this.onUpdate) === null || _a === void 0 ? void 0 : _a.Trigger({ rego: rego, isAdding: false });
+                    removeEntity(this.viewer, rego.visual);
+                }
+                this.rego[id] = [];
+                delete this.rego[id];
+            };
+            Register.prototype.RemoveByMenuItemId = function (id) {
+                var _a;
+                for (var entityId in this.rego) {
+                    var entityRegos = this.rego[entityId];
+                    if (entityRegos) {
+                        var rego = entityRegos.find(function (r) { return r.menuItemId === id; });
+                        if (!rego) {
+                            continue;
+                        }
+                        (_a = this.onUpdate) === null || _a === void 0 ? void 0 : _a.Trigger({ rego: rego, isAdding: false });
+                        removeEntity(this.viewer, rego.visual);
+                        var doesInclude = this.rego[entityId].find(function (r) { return r.menuItemId === id; });
+                        if (doesInclude) {
+                            this.rego[entityId] = entityRegos.filter(function (r) { return r.menuItemId !== id; });
+                            updateEntity(this.viewer, this.rego[entityId]);
+                        }
+                    }
+                }
+            };
+            Register.prototype.Remove = function (entityId, menuItemId, _doUpdate) {
+                var _a;
+                if (_doUpdate === void 0) { _doUpdate = true; }
+                var entityRegos = this.rego[entityId];
+                if (!entityRegos) {
+                    return;
+                }
+                var rego = entityRegos.find(function (r) { return r.menuItemId === menuItemId; });
+                if (!rego) {
+                    return;
+                }
+                (_a = this.onUpdate) === null || _a === void 0 ? void 0 : _a.Trigger({ rego: rego, isAdding: false });
+                removeEntity(this.viewer, rego.visual);
+                this.rego[entityId] = entityRegos.filter(function (r) { return r.menuItemId !== menuItemId; });
+                if (_doUpdate) {
+                    updateEntity(this.viewer, this.rego[entityId]);
+                }
+            };
+            /**
+             * Returns an array of drilled visuals associated with this register.
+             * The top array item is the first found.
+             * @param cursor
+             * @returns
+             */
+            Register.prototype.GetFromCursor = function (cursor) {
+                var _a;
+                var found = [];
+                var picked = this.viewer.scene.drillPick(new Cesium.Cartesian2(cursor.x, cursor.y), 5);
+                for (var i = 0; i < picked.length; i++) {
+                    var object = picked[i];
+                    var entity = (object && object.id && object.id instanceof Cesium.Entity ? object.id : object);
+                    var visual = entity;
+                    if (((_a = visual === null || visual === void 0 ? void 0 : visual._register) === null || _a === void 0 ? void 0 : _a.Id) == this.id) {
+                        found.push(visual._rego);
+                    }
+                }
+                return found;
+            };
+            return Register;
+        }());
+        VisualsRegister.Register = Register;
+    })(exports.VisualsRegister || (exports.VisualsRegister = {}));
+
     (function (EntitiesIdsRenderManager) {
         var Manager = /** @class */ (function () {
             function Manager(viewer, visualsManager, api, item) {
@@ -1581,7 +1856,7 @@
                                             this.visualsManager.Add({
                                                 entityId: id,
                                                 menuItemId: this.item.id,
-                                                visuals: [cEntity],
+                                                visual: cEntity,
                                                 priority: 0
                                             });
                                         }
@@ -1672,7 +1947,7 @@
                                         this.visualsManager.Add({
                                             entityId: entity.Bruce.ID,
                                             menuItemId: this.item.id,
-                                            visuals: [cEntity],
+                                            visual: cEntity,
                                             priority: 0
                                         });
                                     }
@@ -2080,7 +2355,7 @@
                 var bColor = (((_a = style.modelStyle) === null || _a === void 0 ? void 0 : _a.fillColor) ? bruceModels.Calculator.GetValue(style.modelStyle.fillColor, data, []) : null);
                 if (bColor != null) {
                     var cColor = colorToCColor$1(bColor);
-                    var visual = entity.visuals.length > 0 ? entity.visuals[0] : null;
+                    var visual = entity.visual;
                     if (visual && visual instanceof Cesium.Cesium3DTileFeature) {
                         visual.color = cColor;
                     }
@@ -2203,7 +2478,7 @@
                     entityTypeId: null,
                     menuItemId: this.item.id,
                     priority: 0,
-                    visuals: [feature]
+                    visual: feature
                 };
                 if (version == 1) {
                     var pathStr = feature.getProperty("BrucePath");
@@ -2304,12 +2579,32 @@
         TilesetCadRenderManager.Manager = Manager;
     })(exports.TilesetCadRenderManager || (exports.TilesetCadRenderManager = {}));
 
+    /**
+     * Utility to keep track of enabled menu items within a Cesium viewer.
+     */
     var MenuItemManager = /** @class */ (function () {
         function MenuItemManager(viewer, visualsRegister) {
             this.items = [];
             this.viewer = viewer;
+            if (!visualsRegister) {
+                visualsRegister = new exports.VisualsRegister.Register(viewer);
+            }
             this.visualsRegister = visualsRegister;
         }
+        Object.defineProperty(MenuItemManager.prototype, "VisualsRegister", {
+            get: function () {
+                return this.visualsRegister;
+            },
+            enumerable: false,
+            configurable: true
+        });
+        /**
+         * Renders a given menu item and all ids children.
+         * Will return the enabled item id.
+         * @param api
+         * @param item
+         * @returns
+         */
         MenuItemManager.prototype.RenderItem = function (api, item) {
             var _a;
             return __awaiter(this, void 0, void 0, function () {
@@ -2384,6 +2679,11 @@
                 });
             });
         };
+        /**
+         * Disables a menu item by ids id.
+         * This will disable all children as well.
+         * @param id
+         */
         MenuItemManager.prototype.RemoveItemById = function (id) {
             return __awaiter(this, void 0, void 0, function () {
                 var item, _loop_1, this_1, i;
@@ -2564,201 +2864,8 @@
         RenderHelper.RenderTileset = RenderTileset;
     })(exports.RenderHelper || (exports.RenderHelper = {}));
 
-    function removeEntity(viewer, visuals) {
-        unmarkEntity(visuals);
-        for (var i = 0; i < visuals.length; i++) {
-            var visual = visuals[i];
-            if (visual instanceof Cesium.Entity) {
-                exports.EntityRenderEngine.Remove(viewer, visual);
-            }
-            else if (visual instanceof Cesium.Primitive) {
-                viewer.scene.primitives.remove(visual);
-            }
-            else if (visual instanceof Cesium.Cesium3DTileFeature) {
-                visual.show = false;
-            }
-        }
-    }
-    function updateCEntityShow(viewer, visual, show) {
-        if (visual._parentEntity) {
-            updateCEntityShow(viewer, visual._parentEntity, show);
-        }
-        if (visual._siblingGraphics) {
-            for (var i = 0; i < visual._siblingGraphics.length; i++) {
-                var sibling = visual._siblingGraphics[i];
-                updateCEntityShow(viewer, sibling, show);
-            }
-        }
-        visual.show = show;
-    }
-    function updateEntityShow(viewer, visual, show) {
-        if (visual instanceof Cesium.Entity) {
-            updateCEntityShow(viewer, visual, show);
-        }
-        else if (visual instanceof Cesium.Primitive) {
-            visual.show = show;
-        }
-        else if (visual instanceof Cesium.Cesium3DTileFeature) {
-            visual.show = show;
-        }
-    }
-    function updateEntity(viewer, entityRegos) {
-        var highestPriority = null;
-        for (var i = 0; i < entityRegos.length; i++) {
-            var rego = entityRegos[i];
-            if (highestPriority === null || rego.priority > highestPriority.priority) {
-                highestPriority = rego;
-            }
-        }
-        for (var i = 0; i < entityRegos.length; i++) {
-            var rego = entityRegos[i];
-            for (var j = 0; j < rego.visuals.length; j++) {
-                var visual = rego.visuals[j];
-                updateEntityShow(viewer, visual, rego === highestPriority);
-            }
-        }
-    }
-    function markEntity(register, rego, visuals) {
-        for (var i = 0; i < visuals.length; i++) {
-            var visual = visuals[i];
-            var vis = visual;
-            vis._register = register;
-            vis._rego = rego;
-            if (visual instanceof Cesium.Entity) {
-                var visEnt = visual;
-                if (visEnt._parentEntity) {
-                    markEntity(register, rego, [visEnt._parentEntity]);
-                }
-                if (visEnt._siblingGraphics) {
-                    markEntity(register, rego, visEnt._siblingGraphics);
-                }
-            }
-        }
-    }
-    function unmarkEntity(visuals) {
-        for (var i = 0; i < visuals.length; i++) {
-            var visual = visuals[i];
-            var vis = visual;
-            vis._register = null;
-            if (visual instanceof Cesium.Entity) {
-                var visEnt = visual;
-                if (visEnt._parentEntity) {
-                    unmarkEntity([visEnt._parentEntity]);
-                }
-                if (visEnt._siblingGraphics) {
-                    unmarkEntity(visEnt._siblingGraphics);
-                }
-            }
-        }
-    }
-    var VisualsRegister = /** @class */ (function () {
-        function VisualsRegister(viewer) {
-            this.id = bruceModels.ObjectUtils.UId();
-            this.rego = {};
-            this.viewer = viewer;
-        }
-        Object.defineProperty(VisualsRegister.prototype, "Id", {
-            get: function () {
-                return this.id;
-            },
-            enumerable: false,
-            configurable: true
-        });
-        VisualsRegister.prototype.Add = function (rego) {
-            var _a;
-            this.Remove(rego.entityId, rego.menuItemId, false);
-            var entityId = rego.entityId;
-            var entityRegos = (_a = this.rego[entityId]) !== null && _a !== void 0 ? _a : [];
-            entityRegos.push(rego);
-            this.rego[entityId] = entityRegos;
-            markEntity(this, rego, rego.visuals);
-            updateEntity(this.viewer, this.rego[entityId]);
-        };
-        VisualsRegister.prototype.GetVisuals = function (entityId, menuItemId) {
-            var _a;
-            var entityRegos = this.rego[entityId];
-            if (!entityRegos) {
-                return [];
-            }
-            var visuals = (_a = entityRegos.find(function (r) { return r.menuItemId === menuItemId; })) === null || _a === void 0 ? void 0 : _a.visuals;
-            return visuals !== null && visuals !== void 0 ? visuals : [];
-        };
-        VisualsRegister.prototype.RemoveByEntityId = function (id) {
-            var entityRegos = this.rego[id];
-            if (!entityRegos) {
-                return;
-            }
-            for (var i = 0; i < entityRegos.length; i++) {
-                var rego = entityRegos[i];
-                removeEntity(this.viewer, rego.visuals);
-            }
-            this.rego[id] = [];
-            delete this.rego[id];
-        };
-        VisualsRegister.prototype.RemoveByMenuItemId = function (id) {
-            for (var entityId in this.rego) {
-                var entityRegos = this.rego[entityId];
-                if (entityRegos) {
-                    var rego = entityRegos.find(function (r) { return r.menuItemId === id; });
-                    if (!rego) {
-                        continue;
-                    }
-                    removeEntity(this.viewer, rego.visuals);
-                    var doesInclude = this.rego[entityId].find(function (r) { return r.menuItemId === id; });
-                    if (doesInclude) {
-                        this.rego[entityId] = entityRegos.filter(function (r) { return r.menuItemId !== id; });
-                        updateEntity(this.viewer, this.rego[entityId]);
-                    }
-                }
-            }
-        };
-        VisualsRegister.prototype.Remove = function (entityId, menuItemId, _doUpdate) {
-            if (_doUpdate === void 0) { _doUpdate = true; }
-            var entityRegos = this.rego[entityId];
-            if (!entityRegos) {
-                return;
-            }
-            var rego = entityRegos.find(function (r) { return r.menuItemId === menuItemId; });
-            if (!rego) {
-                return;
-            }
-            for (var i = 0; i < rego.visuals.length; i++) {
-                var visual = rego.visuals[i];
-                if (visual instanceof Cesium.Entity) {
-                    this.viewer.entities.remove(visual);
-                }
-                else if (visual instanceof Cesium.Primitive) {
-                    this.viewer.scene.primitives.remove(visual);
-                }
-                else if (visual instanceof Cesium.Cesium3DTileFeature) {
-                    visual.show = false;
-                }
-            }
-            this.rego[entityId] = entityRegos.filter(function (r) { return r.menuItemId !== menuItemId; });
-            if (_doUpdate) {
-                updateEntity(this.viewer, this.rego[entityId]);
-            }
-        };
-        VisualsRegister.prototype.GetFromCursor = function (cursor) {
-            var _a;
-            var found = [];
-            var picked = this.viewer.scene.drillPick(new Cesium.Cartesian2(cursor.x, cursor.y), 5);
-            for (var i = 0; i < picked.length; i++) {
-                var object = picked[i];
-                var entity = (object && object.id && object.id instanceof Cesium.Entity ? object.id : object);
-                var visual = entity;
-                if (((_a = visual === null || visual === void 0 ? void 0 : visual._register) === null || _a === void 0 ? void 0 : _a.Id) == this.id) {
-                    found.push(visual._rego);
-                }
-            }
-            return found;
-        };
-        return VisualsRegister;
-    }());
-
     exports.CesiumViewMonitor = CesiumViewMonitor;
     exports.MenuItemManager = MenuItemManager;
-    exports.VisualsRegister = VisualsRegister;
 
     Object.defineProperty(exports, '__esModule', { value: true });