@cognite/reveal 2.2.2 → 2.3.0

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

@@ -1,98 +1,98 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Configuration of {@link AxisViewTool}.
- */
-export declare type AxisBoxConfig = {
-    /**
-     * Size in pixels of the axis tool.
-     */
-    size?: number;
-    /**
-     * Position, either absolute or relative.
-     */
-    position?: AbsolutePosition | RelativePosition;
-    /**
-     * How long the camera animation lasts when
-     * clicking a face of the orientation box.
-     */
-    animationSpeed?: number;
-    /**
-     * Configuration for each of the faces of the orientation box.
-     * Note that Reveal uses a right-handed Y up coordinate system,
-     * which might differ from the original model space. To account
-     * for this, you might want to reassign labels of the faces.
-     */
-    faces?: {
-        xPositiveFace?: AxisBoxFaceConfig;
-        xNegativeFace?: AxisBoxFaceConfig;
-        yPositiveFace?: AxisBoxFaceConfig;
-        yNegativeFace?: AxisBoxFaceConfig;
-        zPositiveFace?: AxisBoxFaceConfig;
-        zNegativeFace?: AxisBoxFaceConfig;
-    };
-    /**
-     * Configuration of the compass "base" of the tool.
-     */
-    compass?: AxisBoxCompassConfig;
-};
-/**
- * Absolute position in pixels.
- */
-export declare type AbsolutePosition = {
-    xAbsolute: number;
-    yAbsolute: number;
-};
-/**
- * Relative position from a corner of the viewer
- * and a given padding.
- */
-export declare type RelativePosition = {
-    corner: Corner;
-    padding: THREE.Vector2;
-};
-/**
- * Configuration of each face of the orientation box.
- */
-export declare type AxisBoxFaceConfig = {
-    /**
-     * Label of the respective face, e.g. 'X' or 'Right'.
-     */
-    label?: string;
-    fontSize?: number;
-    fontColor?: THREE.Color;
-    outlineSize?: number;
-    outlineColor?: THREE.Color;
-    faceColor?: THREE.Color;
-};
-/**
- * Configuration of the compass.
- */
-export declare type AxisBoxCompassConfig = {
-    /**
-     * Label of the orientation indicator. Defaults
-     * to 'N' for north.
-     */
-    ringLabel?: string;
-    /**
-     * Offset in radians of the orientation indicator.
-     */
-    labelDelta?: number;
-    fontSize?: number;
-    fontColor?: THREE.Color;
-    tickColor?: THREE.Color;
-};
-/**
- * A corner of the viewer.
- */
-export declare enum Corner {
-    TopRight = 0,
-    TopLeft = 1,
-    BottomLeft = 2,
-    BottomRight = 3
-}
-export declare const defaultAxisBoxCompassConfig: AxisBoxCompassConfig;
-export declare const defaultFaceConfig: AxisBoxFaceConfig;
-export declare const defaultAxisBoxConfig: Required<AxisBoxConfig>;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Configuration of {@link AxisViewTool}.
+ */
+export declare type AxisBoxConfig = {
+    /**
+     * Size in pixels of the axis tool.
+     */
+    size?: number;
+    /**
+     * Position, either absolute or relative.
+     */
+    position?: AbsolutePosition | RelativePosition;
+    /**
+     * How long the camera animation lasts when
+     * clicking a face of the orientation box.
+     */
+    animationSpeed?: number;
+    /**
+     * Configuration for each of the faces of the orientation box.
+     * Note that Reveal uses a right-handed Y up coordinate system,
+     * which might differ from the original model space. To account
+     * for this, you might want to reassign labels of the faces.
+     */
+    faces?: {
+        xPositiveFace?: AxisBoxFaceConfig;
+        xNegativeFace?: AxisBoxFaceConfig;
+        yPositiveFace?: AxisBoxFaceConfig;
+        yNegativeFace?: AxisBoxFaceConfig;
+        zPositiveFace?: AxisBoxFaceConfig;
+        zNegativeFace?: AxisBoxFaceConfig;
+    };
+    /**
+     * Configuration of the compass "base" of the tool.
+     */
+    compass?: AxisBoxCompassConfig;
+};
+/**
+ * Absolute position in pixels.
+ */
+export declare type AbsolutePosition = {
+    xAbsolute: number;
+    yAbsolute: number;
+};
+/**
+ * Relative position from a corner of the viewer
+ * and a given padding.
+ */
+export declare type RelativePosition = {
+    corner: Corner;
+    padding: THREE.Vector2;
+};
+/**
+ * Configuration of each face of the orientation box.
+ */
+export declare type AxisBoxFaceConfig = {
+    /**
+     * Label of the respective face, e.g. 'X' or 'Right'.
+     */
+    label?: string;
+    fontSize?: number;
+    fontColor?: THREE.Color;
+    outlineSize?: number;
+    outlineColor?: THREE.Color;
+    faceColor?: THREE.Color;
+};
+/**
+ * Configuration of the compass.
+ */
+export declare type AxisBoxCompassConfig = {
+    /**
+     * Label of the orientation indicator. Defaults
+     * to 'N' for north.
+     */
+    ringLabel?: string;
+    /**
+     * Offset in radians of the orientation indicator.
+     */
+    labelDelta?: number;
+    fontSize?: number;
+    fontColor?: THREE.Color;
+    tickColor?: THREE.Color;
+};
+/**
+ * A corner of the viewer.
+ */
+export declare enum Corner {
+    TopRight = 0,
+    TopLeft = 1,
+    BottomLeft = 2,
+    BottomRight = 3
+}
+export declare const defaultAxisBoxCompassConfig: AxisBoxCompassConfig;
+export declare const defaultFaceConfig: AxisBoxFaceConfig;
+export declare const defaultAxisBoxConfig: Required<AxisBoxConfig>;

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

