@cognite/reveal 4.13.0 → 4.14.0

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

@@ -2,17 +2,16 @@
  * Copyright 2021 Cognite AS
  */
 import * as THREE from 'three';
-import { PointerEventDelegate, SceneRenderedDelegate, DisposedDelegate, BeforeSceneRenderedDelegate } from '../../../../utilities';
+import { PointerEventDelegate, SceneRenderedDelegate, DisposedDelegate, BeforeSceneRenderedDelegate, CustomObjectIntersectInput, ICustomObject } from '../../../../utilities';
 import { CogniteCadModel } from '../../../../cad-model';
 import { PointCloudBudget, CognitePointCloudModel } from '../../../../pointclouds';
-import { AddImage360Options, AddModelOptions, Cognite3DViewerOptions, Intersection, CadModelBudget, ResolutionOptions, RenderParameters } from './types';
+import { AddImage360Options, AddModelOptions, Cognite3DViewerOptions, Intersection, CadModelBudget, ResolutionOptions, RenderParameters, AnyIntersection } from './types';
 import { CogniteModel, Image360WithCollection } from '../types';
 import { ViewerState } from '../../utilities/ViewStateHelper';
 import { CameraManager, CameraChangeDelegate, CameraStopDelegate } from '../../../../camera-manager';
 import { Image360DataModelIdentifier } from '../../../../data-providers';
 import { SupportedModelTypes } from '../../../../model-base';
 import { Image360Collection, Image360, Image360Revision, Image360AnnotationIntersection } from '../../../../360-images';
-import { CustomObject } from '../../../../utilities';
 /**
  * @example
  * ```js
@@ -386,7 +385,7 @@ export declare class Cognite3DViewer {
      * ```
      * @beta
      */
-    addCustomObject(customObject: CustomObject): void;
+    addCustomObject(customObject: ICustomObject): void;
     /**
      * Remove a THREE.Object3D from the viewer.
      * @param object
@@ -410,7 +409,7 @@ export declare class Cognite3DViewer {
      * ```
      * @beta
      */
-    removeCustomObject(customObject: CustomObject): void;
+    removeCustomObject(customObject: ICustomObject): void;
     /**
      * Sets the color used as the clear color of the renderer.
      * @param backgroundColor
@@ -467,6 +466,11 @@ export declare class Cognite3DViewer {
      * Returns the current active global clipping planes.
      */
     getGlobalClippingPlanes(): THREE.Plane[];
+    /**
+     * Returns the union of all bounding boxes in reveal, including custom objects.
+     * @beta
+     */
+    getSceneBoundingBox(): THREE.Box3;
     /**
      * Attempts to load the camera settings from the settings stored for the
      * provided model. See {@link https://docs.cognite.com/api/v1/#operation/get3DRevision}
@@ -502,7 +506,7 @@ export declare class Cognite3DViewer {
      * 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.
+     * @param restrictToMostGeometry If true, attempt to remove junk geometry from the boundingBox to allow setting a good camera position.
      */
     fitCameraToModels(models?: CogniteModel[], duration?: number, restrictToMostGeometry?: boolean): void;
     /**
@@ -587,6 +591,25 @@ export declare class Cognite3DViewer {
      * ```
      */
     getScreenshot(width?: number, height?: number, includeUI?: boolean): Promise<string>;
+    /**
+     * Converts a pixel coordinate to normalized device coordinate (in range [-1, 1]).
+     * @param pixelCoords A Vector2 containing pixel coordinates relative to the 3D viewer.
+     * @returns A Vector2 containing the normalized device coordinate (in range [-1, 1]).
+     */
+    getNormalizedPixelCoordinates(pixelCoords: THREE.Vector2): THREE.Vector2;
+    /**
+     * Determines clicked or touched pixel coordinate as offset.
+     * @param event An PointerEvent or WheelEvent.
+     * @returns A Vector2 containing pixel coordinates relative to the 3D viewer.
+     */
+    getPixelCoordinatesFromEvent(event: PointerEvent | WheelEvent): THREE.Vector2;
+    /**
+     * Creates and initialize a CustomObjectIntersectInput to be used by CustomObject.intersectIfCloser method.
+     * @param pixelCoords A Vector2 containing pixel coordinates relative to the 3D viewer.
+     * @returns A CustomObjectIntersectInput ready to use.
+     * @beta
+     */
+    createCustomObjectIntersectInput(pixelCoords: THREE.Vector2): CustomObjectIntersectInput;
     /**
      * Raycasting model(s) for finding where the ray intersects with the model.
      * @param offsetX X coordinate in pixels (relative to the domElement).
@@ -621,6 +644,14 @@ export declare class Cognite3DViewer {
      * ```
      */
     getIntersectionFromPixel(offsetX: number, offsetY: number): Promise<null | Intersection>;
