@cognite/reveal 3.0.2 → 3.2.0

package/packages/api/src/public/migration/renderOptionsHelpers.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { AntiAliasingMode, SsaoParameters } from '../../../../rendering';
+import { DeviceDescriptor } from '../../../../utilities';
+import { PropType } from '../../utilities/reflection';
+import { Cognite3DViewerOptions } from './types';
+declare type AntiAliasingHintOption = NonNullable<PropType<Cognite3DViewerOptions, 'antiAliasingHint'>>;
+declare type SsaoQualityHintOption = PropType<Cognite3DViewerOptions, 'ssaoQualityHint'>;
+/**
+ * Determines anti-aliasing mode based on the mode requested and the device in question.
+ * For mobile and tablets MSAA is disabled. FXAA is supported on all devices.
+ * @param modeHint  Mode as provided in options to the viewer.
+ * @param device    Descriptor for current device.
+ * @returns Actual anti-aliasing mode to initialize the renderer with.
+ */
+export declare function determineAntiAliasingMode(modeHint: AntiAliasingHintOption | undefined, device: DeviceDescriptor): {
+    antiAliasing: AntiAliasingMode;
+    multiSampleCount: number;
+};
+/**
+ * Determines SSAO mode based on the mode requested and the device in question.
+ * For mobile and tablets SSAO is disabled.
+ * @param qualityHint Mode as provided in options to the viewer.
+ * @param device    Descriptor for current device.
+ * @returns Actual SSAO mode to initialize viewer with.
+ */
+export declare function determineSsaoRenderParameters(qualityHint: SsaoQualityHintOption, device: DeviceDescriptor): SsaoParameters;
+/**
+ * Determines the default resolution threshold based on device .
+ * @param rendererResolutionThreshold User provided resolution cap.
+ * @param device Device type (mobile, tablet, desktop, etc.).
+ * @param devicePixelRatio Device pixel ratio set on the renderer.
+ */
+export declare function determineResolutionCap(rendererResolutionThreshold: number | undefined, device: DeviceDescriptor, devicePixelRatio: number): number;
+export {};

package/{core → packages/api}/src/public/migration/types.d.ts

