@cognite/reveal 4.10.3 → 4.10.5

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

@@ -75,7 +75,7 @@ export declare class Cognite3DViewer {
     /**
      * Reusable buffers used by functions in Cognite3dViewer to avoid allocations.
      */
-    private readonly _updateNearAndFarPlaneBuffers;
+    private readonly _boundingBoxes;
     /**
      * Gets the current budget for downloading geometry for CAD models. Note that this
      * budget is shared between all added CAD models and not a per-model budget.

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

@@ -25,8 +25,8 @@ export declare class FlexibleCameraManager implements IFlexibleCameraManager {
     private readonly _markers?;
     private readonly _currentBoundingBox;
     private _isDisposed;
+    private _isEnableClickAndDoubleClick;
     private _nearAndFarNeedsUpdate;
-    private _isEnabled;
     private _prevTime;
     private readonly _prevCoords;
     private readonly _raycastCallback;
@@ -45,23 +45,25 @@ export declare class FlexibleCameraManager implements IFlexibleCameraManager {
     on(event: CameraManagerEventType, callback: CameraEventDelegate): void;
     off(event: CameraManagerEventType, callback: CameraEventDelegate): void;
     fitCameraToBoundingBox(boundingBox: Box3, duration?: number, radiusFactor?: number): void;
-    update(deltaTime: number, boundingBox: Box3): void;
+    update(deltaTime: number, nearFarBoundingBox: Box3): void;
     dispose(): void;
     get controlsType(): FlexibleControlsType;
     set controlsType(value: FlexibleControlsType);
+    rotateCameraTo(direction: Vector3, animationDuration: number): void;
     addControlsTypeChangeListener(callback: FlexibleControlsTypeChangeDelegate): void;
     removeControlsTypeChangeListener(callback: FlexibleControlsTypeChangeDelegate): void;
+    updateModelBoundingBox(modelBoundingBox: Box3): void;
     get options(): FlexibleControlsOptions;
     get controls(): FlexibleControls;
     get camera(): PerspectiveCamera;
     get domElement(): HTMLElement;
     get isEnabled(): boolean;
+    get isEnableClickAndDoubleClick(): boolean;
     get isDisposed(): boolean;
     private set isEnabled(value);
+    set isEnableClickAndDoubleClick(value: boolean);
     private getPosition;
     private getTarget;
-    getBoundingBoxDiagonal(): number;
-    getHorizontalDiagonal(): number;
     setPositionAndTarget(position: Vector3, target: Vector3): void;
     private readonly getPickedPointByPixelCoordinates;
     private getTargetByBoundingBox;

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

@@ -1,7 +1,7 @@
 /*!
  * Copyright 2024 Cognite AS
  */
-import { EventDispatcher, OrthographicCamera, PerspectiveCamera, Quaternion, Vector2, Vector3 } from 'three';
+import { EventDispatcher, OrthographicCamera, PerspectiveCamera, Quaternion, Spherical, Vector2, Vector3 } from 'three';
 import { FlexibleControlsType } from './FlexibleControlsType';
 import { FlexibleControlsOptions } from './FlexibleControlsOptions';
 import { DampedVector3 } from './DampedVector3';
@@ -27,11 +27,15 @@ export declare class FlexibleControls extends EventDispatcher<FlexibleControlsEv
     private readonly _keyboard;
     private readonly _pointEventCache;
     private _getPickedPointByPixelCoordinates;
+    private _rawCameraRotation;
     private readonly _reusableVector3s;
+    private readonly _rotationHelper;
+    private _mouseDragInfo;
     constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement, options: FlexibleControlsOptions);
     dispose(): void;
     get options(): FlexibleControlsOptions;
     get camera(): PerspectiveCamera | OrthographicCamera;
+    get target(): DampedVector3;
     get cameraVector(): DampedSpherical;
     get cameraPosition(): DampedVector3;
     get isEnabled(): boolean;
@@ -63,9 +67,10 @@ export declare class FlexibleControls extends EventDispatcher<FlexibleControlsEv
     update(deltaTimeS: number, forceUpdate?: boolean): boolean;
     triggerCameraChangeEvent(): void;
     triggerControlsTypeChangeEvent(): void;
+    rotateCameraTo(startDirection: Spherical, endDirection: Spherical, factor: number): void;
     private readonly onPointerDown;
     private readonly onMouseDown;
-    private startMouse;
+    private readonly onPointerMove;
     private readonly onPointerUp;
     private readonly onMouseWheel;
     private readonly onTouchStart;
