@cognite/reveal 3.0.0-alpha.2 → 3.0.0

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

@@ -1,64 +1,75 @@
-/*!
- * 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;
+/*!
+ * 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;
+};
+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;
+/**
+ * Delegate for camera update events.
+ * @module @cognite/reveal
+ * @see {@link CameraManager.on}.
+ */
+export declare type CameraChangeDelegate = (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';

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,5 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { MetricsLogger } from './src/MetricsLogger';
-export { EventProps, TrackedEvents } from './src/types';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { MetricsLogger } from './src/MetricsLogger';

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

@@ -1,21 +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, modelVersion: number): void;
-    static trackCadModelStyled(nodeCollectionClassToken: string, appearance: any): void;
-    static trackError(error: Error, eventProps: EventProps): void;
-    static trackCameraNavigation(eventProps: EventProps): void;
-}
+/*!
+ * 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, modelVersion: number): 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

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

package/packages/model-base/index.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export { IntersectInput, LoadingState } from './src/types';
+export { SupportedModelTypes } from './src/SupportedModelTypes';
+export { CogniteModelBase } from './src/CogniteModelBase';
+export { NodeIdAndTreeIndexMaps } from './src/NodeIdAndTreeIndexMaps';
+export { MetadataRepository } from './src/MetadataRepository';

package/{core/src/public/migration → packages/model-base/src}/CogniteModelBase.d.ts

@@ -1,17 +1,17 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CameraConfiguration } from './types';
-import { SupportedModelTypes } from '../../datamodels/base';
-/**
- * Base class for 3D models supported by {@link Cognite3DViewer}.
- * @module @cognite/reveal
- */
-export interface CogniteModelBase {
-    readonly type: SupportedModelTypes;
-    dispose(): void;
-    getModelBoundingBox(outBbox?: THREE.Box3, restrictToMostGeometry?: boolean): THREE.Box3;
-    getCameraConfiguration(): CameraConfiguration | undefined;
-    setModelTransformation(matrix: THREE.Matrix4): void;
-    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CameraConfiguration } from '../../utilities';
+import { SupportedModelTypes } from './SupportedModelTypes';
+/**
+ * Base class for 3D models supported by {@link Cognite3DViewer}.
+ * @module @cognite/reveal
+ */
+export interface CogniteModelBase {
+    readonly type: SupportedModelTypes;
+    dispose(): void;
+    getModelBoundingBox(outBbox?: THREE.Box3, restrictToMostGeometry?: boolean): THREE.Box3;
+    getCameraConfiguration(): CameraConfiguration | undefined;
+    setModelTransformation(matrix: THREE.Matrix4): void;
+    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+}

package/packages/{cad-parsers/src/metadata → model-base/src}/MetadataRepository.d.ts

@@ -1,7 +1,7 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { ModelIdentifier } from '../../../modeldata-api';
-export interface MetadataRepository<Output> {
-    loadData(modelIdentifier: ModelIdentifier): Output;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { ModelIdentifier } from '../../modeldata-api';
+export interface MetadataRepository<Output> {
+    loadData(modelIdentifier: ModelIdentifier): Output;
+}

package/{core/src/public/migration → packages/model-base/src}/NodeIdAndTreeIndexMaps.d.ts

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export {};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export {};

package/{core/src/datamodels/base → packages/model-base/src}/SupportedModelTypes.d.ts

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare type SupportedModelTypes = 'pointcloud' | 'cad';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare type SupportedModelTypes = 'pointcloud' | 'cad';

package/packages/{cad-geometry-loaders/src/utilities → model-base/src}/types.d.ts

@@ -1,25 +1,36 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * State holding information about data being loaded.
- */
-export declare type LoadingState = {
-    /**
-     * Indicates if we are currently loading more data.
-     */
-    isLoading: boolean;
-    /**
-     * Items loaded so far in this batch.
-     */
-    itemsLoaded: number;
-    /**
-     * Totals number of items to load in this batch.
-     */
-    itemsRequested: number;
-    /**
-     * Number of items that has been 'culled' (i.e. deemed not necessary
-     * to load) so far in this batch.
-     */
-    itemsCulled: number;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export interface IntersectInput {
+    normalizedCoords: {
+        x: number;
+        y: number;
+    };
+    camera: THREE.PerspectiveCamera;
+    clippingPlanes: THREE.Plane[];
+    renderer: THREE.WebGLRenderer;
+    domElement: HTMLElement;
+}
+/**
+ * State holding information about data being loaded.
+ */
+export declare type LoadingState = {
+    /**
+     * Indicates if we are currently loading more data.
+     */
+    isLoading: boolean;
+    /**
+     * Items loaded so far in this batch.
+     */
+    itemsLoaded: number;
+    /**
+     * Totals number of items to load in this batch.
+     */
+    itemsRequested: number;
+    /**
+     * Number of items that has been 'culled' (i.e. deemed not necessary
+     * to load) so far in this batch.
+     */
+    itemsCulled: number;
+};

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

@@ -1,13 +1,12 @@
-/*!
- * 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, BlobOutputMetadata } from './src/types';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { CdfModelDataProvider } from './src/CdfModelDataProvider';
+export { CdfModelIdentifier } from './src/CdfModelIdentifier';
+export { CdfModelMetadataProvider } from './src/CdfModelMetadataProvider';
+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, BlobOutputMetadata } from './src/types';

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

@@ -1,17 +1,17 @@
-/*!
- * 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;
-    private authenticationPromise;
-    constructor(client: CogniteClient);
-    get headers(): HttpHeaders;
-    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
-    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
-    private fetchWithRetry;
-}
+/*!
+ * 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;
+    private authenticationPromise;
+    constructor(client: CogniteClient);
+    get headers(): HttpHeaders;
+    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
+    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
+    private fetchWithRetry;
+}

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

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { ModelIdentifier } from '..';
-/**
- * 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 modelId: number;
-    readonly revisionId: number;
-    constructor(modelId: number, revisionId: number);
-    toString(): string;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { ModelIdentifier } from '..';
+/**
+ * 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 modelId: number;
+    readonly revisionId: number;
+    constructor(modelId: number, revisionId: number);
+    toString(): string;
+}

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

@@ -1,20 +1,20 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { BlobOutputMetadata, File3dFormat } from './types';
-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, format: File3dFormat): Promise<THREE.Matrix4>;
-    getModelCamera(modelIdentifier: ModelIdentifier): Promise<{
-        position: THREE.Vector3;
-        target: THREE.Vector3;
-    } | undefined>;
-    getModelUri(modelIdentifier: ModelIdentifier, formatMetadata: BlobOutputMetadata): Promise<string>;
-    getModelOutputs(modelIdentifier: ModelIdentifier): Promise<BlobOutputMetadata[]>;
-    private getRequestPath;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { BlobOutputMetadata, File3dFormat } from './types';
+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, format: File3dFormat): Promise<THREE.Matrix4>;
+    getModelCamera(modelIdentifier: ModelIdentifier): Promise<{
+        position: THREE.Vector3;
+        target: THREE.Vector3;
+    } | undefined>;
+    getModelUri(modelIdentifier: ModelIdentifier, formatMetadata: BlobOutputMetadata): Promise<string>;
+    getModelOutputs(modelIdentifier: ModelIdentifier): Promise<BlobOutputMetadata[]>;
+    private getRequestPath;
+}