@cognite/reveal 2.2.1 → 2.2.2

package/core/src/public/migration/Cognite3DViewer.d.ts

@@ -2,7 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 import * as THREE from 'three';
-import { AddModelOptions, Cognite3DViewerOptions, Intersection, CameraChangeDelegate, PointerEventDelegate, CadModelBudget, PointCloudBudget } from './types';
+import { AddModelOptions, Cognite3DViewerOptions, Intersection, CameraChangeDelegate, PointerEventDelegate, CadModelBudget, PointCloudBudget, CameraControlsOptions } from './types';
 import { CogniteModelBase } from './CogniteModelBase';
 import { Cognite3DModel } from './Cognite3DModel';
 import { CognitePointCloudModel } from './CognitePointCloudModel';
@@ -49,11 +49,19 @@ export declare class Cognite3DViewer {
     private readonly _domElement;
     private readonly _renderer;
     private readonly _boundAnimate;
+    private _onClick;
+    private _onWheel;
     private readonly _events;
+    private _cameraControlsOptions;
     private readonly _models;
     private readonly _extraObjects;
     private readonly _automaticNearFarPlane;
     private readonly _automaticControlsSensitivity;
+    private readonly _animationDuration;
+    private readonly _minDefaultAnimationDuration;
+    private readonly _maxDefaultAnimationDuration;
+    private readonly _minDistanceDefault;
+    private readonly raycaster;
     private isDisposed;
     private readonly renderController;
     private latestRequestId;
@@ -65,6 +73,37 @@ export declare class Cognite3DViewer {
      * Reusable buffers used by functions in Cognite3dViewer to avoid allocations.
      */
     private readonly _updateNearAndFarPlaneBuffers;
+    /**
+     * Convert pixel coordinates of the cursor to [-1,1]^2 coordinates.
+     * @param pixelX
+     * @param pixelY
+     */
+    private convertPixelCoordinatesToNormalized;
+    /**
+     * 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 calculateMissedRaycast;
+    /**
+     * Removes controls event listeners if they are defined.
+     */
+    private teardownControls;
+    /**
+     * Method for setting up camera controls listeners and values inside current controls class.
+     */
+    private setupControls;
+    /**
+     * Changes controls target based on current cursor position.
+     * @param event MouseEvent that contains pointer location data.
+     */
+    private changeTarget;
+    /**
+     * Changes controls scroll target based on current cursor position.
+     * @param event MouseEvent that contains pointer location data.
+     */
+    private changeScrollTarget;
     /**
      * 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.
@@ -147,6 +186,15 @@ export declare class Cognite3DViewer {
     off(event: 'cameraChange', callback: CameraChangeDelegate): void;
     off(event: 'sceneRendered', callback: SceneRenderedDelegate): void;
     off(event: 'disposed', callback: DisposedDelegate): void;
+    /**
+     * Sets camera controls mode anything allowed in CameraControlsOptions type.
+     * @param controlsOptions JSON object with camera controls options.
+     */
+    setCameraControlsOptions(controlsOptions: CameraControlsOptions): void;
+    /**
+     * Gets camera controls mode.
+     */
+    getCameraControlsOptions(): CameraControlsOptions;
     /**
      * Gets the current viewer state which includes the camera pose as well as applied styling.
      * @returns JSON object containing viewer state.
@@ -358,6 +406,7 @@ export declare class Cognite3DViewer {
      * Set camera's target.
      * @public
      * @param target Target in world space.
+     * @param animated Whether change of target should be animated or not (default is false).
      * @example
      * ```js
      * // store position, target
@@ -368,7 +417,7 @@ export declare class Cognite3DViewer {
      * viewer.setCameraTarget(target);
      * ```
      */
-    setCameraTarget(target: THREE.Vector3): void;
+    setCameraTarget(target: THREE.Vector3, animated?: boolean): void;
     /**
      * Gets the camera controller. See https://www.npmjs.com/package/@cognite/three-combo-controls
      * for documentation. Note that by default the `minDistance` setting of the controls will
@@ -539,6 +588,13 @@ export declare class Cognite3DViewer {
      */
     getIntersectionFromPixel(offsetX: number, offsetY: number, options?: IntersectionFromPixelOptions): Promise<null | Intersection>;
     private getModels;
+    /**
+     * Calculates default duration for camera animation based on distance from the camera to the object.
+     * @param distanceToCamera
+     */
+    private calculateDefaultDuration;
+    /** @private */
+    private moveCameraTargetTo;
     /** @private */
     private moveCameraTo;
     /**

package/core/src/public/migration/types.d.ts

@@ -134,6 +134,30 @@ export interface AddModelOptions {
     localPath?: string;
     geometryFilter?: GeometryFilter;
 }
+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.
+     *
+     */
+    onClickTargetChange?: boolean;
+};
 export declare type CadIntersection = {
     /**
      * The intersection type.