+    /**
+     * Raycasting model(s) for finding where the ray intersects with all models, including custom objects.
+     * @param pixelCoords Pixel coordinate in pixels (relative to the domElement).
+     * @returns A promise that if there was an intersection then return the intersection object - otherwise it
+     * returns `null` if there were no intersections.
+     * @beta
+     */
+    getAnyIntersectionFromPixel(pixelCoords: THREE.Vector2): Promise<AnyIntersection | undefined>;
     /**
      * Check for intersections with 360 annotations through the given pixel.
      * Similar to {getIntersectionFromPixel}, but checks 360 image annotations
@@ -640,7 +671,6 @@ export declare class Cognite3DViewer {
     /** @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/api/src/public/migration/types.d.ts

@@ -10,6 +10,7 @@ import { DataSource } from '../../../../data-source';
 import { EdlOptions } from '../../../../rendering';
 import { Image360AnnotationFilterOptions } from '../../../../360-images';
 import type { Vector2, WebGLRenderTarget, WebGLRenderer, Matrix4, Vector3 } from 'three';
+import { CustomObjectIntersection } from '../../../../utilities';
 /**
  * Callback to monitor loaded requests and progress.
  * Use OnLoadingCallback instead of onProgress/onComplete.
@@ -231,6 +232,12 @@ export type ResolutionOptions = {
  * @module @cognite/reveal
  */
 export type Intersection = CadIntersection | PointCloudIntersection;
+/**
+ * Represents the result from {@link Cognite3DViewer.getAnyIntersectionFromPixel}.
+ * @module @cognite/reveal
+ * @beta
+ */
+export type AnyIntersection = CadIntersection | PointCloudIntersection | CustomObjectIntersection;
 /**
  * @module @cognite/reveal
  */

package/dist/packages/cad-model/src/wrappers/CogniteCadModel.d.ts

@@ -166,7 +166,7 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
     getAncestorTreeIndices(treeIndex: number, generation: number): Promise<NumericRange>;
     /**
      * Determines the full bounding box of the model.
-     * @param outBbox Optional. Used to write result to.
+     * @param outBoundingBox Optional. Used to write result to.
      * @param restrictToMostGeometry Optional. When true, returned bounds are restricted to
      * where most of the geometry is located. This is useful for models that have junk geometry
      * located far from the "main" model. Added in version 1.3.0.
@@ -174,16 +174,16 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
      *
      * @example
      * ```js
-     * const box = new THREE.Box3()
-     * model.getModelBoundingBox(box);
-     * // box now has the bounding box
+     * const boundingBox = new THREE.Box3()
+     * model.getModelBoundingBox(boundingBox);
+     * // boundingBox now has the bounding box
      * ```
      * ```js
      * // the following code does the same
-     * const box = model.getModelBoundingBox();
+     * const boundingBox = model.getModelBoundingBox();
      * ```
      */
-    getModelBoundingBox(outBbox?: THREE.Box3, restrictToMostGeometry?: boolean): THREE.Box3;
+    getModelBoundingBox(outBoundingBox?: THREE.Box3, restrictToMostGeometry?: boolean): THREE.Box3;
     /**
      * Retrieves the camera position and target stored for the model. Typically this
      * is used to store a good starting position for a model. Returns `undefined` if there

package/dist/packages/camera-manager/src/DefaultCameraManager.d.ts

@@ -22,7 +22,7 @@ export declare class DefaultCameraManager implements CameraManager {
     private _isDisposed;
     private _nearAndFarNeedsUpdate;
     private _isEnabled;
-    private readonly _modelRaycastCallback;
+    private readonly _raycastCallback;
     private _onClick;
     private _onDoubleClick;
     private _onWheel;

package/dist/packages/camera-manager/src/Flexible/FlexibleCameraManager.d.ts

@@ -41,7 +41,7 @@ export declare class FlexibleCameraManager extends PointerEvents implements IFle
     on(event: CameraManagerEventType, callback: CameraEventDelegate): void;
     off(event: CameraManagerEventType, callback: CameraEventDelegate): void;
     fitCameraToBoundingBox(boundingBox: Box3, duration?: number, radiusFactor?: number): void;
-    update(deltaTime: number, nearFarBoundingBox: Box3): void;
+    update(deltaTime: number, nearFarPlaneBoundingBox: Box3): void;
     dispose(): void;
     get controlsType(): FlexibleControlsType;
     set controlsType(value: FlexibleControlsType);

package/dist/packages/camera-manager/src/Flexible/FlexibleControls.d.ts

@@ -59,8 +59,7 @@ export declare class FlexibleControls {
         target: Vector3;
         position: Vector3;
     };
-    private getMousePosition;
-    getNormalizedPixelCoordinates(event: PointerEvent | WheelEvent): Vector2;
+    getNormalizedPixelCoordinates(position: Vector2): Vector2;
     setScrollCursor(value: Vector3 | undefined): void;
     setTempTarget(value: Vector3 | undefined): void;
     setFov(value: number, triggerCameraChangeEvent?: boolean): boolean;

package/dist/packages/camera-manager/src/Flexible/FlexibleControlsTranslator.d.ts

@@ -1,6 +1,7 @@
 /*!
  * Copyright 2024 Cognite AS
  */
