@cognite/reveal 3.0.2 → 3.2.0

package/packages/utilities/src/objectTraversal.d.ts

@@ -1,8 +1,8 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-interface WithChildren<T> {
-    readonly children: T[];
-}
-export declare function traverseDepthFirst<T extends WithChildren<T>>(root: T, visitor: (element: T) => boolean): void;
-export {};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+interface WithChildren<T> {
+    readonly children: T[];
+}
+export declare function traverseDepthFirst<T extends WithChildren<T>>(root: T, visitor: (element: T) => boolean): void;
+export {};

package/packages/utilities/src/revealEnv.d.ts

@@ -1,10 +1,10 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Used to specify custom url for worker/wasm files
- * in cases when you need the latest local files or CDN is blocked by CSP.
- */
-export declare const revealEnv: {
-    publicPath: string;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Used to specify custom url for worker/wasm files
+ * in cases when you need the latest local files or CDN is blocked by CSP.
+ */
+export declare const revealEnv: {
+    publicPath: string;
+};

package/packages/utilities/src/three/AutoDisposeGroup.d.ts

@@ -1,17 +1,17 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Referenced count implementation of THREE.Group that
- * automatically disposes all geometries contained in meshes that
- * are direct children of the group.
- */
-export declare class AutoDisposeGroup extends THREE.Group {
-    private _isDisposed;
-    private _referenceCount;
-    reference(): void;
-    dereference(): void;
-    private dispose;
-    private ensureNotDisposed;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Referenced count implementation of THREE.Group that
+ * automatically disposes all geometries contained in meshes that
+ * are direct children of the group.
+ */
+export declare class AutoDisposeGroup extends THREE.Group {
+    private _isDisposed;
+    private _referenceCount;
+    reference(): void;
+    dereference(): void;
+    private dispose;
+    private ensureNotDisposed;
+}

package/packages/utilities/src/three/BoundingBoxLOD.d.ts

@@ -1,27 +1,27 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Class similar to THREE.LOD except that it doesn't use `matrixWorld` to determine distance to camera, but a
- * bounding box.
- */
-export declare class BoundingBoxLOD extends THREE.Object3D {
-    private readonly _boundingBox;
-    private _activeLevel;
-    private readonly _levels;
-    readonly isLOD = true;
-    readonly autoUpdate = true;
-    constructor(boundingBox: THREE.Box3);
-    setBoundingBox(boundingBox: THREE.Box3): void;
-    addLevel(object: THREE.Object3D, distance?: number): void;
-    /**
-     * Returns the index of the current active LOD. 0 means highest detail.
-     */
-    getCurrentLevel(): number;
-    /**
-     * Update selected LOD level based on distance to camera.
-     */
-    update(camera: THREE.Camera): void;
-    private updateCurrentLevel;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Class similar to THREE.LOD except that it doesn't use `matrixWorld` to determine distance to camera, but a
+ * bounding box.
+ */
+export declare class BoundingBoxLOD extends THREE.Object3D {
+    private readonly _boundingBox;
+    private _activeLevel;
+    private readonly _levels;
+    readonly isLOD = true;
+    readonly autoUpdate = true;
+    constructor(boundingBox: THREE.Box3);
+    setBoundingBox(boundingBox: THREE.Box3): void;
+    addLevel(object: THREE.Object3D, distance?: number): void;
+    /**
+     * Returns the index of the current active LOD. 0 means highest detail.
+     */
+    getCurrentLevel(): number;
+    /**
+     * Update selected LOD level based on distance to camera.
+     */
+    update(camera: THREE.Camera): void;
+    private updateCurrentLevel;
+}

package/packages/utilities/src/three/createFullScreenTriangleGeometry.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+export declare function createRenderTriangle(): THREE.BufferGeometry;

package/packages/utilities/src/three/fitCameraToBoundingBox.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Calculates camera position and target that allows to see the content of provided bounding box.
+ * @param camera Used camera instance.
+ * @param box Bounding box to be fitted.
+ * @param radiusFactor The ratio of the distance from camera to center of box and radius of the box.
+ * @returns
+ */
+export declare function fitCameraToBoundingBox(camera: THREE.PerspectiveCamera, box: THREE.Box3, radiusFactor?: number): {
+    position: THREE.Vector3;
+    target: THREE.Vector3;
+};

package/packages/utilities/src/three/isBox3OnPositiveSideOfPlane.d.ts

@@ -1,10 +1,10 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Returns true if any corner point of the box provides is on the "positive side"
- * of the plane provided (i.e. the corner point has a non-negative signed distance to the
- * plane)
- */
-export declare function isBox3OnPositiveSideOfPlane(box: THREE.Box3, plane: THREE.Plane): boolean;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Returns true if any corner point of the box provides is on the "positive side"
+ * of the plane provided (i.e. the corner point has a non-negative signed distance to the
+ * plane)
+ */
+export declare function isBox3OnPositiveSideOfPlane(box: THREE.Box3, plane: THREE.Plane): boolean;

package/packages/utilities/src/three/toThreeBox3.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { BoundingBox3D } from '@cognite/sdk';
-export declare function toThreeBox3(boundingBox: BoundingBox3D, out?: THREE.Box3): THREE.Box3;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { BoundingBox3D } from '@cognite/sdk';
+export declare function toThreeBox3(boundingBox: BoundingBox3D, out?: THREE.Box3): THREE.Box3;

package/packages/utilities/src/three/unionBoxes.d.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-import * as THREE from 'three';
-export declare function unionBoxes(boxes: THREE.Box3[], out?: THREE.Box3): THREE.Box3;
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+export declare function unionBoxes(boxes: THREE.Box3[], out?: THREE.Box3): THREE.Box3;

package/packages/utilities/src/three/visitBox3CornerPoints.d.ts

@@ -1,12 +1,12 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Visits each corner point of the box given by applying
- * the callback provided to each of the points.
- * Note that the callback is invoked with a vector
- * that will be changed later, so if this is to be stored
- * it must be cloned first.
- */
-export declare function visitBox3CornerPoints(box: THREE.Box3, callback: (corner: THREE.Vector3) => void): void;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Visits each corner point of the box given by applying
+ * the callback provided to each of the points.
+ * Note that the callback is invoked with a vector
+ * that will be changed later, so if this is to be stored
+ * it must be cloned first.
+ */
+export declare function visitBox3CornerPoints(box: THREE.Box3, callback: (corner: THREE.Vector3) => void): void;

package/packages/utilities/src/transformCameraConfiguration.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { CameraConfiguration } from './CameraConfiguration';
-export declare function transformCameraConfiguration(cameraConfiguration: CameraConfiguration | undefined, modelMatrix: THREE.Matrix4): CameraConfiguration | undefined;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { CameraConfiguration } from './CameraConfiguration';
+export declare function transformCameraConfiguration(cameraConfiguration: CameraConfiguration | undefined, modelMatrix: THREE.Matrix4): CameraConfiguration | undefined;

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

@@ -1,11 +1,11 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * General typed array.
- *
- * Note that this doesn't include BigInt64Array and BigUint64Array as
- * the type of these is not number which causes some type interference problems.
- */
-export declare type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;
-export declare type TypedArrayConstructor = Int8ArrayConstructor | Uint8ArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Int32ArrayConstructor | Uint32ArrayConstructor | Uint8ClampedArrayConstructor | Float32ArrayConstructor | Float64ArrayConstructor;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * General typed array.
+ *
+ * Note that this doesn't include BigInt64Array and BigUint64Array as
+ * the type of these is not number which causes some type interference problems.
+ */
+export declare type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;
+export declare type TypedArrayConstructor = Int8ArrayConstructor | Uint8ArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Int32ArrayConstructor | Uint32ArrayConstructor | Uint8ClampedArrayConstructor | Float32ArrayConstructor | Float64ArrayConstructor;

package/packages/utilities/src/workers/WorkerPool.d.ts

@@ -1,14 +1,14 @@
-import { RevealParserWorker } from '@cognite/reveal-parser-worker';
-declare type WorkDelegate<T> = (worker: RevealParserWorker) => Promise<T>;
-export declare class WorkerPool {
-    static get defaultPool(): WorkerPool;
-    private static _defaultPool;
-    private readonly workerList;
-    private workerObjUrl?;
-    constructor();
-    private createWorker;
-    postWorkToAvailable<T>(work: WorkDelegate<T>): Promise<T>;
-    private determineNumberOfWorkers;
-}
-export declare function checkWorkerVersion(worker: RevealParserWorker): Promise<void>;
-export {};
+import { RevealParserWorker } from '@cognite/reveal-parser-worker';
+declare type WorkDelegate<T> = (worker: RevealParserWorker) => Promise<T>;
+export declare class WorkerPool {
+    static get defaultPool(): WorkerPool;
+    private static _defaultPool;
+    private readonly workerList;
+    private workerObjUrl?;
+    constructor();
+    private createWorker;
+    postWorkToAvailable<T>(work: WorkDelegate<T>): Promise<T>;
+    private determineNumberOfWorkers;
+}
+export declare function checkWorkerVersion(worker: RevealParserWorker): Promise<void>;
+export {};

package/packages/utilities/src/worldToViewport.d.ts

@@ -1,30 +1,30 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-/**
- * Maps from 3D world coordinates to normalized screen coordinates
- * relative to the canvas being rendered to. X and Y will
- * be in range [0, 1]. Z is in range [-1, 1] if the coordinate
- * is inside the camera near and far planes.
- * @param camera      Camera used to project point from 3D to NDC coordinates
- * @param position3D  World position in 3D
- * @param out         Optionally pre-allocated THREE.Vector3
- * @returns           Relative screen coordinates in X, Y and Z in range [-1, 1] if point
- * is within near/far of camera.
- */
-export declare function worldToNormalizedViewportCoordinates(camera: THREE.PerspectiveCamera, position3D: THREE.Vector3, out?: THREE.Vector3): THREE.Vector3;
-/**
- * Maps from 3D world coordinates to screen coordinates
- * relative to the canvas. X and Y will be in absolute
- * coordinates (0,0 being the top left of the canvas). Z is
- * in range [-1, 1] if the coordinate
- * is inside the camera near and far planes.
- * @param renderer    Renderer used to render the "world"
- * @param camera      Camera used to project point from 3D to NDC coordinates
- * @param position3D  World position in 3D
- * @param out         Optionally pre-allocated THREE.Vector3
- * @returns           Relative screen coordinates in X, Y and Z in range [-1, 1] if point
- * is within near/far of camera.
- */
-export declare function worldToViewportCoordinates(renderer: THREE.WebGLRenderer, camera: THREE.PerspectiveCamera, position3D: THREE.Vector3, out?: THREE.Vector3): THREE.Vector3;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+/**
+ * Maps from 3D world coordinates to normalized screen coordinates
+ * relative to the canvas being rendered to. X and Y will
+ * be in range [0, 1]. Z is in range [-1, 1] if the coordinate
+ * is inside the camera near and far planes.
+ * @param camera      Camera used to project point from 3D to NDC coordinates
+ * @param position3D  World position in 3D
+ * @param out         Optionally pre-allocated THREE.Vector3
+ * @returns           Relative screen coordinates in X, Y and Z in range [-1, 1] if point
+ * is within near/far of camera.
+ */
+export declare function worldToNormalizedViewportCoordinates(camera: THREE.PerspectiveCamera, position3D: THREE.Vector3, out?: THREE.Vector3): THREE.Vector3;
+/**
+ * Maps from 3D world coordinates to screen coordinates
+ * relative to the canvas. X and Y will be in absolute
+ * coordinates (0,0 being the top left of the canvas). Z is
+ * in range [-1, 1] if the coordinate
+ * is inside the camera near and far planes.
+ * @param renderer    Renderer used to render the "world"
+ * @param camera      Camera used to project point from 3D to NDC coordinates
+ * @param position3D  World position in 3D
+ * @param out         Optionally pre-allocated THREE.Vector3
+ * @returns           Relative screen coordinates in X, Y and Z in range [-1, 1] if point
+ * is within near/far of camera.
+ */
+export declare function worldToViewportCoordinates(renderer: THREE.WebGLRenderer, camera: THREE.PerspectiveCamera, position3D: THREE.Vector3, out?: THREE.Vector3): THREE.Vector3;

package/tools.d.ts

@@ -1,7 +1,7 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * @module @cognite/reveal/tools
- */
-export * from './packages/tools';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * @module @cognite/reveal/tools
+ */
+export * from './packages/tools';