@cognite/reveal 2.2.2 → 2.3.0

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

@@ -1,159 +1,159 @@
-/*!
- * 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 '../../../../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;
+}

package/packages/tools/src/Timeline/Keyframe.d.ts

@@ -1,38 +1,38 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodeCollectionBase, NodeAppearance } from '../../../../core/src';
-import { Cognite3DModel } from '../../../../core';
-/**
- * Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline
- */
-export declare class Keyframe {
-    private readonly _date;
-    private readonly _model;
-    private readonly _nodeCollectionAndAppearance;
-    constructor(model: Cognite3DModel, date: Date);
-    /**
-     * Get date of the Keyframe
-     * @returns date
-     */
-    getKeyframeDate(): Date;
-    /**
-     * Assigns the styles for the node set for the model for this Keyframe
-     */
-    activate(): void;
-    /**
-     * Removes the style for the model
-     */
-    deactivate(): void;
-    /**
-     * Add node & style to the collection
-     * @param nodeCollection Node set to apply the Styles
-     * @param nodeAppearance Style to assign to the node collection
-     */
-    assignStyledNodeCollection(nodeCollection: NodeCollectionBase, nodeAppearance: NodeAppearance): void;
-    /**
-     * Remove Node & Style for this keyframe's nodeCollection and nodeAppearance
-     * @param nodeCollection Nodes to be unassign from node collection
-     */
-    unassignStyledNodeCollection(nodeCollection: NodeCollectionBase): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodeCollectionBase, NodeAppearance } from '../../../../core/src';
+import { Cognite3DModel } from '../../../../core';
+/**
+ * Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline
+ */
+export declare class Keyframe {
+    private readonly _date;
+    private readonly _model;
+    private readonly _nodeCollectionAndAppearance;
+    constructor(model: Cognite3DModel, date: Date);
+    /**
+     * Get date of the Keyframe
+     * @returns date
+     */
+    getKeyframeDate(): Date;
+    /**
+     * Assigns the styles for the node set for the model for this Keyframe
+     */
+    activate(): void;
+    /**
+     * Removes the style for the model
+     */
+    deactivate(): void;
+    /**
+     * Add node & style to the collection
+     * @param nodeCollection Node set to apply the Styles
+     * @param nodeAppearance Style to assign to the node collection
+     */
+    assignStyledNodeCollection(nodeCollection: NodeCollectionBase, nodeAppearance: NodeAppearance): void;
+    /**
+     * Remove Node & Style for this keyframe's nodeCollection and nodeAppearance
+     * @param nodeCollection Nodes to be unassign from node collection
+     */
+    unassignStyledNodeCollection(nodeCollection: NodeCollectionBase): void;
+}

package/packages/tools/src/Timeline/TimelineTool.d.ts