@@ -1,25 +1,25 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Base class for tools attaching to a {@see Cognite3DViewer}.
- */
-export declare abstract class Cognite3DViewerToolBase {
-    private readonly _disposedEvent;
-    private _disposed;
-    /**
-     * Unregisters an event handler for the 'disposed'-event.
-     * @param event
-     * @param handler
-     */
-    off(event: 'disposed', handler: () => void): void;
-    /**
-     * Disposes the element and triggeres the 'disposed' event before clearing the list
-     * of dipose-listeners.
-     */
-    dispose(): void;
-    /**
-     * Throws an error if the instance has been disposed.
-     */
-    protected ensureNotDisposed(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Base class for tools attaching to a {@see Cognite3DViewer}.
+ */
+export declare abstract class Cognite3DViewerToolBase {
+    private readonly _disposedEvent;
+    private _disposed;
+    /**
+     * Unregisters an event handler for the 'disposed'-event.
+     * @param event
+     * @param handler
+     */
+    off(event: 'disposed', handler: () => void): void;
+    /**
+     * Disposes the element and triggeres the 'disposed' event before clearing the list
+     * of dipose-listeners.
+     */
+    dispose(): void;
+    /**
+     * Throws an error if the instance has been disposed.
+     */
+    protected ensureNotDisposed(): void;
+}

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

@@ -1,20 +1,20 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Cognite3DViewer } from '../../../core';
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-export declare class DebugCameraTool extends Cognite3DViewerToolBase {
-    private readonly _viewer;
-    private readonly _onViewerDisposedHandler;
-    private _cameraHelper?;
-    private get viewerCamera();
-    constructor(viewer: Cognite3DViewer);
-    /**
-     * Removes all elements and detaches from the viewer.
-     * @override
-     */
-    dispose(): void;
-    showCameraHelper(): void;
-    hideCameraHelper(): void;
-    private onViewerDisposed;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Cognite3DViewer } from '../../../core';
+import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
+export declare class DebugCameraTool extends Cognite3DViewerToolBase {
+    private readonly _viewer;
+    private readonly _onViewerDisposedHandler;
+    private _cameraHelper?;
+    private get viewerCamera();
+    constructor(viewer: Cognite3DViewer);
+    /**
+     * Removes all elements and detaches from the viewer.
+     * @override
+     */
+    dispose(): void;
+    showCameraHelper(): void;
+    hideCameraHelper(): void;
+    private onViewerDisposed;
+}

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

@@ -1,23 +1,23 @@
-import { Cognite3DViewer, Cognite3DModel } from '../../../core';
-import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
-export declare type DebugLoadedSectorsToolOptions = {
-    showSimpleSectors?: boolean;
-    showDetailedSectors?: boolean;
-    showDiscardedSectors?: boolean;
-    colorBy?: 'depth' | 'lod' | 'loadedTimestamp' | 'random';
-    leafsOnly?: boolean;
-    sectorPathFilterRegex?: string;
-};
-export declare class DebugLoadedSectorsTool extends Cognite3DViewerToolBase {
-    private readonly _boundingBoxes;
-    private readonly _viewer;
-    private _options;
-    private _model?;
-    constructor(viewer: Cognite3DViewer, options?: DebugLoadedSectorsToolOptions);
-    setOptions(options: DebugLoadedSectorsToolOptions): void;
-    dispose(): void;
-    showSectorBoundingBoxes(model: Cognite3DModel): void;
-    private updateBoundingBoxes;
-    private isSectorAcceptedByCurrentFilter;
-    private createBboxNodeFor;
-}
+import { Cognite3DViewer, Cognite3DModel } from '../../../core';
+import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
+export declare type DebugLoadedSectorsToolOptions = {
+    showSimpleSectors?: boolean;
+    showDetailedSectors?: boolean;
+    showDiscardedSectors?: boolean;
+    colorBy?: 'depth' | 'lod' | 'loadedTimestamp' | 'random';
+    leafsOnly?: boolean;
+    sectorPathFilterRegex?: string;
+};
+export declare class DebugLoadedSectorsTool extends Cognite3DViewerToolBase {
+    private readonly _boundingBoxes;
+    private readonly _viewer;
+    private _options;
+    private _model?;
+    constructor(viewer: Cognite3DViewer, options?: DebugLoadedSectorsToolOptions);
+    setOptions(options: DebugLoadedSectorsToolOptions): void;
+    dispose(): void;
+    showSectorBoundingBoxes(model: Cognite3DModel): void;
+    private updateBoundingBoxes;
+    private isSectorAcceptedByCurrentFilter;
+    private createBboxNodeFor;
+}

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 { 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;
+}

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

@@ -1,17 +1,17 @@
-import { Cognite3DViewer } from '../../../../core';
-import { LatLongPosition, MapConfig } from './MapConfig';
-export declare class Geomap {
-    private readonly _viewer;
-    private readonly _map;
-    private _intervalId;
-    private readonly _onCameraChange;
-    constructor(viewer: Cognite3DViewer, mapConfig: MapConfig);
-    private requestRedraw;
-    private getMapProvider;
-    latLongToWorldCoordinates(latLong: LatLongPosition): {
-        x: number;
-        y: number;
-    };
-    private handleCameraChange;
-    dispose(): void;
-}
+import { Cognite3DViewer } from '../../../../core';
+import { LatLongPosition, MapConfig } from './MapConfig';
+export declare class Geomap {
+    private readonly _viewer;
+    private readonly _map;
+    private _intervalId;
+    private readonly _onCameraChange;
+    constructor(viewer: Cognite3DViewer, mapConfig: MapConfig);
+    private requestRedraw;
+    private getMapProvider;
+    latLongToWorldCoordinates(latLong: LatLongPosition): {
+        x: number;
+        y: number;
+    };
+    private handleCameraChange;
+    dispose(): void;
+}

package/packages/tools/src/Geomap/GeomapTool.d.ts

@@ -1,24 +1,24 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
-import { LatLongPosition, MapConfig } from './MapConfig';
-import { Cognite3DViewer } from '../../../../core';
-/**
- * The `GeomapTool` is a geolocation for the models and allow the user to place them on the maps.
- * @version New since 2.1.
- */
-export declare class GeomapTool extends Cognite3DViewerToolBase {
-    private readonly _viewer;
-    private readonly _maps;
-    constructor(viewer: Cognite3DViewer, config: MapConfig);
-    /**
-     * Converts Latitude & Longitude into Vector2 World coordinates on the Map
-     * @param latLong Latitude & Longitude
-     */
-    latLongToWorldCoordinates(latLong: LatLongPosition): {
-        x: number;
-        y: number;
-    };
-    dispose(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+import { LatLongPosition, MapConfig } from './MapConfig';
+import { Cognite3DViewer } from '../../../../core';
+/**
+ * The `GeomapTool` is a geolocation for the models and allow the user to place them on the maps.
+ * @version New since 2.1.
+ */
+export declare class GeomapTool extends Cognite3DViewerToolBase {
+    private readonly _viewer;
+    private readonly _maps;
+    constructor(viewer: Cognite3DViewer, config: MapConfig);
+    /**
+     * Converts Latitude & Longitude into Vector2 World coordinates on the Map
+     * @param latLong Latitude & Longitude
+     */
+    latLongToWorldCoordinates(latLong: LatLongPosition): {
+        x: number;
+        y: number;
+    };
+    dispose(): void;
+}