@cognite/reveal 4.0.0-dev.20221121 → 4.0.0-dev.20221122

package/dist/packages/api/src/public/migration/Cognite3DViewer.d.ts

@@ -396,6 +396,13 @@ export declare class Cognite3DViewer {
      * ```
      */
     fitCameraToModel(model: CogniteModel, duration?: number): void;
+    /**
+     * Move camera to a place where a set of 3D models are visible.
+     * @param models Optional 3D models to focus the camera on. If no models are provided the camera will fit to all models.
+     * @param duration The duration of the animation moving the camera. Set this to 0 (zero) to disable animation.
+     * @param restrictToMostGeometry If true, attempt to remove junk geometry from the bounds to allow setting a good camera position.
+     */
+    fitCameraToModels(models?: CogniteModel[], duration?: number, restrictToMostGeometry?: boolean): void;
     /**
      * Move camera to a place where the content of a bounding box is visible to the camera.
      * @param box The bounding box in world space.
@@ -456,9 +463,13 @@ export declare class Cognite3DViewer {
      */
     worldToScreen(point: THREE.Vector3, normalize?: boolean): THREE.Vector2 | null;
     /**
-     * Take screenshot from the current camera position.
+     * Take a screenshot from the current camera position. When drawing UI, only the viewer DOM element and its children will be included in the image.
+     * The DOM is scaled to fit any provided resolution, and as a result some elements can be positioned incorrectly in regards to the 3D render.
+     *
+     * `html2canvas` is used to draw UI and this has some limitations on what CSS properties it is able to render. See {@link https://html2canvas.hertzen.com/documentation the html2canvas documentation} for details.
      * @param width Width of the final image. Default is current canvas size.
      * @param height Height of the final image. Default is current canvas size.
+     * @param includeUI If false the screenshot will include only the rendered 3D.
      * @returns A {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URL} of the image ('image/png').
      * @example
      * ```js
@@ -470,10 +481,10 @@ export declare class Cognite3DViewer {
      * const url = await viewer.getScreenshot();
      * const image = document.createElement('img');
      * image.src = url;
-     * document.body.appendChild(url);
+     * document.body.appendChild(image);
      * ```
      */
-    getScreenshot(width?: number, height?: number): Promise<string>;
+    getScreenshot(width?: number, height?: number, includeUI?: boolean): Promise<string>;
     /**
      * Raycasting model(s) for finding where the ray intersects with the model.
      * @param offsetX X coordinate in pixels (relative to the domElement).

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

@@ -149,8 +149,9 @@ export declare class HtmlOverlayTool extends Cognite3DViewerToolBase {
      * modified externally.
      *
      * Calling this function often might cause degraded performance.
+     * @param customCamera Optional camera to be used in place of viewerCamera when calculating positions
      */
-    forceUpdate(): void;
+    forceUpdate(customCamera?: THREE.PerspectiveCamera): void;
     /**
      * Update size of new elements. This is only done once as this causes
      * layout to be invalidated which is an expensive operation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.0.0-dev.20221121",
+  "version": "4.0.0-dev.20221122",
   "description": "WebGL based 3D viewer for CAD and point clouds processed in Cognite Data Fusion.",
   "homepage": "https://github.com/cognitedata/reveal/tree/master/viewer",
   "repository": {
@@ -73,6 +73,7 @@
     "comlink": "4.3.1",
     "glslify": "7.1.1",
     "glslify-import": "3.1.0",
+    "html2canvas": "^1.4.1",
     "lodash": "4.17.21",
     "loglevel": "1.8.1",
     "mixpanel-browser": "2.45.0",
@@ -89,11 +90,11 @@
     "@types/dat.gui": "0.7.7",
     "@types/expect-puppeteer": "5.0.2",
     "@types/glob": "8.0.0",
-    "@types/jest": "29.2.2",
+    "@types/jest": "29.2.3",
     "@types/jest-environment-puppeteer": "5.0.3",
     "@types/jest-image-snapshot": "5.1.0",
     "@types/jsdom": "20.0.1",
-    "@types/lodash": "4.14.188",
+    "@types/lodash": "4.14.189",
     "@types/mixpanel-browser": "2.38.0",
     "@types/node": "18.11.3",
     "@types/proj4": "2.5.2",