@@ -1,79 +1,79 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Cognite3DModel } from '../../../../core';
-import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
-import { Keyframe } from './Keyframe';
-import { TimelineDateUpdateDelegate } from './types';
-/**
- * Tool to applying styles to nodes based on date to play them over in Timeline
- */
-export declare class TimelineTool extends Cognite3DViewerToolBase {
-    private readonly _model;
-    private readonly _keyframes;
-    private _playback;
-    private readonly _events;
-    constructor(cadModel: Cognite3DModel);
-    /**
-     * Subscribe to the Date changed event
-     * @param event `dateChanged` event
-     * @param listener Listen to Timeline date Update during Playback
-     */
-    subscribe(event: 'dateChanged', listener: TimelineDateUpdateDelegate): void;
-    /**
-     * Unsubscribe to the Date changed event
-     * @param event `dateChanged` event
-     * @param listener Remove Listen to Timeline date Update
-     */
-    unsubscribe(event: 'dateChanged', listener: TimelineDateUpdateDelegate): void;
-    /**
-     * Create Key frame for the Timeline
-     * @param date - date value by Date.now() since January 1, 1970
-     */
-    createKeyframe(date: Date): Keyframe;
-    /**
-     * Returns the keyframe at the date given, or undefined if not found.
-     * @param date
-     * @returns
-     */
-    getKeyframeByDate(date: Date): Keyframe | undefined;
-    /**
-     * Removes the Keyframe from the timeline. Does nothing if the keyframe isn't part of the timeline.
-     * @param keyframe - Keyframe to be removed from the timeline
-     */
-    removeKeyframe(keyframe: Keyframe): void;
-    /**
-     * Removes the Keyframe from the Timeline
-     * @param date - Date of the Keyframe to be removed from the Timeline
-     */
-    removeKeyframeByDate(date: Date): void;
-    /**
-     * Starts playback of Timeline
-     * @param startDate - Keyframe date to start the Playback of Keyframes
-     * @param endDate - Keyframe date to stop the Playback of Keyframes
-     * @param totalDurationInMilliSeconds - Number of milliseconds for all Keyframe within startDate & endDate to be rendered
-     */
-    play(startDate: Date, endDate: Date, totalDurationInMilliSeconds: number): void;
-    /**
-     * Stops any ongoing playback
-     */
-    stop(): void;
-    /**
-     * Pause any ongoing playback
-     */
-    pause(): void;
-    /**
-     * Resume any paused playback
-     */
-    resume(): void;
-    /**
-     * Provides all Keyframes in the Timeline
-     * @returns All Keyframes in Timeline
-     */
-    getAllKeyframes(): Keyframe[];
-    dispose(): void;
-    /**
-     * Sort the Timeline Keyframe by their Date
-     */
-    private sortKeyframesByDates;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Cognite3DModel } from '../../../../core';
+import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+import { Keyframe } from './Keyframe';
+import { TimelineDateUpdateDelegate } from './types';
+/**
+ * Tool to applying styles to nodes based on date to play them over in Timeline
+ */
+export declare class TimelineTool extends Cognite3DViewerToolBase {
+    private readonly _model;
+    private readonly _keyframes;
+    private _playback;
+    private readonly _events;
+    constructor(cadModel: Cognite3DModel);
+    /**
+     * Subscribe to the Date changed event
+     * @param event `dateChanged` event
+     * @param listener Listen to Timeline date Update during Playback
+     */
+    subscribe(event: 'dateChanged', listener: TimelineDateUpdateDelegate): void;
+    /**
+     * Unsubscribe to the Date changed event
+     * @param event `dateChanged` event
+     * @param listener Remove Listen to Timeline date Update
+     */
+    unsubscribe(event: 'dateChanged', listener: TimelineDateUpdateDelegate): void;
+    /**
+     * Create Key frame for the Timeline
+     * @param date - date value by Date.now() since January 1, 1970
+     */
+    createKeyframe(date: Date): Keyframe;
+    /**
+     * Returns the keyframe at the date given, or undefined if not found.
+     * @param date
+     * @returns
+     */
+    getKeyframeByDate(date: Date): Keyframe | undefined;
+    /**
+     * Removes the Keyframe from the timeline. Does nothing if the keyframe isn't part of the timeline.
+     * @param keyframe - Keyframe to be removed from the timeline
+     */
+    removeKeyframe(keyframe: Keyframe): void;
+    /**
+     * Removes the Keyframe from the Timeline
+     * @param date - Date of the Keyframe to be removed from the Timeline
+     */
+    removeKeyframeByDate(date: Date): void;
+    /**
+     * Starts playback of Timeline
+     * @param startDate - Keyframe date to start the Playback of Keyframes
+     * @param endDate - Keyframe date to stop the Playback of Keyframes
+     * @param totalDurationInMilliSeconds - Number of milliseconds for all Keyframe within startDate & endDate to be rendered
+     */
+    play(startDate: Date, endDate: Date, totalDurationInMilliSeconds: number): void;
+    /**
+     * Stops any ongoing playback
+     */
+    stop(): void;
+    /**
+     * Pause any ongoing playback
+     */
+    pause(): void;
+    /**
+     * Resume any paused playback
+     */
+    resume(): void;
+    /**
+     * Provides all Keyframes in the Timeline
+     * @returns All Keyframes in Timeline
+     */
+    getAllKeyframes(): Keyframe[];
+    dispose(): void;
+    /**
+     * Sort the Timeline Keyframe by their Date
+     */
+    private sortKeyframesByDates;
+}

