@cognite/reveal 4.2.0-dev.20230531 → 4.2.0-dev.20230602

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

@@ -7,6 +7,7 @@ import { Image360Entity } from '../entity/Image360Entity';
 import { Image360EnteredDelegate, Image360ExitedDelegate } from '../types';
 import { IconCollection, IconCullingScheme } from '../icons/IconCollection';
 import { Image360AnnotationAppearance } from '../annotation/types';
+import { IdEither } from '@cognite/sdk';
 import { Image360DataProvider } from '../../../data-providers';
 /**
  * Default implementation of {@link Image360Collection}. Used for events when entering
@@ -79,5 +80,6 @@ export declare class DefaultImage360Collection implements Image360Collection {
     resetRedraw(): void;
     getDefaultAnnotationStyle(): Image360AnnotationAppearance;
     setDefaultAnnotationStyle(defaultStyle: Image360AnnotationAppearance): void;
-    findImageAnnotation(filter: Image360AnnotationAssetFilter): Promise<Image360AnnotationAssetQueryResult[]>;
+    findImageAnnotations(filter: Image360AnnotationAssetFilter): Promise<Image360AnnotationAssetQueryResult[]>;
+    getAssetIds(): Promise<IdEither[]>;
 }

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

@@ -8,9 +8,12 @@ import { Image360Revision } from '../entity/Image360Revision';
 import { IdEither } from '@cognite/sdk';
 import { Image360Annotation } from '../annotation/Image360Annotation';
 /**
- * Filter for finding annotation related to asset
+ * Filter for finding annotations related to an asset
  */
 export type Image360AnnotationAssetFilter = {
+    /**
+     * Reference to the wanted asset
+     */
     assetRef: IdEither;
 };
 /**
@@ -89,7 +92,11 @@ export interface Image360Collection {
      */
     setDefaultAnnotationStyle(appearance: Image360AnnotationAppearance): void;
     /**
-     * Find 360 images associated with a asset with the given assetRef
+     * Find 360 images associated with an asset through CDF annotations
+     */
+    findImageAnnotations(filter: Image360AnnotationAssetFilter): Promise<Image360AnnotationAssetQueryResult[]>;
+    /**
+     * Get IDs of all CDF assets associated with this 360 image collection through CDF annotations
      */
-    findImageAnnotation(filter: Image360AnnotationAssetFilter): Promise<Image360AnnotationAssetQueryResult[]>;
+    getAssetIds(): Promise<IdEither[]>;
 }

package/dist/packages/3d-overlays/src/Overlay3DCollection.d.ts

@@ -6,6 +6,7 @@ import { Overlay3D } from './Overlay3D';
 import { DefaultOverlay3DContentType, OverlayCollection, OverlayInfo } from './OverlayCollection';
 export type Overlay3DCollectionOptions = {
     overlayTexture?: Texture;
+    overlayTextureMask?: Texture;
     maxPointSize?: number;
     defaultOverlayColor?: Color;
 };
@@ -14,7 +15,7 @@ export declare class Overlay3DCollection<MetadataType = DefaultOverlay3DContentT
     private readonly MaxPixelSize;
     private readonly DefaultMaxPoints;
     private readonly defaultOverlayColor;
-    private readonly _sharedTexture;
+    private readonly _sharedTextures;
     private readonly _overlayPoints;
     private readonly _iconRadius;
     private _overlays;
@@ -30,5 +31,5 @@ export declare class Overlay3DCollection<MetadataType = DefaultOverlay3DContentT
     private updatePointsObject;
     private initializeOverlay3DIcons;
     dispose(): void;
-    private createCircleTexture;
+    private createCircleTextures;
 }

package/dist/packages/3d-overlays/src/OverlayCollection.d.ts

