@cognite/reveal 4.0.0-dev.20221220 → 4.0.0-dev.20221222

package/dist/packages/api/src/public/RevealManager.d.ts

@@ -8,7 +8,7 @@ import { PointCloudManager, PointCloudNode } from '../../../pointclouds';
 import { LoadingState } from '../../../model-base';
 import { CadManager, CadModelBudget } from '../../../cad-geometry-loaders';
 import { NodeAppearanceProvider } from '../../../cad-styling';
-import { RenderMode, RenderPipelineExecutor, CadMaterialManager, RenderPipelineProvider } from '../../../rendering';
+import { RenderMode, RenderPipelineExecutor, CadMaterialManager, RenderPipelineProvider, ResizeHandler } from '../../../rendering';
 import { CameraManager } from '../../../camera-manager';
 import { ModelIdentifier } from '../../../data-providers';
 export type AddCadModelOptions = {
@@ -24,6 +24,7 @@ export declare class RevealManager {
     private readonly _pointCloudManager;
     private readonly _pipelineExecutor;
     private readonly _renderPipeline;
+    private readonly _resizeHandler;
     private _cameraInMotion;
     private _isDisposed;
     private readonly _subscriptions;
@@ -32,7 +33,7 @@ export declare class RevealManager {
     private readonly _cameraManager;
     private readonly _onCameraChange;
     private readonly _onCameraStop;
-    constructor(cadManager: CadManager, pointCloudManager: PointCloudManager, pipelineExecutor: RenderPipelineExecutor, renderPipeline: RenderPipelineProvider, cameraManager: CameraManager);
+    constructor(cadManager: CadManager, pointCloudManager: PointCloudManager, pipelineExecutor: RenderPipelineExecutor, renderPipeline: RenderPipelineProvider, resizeHandler: ResizeHandler, cameraManager: CameraManager);
     dispose(): void;
     requestRedraw(): void;
     resetRedraw(): void;
@@ -50,6 +51,8 @@ export declare class RevealManager {
     get clippingPlanes(): THREE.Plane[];
     on(event: 'loadingStateChanged', listener: LoadingStateChangeListener): void;
     off(event: 'loadingStateChanged', listener: LoadingStateChangeListener): void;
+    setResolutionThreshold(threshold: number): void;
+    setMovingCameraResolutionFactor(factor: number): void;
     render(camera: THREE.PerspectiveCamera): void;
     addModel(type: 'cad', modelIdentifier: ModelIdentifier, options?: AddCadModelOptions): Promise<CadNode>;
     addModel(type: 'pointcloud', modelIdentifier: ModelIdentifier): Promise<PointCloudNode>;

package/dist/packages/api/src/public/RevealOptions.d.ts

@@ -6,7 +6,8 @@ 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 movingCameraResolutionFactor Factor with which the resolution (number of screen pixels) is scaled
+ * when camera is moving.
  * @property internal Internals are for internal usage only (like unit-testing).
  */
 export type RevealOptions = {

package/dist/packages/api/src/public/migration/Cognite3DViewer.d.ts

@@ -5,7 +5,7 @@ import * as THREE from 'three';
 import { PointerEventDelegate, SceneRenderedDelegate, DisposedDelegate, BeforeSceneRenderedDelegate } from '../../../../utilities';
 import { CogniteCadModel } from '../../../../cad-model';
 import { PointCloudBudget, CognitePointCloudModel } from '../../../../pointclouds';
-import { AddImage360Options, AddModelOptions, Cognite3DViewerOptions, Intersection, CadModelBudget } from './types';
+import { AddImage360Options, AddModelOptions, Cognite3DViewerOptions, Intersection, CadModelBudget, ResolutionOptions } from './types';
 import { CogniteModel } from '../types';
 import { ViewerState } from '../../utilities/ViewStateHelper';
 import { CameraManager, CameraChangeDelegate } from '../../../../camera-manager';
@@ -91,6 +91,12 @@ export declare class Cognite3DViewer {
      */
     get models(): CogniteModel[];
     constructor(options: Cognite3DViewerOptions);
+    /**
+     * Set options to control resolution of the viewer. This includes
+     * settings for max resolution and limiting resolution when moving the camera.
+     * @param options Options to apply.
+     */
+    setResolutionOptions(options: ResolutionOptions): void;
     /**
      * Returns reveal version installed.
      */

package/dist/packages/api/src/public/migration/types.d.ts

@@ -69,6 +69,8 @@ export interface Cognite3DViewerOptions {
      * 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.
+     *
+     * @deprecated Use {@link Cognite3DViewer.setResolutionOptions} instead.
      */
     rendererResolutionThreshold?: number;
     /**
@@ -175,6 +177,29 @@ export type CadIntersection = {
      */
     distanceToCamera: number;
 };
+/**
+ * Options to control resolution of the viewer. This includes
+ * settings for max resolution and limiting resolution when moving the camera.
+ *
+ * @module @cognite/reveal
+ */
+export type ResolutionOptions = {
+    /**
+     * 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. The `maxRenderResolution` option will
+     * directly control this upper limit. It corresponds to the number of pixels in the render target.
+     */
+    maxRenderResolution?: number;
+    /**
+     * A factor that will scale down the resolution when moving the camera. This can
+     * be used to achieve a better user experience on devices with limited hardware.
+     * Values must be greater than 0 and at most 1.
+     * A value of e.g. 0.25 will approximately divide the number of pixels on the screen by four.
+     */
+    movingCameraResolutionFactor?: number;
+};
 /**
  * Represents the result from {@link Cognite3DViewer.getIntersectionFromPixel}.
  * @module @cognite/reveal

package/dist/packages/cad-geometry-loaders/src/sector/culling/ByScreenSizeSectorCuller.d.ts

@@ -3,13 +3,13 @@
  */
 import { DetermineSectorCostDelegate, DetermineSectorsInput, SectorLoadingSpent } from './types';
 import { SectorCuller } from './SectorCuller';
-import { V9SectorMetadata, WantedSector } from '../../../../cad-parsers';
+import { SectorMetadata, WantedSector } from '../../../../cad-parsers';
 export type ByScreenSizeSectorCullerOptions = {
     /**
      * Optional callback for determining the cost of a sector. The default unit of the cost
      * function is bytes downloaded.
      */
-    determineSectorCost?: DetermineSectorCostDelegate<V9SectorMetadata>;
+    determineSectorCost?: DetermineSectorCostDelegate<SectorMetadata>;
 };
 export declare class ByScreenSizeSectorCuller implements SectorCuller {
     private readonly _determineSectorCost;

package/dist/packages/cad-geometry-loaders/src/sector/culling/WeightFunctionsHelper.d.ts

@@ -2,7 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 import * as THREE from 'three';
-import { SectorMetadata, V9SectorMetadata } from '../../../../cad-parsers';
+import { SectorMetadata } from '../../../../cad-parsers';
 import { PrioritizedArea } from '../../../../cad-styling';
 export declare class WeightFunctionsHelper {
     private readonly _camera;
@@ -35,7 +35,7 @@ export declare class WeightFunctionsHelper {
      * sectors right below root sector.
      * @param sector
      */
-    computeSectorTreePlacementWeight(sector: V9SectorMetadata): number;
+    computeSectorTreePlacementWeight(sector: SectorMetadata): number;
     /**
      * Computes a weight based on how large the biggest node within the sector
      * will be on screen (a number in range [0-1]).

package/dist/packages/cad-geometry-loaders/src/sector/culling/takensectors/TakenV9SectorMap.d.ts

@@ -4,14 +4,14 @@
 import { DetermineSectorCostDelegate, PrioritizedWantedSector, SectorCost } from '../types';
 import { CadModelBudget } from '../../../CadModelBudget';
 import { TakenSectorMapBase } from './TakenSectorMapBase';
-import { CadModelMetadata, V9SectorMetadata } from '../../../../../cad-parsers';
+import { CadModelMetadata, SectorMetadata } from '../../../../../cad-parsers';
 export declare class TakenV9SectorMap extends TakenSectorMapBase {
     private readonly determineSectorCost;
     private readonly _totalCost;
     private readonly _models;
     get totalCost(): SectorCost;
     get modelsMetadata(): CadModelMetadata[];
-    constructor(determineSectorCost: DetermineSectorCostDelegate<V9SectorMetadata>);
+    constructor(determineSectorCost: DetermineSectorCostDelegate<SectorMetadata>);
     initializeScene(modelMetadata: CadModelMetadata): void;
     markSectorDetailed(model: CadModelMetadata, sectorId: number, priority: number): void;
     isWithinBudget(budget: CadModelBudget): boolean;

package/dist/packages/cad-parsers/index.d.ts

@@ -6,7 +6,7 @@ export { CadModelMetadata } from './src/metadata/CadModelMetadata';
 export { SectorSceneFactory } from './src/utilities/SectorSceneFactory';
 export { CadModelClipper } from './src/metadata/CadModelClipper';
 export { SectorScene } from './src/utilities/types';
-export { SectorMetadata, V9SectorMetadata } from './src/metadata/types';
+export { SectorMetadata } from './src/metadata/types';
 export { SectorNode } from './src/sector/SectorNode';
 export { RootSectorNode } from './src/sector/RootSectorNode';
 export { LevelOfDetail } from './src/cad/LevelOfDetail';

package/dist/packages/cad-parsers/src/metadata/parsers/types.d.ts

@@ -7,9 +7,6 @@ export type CadSceneRootMetadata = {
     readonly sectors: SceneSectorMetadata[];
     readonly unit: string | null;
 };
-export type SceneSectorMetadata = BaseSceneSectorMetadata & (GltfSceneSectorMetadata | I3dF3dSceneSectorMetadata);
-export type V8SceneSectorMetadata = BaseSceneSectorMetadata & I3dF3dSceneSectorMetadata;
-export type V9SceneSectorMetadata = BaseSceneSectorMetadata & GltfSceneSectorMetadata;
 export type BoundingBox = {
     readonly min: {
         x: number;
@@ -22,7 +19,7 @@ export type BoundingBox = {
         z: number;
     };
 };
-export type BaseSceneSectorMetadata = {
+export type SceneSectorMetadata = {
     readonly id: number;
     readonly parentId: number | null;
     readonly path: string;
@@ -31,32 +28,8 @@ export type BaseSceneSectorMetadata = {
     readonly estimatedTriangleCount: number;
     readonly boundingBox: BoundingBox;
     readonly geometryBoundingBox?: BoundingBox;
-};
-export type GltfSceneSectorMetadata = {
     readonly sectorFileName: string | null;
     readonly maxDiagonalLength: number;
     readonly minDiagonalLength: number;
     readonly downloadSize: number;
 };
-export type I3dF3dSceneSectorMetadata = {
-    readonly indexFile: {
-        readonly fileName: string;
-        readonly peripheralFiles: string[];
-        readonly downloadSize: number;
-    };
-    readonly facesFile: {
-        readonly quadSize: number;
-        readonly coverageFactors: {
-            xy: number;
-            yz: number;
-            xz: number;
-        };
-        readonly recursiveCoverageFactors: {
-            xy: number;
-            yz: number;
-            xz: number;
-        } | undefined;
-        readonly fileName: string | null;
-        readonly downloadSize: number;
-    } | null;
-};

package/dist/packages/cad-parsers/src/metadata/types.d.ts

@@ -2,33 +2,7 @@
  * Copyright 2021 Cognite AS
  */
 import * as THREE from 'three';
-export interface SectorMetadataIndexFileSection {
-    readonly fileName: string;
-    readonly peripheralFiles: string[];
-    readonly downloadSize: number;
-}
-export interface SectorMetadataFacesFileSection {
-    readonly quadSize: number;
-    /**
-     * Coverage factors for the sector without children.
-     */
-    readonly coverageFactors: {
-        xy: number;
-        yz: number;
-        xz: number;
-    };
-    /**
-     * Coverage factor for the sectors including children.
-     */
-    readonly recursiveCoverageFactors: {
-        xy: number;
-        yz: number;
-        xz: number;
-    };
-    readonly fileName: string | null;
-    readonly downloadSize: number;
-}
-export type BaseSectorMetadata = {
+export type SectorMetadata = {
     readonly id: number;
     readonly path: string;
     readonly depth: number;
@@ -36,14 +10,6 @@ export type BaseSectorMetadata = {
     readonly children: SectorMetadata[];
     readonly estimatedDrawCallCount: number;
     readonly estimatedRenderCost: number;
-};
-export type SectorMetadata = BaseSectorMetadata & (I3dF3dSectorMetadata | GltfSectorMetadata);
-export type V9SectorMetadata = BaseSectorMetadata & GltfSectorMetadata;
-export type I3dF3dSectorMetadata = {
-    readonly indexFile: SectorMetadataIndexFileSection;
-    readonly facesFile: SectorMetadataFacesFileSection;
-};
-export type GltfSectorMetadata = {
     readonly sectorFileName: string | null;
     readonly maxDiagonalLength: number;
     readonly minDiagonalLength: number;

package/dist/packages/pointclouds/src/potree-three-loader/Potree.d.ts

@@ -18,11 +18,13 @@ export declare class Potree implements IPotree {
     private readonly _modelDataProvider;
     private readonly _materialManager;
     private readonly _throttledUpdateFunc;
+    private _shouldLoad;
     maxNumNodesLoading: number;
     lru: LRU;
     constructor(modelDataProvider: ModelDataProvider, pointCloudMaterialManager: PointCloudMaterialManager);
     loadPointCloud(baseUrl: string, fileName: string, pointCloudObjects: PointCloudObject[], modelIdentifier: symbol): Promise<PointCloudOctree>;
     updatePointClouds(pointClouds: PointCloudOctree[], camera: Camera, renderer: WebGLRenderer): void;
+    set shouldLoad(value: boolean);
     private innerUpdatePointClouds;
     get pointBudget(): number;
     set pointBudget(value: number);

package/dist/packages/rendering/index.d.ts

@@ -20,3 +20,4 @@ export { CadGeometryRenderModePipelineProvider } from './src/render-pipeline-pro
 export { BasicPipelineExecutor } from './src/pipeline-executors/BasicPipelineExecutor';
 export { RenderPipelineExecutor } from './src/RenderPipelineExecutor';
 export { RenderPipelineProvider } from './src/RenderPipelineProvider';
+export { ResizeHandler } from './src/ResizeHandler';

package/dist/packages/rendering/src/ResizeHandler.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { WebGLRenderer, PerspectiveCamera } from 'three';
+import { CameraManager } from '../../camera-manager';
+export type ResizeHandlerOptions = {
+    renderResolutionThreshold?: number;
+};
+export declare class ResizeHandler {
+    private readonly _defaultResolutionThreshold;
+    private readonly _renderer;
+    private readonly _cameraManager;
+    private _stoppedCameraResolutionThreshold;
+    private _currentResolutionThreshold;
+    private _movingResolutionFactor;
+    private readonly _onCameraChangeCallback;
+    private readonly _onCameraStopCallback;
+    private readonly _resizeObserver;
+    private _shouldResize;
+    constructor(renderer: WebGLRenderer, cameraManager: CameraManager, resizeOptions?: ResizeHandlerOptions);
+    get needsRedraw(): boolean;
+    resetRedraw(): void;
+    setResolutionThreshold(threshold: number): void;
+    setMovingCameraResolutionFactor(factor: number): void;
+    handleResize(camera: PerspectiveCamera): void;
+    private setupResizeListener;
+    private resize;
+    dispose(): void;
+}

package/dist/packages/rendering/src/pipeline-executors/BasicPipelineExecutor.d.ts

@@ -4,19 +4,9 @@
 import * as THREE from 'three';
 import { RenderPipelineExecutor } from '../RenderPipelineExecutor';
 import { RenderPipelineProvider } from '../RenderPipelineProvider';
-export type BasicPipelineExecutorOptions = {
-    autoResizeRenderer: boolean;
-    resolutionThreshold?: number;
-};
 export declare class BasicPipelineExecutor implements RenderPipelineExecutor {
-    private readonly _defaultResolutionThreshold;
     private readonly _renderer;
-    private readonly _resolutionThreshold;
-    private readonly _resizeObserver;
-    private _shouldResize;
-    constructor(renderer: THREE.WebGLRenderer, options?: BasicPipelineExecutorOptions);
+    constructor(renderer: THREE.WebGLRenderer);
     render(renderPipeline: RenderPipelineProvider, camera: THREE.PerspectiveCamera): void;
-    private setupResizeListener;
-    private resize;
     dispose(): void;
 }

package/dist/packages/rendering/src/pointcloud-rendering/PointCloudMaterial.d.ts

@@ -39,7 +39,6 @@ export interface IPointCloudMaterialUniforms {
 }
 export declare class PointCloudMaterial extends RawShaderMaterial {
     private static readonly helperVec3;
-    private static readonly helperVec2;
     /**
      * Use the drawing buffer size instead of the dom client width and height when passing the screen height and screen width uniforms to the
      * shader. This is useful if you have offscreen canvases (which in some browsers return 0 as client width and client height).
@@ -115,7 +114,7 @@ export declare class PointCloudMaterial extends RawShaderMaterial {
     set elevationRange(value: [number, number]);
     getUniform<K extends keyof IPointCloudMaterialUniforms>(name: K): IPointCloudMaterialUniforms[K]['value'];
     setUniform<K extends keyof IPointCloudMaterialUniforms>(name: K, value: IPointCloudMaterialUniforms[K]['value']): void;
-    onBeforeRender(): void;
-    updateMaterial(octreeParams: OctreeMaterialParams, visibilityTextureData: Uint8Array, camera: Camera, renderer: WebGLRenderer): void;
+    onBeforeRender(renderer: WebGLRenderer): void;
+    updateMaterial(octreeParams: OctreeMaterialParams, visibilityTextureData: Uint8Array, camera: Camera): void;
     private updateVisibilityTextureData;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.0.0-dev.20221220",
+  "version": "4.0.0-dev.20221222",
   "description": "WebGL based 3D viewer for CAD and point clouds processed in Cognite Data Fusion.",
   "homepage": "https://github.com/cognitedata/reveal/tree/master/viewer",
   "repository": {
@@ -80,7 +80,7 @@
     "mixpanel-browser": "2.45.0",
     "path-browserify": "1.0.1",
     "proj4": "2.8.0",
-    "rxjs": "7.6.0",
+    "rxjs": "7.8.0",
     "skmeans": "0.11.3",
     "three-stdlib": "2.20.4"
   },
@@ -93,7 +93,7 @@
     "@types/glob": "8.0.0",
     "@types/jest": "29.2.4",
     "@types/jest-environment-puppeteer": "5.0.3",
-    "@types/jest-image-snapshot": "5.1.0",
+    "@types/jest-image-snapshot": "6.1.0",
     "@types/jsdom": "20.0.1",
     "@types/lodash": "4.14.191",
     "@types/mixpanel-browser": "2.38.0",
@@ -132,7 +132,7 @@
     "nock": "13.2.9",
     "prettier": "2.8.1",
     "process": "0.11.10",
-    "puppeteer": "19.4.0",
+    "puppeteer": "19.4.1",
     "random-seed": "0.3.0",
     "raw-loader": "4.0.2",
     "remove-files-webpack-plugin": "1.5.0",