@cognite/reveal 2.2.2 → 2.3.0

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

@@ -1,33 +1,33 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodeAppearance } from './NodeAppearance';
-import { NodeCollectionBase } from './NodeCollectionBase';
-import { IndexSet } from '../../utilities';
-/**
- * Delegate for applying styles in {@see NodeStyleProvider}.
- * @param treeIndices Set of tree indices that the style is applied to.
- * @param appearance  Style to be applied to the nodes.
- */
-export declare type ApplyStyleDelegate = (treeIndices: IndexSet, appearance: NodeAppearance) => void;
-export declare class NodeAppearanceProvider {
-    private readonly _styledCollections;
-    private _lastFiredLoadingState?;
-    private readonly _events;
-    on(event: 'changed', listener: () => void): void;
-    on(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
-    off(event: 'changed', listener: () => void): void;
-    off(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
-    assignStyledNodeCollection(nodeCollection: NodeCollectionBase, appearance: NodeAppearance): void;
-    unassignStyledNodeCollection(nodeCollection: NodeCollectionBase): void;
-    applyStyles(applyCb: ApplyStyleDelegate): void;
-    clear(): void;
-    get isLoading(): boolean;
-    private notifyChanged;
-    /**
-     * Schedules event 'changed' to trigger at the next tick.
-     */
-    private readonly scheduleNotifyChanged;
-    private notifyLoadingStateChanged;
-    private handleNodeCollectionChanged;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodeAppearance } from './NodeAppearance';
+import { NodeCollectionBase } from './NodeCollectionBase';
+import { IndexSet } from '../../utilities';
+/**
+ * Delegate for applying styles in {@see NodeStyleProvider}.
+ * @param treeIndices Set of tree indices that the style is applied to.
+ * @param appearance  Style to be applied to the nodes.
+ */
+export declare type ApplyStyleDelegate = (treeIndices: IndexSet, appearance: NodeAppearance) => void;
+export declare class NodeAppearanceProvider {
+    private readonly _styledCollections;
+    private _lastFiredLoadingState?;
+    private readonly _events;
+    on(event: 'changed', listener: () => void): void;
+    on(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
+    off(event: 'changed', listener: () => void): void;
+    off(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
+    assignStyledNodeCollection(nodeCollection: NodeCollectionBase, appearance: NodeAppearance): void;
+    unassignStyledNodeCollection(nodeCollection: NodeCollectionBase): void;
+    applyStyles(applyCb: ApplyStyleDelegate): void;
+    clear(): void;
+    get isLoading(): boolean;
+    private notifyChanged;
+    /**
+     * Schedules event 'changed' to trigger at the next tick.
+     */
+    private readonly scheduleNotifyChanged;
+    private notifyLoadingStateChanged;
+    private handleNodeCollectionChanged;
+}

package/packages/cad-styling/src/NodeCollectionBase.d.ts

@@ -1,47 +1,47 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { IndexSet } from '../../utilities';
-export declare type SerializedNodeCollection = {
-    token: string;
-    state: any;
-    options?: any;
-};
-/**
- * Abstract class for implementing a set of nodes to be styled.
- */
-export declare abstract class NodeCollectionBase {
-    private readonly _changedEvent;
-    private readonly _classToken;
-    protected constructor(classToken: string);
-    get classToken(): string;
-    /**
-     * Subscribe a listener to events about the set changing, i.e.
-     * when nodes are added or removed to the set.
-     */
-    on(event: 'changed', listener: () => void): void;
-    /**
-     * Unsubscribe a listener to events about the set changing, i.e.
-     * when nodes are added or removed to the set.
-     */
-    off(event: 'changed', listener: () => void): void;
-    /**
-     * Returns true when the set currently is running an operation
-     * for loading the full set of nodes contained by the set.
-     */
-    abstract get isLoading(): boolean;
-    /**
-     * Returns the {@link IndexSet} that holds the tree indices
-     * of the nodes contained by the set.
-     */
-    abstract getIndexSet(): IndexSet;
-    /**
-     * Clears the set, making it empty.
-     */
-    abstract clear(): void;
-    /**
-     * Triggers the changed-event.
-     */
-    protected notifyChanged(): void;
-    abstract serialize(): SerializedNodeCollection;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { IndexSet } from '../../utilities';
+export declare type SerializedNodeCollection = {
+    token: string;
+    state: any;
+    options?: any;
+};
+/**
+ * Abstract class for implementing a set of nodes to be styled.
+ */
+export declare abstract class NodeCollectionBase {
+    private readonly _changedEvent;
+    private readonly _classToken;
+    protected constructor(classToken: string);
+    get classToken(): string;
+    /**
+     * Subscribe a listener to events about the set changing, i.e.
+     * when nodes are added or removed to the set.
+     */
+    on(event: 'changed', listener: () => void): void;
+    /**
+     * Unsubscribe a listener to events about the set changing, i.e.
+     * when nodes are added or removed to the set.
+     */
+    off(event: 'changed', listener: () => void): void;
+    /**
+     * Returns true when the set currently is running an operation
+     * for loading the full set of nodes contained by the set.
+     */
+    abstract get isLoading(): boolean;
+    /**
+     * Returns the {@link IndexSet} that holds the tree indices
+     * of the nodes contained by the set.
+     */
+    abstract getIndexSet(): IndexSet;
+    /**
+     * Clears the set, making it empty.
+     */
+    abstract clear(): void;
+    /**
+     * Triggers the changed-event.
+     */
+    protected notifyChanged(): void;
+    abstract serialize(): SerializedNodeCollection;
+}

package/packages/cad-styling/src/TreeIndexNodeCollection.d.ts

@@ -1,23 +1,23 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NumericRange, IndexSet } from '../../utilities';
-import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
-/**
- * Node collection that holds a set of nodes defined by a set of tree indices.
- */
-export declare class TreeIndexNodeCollection extends NodeCollectionBase {
-    static readonly classToken = "TreeIndexNodeCollection";
-    private _treeIndices;
-    constructor(treeIndexSet?: IndexSet);
-    constructor(treeIndices?: Iterable<number>);
-    constructor(treeIndexRange?: NumericRange);
-    updateSet(treeIndices: IndexSet): void;
-    /**
-     * Sets this set to hold an empty set.
-     */
-    clear(): void;
-    getIndexSet(): IndexSet;
-    get isLoading(): boolean;
-    serialize(): SerializedNodeCollection;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NumericRange, IndexSet } from '../../utilities';
+import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
+/**
+ * Node collection that holds a set of nodes defined by a set of tree indices.
+ */
+export declare class TreeIndexNodeCollection extends NodeCollectionBase {
+    static readonly classToken = "TreeIndexNodeCollection";
+    private _treeIndices;
+    constructor(treeIndexSet?: IndexSet);
+    constructor(treeIndices?: Iterable<number>);
+    constructor(treeIndexRange?: NumericRange);
+    updateSet(treeIndices: IndexSet): void;
+    /**
+     * Sets this set to hold an empty set.
+     */
+    clear(): void;
+    getIndexSet(): IndexSet;
+    get isLoading(): boolean;
+    serialize(): SerializedNodeCollection;
+}

package/packages/cad-styling/src/UnionNodeCollection.d.ts

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
-import { CombineNodeCollectionBase } from './CombineNodeCollectionBase';
-import { IndexSet } from '../../utilities';
-/**
- * Node collection that takes the set union of multiple node collections.
- */
-export declare class UnionNodeCollection extends CombineNodeCollectionBase {
-    static readonly classToken = "UnionNodeCollection";
-    constructor(nodeCollections?: NodeCollectionBase[]);
-    serialize(): SerializedNodeCollection;
-    protected createCombinedIndexSet(): IndexSet;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
+import { CombineNodeCollectionBase } from './CombineNodeCollectionBase';
+import { IndexSet } from '../../utilities';
+/**
+ * Node collection that takes the set union of multiple node collections.
+ */
+export declare class UnionNodeCollection extends CombineNodeCollectionBase {
+    static readonly classToken = "UnionNodeCollection";
+    constructor(nodeCollections?: NodeCollectionBase[]);
+    serialize(): SerializedNodeCollection;
+    protected createCombinedIndexSet(): IndexSet;
+}

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

@@ -1,4 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { default } from './src/ComboControls';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { ComboControls } from './src/ComboControls';
+export { CameraManager } from './src/CameraManager';
+export * from './src/types';

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

@@ -0,0 +1,85 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { ComboControls } from './ComboControls';
+import { CameraManagerCallbackData, CameraControlsOptions, CameraChangeData, ControlsState } from './types';
+import { InputHandler } from '../../utilities';
+export declare class CameraManager {
+    private readonly _events;
+    private readonly _controls;
+    private readonly _camera;
+    private readonly _domElement;
+    private readonly _inputHandler;
+    private readonly _raycaster;
+    private isDisposed;
+    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;
+    automaticNearFarPlane: boolean;
+    automaticControlsSensitivity: boolean;
+    /**
+     * Reusable buffers used by functions in Cognite3dViewer to avoid allocations.
+     */
+    private readonly _updateNearAndFarPlaneBuffers;
+    private readonly _calculateCameraFarBuffers;
+    constructor(camera: THREE.PerspectiveCamera, domElement: HTMLElement, inputHandler: InputHandler, raycastFunction: (x: number, y: number) => Promise<CameraManagerCallbackData>);
+    on(event: 'cameraChange', callback: CameraChangeData): void;
+    off(event: 'cameraChange', callback: CameraChangeData): void;
+    fitCameraToBoundingBox(box: THREE.Box3, duration?: number, radiusFactor?: number): void;
+    set cameraControlsEnabled(enabled: boolean);
+    get cameraControlsEnabled(): boolean;
+    set keyboardNavigationEnabled(enabled: boolean);
+    get keyboardNavigationEnabled(): boolean;
+    get cameraControls(): ComboControls;
+    setCameraTarget(target: THREE.Vector3, animated?: boolean): void;
+    setCameraControlsState(controlsState: ControlsState): void;
+    getCameraControlsState(): ControlsState;
+    getCameraControlsOptions(): CameraControlsOptions;
+    setCameraControlsOptions(controlsOptions: CameraControlsOptions): void;
+    moveCameraTo(position: THREE.Vector3, target: THREE.Vector3, duration?: number): void;
+    moveCameraTargetTo(target: THREE.Vector3, duration?: number): void;
+    updateCameraNearAndFar(camera: THREE.PerspectiveCamera, combinedBbox: THREE.Box3): void;
+    updateCameraControlsState(deltaTime: number): void;
+    dispose(): void;
+    private calculateAnimationStartTarget;
+    private createTweenAnimation;
+    private calculateCameraFar;
+    private calculateCameraNear;
+    /**
+     * 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/ComboControls.d.ts

@@ -1,100 +1,102 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { EventDispatcher, Vector3, PerspectiveCamera, OrthographicCamera } from 'three';
-export default class ComboControls extends EventDispatcher {
-    enabled: boolean;
-    enableDamping: boolean;
-    dampingFactor: number;
-    dynamicTarget: boolean;
-    minDistance: number;
-    maxDistance: number;
-    dollyFactor: number;
-    minPolarAngle: number;
-    maxPolarAngle: number;
-    minAzimuthAngle: number;
-    maxAzimuthAngle: number;
-    panDollyMinDistanceFactor: number;
-    firstPersonRotationFactor: number;
-    pointerRotationSpeedAzimuth: number;
-    pointerRotationSpeedPolar: number;
-    enableKeyboardNavigation: boolean;
-    keyboardRotationSpeedAzimuth: number;
-    keyboardRotationSpeedPolar: number;
-    mouseFirstPersonRotationSpeed: number;
-    keyboardDollySpeed: number;
-    keyboardPanSpeed: number;
-    keyboardSpeedFactor: number;
-    pinchEpsilon: number;
-    pinchPanSpeed: number;
-    EPSILON: number;
-    dispose: () => void;
-    minZoom: number;
-    maxZoom: number;
-    orthographicCameraDollyFactor: number;
-    lookAtViewTarget: boolean;
-    useScrollTarget: boolean;
-    zoomToCursor: boolean;
-    minDeltaRatio: number;
-    maxDeltaRatio: number;
-    minDeltaDownscaleCoefficient: number;
-    maxDeltaDownscaleCoefficient: number;
-    private _temporarilyDisableDamping;
-    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 _sphericalEnd;
-    private readonly _deltaTarget;
-    private _keyboard;
-    private readonly _offsetVector;
-    private readonly _panVector;
-    private readonly _raycaster;
-    private readonly _targetFPS;
-    private _targetFPSOverActualFPS;
-    private _isFocused;
-    constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement);
-    update: (deltaTime: number) => boolean;
-    getState: () => {
-        target: Vector3;
-        position: Vector3;
-    };
-    setState: (position: Vector3, target: Vector3) => void;
-    setViewTarget: (target: Vector3) => void;
-    setScrollTarget: (target: Vector3) => void;
-    triggerCameraChangeEvent: () => void;
-    private calculateShortestDeltaTheta;
-    private readonly convertPixelCoordinatesToNormalized;
-    private readonly onMouseDown;
-    private readonly onMouseUp;
-    private readonly onMouseWheel;
-    private readonly onTouchStart;
-    private readonly onFocusChanged;
-    private readonly onContextMenu;
-    private readonly rotate;
-    private readonly startMouseRotation;
-    private readonly startMousePan;
-    private readonly startTouchRotation;
-    private readonly startTouchPinch;
-    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;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { EventDispatcher, Vector3, PerspectiveCamera, OrthographicCamera } from 'three';
+export declare class ComboControls extends EventDispatcher {
+    enabled: boolean;
+    enableDamping: boolean;
+    dampingFactor: number;
+    dynamicTarget: boolean;
+    minDistance: number;
+    minZoomDistance: number;
+    dollyFactor: number;
+    minPolarAngle: number;
+    maxPolarAngle: number;
+    minAzimuthAngle: number;
+    maxAzimuthAngle: number;
+    panDollyMinDistanceFactor: number;
+    firstPersonRotationFactor: number;
+    pointerRotationSpeedAzimuth: number;
+    pointerRotationSpeedPolar: number;
+    enableKeyboardNavigation: boolean;
+    keyboardRotationSpeedAzimuth: number;
+    keyboardRotationSpeedPolar: number;
+    mouseFirstPersonRotationSpeed: number;
+    keyboardDollySpeed: number;
+    keyboardPanSpeed: number;
+    keyboardSpeedFactor: number;
+    pinchEpsilon: number;
+    pinchPanSpeed: number;
+    EPSILON: number;
+    dispose: () => void;
+    minZoom: number;
+    maxZoom: number;
+    orthographicCameraDollyFactor: number;
+    lookAtViewTarget: boolean;
+    useScrollTarget: boolean;
+    zoomToCursor: boolean;
+    minDeltaRatio: number;
+    maxDeltaRatio: number;
+    minDeltaDownscaleCoefficient: number;
+    maxDeltaDownscaleCoefficient: number;
+    private _temporarilyDisableDamping;
+    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 _sphericalEnd;
+    private readonly _deltaTarget;
+    private _keyboard;
+    private readonly _offsetVector;
+    private readonly _panVector;
+    private readonly _raycaster;
+    private readonly _targetFPS;
+    private _targetFPSOverActualFPS;
+    private _isFocused;
+    constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement);
+    update: (deltaTime: number) => boolean;
+    getState: () => {
+        target: Vector3;
+        position: Vector3;
+    };
+    setState: (position: Vector3, target: Vector3) => void;
+    setViewTarget: (target: Vector3) => void;
+    setScrollTarget: (target: Vector3) => void;
+    triggerCameraChangeEvent: () => void;
+    private calculateShortestDeltaTheta;
+    private readonly convertPixelCoordinatesToNormalized;
+    private readonly onPointerDown;
+    private readonly onMouseDown;
+    private readonly onMouseUp;
+    private readonly onMouseWheel;
+    private readonly onTouchStart;
+    private readonly onFocusChanged;
+    private readonly isDescendant;
+    private readonly onContextMenu;
+    private readonly rotate;
+    private readonly startMouseRotation;
+    private readonly startMousePan;
+    private readonly startTouchRotation;
+    private readonly startTouchPinch;
+    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;
+}

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

@@ -1,17 +1,17 @@
-/*!
- * 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;
+    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;
+}

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

@@ -0,0 +1,64 @@
+/*!
+ * 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 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;
+};
+/**
+ * Delegate for pointer events.
+ * @module @cognite/reveal
+ */
+export declare type PointerEventDelegate = (event: {
+    offsetX: number;
+    offsetY: number;
+}) => void;
+/**
+ * Type defining camera change event data.
+ */
+export declare type CameraChangeData = (event: {
+    camera: {
+        position: THREE.Vector3;
+        target: THREE.Vector3;
+    };
+}) => void;

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';