@cognite/reveal 4.6.0 → 4.7.1

package/dist/packages/360-images/src/Image360Facade.d.ts

@@ -13,6 +13,7 @@ export declare class Image360Facade<T> {
     private readonly _image360Collections;
     private readonly _rayCaster;
     private readonly _image360Cache;
+    private readonly _loadSequencer;
     get collections(): DefaultImage360Collection[];
     set allIconsVisibility(visible: boolean);
     set allIconsSelected(visible: boolean);

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

@@ -65,6 +65,10 @@ export declare class Cognite3DViewer {
     private _clippingNeedsUpdate;
     private _forceStopRendering;
     private readonly spinner;
+    /**
+     * Enbles us to ensure models are added in the order their load is initialized.
+     */
+    private readonly _addModelSequencer;
     private get revealManager();
     /**
      * Reusable buffers used by functions in Cognite3dViewer to avoid allocations.
@@ -251,6 +255,7 @@ export declare class Cognite3DViewer {
      * ```
      */
     addCadModel(options: AddModelOptions): Promise<CogniteCadModel>;
+    private addCadModelWithSequencer;
     /**
      * Add a new pointcloud 3D model to the viewer.
      * Call {@link Cognite3DViewer.fitCameraToModel} to see the model after the model has loaded.
@@ -267,6 +272,7 @@ export declare class Cognite3DViewer {
      * ```
      */
     addPointCloudModel(options: AddModelOptions): Promise<CognitePointCloudModel>;
+    private addPointCloudModelWithSequencer;
     /**
      * Adds a set of 360 images to the scene from the /events API in Cognite Data Fusion.
      * @param datasource The CDF data source which holds the references to the 360 image sets.

package/dist/packages/pointclouds/src/ClassificationHandler.d.ts

@@ -4,6 +4,7 @@
 import { ClassificationInfo } from './potree-three-loader/loading/ClassificationInfo';
 import { WellKnownAsprsPointClassCodes } from './types';
 import { PointCloudMaterial, PointClassification } from '../../rendering';
+import { Color } from 'three';
 export declare class ClassificationHandler {
     private readonly _classification;
     private readonly _material;
@@ -18,6 +19,7 @@ export declare class ClassificationHandler {
     get classes(): Array<{
         name: string;
         code: number;
+        color: Color;
     }>;
     createPointClassKey(pointClass: number | WellKnownAsprsPointClassCodes): number;
     setClassificationAndRecompute(pointClass: number | WellKnownAsprsPointClassCodes, visible: boolean): void;

package/dist/packages/pointclouds/src/CognitePointCloudModel.d.ts

@@ -107,6 +107,7 @@ export declare class CognitePointCloudModel {
     getClasses(): Array<{
         name: string;
         code: number | WellKnownAsprsPointClassCodes;
+        color: THREE.Color;
     }>;
     /**
      * Returns the current number of visible/loaded points.

package/dist/packages/pointclouds/src/PointCloudNode.d.ts

@@ -7,7 +7,7 @@ import { WellKnownAsprsPointClassCodes } from './types';
 import { PointColorType, PointShape, PointSizeType } from '../../rendering';
 import { PointCloudObjectMetadata, PointCloudObject } from '../../data-providers';
 import { CompletePointCloudAppearance, StyledPointCloudObjectCollection } from '../../pointcloud-styling';
-import { Matrix4, Group } from 'three';
+import { Matrix4, Group, Color } from 'three';
 export declare class PointCloudNode extends Group {
     private readonly _cameraConfiguration?;
     private readonly _octree;
@@ -72,6 +72,7 @@ export declare class PointCloudNode extends Group {
     getClasses(): Array<{
         name: string;
         code: number | WellKnownAsprsPointClassCodes;
+        color: Color;
     }>;
     getBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
     setModelTransformation(matrix: THREE.Matrix4): void;

package/dist/packages/tools/index.d.ts

@@ -11,5 +11,5 @@ export { Keyframe } from './src/Timeline/Keyframe';
 export { TimelineDateUpdateDelegate } from './src/Timeline/types';
 export { Cognite3DViewerToolBase } from './src/Cognite3DViewerToolBase';
 export { MeasurementTool } from './src/Measurement/MeasurementTool';
-export { Measurement } from './src/Measurement/MeasurementManager';
+export { Measurement } from './src/Measurement/types';
 export { DistanceToLabelDelegate, MeasurementOptions, MeasurementAddedDelegate, MeasurementStartedDelegate, MeasurementEndedDelegate } from './src/Measurement/types';

package/dist/packages/tools/src/Measurement/MeasurementManager.d.ts

@@ -3,13 +3,7 @@
  */
 import * as THREE from 'three';
 import { HtmlOverlayTool } from '../HtmlOverlay/HtmlOverlayTool';
-import { MeasurementOptions } from './types';
-export type Measurement = {
-    readonly measurementId: number;
-    readonly startPoint: THREE.Vector3;
-    readonly endPoint: THREE.Vector3;
-    readonly distanceInMeters: number;
-};
+import { Measurement, MeasurementOptions } from './types';
 export declare class MeasurementManager {
     private readonly _measurementLabel;
     private readonly _line;

package/dist/packages/tools/src/Measurement/MeasurementTool.d.ts

@@ -5,8 +5,7 @@ import { Cognite3DViewer } from '../../../api';
 import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
 import { DisposedDelegate } from '../../../utilities';
 import * as THREE from 'three';
-import { MeasurementAddedDelegate, MeasurementStartedDelegate, MeasurementEndedDelegate, MeasurementOptions } from './types';
-import { Measurement } from './MeasurementManager';
+import { MeasurementAddedDelegate, MeasurementStartedDelegate, MeasurementEndedDelegate, MeasurementOptions, Measurement } from './types';
 /**
  * Enables {@link Cognite3DViewer} to perform a point to point measurement.
  * This can be achieved by selecting a point on the 3D Object and drag the pointer to
@@ -131,6 +130,10 @@ export declare class MeasurementTool extends Cognite3DViewerToolBase {
      * @param measurement Measurement to be removed from Cognite3DViewer.
      */
     removeMeasurement(measurement: Measurement): void;
+    /**
+     * Adds a measurement directly. E.g. to restore a previous state programatically
+     */
+    addMeasurement(startPoint: THREE.Vector3, endPoint: THREE.Vector3): Measurement;
     /**
      * Removes all measurements from the Cognite3DViewer.
      */

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

@@ -1,6 +1,12 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+export type Measurement = {
+    readonly measurementId: number;
+    readonly startPoint: THREE.Vector3;
+    readonly endPoint: THREE.Vector3;
+    readonly distanceInMeters: number;
+};
 /**
  * Custom callback for users to change measurement label content.
  */
@@ -8,12 +14,7 @@ export type DistanceToLabelDelegate = (distanceInMeters: number) => string;
 /**
  * Delegate for measurement added events.
  */
-export type MeasurementAddedDelegate = (event: {
-    measurementId: number;
-    startPoint: THREE.Vector3;
-    endPoint: THREE.Vector3;
-    distanceInMeters: number;
-}) => void;
+export type MeasurementAddedDelegate = (measurement: Measurement) => void;
 /**
  * Delegate for measurement started events.
  */

package/dist/packages/utilities/src/AsyncSequencer.d.ts

@@ -0,0 +1,63 @@
+/*!
+ * Copyright 2023 Cognite AS
+ */
+export type SequencerFunction<T> = (region: () => Promise<T> | T) => Promise<T>;
+/**
+ * AsyncSequencer - helper class for making sure a sequence of operations
+ * are performed in the same order, while permitting dependant computations
+ * to be performed in arbitrary order.
+ * See the following example of a function that loads data and puts it in an
+ * array:.
+ *
+ * ```
+ * function loadData(id: any): Promise<void> {
+ *   const result = await expensiveFetchOperation(id);
+ *   this._array.push(result); // Shared array used for all retrieved data
+ * }
+ * ```
+ *
+ * Calling `loadData` multiple times sequentially without awaiting may
+ * cause the retrieved data to be pushed to the array in an arbitrary order.
+ * This may be fine in some cases, but not in others.
+ * `AsyncSequencer` guarantees the order in the following way:
+ *
+ * ```
+ * const asyncSequencer = new AsyncSequencer();
+ * ...
+ * // Same function signature as before
+ * function loadData(id: any): Promise<void> {
+ *
+ *   // `getNextSequencer` returns a _sequencer_ function that takes another
+ *   // function (the "critical region") as input and ensures it is run
+ *   // after the critical region of the previous _sequencer_ function
+ *   // retrieved from the `asyncSequencer` object with `getNextSequencer`,
+ *   // and before the next such sequencer's critical region
+ *   const sequencer = asyncSequencer.getNextSequencer<void>();
+ *
+ *   // The following line still runs and finishes at arbitrary times
+ *   // across different calls to `loadData` ...
+ *   const result = await expensiveFetchOperation(id);
+ *
+ *   // ... However, the function given to `sequencer` will always
+ *   // run in the same order as the `sequencer`s were created with
+ *   // `getNextSequencer`
+ *   await sequencer(() => {
+ *     this._array.push(result)
+ *   });
+ * }
+ * ```
+ * Note that this approach allows `expensiveFetchOperation` to be run in parallel
+ * while still guaranteeing the order of the results.
+ * Also, be aware that if `loadData` had been declared `async`, it is not certain
+ * that the calls to `getNextSequencer` would have been in the same order as
+ * the calls to the corresponding `loadData`.
+ */
+export declare class AsyncSequencer {
+    private _currentPromise;
+    /**
+     * Returns a `sequencer` function that guarantees that the
+     * function it is called with is run after the previous `sequencer`'s
+     * function, and before the next one's.
+     */
+    getNextSequencer<T>(): SequencerFunction<T>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.6.0",
+  "version": "4.7.1",
   "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": {
@@ -39,8 +39,8 @@
   ],
   "scripts": {
     "build": "yarn run clean && yarn run build:wasm && webpack --env development",
-    "build:wasm": "yarn workspaces foreach run run-wasm-pack build --target web ./wasm",
-    "build:wasm-test": "yarn workspaces foreach run run-wasm-pack build --target nodejs ./wasm",
+    "build:wasm": "yarn workspaces foreach -A run run-wasm-pack build --target web ./wasm",
+    "build:wasm-test": "yarn workspaces foreach -A run run-wasm-pack build --target nodejs ./wasm",
     "build:watch": "yarn run clean && yarn run build:wasm && webpack --env development --watch",
     "build:prod": "yarn run clean && yarn run build:wasm && webpack --env production",
     "clean": "shx rm -rf dist/ && shx mkdir -p dist",
@@ -48,7 +48,7 @@
     "retarget-types": "tsc-alias -p tsconfig.webpack.json -v true",
     "test": "yarn run test:wasm && yarn run test:ts",
     "test:ts": "yarn run build:wasm-test && cross-env NODE_OPTIONS=--experimental-vm-modules jest --maxWorkers=4",
-    "test:wasm": "yarn workspaces foreach run run-wasm-pack test --headless --chrome ./wasm",
+    "test:wasm": "yarn workspaces foreach -A run run-wasm-pack test --headless --chrome ./wasm",
     "test:visual:client": "cross-env JEST_PUPPETEER_CONFIG=visual-tests/jest-puppeteer.config.js jest --config=visual-tests/jest.config.js --verbose",
     "test:visual:server": "webpack-dev-server --config packages/webpack.config.js",
     "test:visual": "yarn run build:wasm && concurrently --passthrough-arguments -k -s \"first\" \"yarn run test:visual:client {@}\" \"yarn run test:visual:server\"",
@@ -70,7 +70,7 @@
     "html2canvas": "^1.4.1",
     "lodash": "4.17.21",
     "loglevel": "1.8.1",
-    "mixpanel-browser": "2.47.0",
+    "mixpanel-browser": "2.48.1",
     "path-browserify": "1.0.1",
     "random-seed": "0.3.0",
     "rxjs": "7.8.1",
@@ -80,31 +80,31 @@
   "devDependencies": {
     "@azure/msal-browser": "2.38.3",
     "@cognite/sdk": "8.3.0",
-    "@microsoft/api-extractor": "7.38.2",
-    "@types/dat.gui": "0.7.11",
+    "@microsoft/api-extractor": "7.38.3",
+    "@types/dat.gui": "0.7.12",
     "@types/gl": "^6.0.2",
     "@types/glob": "8.1.0",
-    "@types/jest": "29.5.7",
-    "@types/jest-environment-puppeteer": "5.0.5",
-    "@types/jest-image-snapshot": "6.2.2",
-    "@types/jsdom": "21.1.4",
-    "@types/lodash": "4.14.200",
-    "@types/mixpanel-browser": "2.47.4",
-    "@types/node": "18.18.7",
-    "@types/random-seed": "0.3.4",
-    "@types/skmeans": "0.11.6",
+    "@types/jest": "29.5.10",
+    "@types/jest-environment-puppeteer": "5.0.6",
+    "@types/jest-image-snapshot": "6.2.3",
+    "@types/jsdom": "21.1.6",
+    "@types/lodash": "4.14.202",
+    "@types/mixpanel-browser": "2.47.5",
+    "@types/node": "18.18.13",
+    "@types/random-seed": "0.3.5",
+    "@types/skmeans": "0.11.7",
     "@types/stats": "0.16.30",
-    "@types/three": "0.158.1",
+    "@types/three": "0.158.2",
     "@types/tween.js": "18.5.1",
-    "@typescript-eslint/eslint-plugin": "6.7.0",
-    "@typescript-eslint/parser": "6.7.0",
+    "@typescript-eslint/eslint-plugin": "6.11.0",
+    "@typescript-eslint/parser": "6.11.0",
     "concurrently": "8.2.2",
     "cross-env": "7.0.3",
     "dat.gui": "0.7.9",
-    "eslint": "8.52.0",
+    "eslint": "8.54.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-jsdoc": "46.8.2",
+    "eslint-plugin-jsdoc": "46.9.0",
     "eslint-plugin-lodash": "7.4.0",
     "eslint-plugin-prettier": "5.0.1",
     "eslint-plugin-unused-imports": "3.0.0",
@@ -121,10 +121,10 @@
     "jest-puppeteer": "9.0.1",
     "jsdom": "22.1.0",
     "moq.ts": "10.0.8",
-    "nock": "13.3.6",
-    "prettier": "3.0.3",
+    "nock": "13.3.8",
+    "prettier": "3.1.0",
     "process": "0.11.10",
-    "puppeteer": "21.4.1",
+    "puppeteer": "21.5.2",
     "random-seed": "0.3.0",
     "raw-loader": "4.0.2",
     "remove-files-webpack-plugin": "1.5.0",
@@ -133,7 +133,7 @@
     "stats.js": "0.17.0",
     "three": "0.158.0",
     "ts-jest": "29.1.1",
-    "ts-loader": "9.5.0",
+    "ts-loader": "9.5.1",
     "tsc-alias": "1.8.8",
     "typescript": "5.2.2",
     "wasm-pack": "0.12.1",
@@ -156,5 +156,5 @@
   "files": [
     "dist"
   ],
-  "packageManager": "yarn@3.6.4"
+  "packageManager": "yarn@4.0.2"
 }