@cognite/reveal 4.8.0 → 4.9.1

package/dist/packages/api/src/api-helpers/Image360ApiHelper.d.ts

@@ -23,7 +23,6 @@ export declare class Image360ApiHelper {
     constructor(cogniteClient: CogniteClient, sceneHandler: SceneHandler, domElement: HTMLElement, activeCameraManager: ProxyCameraManager, inputHandler: InputHandler, onBeforeSceneRendered: EventTrigger<BeforeSceneRenderedDelegate>, iconsOptions?: IconsOptions);
     get needsRedraw(): boolean;
     resetRedraw(): void;
-    private getNormalizedOffset;
     add360ImageSet(collectionIdentifier: Metadata | Image360DataModelIdentifier, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean, annotationOptions?: Image360AnnotationFilterOptions): Promise<Image360Collection>;
     getImageCollections(): Image360Collection[];
     remove360Images(entities: Image360[]): Promise<void>;

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

@@ -48,7 +48,7 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
     private readonly cadModel;
     private readonly nodesApiClient;
     private readonly nodeIdAndTreeIndexMaps;
-    private readonly _styledNodeCollections;
+    private _styledNodeCollections;
     private readonly customSectorBounds;
     /**
      * Sets the default appearance for nodes that are not styled using
@@ -90,6 +90,7 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
      *
      * @param nodeCollection Dynamic set of nodes to apply the provided appearance to.
      * @param appearance Appearance to style the provided set with.
+     * @param importance The importance of this style. Can be used to manually order the order of styles, this can avoid the order of adding styles affecting the outcome. Optional and defaults to 0.
      * @example
      * ```js
      * model.setDefaultNodeAppearance({ rendererGhosted: true });
@@ -97,7 +98,7 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
      * model.assignStyledNodeCollection(visibleSet, { rendererGhosted: false });
      * ```
      */
-    assignStyledNodeCollection(nodeCollection: NodeCollection, appearance: NodeAppearance): void;
+    assignStyledNodeCollection(nodeCollection: NodeCollection, appearance: NodeAppearance, importance?: number): void;
     /**
      * Removes styling for previously added styled collection, resetting the style to the default (or
      * the style imposed by other styled collections).

package/dist/packages/cad-styling/src/NodeAppearanceProvider.d.ts

@@ -12,7 +12,7 @@ import { IndexSet } from '../../utilities';
  */
 export type ApplyStyleDelegate = (treeIndices: IndexSet, appearance: NodeAppearance) => void;
 export declare class NodeAppearanceProvider {
-    private readonly _styledCollections;
+    private _styledCollections;
     private _lastFiredLoadingState?;
     private _cachedPrioritizedAreas?;
     private readonly _events;
@@ -21,7 +21,7 @@ export declare class NodeAppearanceProvider {
     on(event: 'prioritizedAreasChanged', listener: () => void): void;
     off(event: 'changed', listener: () => void): void;
     off(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
-    assignStyledNodeCollection(nodeCollection: NodeCollection, appearance: NodeAppearance): void;
+    assignStyledNodeCollection(nodeCollection: NodeCollection, appearance: NodeAppearance, importance?: number): void;
     unassignStyledNodeCollection(nodeCollection: NodeCollection): void;
     applyStyles(applyCb: ApplyStyleDelegate): void;
     getPrioritizedAreas(): PrioritizedArea[];

package/dist/packages/camera-manager/index.d.ts

@@ -6,6 +6,7 @@ export { ProxyCameraManager } from './src/ProxyCameraManager';
 export { StationaryCameraManager } from './src/StationaryCameraManager';
 export { CameraManagerHelper } from './src/CameraManagerHelper';
 export { CameraManager } from './src/CameraManager';
-export { ComboControls, ComboControlsOptions, ComboControlsEventType } from './src/ComboControls';
+export { ComboControls, ComboControlsEventType } from './src/ComboControls';
+export { ComboControlsOptions } from './src/ComboControlsOptions';
 export { DebouncedCameraStopEventTrigger } from './src/utils/DebouncedCameraStopEventTrigger';
 export * from './src/types';

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

@@ -2,66 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 import { EventDispatcher, OrthographicCamera, PerspectiveCamera, Quaternion, Vector3 } from 'three';
-/**
- * Exposed options for Combo Controls
- */
-export type ComboControlsOptions = {
-    enableDamping: boolean;
-    dampingFactor: number;
-    dynamicTarget: boolean;
-    minDistance: number;
-    minZoomDistance: number;
-    dollyFactor: number;
-    /**
-     * Radians
-     */
-    minPolarAngle: number;
-    /**
-     * Radians
-     */
-    maxPolarAngle: number;
-    /**
-     * Radians
-     */
-    minAzimuthAngle: number;
-    /**
-     * Radians
-     */
-    maxAzimuthAngle: number;
-    panDollyMinDistanceFactor: number;
-    firstPersonRotationFactor: number;
-    /**
-     * Radians per pixel
-     */
-    pointerRotationSpeedAzimuth: number;
-    /**
-     * Radians per pixel
-     */
-    pointerRotationSpeedPolar: number;
-    enableKeyboardNavigation: boolean;
-    keyboardRotationSpeedAzimuth: number;
-    keyboardRotationSpeedPolar: number;
-    mouseFirstPersonRotationSpeed: number;
-    keyboardDollySpeed: number;
-    keyboardPanSpeed: number;
-    /**
-     * How much quicker keyboard navigation will be with 'shift' pressed
-     */
-    keyboardSpeedFactor: number;
-    pinchEpsilon: number;
-    pinchPanSpeed: number;
-    EPSILON: number;
-    minZoom: number;
-    maxZoom: number;
-    orthographicCameraDollyFactor: number;
-    lookAtViewTarget: boolean;
-    useScrollTarget: boolean;
-    zoomToCursor: boolean;
-    minDeltaRatio: number;
-    maxDeltaRatio: number;
-    minDeltaDownscaleCoefficient: number;
-    maxDeltaDownscaleCoefficient: number;
-};
+import { ComboControlsOptions } from './ComboControlsOptions';
 /**
  * The event type for events emitted by {@link ComboControls}.
  */
@@ -75,31 +16,25 @@ export type ComboControlsEventType = {
 };
 export declare class ComboControls extends EventDispatcher<ComboControlsEventType> {
     dispose: () => void;
+    private _enabled;
+    private _options;
     private _temporarilyDisableDamping;
+    private readonly _domElement;
     private readonly _camera;
-    private _firstPersonMode;
     private readonly _reusableCamera;
-    private readonly _reusableVector3;
-    private readonly _accumulatedMouseMove;
-    private readonly _domElement;
     private readonly _target;
-    private readonly _viewTarget;
-    private readonly _scrollTarget;
     private readonly _targetEnd;
     private readonly _spherical;
     private readonly _sphericalEnd;
-    private readonly _deltaTarget;
+    private readonly _scrollTarget;
+    private readonly _viewTarget;
     private readonly _rawCameraRotation;
+    private readonly _accumulatedMouseMove;
     private readonly _keyboard;
-    private readonly _offsetVector;
-    private readonly _panVector;
-    private readonly _raycaster;
-    private readonly _targetFPS;
-    private _targetFPSOverActualFPS;
     private readonly _pointEventCache;
-    private _enabled;
-    private _options;
-    private static readonly DefaultControlsOptions;
+    private readonly _reusableVector3s;
+    private readonly _raycaster;
+    constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement);
     /**
      * Gets current Combo Controls options.
      */
@@ -118,13 +53,6 @@ export declare class ComboControls extends EventDispatcher<ComboControlsEventTyp
      * Sets the enabled state of these controls.
      */
     set enabled(newEnabledValue: boolean);
-    constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement);
-    update: (deltaTimeS: number, forceUpdate?: boolean) => boolean;
-    getState: () => {
-        target: Vector3;
-        position: Vector3;
-    };
-    setState: (position: Vector3, target: Vector3) => void;
     /**
      * Camera rotation to be used by the camera instead of target-based rotation.
      * This rotation is used only when set to non-default quaternion value (not identity rotation quaternion).
@@ -132,12 +60,25 @@ export declare class ComboControls extends EventDispatcher<ComboControlsEventTyp
      * resets to default value when `setState` method is called with no rotation value.
      */
     get cameraRawRotation(): Quaternion;
-    setViewTarget: (target: Vector3) => void;
-    setScrollTarget: (target: Vector3) => void;
     getScrollTarget: () => Vector3;
+    getState: () => {
+        target: Vector3;
+        position: Vector3;
+    };
+    setScrollTarget: (target: Vector3) => void;
+    setState: (position: Vector3, target: Vector3) => void;
+    setViewTarget: (target: Vector3) => void;
+    /**
+     * Converts deltaTimeS to a time scale based on the target frames per second (FPS).
+     *
+     * @param deltaTimeS - The elapsed time since the last frame in seconds.
+     * @returns The time scale, which is a factor representing the relationship of deltaTimeS to the target FPS.
+     */
+    private getTimeScale;
+    private getDollyDeltaDistance;
+    private newVector3;
+    update: (deltaTimeS: number, forceUpdate?: boolean) => boolean;
     triggerCameraChangeEvent: () => void;
-    private calculateShortestDeltaTheta;
-    private readonly convertPixelCoordinatesToNormalized;
     private readonly onPointerDown;
     private readonly onMouseDown;
     private readonly onPointerUp;
@@ -146,36 +87,25 @@ export declare class ComboControls extends EventDispatcher<ComboControlsEventTyp
     private readonly onTouchStart;
     private readonly onFocusChanged;
     private readonly onContextMenu;
-    private readonly rotate;
-    private readonly startMouseRotation;
-    private readonly startMousePan;
-    private readonly startTouchRotation;
-    private readonly startTouchPinch;
-    /**
-     * Converts deltaTimeS to a time scale based on the target frames per second (FPS).
-     *
-     * @param deltaTimeS - The elapsed time since the last frame in seconds.
-     * @returns The time scale, which is a factor representing the relationship of deltaTimeS to the target FPS.
-     */
-    private getTimeScale;
+    private addEventListeners;
+    private removeEventListeners;
+    private startMouseRotation;
+    private startTouchRotation;
+    private rotate;
+    private rotateFirstPersonMode;
+    private startTouchPinch;
+    private startMousePan;
+    private pan;
+    private panLeft;
+    private panUp;
+    private dolly;
+    private dollyOrthographicCamera;
+    private dollyPerspectiveCamera;
+    private dollyWithWheelScroll;
+    private calculateNewRadiusAndTargetOffsetLerp;
+    private calculateNewRadiusAndTargetOffsetScrollTarget;
     private handleRotationFromKeyboard;
     private handleDollyFromKeyboard;
     private handlePanFromKeyboard;
-    private readonly handleKeyboard;
-    private readonly rotateSpherical;
-    private readonly rotateFirstPersonMode;
-    private readonly pan;
-    private readonly dollyOrthographicCamera;
-    private readonly calculateNewRadiusAndTargetOffsetLerp;
-    private readonly clampedMap;
-    private readonly calculateNewRadiusAndTargetOffsetScrollTarget;
-    private readonly dollyWithWheelScroll;
-    private readonly dollyPerspectiveCamera;
-    private readonly dolly;
-    private readonly getDollyDeltaDistance;
-    private readonly panLeft;
-    private readonly panUp;
-    private isIdentityQuaternion;
-    private addEventListeners;
-    private removeEventListeners;
+    private handleKeyboard;
 }

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

@@ -0,0 +1,64 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+/**
+ * Exposed options for Combo Controls
+ */
+export type ComboControlsOptions = {
+    enableDamping: boolean;
+    dampingFactor: number;
+    dynamicTarget: boolean;
+    minDistance: number;
+    minZoomDistance: number;
+    dollyFactor: number;
+    /**
+     * Radians
+     */
+    minPolarAngle: number;
+    /**
+     * Radians
+     */
+    maxPolarAngle: number;
+    /**
+     * Radians
+     */
+    minAzimuthAngle: number;
+    /**
+     * Radians
+     */
+    maxAzimuthAngle: number;
+    panDollyMinDistanceFactor: number;
+    firstPersonRotationFactor: number;
+    /**
+     * Radians per pixel
+     */
+    pointerRotationSpeedAzimuth: number;
+    /**
+     * Radians per pixel
+     */
+    pointerRotationSpeedPolar: number;
+    enableKeyboardNavigation: boolean;
+    keyboardRotationSpeedAzimuth: number;
+    keyboardRotationSpeedPolar: number;
+    mouseFirstPersonRotationSpeed: number;
+    keyboardDollySpeed: number;
+    keyboardPanSpeed: number;
+    /**
+     * How much quicker keyboard navigation will be with 'shift' pressed
+     */
+    keyboardSpeedFactor: number;
+    pinchEpsilon: number;
+    pinchPanSpeed: number;
+    EPSILON: number;
+    minZoom: number;
+    maxZoom: number;
+    orthographicCameraDollyFactor: number;
+    lookAtViewTarget: boolean;
+    useScrollTarget: boolean;
+    zoomToCursor: boolean;
+    minDeltaRatio: number;
+    maxDeltaRatio: number;
+    minDeltaDownscaleCoefficient: number;
+    maxDeltaDownscaleCoefficient: number;
+};
+export declare function CreateDefaultControlsOptions(): Readonly<Required<ComboControlsOptions>>;

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

@@ -2,7 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 import * as THREE from 'three';
-import { ComboControlsOptions } from './ComboControls';
+import { ComboControlsOptions } from './ComboControlsOptions';
 import { CameraControlsOptions, CameraState, CameraManagerEventType, CameraEventDelegate } from './types';
 import { CameraManager } from './CameraManager';
 /**
@@ -18,12 +18,13 @@ export declare class DefaultCameraManager implements CameraManager {
     private readonly _domElement;
     private readonly _inputHandler;
     private readonly _raycaster;
-    private isDisposed;
+    private _isDisposed;
     private _nearAndFarNeedsUpdate;
-    private isEnabled;
+    private _isEnabled;
     private readonly _modelRaycastCallback;
     private _onClick;
     private _onWheel;
+    private _onDoubleClick;
     private static readonly AnimationDuration;
     private static readonly MinAnimationDuration;
     private static readonly MaxAnimationDuration;
@@ -126,11 +127,7 @@ export declare class DefaultCameraManager implements CameraManager {
      * Method for setting up camera controls listeners and values inside current controls class.
      */
     private setupControls;
-    /**
-     * Convert pixel coordinates of the cursor to [-1,1]^2 coordinates.
-     * @param pixelX
-     * @param pixelY
-     */
-    private convertPixelCoordinatesToNormalized;
+    private readonly onClick;
+    private readonly onDoubleClick;
     private calculateDefaultDuration;
 }

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

@@ -24,6 +24,14 @@ export type CameraControlsOptions = {
      *
      */
     changeCameraTargetOnClick?: boolean;
+    /**
+     * Enables or disables change of camera position on mouse doubke click. New target is then set to the point of the model under current cursor
+     * position and the a camera position is set half way to this point
+     *
+     * Default is false.
+     *
+     */
+    changeCameraPositionOnDoubleClick?: boolean;
 };
 export type ControlsState = {
     position: THREE.Vector3;
@@ -72,6 +80,10 @@ export type CameraManagerCallbackData = {
      * Bounding box for all models on the scene
      */
     modelsBoundingBox: THREE.Box3;
+    /**
+     * Bounding box for the object (node in a model) that was picked
+     */
+    pickedBoundingBox: THREE.Box3 | undefined;
 };
 /**
  * List of supported event types (adapted from https://stackoverflow.com/questions/44480644/string-union-to-string-array)

package/dist/packages/metrics/src/Fingerprint.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns a fingerprint based on the current browser. This is can be used to
+ * distinguish between different users. However, it is not 100% reliable,
+ * and can produce duplicates for distinct users.
+ *
+ * See https://broprintjs.netlify.app/
+ */
+export declare function getUserFingerprint(): Promise<string>;

package/dist/packages/metrics/src/MetricsLogger.d.ts

@@ -6,13 +6,14 @@ import * as THREE from 'three';
 import { TrackedEvents, EventProps } from './types';
 export declare class MetricsLogger {
     private readonly _sessionProps;
+    private readonly _initPromise;
     private static readonly TrackCameraNavigationThrottleDelay;
     private static readonly TrackCadNodeTransformOverriddenThrottleDelay;
     static globalMetricsLogger: MetricsLogger;
     private constructor();
     static init(logMetrics: boolean, project: string, applicationId: string, eventProps: EventProps): void;
     private innerTrackEvent;
-    static trackEvent(eventName: TrackedEvents, eventProps: EventProps): void;
+    static trackEvent(eventName: TrackedEvents, eventProps: EventProps): Promise<void>;
     static trackCreateTool(toolName: string): void;
     static trackLoadModel(eventProps: EventProps, modelIdentifier: any, modelVersion: number): void;
     static trackCadModelStyled(nodeCollectionClassToken: string, appearance: any): void;

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

@@ -33,7 +33,7 @@ export { disposeAttributeArrayOnUpload } from './src/disposeAttributeArrayOnUplo
 export { incrementOrInsertIndex, decrementOrDeleteIndex } from './src/counterMap';
 export { calculateVolumeOfMesh } from './src/calculateVolumeOfMesh';
 export { getApproximateProjectedBounds, getScreenArea } from './src/projectedBounds';
-export { worldToNormalizedViewportCoordinates, worldToViewportCoordinates, pixelToNormalizedDeviceCoordinates } from './src/worldToViewport';
+export { worldToNormalizedViewportCoordinates, worldToViewportCoordinates, getNormalizedPixelCoordinatesBySize, getNormalizedPixelCoordinates } from './src/worldToViewport';
 export { Line2 } from './src/three/lines/Line2';
 export { LineGeometry } from './src/three/lines/LineGeometry';
 export { LineMaterial } from './src/three/lines/LineMaterial';

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

@@ -31,4 +31,5 @@ export declare function worldToViewportCoordinates(canvas: HTMLCanvasElement, ca
 /**
  * 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;
+export declare function getNormalizedPixelCoordinatesBySize(pixelX: number, pixelY: number, width: number, height: number): THREE.Vector2;
+export declare function getNormalizedPixelCoordinates(domElement: HTMLElement, pixelX: number, pixelY: number): THREE.Vector2;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.8.0",
+  "version": "4.9.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": {
@@ -62,9 +62,10 @@
     "ws:lint": "cd $INIT_CWD && eslint . --ext .ts,.js --max-warnings 0 --cache"
   },
   "dependencies": {
+    "@rajesh896/broprint.js": "^2.1.1",
     "@tweenjs/tween.js": "19.0.0",
     "assert": "2.1.0",
-    "async-mutex": "0.4.0",
+    "async-mutex": "0.4.1",
     "glslify": "7.1.1",
     "glslify-import": "3.1.0",
     "html2canvas": "^1.4.1",
@@ -80,51 +81,51 @@
   "devDependencies": {
     "@azure/msal-browser": "2.38.3",
     "@cognite/sdk": "8.3.0",
-    "@microsoft/api-extractor": "7.38.3",
+    "@microsoft/api-extractor": "7.39.4",
     "@types/dat.gui": "0.7.12",
     "@types/gl": "^6.0.2",
     "@types/glob": "8.1.0",
-    "@types/jest": "29.5.10",
+    "@types/jest": "29.5.12",
     "@types/jest-environment-puppeteer": "5.0.6",
-    "@types/jest-image-snapshot": "6.3.0",
+    "@types/jest-image-snapshot": "6.4.0",
     "@types/jsdom": "21.1.6",
     "@types/lodash": "4.14.202",
-    "@types/mixpanel-browser": "2.47.5",
-    "@types/node": "18.19.1",
+    "@types/mixpanel-browser": "2.48.1",
+    "@types/node": "18.19.14",
     "@types/random-seed": "0.3.5",
     "@types/skmeans": "0.11.7",
     "@types/stats": "0.16.30",
     "@types/three": "0.158.2",
     "@types/tween.js": "18.5.1",
-    "@typescript-eslint/eslint-plugin": "6.12.0",
-    "@typescript-eslint/parser": "6.12.0",
+    "@typescript-eslint/eslint-plugin": "6.19.1",
+    "@typescript-eslint/parser": "6.19.1",
     "concurrently": "8.2.2",
     "cross-env": "7.0.3",
     "dat.gui": "0.7.9",
-    "eslint": "8.54.0",
-    "eslint-config-prettier": "9.0.0",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "9.1.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-jsdoc": "46.9.0",
+    "eslint-plugin-jsdoc": "46.10.1",
     "eslint-plugin-lodash": "7.4.0",
-    "eslint-plugin-prettier": "5.0.1",
+    "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-unused-imports": "3.0.0",
     "file-loader": "6.2.0",
     "gl": "6.0.2",
     "glob": "10.3.10",
     "glslify-loader": "2.0.0",
-    "html-webpack-plugin": "5.5.3",
+    "html-webpack-plugin": "5.6.0",
     "jest": "29.7.0",
     "jest-canvas-mock": "2.5.2",
     "jest-environment-jsdom": "29.7.0",
     "jest-extended": "4.0.2",
-    "jest-image-snapshot": "6.3.0",
-    "jest-puppeteer": "9.0.1",
-    "jsdom": "22.1.0",
+    "jest-image-snapshot": "6.4.0",
+    "jest-puppeteer": "9.0.2",
+    "jsdom": "23.2.0",
     "moq.ts": "10.0.8",
-    "nock": "13.4.0",
-    "prettier": "3.1.0",
+    "nock": "13.5.1",
+    "prettier": "3.2.4",
     "process": "0.11.10",
-    "puppeteer": "21.5.2",
+    "puppeteer": "21.11.0",
     "random-seed": "0.3.0",
     "raw-loader": "4.0.2",
     "remove-files-webpack-plugin": "1.5.0",
@@ -132,16 +133,16 @@
     "shx": "0.3.4",
     "stats.js": "0.17.0",
     "three": "0.158.0",
-    "ts-jest": "29.1.1",
+    "ts-jest": "29.1.2",
     "ts-loader": "9.5.1",
     "tsc-alias": "1.8.8",
-    "typescript": "5.3.2",
+    "typescript": "5.3.3",
     "wasm-pack": "0.12.1",
     "webpack": "5.89.0",
     "webpack-cli": "5.1.4",
     "webpack-dev-server": "4.15.1",
     "webpack-node-externals": "3.0.0",
-    "whatwg-fetch": "3.6.19",
+    "whatwg-fetch": "3.6.20",
     "workerize-loader": "2.0.2"
   },
   "peerDependencies": {