@@ -1,169 +1,180 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CogniteClient } from '@cognite/sdk';
-import { CadModelBudget } from '../../../../packages/cad-geometry-loaders';
-import { PointCloudBudget, PointCloudIntersection } from '../../../../packages/pointclouds';
-import { CameraManager } from '../../../../packages/camera-manager';
-import { GeometryFilter, Cognite3DModel } from '../../../../packages/cad-model';
-import { DataSource } from '../../../../packages/data-source';
-/**
- * @module @cognite/reveal
- */
-export declare type Color = {
-    r: number;
-    g: number;
-    b: number;
-};
-/**
- * Callback to monitor loaded requests and progress.
- * Use OnLoadingCallback instead of onProgress/onComplete.
- * @module @cognite/reveal
- *
- * @param itemsLoaded Number of items loaded so far in this batch.
- * @param itemsRequested Total number of items to load in this batch.
- * @param itemsCulled Number of items deemed unnecessary to load in this batch.
- */
-export declare type OnLoadingCallback = (itemsLoaded: number, itemsRequested: number, itemsCulled: number) => void;
-/**
- * @module @cognite/reveal
- */
-export interface Cognite3DViewerOptions {
-    /** Initialized connection to CDF used to load data. */
-    sdk: CogniteClient;
-    /** An existing DOM element that we will render canvas into. */
-    domElement?: HTMLElement;
-    /** Send anonymous usage statistics. */
-    logMetrics?: boolean;
-    /**
-     * Render to offscreen buffer instead of canvas.
-     */
-    renderTargetOptions?: {
-        target: THREE.WebGLRenderTarget;
-        autoSetSize?: boolean;
-    };
-    /**
-     * Style the loading indicator.
-     */
-    loadingIndicatorStyle?: {
-        /**
-         * What corner the spinner should be placed in. Defaults top topLeft.
-         */
-        placement: 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
-        /**
-         * Opacity of the spinner in fractions. Valid values are between
-         * 0.2 and 1.0. Defaults to 1.0.
-         */
-        opacity: number;
-    };
-    /**
-     * Camera manager instance that is used for controlling the camera.
-     * It is responsible for all manipulations that are done with the camera,
-     * including animations and modification of state. Also, gives ability
-     * to provide custom `THREE.PerspectiveCamera` instance to {@link Cognite3DViewer}.
-     * Default implementation is {@link DefaultCameraManager}.
-     */
-    cameraManager?: CameraManager;
-    /** Renderer used to visualize model (optional). */
-    renderer?: THREE.WebGLRenderer;
-    /**
-     * Hints Reveal to use a given anti-aliasing technique.
-     *
-     * Fast approximate anti-aliasing (FXAA) is a fast technique that will remove some, but not all aliasing effects. See
-     * https://en.wikipedia.org/wiki/Fast_approximate_anti-aliasing.
-     *
-     * Multi-sampling anti-aliasinbg (MSAA) is a technique for taking multiple samples per pixel to avoid aliasing effects.
-     * This mode requires WebGL 2. See https://www.khronos.org/opengl/wiki/Multisampling.
-     *
-     * The combined modes will apply both MSAA and FXAA anti-aliasing and yields the best visual result.
-     *
-     * When using the MSAA modes combined with FXAA Reveal will fall back to FXAA on WebGL 1. There is no fallback for the
-     * "plain" MSAA modes on WebGL 1.
-     *
-     * Currently the default mode is FXAA, but this is subject to change.
-     */
-    antiAliasingHint?: 'disabled' | 'fxaa' | 'msaa2+fxaa' | 'msaa4+fxaa' | 'msaa8+fxaa' | 'msaa16+fxaa' | 'msaa2' | 'msaa4' | 'msaa8' | 'msaa16';
-    /**
-     * Hints the renderer of the quality it should aim for for screen space ambient occlusion,
-     * an effect creating shadows and that gives the rendered image more depth.
-     */
-    ssaoQualityHint?: 'medium' | 'high' | 'veryhigh' | 'disabled';
-    /**
-     * Enables / disables visualizing the edges of geometry. Defaults to true.
-     */
-    enableEdges?: boolean;
-    /** Callback to download stream progress. */
-    onLoading?: OnLoadingCallback;
-    /**
-     * Allows providing a custom data source that Reveal will
-     * use to load model data. Note that some features might not
-     * work when implementing a custom data source. Please refer
-     * to the Reveal documentation for details.
-     *
-     * Note that the data source must support {@link CdfModelIdentifier}.
-     *
-     * This cannot be used together with {@link _localModels}.
-     */
-    customDataSource?: DataSource;
-    /**
-     * Allows for controlling if geometry streaming should be halted when
-     * the camera is moving. Note that this option should left to false on
-     * low-end devices as more loading can cause frame drops.
-     *
-     * Default value is set to false.
-     */
-    continuousModelStreaming?: boolean;
-}
-/**
- * @module @cognite/reveal
- */
-export interface AddModelOptions {
-    modelId: number;
-    revisionId: number;
-    localPath?: string;
-    geometryFilter?: GeometryFilter;
-}
-export declare type CadIntersection = {
-    /**
-     * The intersection type.
-     */
-    type: 'cad';
-    /**
-     * The model that was intersected.
-     */
-    model: Cognite3DModel;
-    /**
-     * Coordinate of the intersection.
-     */
-    point: THREE.Vector3;
-    /**
-     * Tree index of the intersected 3D node.
-     */
-    treeIndex: number;
-    /**
-     * Distance from the camera to the intersection.
-     */
-    distanceToCamera: number;
-};
-/**
- * Represents the result from {@link Cognite3DViewer.getIntersectionFromPixel}.
- * @module @cognite/reveal
- */
-export declare type Intersection = CadIntersection | PointCloudIntersection;
-/**
- * @module @cognite/reveal
- */
-export { CameraConfiguration } from '../../../../packages/utilities';
-export * from './NotSupportedInMigrationWrapperError';
-export { CadModelBudget, PointCloudBudget };
-/**
- * Options to control how {@link Cognite3DViewer.getIntersectionFromPixel} behaves.
- */
-export interface IntersectionFromPixelOptions {
-    /**
-     * Threshold (in meters) for how close a point must be an intersection
-     * ray for it to be considered an intersection for point clouds. Defaults
-     * to 0.05.
-     */
-    pointIntersectionThreshold?: number;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CogniteClient } from '@cognite/sdk';
+import { CadModelBudget } from '../../../../cad-geometry-loaders';
+import { PointCloudBudget, PointCloudIntersection } from '../../../../pointclouds';
+import { CameraManager } from '../../../../camera-manager';
+import { GeometryFilter, Cognite3DModel } from '../../../../cad-model';
+import { DataSource } from '../../../../data-source';
+/**
+ * Callback to monitor loaded requests and progress.
+ * Use OnLoadingCallback instead of onProgress/onComplete.
+ * @module @cognite/reveal
+ *
+ * @param itemsLoaded Number of items loaded so far in this batch.
+ * @param itemsRequested Total number of items to load in this batch.
+ * @param itemsCulled Number of items deemed unnecessary to load in this batch.
+ */
+export declare type OnLoadingCallback = (itemsLoaded: number, itemsRequested: number, itemsCulled: number) => void;
+/**
+ * @module @cognite/reveal
+ */
+export interface Cognite3DViewerOptions {
+    /** Initialized connection to CDF used to load data. */
+    sdk: CogniteClient;
+    /** An existing DOM element that we will render canvas into. */
+    domElement?: HTMLElement;
+    /** Send anonymous usage statistics. */
+    logMetrics?: boolean;
+    /**
+     * Render to offscreen buffer instead of canvas.
+     */
+    renderTargetOptions?: {
+        target: THREE.WebGLRenderTarget;
+        autoSetSize?: boolean;
+    };
+    /**
+     * Style the loading indicator.
+     */
+    loadingIndicatorStyle?: {
+        /**
+         * What corner the spinner should be placed in. Defaults top topLeft.
+         */
+        placement: 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
+        /**
+         * Opacity of the spinner in fractions. Valid values are between
+         * 0.2 and 1.0. Defaults to 1.0.
+         */
+        opacity: number;
+    };
+    /**
+     * Camera manager instance that is used for controlling the camera.
+     * It is responsible for all manipulations that are done with the camera,
+     * including animations and modification of state. Also, gives ability
+     * to provide custom `THREE.PerspectiveCamera` instance to {@link Cognite3DViewer}.
+     * Default implementation is {@link DefaultCameraManager}.
+     */
+    cameraManager?: CameraManager;
+    /** Renderer used to visualize model (optional). */
+    renderer?: THREE.WebGLRenderer;
+    /**
+     * Generally Reveal will follow the resolution given by the size
+     * of the encapsulating DOM element of the Canvas {@link Cognite3DViewerOptions.domElement}.
+     * To ensure managable performance, Reveal will by default set an upper threshold to limit
+     * the resolution. Setting the {@link Cognite3DViewerOptions.rendererResolutionThreshold} will
+     * set this upper limit of what resolution Reveal will allow.
+     */
+    rendererResolutionThreshold?: number;
+    /**
+     * Hints Reveal to use a given anti-aliasing technique.
+     *
+     * Fast approximate anti-aliasing (FXAA) is a fast technique that will remove some, but not all aliasing effects. See
+     * https://en.wikipedia.org/wiki/Fast_approximate_anti-aliasing.
+     *
+     * Multi-sampling anti-aliasinbg (MSAA) is a technique for taking multiple samples per pixel to avoid aliasing effects.
+     * This mode requires WebGL 2. See https://www.khronos.org/opengl/wiki/Multisampling.
+     *
+     * The combined modes will apply both MSAA and FXAA anti-aliasing and yields the best visual result.
+     *
+     * When using the MSAA modes combined with FXAA Reveal will fall back to FXAA on WebGL 1. There is no fallback for the
+     * "plain" MSAA modes on WebGL 1.
+     *
+     * Currently the default mode is FXAA, but this is subject to change.
+     */
+    antiAliasingHint?: 'disabled' | 'fxaa' | 'msaa2+fxaa' | 'msaa4+fxaa' | 'msaa8+fxaa' | 'msaa16+fxaa' | 'msaa2' | 'msaa4' | 'msaa8' | 'msaa16';
+    /**
+     * Hints the renderer of the quality it should aim for for screen space ambient occlusion,
+     * an effect creating shadows and that gives the rendered image more depth.
+     */
+    ssaoQualityHint?: 'medium' | 'high' | 'veryhigh' | 'disabled';
+    /**
+     * Point cloud visualisation effects parameteres.
+     */
+    pointCloudEffects?: {
+        /**
+         * Point blending effect, creates more "stable" texture on objects surfaces if point sizing is
+         * big enough. Can cause significant decrease in performance on some machines.
+         */
+        pointBlending?: boolean;
+    };
+    /**
+     * Enables / disables visualizing the edges of geometry. Defaults to true.
+     */
+    enableEdges?: boolean;
+    /** Callback to download stream progress. */
+    onLoading?: OnLoadingCallback;
+    /**
+     * Allows providing a custom data source that Reveal will
+     * use to load model data. Note that some features might not
+     * work when implementing a custom data source. Please refer
+     * to the Reveal documentation for details.
+     *
+     * Note that the data source must support {@link CdfModelIdentifier}.
+     *
+     * This cannot be used together with {@link _localModels}.
+     */
+    customDataSource?: DataSource;
+    /**
+     * Allows for controlling if geometry streaming should be halted when
+     * the camera is moving. Note that this option should left to false on
+     * low-end devices as more loading can cause frame drops.
+     *
+     * Default value is set to false.
+     */
+    continuousModelStreaming?: boolean;
+}
+/**
+ * @module @cognite/reveal
+ */
+export interface AddModelOptions {
+    modelId: number;
+    revisionId: number;
+    localPath?: string;
+    geometryFilter?: GeometryFilter;
+}
+export declare type CadIntersection = {
+    /**
+     * The intersection type.
+     */
+    type: 'cad';
+    /**
+     * The model that was intersected.
+     */
+    model: Cognite3DModel;
+    /**
+     * Coordinate of the intersection.
+     */
+    point: THREE.Vector3;
+    /**
+     * Tree index of the intersected 3D node.
+     */
+    treeIndex: number;
+    /**
+     * Distance from the camera to the intersection.
+     */
+    distanceToCamera: number;
+};
+/**
+ * Represents the result from {@link Cognite3DViewer.getIntersectionFromPixel}.
+ * @module @cognite/reveal
+ */
+export declare type Intersection = CadIntersection | PointCloudIntersection;
+/**
+ * @module @cognite/reveal
+ */
+export { CameraConfiguration } from '../../../../utilities';
+export { CadModelBudget, PointCloudBudget };
+/**
+ * Options to control how {@link Cognite3DViewer.getIntersectionFromPixel} behaves.
+ * @deprecated Since 3.1 these options have no effect.
+ */
+export interface IntersectionFromPixelOptions {
+    /**
+     * Threshold (in meters) for how close a point must be an intersection
+     * ray for it to be considered an intersection for point clouds. Defaults
+     * to 0.05.
+     * @deprecated Since 3.1, threshold doesn't affect picking because of new, GPU based method.
+     */
+    pointIntersectionThreshold?: number;
+}

