@cognite/reveal 3.1.0 → 4.0.0-dev.20221025

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognite/reveal",
-	"version": "3.1.0",
+	"version": "4.0.0-dev.20221025",
 	"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": {
@@ -19,26 +19,26 @@
 	"main": "index.js",
 	"types": "index.d.ts",
 	"dependencies": {
-		"@cognite/reveal-parser-worker": "1.3.0",
 		"@tweenjs/tween.js": "18.6.4",
 		"@types/draco3dgltf": "1.4.0",
-		"@types/geojson": "7946.0.8",
-		"@types/three": "0.140.0",
+		"@types/three": "0.144.0",
 		"assert": "2.0.0",
+		"async-mutex": "0.4.0",
 		"comlink": "4.3.1",
-		"geo-three": "0.0.17",
 		"glslify": "7.1.1",
 		"glslify-import": "3.1.0",
 		"lodash": "4.17.21",
 		"loglevel": "1.8.0",
 		"mixpanel-browser": "2.45.0",
-		"proj4": "^2.8.0",
-		"rxjs": "7.5.5",
+		"path-browserify": "1.0.1",
+		"proj4": "2.8.0",
+		"rxjs": "7.5.7",
 		"skmeans": "0.11.3",
-		"three": "0.140.2"
+		"three": "0.144.0",
+		"three-stdlib": "2.17.3"
 	},
 	"peerDependencies": {
-		"@cognite/sdk": "^5.0.0 || ^6.0.0 || ^7.0.0",
+		"@cognite/sdk": "^7.7.0",
 		"@cognite/sdk-core": "^4.1.0"
 	},
 	"glslify": {

package/packages/360-images/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export { Image360Facade } from './src/Image360Facade';
+export { Image360EntityFactory } from './src/Image360EntityFactory';
+export { Image360Entity } from './src/Image360Entity';

package/packages/360-images/src/Image360Entity.d.ts

@@ -0,0 +1,44 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { SceneHandler } from '../../utilities';
+import { Image360Descriptor, Image360FileProvider } from '../../data-providers';
+import { Image360Icon } from './Image360Icon';
+export declare class Image360Entity {
+    private readonly _imageProvider;
+    private readonly _image360Metadata;
+    private readonly _sceneHandler;
+    private readonly _transform;
+    private readonly _image360Icon;
+    private _faceMaterials;
+    private _imageContainer;
+    /**
+     * Get the model-to-world transformation matrix
+     * of the given 360 image.
+     * @returns model-to-world transform of the 360 Image
+     */
+    get transform(): THREE.Matrix4;
+    /**
+     * Get the icon that represents the 360
+     * image during normal visualization.
+     * @returns Image360Icon
+     */
+    get icon(): Image360Icon;
+    /**
+     * Sets the opacity of this 360 image.
+     */
+    set opacity(alpha: number);
+    constructor(image360Metadata: Image360Descriptor, sceneHandler: SceneHandler, imageProvider: Image360FileProvider, postTransform: THREE.Matrix4, preComputedRotation: boolean);
+    /**
+     * Enables a unit inverted cube which contains the 360 image.
+     */
+    activate360Image(): Promise<void>;
+    /**
+     * Disables the unit inverted cube which contains the 360 image.
+     */
+    deactivate360Image(): Promise<void>;
+    private load360Image;
+    private createImage360VisualizationObject;
+    private computeTransform;
+}

package/packages/360-images/src/Image360EntityFactory.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { Image360Entity } from './Image360Entity';
+import { SceneHandler } from '../../utilities';
+import { Image360Provider } from '../../data-providers';
+export declare class Image360EntityFactory<T> {
+    private readonly _sceneHandler;
+    private readonly _image360DataProvider;
+    constructor(image360DataProvider: Image360Provider<T>, sceneHandler: SceneHandler);
+    create(dataProviderFilter: T, postTransform: THREE.Matrix4, preMultipliedRotation: boolean): Promise<Image360Entity[]>;
+}

package/packages/360-images/src/Image360Facade.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { Image360Entity } from './Image360Entity';
+import { Image360EntityFactory } from './Image360EntityFactory';
+export declare class Image360Facade<T> {
+    private readonly _entityFactory;
+    private readonly _image360Entities;
+    private readonly _rayCaster;
+    set allIconsVisibility(visible: boolean);
+    set allHoverIconsVisibility(visible: boolean);
+    constructor(entityFactory: Image360EntityFactory<T>);
+    create(dataProviderFilter: T, postTransform?: THREE.Matrix4, preComputedRotation?: boolean): Promise<Image360Entity[]>;
+    delete(entity: Image360Entity): void;
+    intersect(coords: {
+        x: number;
+        y: number;
+    }, camera: THREE.Camera): Image360Entity | undefined;
+}

package/packages/360-images/src/Image360Icon.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+export declare class Image360Icon extends THREE.Group {
+    private readonly MIN_PIXEL_SIZE;
+    private readonly MAX_PIXEL_SIZE;
+    private readonly _hoverSprite;
+    private readonly _outerSprite;
+    constructor(modelToWorldTransform: THREE.Matrix4);
+    set hoverSpriteVisible(visible: boolean);
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection<THREE.Object3D<THREE.Event>>[]): void;
+    private setupAdaptiveScaling;
+    private createOuterRingsSprite;
+    private createHoverSprite;
+}

package/packages/api/index.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export { Cognite3DViewer } from './src/public/migration/Cognite3DViewer';
+export { Cognite3DModel } from '../cad-model';
+export { ViewerState, ModelState } from './src/utilities/ViewStateHelper';
+export * from './src/public/types';
+import * as THREE from 'three';
+export { THREE };
+declare const REVEAL_VERSION: string;
+export { REVEAL_VERSION };

package/packages/api/src/api-helpers/Image360ApiHelper.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { CogniteClient } from '@cognite/sdk';
+import { Image360Entity } from '../../../360-images';
+import { SceneHandler } from '../../../utilities';
+import { ProxyCameraManager } from '../../../camera-manager';
+export declare class Image360ApiHelper {
+    private readonly _image360Facade;
+    private readonly _domElement;
+    private readonly _interactionState;
+    private readonly _domEventHandlers;
+    private readonly _requestRedraw;
+    private readonly _activeCameraManager;
+    private readonly _image360Navigation;
+    private _cachedCameraManager;
+    constructor(cogniteClient: CogniteClient, sceneHandler: SceneHandler, domElement: HTMLElement, activeCameraManager: ProxyCameraManager, requestRedraw: () => void);
+    add360ImageSet(eventFilter: {
+        [key: string]: string;
+    }, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean): Promise<Image360Entity[]>;
+    enter360Image(image360Entity: Image360Entity): Promise<void>;
+    exit360Image(): void;
+    dispose(): void;
+    private enter360ImageOnIntersect;
+    private setHoverIconOnIntersect;
+    private exit360ImageOnEscape;
+}

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

@@ -1,52 +1,51 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { LoadingStateChangeListener, PointCloudBudget } from './types';
-import { GeometryFilter, CadModelSectorLoadStatistics, CadNode } from '../../../packages/cad-model';
-import { PointCloudManager, PointCloudNode } from '../../../packages/pointclouds';
-import { CadManager, CadModelBudget } from '../../../packages/cad-geometry-loaders';
-import { NodeAppearanceProvider } from '../../../packages/cad-styling';
-import { RenderMode, RenderPipelineExecutor, CadMaterialManager, RenderPipelineProvider } from '../../../packages/rendering';
-import { ModelIdentifier } from '../../../packages/modeldata-api';
-export declare type AddCadModelOptions = {
-    nodeAppearanceProvider?: NodeAppearanceProvider;
-    geometryFilter?: GeometryFilter;
-};
-export declare class RevealManager {
-    private readonly _cadManager;
-    private readonly _pointCloudManager;
-    private readonly _pipelineExecutor;
-    private readonly _renderPipeline;
-    private readonly _lastCamera;
-    private _isDisposed;
-    private readonly _subscriptions;
-    private readonly _events;
-    private readonly _updateSubject;
-    private readonly _materialManager;
-    constructor(cadManager: CadManager, pointCloudManager: PointCloudManager, pipelineExecutor: RenderPipelineExecutor, renderPipeline: RenderPipelineProvider, materialManager: CadMaterialManager);
-    dispose(): void;
-    requestRedraw(): void;
-    resetRedraw(): void;
-    get materialManager(): CadMaterialManager;
-    get needsRedraw(): boolean;
-    update(camera: THREE.PerspectiveCamera): void;
-    get cadBudget(): CadModelBudget;
-    set cadBudget(budget: CadModelBudget);
-    get cadLoadedStatistics(): CadModelSectorLoadStatistics;
-    get cadRenderMode(): RenderMode;
-    set cadRenderMode(renderMode: RenderMode);
-    get pointCloudBudget(): PointCloudBudget;
-    set pointCloudBudget(budget: PointCloudBudget);
-    set clippingPlanes(clippingPlanes: THREE.Plane[]);
-    get clippingPlanes(): THREE.Plane[];
-    on(event: 'loadingStateChanged', listener: LoadingStateChangeListener): void;
-    off(event: 'loadingStateChanged', listener: LoadingStateChangeListener): void;
-    render(camera: THREE.PerspectiveCamera): void;
-    addModel(type: 'cad', modelIdentifier: ModelIdentifier, options?: AddCadModelOptions): Promise<CadNode>;
-    addModel(type: 'pointcloud', modelIdentifier: ModelIdentifier): Promise<PointCloudNode>;
-    removeModel(type: 'cad', model: CadNode): void;
-    removeModel(type: 'pointcloud', model: PointCloudNode): void;
-    private notifyLoadingStateChanged;
-    private initLoadingStateObserver;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { LoadingStateChangeListener, PointCloudBudget } from './types';
+import { GeometryFilter, CadModelSectorLoadStatistics, CadNode } from '../../../cad-model';
+import { PointCloudManager, PointCloudNode } from '../../../pointclouds';
+import { CadManager, CadModelBudget } from '../../../cad-geometry-loaders';
+import { NodeAppearanceProvider } from '../../../cad-styling';
+import { RenderMode, RenderPipelineExecutor, CadMaterialManager, RenderPipelineProvider } from '../../../rendering';
+import { ModelIdentifier } from '../../../data-providers';
+export declare type AddCadModelOptions = {
+    nodeAppearanceProvider?: NodeAppearanceProvider;
+    geometryFilter?: GeometryFilter;
+};
+export declare class RevealManager {
+    private readonly _cadManager;
+    private readonly _pointCloudManager;
+    private readonly _pipelineExecutor;
+    private readonly _renderPipeline;
+    private readonly _lastCamera;
+    private _isDisposed;
+    private readonly _subscriptions;
+    private readonly _events;
+    private readonly _updateSubject;
+    constructor(cadManager: CadManager, pointCloudManager: PointCloudManager, pipelineExecutor: RenderPipelineExecutor, renderPipeline: RenderPipelineProvider);
+    dispose(): void;
+    requestRedraw(): void;
+    resetRedraw(): void;
+    get materialManager(): CadMaterialManager;
+    get needsRedraw(): boolean;
+    update(camera: THREE.PerspectiveCamera): void;
+    get cadBudget(): CadModelBudget;
+    set cadBudget(budget: CadModelBudget);
+    get cadLoadedStatistics(): CadModelSectorLoadStatistics;
+    get cadRenderMode(): RenderMode;
+    set cadRenderMode(renderMode: RenderMode);
+    get pointCloudBudget(): PointCloudBudget;
+    set pointCloudBudget(budget: PointCloudBudget);
+    set clippingPlanes(clippingPlanes: THREE.Plane[]);
+    get clippingPlanes(): THREE.Plane[];
+    on(event: 'loadingStateChanged', listener: LoadingStateChangeListener): void;
+    off(event: 'loadingStateChanged', listener: LoadingStateChangeListener): void;
+    render(camera: THREE.PerspectiveCamera): void;
+    addModel(type: 'cad', modelIdentifier: ModelIdentifier, options?: AddCadModelOptions): Promise<CadNode>;
+    addModel(type: 'pointcloud', modelIdentifier: ModelIdentifier): Promise<PointCloudNode>;
+    removeModel(type: 'cad', model: CadNode): void;
+    removeModel(type: 'pointcloud', model: PointCloudNode): void;
+    private notifyLoadingStateChanged;
+    private initLoadingStateObserver;
+}

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

@@ -1,24 +1,24 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { RevealOptions } from './types';
-import { RevealManager } from './RevealManager';
-import { CogniteClient } from '@cognite/sdk';
-import { SceneHandler } from '../../../packages/utilities';
-/**
- * Used to create an instance of reveal manager that works with localhost.
- * @param renderer
- * @param sceneHandler
- * @param revealOptions
- * @returns RevealManager instance.
- */
-export declare function createLocalRevealManager(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions?: RevealOptions): RevealManager;
-/**
- * Used to create an instance of reveal manager that works with the CDF.
- * @param client
- * @param renderer
- * @param sceneHandler
- * @param revealOptions
- */
-export declare function createCdfRevealManager(client: CogniteClient, renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions?: RevealOptions): RevealManager;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { RevealOptions } from './types';
+import { RevealManager } from './RevealManager';
+import { CogniteClient } from '@cognite/sdk';
+import { SceneHandler } from '../../../utilities';
+/**
+ * Used to create an instance of reveal manager that works with localhost.
+ * @param renderer
+ * @param sceneHandler
+ * @param revealOptions
+ * @returns RevealManager instance.
+ */
+export declare function createLocalRevealManager(renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions?: RevealOptions): RevealManager;
+/**
+ * Used to create an instance of reveal manager that works with the CDF.
+ * @param client
+ * @param renderer
+ * @param sceneHandler
+ * @param revealOptions
+ */
+export declare function createCdfRevealManager(client: CogniteClient, renderer: THREE.WebGLRenderer, sceneHandler: SceneHandler, revealOptions?: RevealOptions): RevealManager;