bruce-cesium 7.3.8 → 7.4.0

package/dist/lib/rendering/visuals-register.js

@@ -7,6 +7,7 @@ const js_utils_1 = require("../internal/js-utils");
 const cesium_show_gate_1 = require("../internal/cesium-show-gate");
 const cesium_utils_1 = require("../internal/cesium-utils");
 const entity_label_1 = require("../rendering/render-managers/common/entity-label");
+const entity_label_group_1 = require("./render-managers/common/entity-label-group");
 const cesium_entity_styler_1 = require("../utils/cesium-entity-styler");
 const entity_render_engine_1 = require("./entity-render-engine");
 const entity_utils_1 = require("../utils/entity-utils");
@@ -170,7 +171,7 @@ function updateEntityShow(viewer, rego, show) {
     }
 }
 function updateEntity(viewer, entityId, register, refresh, cache = {}) {
-    var _a;
+    var _a, _b, _c;
     if (!entityId) {
         // What are we doing?
         return;
@@ -283,20 +284,25 @@ function updateEntity(viewer, entityId, register, refresh, cache = {}) {
                 }
             }
         }
-        if (state.labelled && visible) {
+        const labelGroup = register.GetLabelGroupFor(rego.entityId, rego.menuItemId);
+        if ((state.labelled || labelGroup) && visible) {
             entity_label_1.EntityLabel.Attach({
                 rego,
                 viewer,
-                api: register.ApiGetters.GetBruceApi(),
-                visualRegister: register
+                api: (_b = register.ApiGetters) === null || _b === void 0 ? void 0 : _b.GetBruceApi(),
+                visualRegister: register,
+                options: labelGroup === null || labelGroup === void 0 ? void 0 : labelGroup.options,
+                groupId: labelGroup === null || labelGroup === void 0 ? void 0 : labelGroup.groupId,
+                persistent: true
             });
         }
-        else {
+        else if (!visible || ((_c = entity_label_1.EntityLabel.GetLabel({ rego })) === null || _c === void 0 ? void 0 : _c.Persistent)) {
             entity_label_1.EntityLabel.Detatch({
-                rego
+                rego, force: true
             });
         }
     }
+    register.RefreshLabelGroupEntity(entityId);
 }
 function markEntity(register, rego, visual, ignoreParent) {
     const vis = visual;
@@ -411,6 +417,7 @@ var VisualsRegister;
             }
             return this.onUpdate;
         }