package/{core → packages/api}/src/public/types.d.ts

@@ -1,25 +1,31 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { LoadingState } from '../../../packages/model-base';
-import { RenderOptions } from '../../../packages/rendering';
-import { InternalRevealCadOptions } from '../../../packages/cad-model';
-/**
- * @property logMetrics Might be used to disable usage statistics.
- * @property nodeAppearanceProvider Style node by tree-index.
- * @property internal Internals are for internal usage only (like unit-testing).
- */
-export declare type RevealOptions = {
-    logMetrics?: boolean;
-    renderOptions?: RenderOptions;
-    continuousModelStreaming?: boolean;
-    internal?: {
-        cad?: InternalRevealCadOptions;
-    };
-};
-/**
- * Handler for events about data being loaded.
- */
-export declare type LoadingStateChangeListener = (loadingState: LoadingState) => any;
-export { PotreePointShape, PotreePointColorType, PotreePointSizeType, WellKnownAsprsPointClassCodes } from '../../../packages/pointclouds';
-export * from './migration/types';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { LoadingState } from '../../../model-base';
+import { RenderOptions } from '../../../rendering';
+import { InternalRevealCadOptions } from '../../../cad-geometry-loaders';
+/**
+ * @property logMetrics Might be used to disable usage statistics.
+ * @property nodeAppearanceProvider Style node by tree-index.
+ * @property internal Internals are for internal usage only (like unit-testing).
+ */
+export declare type RevealOptions = {
+    logMetrics?: boolean;
+    renderOptions?: RenderOptions;
+    continuousModelStreaming?: boolean;
+    outputRenderTarget?: {
+        target: THREE.WebGLRenderTarget;
+        autoSize?: boolean;
+    };
+    rendererResolutionThreshold?: number;
+    internal?: {
+        cad?: InternalRevealCadOptions;
+    };
+};
+/**
+ * Handler for events about data being loaded.
+ */
+export declare type LoadingStateChangeListener = (loadingState: LoadingState) => any;
+export { PotreePointShape, PotreePointColorType, PotreePointSizeType, WellKnownAsprsPointClassCodes } from '../../../pointclouds';
+export * from './migration/types';

