@cognite/reveal 4.0.0-dev.20221124 → 4.0.0-dev.20221128

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

@@ -4,3 +4,4 @@
 export { Image360Facade } from './src/Image360Facade';
 export { Image360EntityFactory } from './src/Image360EntityFactory';
 export { Image360Entity } from './src/Image360Entity';
+export { Image360Visualization } from './src/Image360Visualization';

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

@@ -5,16 +5,15 @@ import * as THREE from 'three';
 import { SceneHandler } from '../../utilities';
 import { Image360Descriptor, Image360FileProvider } from '../../data-providers';
 import { Image360Icon } from './Image360Icon';
+import { Image360Visualization } from './Image360Visualization';
 export declare class Image360Entity {
     private readonly _imageProvider;
     private readonly _image360Metadata;
-    private readonly _sceneHandler;
     private readonly _transform;
     private readonly _image360Icon;
-    private _faceMaterials;
-    private _imageContainer;
+    private readonly _image360VisualzationBox;
     /**
-     * Get the model-to-world transformation matrix
+     * Get a copy of the model-to-world transformation matrix
      * of the given 360 image.
      * @returns model-to-world transform of the 360 Image
      */
@@ -26,21 +25,23 @@ export declare class Image360Entity {
      */
     get icon(): Image360Icon;
     /**
-     * Sets the opacity of this 360 image.
+     * The object containing the unit cube with the 360 images.
+     * @returns Image360Visualization
      */
-    set opacity(alpha: number);
+    get image360Visualization(): Image360Visualization;
     constructor(image360Metadata: Image360Descriptor, sceneHandler: SceneHandler, imageProvider: Image360FileProvider, postTransform: THREE.Matrix4, preComputedRotation: boolean);
     /**
-     * Enables a unit inverted cube which contains the 360 image.
+     * Loads the 360 image (6 faces) into the visualization object.
      */
-    activate360Image(): Promise<void>;
+    load360Image(): Promise<void>;
     /**
-     * Disables the unit inverted cube which contains the 360 image.
+     * Drops the GPU resources for the 360 image
+     * the icon will be preserved.
      */
-    deactivate360Image(): Promise<void>;
-    load360Image(): Promise<void>;
-    unload360Image(): Promise<void>;
-    dispose(): Promise<void>;
-    private createImage360VisualizationObject;
+    unload360Image(): void;
+    /**
+     * @obvious
+     */
+    dispose(): void;
     private computeTransform;
 }

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

@@ -1,15 +1,18 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+import { SceneHandler } from '../../utilities';
 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);
+    private readonly _sceneHandler;
+    constructor(modelToWorldTransform: THREE.Matrix4, sceneHandler: SceneHandler);
     set hoverSpriteVisible(visible: boolean);
     raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection<THREE.Object3D<THREE.Event>>[]): void;
+    dispose(): void;
     private setupAdaptiveScaling;
     private createOuterRingsSprite;
     private createHoverSprite;

package/dist/packages/360-images/src/Image360LoadingCache.d.ts

@@ -7,7 +7,8 @@ export declare class Image360LoadingCache {
     private readonly _loaded360Images;
     private readonly _inFlightEntities;
     get cachedEntities(): Image360Entity[];
-    get currentlyLoadingEntities(): Set<Image360Entity>;
+    get currentlyLoadingEntities(): Map<Image360Entity, Promise<void>>;
     constructor(_cacheSize?: number);
     cachedPreload(entity: Image360Entity): Promise<void>;
+    purge(entity: Image360Entity): Promise<void>;
 }

package/dist/packages/360-images/src/Image360Visualization.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+export interface Image360Visualization {
+    /**
+     * Opaqueness of the 360 image
+     */
+    opacity: number;
+    /**
+     * Visibility of the 360 image
+     */
+    visible: boolean;
+    /**
+     * Scale of the box containing the 360 image
+     */
+    scale: THREE.Vector3;
+    /**
+     * Render order of the mesh containing the 360 image
+     */
+    renderOrder: number;
+}

