@cognite/reveal 4.0.0-dev.20221128 → 4.0.0-dev.20221129

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

@@ -11,6 +11,7 @@ export declare class Image360VisualizationBox implements Image360Visualization {
     private _faceMaterials;
     private readonly _sceneHandler;
     private readonly _visualizationState;
+    get opacity(): number;
     set opacity(alpha: number);
     set visible(isVisible: boolean);
     set scale(newScale: THREE.Vector3);

package/dist/packages/api/src/public/RevealManager.d.ts

@@ -8,6 +8,7 @@ import { PointCloudManager, PointCloudNode } from '../../../pointclouds';
 import { CadManager, CadModelBudget } from '../../../cad-geometry-loaders';
 import { NodeAppearanceProvider } from '../../../cad-styling';
 import { RenderMode, RenderPipelineExecutor, CadMaterialManager, RenderPipelineProvider } from '../../../rendering';
+import { CameraManager } from '../../../camera-manager';
 import { ModelIdentifier } from '../../../data-providers';
 export type AddCadModelOptions = {
     nodeAppearanceProvider?: NodeAppearanceProvider;
@@ -18,12 +19,15 @@ export declare class RevealManager {
     private readonly _pointCloudManager;
     private readonly _pipelineExecutor;
     private readonly _renderPipeline;
-    private readonly _lastCamera;
+    private _cameraInMotion;
     private _isDisposed;
     private readonly _subscriptions;
     private readonly _events;
     private readonly _updateSubject;
-    constructor(cadManager: CadManager, pointCloudManager: PointCloudManager, pipelineExecutor: RenderPipelineExecutor, renderPipeline: RenderPipelineProvider);
+    private readonly _cameraManager;
+    private readonly _onCameraChange;
+    private readonly _onCameraStop;
+    constructor(cadManager: CadManager, pointCloudManager: PointCloudManager, pipelineExecutor: RenderPipelineExecutor, renderPipeline: RenderPipelineProvider, cameraManager: CameraManager);
     dispose(): void;
     requestRedraw(): void;
     resetRedraw(): void;

package/dist/packages/api/src/public/createRevealManager.d.ts

@@ -6,19 +6,22 @@ import { RevealOptions } from './types';
 import { RevealManager } from './RevealManager';
 import { CogniteClient } from '@cognite/sdk';
 import { SceneHandler } from '../../../utilities';
+import { CameraManager } from '../../../camera-manager';
 /**
  * Used to create an instance of reveal manager that works with localhost.
  * @param renderer
  * @param sceneHandler
+ * @param cameraManager
  * @param revealOptions
  * @returns RevealManager instance.
  */
-export declare function createLocalRevealManager(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions?: RevealOptions): RevealManager;
+export declare function createLocalRevealManager(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, cameraManager: CameraManager, revealOptions?: RevealOptions): RevealManager;
 /**
  * Used to create an instance of reveal manager that works with the CDF.
  * @param client
  * @param renderer
  * @param sceneHandler
+ * @param cameraManager
  * @param revealOptions
  */
-export declare function createCdfRevealManager(client: CogniteClient, renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions?: RevealOptions): RevealManager;
+export declare function createCdfRevealManager(client: CogniteClient, renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, cameraManager: CameraManager, revealOptions?: RevealOptions): RevealManager;

package/dist/packages/api/src/storage/RevealManagerHelper.d.ts

@@ -10,6 +10,7 @@ import { SceneHandler } from '../../../utilities';
 import { CadNode } from '../../../cad-model';
 import { CogniteClient } from '@cognite/sdk';
 import { PointCloudNode } from '../../../pointclouds';
+import { CameraManager } from '../../../camera-manager';
 /**
  * Helper for {@link RevealManager} for creating a uniform interface for
  * working with instances that fetch models from CDF or instances that fetch
@@ -26,18 +27,20 @@ export declare class RevealManagerHelper {
      * meant for use in debugging and development.
      * @param renderer
      * @param sceneHandler
+     * @param cameraManager
      * @param revealOptions
      */
-    static createLocalHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions: RevealOptions): RevealManagerHelper;
+    static createLocalHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, cameraManager: CameraManager, revealOptions: RevealOptions): RevealManagerHelper;
     /**
      * Creates a helper for RevealManager that loads models from CDF.
      * @param renderer
      * @param sceneHandler
+     * @param cameraManager
      * @param revealOptions
      * @param sdkClient
      */
-    static createCdfHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions: RevealOptions, sdkClient: CogniteClient): RevealManagerHelper;
-    static createCustomDataSourceHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions: RevealOptions, dataSource: DataSource): RevealManagerHelper;
+    static createCdfHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, cameraManager: CameraManager, revealOptions: RevealOptions, sdkClient: CogniteClient): RevealManagerHelper;
+    static createCustomDataSourceHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, cameraManager: CameraManager, revealOptions: RevealOptions, dataSource: DataSource): RevealManagerHelper;
     get revealManager(): RevealManager;
     /**
      * Adds a local CAD model.

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

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

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

@@ -2,7 +2,7 @@
  * Copyright 2022 Cognite AS
  */
 import * as THREE from 'three';