@@ -9,7 +9,7 @@ export type DefaultOverlay3DContentType = {
     [key: string]: string;
 };
 /**
- * Data used in creating an overlay
+ * Data used in creating an overlay.
  */
 export type OverlayInfo<ContentType = DefaultOverlay3DContentType> = {
     /**
@@ -26,7 +26,7 @@ export type OverlayInfo<ContentType = DefaultOverlay3DContentType> = {
     color?: THREE.Color;
 };
 /**
- * A set of overlays managed
+ * A set of overlays managed.
  */
 export interface OverlayCollection<ContentType> {
     /**

package/dist/packages/3d-overlays/src/OverlayPointsObject.d.ts

@@ -4,6 +4,7 @@
 import { Color, DepthModes, Group, Texture, Vector3 } from 'three';
 export type OverlayPointsParameters = {
     spriteTexture: Texture;
+    maskTexture?: Texture;
     minPixelSize: number;
     maxPixelSize: number;
     radius: number;

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

@@ -12,6 +12,7 @@ export declare class Image360ApiHelper {
     private _transitionInProgress;
     private readonly _raycaster;
     private _needsRedraw;
+    private readonly _imageCollections;
     private readonly _interactionState;
     private readonly _eventHandlers;
     private readonly _debouncePreLoad;
@@ -24,7 +25,9 @@ export declare class Image360ApiHelper {
     resetRedraw(): void;
     private getNormalizedOffset;
     add360ImageSet(eventFilter: Metadata, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean, annotationOptions?: Image360AnnotationFilterOptions): Promise<Image360Collection>;
+    getImageCollections(): Image360Collection[];
     remove360Images(entities: Image360[]): Promise<void>;
+    remove360ImageCollection(collection: Image360Collection): void;
     enter360Image(image360Entity: Image360Entity, revision?: Image360RevisionEntity): Promise<void>;
     private applyFullResolutionTextures;
     private transition;

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

@@ -281,11 +281,21 @@ export declare class Cognite3DViewer {
     add360ImageSet(datasource: 'events', eventFilter: {
         [key: string]: string;
     }, add360ImageOptions?: AddImage360Options): Promise<Image360Collection>;
+    /**
+     * Returns a list of added 360 image collections.
+     */
+    get360ImageCollections(): Image360Collection[];
     /**
      * Remove a set of 360 images.
      * @param image360Entities
+     * @deprecated
      */
     remove360Images(...image360Entities: Image360[]): Promise<void>;
+    /**
+     * Removes a previously added 360 image collection from the viewer.
+     * @param imageCollection Collection to remove.
+     */
+    remove360ImageSet(imageCollection: Image360Collection): void;
     /**
      * Enter visualization of a 360 image.
      * @param image360 The 360 image to enter.

package/dist/packages/data-providers/src/Image360Provider.d.ts

@@ -1,8 +1,8 @@
 /*!
  * Copyright 2022 Cognite AS
  */
-import { Image360DescriptorProvider, Image360FileProvider, Image360AnnotationProvider } from './types';
+import { Image360DescriptorProvider, Image360FileProvider, Image360AnnotationProvider, Image360AssetProvider } from './types';
 export interface Image360Provider<T> extends Image360DescriptorProvider<T>, Image360DataProvider {
 }
-export interface Image360DataProvider extends Image360FileProvider, Image360AnnotationProvider {
+export interface Image360DataProvider extends Image360FileProvider, Image360AnnotationProvider, Image360AssetProvider {
 }

package/dist/packages/data-providers/src/image-360-data-providers/Cdf360ImageEventProvider.d.ts

@@ -24,5 +24,5 @@ export declare class Cdf360ImageEventProvider implements Image360Provider<Metada
     }[], abortSignal?: AbortSignal): Promise<ArrayBuffer[]>;
     private getDownloadUrls;
     private parseEventMetadata;
-    get360ImageFaces(): Promise<void>;
+    get360ImageAssets(image360FileDescriptors: Image360FileDescriptor[]): Promise<IdEither[]>;
 }

package/dist/packages/data-providers/src/image-360-data-providers/Local360ImageProvider.d.ts

@@ -9,4 +9,5 @@ export declare class Local360ImageProvider implements Image360Provider<unknown>
     get360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
     getLowResolution360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
     getFilesByAssetRef(_assetId: IdEither): Promise<CogniteInternalId[]>;
+    get360ImageAssets(_image360FileDescriptors: Image360FileDescriptor[]): Promise<IdEither[]>;
 }

package/dist/packages/data-providers/src/types.d.ts

@@ -20,6 +20,9 @@ export interface Image360FileProvider {
     get360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
     getLowResolution360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
 }
+export interface Image360AssetProvider {
+    get360ImageAssets(image360FileDescriptors: Image360FileDescriptor[]): Promise<IdEither[]>;
+}
 export type Historical360ImageSet = Image360EventDescriptor & {
     imageRevisions: Image360Descriptor[];
 };

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

