bruce-cesium 0.0.2 → 0.0.3

package/dist/types/rendering/entity-render-engine.d.ts

@@ -10,7 +10,7 @@ export declare namespace EntityRenderEngine {
     interface IParams {
         api: BruceApi;
         viewer: Cesium.Viewer;
-        visualRegister: VisualsRegister;
+        visualRegister: VisualsRegister.Register;
         menuItemId: string;
         zoomControl: ZoomControl.IItem[];
         entities: Entity.IEntity[];
@@ -29,7 +29,7 @@ export declare namespace EntityRenderEngine {
             menuItemId: string;
             entities: Entity.IEntity[];
             zoomItems: IDictionary<ZoomControl.IItem>;
-            visualRegister: VisualsRegister;
+            visualRegister: VisualsRegister.Register;
             viewer: Cesium.Viewer;
         }
         function Render(params: IParams): ICesiumEntityExt;
@@ -47,7 +47,7 @@ export declare namespace EntityRenderEngine {
             menuItemId: string;
             entities: Entity.IEntity[];
             zoomItems: IDictionary<ZoomControl.IItem>;
-            visualRegister: VisualsRegister;
+            visualRegister: VisualsRegister.Register;
             viewer: Cesium.Viewer;
         }
         function Render(params: IParams): ICesiumEntityExt;
@@ -65,7 +65,7 @@ export declare namespace EntityRenderEngine {
             menuItemId: string;
             entities: Entity.IEntity[];
             zoomItems: IDictionary<ZoomControl.IItem>;
-            visualRegister: VisualsRegister;
+            visualRegister: VisualsRegister.Register;
             viewer: Cesium.Viewer;
         }
         function Render(params: IParams): ICesiumEntityExt;
@@ -84,7 +84,7 @@ export declare namespace EntityRenderEngine {
             menuItemId: string;
             entities: Entity.IEntity[];
             zoomItems: IDictionary<ZoomControl.IItem>;
-            visualRegister: VisualsRegister;
+            visualRegister: VisualsRegister.Register;
             viewer: Cesium.Viewer;
         }
         function Render(params: IParams): ICesiumEntityExt;

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

@@ -1,11 +1,27 @@
 import { BruceApi, MenuItem } from "bruce-models";
 import * as Cesium from "cesium";
 import { VisualsRegister } from "./visuals-register";
+/**
+ * Utility to keep track of enabled menu items within a Cesium viewer.
+ */
 export declare class MenuItemManager {
     private viewer;
     private items;
     private visualsRegister;
-    constructor(viewer: Cesium.Viewer, visualsRegister: VisualsRegister);
+    get VisualsRegister(): VisualsRegister.Register;
+    constructor(viewer: Cesium.Viewer, visualsRegister?: VisualsRegister.Register);
+    /**
+     * Renders a given menu item and all ids children.
+     * Will return the enabled item id.
+     * @param api
+     * @param item
+     * @returns
+     */
     RenderItem(api: BruceApi, item: MenuItem.IItem): Promise<string>;
+    /**
+     * Disables a menu item by ids id.
+     * This will disable all children as well.
+     * @param id
+     */
     RemoveItemById(id: string): Promise<void>;
 }

package/dist/types/rendering/render-helper.d.ts

@@ -1,6 +1,9 @@
 import { BruceApi, Entity, MenuItem } from "bruce-models";
 import { MenuItemManager } from "./menu-item-manager";
 import * as Cesium from "cesium";
+/**
+ * Utility to help generate menu items for rendering various data.
+ */
 export declare namespace RenderHelper {
     function RenderEntities(manager: MenuItemManager, api: BruceApi, entityIds: string[]): Promise<string>;
     function RenderEntityTypes(manager: MenuItemManager, api: BruceApi, typeIds: string[]): Promise<string>;

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

@@ -2,6 +2,10 @@ import { BruceApi, MenuItem } from "bruce-models";
 import * as Cesium from "cesium";
 import { VisualsRegister } from "../../visuals-register";
 import { RenderManager } from "../render-manager";
+/**
+ * Render manager for rendering an array of entity ids.
+ * This will render them in batches to avoid overloading the viewer.
+ */
 export declare namespace EntitiesIdsRenderManager {
     class Manager implements RenderManager.IManager {
         private viewer;
@@ -13,7 +17,7 @@ export declare namespace EntitiesIdsRenderManager {
         get Disposed(): boolean;
         private renderedEntities;
         private visualsManager;
-        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister, api: BruceApi, item: MenuItem.Item.IEntityIds);
+        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister.Register, api: BruceApi, item: MenuItem.Item.IEntityIds);
         Init(): Promise<void>;
         Dispose(): void;
         private onGetterUpdate;

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

@@ -2,6 +2,11 @@ import { BruceApi, MenuItem } from "bruce-models";
 import * as Cesium from "cesium";
 import { VisualsRegister } from "../../visuals-register";
 import { RenderManager } from "../render-manager";
+/**
+ * Render manager for a group of pre-loaded entities.
+ * The entities may or may not have records.
+ * If the entities DON'T have records, it is recommended to avoid using the 3dmodel visualization as it will fail to locate LODs.
+ */
 export declare namespace EntitiesLoadedRenderManager {
     class Manager implements RenderManager.IManager {
         private viewer;
@@ -13,7 +18,7 @@ export declare namespace EntitiesLoadedRenderManager {
         get Disposed(): boolean;
         private renderedEntities;
         private visualsManager;
-        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister, api: BruceApi, item: MenuItem.Item.IEntitiesLoaded);
+        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister.Register, api: BruceApi, item: MenuItem.Item.IEntitiesLoaded);
         Init(): Promise<void>;
         Dispose(): void;
         private onGetterUpdate;

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

@@ -2,6 +2,10 @@ import { BruceApi, MenuItem } from "bruce-models";
 import * as Cesium from "cesium";
 import { VisualsRegister } from "../../visuals-register";
 import { RenderManager } from "../render-manager";
+/**
+ * Manager for rendering Bruce entities.
+ * This will request entities based on setup menu item filter.
+ */
 export declare namespace EntitiesRenderManager {
     class Manager implements RenderManager.IManager {
         private viewer;
@@ -17,7 +21,7 @@ export declare namespace EntitiesRenderManager {
         private entityCheckRemoval;
         private isRunningCheck;
         private viewMonitorRemoval;
-        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister, api: BruceApi, item: MenuItem.Item.IBruceEntities);
+        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister.Register, api: BruceApi, item: MenuItem.Item.IBruceEntities);
         Init(): Promise<void>;
         Dispose(): void;
         private doEntityCheck;

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

@@ -2,6 +2,9 @@ import { BruceApi, MenuItem } from "bruce-models";
 import * as Cesium from "cesium";
 import { VisualsRegister } from "../../visuals-register";
 import { RenderManager } from "../render-manager";
+/**
+ * Manager for rendering a single Bruce entity.
+ */
 export declare namespace EntityRenderManager {
     class Manager implements RenderManager.IManager {
         private viewer;
@@ -12,7 +15,7 @@ export declare namespace EntityRenderManager {
         private disposed;
         get Disposed(): boolean;
         private visualsManager;
-        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister, api: BruceApi, item: MenuItem.Item.IBruceEntity);
+        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister.Register, api: BruceApi, item: MenuItem.Item.IBruceEntity);
         Init(): Promise<void>;
         Dispose(): void;
         private onGetterUpdate;

package/dist/types/rendering/render-managers/tilesets/tileset-cad-render-manager.d.ts

@@ -2,6 +2,10 @@ import { BruceApi, MenuItem } from "bruce-models";
 import { VisualsRegister } from "../../visuals-register";
 import { RenderManager } from "../render-manager";
 import * as Cesium from "cesium";
+/**
+ * Manager for rendering CAD tilesets.
+ * CAD tilesets are referred to as "MODEL" tilesets in some other areas of Bruce code.
+ */
 export declare namespace TilesetCadRenderManager {
     class Manager implements RenderManager.IManager {
         private viewer;
@@ -12,7 +16,7 @@ export declare namespace TilesetCadRenderManager {
         private visualsManager;
         private cTileset;
         private styler;
-        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister, api: BruceApi, item: MenuItem.Item.ICadTileset);
+        constructor(viewer: Cesium.Viewer, visualsManager: VisualsRegister.Register, api: BruceApi, item: MenuItem.Item.ICadTileset);
         Init(): Promise<void>;
         private onCTilesetLoad;
         private mapCTile;

package/dist/types/rendering/tileset-render-engine.d.ts

@@ -1,6 +1,6 @@
 import { BruceApi, Tileset } from "bruce-models";
 import * as Cesium from "cesium";
-import { IVisualRego } from "./visuals-register";
+import { VisualsRegister } from "./visuals-register";
 export declare namespace TilesetRenderEngine {
     interface IParams {
         api: BruceApi;
@@ -26,7 +26,7 @@ export declare namespace TilesetRenderEngine {
         private recordCheckQueue;
         private queueCheckInterval;
         constructor(api: BruceApi, cTileset: Cesium.Cesium3DTileset, fallbackStyleId: number, styleMapping: any[]);
-        QueueEntities(entities: IVisualRego[]): void;
+        QueueEntities(entities: VisualsRegister.IVisualRego[]): void;
         private processQueue;
         private getEntitiesForQueue;
         Dispose(): void;

package/dist/types/rendering/visuals-register.d.ts

@@ -1,24 +1,42 @@
-import { Cartes } from "bruce-models";
+import { BruceEvent, Cartes } from "bruce-models";
 import * as Cesium from "cesium";
 declare type Visual = Cesium.Entity | Cesium.Primitive | Cesium.Cesium3DTileFeature;
-export interface IVisualRego {
-    entityId: string;
-    entityTypeId?: string;
-    menuItemId: string;
-    visuals: Visual[];
-    priority: number;
-}
-export declare class VisualsRegister {
-    private id;
-    get Id(): string;
-    private viewer;
-    private rego;
-    constructor(viewer: Cesium.Viewer);
-    Add(rego: IVisualRego): void;
-    GetVisuals(entityId: string, menuItemId: string): Visual[];
-    RemoveByEntityId(id: string): void;
-    RemoveByMenuItemId(id: string): void;
-    Remove(entityId: string, menuItemId: string, _doUpdate?: boolean): void;
-    GetFromCursor(cursor: Cartes.ICartes2): IVisualRego[];
+/**
+ * Manages a registry of all Bruce visuals being rendered by menu items.
+ * If multiple stuff is registered with the same entity id, only the "best" one is left visible.
+ */
+export declare namespace VisualsRegister {
+    interface IVisualRego {
+        entityId: string;
+        entityTypeId?: string;
+        menuItemId: string;
+        visual: Visual;
+        priority: number;
+    }
+    interface IVisualUpdate {
+        rego: IVisualRego;
+        isAdding: boolean;
+    }
+    class Register {
+        private id;
+        get Id(): string;
+        private viewer;
+        private rego;
+        private onUpdate;
+        get OnUpdate(): BruceEvent<IVisualUpdate>;
+        constructor(viewer: Cesium.Viewer);
+        Add(rego: IVisualRego): void;
+        GetVisuals(entityId: string, menuItemId: string): Visual[];
+        RemoveByEntityId(id: string): void;
+        RemoveByMenuItemId(id: string): void;
+        Remove(entityId: string, menuItemId: string, _doUpdate?: boolean): void;
+        /**
+         * Returns an array of drilled visuals associated with this register.
+         * The top array item is the first found.
+         * @param cursor
+         * @returns
+         */
+        GetFromCursor(cursor: Cartes.ICartes2): IVisualRego[];
+    }
 }
 export {};

package/dist/types/utils/drawing-utils.d.ts

@@ -1,4 +1,12 @@
 import * as Cesium from "cesium";
 export declare namespace 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: Cesium.Viewer, positions: Cesium.Cartesian3[], distance: number): Cesium.Cartesian3;
 }

package/dist/types/utils/entity-utils.d.ts

@@ -1,5 +1,17 @@
 import { Entity as E } from "bruce-models";
 import * as Cesium from "cesium";
 export declare namespace 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: Cesium.Viewer, entity: E.IEntity): Cesium.Cartesian3;
+    /**
+     * Returns entity and any associated parent/sibling entities as a flat array.
+     * @param entity
+     */
+    function GatherEntity(entity: Cesium.Entity): Cesium.Entity[];
 }

package/dist/types/utils/measure-utils.d.ts

@@ -1,4 +1,10 @@
 import * as Cesium from "cesium";
 export declare namespace 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: Cesium.Cartesian3[]): number;
 }

package/dist/types/viewer/cesium-view-monitor.d.ts

@@ -1,5 +1,8 @@
 import { Bounds, BruceEvent, Carto, ViewMonitor } from "bruce-models";
 import * as Cesium from "cesium";
+/**
+ * Monitors and emits events when the Cesium view changes.
+ */
 export declare class CesiumViewMonitor implements ViewMonitor.IMonitor {
     private viewer;
     private pendingTimeout;

package/dist/types/viewer/viewer-utils.d.ts

@@ -7,9 +7,19 @@ export declare namespace ViewerUtils {
     interface IViewContainer extends HTMLElement {
         _cViewer?: Cesium.Viewer;
     }
+    /**
+     * 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: HTMLElement): Cesium.Viewer;
     function GetViewerFromContainer(container: HTMLElement): Cesium.Viewer;
     function DestroyWidget(widget: IWidget): void;
+    /**
+     * Hides all unnecessary elements from the Cesium viewer container.
+     * @param viewer
+     */
     function StyleContainer(viewer: Cesium.Viewer): void;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bruce-cesium",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "",
   "keywords": [],
   "main": "dist/bruce-cesium.umd.js",