@@ -73,6 +78,8 @@ export declare class FlexibleControls extends EventDispatcher<FlexibleControlsEv
     private readonly onContextMenu;
     addEventListeners(): void;
     private removeEventListeners;
+    updateCameraAndTriggerCameraChangeEvent(): void;
+    updateCamera(deltaTimeS: number, forceUpdate?: boolean, useDampening?: boolean): boolean;
     private startTouchRotation;
     private rotate;
     getAzimuthCompensationFactor(): number;
@@ -91,3 +98,6 @@ export declare class FlexibleControls extends EventDispatcher<FlexibleControlsEv
     private handleRotationFromKeyboard;
     private handleMoveFromKeyboard;
 }
+export declare function isMouse(event: PointerEvent): boolean;
+export declare function isTouch(event: PointerEvent): boolean;
+export declare function isPressed(event: PointerEvent): boolean;

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

@@ -9,7 +9,6 @@ import { FlexibleWheelZoomType } from './FlexibleWheelZoomType';
  */
 export declare class FlexibleControlsOptions {
     controlsType: FlexibleControlsType;
-    showTarget: boolean;
     mouseWheelAction: FlexibleWheelZoomType;
     mouseClickType: FlexibleMouseActionType;
     mouseDoubleClickType: FlexibleMouseActionType;
@@ -46,8 +45,11 @@ export declare class FlexibleControlsOptions {
     keyboardFastMoveFactor: number;
     pinchEpsilon: number;
     pinchPanSpeed: number;
-    EPSILON: number;
     orthographicCameraDollyFactor: number;
+    showTarget: boolean;
+    relativeMarkerSize: number;
+    outerMarkerColor: string;
+    innerMarkerColor: string;
     get realMouseWheelAction(): FlexibleWheelZoomType;
     get shouldPick(): boolean;
     getLegalAzimuthAngle(azimuthAngle: number): number;

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

@@ -0,0 +1,15 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+import { FlexibleControls } from './FlexibleControls';
+/**
+ * Helper class for rotating the camera. Call begin() before rotation,
+ * and end() after so the camera position updates correcly
+ * @beta
+ */
+export declare class FlexibleControlsRotationHelper {
+    private readonly oldOffset;
+    private readonly oldCameraVectorEnd;
+    begin(controls: FlexibleControls): void;
+    end(controls: FlexibleControls): void;
+}

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

@@ -3,6 +3,7 @@
  */
 import { CameraManager } from '../CameraManager';
 import { FlexibleControlsType } from './FlexibleControlsType';
+import { Vector3 } from 'three';
 /**
  * @beta
  */
@@ -10,11 +11,34 @@ export type FlexibleControlsTypeChangeDelegate = (controlsType: FlexibleControls
 /**
  * Flexible implementation of {@link CameraManager}. The user can switch between Orbit, FirstPersion or OrbitInCenter
  * Supports automatic update of camera near and far planes and animated change of camera position and target.
+ * It provides additional functionality for controlling camera behavior and rotation.
  * @beta
  */
 export interface IFlexibleCameraManager extends CameraManager {
+    /**
+     * Get curent FlexibleControlsType type
+     */
     get controlsType(): FlexibleControlsType;
+    /**
+     * Set curent FlexibleControlsType type
+     */
     set controlsType(value: FlexibleControlsType);
+    /**
+     * Rotates the camera to look in the specified direction.
+     * Supports automatic update of camera near and far planes and animated change of camera position and target.
+     * @beta
+     * @param direction - The direction to rotate the camera towards.
+     * @param animationDuration - The duration of the rotation animation in milliseconds.
+     */
+    rotateCameraTo(direction: Vector3, animationDuration: number): void;
+    /**
+     * Adds a listener for changes in the controls type of the camera manager.
+     * @param callback - The callback function to be invoked when the controls type changes.
+     */
     addControlsTypeChangeListener(callback: FlexibleControlsTypeChangeDelegate): void;
+    /**
+     * Removes a listener for changes in the controls type of the camera manager.
+     * @param callback - The callback function to be removed from the controls type change listeners.
+     */
     removeControlsTypeChangeListener(callback: FlexibleControlsTypeChangeDelegate): void;
 }

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

@@ -5,14 +5,16 @@ declare const EVENT_CODES: readonly ["MetaLeft", "MetaRight", "ShiftLeft", "Shif
 type EventCode = (typeof EVENT_CODES)[number];
 export default class Keyboard {
     private readonly _keys;
-    private _disabled;
+    private _isEnabled;
     private readonly _domElement;
-    get disabled(): boolean;
-    set disabled(isDisabled: boolean);
+    get isEnabled(): boolean;
+    set isEnabled(value: boolean);
     constructor(domElement: HTMLElement);
     isPressed(key: EventCode): boolean;
     isShiftPressed(): boolean;
+    isShiftPressedOnly(): boolean;
     isCtrlPressed(): boolean;
+    isCtrlPressedOnly(): boolean;
     isAltPressed(): boolean;
     isMetaPressed(): boolean;
     dispose(): void;
@@ -29,6 +31,6 @@ export default class Keyboard {
     private readonly removeEventListeners;
     private readonly onKeyDown;
     private readonly onKeyUp;
-    private readonly clearPressedKeys;
+    readonly clearPressedKeys: () => void;
 }
 export {};

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

@@ -4,7 +4,10 @@
 export { HtmlOverlayTool, HtmlOverlayOptions, HtmlOverlayToolOptions, HtmlOverlayToolClusteringOptions, HtmlOverlayPositionUpdatedDelegate, HtmlOverlayCreateClusterDelegate } from './src/HtmlOverlay/HtmlOverlayTool';
 export { DebugCameraTool } from './src/DebugCameraTool';
 export { AxisViewTool } from './src/AxisView/AxisViewTool';
-export { AxisBoxConfig, AxisBoxCompassConfig, AxisBoxFaceConfig, Corner, AbsolutePosition, RelativePosition } from './src/AxisView/types';
+export { AxisGizmoTool } from './src/AxisGizmo/AxisGizmoTool';
+export { AxisGizmoOptions } from './src/AxisGizmo/AxisGizmoOptions';
+export { AxisBoxConfig, AxisBoxCompassConfig, AxisBoxFaceConfig, AbsolutePosition, RelativePosition } from './src/AxisView/types';
+export { Corner } from './src/utilities/Corner';
 export { Overlay3DTool, Overlay3DToolParameters, OverlayEventHandler, OverlayToolEvent, OverlayCollectionOptions } from './src/Overlay3D/Overlay3DTool';
 export { TimelineTool } from './src/Timeline/TimelineTool';
 export { Keyframe } from './src/Timeline/Keyframe';

package/dist/packages/tools/src/AxisGizmo/AxisGizmoOptions.d.ts

@@ -0,0 +1,36 @@
+import { Corner } from '../utilities/Corner';
+/**
+ * Options for styling the AxisGizmoTool
+ * @beta
+ */
+export declare class AxisGizmoOptions {
+    size: number;
+    corner: Corner;
+    xMargin: number;
+    yMargin: number;
+    bubbleRadius: number;
+    insideMargin: number;
+    primaryLineWidth: number;
+    secondaryLineWidth: number;
+    bobbleLineWidth: number;
+    useGeoLabels: boolean;
+    yUp: boolean;
+    fontSize: string;
+    fontFamily: string;
+    fontWeight: string;
+    normalTextColor: string;
+    selectedTextColor: string;
+    focusCircleColor: string;
+    focusCircleAlpha: number;
+    fontYAdjust: number;
+    lightColors: number[];
+    darkColors: number[];
+    animationDuration: number;
+    private _font;
+    get radius(): number;
+    /**
+     * Get the font style.
+     * @returns The font style.
+     */
+    getFont(): string;
+}

package/dist/packages/tools/src/AxisGizmo/AxisGizmoTool.d.ts

@@ -0,0 +1,55 @@
+import { AxisGizmoOptions } from './AxisGizmoOptions';
+import { Cognite3DViewer } from '../../../api';
+import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+/**
+ * Class for axis gizmo like the one in Blender
+ * @beta
+ */
+export declare class AxisGizmoTool extends Cognite3DViewerToolBase {
+    private readonly _options;
+    private readonly _axes;
+    private readonly _center;
+    private _mousePosition;
+    private _selectedAxis;
+    private _isMouseOver;
+    private _inDragging;
+    private _viewer;
+    private _element;
+    private _canvas;
+    private _context;
+    private readonly _onPointerDown;
+    private readonly _onPointerUp;
+    private readonly _onPointerMove;
+    private readonly _onPointerOut;
+    private readonly _onMouseClick;
+    private readonly _onMouseDoubleClick;
+    constructor(option?: AxisGizmoOptions);
+    dispose(): void;
+    /**
+     * Connects the AxisGizmoTool to a Cognite3DViewer instance.
+     * @param viewer The Cognite3DViewer instance to connect to.
+     * Note: After it is connected to the viewer the tool can not be moved or
+     * changed size by changing the fields: size, corner, yMargin and yMargin
+     * in the AxisGizmoOptions
+     */
+    connect(viewer: Cognite3DViewer): void;
+    get options(): AxisGizmoOptions;
+    private onPointerDown;
+    private onPointerUp;
+    private onPointerMove;
+    private onPointerOut;
+    private onMouseClick;
+    private onMouseDoubleClick;
+    private readonly onCameraChange;
+    private getTextColor;
+    private isMouseOver;
+    private getAxisToUse;
+    private getSelectedAxis;
+    private updateSelectedAxis;
+    private updateAndRender;
+    private updateAxisPosition;
+    private addEventListeners;
+    private removeEventListeners;
+    private createElement;
+    private render;
+}

package/dist/packages/tools/src/AxisGizmo/OneGizmoAxis.d.ts

@@ -0,0 +1,26 @@
+import { Vector3 } from 'three';
+import { AxisGizmoOptions } from './AxisGizmoOptions';
+/**
+ * This class is used internally in AxisGizmoTool
+ * @beta
+ */
+export declare class OneGizmoAxis {
+    readonly axis: number;
+    readonly isPrimary: boolean;
+    readonly direction: Vector3;
+    readonly upAxis: Vector3;
+    readonly bubblePosition: Vector3;
+    readonly label: string;
+    private readonly _lightColor;
+    private readonly _darkColor;
+    private constructor();
+    getLightColorInHex(): string;
+    getDarkColorInHex(): string;
+    getColorFraction(): number;
+    private createGeoLabel;
+    private createMathLabel;
+    private getMathAxisName;
+    private createUpAxis;
+    private createDirection;
+    static createAllAxes(options: AxisGizmoOptions): OneGizmoAxis[];
+}

package/dist/packages/tools/src/AxisView/AxisViewTool.d.ts

@@ -27,5 +27,4 @@ export declare class AxisViewTool extends Cognite3DViewerToolBase {
     private createCompassTexture;
     private getFaceTexture;
     private createBoxFace;
-    private moveCameraTo;
 }

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

@@ -2,6 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 import * as THREE from 'three';
+import { Corner } from '../utilities/Corner';
 /**
  * Configuration of {@link AxisViewTool}.
  */
@@ -84,15 +85,6 @@ export type AxisBoxCompassConfig = {
     fontColor?: THREE.Color;
     tickColor?: THREE.Color;
 };
-/**
- * A corner of the viewer.
- */
-export declare enum Corner {
-    TopRight = 0,
-    TopLeft = 1,
-    BottomLeft = 2,
-    BottomRight = 3
-}
 export declare const defaultAxisBoxCompassConfig: AxisBoxCompassConfig;
 export declare const defaultFaceConfig: AxisBoxFaceConfig;
 export declare const defaultAxisBoxConfig: Required<AxisBoxConfig>;

package/dist/packages/tools/src/utilities/Corner.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+/**
+ * A corner of the anything.
+ */
+export declare enum Corner {
+    TopRight = 0,
+    TopLeft = 1,
+    BottomLeft = 2,
+    BottomRight = 3
+}

package/dist/packages/tools/src/utilities/moveCameraTo.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CameraManager } from '../../../camera-manager';
+import { Vector3 } from 'three';
+export declare function moveCameraTo(cameraManager: CameraManager, targetAxis: Vector3, targetUpAxis: Vector3, duration: number): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.10.3",
+  "version": "4.10.5",
   "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.2",
+    "@microsoft/api-extractor": "7.41.0",
     "@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.17",
+    "@types/node": "18.19.21",
     "@types/random-seed": "0.3.5",
     "@types/skmeans": "0.11.7",
     "@types/stats": "0.16.30",
@@ -102,10 +102,10 @@
     "concurrently": "8.2.2",
     "cross-env": "7.0.3",
     "dat.gui": "0.7.9",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-jsdoc": "46.10.1",
+    "eslint-plugin-jsdoc": "48.2.0",
     "eslint-plugin-lodash": "7.4.0",
     "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-unused-imports": "3.1.0",
@@ -122,7 +122,7 @@
     "jest-puppeteer": "9.0.2",
     "jsdom": "23.2.0",
     "moq.ts": "10.0.8",
-    "nock": "13.5.3",
+    "nock": "13.5.4",
     "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.2",
+    "webpack": "5.90.3",
     "webpack-cli": "5.1.4",
     "webpack-dev-server": "4.15.1",
     "webpack-node-externals": "3.0.0",