@@ -5,7 +5,7 @@ export { HtmlOverlayTool, HtmlOverlayOptions, HtmlOverlayToolOptions, HtmlOverla
 export { DebugCameraTool } from './src/DebugCameraTool';
 export { AxisViewTool } from './src/AxisView/AxisViewTool';
 export { AxisBoxConfig, AxisBoxCompassConfig, AxisBoxFaceConfig, Corner, AbsolutePosition, RelativePosition } from './src/AxisView/types';
-export { Overlay3DTool, Overlay3DToolParameters, OverlayEventHandler, OverlayToolEvent } from './src/Overlay3D/Overlay3DTool';
+export { Overlay3DTool, Overlay3DToolParameters, OverlayEventHandler, OverlayToolEvent, OverlayCollectionOptions } from './src/Overlay3D/Overlay3DTool';
 export { TimelineTool } from './src/Timeline/TimelineTool';
 export { Keyframe } from './src/Timeline/Keyframe';
 export { TimelineDateUpdateDelegate } from './src/Timeline/types';

package/dist/packages/tools/src/Overlay3D/Overlay3DTool.d.ts

@@ -15,10 +15,10 @@ export type OverlayToolEvent = 'hover' | 'click' | 'disposed';
  */
 export type OverlayEventHandler<ContentType> = (event: {
     targetOverlay: Overlay3D<ContentType>;
-    htmlOverlay: HTMLElement;
+    htmlTextOverlay: HTMLElement;
     mousePosition: {
-        clientX: number;
-        clientY: number;
+        offsetX: number;
+        offsetY: number;
     };
 }) => void;
 /**
@@ -36,6 +36,30 @@ export type Overlay3DToolParameters = {
      */
     defaultOverlayColor: THREE.Color;
 };
+/**
+ * Parameters for instantiating the OverlayCollection.
+ */
+export type OverlayCollectionOptions = {
+    /**
+     * Sets default overlay color for newly added overlays.
+     * Default is yellow.
+     * */
+    defaultOverlayColor?: THREE.Color;
+    /**
+     * Sets default texture for all overlays of this OverlayCollection.
+     * Must be a square texture, recommended size is at least `maxPointSize` for
+     * not pixelated overlays.
+     */
+    overlayTexture?: THREE.Texture;
+    /**
+     * Sets default mask for all overlays of this OverlayCollection,
+     * denoting where overlay color should be placed compared to texture color.
+     * Must be a square texture with the same size as `overlayTexture`.
+     * Texture should be monochrome. Internally, R channel is used for
+     * denoting pixels that should be colored by texture and not by overlay color.
+     */
+    overlayTextureMask?: THREE.Texture;
+};
 /**
  * Tool for adding and interacting with 2D overlays positioned at points in
  */
@@ -56,7 +80,7 @@ export declare class Overlay3DTool<ContentType = DefaultOverlay3DContentType> ex
      * @param overlays Array of overlays to add.
      * @returns Overlay group containing it's id.
      */
-    createOverlayCollection(overlays?: OverlayInfo<ContentType>[]): OverlayCollection<ContentType>;
+    createOverlayCollection(overlays?: OverlayInfo<ContentType>[], options?: OverlayCollectionOptions): OverlayCollection<ContentType>;
     /**
      * Removes overlays that were added with addOverlays method.
      * @param overlayCollection Id of the overlay group to remove.
@@ -76,6 +100,7 @@ export declare class Overlay3DTool<ContentType = DefaultOverlay3DContentType> ex
     getVisible(): boolean;
     /**
      * Sets whether text overlay is visible.
+     * Default is false.
      */
     setTextOverlayVisible(visible: boolean): void;
     /**
@@ -105,6 +130,5 @@ export declare class Overlay3DTool<ContentType = DefaultOverlay3DContentType> ex
     private readonly onMouseClick;
     private positionTextOverlay;
     private intersectPointsMarkers;
-    private convertPixelCoordinatesToNormalized;
     private createTextOverlay;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.2.0-dev.20230531",
+  "version": "4.2.0-dev.20230602",
   "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": {
@@ -76,7 +76,7 @@
     "rxjs": "7.8.1",
     "skmeans": "0.11.3",
     "sparse-octree": "7.1.6",
-    "three-stdlib": "2.22.4"
+    "three-stdlib": "2.23.4"
   },
   "devDependencies": {
     "@azure/msal-browser": "2.37.0",
@@ -91,7 +91,7 @@
     "@types/jsdom": "21.1.1",
     "@types/lodash": "4.14.195",
     "@types/mixpanel-browser": "2.38.1",
-    "@types/node": "18.16.15",
+    "@types/node": "18.16.16",
     "@types/random-seed": "0.3.3",
     "@types/skmeans": "0.11.4",
     "@types/stats": "0.16.30",
@@ -120,7 +120,7 @@
     "jest-extended": "3.2.4",
     "jest-image-snapshot": "6.1.0",
     "jest-puppeteer": "8.0.6",
-    "jsdom": "22.0.0",
+    "jsdom": "22.1.0",
     "moq.ts": "10.0.6",
     "nock": "13.3.1",
     "prettier": "2.8.8",