@cognite/reveal 3.1.0 → 4.0.0-dev.20221025

package/packages/utilities/src/workers/workerize-transferable/on-main.d.ts

@@ -0,0 +1,13 @@
+/** Options for worker method params */
+export declare type WorkerMethodParamsOptions = {
+    /** pick transferables from method params */
+    pickTransferablesFromParams?: (params: any) => any[];
+};
+/**
+ * Setup worker methods which receive transferables from worker method params. This function should be executed on the main thread.
+ * @param worker worker instance
+ * @param methods an object whose key is method name and whose value is options how to pick transferables from method params
+ */
+export declare function setupTransferableMethodsOnMain<WORKER extends Worker>(worker: WORKER, methods: {
+    [x: string]: WorkerMethodParamsOptions;
+}): void;

package/packages/utilities/src/workers/workerize-transferable/on-worker.d.ts

@@ -0,0 +1,14 @@
+/** Options for worker method result */
+export declare type WorkerMethodResultOptions = {
+    /** worker method */
+    fn: (...params: any[]) => any;
+    /** pick transferables from method result */
+    pickTransferablesFromResult?: (result: any) => any[];
+};
+/**
+ * Setup worker methods which return transferables. This function should be executed on the worker thread.
+ * @param methods an object whose key is method name and whose value is options how to pick transferables from method result
+ */
+export declare function setupTransferableMethodsOnWorker(methods: {
+    [x: string]: WorkerMethodResultOptions;
+}): void;

package/packages/utilities/src/workers/workerize-transferable/util.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Get the global scope for browsers that do not support globalThis
+ * https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/globalThis
+ */
+export declare function getGlobalThis(): typeof globalThis;
+/**
+ * Test if an object is transferable
+ * @param x Object
+ */
+export declare function isTransferableObject(x: any): boolean;

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

@@ -1,30 +1,34 @@
-/*!
- * 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;
+/**
+ * Converts a pixel coordinate to normalized device coordinate (in range [-1, 1])
+ */
+export declare function pixelToNormalizedDeviceCoordinates(x: number, y: number, width: number, height: number): THREE.Vector2;

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';