@cognite/reveal 4.10.1 → 4.10.3

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

@@ -12,6 +12,7 @@ import { CameraManager, CameraChangeDelegate, CameraStopDelegate } from '../../.
 import { Image360DataModelIdentifier } from '../../../../data-providers';
 import { SupportedModelTypes } from '../../../../model-base';
 import { Image360Collection, Image360, Image360Revision, Image360AnnotationIntersection } from '../../../../360-images';
+import { CustomObject } from '../../../../utilities';
 /**
  * @example
  * ```js
@@ -365,6 +366,22 @@ export declare class Cognite3DViewer {
      * ```
      */
     addObject3D(object: THREE.Object3D): void;
+    /**
+     * Add a CustomObject to the viewer.
+     * @param customObject
+     * @example
+     * ```js
+     * const sphere = new THREE.Mesh(
+     * new THREE.SphereGeometry(),
+     * new THREE.MeshBasicMaterial()
+     * );
+     * const customObject = CustomObject(sphere);
+     * customObject.isPartOfBoundingBox = false;
+     * viewer.addCustomObject(customObject);
+     * ```
+     * @beta
+     */
+    addCustomObject(customObject: CustomObject): void;
     /**
      * Remove a THREE.Object3D from the viewer.
      * @param object
@@ -376,6 +393,19 @@ export declare class Cognite3DViewer {
      * ```
      */
     removeObject3D(object: THREE.Object3D): void;
+    /**
+     * Remove a CustomObject from the viewer.
+     * @param customObject
+     * @example
+     * ```js
+     * const sphere = new THREE.Mesh(new THREE.SphereGeometry(), new THREE.MeshBasicMaterial());
+     * const customObject = CustomObject(sphere);
+     * viewer.addCustomObject(sphere);
+     * viewer.removeCustomObject(sphere);
+     * ```
+     * @beta
+     */
+    removeCustomObject(customObject: CustomObject): void;
     /**
      * Sets the color used as the clear color of the renderer.
      * @param backgroundColor
@@ -604,6 +634,8 @@ export declare class Cognite3DViewer {
     private animate;
     /** @private */
     private intersectModels;
+    private getCustomObjectIntersectionIfCloser;
+    private createCustomObjectIntersectInput;
     /**
      * Callback used by DefaultCameraManager to do model intersection. Made synchronous to avoid
      * input lag when zooming in and out. Default implementation is async. See PR #2405 for more info.

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

@@ -39,6 +39,9 @@ export { LineGeometry } from './src/three/lines/LineGeometry';
 export { LineMaterial } from './src/three/lines/LineMaterial';
 export { DeferredPromise } from './src/DeferredPromise';
 export { SceneHandler } from './src/SceneHandler';
+export { CustomObject } from './src/customObject/CustomObject';
+export { CustomObjectIntersectInput } from './src/customObject/CustomObjectIntersectInput';
+export { CustomObjectIntersection } from './src/customObject/CustomObjectIntersection';
 export { CDF_TO_VIEWER_TRANSFORMATION } from './src/constants';
 export * from './src/workers/workerize-transferable';
 export * from './src/shapes';

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

@@ -2,6 +2,7 @@
  * Copyright 2022 Cognite AS
  */
 import * as THREE from 'three';
+import { CustomObject } from './customObject/CustomObject';
 export declare class SceneHandler {
     private readonly _scene;
     private readonly _cadModels;
@@ -16,13 +17,15 @@ export declare class SceneHandler {
         pointCloudNode: THREE.Object3D;
         modelIdentifier: symbol;
     }[];
-    get customObjects(): THREE.Object3D[];
+    get customObjects(): CustomObject[];
     constructor();
     addCadModel(cadNode: THREE.Object3D, modelIdentifier: string): void;
     addPointCloudModel(pointCloudNode: THREE.Object3D, modelIdentifier: symbol): void;
     removePointCloudModel(pointCloudNode: THREE.Object3D): void;
     removeCadModel(cadNode: THREE.Object3D): void;
-    addCustomObject(object: THREE.Object3D): void;
-    removeCustomObject(object: THREE.Object3D): void;
+    addObject3D(object: THREE.Object3D): void;
+    addCustomObject(customObject: CustomObject): void;
+    removeObject3D(object: THREE.Object3D): void;
+    removeCustomObject(customObject: CustomObject): void;
     dispose(): void;
 }

package/dist/packages/utilities/src/customObject/CustomObject.d.ts

