@cognite/reveal 4.0.0-dev.20230125 → 4.1.0-dev.20230126

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

@@ -7,3 +7,5 @@ export { Image360Facade } from './src/Image360Facade';
 export { Image360EntityFactory } from './src/Image360EntityFactory';
 export { Image360Entity } from './src/Image360Entity';
 export { Image360Visualization } from './src/Image360Visualization';
+export { Image360EnteredDelegate, Image360ExitedDelegate } from './src/types';
+export { DefaultImage360Collection } from './src/DefaultImage360Collection';

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

@@ -0,0 +1,44 @@
+/*!
+ * Copyright 2023 Cognite AS
+ */
+import { EventTrigger } from '../../utilities';
+import { Image360 } from './Image360';
+import { Image360Collection } from './Image360Collection';
+import { Image360Entity } from './Image360Entity';
+import { Image360EnteredDelegate, Image360ExitedDelegate } from './types';
+/**
+ * Default implementation of {@link Image360Collection}. Used for events when entering
+ * and exiting 360 image mode
+ */
+export declare class DefaultImage360Collection implements Image360Collection {
+    /**
+     * A list containing all the 360 images in this set.
+     */
+    readonly image360Entities: Image360Entity[];
+    private readonly _events;
+    /**
+     * The events from the image collection.
+     */
+    get events(): {
+        image360Entered: EventTrigger<Image360EnteredDelegate>;
+        image360Exited: EventTrigger<Image360ExitedDelegate>;
+    };
+    constructor(entities: Image360[]);
+    /**
+     * Subscribes to events on 360 Image datasets. There are several event types:
+     * 'image360Entered' - Subscribes to a event for entering 360 image mode.
+     * 'image360Exited' - Subscribes to events indicating 360 image mode has exited.
+     * @param event The event type.
+     * @param callback Callback to be called when the event is fired.
+     */
+    on(event: 'image360Entered', callback: Image360EnteredDelegate): void;
+    on(event: 'image360Exited', callback: Image360ExitedDelegate): void;
+    /**
+     * Unsubscribes from 360 image dataset event.
+     * @param event The event type.
+     * @param callback Callback function to be unsubscribed.
+     */
+    off(event: 'image360Entered', callback: Image360EnteredDelegate): void;
+    off(event: 'image360Exited', callback: Image360ExitedDelegate): void;
+    dispose(): void;
+}

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

@@ -2,6 +2,7 @@
  * Copyright 2022 Cognite AS
  */
 import { Image360 } from './Image360';
+import { Image360EnteredDelegate, Image360ExitedDelegate } from './types';
 /**
  * A wrapper that represents a set of 360 images.
  */
@@ -10,4 +11,20 @@ export interface Image360Collection {
      * A list containing all the 360 images in this set.
      */
     readonly image360Entities: Image360[];
+    /**
+     * Subscribes to events on 360 Image datasets. There are several event types:
+     * 'image360Entered' - Subscribes to a event for entering 360 image mode.
+     * 'image360Exited' - Subscribes to events indicating 360 image mode has exited.
+     * @param event The event type.
+     * @param callback Callback to be called when the event is fired.
+     */
+    on(event: 'image360Entered', callback: Image360EnteredDelegate): void;
+    on(event: 'image360Exited', callback: Image360ExitedDelegate): void;
+    /**
+     * Unsubscribes from 360 image dataset event.
+     * @param event The event type.
+     * @param callback Callback function to be unsubscribed.
+     */
+    off(event: 'image360Entered', callback: Image360EnteredDelegate): void;
+    off(event: 'image360Exited', callback: Image360ExitedDelegate): void;
 }

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

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2023 Cognite AS
+ */
+import { Image360 } from './Image360';
+/**
+ * Delegate for 360 image mode entered events.
+ */
+export type Image360EnteredDelegate = (image360: Image360) => void;
+/**
+ * Delegate for 360 image mode exited events.
+ */
+export type Image360ExitedDelegate = () => void;

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

@@ -3,7 +3,7 @@
  */
 import * as THREE from 'three';
 import { CogniteClient } from '@cognite/sdk';
-import { Image360Entity } from '../../../360-images';
+import { Image360Collection, Image360Entity } from '../../../360-images';
 import { InputHandler, SceneHandler } from '../../../utilities';
 import { ProxyCameraManager } from '../../../camera-manager';
 import { Image360 } from '../../../360-images/src/Image360';
@@ -17,10 +17,11 @@ export declare class Image360ApiHelper {
     private readonly _activeCameraManager;
     private readonly _image360Navigation;
     private _cachedCameraManager;
+    private readonly _imageCollection;
     constructor(cogniteClient: CogniteClient, sceneHandler: SceneHandler, domElement: HTMLElement, activeCameraManager: ProxyCameraManager, inputHandler: InputHandler, requestRedraw: () => void);
     add360ImageSet(eventFilter: {
         [key: string]: string;
-    }, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean): Promise<Image360Entity[]>;
+    }, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean): Promise<Image360Collection>;
     remove360Images(entities: Image360[]): Promise<void>;
     enter360Image(image360Entity: Image360Entity): Promise<void>;
     private transition;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.0.0-dev.20230125",
+  "version": "4.1.0-dev.20230126",
   "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": {