bruce-cesium 7.6.6 → 7.6.8

package/dist/types/bruce-cesium.d.ts

@@ -12,6 +12,7 @@ export * from "./rendering/texture-value-labels";
 export * from "./rendering/menu-item-creator";
 export * from "./rendering/menu-item-manager";
 export * from "./rendering/menu-item-styles";
+export * from "./rendering/menu-item-style-overlay";
 export * from "./rendering/render-managers/common/cesium-parabola";
 export * from "./rendering/render-managers/common/entity-label";
 export * from "./rendering/render-managers/common/entity-label-group";
@@ -71,7 +72,7 @@ export * from "./widgets/widget-info-view";
 export * from "./widgets/widget-left-panel";
 export * from "./widgets/widget-nav-compass";
 export * from "./widgets/widget-view-bar";
-export declare const VERSION = "7.6.6";
+export declare const VERSION = "7.6.8";
 /**
  * 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.

package/dist/types/rendering/menu-item-manager.d.ts

@@ -1,4 +1,4 @@
-import { ApiGetters, BruceApi, BruceEvent, Entity, EntityHistoricData, MenuItem } from "bruce-models";
+import { ApiGetters, BruceApi, BruceEvent, Entity, EntityHistoricData, MenuItem, Style } from "bruce-models";
 import * as Cesium from "cesium";
 import * as SeriesSegmentTypes from "../internal/series-segment";
 import { RenderManager } from "./render-managers/render-manager";
@@ -31,6 +31,11 @@ export declare namespace MenuItemManager {
         private items;
         private pendingHandoffPool;
         private authoredAlternations;
+        private styleOverlay;
+        private styleOverlayCounter;
+        private itemStyleRecords;
+        private itemStyleRecordsLoading;
+        get StyleOverlay(): Style.IEntitySettings | null;
         private visualsRegister;
         get VisualsRegister(): VisualsRegister.Register;
         private onUpdate;
@@ -109,6 +114,23 @@ export declare namespace MenuItemManager {
             menuItemId: string;
             styleId: number | string;
         }): boolean;
+        /**
+         * Lays a style, inline or by record, over every item that can take one; null clears it.
+         */
+        SetStyleOverlay(params: {
+            style?: Style.IEntitySettings;
+            styleId?: number | string;
+        } | null): Promise<void>;
+        /**
+         * Lays an inline style or any Style record on one enabled item under the scene-wide one; neither clears it.
+         */
+        SetItemStyleOverlay(params: {
+            menuItemId: string;
+            style?: Style.IEntitySettings | null;
+            styleId?: number | string | null;
+        }): boolean;
+        private getEffectiveOverlay;
+        private loadItemStyleRecord;
         private pickRadioChild;
         private renderInPlaceOf;
         private isHandoffCapable;

package/dist/types/rendering/menu-item-style-overlay.d.ts

@@ -0,0 +1,57 @@
+import { MenuItem, Style, ZoomControl } from "bruce-models";
+/**
+ * Lays one style over every menu item that can take it, changing only what that style sets.
+ */
+export declare namespace MenuItemStyleOverlay {
+    /**
+     * A style a bookmark lays on one menu item, saved on that item's alternation.
+     */
+    interface IItemStyle {
+        style?: Style.IEntitySettings;
+        styleId?: number | string;
+    }
+    /**
+     * Returns the base style with each field the overlay sets laid over it.
+     */
+    function Merge(base: Style.IEntitySettings, overlay: Style.IEntitySettings): Style.IEntitySettings;
+    /**
+     * Returns the overlay a zoom control row carries laid over the style it resolved.
+     */
+    function ApplyRow(style: Style.Settings, row: ZoomControl.IItem): Style.Settings;
+    /**
+     * Returns true when the item renders through a path that honours an overlay.
+     */
+    function Supports(item: MenuItem.IItem): boolean;
+    /**
+     * Returns the overlay laid on the item, or null when it carries none.
+     */
+    function Get(item: MenuItem.IItem): Style.IEntitySettings | null;
+    /**
+     * Returns a copy carrying the overlay, or the item itself when it cannot take one and carries none.
+     */
+    function With(item: MenuItem.IItem, overlay: Style.IEntitySettings | null): MenuItem.IItem;
+    /**
+     * Returns the style a bookmark laid on this one item, or null when it carries none.
+     */
+    function GetItemStyle(item: MenuItem.IItem): Style.IEntitySettings | null;
+    /**
+     * Returns the Style record a bookmark laid on this one item, or null when it names none.
+     */
+    function GetItemStyleId(item: MenuItem.IItem): number | string | null;
+    /**
+     * Returns a copy carrying the given bookmark style, inline or by record, or without one for null.
+     */
+    function WithItemStyle(item: MenuItem.IItem, itemStyle: IItemStyle | null): MenuItem.IItem;
+    /**
+     * Returns the overlay an item renders with: its inline or loaded bookmark style, under the scene-wide one.
+     */
+    function Effective(item: MenuItem.IItem, overlay: Style.IEntitySettings, record?: Style.IEntitySettings): Style.IEntitySettings | null;
+    /**
+     * Returns a copy without its overlay or bookmark style, so what else two items differ by can be compared.
+     */
+    function Strip(item: MenuItem.IItem): MenuItem.IItem;
+    /**
+     * Returns true when the two items differ by nothing but their overlay or bookmark style.
+     */
+    function IsChangeOnly(from: MenuItem.IItem, to: MenuItem.IItem): boolean;
+}

