@cognite/reveal 3.1.0 → 4.0.0-dev.20221025

package/packages/tools/src/ExplodedViewTool.d.ts

@@ -1,12 +1,12 @@
-import { Cognite3DModel } from '../../../core';
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-export declare class ExplodedViewTool extends Cognite3DViewerToolBase {
-    private readonly _cadModel;
-    private _treeBoundingBoxdata;
-    private readonly _rootTreeIndex;
-    get readyPromise(): Promise<void>;
-    constructor(treeIndex: number, cadModel: Cognite3DModel);
-    expand(expandRadius: number): Promise<void>;
-    reset(): void;
-    private preloadBoundingBoxData;
-}
+import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
+import { Cognite3DModel } from '../../api';
+export declare class ExplodedViewTool extends Cognite3DViewerToolBase {
+    private readonly _cadModel;
+    private _treeBoundingBoxdata;
+    private readonly _rootTreeIndex;
+    get readyPromise(): Promise<void>;
+    constructor(treeIndex: number, cadModel: Cognite3DModel);
+    expand(expandRadius: number): Promise<void>;
+    reset(): void;
+    private preloadBoundingBoxData;
+}

package/packages/tools/src/HtmlOverlay/BucketGrid2D.d.ts

@@ -1,28 +1,28 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Data structure that splits a 2D region into cells where each cell can contain zero to many
- * elements. Elements can be stored in several cells. This data structure make overlap lookups
- * efficient.
- *
- * Note! This class is tailored for usage with {@link HtmlOverlayTool} and has a few restrictions
- * and assumptions associated with the usage. If used elsewhere, take care as to how this affects
- * performance and behaviour.
- */
-export declare class BucketGrid2D<T> {
-    private readonly _dimensions;
-    private readonly _bounds;
-    private readonly _cells;
-    /**
-     * Holds elements that has been removed from the collection using {@link removeOverlappingElements}.
-     * This is used to avoid expensive re-allocations of cells when removing elements.
-     */
-    private readonly _removedElements;
-    constructor(bounds: THREE.Box2, dimensions: [width: number, height: number]);
-    insert(bounds: THREE.Box2, element: T): void;
-    overlappingElements(bounds: THREE.Box2): Generator<T>;
-    removeOverlappingElements(bounds: THREE.Box2): Generator<T>;
-    private cellsIntersecting;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Data structure that splits a 2D region into cells where each cell can contain zero to many
+ * elements. Elements can be stored in several cells. This data structure make overlap lookups
+ * efficient.
+ *
+ * Note! This class is tailored for usage with {@link HtmlOverlayTool} and has a few restrictions
+ * and assumptions associated with the usage. If used elsewhere, take care as to how this affects
+ * performance and behaviour.
+ */
+export declare class BucketGrid2D<T> {
+    private readonly _dimensions;
+    private readonly _bounds;
+    private readonly _cells;
+    /**
+     * Holds elements that has been removed from the collection using {@link removeOverlappingElements}.
+     * This is used to avoid expensive re-allocations of cells when removing elements.
+     */
+    private readonly _removedElements;
+    constructor(bounds: THREE.Box2, dimensions: [width: number, height: number]);
+    insert(bounds: THREE.Box2, element: T): void;
+    overlappingElements(bounds: THREE.Box2): Generator<T>;
+    removeOverlappingElements(bounds: THREE.Box2): Generator<T>;
+    private cellsIntersecting;
+}

package/packages/tools/src/HtmlOverlay/HtmlOverlayTool.d.ts

@@ -1,160 +1,166 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
-import { Cognite3DViewer } from '../../../../core';
-/**
- * Callback that is triggered whenever the 2D position of an overlay is updated
- * in {@link HtmlOverlayTool}.
- */
-export declare type HtmlOverlayPositionUpdatedDelegate = (element: HTMLElement, position2D: THREE.Vector2, position3D: THREE.Vector3, distanceToCamera: number, userData: any) => void;
-/**
- * Callback that is triggered when a set of overlays are clustered together in
- * {@link HtmlOverlayTool}.
- */
-export declare type HtmlOverlayCreateClusterDelegate = (overlayElements: {
-    htmlElement: HTMLElement;
-    userData: any;
-}[]) => HTMLElement;
-/**
- * Options for an overlay added using {@link HtmlOverlayTool.add}.
- */
-export declare type HtmlOverlayOptions = {
-    /**
-     * Callback that is triggered whenever the position of the overlay is updated. Optional.
-     */
-    positionUpdatedCallback?: HtmlOverlayPositionUpdatedDelegate;
-    /**
-     * Optional user specified data that is provided to the {@link HtmlOverlayCreateClusterDelegate} and
-     * {@link HtmlOverlayPositionUpdatedDelegate}.
-     */
-    userData?: any;
-};
-/**
- * Controls how close overlay elements are clustered together.
- */
-export declare type HtmlOverlayToolClusteringOptions = {
-    /**
-     * Currently only 'overlapInScreenSpace' is supported. In this mode,
-     * overlays are clustered together into a single element as defined by
-     * the {@link createClusterElementCallback} and hidden when they overlap
-     * in screen space. The composite element is placed at the midpoint of
-     * all clustered elements.
-     *
-     * Clustered elements are faded in/out using CSS styling `transition`,
-     * `opacity` and `visibility`.
-     */
-    mode: 'overlapInScreenSpace';
-    /**
-     * Callback that is triggered when a set of overlays are clustered together
-     * to create a "composite" element as a placeholder for the clustered elements.
-     * Note that this callback will be triggered every frame for each cluster so it
-     * must be performant.
-     */
-    createClusterElementCallback: HtmlOverlayCreateClusterDelegate;
-};
-export declare type HtmlOverlayToolOptions = {
-    clusteringOptions?: HtmlOverlayToolClusteringOptions;
-};
-/**
- 
- * Manages HTMLoverlays for {@see Cognite3DViewer}. Attaches HTML elements to a
- * 3D position and updates its position/visibility as user moves the camera. This is
- * useful to create HTML overlays to highlight information about key positions in the 3D model.
- *
- * Attached elements *must* have CSS style 'position: absolute'. It's also recommended
- * in most cases to have styles 'pointer-events: none' and 'touch-action: none' to avoid
- * interfering with 3D navigation. Consider also applying 'transform: translate(-50%, -50%)'
- * to anchor the center of the element rather than the top-left corner. In some cases the
- * `zIndex`-attribute is necessary for the element to appear on top of the viewer.
- *
- * @example
- * ```js
- * const el = document.createElement('div');
- * el.style.position = 'absolute'; // Required!
- * // Anchor to center of element
- * el.style.transform = 'translate(-50%, -50%)';
- * // Avoid being target for events
- * el.style.pointerEvents = 'none;
- * el.style.touchAction = 'none';
- * // Render in front of other elements
- * el.style.zIndex = 10;
- *
- * el.style.color = 'red';
- * el.innerHtml = '<h1>Overlay</h1>';
- *
- * const overlayTool = new HtmlOverlayTool(viewer);
- * overlayTool.add(el, new THREE.Vector3(10, 10, 10));
- * // ...
- * overlayTool.remove(el);
- * // or, to remove all attached elements
- * overlayTool.clear();
- *
- * // detach the tool from the viewer
- * overlayTool.dispose();
- * ```
- */
-export declare class HtmlOverlayTool extends Cognite3DViewerToolBase {
-    private readonly _viewer;
-    private readonly _options;
-    private readonly _htmlOverlays;
-    private readonly _compositeOverlays;
-    private readonly _onSceneRenderedHandler;
-    private readonly _onViewerDisposedHandler;
-    private readonly _preallocatedVariables;
-    private readonly scheduleUpdate;
-    private get viewerDomElement();
-    private get viewerCamera();
-    private get viewerRenderer();
-    constructor(viewer: Cognite3DViewer, options?: HtmlOverlayToolOptions);
-    /**
-     * Returns all added HTML elements along with their 3D positions.
-     */
-    get elements(): {
-        element: HTMLElement;
-        position3D: THREE.Vector3;
-    }[];
-    /**
-     * Removes all elements and detaches from the viewer.
-     * @override
-     */
-    dispose(): void;
-    /**
-     * Registers a HTML overlay that will be updated on rendering.
-     *
-     * @param htmlElement
-     * @param position3D
-     * @param options
-     */
-    add(htmlElement: HTMLElement, position3D: THREE.Vector3, options?: HtmlOverlayOptions): void;
-    /**
-     * Removes a overlay and removes it from the DOM.
-     * @param htmlElement
-     */
-    remove(htmlElement: HTMLElement): void;
-    /**
-     * Removes all attached HTML overlay elements.
-     */
-    clear(): void;
-    /**
-     * Updates positions of all overlays. This is automatically managed and there
-     * shouldn't be any reason to trigger this unless the attached elements are
-     * modified externally.
-     *
-     * Calling this function often might cause degraded performance.
-     */
-    forceUpdate(): void;
-    /**
-     * Update size of new elements. This is only done once as this causes
-     * layout to be invalidated which is an expensive operation.
-     */
-    private updateNewElementSizes;
-    private commitDOMChanges;
-    private clusterElements;
-    private cleanupClusterElements;
-    private clusterByOverlapInScreenSpace;
-    private addComposite;
-    private onSceneRendered;
-    private onViewerDisposed;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+import { Cognite3DViewer } from '../../../api';
+/**
+ * Callback that is triggered whenever the 2D position of an overlay is updated
+ * in {@link HtmlOverlayTool}.
+ */
+export declare type HtmlOverlayPositionUpdatedDelegate = (element: HTMLElement, position2D: THREE.Vector2, position3D: THREE.Vector3, distanceToCamera: number, userData: any) => void;
+/**
+ * Callback that is triggered when a set of overlays are clustered together in
+ * {@link HtmlOverlayTool}.
+ */
+export declare type HtmlOverlayCreateClusterDelegate = (overlayElements: {
+    htmlElement: HTMLElement;
+    userData: any;
+}[]) => HTMLElement;
+/**
+ * Options for an overlay added using {@link HtmlOverlayTool.add}.
+ */
+export declare type HtmlOverlayOptions = {
+    /**
+     * Callback that is triggered whenever the position of the overlay is updated. Optional.
+     */
+    positionUpdatedCallback?: HtmlOverlayPositionUpdatedDelegate;
+    /**
+     * Optional user specified data that is provided to the {@link HtmlOverlayCreateClusterDelegate} and
+     * {@link HtmlOverlayPositionUpdatedDelegate}.
+     */
+    userData?: any;
+};
+/**
+ * Controls how close overlay elements are clustered together.
+ */
+export declare type HtmlOverlayToolClusteringOptions = {
+    /**
+     * Currently only 'overlapInScreenSpace' is supported. In this mode,
+     * overlays are clustered together into a single element as defined by
+     * the {@link createClusterElementCallback} and hidden when they overlap
+     * in screen space. The composite element is placed at the midpoint of
+     * all clustered elements.
+     *
+     * Clustered elements are faded in/out using CSS styling `transition`,
+     * `opacity` and `visibility`.
+     */
+    mode: 'overlapInScreenSpace';
+    /**
+     * Callback that is triggered when a set of overlays are clustered together
+     * to create a "composite" element as a placeholder for the clustered elements.
+     * Note that this callback will be triggered every frame for each cluster so it
+     * must be performant.
+     */
+    createClusterElementCallback: HtmlOverlayCreateClusterDelegate;
+};
+export declare type HtmlOverlayToolOptions = {
+    clusteringOptions?: HtmlOverlayToolClusteringOptions;
+};
+/**
+ 
+ * Manages HTMLoverlays for {@link Cognite3DViewer}. Attaches HTML elements to a
+ * 3D position and updates its position/visibility as user moves the camera. This is
+ * useful to create HTML overlays to highlight information about key positions in the 3D model.
+ *
+ * Attached elements *must* have CSS style 'position: absolute'. It's also recommended
+ * in most cases to have styles 'pointer-events: none' and 'touch-action: none' to avoid
+ * interfering with 3D navigation. Consider also applying 'transform: translate(-50%, -50%)'
+ * to anchor the center of the element rather than the top-left corner. In some cases the
+ * `zIndex`-attribute is necessary for the element to appear on top of the viewer.
+ *
+ * @example
+ * ```js
+ * const el = document.createElement('div');
+ * el.style.position = 'absolute'; // Required!
+ * // Anchor to center of element
+ * el.style.transform = 'translate(-50%, -50%)';
+ * // Avoid being target for events
+ * el.style.pointerEvents = 'none;
+ * el.style.touchAction = 'none';
+ * // Render in front of other elements
+ * el.style.zIndex = 10;
+ *
+ * el.style.color = 'red';
+ * el.innerHtml = '<h1>Overlay</h1>';
+ *
+ * const overlayTool = new HtmlOverlayTool(viewer);
+ * overlayTool.add(el, new THREE.Vector3(10, 10, 10));
+ * // ...
+ * overlayTool.remove(el);
+ * // or, to remove all attached elements
+ * overlayTool.clear();
+ *
+ * // detach the tool from the viewer
+ * overlayTool.dispose();
+ * ```
+ */
+export declare class HtmlOverlayTool extends Cognite3DViewerToolBase {
+    private readonly _viewer;
+    private readonly _options;
+    private readonly _htmlOverlays;
+    private readonly _compositeOverlays;
+    private _visible;
+    private readonly _onSceneRenderedHandler;
+    private readonly _onViewerDisposedHandler;
+    private readonly _preallocatedVariables;
+    private readonly scheduleUpdate;
+    private get viewerDomElement();
+    private get viewerCamera();
+    private get viewerRenderer();
+    constructor(viewer: Cognite3DViewer, options?: HtmlOverlayToolOptions);
+    /**
+     * Returns all added HTML elements along with their 3D positions.
+     */
+    get elements(): {
+        element: HTMLElement;
+        position3D: THREE.Vector3;
+    }[];
+    /**
+     * Removes all elements and detaches from the viewer.
+     * @override
+     */
+    dispose(): void;
+    /**
+     * Registers a HTML overlay that will be updated on rendering.
+     *
+     * @param htmlElement
+     * @param position3D
+     * @param options
+     */
+    add(htmlElement: HTMLElement, position3D: THREE.Vector3, options?: HtmlOverlayOptions): void;
+    /**
+     * Removes a overlay and removes it from the DOM.
+     * @param htmlElement
+     */
+    remove(htmlElement: HTMLElement): void;
+    /**
+     * Removes all attached HTML overlay elements.
+     */
+    clear(): void;
+    /**
+     * Hide/unhide all HTML overlay elements.
+     * @param enable
+     */
+    visible(enable: boolean): void;
+    /**
+     * Updates positions of all overlays. This is automatically managed and there
+     * shouldn't be any reason to trigger this unless the attached elements are
+     * modified externally.
+     *
+     * Calling this function often might cause degraded performance.
+     */
+    forceUpdate(): void;
+    /**
+     * Update size of new elements. This is only done once as this causes
+     * layout to be invalidated which is an expensive operation.
+     */
+    private updateNewElementSizes;
+    private commitDOMChanges;
+    private clusterElements;
+    private cleanupClusterElements;
+    private clusterByOverlapInScreenSpace;
+    private addComposite;
+    private onSceneRendered;
+    private onViewerDisposed;
+}

package/packages/tools/src/Measurement/MeasurementLabels.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export declare class MeasurementLabels {
+    static readonly stylesId = "reveal-measurement-label";
+    constructor();
+    /**
+     * Create a HTML element with a string and return the element.
+     * @param label String on the label.
+     * @returns HTMLDivElement.
+     */
+    createLabel(label: string): HTMLDivElement;
+    /**
+     * Load the the styles from the CSS and appends them to the label.
+     * @returns Return if styles already loaded.
+     */
+    private static ensureStylesLoaded;
+}

package/packages/tools/src/Measurement/MeasurementLine.d.ts

@@ -0,0 +1,44 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+export declare class MeasurementLine {
+    private readonly _geometry;
+    private readonly _meshes;
+    private readonly _fixedWidthLineMaterial;
+    private readonly _adaptiveWidthLineMaterial;
+    private readonly _position;
+    constructor(lineWidth: number, lineColor: THREE.Color, startPoint: THREE.Vector3);
+    dispose(): void;
+    get meshes(): THREE.Group;
+    /**
+     * Update the measuring line end point.
+     * @param endPoint Second point of the line to end the measurement.
+     */
+    updateLine(endPoint: THREE.Vector3): void;
+    /**
+     * Get the distance between the measuring line start point & end point.
+     * @returns Return distance between start & end point of the line.
+     */
+    getMeasuredDistance(): number;
+    /**
+     * Calculate mid point on the Line.
+     * @returns Returns mid point between start and end points.
+     */
+    getMidPointOnLine(): THREE.Vector3;
+    /**
+     * Update current line width.
+     * @param lineWidth Width of the measuring line mesh.
+     */
+    updateLineWidth(lineWidth: number): void;
+    /**
+     * Update current line color.
+     * @param color Color of the measuring line mesh.
+     */
+    updateLineColor(color: THREE.Color): void;
+    /**
+     * Generate line geometry and create the mesh.
+     * @param point Point from where the line will be generated.
+     */
+    private startLine;
+}

package/packages/tools/src/Measurement/MeasurementManager.d.ts

@@ -0,0 +1,66 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { HtmlOverlayTool } from '../HtmlOverlay/HtmlOverlayTool';
+import { MeasurementOptions } from './types';
+export declare type Measurement = {
+    readonly measurementId: number;
+    readonly startPoint: THREE.Vector3;
+    readonly endPoint: THREE.Vector3;
+    readonly distanceInMeters: number;
+};
+export declare class MeasurementManager {
+    private readonly _measurementLabel;
+    private readonly _line;
+    private readonly _options;
+    private readonly _domElement;
+    private readonly _camera;
+    private readonly _meshGroup;
+    private readonly _htmlOverlay;
+    private _labelElement;
+    private readonly _distanceToCamera;
+    private readonly _startPoint;
+    private _measurement;
+    constructor(viewerDomElement: HTMLElement, camera: THREE.Camera, meshGroup: THREE.Group, options: Required<MeasurementOptions>, overlay: HtmlOverlayTool, startPoint: THREE.Vector3);
+    /**
+     * Update the measurement line end point to the provided mouse coordinates
+     */
+    update(mouseEvent: {
+        offsetX: number;
+        offsetY: number;
+    }): void;
+    /**
+     * End the measurement.
+     * @param point World position at which measuring line ends.
+     */
+    endMeasurement(point: THREE.Vector3): void;
+    /**
+     * Remove the measurement.
+     */
+    removeMeasurement(): void;
+    getMeasurement(): Readonly<Measurement>;
+    /**
+     * Update current line width.
+     * @param lineWidth Width of the measuring line mesh.
+     */
+    updateLineWidth(lineWidth: number): void;
+    /**
+     * Update current line color.
+     * @param color Color of the measuring line mesh.
+     */
+    updateLineColor(color: THREE.Color): void;
+    /**
+     * Start the measurement.
+     * @param point World position to start measurement operation from.
+     */
+    private startMeasurement;
+    /**
+     * Creates a measurement label, add it to HTMLOverlay and return the created label element.
+     * @param position Label position.
+     * @param label Label text.
+     * @returns HTML element.
+     */
+    private addLabel;
+    private pointerTo3DPosition;
+}