@cognite/reveal 3.1.0 → 3.2.1

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

@@ -1,136 +1,150 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { ComboControls } from './ComboControls';
-import { CameraControlsOptions, CameraState, CameraChangeDelegate } from './types';
-import { CameraManager } from './CameraManager';
-/**
- * Default implementation of {@link CameraManager}. Uses target-based orbit controls combined with
- * keyboard and mouse navigation possibility. Supports automatic update of camera near and far
- * planes and animated change of camera position and target.
- */
-export declare class DefaultCameraManager implements CameraManager {
-    private readonly _events;
-    private readonly _controls;
-    private readonly _camera;
-    private readonly _domElement;
-    private readonly _inputHandler;
-    private readonly _raycaster;
-    private isDisposed;
-    private _nearAndFarNeedsUpdate;
-    private readonly _modelRaycastCallback;
-    private _onClick;
-    private _onWheel;
-    private static readonly DefaultAnimationDuration;
-    private static readonly DefaultMinAnimationDuration;
-    private static readonly DefaultMaxAnimationDuration;
-    private static readonly DefaultMinDistance;
-    private static readonly DefaultMinZoomDistance;
-    private static readonly DefaultMinimalTimeBetweenRaycasts;
-    private static readonly DefaultCameraControlsOptions;
-    private _cameraControlsOptions;
-    private readonly _currentBoundingBox;
-    /**
-     * When false, camera near and far planes will not be updated automatically (defaults to true).
-     * This can be useful when you have custom content in the 3D view and need to better
-     * control the view frustum.
-     *
-     * When automatic camera near/far planes are disabled, you are responsible for setting
-     * this on your own.
-     * @example
-     * ```
-     * viewer.camera.near = 0.1;
-     * viewer.camera.far = 1000.0;
-     * viewer.camera.updateProjectionMatrix();
-     * ```
-     */
-    automaticNearFarPlane: boolean;
-    /**
-     * When false, the sensitivity of the camera controls will not be updated automatically.
-     * This can be useful to better control the sensitivity of the 3D navigation.
-     *
-     * When not set, control the sensitivity of the camera using `viewer.cameraManager.cameraControls.minDistance`
-     * and `viewer.cameraManager.cameraControls.maxDistance`.
-     */
-    automaticControlsSensitivity: boolean;
-    on(event: 'cameraChange', callback: CameraChangeDelegate): void;
-    off(event: 'cameraChange', callback: CameraChangeDelegate): 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.
-     */
-    get cameraControls(): ComboControls;
-    /**
-     * Sets whether camera controls through mouse, touch and keyboard are enabled.
-     * This can be useful to e.g. temporarily disable navigation when manipulating other
-     * objects in the scene or when implementing a "cinematic" viewer.
-     */
-    set cameraControlsEnabled(enabled: boolean);
-    /**
-     * Gets whether camera controls through mouse, touch and keyboard are enabled.
-     */
-    get cameraControlsEnabled(): boolean;
-    /**
-     * Sets whether keyboard control of the camera is enabled/disabled.
-     */
-    set keyboardNavigationEnabled(enabled: boolean);
-    /**
-     * Whether keyboard control of the camera is enabled/disabled.
-     */
-    get keyboardNavigationEnabled(): boolean;
-    getCamera(): THREE.PerspectiveCamera;
-    /**
-     * Sets camera state. All parameters are optional. Rotation and target can't be set at the same time,
-     * if so, error will be thrown. Set rotation is preserved until next call of setCameraState with
-     * empty rotation field.
-     * @param state Camera state.
-     * **/
-    setCameraState(state: CameraState): void;
-    getCameraState(): Required<CameraState>;
-    /**
-     * Gets current camera controls options.
-     */
-    getCameraControlsOptions(): CameraControlsOptions;
-    /**
-     * Sets camera controls options to customize camera controls modes. See {@link CameraControlsOptions}.
-     * @param controlsOptions JSON object with camera controls options.
-     */
-    setCameraControlsOptions(controlsOptions: CameraControlsOptions): void;
-    update(deltaTime: number, boundingBox: THREE.Box3): void;
-    dispose(): void;
-    private moveCameraTo;
-    private moveCameraTargetTo;
-    private updateCameraNearAndFar;
-    private calculateAnimationStartTarget;
-    private createTweenAnimation;
-    /**
-     * Calculates new target when raycaster doesn't have any intersections with the model.
-     * @param cursorPosition Cursor position for desired calculations.
-     * @param cursorPosition.x
-     * @param cursorPosition.y
-     */
-    private calculateNewTargetWithoutModel;
-    /**
-     * Calculates new camera target based on cursor position.
-     * @param event MouseEvent that contains pointer location data.
-     */
-    private calculateNewTarget;
-    /**
-     * Removes controls event listeners if they are defined.
-     */
-    private teardownControls;
-    private handleMouseWheelActionChange;
-    /**
-     * 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 calculateDefaultDuration;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { ComboControls } from './ComboControls';
+import { CameraControlsOptions, CameraState, CameraChangeDelegate } from './types';
+import { CameraManager } from './CameraManager';
+/**
+ * Default implementation of {@link CameraManager}. Uses target-based orbit controls combined with
+ * keyboard and mouse navigation possibility. Supports automatic update of camera near and far
+ * planes and animated change of camera position and target.
+ */
+export declare class DefaultCameraManager implements CameraManager {
+    private readonly _events;
+    private readonly _controls;
+    private readonly _camera;
+    private readonly _domElement;
+    private readonly _inputHandler;
+    private readonly _raycaster;
+    private isDisposed;
+    private _nearAndFarNeedsUpdate;
+    private _enabledCopy;
+    private readonly _modelRaycastCallback;
+    private _onClick;
+    private _onWheel;
+    private static readonly AnimationDuration;
+    private static readonly MinAnimationDuration;
+    private static readonly MaxAnimationDuration;
+    private static readonly MinDistance;
+    private static readonly MinZoomDistance;
+    private static readonly MinimalTimeBetweenRaycasts;
+    private static readonly MaximumTimeBetweenRaycasts;
+    private static readonly MouseDistanceThresholdBetweenRaycasts;
+    private static readonly DefaultCameraControlsOptions;
+    private _cameraControlsOptions;
+    private readonly _currentBoundingBox;
+    /**
+     * When false, camera near and far planes will not be updated automatically (defaults to true).
+     * This can be useful when you have custom content in the 3D view and need to better
+     * control the view frustum.
+     *
+     * When automatic camera near/far planes are disabled, you are responsible for setting
+     * this on your own.
+     * @example
+     * ```
+     * viewer.camera.near = 0.1;
+     * viewer.camera.far = 1000.0;
+     * viewer.camera.updateProjectionMatrix();
+     * ```
+     */
+    automaticNearFarPlane: boolean;
+    /**
+     * When false, the sensitivity of the camera controls will not be updated automatically.
+     * This can be useful to better control the sensitivity of the 3D navigation.
+     *
+     * When not set, control the sensitivity of the camera using `viewer.cameraManager.cameraControls.minDistance`
+     * and `viewer.cameraManager.cameraControls.maxDistance`.
+     */
+    automaticControlsSensitivity: boolean;
+    on(event: 'cameraChange', callback: CameraChangeDelegate): void;
+    off(event: 'cameraChange', callback: CameraChangeDelegate): 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.
+     */
+    set enabled(enabled: boolean);
+    /**
+     * Gets whether camera controls through mouse, touch and keyboard are enabled.
+     */
+    get enabled(): boolean;
+    /**
+     * Sets whether camera controls through mouse, touch and keyboard are enabled.
+     * This can be useful to e.g. temporarily disable navigation when manipulating other
+     * objects in the scene or when implementing a "cinematic" viewer.
+     * @deprecated Will be removed in 4.0.0. Use {@link DefaultCameraManager.enabled} instead.
+     */
+    set cameraControlsEnabled(enabled: boolean);
+    /**
+     * Gets whether camera controls through mouse, touch and keyboard are enabled.
+     * @deprecated Will be removed in 4.0.0. Use {@link DefaultCameraManager.enabled} instead.
+     */
+    get cameraControlsEnabled(): boolean;
+    /**
+     * Sets whether keyboard control of the camera is enabled/disabled.
+     */
+    set keyboardNavigationEnabled(enabled: boolean);
+    /**
+     * Whether keyboard control of the camera is enabled/disabled.
+     */
+    get keyboardNavigationEnabled(): boolean;
+    getCamera(): THREE.PerspectiveCamera;
+    /**
+     * Sets camera state. All parameters are optional. Rotation and target can't be set at the same time,
+     * if so, error will be thrown. Set rotation is preserved until next call of setCameraState with
+     * empty rotation field.
+     * @param state Camera state.
+     * **/
+    setCameraState(state: CameraState): void;
+    getCameraState(): Required<CameraState>;
+    /**
+     * Gets current camera controls options.
+     */
+    getCameraControlsOptions(): CameraControlsOptions;
+    /**
+     * Sets camera controls options to customize camera controls modes. See {@link CameraControlsOptions}.
+     * @param controlsOptions JSON object with camera controls options.
+     */
+    setCameraControlsOptions(controlsOptions: CameraControlsOptions): void;
+    update(deltaTime: number, boundingBox: THREE.Box3): void;
+    dispose(): void;
+    private moveCameraTo;
+    private moveCameraTargetTo;
+    private updateCameraNearAndFar;
+    private calculateAnimationStartTarget;
+    private createTweenAnimation;
+    /**
+     * Calculates new target when raycaster doesn't have any intersections with the model.
+     * @param cursorPosition Cursor position for desired calculations.
+     * @param cursorPosition.x
+     * @param cursorPosition.y
+     */
+    private calculateNewTargetWithoutModel;
+    /**
+     * Calculates new camera target based on cursor position.
+     * @param event MouseEvent that contains pointer location data.
+     */
+    private calculateNewTarget;
+    /**
+     * Removes controls event listeners if they are defined.
+     */
+    private teardownControls;
+    private handleMouseWheelActionChange;
+    /**
+     * 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 calculateDefaultDuration;
+}

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

@@ -1,17 +1,19 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export default class Keyboard {
-    private keys;
-    private _disabled;
-    get disabled(): boolean;
-    set disabled(isDisabled: boolean);
-    constructor();
-    isPressed(key: string): boolean;
-    comsumePressed(key: string): boolean;
-    private readonly addEventListeners;
-    private readonly removeEventListeners;
-    private readonly onKeydown;
-    private readonly onKeyup;
-    private readonly clearPressedKeys;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export default class Keyboard {
+    private keys;
+    private _disabled;
+    private readonly _domElement;
+    get disabled(): boolean;
+    set disabled(isDisabled: boolean);
+    constructor(domElement: HTMLElement);
+    isPressed(key: string): boolean;
+    comsumePressed(key: string): boolean;
+    dispose(): void;
+    private readonly addEventListeners;
+    private readonly removeEventListeners;
+    private readonly onKeydown;
+    private readonly onKeyup;
+    private readonly clearPressedKeys;
+}

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

@@ -1,66 +1,66 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare type CameraControlsOptions = {
-    /**
-     * Sets mouse wheel initiated action.
-     *
-     * Modes:
-     *
-     * 'zoomToTarget' - zooms just to the current target (center of the screen) of the camera.
-     *
-     * 'zoomPastCursor' - zooms in the direction of the ray coming from camera through cursor screen position, allows going through objects.
-     *
-     * 'zoomToCursor' - mouse wheel scroll zooms towards the point on the model where cursor is hovering over, doesn't allow going through objects.
-     *
-     * Default is 'zoomPastCursor'.
-     *
-     */
-    mouseWheelAction?: 'zoomToTarget' | 'zoomPastCursor' | 'zoomToCursor';
-    /**
-     * Enables or disables change of camera target on mouse click. New target is then set to the point of the model under current cursor position.
-     *
-     * Default is false.
-     *
-     */
-    changeCameraTargetOnClick?: boolean;
-};
-export declare type ControlsState = {
-    position: THREE.Vector3;
-    target: THREE.Vector3;
-};
-export declare type CameraState = {
-    /**
-     * Camera position in world space.
-     */
-    position?: THREE.Vector3;
-    /**
-     * Camera target in world space.
-     * **/
-    target?: THREE.Vector3;
-    /**
-     * Camera local rotation in quaternion form.
-     */
-    rotation?: THREE.Quaternion;
-};
-/**
- * Delegate for camera update events.
- * @module @cognite/reveal
- */
-export declare type CameraChangeDelegate = (position: THREE.Vector3, target: THREE.Vector3) => void;
-export declare type CameraManagerCallbackData = {
-    intersection: {
-        /**
-         * Coordinate of the intersection.
-         */
-        point: THREE.Vector3;
-        /**
-         * Distance from the camera to the intersection.
-         */
-        distanceToCamera: number;
-    } | null;
-    /**
-     * Bounding box for all models on the scene
-     */
-    modelsBoundingBox: THREE.Box3;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare type CameraControlsOptions = {
+    /**
+     * Sets mouse wheel initiated action.
+     *
+     * Modes:
+     *
+     * 'zoomToTarget' - zooms just to the current target (center of the screen) of the camera.
+     *
+     * 'zoomPastCursor' - zooms in the direction of the ray coming from camera through cursor screen position, allows going through objects.
+     *
+     * 'zoomToCursor' - mouse wheel scroll zooms towards the point on the model where cursor is hovering over, doesn't allow going through objects.
+     *
+     * Default is 'zoomPastCursor'.
+     *
+     */
+    mouseWheelAction?: 'zoomToTarget' | 'zoomPastCursor' | 'zoomToCursor';
+    /**
+     * Enables or disables change of camera target on mouse click. New target is then set to the point of the model under current cursor position.
+     *
+     * Default is false.
+     *
+     */
+    changeCameraTargetOnClick?: boolean;
+};
+export declare type ControlsState = {
+    position: THREE.Vector3;
+    target: THREE.Vector3;
+};
+export declare type CameraState = {
+    /**
+     * Camera position in world space.
+     */
+    position?: THREE.Vector3;
+    /**
+     * Camera target in world space.
+     * **/
+    target?: THREE.Vector3;
+    /**
+     * Camera local rotation in quaternion form.
+     */
+    rotation?: THREE.Quaternion;
+};
+/**
+ * Delegate for camera update events.
+ * @module @cognite/reveal
+ */
+export declare type CameraChangeDelegate = (position: THREE.Vector3, target: THREE.Vector3) => void;
+export declare type CameraManagerCallbackData = {
+    intersection: {
+        /**
+         * Coordinate of the intersection.
+         */
+        point: THREE.Vector3;
+        /**
+         * Distance from the camera to the intersection.
+         */
+        distanceToCamera: number;
+    } | null;
+    /**
+     * Bounding box for all models on the scene
+     */
+    modelsBoundingBox: THREE.Box3;
+};

package/packages/data-source/index.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { DataSource } from './src/DataSource';
-export { CdfDataSource } from './src/CdfDataSource';
-export { LocalDataSource } from './src/LocalDataSource';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { DataSource } from './src/DataSource';
+export { CdfDataSource } from './src/CdfDataSource';
+export { LocalDataSource } from './src/LocalDataSource';

package/packages/data-source/src/CdfDataSource.d.ts

@@ -1,19 +1,19 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CogniteClient } from '@cognite/sdk';
-import { DataSource } from './DataSource';
-import { NodesApiClient } from '../../nodes-api';
-import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
-/**
- * Data source for Cognite Data Fusion.
- */
-export declare class CdfDataSource implements DataSource {
-    private readonly _metadataProvider;
-    private readonly _nodesApiClient;
-    private readonly _modelDataClient;
-    constructor(sdkClient: CogniteClient);
-    getNodesApiClient(): NodesApiClient;
-    getModelDataProvider(): ModelDataProvider;
-    getModelMetadataProvider(): ModelMetadataProvider;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CogniteClient } from '@cognite/sdk';
+import { DataSource } from './DataSource';
+import { NodesApiClient } from '../../nodes-api';
+import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
+/**
+ * Data source for Cognite Data Fusion.
+ */
+export declare class CdfDataSource implements DataSource {
+    private readonly _metadataProvider;
+    private readonly _nodesApiClient;
+    private readonly _modelDataClient;
+    constructor(sdkClient: CogniteClient);
+    getNodesApiClient(): NodesApiClient;
+    getModelDataProvider(): ModelDataProvider;
+    getModelMetadataProvider(): ModelMetadataProvider;
+}

package/packages/data-source/src/DataSource.d.ts

@@ -1,25 +1,25 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodesApiClient } from '../../nodes-api';
-import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
-/**
- * Describes how Reveal data is stored, and provides means to create custom storage providers
- * that Reveal will fetch data from.
- */
-export interface DataSource {
-    /**
-     * Gets a node API client that is able to fetch data about
-     * models.
-     */
-    getNodesApiClient(): NodesApiClient;
-    /**
-     * Gets a metadata provider for models.
-     */
-    getModelMetadataProvider(): ModelMetadataProvider;
-    /**
-     * Gets a client that is able to download geometry and other files
-     * for models.
-     */
-    getModelDataProvider(): ModelDataProvider;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodesApiClient } from '../../nodes-api';
+import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
+/**
+ * Describes how Reveal data is stored, and provides means to create custom storage providers
+ * that Reveal will fetch data from.
+ */
+export interface DataSource {
+    /**
+     * Gets a node API client that is able to fetch data about
+     * models.
+     */
+    getNodesApiClient(): NodesApiClient;
+    /**
+     * Gets a metadata provider for models.
+     */
+    getModelMetadataProvider(): ModelMetadataProvider;
+    /**
+     * Gets a client that is able to download geometry and other files
+     * for models.
+     */
+    getModelDataProvider(): ModelDataProvider;
+}