-import { CameraState, CameraChangeDelegate } from './types';
+import { CameraState, CameraChangeDelegate, CameraStopDelegate, CameraManagerEventType, CameraEventDelegate } from './types';
 /**
  * Interface for manager responsible for all manipulations to the camera,
  * including animations and modification of state. Implementations are responsible for
@@ -56,20 +56,26 @@ export interface CameraManager {
      */
     deactivate(): void;
     /**
-     * Subscribes to changes of the camera event. This is used by Reveal to react on changes of the camera.
-     * @param event Name of the event.
+     * Subscribes to events on this camera manager. There are several event types:
+     * 'cameraChange' - Subscribes to changes of the camera. This is used by Reveal to react on changes of the camera.
+     * 'cameraStop' - Subscribes to events indicating the camera has stopped
+     * @param event The event type.
      * @param callback Callback to be called when the event is fired.
      */
     on(event: 'cameraChange', callback: CameraChangeDelegate): void;
+    on(event: 'cameraStop', callback: CameraStopDelegate): void;
+    on(event: CameraManagerEventType, callback: CameraEventDelegate): void;
     /**
      * Unsubscribes from changes of the camera event.
-     * @param event Name of the event.
+     * @param event The event type.
      * @param callback Callback function to be unsubscribed.
      */
     off(event: 'cameraChange', callback: CameraChangeDelegate): void;
+    off(event: 'cameraStop', callback: CameraStopDelegate): void;
+    off(event: CameraManagerEventType, callback: CameraEventDelegate): void;
     /**
      * Moves camera to a place where the content of a bounding box is visible to the camera.
-     * @param box The bounding box in world space.
+     * @param boundingBox The bounding box in world space.
      * @param duration The duration of the animation moving the camera.
      * @param radiusFactor The ratio of the distance from camera to center of box and radius of the box.
      */

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

@@ -1,22 +1,42 @@
 /*!
  * Copyright 2021 Cognite AS
  */