+        get OnLabelGroupsChanged() { return this.labelGroupsChanged; }
         constructor(params) {
             this.id = bruce_models_1.ObjectUtils.UId();
             this.disposed = false;
@@ -449,10 +456,35 @@ var VisualsRegister;
             this.menuItemSources = new Map();
             // Set when the data source order no longer matches the zIndexes seen, so it is re-applied once.
             this.sourceOrderDirty = false;
+            this.labelGroupsChanged = new bruce_models_1.BruceEvent();
+            this.hoverRingState = {};
+            this.retiringHoverLabels = new Map();
             /*
              * Tilesets in the scene, keyed by the tileset itself.
              */
             this.tilesets = new Map();
+            this.ClearLabelHover = () => {
+                if (!this.labelHover && !this.hoverLabel) {
+                    return;
+                }
+                this.ReleaseHoverLabel();
+                this.labelHover = undefined;
+                clearTimeout(this.hoverRingReset);
+                this.hoverRingReset = setTimeout(() => { this.hoverRingState = {}; }, 400);
+                const doc = this.viewer.container.ownerDocument;
+                doc.removeEventListener("pointermove", this.CheckLabelHoverBounds, true);
+                this.viewer.container.removeEventListener("pointerleave", this.CheckLabelHoverBounds);
+                doc.defaultView.removeEventListener("blur", this.ClearLabelHover);
+                if (!this.viewer.isDestroyed()) {
+                    this.viewer.scene.requestRender();
+                }
+            };
+            this.CheckLabelHoverBounds = (event) => {
+                const bounds = this.viewer.canvas.getBoundingClientRect();
+                if (event.clientX < bounds.left || event.clientX >= bounds.right || event.clientY < bounds.top || event.clientY >= bounds.bottom) {
+                    this.ClearLabelHover();
+                }
+            };
             this.viewer = params.viewer;
             this.apiGetters = params.apiGetters;
             this.cameraCullerDispose = visual_register_culler_1.VisualRegisterCuller.Monitor({
@@ -648,6 +680,7 @@ var VisualsRegister;
             const BATCH_SIZE = 300;
             if (this.updateQueue.length) {
                 this.updateQueueInterval = setInterval(() => {
+                    var _a;
                     if (this.Disposed || (!this.viewer || !this.viewer.scene || this.viewer.isDestroyed())) {
                         clearInterval(this.updateQueueInterval);
                         this.updateQueueInterval = null;
@@ -660,6 +693,8 @@ var VisualsRegister;
                         this.updateQueueIds.delete(entityId);
                         // Check if still registered.
                         if (entityId && (!this.rego[entityId] || !this.rego[entityId].length)) {
+                            (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.RefreshEntity(entityId);
+                            delete this.updateQueueSettings[entityId];
                             continue;
                         }
                         updateEntity(this.viewer, entityId, this, this.updateQueueSettings[entityId] == null ? false : this.updateQueueSettings[entityId], cache);
@@ -1317,8 +1352,23 @@ var VisualsRegister;
             markEntity(this, rego, rego.visual, false);
         }
         Dispose() {
-            var _a, _b, _c, _d;
-            (_a = this.cameraCullerDispose) === null || _a === void 0 ? void 0 : _a.call(this, {
+            var _a, _b, _c, _d, _e;
+            this.ClearLabelHover();
+            clearTimeout(this.hoverRingReset);
+            this.hoverRingState = {};
+            for (const { label, timer } of this.retiringHoverLabels.values()) {
+                clearTimeout(timer);
+                entity_label_1.EntityLabel.Detatch({ label });
+            }
+            this.retiringHoverLabels.clear();
+            (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.Dispose();
+            this.labelGroupsChanged.Clear();
+            for (const regos of Object.values(this.rego)) {
+                for (const rego of regos)
+                    entity_label_1.EntityLabel.Detatch({ rego, force: true });
+            }
+            entity_label_1.EntityLabel.SetContainer(this.viewer);
+            (_b = this.cameraCullerDispose) === null || _b === void 0 ? void 0 : _b.call(this, {
                 uncull: false
             });
             this.cameraCullerDispose = null;
@@ -1334,7 +1384,7 @@ var VisualsRegister;
             this.disposed = true;
             for (const record of Array.from(this.menuItemSources.values())) {
                 try {
-                    (_c = (_b = this.viewer) === null || _b === void 0 ? void 0 : _b.dataSources) === null || _c === void 0 ? void 0 : _c.remove(record.source, true);
+                    (_d = (_c = this.viewer) === null || _c === void 0 ? void 0 : _c.dataSources) === null || _d === void 0 ? void 0 : _d.remove(record.source, true);
                 }
                 catch (e) {
                     console.error(e);
@@ -1343,7 +1393,7 @@ var VisualsRegister;
             this.menuItemSources.clear();
             // Hand every tileset's show flag back to its owner, holding whatever the owner last asked for.
             for (const rego of Array.from(this.tilesets.values())) {
-                (_d = rego.gate) === null || _d === void 0 ? void 0 : _d.Release();
+                (_e = rego.gate) === null || _e === void 0 ? void 0 : _e.Release();
             }
             this.tilesets.clear();
         }
@@ -2297,7 +2347,7 @@ var VisualsRegister;
          * @returns
          */
         RemoveRegos(params) {
-            var _a, _b, _c;
+            var _a, _b, _c, _d, _e;
             let { entityId, menuItemId, doUpdate, relation, retainTagIds, requestRender, doRemove, source, lazy, onComplete } = params;
             if (doUpdate == null || doUpdate === undefined) {
                 doUpdate = true;
@@ -2318,7 +2368,7 @@ var VisualsRegister;
                     }
                 }
                 const removeOne = (entityId) => {
-                    var _a, _b;
+                    var _a, _b, _c;
                     const entityRegos = this.rego[entityId];
                     if (!entityRegos) {
                         return;
@@ -2333,7 +2383,7 @@ var VisualsRegister;
                         return;
                     }
                     entity_label_1.EntityLabel.Detatch({
-                        rego
+                        rego, force: true
                     });
                     // Never tear down the graphic the caller is registering: the renderers hand back
                     // the same object when they reuse it, so removing it here destroys what replaces it.
@@ -2358,15 +2408,14 @@ var VisualsRegister;
                         (_a = this.onUpdate) === null || _a === void 0 ? void 0 : _a.Trigger(update);
                     }
                     // Only worth refreshing while the Entity is still drawn by something else, since
-                    // losing this rego can change which of the survivors wins. With none left there is
-                    // nothing to restyle, and queueing one per removed Entity is what turns disabling a
-                    // large menu item into minutes of scheduled work.
+                    // losing this rego can change which of the survivors wins.
                     if (doesInclude && ((_b = this.rego[entityId]) === null || _b === void 0 ? void 0 : _b.length)) {
                         this.queueUpdate({
                             entityId: entityId,
                             refresh: false
                         });
                     }
+                    (_c = this.labelGroups) === null || _c === void 0 ? void 0 : _c.RefreshEntity(entityId);
                 };
                 const finish = () => {
                     this.releaseMenuItemCollection(menuItemId);
@@ -2397,7 +2446,7 @@ var VisualsRegister;
                         return;
                     }
                     entity_label_1.EntityLabel.Detatch({
-                        rego
+                        rego, force: true
                     });
                     // Never tear down the graphic the caller is registering: the renderers hand back
                     // the same object when they reuse it, so removing it here destroys what replaces it.
@@ -2416,7 +2465,7 @@ var VisualsRegister;
                     if (source !== EUpdateSource.TREE_CASCADE) {
                         (_b = this.onUpdate) === null || _b === void 0 ? void 0 : _b.Trigger(update);
                     }
-                    this.rego[entityId] = entityRegos.filter(r => r.menuItemId !== menuItemId);
+                    this.rego[entityId] = this.rego[entityId].filter(r => r.menuItemId !== menuItemId);
                     this.unindexMenuItemEntityIfAbsent(menuItemId, entityId);
                     if (doUpdate && menuItemId) {
                         this.queueUpdate({
@@ -2425,6 +2474,7 @@ var VisualsRegister;
                         });
                     }
                 }
+                (_c = this.labelGroups) === null || _c === void 0 ? void 0 : _c.RefreshEntity(entityId);
             }
             else if (relation) {
                 const relationKey = relation_render_engine_1.RelationRenderEngine.GetRenderGroupId(relation);
@@ -2436,7 +2486,7 @@ var VisualsRegister;
                             continue;
                         }
                         entity_label_1.EntityLabel.Detatch({
-                            rego
+                            rego, force: true
                         });
                         removeEntity(this.viewer, rego.visual);
                         rego.visual = null;
@@ -2445,6 +2495,7 @@ var VisualsRegister;
                             delete this.rego[entityId];
                         }
                         this.unindexMenuItemEntityIfAbsent(rego.menuItemId, entityId);
+                        (_d = this.labelGroups) === null || _d === void 0 ? void 0 : _d.RefreshEntity(entityId);
                         const update = {
                             type: EVisualUpdateType.Remove,
                             entityId: rego.entityId,
@@ -2454,7 +2505,7 @@ var VisualsRegister;
                             update.source = source;
                         }
                         if (source !== EUpdateSource.TREE_CASCADE) {
-                            (_c = this.onUpdate) === null || _c === void 0 ? void 0 : _c.Trigger(update);
+                            (_e = this.onUpdate) === null || _e === void 0 ? void 0 : _e.Trigger(update);
                         }
                         if (doUpdate) {
                             this.queueUpdate({
@@ -2473,7 +2524,7 @@ var VisualsRegister;
          * @param params
          */
         RemoveRegosByVisuals(params) {
-            var _a, _b;
+            var _a, _b, _c;
             const { doRemove = true, requestRender = true, source, doUpdate, menuItemId } = params;
             const removedEntityIds = new Set();
             for (const visual of params.visuals) {
@@ -2488,9 +2539,8 @@ var VisualsRegister;
                     continue;
                 }
                 if (rego.visual === visual) {
-                    // The primary graphic for this rego - remove the rego entirely.
                     entity_label_1.EntityLabel.Detatch({
-                        rego
+                        rego, force: true
                     });
                     if (doRemove != false) {
                         removeEntity(this.viewer, rego.visual);
@@ -2519,9 +2569,10 @@ var VisualsRegister;
                         });
                     }
                     removedEntityIds.add(entityId);
+                    (_b = this.labelGroups) === null || _b === void 0 ? void 0 : _b.RefreshEntity(entityId);
                 }
                 else {
-                    const siblings = (_b = rego.visual) === null || _b === void 0 ? void 0 : _b["_siblingGraphics"];
+                    const siblings = (_c = rego.visual) === null || _c === void 0 ? void 0 : _c["_siblingGraphics"];
                     if (siblings === null || siblings === void 0 ? void 0 : siblings.length) {
                         if (doRemove != false && siblings.includes(visual)) {
                             removeEntity(this.viewer, visual);
@@ -2788,6 +2839,204 @@ var VisualsRegister;
             }
             return map;
         }
+        ReleaseHoverLabel(immediate = false) {
+            const label = this.hoverLabel;
+            this.hoverLabel = undefined;
+            if (!label || label.Disposed || label.Persistent) {
+                return;
+            }
+            if (immediate) {
+                entity_label_1.EntityLabel.Detatch({ label });
+                return;
+            }
+            label.SetHoverVisible(false);
+            const key = JSON.stringify([label.Rego.entityId, label.Rego.menuItemId || ""]);
+            const previous = this.retiringHoverLabels.get(key);
+            if (previous) {
+                clearTimeout(previous.timer);
+                entity_label_1.EntityLabel.Detatch({ label: previous.label });
+            }
+            // Retain briefly beyond the fade to bridge debounced same-target hover updates.
+            const timer = setTimeout(() => {
+                this.retiringHoverLabels.delete(key);
+                entity_label_1.EntityLabel.Detatch({ label });
+            }, 240);
+            this.retiringHoverLabels.set(key, { label, timer });
+        }
+        /*
+         * Owns temporary positioning separately from persistent label membership and world anchors.
+         */
+        SetLabelHover(params) {
+            var _a, _b;
+            if (this.disposed) {
+                return;
+            }
+            if (!(params === null || params === void 0 ? void 0 : params.entityId)) {
+                this.ClearLabelHover();
+                return;
+            }
+            if (params.position && (!Number.isFinite(params.position.x) || !Number.isFinite(params.position.y) ||
+                params.position.x < 0 || params.position.y < 0 ||
+                params.position.x >= this.viewer.canvas.clientWidth || params.position.y >= this.viewer.canvas.clientHeight)) {
+                this.ClearLabelHover();
+                return;
+            }
+            const changed = ((_a = this.labelHover) === null || _a === void 0 ? void 0 : _a.entityId) !== params.entityId || ((_b = this.labelHover) === null || _b === void 0 ? void 0 : _b.menuItemId) !== params.menuItemId;
+            if (changed) {
+                this.ClearLabelHover();
+            }
+            clearTimeout(this.hoverRingReset);
+            this.labelHover = {
+                entityId: params.entityId,
+                menuItemId: params.menuItemId,
+                position: params.position ? { ...params.position } : undefined,
+                createIfMissing: params.createIfMissing !== false
+            };
+            const doc = this.viewer.container.ownerDocument;
+            doc.addEventListener("pointermove", this.CheckLabelHoverBounds, true);
+            this.viewer.container.addEventListener("pointerleave", this.CheckLabelHoverBounds);
+            doc.defaultView.addEventListener("blur", this.ClearLabelHover);
+            this.SyncLabelHover();
+            this.viewer.scene.requestRender();
+        }
+        GetLabelHoverPosition(entityId, menuItemId) {
+            const hover = this.labelHover;
+            return (hover === null || hover === void 0 ? void 0 : hover.entityId) === entityId && (hover.menuItemId == null || hover.menuItemId === menuItemId) ? hover.position : undefined;
+        }
+        SyncLabelHover() {
+            var _a, _b, _c, _d;
+            const hover = this.labelHover;
+            if (!hover || this.disposed) {
+                return;
+            }
+            if ((_a = this.hoverLabel) === null || _a === void 0 ? void 0 : _a.Disposed) {
+                this.hoverLabel = undefined;
+            }
+            if (!hover.createIfMissing) {
+                this.ReleaseHoverLabel(true);
+                return;
+            }
+            const group = this.GetLabelGroupFor(hover.entityId, hover.menuItemId);
+            let rego = this.GetRego(hover);
+            const key = JSON.stringify([hover.entityId, hover.menuItemId || ""]);
+            const retiring = this.retiringHoverLabels.get(key);
+            if (retiring) {
+                clearTimeout(retiring.timer);
+                this.retiringHoverLabels.delete(key);
+                if (!retiring.label.Disposed) {
+                    this.hoverLabel = retiring.label;
+                }
+            }
+            const existing = rego && entity_label_1.EntityLabel.GetLabel({ rego });
+            const state = this.GetState(hover);
+            if ((!rego && !group) || state.hidden || ((_b = rego === null || rego === void 0 ? void 0 : rego.visual) === null || _b === void 0 ? void 0 : _b.show) === false ||
+                (this.GetIsIsolatedAny() && !state.isolated && this.GetIsolationOpacity() == null) ||
+                (existing && existing !== this.hoverLabel && existing.HasText) ||
+                (group && group.options.presentation !== "icon")) {
+                this.ReleaseHoverLabel(true);
+                return;
+            }
+            if (this.hoverLabel && !this.hoverLabel.Disposed) {
+                this.hoverLabel.SetHoverVisible(true);
+                return;
+            }
+            // Query-only icon groups have coordinates but no registered scene visual to attach to.
+            if (!rego && group && [group.item.longitude, group.item.latitude, (_c = group.item.altitude) !== null && _c !== void 0 ? _c : 0].every(Number.isFinite)) {
+                rego = {
+                    entityId: hover.entityId,
+                    menuItemId: hover.menuItemId,
+                    name: group.options.text,
+                    priority: 0,
+                    visual: new Cesium.Entity({
+                        position: Cesium.Cartesian3.fromDegrees(group.item.longitude, group.item.latitude, group.item.altitude || 0),
+                        point: {
+                            pixelSize: 0,
+                            heightReference: Cesium.HeightReference.NONE
+                        }
+                    })
+                };
+            }
+            if (!rego) {
+                return;
+            }
+            const params = {
+                rego,
+                viewer: this.viewer,
+                visualRegister: this,
+                api: (_d = this.ApiGetters) === null || _d === void 0 ? void 0 : _d.GetBruceApi(),
+                persistent: false,
+                transient: true,
+                hoverRingState: this.hoverRingState,
+                options: {
+                    presentation: "text",
+                    text: group === null || group === void 0 ? void 0 : group.options.text,
+                    selectOnClick: false
+                },
+                visible: () => {
+                    var _a, _b;
+                    const current = this.GetState(hover);
+                    return (!this.disposed && !current.hidden && ((_a = rego.visual) === null || _a === void 0 ? void 0 : _a.show) !== false &&
+                        Boolean(this.GetRego(hover) || ((_b = this.labelGroups) === null || _b === void 0 ? void 0 : _b.Has(hover.entityId, hover.menuItemId))) &&
+                        (!this.GetIsIsolatedAny() || current.isolated || this.GetIsolationOpacity() != null));
+                }
+            };
+            this.hoverLabel = existing || group ? new entity_label_1.EntityLabel.Label(params) : entity_label_1.EntityLabel.Attach(params);
+        }
+        SetLabelContainer(container) {
+            if (this.disposed) {
+                return;
+            }
+            entity_label_1.EntityLabel.SetContainer(this.viewer, container);
+        }
+        ClearLabelContainer() {
+            this.SetLabelContainer();
+        }
+        /*
+         * Adds source-driven membership without changing manual labelled state or legacy bookmark snapshots.
+         */
+        SetLabelGroup(group) {
+            if (this.disposed) {
+                return Promise.reject(new Error("Visual register is disposed"));
+            }
+            if (!this.labelGroups) {
+                this.labelGroups = new entity_label_group_1.EntityLabelGroup.Manager(this, () => this.labelGroupsChanged.Trigger(undefined));
+            }
+            return this.labelGroups.Set(group);
+        }
+        RemoveLabelGroup(id) {
+            var _a;
+            (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.Remove(id);
+        }
+        RefreshLabelGroup(id) {
+            var _a, _b;
+            if (this.disposed) {
+                return Promise.reject(new Error("Visual register is disposed"));
+            }
+            return (_b = (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.Refresh(id)) !== null && _b !== void 0 ? _b : Promise.reject(new Error(`Unknown label group: ${id}`));
+        }
+        SetLabelGroupVisible(id, visible) {
+            var _a, _b;
+            return (_b = (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.SetVisible(id, visible)) !== null && _b !== void 0 ? _b : false;
+        }
+        ClearLabelGroups() {
+            var _a;
+            (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.Clear();
+        }
+        GetLabelGroups() {
+            var _a;
+            return ((_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.Get()) || [];
+        }
+        GetLabelGroupFor(entityId, menuItemId) {
+            var _a;
+            return (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.Resolve(entityId, menuItemId);
+        }
+        RefreshLabelGroupEntity(entityId) {
+            var _a, _b;
+            (_a = this.labelGroups) === null || _a === void 0 ? void 0 : _a.RefreshEntity(entityId);
+            if (((_b = this.labelHover) === null || _b === void 0 ? void 0 : _b.entityId) === entityId) {
+                this.SyncLabelHover();
+            }
+        }
     }
     VisualsRegister.Register = Register;
 })(VisualsRegister = exports.VisualsRegister || (exports.VisualsRegister = {}));