@cognite/reveal 2.1.0 → 2.2.2

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

@@ -1,83 +1,100 @@
-/*!
- * 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;
-    private temporarilyDisableDamping;
-    private camera;
-    private firstPersonMode;
-    private reusableCamera;
-    private reusableVector3;
-    private _accumulatedMouseMove;
-    private domElement;
-    private target;
-    private targetEnd;
-    private spherical;
-    private sphericalEnd;
-    private deltaTarget;
-    private keyboard;
-    private offsetVector;
-    private panVector;
-    private raycaster;
-    private 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;
-    triggerCameraChangeEvent: () => void;
-    private onMouseDown;
-    private onMouseUp;
-    private onMouseWheel;
-    private onTouchStart;
-    private onFocusChanged;
-    private onContextMenu;
-    private rotate;
-    private startMouseRotation;
-    private startMousePan;
-    private startTouchRotation;
-    private startTouchPinch;
-    private handleKeyboard;
-    private rotateSpherical;
-    private rotateFirstPersonMode;
-    private pan;
-    private dollyOrthographicCamera;
-    private dollyPerspectiveCamera;
-    private dolly;
-    private getDollyDeltaDistance;
-    private panLeft;
-    private panUp;
-}
+/*!
+ * 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;
+}

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

@@ -1,14 +1,17 @@
-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 addEventListeners;
-    private removeEventListeners;
-    private onKeydown;
-    private onKeyup;
-    private 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/data-source/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * 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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,26 @@
+/*!
+ * 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.
+ * @version New since 2.2
+ */
+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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,5 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { MetricsLogger } from './src/MetricsLogger';
+export { EventProps, TrackedEvents } from './src/types';

package/packages/metrics/src/MetricsLogger.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { TrackedEvents, EventProps } from './types';
+export declare class MetricsLogger {
+    _sessionProps: {
+        VERSION: string;
+        project: string;
+        application: string;
+        sessionId: string;
+    };
+    private constructor();
+    static init(logMetrics: boolean, project: string, applicationId: string, eventProps: EventProps): void;
+    private innerTrackEvent;
+    static trackEvent(eventName: TrackedEvents, eventProps: EventProps): void;
+    static trackCreateTool(toolName: string): void;
+    static trackLoadModel(eventProps: EventProps, modelIdentifier: any): void;
+    static trackCadModelStyled(nodeCollectionClassToken: string, appearance: any): void;
+    static trackError(error: Error, eventProps: EventProps): void;
+    static trackCameraNavigation(eventProps: EventProps): void;
+}

package/packages/metrics/src/types.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare type TrackedEvents = 'init' | 'construct3dViewer' | 'loadModel' | 'error' | 'cameraNavigated' | 'toolCreated' | 'cadModelStyleAssigned';
+export declare type EventProps = {
+    [key: string]: any;
+};

package/packages/modeldata-api/index.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { CdfModelDataProvider } from './src/CdfModelDataProvider';
+export { CdfModelIdentifier } from './src/CdfModelIdentifier';
+export { CdfModelMetadataProvider } from './src/CdfModelMetadataProvider';
+export { CdfModelOutputsProvider } from './src/CdfModelOutputsProvider';
+export { LocalModelDataProvider } from './src/LocalModelDataProvider';
+export { LocalModelIdentifier } from './src/LocalModelIdentifier';
+export { LocalModelMetadataProvider } from './src/LocalModelMetadataProvider';
+export { ModelIdentifier } from './src/ModelIdentifier';
+export { ModelMetadataProvider } from './src/ModelMetadataProvider';
+export { BinaryFileProvider, File3dFormat, HttpHeadersProvider, ModelDataProvider } from './src/types';

package/packages/modeldata-api/src/CdfModelDataProvider.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CogniteClient, HttpHeaders } from '@cognite/sdk';
+import { ModelDataProvider } from './types';
+/**
+ * Provides 3D V2 specific extensions for the standard CogniteClient used by Reveal.
+ */
+export declare class CdfModelDataProvider implements ModelDataProvider {
+    private readonly client;
+    constructor(client: CogniteClient);
+    get headers(): HttpHeaders;
+    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
+    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
+}