-import { EventDispatcher, Vector3, PerspectiveCamera, OrthographicCamera, Quaternion } from 'three';
-export declare class ComboControls extends EventDispatcher {
-    enabled: boolean;
+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;
@@ -24,11 +44,13 @@ export declare class ComboControls extends EventDispatcher {
     mouseFirstPersonRotationSpeed: number;
     keyboardDollySpeed: number;
     keyboardPanSpeed: number;
+    /**
+     * How much quicker keyboard navigation will be with 'shift' pressed
+     */
     keyboardSpeedFactor: number;
     pinchEpsilon: number;
     pinchPanSpeed: number;
     EPSILON: number;
-    dispose: () => void;
     minZoom: number;
     maxZoom: number;
     orthographicCameraDollyFactor: number;
@@ -39,6 +61,9 @@ export declare class ComboControls extends EventDispatcher {
     maxDeltaRatio: number;
     minDeltaDownscaleCoefficient: number;
     maxDeltaDownscaleCoefficient: number;
+};
+export declare class ComboControls extends EventDispatcher {
+    dispose: () => void;
     private _temporarilyDisableDamping;
     private readonly _camera;
     private _firstPersonMode;
@@ -60,6 +85,27 @@ export declare class ComboControls extends EventDispatcher {
     private readonly _raycaster;
     private readonly _targetFPS;
     private _targetFPSOverActualFPS;
+    private _enabled;
+    private _options;
+    private static readonly DefaultControlsOptions;
+    /**
+     * Gets current Combo Controls options.
+     */
+    get options(): Readonly<ComboControlsOptions>;
+    /**
+     * Sets Combo Controls options.
+     *
+     * Only the provided options will be changed, any undefined options will be kept as is.
+     */
+    set options(options: Partial<ComboControlsOptions>);
+    /**
+     * Returns true if these controls are enabled.
+     */
+    get enabled(): boolean;
+    /**
+     * Sets the enabled state of these controls.
+     */
+    set enabled(enabled: boolean);
     constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement);
     update: (deltaTime: number, forceUpdate?: boolean) => boolean;
     getState: () => {

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

@@ -2,8 +2,8 @@
  * Copyright 2021 Cognite AS
  */
 import * as THREE from 'three';
-import { ComboControls } from './ComboControls';
-import { CameraControlsOptions, CameraState, CameraChangeDelegate } from './types';
+import { ComboControlsOptions } from './ComboControls';
+import { CameraControlsOptions, CameraState, CameraManagerEventType, CameraEventDelegate } from './types';
 import { CameraManager } from './CameraManager';
 /**
  * Default implementation of {@link CameraManager}. Uses target-based orbit controls combined with
@@ -12,6 +12,7 @@ import { CameraManager } from './CameraManager';
  */
 export declare class DefaultCameraManager implements CameraManager {
     private readonly _events;
+    private readonly _stopEventTrigger;
     private readonly _controls;
     private readonly _camera;
     private readonly _domElement;
@@ -57,15 +58,9 @@ export declare class DefaultCameraManager implements CameraManager {
      * and `viewer.cameraManager.cameraControls.maxDistance`.
      */
     automaticControlsSensitivity: boolean;
-    on(event: 'cameraChange', callback: CameraChangeDelegate): void;
-    off(event: 'cameraChange', callback: CameraChangeDelegate): void;
+    on(event: CameraManagerEventType, callback: CameraEventDelegate): void;
+    off(event: CameraManagerEventType, callback: CameraEventDelegate): void;
     fitCameraToBoundingBox(box: THREE.Box3, duration?: number, radiusFactor?: number): void;
-    /**
-     * Gets instance of camera controls that are used by camera manager. See {@link ComboControls} for more
-     * information on all adjustable properties.
-     * @deprecated Will be removed in 4.0.0.
-     */
-    get cameraControls(): ComboControls;
     /**
      * Sets whether camera controls through mouse, touch and keyboard are enabled.
      */
@@ -74,6 +69,15 @@ export declare class DefaultCameraManager implements CameraManager {
      * Gets whether camera controls through mouse, touch and keyboard are enabled.
      */
     get enabled(): boolean;
+    /**
+     * Gets current Combo Controls options.
+     */
+    getComboControlsOptions(): Readonly<ComboControlsOptions>;
+    /**
+     * Sets Combo Controls options.
+     * Only provided options will be changed, any undefined options will be kept as is.
+     */
+    setComboControlsOptions(options: Partial<ComboControlsOptions>): void;
     /**
      * Sets whether keyboard control of the camera is enabled/disabled.
      */

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

@@ -3,11 +3,11 @@
  */
 import * as THREE from 'three';
 import { CameraManager } from './CameraManager';
-import { CameraChangeDelegate, CameraState } from './types';
+import { CameraChangeDelegate, CameraState, CameraStopDelegate } from './types';
 export declare class ProxyCameraManager implements CameraManager {
-    private readonly _cameraChangedListeners;
+    private readonly _cameraEventListeners;
+    private readonly _activeCameraEventHandlers;
     private _activeCameraManager;
-    private readonly _activeCameraEventHandler;
     get enabled(): boolean;
     get innerCameraManager(): CameraManager;
     constructor(initialActiveCamera: CameraManager);
@@ -17,10 +17,13 @@ export declare class ProxyCameraManager implements CameraManager {
     getCameraState(): Required<CameraState>;
     activate(cameraManager?: CameraManager): void;
     deactivate(): void;
-    on(_: 'cameraChange', callback: CameraChangeDelegate): void;
-    off(_: 'cameraChange', callback: CameraChangeDelegate): void;
+    on(eventType: 'cameraChange', callback: CameraChangeDelegate): void;
+    on(eventType: 'cameraStop', callback: CameraStopDelegate): void;
+    off(eventType: 'cameraChange', callback: CameraChangeDelegate): void;
+    off(eventType: 'cameraStop', callback: CameraStopDelegate): void;
     fitCameraToBoundingBox(boundingBox: THREE.Box3, duration?: number | undefined, radiusFactor?: number | undefined): void;
     update(deltaTime: number, boundingBox: THREE.Box3): void;
     dispose(): void;
-    private onActiveCameraManagerEventFired;
+    private onActiveCameraManagerChangeFired;
+    private onActiveCameraManagerStopFired;
 }

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

@@ -3,11 +3,13 @@
  */
 import * as THREE from 'three';
 import { CameraManager } from './CameraManager';
-import { CameraChangeDelegate, CameraState } from './types';
+import { CameraChangeDelegate, CameraEventDelegate, CameraManagerEventType, CameraState } from './types';
 export declare class StationaryCameraManager implements CameraManager {
     private readonly _camera;
-    private readonly _cameraChangedListener;
+    private readonly _cameraChangedListeners;
     private readonly _domElement;
+    private _defaultFOV;
+    private readonly _stopEventTrigger;
     private _isEnabled;
     private _isDragging;
     constructor(domElement: HTMLElement, camera: THREE.PerspectiveCamera);
@@ -15,10 +17,10 @@ export declare class StationaryCameraManager implements CameraManager {
     getCamera(): THREE.PerspectiveCamera;
     setCameraState(state: CameraState): void;
     getCameraState(): Required<CameraState>;
-    activate(): void;
+    activate(cameraManager: CameraManager): void;
     deactivate(): void;
-    on(_: 'cameraChange', callback: CameraChangeDelegate): void;
-    off(_: 'cameraChange', callback: CameraChangeDelegate): void;
+    on(eventType: CameraManagerEventType, callback: CameraEventDelegate): void;
+    off(eventType: CameraManagerEventType, callback: CameraChangeDelegate): void;
     fitCameraToBoundingBox(boundingBox: THREE.Box3, _?: number, radiusFactor?: number): void;
     moveTo(targetPosition: THREE.Vector3, duration?: number): Promise<void>;
     update(_: number, boundingBox: THREE.Box3): void;
@@ -26,4 +28,5 @@ export declare class StationaryCameraManager implements CameraManager {
     private readonly enableDragging;
     private readonly disableDragging;
     private readonly rotateCamera;
+    private readonly zoomCamera;
 }

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

@@ -48,6 +48,15 @@ export type CameraState = {
  * @module @cognite/reveal
  */
 export type CameraChangeDelegate = (position: THREE.Vector3, target: THREE.Vector3) => void;
+/**
+ * Delegate for camera update events.
+ * @module @cognite/reveal
+ */
+export type CameraStopDelegate = () => void;
+/**
+ * Union type of all camera event delegates
+ */
+export type CameraEventDelegate = CameraChangeDelegate | CameraStopDelegate;
 export type CameraManagerCallbackData = {
     intersection: {
         /**
@@ -64,3 +73,11 @@ export type CameraManagerCallbackData = {
      */
     modelsBoundingBox: THREE.Box3;
 };
+/**
+ * List of supported event types (adapted from https://stackoverflow.com/questions/44480644/string-union-to-string-array)
+ */
+export declare const CAMERA_MANAGER_EVENT_TYPE_LIST: readonly ["cameraChange", "cameraStop"];
+/**
+ * Union type of the supported camera manager event types
+ */
+export type CameraManagerEventType = typeof CAMERA_MANAGER_EVENT_TYPE_LIST[number];

package/dist/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { CameraManager } from '../CameraManager';
+import { CameraStopDelegate } from '../types';
+import { EventTrigger } from '../../../utilities';
+export declare class DebouncedCameraStopEventTrigger extends EventTrigger<CameraStopDelegate> {
+    private readonly _debouncedFireEvent;
+    private readonly _cameraManager;
+    constructor(cameraManager: CameraManager, debounceTimeMs?: number);
+    dispose(): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.0.0-dev.20221128",
+  "version": "4.0.0-dev.20221129",
   "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": {
@@ -94,7 +94,7 @@
     "@types/jest-environment-puppeteer": "5.0.3",
     "@types/jest-image-snapshot": "5.1.0",
     "@types/jsdom": "20.0.1",
-    "@types/lodash": "4.14.189",
+    "@types/lodash": "4.14.190",
     "@types/mixpanel-browser": "2.38.0",
     "@types/node": "18.11.3",
     "@types/proj4": "2.5.2",
@@ -104,7 +104,7 @@
     "@types/tween.js": "18.5.1",
     "@typescript-eslint/eslint-plugin": "5.43.0",
     "@typescript-eslint/parser": "5.43.0",
-    "concurrently": "7.5.0",
+    "concurrently": "7.6.0",
     "cross-env": "7.0.3",
     "cross-var": "1.1.0",
     "dat.gui": "0.7.9",