package/packages/tools/src/Timeline/types.d.ts

@@ -1,13 +1,13 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Keyframe } from './Keyframe';
-/**
- * Delegate for Timeline Date update
- */
-export declare type TimelineDateUpdateDelegate = (event: {
-    date: Date;
-    activeKeyframe: Keyframe | undefined;
-    startDate: Date;
-    endDate: Date;
-}) => void;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Keyframe } from './Keyframe';
+/**
+ * Delegate for Timeline Date update
+ */
+export declare type TimelineDateUpdateDelegate = (event: {
+    date: Date;
+    activeKeyframe: Keyframe | undefined;
+    startDate: Date;
+    endDate: Date;
+}) => void;

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

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare type DisposedDelegate = () => void;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare type DisposedDelegate = () => void;

package/packages/utilities/index.d.ts

@@ -1,24 +1,24 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { traverseDepthFirst } from './src/objectTraversal';
-export { transformCameraConfiguration } from './src/transformCameraConfiguration';
-export { RandomColors } from './src/RandomColors';
-export { CameraConfiguration } from './src/CameraConfiguration';
-export { EventTrigger, clickOrTouchEventOffset } from './src/events';
-export { assertNever } from './src/assertNever';
-export { NumericRange } from './src/NumericRange';
-export { determinePowerOfTwoDimensions } from './src/determinePowerOfTwoDimensions';
-export { IndexSet } from './src/IndexSet';
-export { packFloatInto } from './src/packFloat';
-export { DynamicDefragmentedBuffer } from './src/datastructures/DynamicDefragmentedBuffer';
-export { AutoDisposeGroup } from './src/three/AutoDisposeGroup';
-export { BoundingBoxLOD } from './src/three/BoundingBoxLOD';
-export { getBox3CornerPoints } from './src/three/getBox3CornerPoints';
-export { isMobileOrTablet } from './src/isMobileOrTablet';
-export { WebGLRendererStateHelper } from './src/WebGLRendererStateHelper';
-export { WorkerPool } from './src/workers/WorkerPool';
-export { MemoryRequestCache } from './src/cache/MemoryRequestCache';
-export { MostFrequentlyUsedCache } from './src/cache/MostFrequentlyUsedCache';
-export { disposeAttributeArrayOnUpload } from './src/disposeAttributeArrayOnUpload';
-export { revealEnv } from './src/revealEnv';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { traverseDepthFirst } from './src/objectTraversal';
+export { transformCameraConfiguration } from './src/transformCameraConfiguration';
+export { RandomColors } from './src/RandomColors';
+export { CameraConfiguration } from './src/CameraConfiguration';
+export { EventTrigger, clickOrTouchEventOffset, InputHandler, disposeOfAllEventListeners } from './src/events';
+export { assertNever } from './src/assertNever';
+export { NumericRange } from './src/NumericRange';
+export { determinePowerOfTwoDimensions } from './src/determinePowerOfTwoDimensions';
+export { IndexSet } from './src/IndexSet';
+export { packFloatInto } from './src/packFloat';
+export { DynamicDefragmentedBuffer } from './src/datastructures/DynamicDefragmentedBuffer';
+export { AutoDisposeGroup } from './src/three/AutoDisposeGroup';
+export { BoundingBoxLOD } from './src/three/BoundingBoxLOD';
+export { getBox3CornerPoints } from './src/three/getBox3CornerPoints';
+export { isMobileOrTablet } from './src/isMobileOrTablet';
+export { WebGLRendererStateHelper } from './src/WebGLRendererStateHelper';
+export { WorkerPool } from './src/workers/WorkerPool';
+export { MemoryRequestCache } from './src/cache/MemoryRequestCache';
+export { MostFrequentlyUsedCache } from './src/cache/MostFrequentlyUsedCache';
+export { disposeAttributeArrayOnUpload } from './src/disposeAttributeArrayOnUpload';
+export { revealEnv } from './src/revealEnv';