package/dist/types/rendering/menu-item-styles.d.ts

@@ -20,7 +20,7 @@ export declare namespace MenuItemStyles {
      */
     function Resolve(item: MenuItem.IItem): MenuItem.IItem;
     /**
-     * Returns a copy on the style a bookmark alternation picked, or the item itself when that is not an option.
+     * Returns a copy on the style a bookmark alternation picked and carrying any style it laid on the item.
      */
     function ApplyAlternation(item: MenuItem.IItem, alternation: MenuItem.IItem): MenuItem.IItem;
     /**

package/dist/types/rendering/render-managers/entities/entities-datalab-render-manager.d.ts

@@ -21,6 +21,7 @@ export declare namespace DataLabRenderManager {
         private isRunningCheck;
         private viewMonitorRemoval;
         private renderQueue;
+        private renderQueueForced;
         private renderQueueInterval;
         private reRenderState;
         private zoomControl;

package/dist/types/rendering/render-managers/entities/entities-render-manager.d.ts

@@ -35,6 +35,7 @@ export declare namespace EntitiesRenderManager {
         private isRunningCheck;
         private viewMonitorRemoval;
         private renderQueue;
+        private renderQueueForced;
         private renderQueueInterval;
         private clustering;
         private sources;

package/dist/types/rendering/tileset-styler.d.ts

@@ -46,6 +46,8 @@ export declare class TilesetStyler {
     private stylePendingEntityIds;
     private fallbackStyleId;
     private fallbackStyle;
+    private styleOverlay;
+    private blendBeforeOverlay;
     private styleFallbackLoaded;
     private loadingCounter;
     private overrideFeatureColor;
@@ -80,6 +82,7 @@ export declare class TilesetStyler {
         scenario?: number | string;
         historic?: boolean;
         applyStyles?: boolean;
+        styleOverlay?: Style.IEntitySettings;
         monitor?: CesiumViewMonitor.Monitor;
         simulation?: EntitySimulation.Store;
     }): void;
@@ -92,6 +95,7 @@ export declare class TilesetStyler {
         styleMapping?: any[];
         fallbackStyleId?: number | string;
         fallbackStyle?: Style.IStyle;
+        styleOverlay?: Style.IEntitySettings;
         expandSources?: boolean;
         scenario?: number | string;
         historic?: boolean;
@@ -104,6 +108,7 @@ export declare class TilesetStyler {
      */
     SetEntityCache(entityIds: string[], entities?: Entity.IEntity[], maintain?: true): void;
     QueueEntities(regos: VisualsRegister.IVisualRego[], highPriority?: boolean): void;
+    private applyOverlayBlend;
     /**
      * Calculates the current progress % and updates the progress if there is a change.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bruce-cesium",
-  "version": "7.6.6",
+  "version": "7.6.8",
   "description": "",
   "keywords": [],
   "main": "dist/bruce-cesium.umd.js",
@@ -84,7 +84,7 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "bruce-models": "^7.1.129",
+    "bruce-models": "^7.1.130",
     "tslib": "^2.4.1"
   }
 }