@cognite/reveal 2.0.0-beta.3 → 2.1.2

package/{public → core/src/public}/migration/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 './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;
+}

package/{public → core/src/public}/migration/CognitePointCloudModel.d.ts

@@ -1,127 +1,121 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { CogniteModelBase } from './CogniteModelBase';
-import { SupportedModelTypes } from '../types';
-import { CameraConfiguration } from './types';
-import { PotreePointColorType, PotreePointShape, WellKnownAsprsPointClassCodes } from '../..';
-/**
- * Represents a point clouds model loaded from CDF.
- * @noInheritDoc
- * @module @cognite/reveal
- */
-export declare class CognitePointCloudModel extends THREE.Object3D implements CogniteModelBase {
-    readonly type: SupportedModelTypes;
-    readonly modelId: number;
-    /**
-     * The modelId of the point cloud model in Cognite Data Fusion.
-     */
-    readonly revisionId: number;
-    /**
-     * Used to clean up memory.
-     */
-    dispose(): void;
-    /**
-     * @param outBbox Optional. Used to write result to.
-     * @returns Model's bounding box.
-     * @example
-     * ```js
-     * const box = new THREE.Box3()
-     * model.getModelBoundingBox(box);
-     * // box now has the bounding box
-     *```
-     * ```js
-     * // the following code does the same
-     * const box = model.getModelBoundingBox();
-     * ```
-     */
-    getModelBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
-    /**
-     * Retrieves the camera position and target stored for the model. Typically this
-     * is used to store a good starting position for a model. Returns `undefined` if there
-     * isn't any stored camera configuration for the model.
-     */
-    getCameraConfiguration(): CameraConfiguration | undefined;
-    /**
-     * Sets transformation matrix of the model. This overrides the current transformation.
-     * @param transformationMatrix
-     */
-    setModelTransformation(transformationMatrix: THREE.Matrix4): void;
-    /**
-     * Gets transformation matrix of the model.
-     * @param out Preallocated `THREE.Matrix4` (optional).
-     */
-    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
-    /**
-     * Sets a visible filter on points of a given class.
-     * @param pointClass ASPRS classification class code. Either one of the well known
-     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
-     * @param visible Boolean flag that determines if the point class type should be visible or not.
-     * @throws Error if the model doesn't have the class given.
-     */
-    setClassVisible(pointClass: number | WellKnownAsprsPointClassCodes, visible: boolean): void;
-    /**
-     * Determines if points from a given class are visible.
-     * @param pointClass ASPRS classification class code. Either one of the well known
-     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
-     * @returns True if points from the given class will be visible.
-     * @throws Error if the model doesn't have the class given.
-     */
-    isClassVisible(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
-    /**
-     * Returns true if the model has values with the given classification class.
-     * @param pointClass ASPRS classification class code. Either one of the well known
-     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
-     * @returns True if model has values in the class given.
-     */
-    hasClass(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
-    /**
-     * Returns a list of sorted classification codes present in the model.
-     * @returns A sorted list of classification codes from the model.
-     */
-    getClasses(): Array<number | WellKnownAsprsPointClassCodes>;
-    /**
-     * Returns the current budget measured in number of points.
-     */
-    get pointBudget(): number;
-    /**
-     * The point budget limits the number of points loaded and rendered at any given time,
-     * which helps to adapt performance requirements to the capabilities of different hardware.
-     * Recommended values are between 500.000  and 10.000.000.
-     */
-    set pointBudget(count: number);
-    /**
-     * Determines how points currently are colored.
-     */
-    get pointColorType(): PotreePointColorType;
-    /**
-     * Specifies how points are colored.
-     * @default PotreePointColorType.Rgb
-     * @example
-     * ```js
-     * model.pointColorType = PotreePointColorType.Rgb
-     * ```
-     */
-    set pointColorType(type: PotreePointColorType);
-    /**
-     * Returns the size of each rendered point in the point cloud.
-     */
-    get pointSize(): number;
-    /**
-     * Sets the size of each rendered point in the point cloud.
-     * @default `1`
-     */
-    set pointSize(size: number);
-    /**
-     * Sets the point shape of each rendered point in the point cloud.
-     * @default `PotreePointShape.Circle`
-     * @see {@link PotreePointShape}.
-     */
-    get pointShape(): PotreePointShape;
-    /**
-     * Gets the point shape of each rendered point in the point cloud.
-     * @see {@link PotreePointShape}.
-     */
-    set pointShape(shape: PotreePointShape);
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { CogniteModelBase } from './CogniteModelBase';
+import { SupportedModelTypes } from '../types';
+import { CameraConfiguration } from './types';
+import { PotreePointColorType, PotreePointShape, WellKnownAsprsPointClassCodes } from '../..';
+/**
+ * Represents a point clouds model loaded from CDF.
+ * @noInheritDoc
+ * @module @cognite/reveal
+ */
+export declare class CognitePointCloudModel extends THREE.Object3D implements CogniteModelBase {
+    readonly type: SupportedModelTypes;
+    readonly modelId: number;
+    /**
+     * The modelId of the point cloud model in Cognite Data Fusion.
+     */
+    readonly revisionId: number;
+    /**
+     * Used to clean up memory.
+     */
+    dispose(): void;
+    /**
+     * @param outBbox Optional. Used to write result to.
+     * @returns Model's bounding box.
+     * @example
+     * ```js
+     * const box = new THREE.Box3()
+     * model.getModelBoundingBox(box);
+     * // box now has the bounding box
+     *```
+     * ```js
+     * // the following code does the same
+     * const box = model.getModelBoundingBox();
+     * ```
+     */
+    getModelBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
+    /**
+     * Retrieves the camera position and target stored for the model. Typically this
+     * is used to store a good starting position for a model. Returns `undefined` if there
+     * isn't any stored camera configuration for the model.
+     */
+    getCameraConfiguration(): CameraConfiguration | undefined;
+    /**
+     * Sets transformation matrix of the model. This overrides the current transformation.
+     * @param transformationMatrix
+     */
+    setModelTransformation(transformationMatrix: THREE.Matrix4): void;
+    /**
+     * Gets transformation matrix of the model.
+     * @param out Preallocated `THREE.Matrix4` (optional).
+     */
+    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+    /**
+     * Sets a visible filter on points of a given class.
+     * @param pointClass ASPRS classification class code. Either one of the well known
+     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
+     * @param visible Boolean flag that determines if the point class type should be visible or not.
+     * @throws Error if the model doesn't have the class given.
+     */
+    setClassVisible(pointClass: number | WellKnownAsprsPointClassCodes, visible: boolean): void;
+    /**
+     * Determines if points from a given class are visible.
+     * @param pointClass ASPRS classification class code. Either one of the well known
+     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
+     * @returns True if points from the given class will be visible.
+     * @throws Error if the model doesn't have the class given.
+     */
+    isClassVisible(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
+    /**
+     * Returns true if the model has values with the given classification class.
+     * @param pointClass ASPRS classification class code. Either one of the well known
+     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
+     * @returns True if model has values in the class given.
+     */
+    hasClass(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
+    /**
+     * Returns a list of sorted classification codes present in the model.
+     * @returns A sorted list of classification codes from the model.
+     */
+    getClasses(): Array<number | WellKnownAsprsPointClassCodes>;
+    /**
+     * Returns the current number of visible/loaded points.
+     */
+    get visiblePointCount(): number;
+    /**
+     * Determines how points currently are colored.
+     */
+    get pointColorType(): PotreePointColorType;
+    /**
+     * Specifies how points are colored.
+     * @default PotreePointColorType.Rgb
+     * @example
+     * ```js
+     * model.pointColorType = PotreePointColorType.Rgb
+     * ```
+     */
+    set pointColorType(type: PotreePointColorType);
+    /**
+     * Returns the size of each rendered point in the point cloud.
+     */
+    get pointSize(): number;
+    /**
+     * Sets the size of each rendered point in the point cloud.
+     * @default `1`
+     */
+    set pointSize(size: number);
+    /**
+     * Sets the point shape of each rendered point in the point cloud.
+     * @default `PotreePointShape.Circle`
+     * @see {@link PotreePointShape}.
+     */
+    get pointShape(): PotreePointShape;
+    /**
+     * Gets the point shape of each rendered point in the point cloud.
+     * @see {@link PotreePointShape}.
+     */
+    set pointShape(shape: PotreePointShape);
+}

package/{public → core/src/public}/migration/NodeIdAndTreeIndexMaps.d.ts

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

package/{public → core/src/public}/migration/NotSupportedInMigrationWrapperError.d.ts

@@ -1,11 +1,11 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-/**
- * Error that is thrown for certain type of functionality that was supported in @cognite/3d-viewer,
- * but not in @cognite/reveal.
- * @module @cognite/reveal
- */
-export declare class NotSupportedInMigrationWrapperError extends Error {
-    constructor(message?: string);
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/**
+ * Error that is thrown for certain type of functionality that was supported in @cognite/3d-viewer,
+ * but not in @cognite/reveal.
+ * @module @cognite/reveal
+ */
+export declare class NotSupportedInMigrationWrapperError extends Error {
+    constructor(message?: string);
+}

package/{public → core/src/public}/migration/RenderController.d.ts

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

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

@@ -0,0 +1,58 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { AddModelOptions } from './types';
+import { RevealManager } from '../RevealManager';
+import { RevealOptions } from '../..';
+import { PointCloudNode } from '../../datamodels/pointcloud/PointCloudNode';
+import { CdfModelIdentifier, LocalModelIdentifier } from '../../../../packages/modeldata-api';
+import { CadNode } from '../../../../packages/cad-geometry-loaders';
+import { CogniteClient } from '@cognite/sdk';
+/**
+ * Helper for {@link RevealManager} for creating a uniform interface for
+ * working with instances that fetch models from CDF or instances that fetch
+ * models from local storage (i.e. in development/debugging).
+ */
+export declare class RevealManagerHelper {
+    private readonly _revealManager;
+    addCadModel: (model: AddModelOptions) => Promise<CadNode>;
+    addPointCloudModel: (model: AddModelOptions) => Promise<PointCloudNode>;
+    private constructor();
+    private constructor();
+    /**
+     * Create helper for RevealManager that loads models from local storage. This is only
+     * meant for use in debugging and development.
+     * @param renderer
+     * @param scene
+     * @param revealOptions
+     */
+    static createLocalHelper(renderer: THREE.WebGLRenderer, scene: THREE.Scene, revealOptions: RevealOptions): RevealManagerHelper;
+    /**
+     * Creates a helper for RevealManager that loads models from CDF.
+     * @param renderer
+     * @param scene
+     * @param revealOptions
+     * @param sdkClient
+     */
+    static createCdfHelper(renderer: THREE.WebGLRenderer, scene: THREE.Scene, revealOptions: RevealOptions, sdkClient: CogniteClient): RevealManagerHelper;
+    get revealManager(): RevealManager<LocalModelIdentifier> | RevealManager<CdfModelIdentifier>;
+    /**
+     * Adds a local CAD model.
+     * @param model
+     * @param revealManager
+     */
+    private static addLocalCadModel;
+    /**
+     * Adds a CDF hosted CAD model.
+     * @param model
+     * @param revealManager
+     */
+    private static addCdfCadModel;
+    /**
+     * Add a CDF hosted point cloud model.
+     * @param model
+     * @param revealManager
+     */
+    private static addCdfPointCloudModel;
+}