package/packages/modeldata-api/src/CdfModelIdentifier.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { ModelIdentifier } from '..';
+import { File3dFormat } from './types';
+/**
+ * Identifies a 3D model stored in CDF by the combination of a modelId, a revisionId
+ * and a format.
+ */
+export declare class CdfModelIdentifier implements ModelIdentifier {
+    readonly revealInternalId: symbol;
+    readonly modelFormat: File3dFormat;
+    readonly modelId: number;
+    readonly revisionId: number;
+    constructor(modelId: number, revisionId: number, modelFormat: File3dFormat);
+    toString(): string;
+}

package/packages/modeldata-api/src/CdfModelMetadataProvider.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { ModelMetadataProvider } from './ModelMetadataProvider';
+import { CogniteClient } from '@cognite/sdk';
+import { ModelIdentifier } from './ModelIdentifier';
+export declare class CdfModelMetadataProvider implements ModelMetadataProvider {
+    private readonly _client;
+    constructor(client: CogniteClient);
+    getModelMatrix(modelIdentifier: ModelIdentifier): Promise<THREE.Matrix4>;
+    getModelCamera(modelIdentifier: ModelIdentifier): Promise<{
+        position: THREE.Vector3;
+        target: THREE.Vector3;
+    } | undefined>;
+    getModelUri(modelIdentifier: ModelIdentifier): Promise<string>;
+    private getOutputs;
+    private getRequestPath;
+}

package/packages/modeldata-api/src/CdfModelOutputsProvider.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CdfModelIdentifier } from './CdfModelIdentifier';
+import { Model3DOutputList } from './Model3DOutputList';
+import { CogniteClient } from '@cognite/sdk';
+/**
+ * Helper class for getting the available 'outputs' from the Cognite
+ * 3D processing pipeline for a given model.
+ */
+export declare class CdfModelOutputsProvider {
+    private readonly _client;
+    constructor(client: CogniteClient);
+    getOutputs(modelIdentifier: CdfModelIdentifier): Promise<Model3DOutputList>;
+}

package/packages/modeldata-api/src/LocalModelDataProvider.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { HttpHeaders } from '@cognite/sdk-core';
+import { ModelDataProvider } from './types';
+export declare class LocalModelDataProvider implements ModelDataProvider {
+    get headers(): HttpHeaders;
+    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
+    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
+}

package/packages/modeldata-api/src/LocalModelIdentifier.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { ModelIdentifier } from './ModelIdentifier';
+/**
+ * Identifies a 3D model by a URL. This implementation is used for testing
+ * purposes.
+ */
+export declare class LocalModelIdentifier implements ModelIdentifier {
+    readonly revealInternalId: symbol;
+    readonly localPath: string;
+    constructor(localPath: string);
+    toString(): string;
+}

package/packages/modeldata-api/src/LocalModelMetadataProvider.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { ModelIdentifier } from './ModelIdentifier';
+import { ModelMetadataProvider } from './ModelMetadataProvider';
+export declare class LocalModelMetadataProvider implements ModelMetadataProvider {
+    getModelUri(modelIdentifier: ModelIdentifier): Promise<string>;
+    getModelMatrix(modelIdentifier: ModelIdentifier): Promise<THREE.Matrix4>;
+    getModelCamera(modelIdentifier: ModelIdentifier): Promise<{
+        position: THREE.Vector3;
+        target: THREE.Vector3;
+    } | undefined>;
+}

package/{core/src/utilities/networking → packages/modeldata-api/src}/Model3DOutputList.d.ts