package/{core → packages/api}/src/storage/RevealManagerHelper.d.ts

@@ -1,59 +1,61 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { AddModelOptions } from '../public/migration/types';
-import { RevealOptions } from '../public/types';
-import { PointCloudNode, RevealManager } from '../internals';
-import { DataSource } from '../../../packages/data-source';
-import { CadNode } from '../../../packages/rendering';
-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;
-    static createCustomDataSourceHelper(renderer: THREE.WebGLRenderer, scene: THREE.Scene, revealOptions: RevealOptions, dataSource: DataSource): RevealManagerHelper;
-    get revealManager(): RevealManager;
-    /**
-     * 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;
-    private static addLocalPointCloudModel;
-    /**
-     * Add a CDF hosted point cloud model.
-     * @param model
-     * @param revealManager
-     */
-    private static addCdfPointCloudModel;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { AddModelOptions } from '../public/migration/types';
+import { RevealManager } from '../public/RevealManager';
+import { RevealOptions } from '../public/types';
+import { DataSource } from '../../../data-source';
+import { SceneHandler } from '../../../utilities';
+import { CogniteClient } from '@cognite/sdk';
+import { CadNode } from '../../../cad-model';
+import { PointCloudNode } from '../../../pointclouds';
+/**
+ * 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 sceneHandler
+     * @param revealOptions
+     */
+    static createLocalHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions: RevealOptions): RevealManagerHelper;
+    /**
+     * Creates a helper for RevealManager that loads models from CDF.
+     * @param renderer
+     * @param sceneHandler
+     * @param revealOptions
+     * @param sdkClient
+     */
+    static createCdfHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions: RevealOptions, sdkClient: CogniteClient): RevealManagerHelper;
+    static createCustomDataSourceHelper(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions: RevealOptions, dataSource: DataSource): RevealManagerHelper;
+    get revealManager(): RevealManager;
+    /**
+     * 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;
+    private static addLocalPointCloudModel;
+    /**
+     * Add a CDF hosted point cloud model.
+     * @param model
+     * @param revealManager
+     */
+    private static addCdfPointCloudModel;
+}