@@ -0,0 +1,54 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+import { Object3D } from 'three';
+import { CustomObjectIntersection } from './CustomObjectIntersection';
+import { CustomObjectIntersectInput } from './CustomObjectIntersectInput';
+/**
+ * This class encasulate a Object3D, and made it possible to add flags to it.
+ * It might be extended with more flags in the future.
+ * @beta
+ */
+export declare class CustomObject {
+    private readonly _object;
+    private _isPartOfBoundingBox;
+    private _shouldPick;
+    private _shouldPickBoundingBox;
+    /**
+     * Constructor
+     * @beta
+     */
+    constructor(object: Object3D);
+    /**
+     * Get the Object3D
+     * @beta
+     */
+    get object(): Object3D;
+    /**
+     * Set or get whether it should be part of the combined bounding box or not.
+     * Default is true.
+     * @beta
+     */
+    get isPartOfBoundingBox(): boolean;
+    set isPartOfBoundingBox(value: boolean);
+    /**
+     * Set or get whether it should be picked by the camera manager
+     * Default is false.
+     * @beta
+     */
+    get shouldPick(): boolean;
+    set shouldPick(value: boolean);
+    /**
+     * Set or get whether it should be also give the bounding box when picked by the camera
+     * Default is false.
+     * @beta
+     */
+    get shouldPickBoundingBox(): boolean;
+    set shouldPickBoundingBox(value: boolean);
+    /**
+     * Intersect the object with the raycaster.
+     * This function can be overridden to provide custom intersection logic.
+     * @beta
+     */
+    intersectIfCloser(intersectInput: CustomObjectIntersectInput, closestDistance: number | undefined): undefined | CustomObjectIntersection;
+}

package/dist/packages/utilities/src/customObject/CustomObjectIntersectInput.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+import { Raycaster, Vector3, Vector2, PerspectiveCamera, Plane } from 'three';
+/**
+ * This class is used as input for intersecting custom objects
+ * @beta
+ */
+export declare class CustomObjectIntersectInput {
+    readonly normalizedCoords: Vector2;
+    readonly camera: PerspectiveCamera;
+    readonly clippingPlanes: Plane[] | undefined;
+    readonly raycaster: Raycaster;
+    constructor(normalizedCoords: Vector2, camera: PerspectiveCamera, clippingPlanes?: Plane[] | undefined);
+    isVisible(point: Vector3): boolean;
+}

package/dist/packages/utilities/src/customObject/CustomObjectIntersection.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+import { Vector3, Box3 } from 'three';
+import { CustomObject } from './CustomObject';
+/**
+ * This class is used as output intersecting custom objects
+ * @beta
+ */
+export type CustomObjectIntersection = {
+    /**
+     * The intersection type.
+     */
+    type: 'customObject';
+    /**
+     * Coordinate of the intersection.
+     */
+    point: Vector3;
+    /**
+     * Distance from the camera to the intersection.
+     */
+    distanceToCamera: number;
+    customObject: CustomObject;
+    boundingBox?: Box3;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.10.1",
+  "version": "4.10.3",
   "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": {
@@ -81,7 +81,7 @@
   "devDependencies": {
     "@azure/msal-browser": "2.38.3",
     "@cognite/sdk": "8.3.0",
-    "@microsoft/api-extractor": "7.40.1",
+    "@microsoft/api-extractor": "7.40.2",
     "@types/dat.gui": "0.7.12",
     "@types/gl": "^6.0.2",
     "@types/glob": "8.1.0",
@@ -91,7 +91,7 @@
     "@types/jsdom": "21.1.6",
     "@types/lodash": "4.14.202",
     "@types/mixpanel-browser": "2.49.0",
-    "@types/node": "18.19.15",
+    "@types/node": "18.19.17",
     "@types/random-seed": "0.3.5",
     "@types/skmeans": "0.11.7",
     "@types/stats": "0.16.30",
@@ -122,7 +122,7 @@
     "jest-puppeteer": "9.0.2",
     "jsdom": "23.2.0",
     "moq.ts": "10.0.8",
-    "nock": "13.5.1",
+    "nock": "13.5.3",
     "prettier": "3.2.5",
     "process": "0.11.10",
     "puppeteer": "21.11.0",
@@ -138,7 +138,7 @@
     "tsc-alias": "1.8.8",
     "typescript": "5.3.3",
     "wasm-pack": "0.12.1",
-    "webpack": "5.90.1",
+    "webpack": "5.90.2",
     "webpack-cli": "5.1.4",
     "webpack-dev-server": "4.15.1",
     "webpack-node-externals": "3.0.0",