package/packages/data-source/src/LocalDataSource.d.ts

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodesApiClient } from '../../nodes-api';
-import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
-import { DataSource } from './DataSource';
-/**
- * Data source for loading models from local storage (i.e. by URL).
- * This implementation is meant for use in development.
- */
-export declare class LocalDataSource implements DataSource {
-    getNodesApiClient(): NodesApiClient;
-    getModelDataProvider(): ModelDataProvider;
-    getModelMetadataProvider(): ModelMetadataProvider;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodesApiClient } from '../../nodes-api';
+import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
+import { DataSource } from './DataSource';
+/**
+ * Data source for loading models from local storage (i.e. by URL).
+ * This implementation is meant for use in development.
+ */
+export declare class LocalDataSource implements DataSource {
+    getNodesApiClient(): NodesApiClient;
+    getModelDataProvider(): ModelDataProvider;
+    getModelMetadataProvider(): ModelMetadataProvider;
+}

package/packages/logger/index.d.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import log from './src/Log';
-export default log;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import log from './src/Log';
+export default log;

package/packages/logger/src/Log.d.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as log from 'loglevel';
-export default log;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as log from 'loglevel';
+export default log;

package/packages/metrics/index.d.ts

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { MetricsLogger } from './src/MetricsLogger';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { MetricsLogger } from './src/MetricsLogger';