package/{core → packages/api}/src/utilities/Spinner.d.ts

@@ -1,27 +1,27 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export declare type Corner = 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
-export declare class Spinner {
-    private static readonly stylesId;
-    private static readonly classnames;
-    private static readonly titles;
-    private _loading;
-    private static loadStyles;
-    private readonly el;
-    constructor(parent: HTMLElement);
-    set placement(placement: Corner);
-    set opacity(fractionOpacity: number);
-    get loading(): boolean;
-    set loading(loadingState: boolean);
-    /**
-     * Pass background cover of the viewer to adjust Logo color
-     * @param color
-     * @param color.r 0..1 red
-     * @param color.g 0..1 green
-     * @param color.b 0..1 blue
-     */
-    updateBackgroundColor(color: Pick<THREE.Color, 'getHSL'>): void;
-    dispose(): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export declare type Corner = 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
+export declare class Spinner {
+    private static readonly stylesId;
+    private static readonly classnames;
+    private static readonly titles;
+    private _loading;
+    private static loadStyles;
+    private readonly el;
+    constructor(parent: HTMLElement);
+    set placement(placement: Corner);
+    set opacity(fractionOpacity: number);
+    get loading(): boolean;
+    set loading(loadingState: boolean);
+    /**
+     * Pass background cover of the viewer to adjust Logo color
+     * @param color
+     * @param color.r 0..1 red
+     * @param color.g 0..1 green
+     * @param color.b 0..1 blue
+     */
+    updateBackgroundColor(color: Pick<THREE.Color, 'getHSL'>): void;
+    dispose(): void;
+}