package/dist/packages/360-images/src/Image360VisualizationBox.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import * as THREE from 'three';
+import { SceneHandler } from '../../utilities';
+import { Image360Face } from '../../data-providers';
+import { Image360Visualization } from './Image360Visualization';
+export declare class Image360VisualizationBox implements Image360Visualization {
+    private readonly _worldTransform;
+    private _visualizationMesh;
+    private _faceMaterials;
+    private readonly _sceneHandler;
+    private readonly _visualizationState;
+    set opacity(alpha: number);
+    set visible(isVisible: boolean);
+    set scale(newScale: THREE.Vector3);
+    set renderOrder(newRenderOrder: number);
+    constructor(worldTransform: THREE.Matrix4, sceneHandler: SceneHandler);
+    loadImages(faces: Image360Face[]): Promise<void>;
+    unloadImages(): void;
+}

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

@@ -9,6 +9,7 @@ import { ProxyCameraManager } from '../../../camera-manager';
 export declare class Image360ApiHelper {
     private readonly _image360Facade;
     private readonly _domElement;
+    private _transitionInProgress;
     private readonly _interactionState;
     private readonly _domEventHandlers;
     private readonly _requestRedraw;
@@ -19,7 +20,11 @@ export declare class Image360ApiHelper {
     add360ImageSet(eventFilter: {
         [key: string]: string;
     }, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean): Promise<Image360Entity[]>;
+    remove360Images(entities: Image360Entity[]): Promise<void>;
     enter360Image(image360Entity: Image360Entity): Promise<void>;
+    private transition;
+    private tweenVisualizationAlpha;
+    private set360CameraManager;
     exit360Image(): void;
     dispose(): void;
     private enter360ImageOnIntersect;

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

@@ -178,9 +178,8 @@ export declare class Cognite3DViewer {
     /**
      * Sets the active camera manager instance for current Cognite3Dviewer.
      * @param cameraManager Camera manager instance.
-     * @param preserveCameraState Whether to set current camera state to new camera manager.
      */
-    setCameraManager(cameraManager: CameraManager, preserveCameraState?: boolean): void;
+    setCameraManager(cameraManager: CameraManager): void;
     /**
      * Gets the current viewer state which includes the camera pose as well as applied styling.
      * @returns JSON object containing viewer state.
@@ -248,12 +247,17 @@ export declare class Cognite3DViewer {
      * @example
      * ```js
      * const eventFilter = { site_id: "12345" };
-     * await viewer.add360ImageSet(eventFilter);
+     * await viewer.add360ImageSet('events', eventFilter);
      * ```
      */
     add360ImageSet(datasource: 'events', eventFilter: {
         [key: string]: string;
     }, add360ImageOptions?: AddImage360Options): Promise<Image360Entity[]>;
+    /**
+     * Remove a set of 360 images.
+     * @param image360Entities
+     */
+    remove360Images(...image360Entities: Image360Entity[]): Promise<void>;
     /**
      * Enter visualization of a 360 image.
      * @param image360

package/dist/packages/cad-model/src/wrappers/CogniteCadModel.d.ts

@@ -25,6 +25,18 @@ export declare class CogniteCadModel implements CdfModelNodeCollectionDataProvid
      * return undefined if the model has been stored in an unsupported unit.
      */
     get modelUnitToMetersFactor(): number | undefined;
+    /**
+     * Sets the model visibility.
+     * @example
+     * ```js
+     * model.visible = false
+     * ```
+     */
+    set visible(value: boolean);
+    /**
+     * Returns the model visibility.
+     */
+    get visible(): boolean;
     /**
      * The CDF model ID of the model.
      */

package/dist/packages/camera-manager/src/CameraManager.d.ts

@@ -40,6 +40,21 @@ export interface CameraManager {
      * @returns Camera state: position, target and rotation.
      */
     getCameraState(): Required<CameraState>;
+    /**
+     * Set this manager as active and enable controls.
+     *
+     * Should update {@link CameraManager.enabled} to reflect the state of the manager.
+     * Note that this is called automatically when a new CameraManager is set on the {@link Cognite3DViewer}.
+     * @param cameraManager Previously used camera manager.
+     */
+    activate(cameraManager?: CameraManager): void;
+    /**
+     * Deactivate this manager and disable controls.
+     *
+     * Should update {@link CameraManager.enabled} to reflect the state of the manager.
+     * Note that this is called automatically when a new CameraManager is set on the {@link Cognite3DViewer}.
+     */
+    deactivate(): void;
     /**
      * Subscribes to changes of the camera event. This is used by Reveal to react on changes of the camera.
      * @param event Name of the event.
@@ -72,7 +87,7 @@ export interface CameraManager {
      */
     dispose(): void;
     /**
-     * Enables or disables camera manager. When disabled, camera manager shouldn't consume or react to any DOM events.
+     * Enabled is true if this camera manager is active. When disabled, the camera manager shouldn't consume or react to any DOM events.
      */
-    enabled?: boolean;
+    enabled: boolean;
 }

package/dist/packages/camera-manager/src/DefaultCameraManager.d.ts

@@ -19,7 +19,7 @@ export declare class DefaultCameraManager implements CameraManager {
     private readonly _raycaster;
     private isDisposed;
     private _nearAndFarNeedsUpdate;
-    private _enabledCopy;
+    private isEnabled;
     private readonly _modelRaycastCallback;
     private _onClick;
     private _onWheel;
@@ -69,23 +69,11 @@ export declare class DefaultCameraManager implements CameraManager {
     /**
      * Sets whether camera controls through mouse, touch and keyboard are enabled.
      */
-    set enabled(enabled: boolean);
+    private set enabled(value);
     /**
      * Gets whether camera controls through mouse, touch and keyboard are enabled.
      */
     get enabled(): boolean;
-    /**
-     * Sets whether camera controls through mouse, touch and keyboard are enabled.
-     * This can be useful to e.g. temporarily disable navigation when manipulating other
-     * objects in the scene or when implementing a "cinematic" viewer.
-     * @deprecated Will be removed in 4.0.0. Use {@link DefaultCameraManager.enabled} instead.
-     */
-    set cameraControlsEnabled(enabled: boolean);
-    /**
-     * Gets whether camera controls through mouse, touch and keyboard are enabled.
-     * @deprecated Will be removed in 4.0.0. Use {@link DefaultCameraManager.enabled} instead.
-     */
-    get cameraControlsEnabled(): boolean;
     /**
      * Sets whether keyboard control of the camera is enabled/disabled.
      */
@@ -103,6 +91,8 @@ export declare class DefaultCameraManager implements CameraManager {
      * **/
     setCameraState(state: CameraState): void;
     getCameraState(): Required<CameraState>;
+    activate(cameraManager?: CameraManager): void;
+    deactivate(): void;
     /**
      * Gets current camera controls options.
      */

package/dist/packages/camera-manager/src/ProxyCameraManager.d.ts

@@ -8,14 +8,15 @@ export declare class ProxyCameraManager implements CameraManager {
     private readonly _cameraChangedListeners;
     private _activeCameraManager;
     private readonly _activeCameraEventHandler;
-    set enabled(value: boolean);
     get enabled(): boolean;
     get innerCameraManager(): CameraManager;
     constructor(initialActiveCamera: CameraManager);
-    setActiveCameraManager(cameraManager: CameraManager, preserveCameraState?: boolean): void;
+    setActiveCameraManager(cameraManager: CameraManager): void;
     getCamera(): THREE.PerspectiveCamera;
     setCameraState(state: CameraState): void;
     getCameraState(): Required<CameraState>;
+    activate(cameraManager?: CameraManager): void;
+    deactivate(): void;
     on(_: 'cameraChange', callback: CameraChangeDelegate): void;
     off(_: 'cameraChange', callback: CameraChangeDelegate): void;
     fitCameraToBoundingBox(boundingBox: THREE.Box3, duration?: number | undefined, radiusFactor?: number | undefined): void;

package/dist/packages/camera-manager/src/StationaryCameraManager.d.ts

@@ -11,17 +11,19 @@ export declare class StationaryCameraManager implements CameraManager {
     private _isEnabled;
     private _isDragging;
     constructor(domElement: HTMLElement, camera: THREE.PerspectiveCamera);
-    set enabled(value: boolean);
     get enabled(): boolean;
     getCamera(): THREE.PerspectiveCamera;
     setCameraState(state: CameraState): void;
     getCameraState(): Required<CameraState>;
+    activate(): void;
+    deactivate(): void;
     on(_: 'cameraChange', callback: CameraChangeDelegate): void;
     off(_: 'cameraChange', callback: CameraChangeDelegate): void;
     fitCameraToBoundingBox(boundingBox: THREE.Box3, _?: number, radiusFactor?: number): void;
+    moveTo(targetPosition: THREE.Vector3, duration?: number): Promise<void>;
     update(_: number, boundingBox: THREE.Box3): void;
     dispose(): void;
-    private enableDragging;
-    private disableDragging;
-    private rotateCamera;
+    private readonly enableDragging;
+    private readonly disableDragging;
+    private readonly rotateCamera;
 }

package/dist/packages/sector-parser/src/GltfSectorParser.d.ts

@@ -1,7 +1,6 @@
 import { ParsedGeometry } from './types';
 export declare class GltfSectorParser {
     private readonly _glbMetadataParser;
-    private readonly _dracoDecoderHelper;
     constructor();
     parseSector(data: ArrayBuffer): Promise<ParsedGeometry[]>;
     private traverseDefaultSceneNodes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.0.0-dev.20221124",
+  "version": "4.0.0-dev.20221128",
   "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": {
@@ -81,7 +81,7 @@
     "proj4": "2.8.0",
     "rxjs": "7.5.7",
     "skmeans": "0.11.3",
-    "three-stdlib": "2.18.1"
+    "three-stdlib": "2.19.0"
   },
   "devDependencies": {
     "@azure/msal-browser": "2.31.0",
@@ -124,9 +124,9 @@
     "jest-canvas-mock": "2.4.0",
     "jest-environment-jsdom": "29.3.1",
     "jest-extended": "3.1.0",
-    "jest-image-snapshot": "5.2.0",
+    "jest-image-snapshot": "6.0.0",
     "jest-puppeteer": "6.1.1",
-    "jsdom": "20.0.2",
+    "jsdom": "20.0.3",
     "moq.ts": "9.0.2",
     "nock": "13.2.9",
     "prettier": "2.7.1",

package/dist/packages/sector-parser/src/DracoDecoderHelper.d.ts

@@ -1,32 +0,0 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-import type { Mesh } from 'draco3dgltf';
-import { GltfJson } from './types';
-export type VertexBufferDescriptor = {
-    [key: string]: {
-        byteStride: number;
-        byteOffset: number;
-    };
-};
-export type MeshGeometryBufferDescriptor = {
-    indexBufferView: Uint16Array | Uint32Array;
-    vertexBufferView: Uint8Array;
-    vertexBufferDescriptor: VertexBufferDescriptor;
-};
-export declare class DracoDecoderHelper {
-    private readonly _dracoDecoderModule;
-    private readonly _dracoDataTypes;
-    constructor();
-    decodeDracoBufferToDracoMesh(dracoMeshBufferView: Int8Array): Promise<Mesh>;
-    decodeDracoMeshToGeometryBuffers(json: GltfJson, dracoMesh: Mesh, dracoAttributes: {
-        [key: string]: number;
-    }, gltfAttributes: {
-        [key: string]: number;
-    }): Promise<MeshGeometryBufferDescriptor>;
-    private decodeVertexBuffer;
-    private computeVertexBufferDescriptor;
-    private getAttributeDescriptors;
-    private decodeIndex;
-    private copyLinearToInterleaved;
-}

package/dist/packages/sector-parser/src/lib/draco_decoder_gltf.d.ts

@@ -1,5 +0,0 @@
-export = DracoDecoderModule;
-declare function DracoDecoderModule(DracoDecoderModule: any): any;
-declare namespace DracoDecoderModule {
-    export { DracoDecoderModule };
-}