@@ -1,18 +1,17 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { BlobOutputMetadata } from './types';
-import { File3dFormat } from '../types';
-export declare class Model3DOutputList {
-    readonly modelId: number;
-    readonly revisionId: number;
-    readonly outputs: BlobOutputMetadata[];
-    constructor(modelId: number, revisionId: number, outputs: BlobOutputMetadata[]);
-    /**
-     * Finds an output with a given format of the most recent version.
-     *
-     * @param outputFormat        Format to find output for, either a well known format a custom format.
-     * @param supportedVersions   Optional list of supported version. If not provided all versions are considered.
-     */
-    findMostRecentOutput(outputFormat: File3dFormat | string, supportedVersions?: number[]): BlobOutputMetadata | undefined;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { BlobOutputMetadata, File3dFormat } from './types';
+export declare class Model3DOutputList {
+    readonly modelId: number;
+    readonly revisionId: number;
+    readonly outputs: BlobOutputMetadata[];
+    constructor(modelId: number, revisionId: number, outputs: BlobOutputMetadata[]);
+    /**
+     * Finds an output with a given format of the most recent version.
+     *
+     * @param outputFormat        Format to find output for, either a well known format a custom format.
+     * @param supportedVersions   Optional list of supported version. If not provided all versions are considered.
+     */
+    findMostRecentOutput(outputFormat: File3dFormat | string, supportedVersions?: number[]): BlobOutputMetadata | undefined;
+}

package/packages/modeldata-api/src/ModelIdentifier.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Identifies a 3D model. Typically, implementations will use {@link CdfModelIdentifier}.
+ */
+export interface ModelIdentifier {
+    /**
+     * Unique ID of the model.
+     */
+    readonly revealInternalId: symbol;
+}

package/packages/modeldata-api/src/ModelMetadataProvider.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { ModelIdentifier } from './ModelIdentifier';
+/**
+ * Provides metadata for 3D models.
+ * @version New since 2.2
+ */
+export interface ModelMetadataProvider {
+    getModelUri(identifier: ModelIdentifier): Promise<string>;
+    getModelCamera(identifier: ModelIdentifier): Promise<{
+        position: THREE.Vector3;
+        target: THREE.Vector3;
+    } | undefined>;
+    getModelMatrix(identifier: ModelIdentifier): Promise<THREE.Matrix4>;
+}

package/{core/src/utilities/networking → packages/modeldata-api/src}/applyDefaultModelTransformation.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { File3dFormat } from '..';
-export declare function applyDefaultModelTransformation(matrix: THREE.Matrix4, format: File3dFormat | string): void;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { File3dFormat } from './types';
+export declare function applyDefaultModelTransformation(matrix: THREE.Matrix4, format: File3dFormat | string): void;

package/packages/modeldata-api/src/types.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { HttpHeaders } from '@cognite/sdk-core';
+export interface JsonFileProvider {
+    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
+}
+export interface BinaryFileProvider {
+    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
+}
+/**
+ * Provides data for 3D models.
+ * @version New since 2.2
+ */
+export interface ModelDataProvider extends HttpHeadersProvider, JsonFileProvider, BinaryFileProvider {
+    /**
+     * Download and parse a JSON file and return the resulting struct.
+     * @param baseUrl     Base URL of the model.
+     * @param fileName    Filename of JSON file.
+     */
+    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
+    /**
+     * Downloads a binary blob.
+     * @param baseUrl     Base URL of the model.
+     * @param fileName    Filename of binary file.
+     */
+    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
+}
+export interface HttpHeadersProvider {
+    readonly headers: HttpHeaders;
+}
+export declare enum File3dFormat {
+    EptPointCloud = "ept-pointcloud",
+    RevealCadModel = "reveal-directory",
+    AnyFormat = "all-outputs"
+}
+export interface BlobOutputMetadata {
+    blobId: number;
+    format: File3dFormat | string;
+    version: number;
+}

package/packages/modeldata-api/src/utilities.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { Versioned3DFile } from '@cognite/sdk';
+export declare const supportedVersions: number[];
+export declare function getNewestVersionedFile(files: Versioned3DFile[]): Versioned3DFile;
+export declare function fetchWithStatusCheck(url: string): Promise<Response>;

package/packages/nodes-api/index.d.ts

@@ -1,7 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { NodesApiClient } from './src/NodesApiClient';
-export { NodesCdfClient } from './src/NodesCdfClient';
-export { NodesLocalClient } from './src/NodesLocalClient';
-export { NodeTreeIndexAndSubtreeSize } from './src/types';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { NodesApiClient } from './src/NodesApiClient';
+export { NodesCdfClient } from './src/NodesCdfClient';
+export { NodesLocalClient } from './src/NodesLocalClient';