+import { Vector2 } from 'three';
 import { FlexibleControls } from './FlexibleControls';
 /**
  * @beta
@@ -14,6 +15,6 @@ export declare class FlexibleControlsTranslator {
     private readonly _raycaster;
     private _camera;
     constructor(controls: FlexibleControls);
-    initialize(event: PointerEvent): Promise<boolean>;
-    translate(event: PointerEvent): boolean;
+    initialize(position: Vector2): Promise<boolean>;
+    translate(position: Vector2): boolean;
 }

package/dist/packages/camera-manager/src/Flexible/GetPickedPointByPixelCoordinates.d.ts

@@ -1,5 +1,5 @@
 /*!
  * Copyright 2024 Cognite AS
  */
-import { Vector3 } from 'three';
-export type GetPickedPointByPixelCoordinates = (pixelX: number, pixelY: number) => Promise<Vector3>;
+import { Vector2, Vector3 } from 'three';
+export type GetPickedPointByPixelCoordinates = (position: Vector2) => Promise<Vector3>;

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

@@ -26,20 +26,20 @@ export declare class CognitePointCloudModel {
      */
     dispose(): void;
     /**
-     * @param outBbox Optional. Used to write result to.
+     * @param outBoundingBox Optional. Used to write result to.
      * @returns Model's bounding box.
      * @example
      * ```js
-     * const box = new THREE.Box3()
-     * model.getModelBoundingBox(box);
-     * // box now has the bounding box
+     * const boundingBox = new THREE.Box3()
+     * model.getModelBoundingBox(boundingBox);
+     * // boundingBox now has the bounding box
      *```
      * ```js
      * // the following code does the same
-     * const box = model.getModelBoundingBox();
+     * const boundingBox = model.getModelBoundingBox();
      * ```
      */
-    getModelBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
+    getModelBoundingBox(outBoundingBox?: THREE.Box3): THREE.Box3;
     /**
      * Retrieves the camera position and target stored for the model. Typically this
      * is used to store a good starting position for a model. Returns `undefined` if there

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

@@ -10,7 +10,7 @@ export { InputHandler } from './src/events/InputHandler';
 export { PointerEvents } from './src/events/PointerEvents';
 export { PointerEventsTarget } from './src/events/PointerEventsTarget';
 export { disposeOfAllEventListeners } from './src/events/disposeOfAllEventListeners';
-export { clickOrTouchEventOffset, getClickOrTouchEventPoint } from './src/events/clickOrTouchEventOffset';
+export { getPixelCoordinatesFromEvent } from './src/events/getPixelCoordinatesFromEvent';
 export { getWheelEventDelta } from './src/events/getWheelEventDelta';
 export { DisposedDelegate, BeforeSceneRenderedDelegate, SceneRenderedDelegate, PointerEventDelegate, PointerEventData } from './src/events/types';
 export { assertNever } from './src/assertNever';
@@ -46,6 +46,7 @@ export { LineMaterial } from './src/three/lines/LineMaterial';
 export { DeferredPromise } from './src/DeferredPromise';
 export { SceneHandler } from './src/SceneHandler';
 export { CustomObject } from './src/customObject/CustomObject';
+export { ICustomObject } from './src/customObject/ICustomObject';
 export { CustomObjectIntersectInput } from './src/customObject/CustomObjectIntersectInput';
 export { CustomObjectIntersection } from './src/customObject/CustomObjectIntersection';
 export { isPointVisibleByPlanes } from './src/three/isPointVisibleByPlanes';

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

@@ -2,7 +2,7 @@
  * Copyright 2022 Cognite AS
  */
 import * as THREE from 'three';
-import { CustomObject } from './customObject/CustomObject';
+import { ICustomObject } from './customObject/ICustomObject';
 export declare class SceneHandler {
     private readonly _scene;
     private readonly _cadModels;
@@ -17,15 +17,15 @@ export declare class SceneHandler {
         pointCloudNode: THREE.Object3D;
         modelIdentifier: symbol;
     }[];
-    get customObjects(): CustomObject[];
+    get customObjects(): ICustomObject[];
     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;
     addObject3D(object: THREE.Object3D): void;
-    addCustomObject(customObject: CustomObject): void;
+    addCustomObject(customObject: ICustomObject): void;
     removeObject3D(object: THREE.Object3D): void;
-    removeCustomObject(customObject: CustomObject): void;
+    removeCustomObject(customObject: ICustomObject): void;
     dispose(): void;
 }

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

@@ -1,15 +1,16 @@
 /*!
  * Copyright 2024 Cognite AS
  */
-import { Object3D } from 'three';
+import { Object3D, Box3 } from 'three';
 import { CustomObjectIntersection } from './CustomObjectIntersection';
 import { CustomObjectIntersectInput } from './CustomObjectIntersectInput';
+import { ICustomObject } from './ICustomObject';
 /**
  * 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 {
+export declare class CustomObject implements ICustomObject {
     private readonly _object;
     private _isPartOfBoundingBox;
     private _shouldPick;
@@ -38,6 +39,11 @@ export declare class CustomObject {
      */
     get shouldPick(): boolean;
     set shouldPick(value: boolean);
+    /**
+     * Get the bounding box from the object
+     * @beta
+     */
+    getBoundingBox(target: Box3): Box3;
     /**
      * Set or get whether it should be also give the bounding box when picked by the camera
      * Default is false.

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

@@ -2,7 +2,7 @@
  * Copyright 2024 Cognite AS
  */
 import { Vector3, Box3 } from 'three';
-import { CustomObject } from './CustomObject';
+import { ICustomObject } from './ICustomObject';
 /**
  * This class is used as output intersecting custom objects
  * @beta
@@ -23,7 +23,7 @@ export type CustomObjectIntersection = {
     /**
      * The CustomObject that was intersected.
      */
-    customObject: CustomObject;
+    customObject: ICustomObject;
     /**
      * The bounding box of the part of the CustomObject that was intersected.
      */

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

@@ -0,0 +1,47 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+import { Object3D, Box3 } from 'three';
+import { CustomObjectIntersection } from './CustomObjectIntersection';
+import { CustomObjectIntersectInput } from './CustomObjectIntersectInput';
+/**
+ * This interface encasulate a Object3D, and made it possible to add flags to it.
+ * It might be extended with more flags in the future.
+ * @beta
+ */
+export interface ICustomObject {
+    /**
+     * Get the Object3D
+     * @beta
+     */
+    get object(): Object3D;
+    /**
+     * Get whether it should be part of the combined bounding box or not.
+     * Default is true.
+     * @beta
+     */
+    get isPartOfBoundingBox(): boolean;
+    /**
+     * Get whether it should be picked by the camera manager
+     * Default is false.
+     * @beta
+     */
+    get shouldPick(): 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;
+    /**
+     * Get the bounding box from the object
+     * @beta
+     */
+    getBoundingBox(target: Box3): Box3;
+    /**
+     * 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/events/PointerEventsTarget.d.ts

@@ -11,7 +11,7 @@ import { PointerEvents } from './PointerEvents';
 export declare class PointerEventsTarget {
     private readonly _domElement;
     private readonly _events;
-    private readonly _downPosition;
+    private _downPosition;
     private _lastDownTimestamp;
     private _prevDownTimestamp;
     private _clickCounter;

package/dist/packages/utilities/src/events/getPixelCoordinatesFromEvent.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Vector2 } from 'three';
+/**
+ * Determines clicked or touched coordinate as offset
+ * @param event     An PointerEvent or WheelEvent.
+ * @param domElement    HTML element to find coordinates relative to.
+ * @returns A Vector2 containing coordinates relative to the HTML element provided.
+ */
+export declare function getPixelCoordinatesFromEvent(event: PointerEvent | WheelEvent, domElement: HTMLElement): Vector2;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.13.0",
+  "version": "4.14.0",
   "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": {
@@ -156,5 +156,5 @@
   "files": [
     "dist"
   ],
-  "packageManager": "yarn@4.1.1"
+  "packageManager": "yarn@4.2.1"
 }

package/dist/packages/utilities/src/events/clickOrTouchEventOffset.d.ts

@@ -1,21 +0,0 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Vector2 } from 'three';
-/**
- * Determines clicked or touched coordinate as offset
- * @param event     An PointerEvent or WheelEvent.
- * @param target    HTML element to find coordinates relative to.
- * @returns A struct containing coordinates relative to the HTML element provided.
- */
-export declare function clickOrTouchEventOffset(event: PointerEvent | WheelEvent, target: HTMLElement): {
-    offsetX: number;
-    offsetY: number;
-};
-/**
- * Determines clicked or touched coordinate as offset
- * @param event     An PointerEvent or WheelEvent.
- * @param target    HTML element to find coordinates relative to.
- * @returns A Vector2 containing coordinates relative to the HTML element provided.
- */
-export declare function getClickOrTouchEventPoint(event: PointerEvent | WheelEvent, target: HTMLElement): Vector2;