@cognite/reveal 4.2.0-dev.20230524 → 4.2.0-dev.20230525

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

@@ -1,7 +1,7 @@
 /*!
  * Copyright 2022 Cognite AS
  */
-export { Image360, Image360Metadata } from './src/entity/Image360';
+export { Image360 } from './src/entity/Image360';
 export { Image360Revision } from './src/entity/Image360Revision';
 export { Image360Collection, Image360AnnotationAssetFilter, Image360AnnotationAssetQueryResult } from './src/collection/Image360Collection';
 export { Image360Facade } from './src/Image360Facade';

package/dist/packages/360-images/src/annotation/Image360Annotation.d.ts

@@ -11,10 +11,18 @@ export interface Image360Annotation {
      * The underlying CDF annotation
      */
     readonly annotation: AnnotationModel;
+    /**
+     * Get the individual display color of this annotation.
+     */
+    getColor(): Color;
     /**
      * Set the display color of this annotation. Default: Random, based on annotation label
      */
     setColor(color?: Color): void;
+    /**
+     * Get whether this annotation is visible
+     */
+    getVisible(): boolean;
     /**
      * Set whether this annotation should be visible. Default: true
      */

package/dist/packages/360-images/src/annotation/ImageAnnotationObject.d.ts

@@ -27,7 +27,10 @@ export declare class ImageAnnotationObject implements Image360Annotation {
     intersects(raycaster: Raycaster): boolean;
     private updateMaterials;
     setDefaultStyle(appearance: Image360AnnotationAppearance): void;
+    private getColorReference;
+    getColor(): Color;
     setColor(color?: Color): void;
+    getVisible(): boolean;
     setVisible(visible?: boolean): void;
     dispose(): void;
     getCenter(out?: Vector3): Vector3;

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

@@ -75,7 +75,7 @@ export declare class DefaultImage360Collection implements Image360Collection {
     dispose(): void;
     get needsRedraw(): boolean;
     resetRedraw(): void;
-    get defaultStyle(): Image360AnnotationAppearance;
+    getDefaultAnnotationStyle(): Image360AnnotationAppearance;
     setDefaultAnnotationStyle(defaultStyle: Image360AnnotationAppearance): void;
     findImageAnnotation(filter: Image360AnnotationAssetFilter): Promise<Image360AnnotationAssetQueryResult[]>;
 }

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

@@ -70,6 +70,10 @@ export interface Image360Collection {
      */
     off(event: 'image360Entered', callback: Image360EnteredDelegate): void;
     off(event: 'image360Exited', callback: Image360ExitedDelegate): void;
+    /**
+     * Get the assigned default style affecting all annotations
+     */
+    getDefaultAnnotationStyle(): Image360AnnotationAppearance;
     /**
      * Assign a default style which affects all annotations
      */

package/dist/packages/360-images/src/entity/Image360.d.ts

@@ -3,11 +3,10 @@
  */
 import { Image360Revision } from './Image360Revision';
 import { Image360Visualization } from './Image360Visualization';
-export type Image360Metadata = {
-    station: string;
-    collection: string;
-    date?: Date;
-};
+/**
+ * A single 360 image "station", which may consist of several revisions
+ * captured in approximately the same location
+ */
 export interface Image360 {
     /**
      * Get a copy of the model-to-world transformation matrix
@@ -21,9 +20,15 @@ export interface Image360 {
      */
     readonly image360Visualization: Image360Visualization;
     /**
-     * Get additional information about this image and its active revision.
+     * Get Id of 360 image entity.
+     * @returns Station Id
      */
-    getImageMetadata(): Image360Metadata;
+    readonly id: string;
+    /**
+     * Get label of 360 image entity.
+     * @returns Station label
+     * */
+    readonly label: string;
     /**
      * List all historical images for this entity.
      * @returns A list of available revisions.

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

@@ -3,7 +3,7 @@
  */
 import { DeviceDescriptor, SceneHandler } from '../../../utilities';
 import { Image360DataProvider } from '../../../data-providers';
-import { Image360, Image360Metadata } from './Image360';
+import { Image360 } from './Image360';
 import { Historical360ImageSet } from '../../../data-providers/src/types';
 import { Image360RevisionEntity } from './Image360RevisionEntity';
 import { Image360VisualizationBox } from './Image360VisualizationBox';
@@ -34,6 +34,16 @@ export declare class Image360Entity implements Image360 {
      * @returns Image360Visualization
      */
     get image360Visualization(): Image360VisualizationBox;
+    /**
+     * Get Id of 360 image entity.
+     * @returns Station Id
+     */
+    get id(): string;
+    /**
+     * Get label of 360 image entity.
+     * @returns Station label
+     * */
+    get label(): string;
     constructor(image360Metadata: Historical360ImageSet, sceneHandler: SceneHandler, imageProvider: Image360DataProvider, annotationFilterer: Image360AnnotationFilter, transform: THREE.Matrix4, icon: Overlay3DIcon, device: DeviceDescriptor);
     /**
      * List all historical images for this entity.
@@ -58,7 +68,6 @@ export declare class Image360Entity implements Image360 {
      * Drops the GPU resources for the 360 image
      */
     unloadImage(): void;
-    getImageMetadata(): Image360Metadata;
     activateAnnotations(): void;
     deactivateAnnotations(): void;
     /**

package/dist/packages/3d-overlays/index.d.ts

@@ -5,5 +5,5 @@ export { Overlay3DCollection } from './src/Overlay3DCollection';
 export { OverlayPointsObject, OverlayPointsParameters } from './src/OverlayPointsObject';
 export { Overlay3DIcon } from './src/Overlay3DIcon';
 export { Overlay3D } from './src/Overlay3D';
-export { OverlayCollection, OverlayInfo, DefaultMetadataType } from './src/OverlayCollection';
+export { OverlayCollection, OverlayInfo, DefaultOverlay3DContentType } from './src/OverlayCollection';
 export { IconOctree } from './src/IconOctree';

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

@@ -1,29 +1,33 @@
 /*!
  * Copyright 2023 Cognite AS
  */
-export interface Overlay3D<MetadataType> {
+import { Color, Vector3 } from 'three';
+/**
+ * Represents one 3d overlay
+ */
+export interface Overlay3D<ContentType> {
     /**
      * Set whether this overlay should be visible.
      * */
-    set visible(visible: boolean);
+    setVisible(visible: boolean): void;
     /**
      * Get whether this overlay is visible.
      */
-    get visible(): boolean;
+    getVisible(): boolean;
     /**
      * Get the position of this overlay.
      */
-    get position(): THREE.Vector3;
+    getPosition(): Vector3;
     /**
      * Set the display color of this overlay.
      * */
-    setColor(color: THREE.Color): void;
+    setColor(color: Color): void;
     /**
      * Get the display color of this overlay.
      * */
-    get color(): THREE.Color;
+    getColor(): Color;
     /**
      * Get the metadata associated with this overlay.
      * */
-    getMetadata(): MetadataType | undefined;
+    getContent(): ContentType;
 }

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

@@ -3,13 +3,13 @@
  */
 import { Color, Texture, Object3D } from 'three';
 import { Overlay3D } from './Overlay3D';
-import { DefaultMetadataType, OverlayCollection, OverlayInfo } from './OverlayCollection';
+import { DefaultOverlay3DContentType, OverlayCollection, OverlayInfo } from './OverlayCollection';
 export type Overlay3DCollectionOptions = {
     overlayTexture?: Texture;
     maxPointSize?: number;
     defaultOverlayColor?: Color;
 };
-export declare class Overlay3DCollection<MetadataType = DefaultMetadataType> extends Object3D implements OverlayCollection<MetadataType> {
+export declare class Overlay3DCollection<MetadataType = DefaultOverlay3DContentType> extends Object3D implements OverlayCollection<MetadataType> {
     private readonly MinPixelSize;
     private readonly MaxPixelSize;
     private readonly DefaultMaxPoints;

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

@@ -3,7 +3,7 @@
  */
 import { PerspectiveCamera, Ray, Vector3, Color } from 'three';
 import { Overlay3D } from './Overlay3D';
-import { DefaultMetadataType } from './OverlayCollection';
+import { DefaultOverlay3DContentType } from './OverlayCollection';
 export type IconParameters = {
     position: THREE.Vector3;
     color?: THREE.Color;
@@ -25,14 +25,14 @@ export type SelectedDelegate = (event: {
     selected: boolean;
 }) => void;
 export type IconEvent = 'selected' | 'parametersChange';
-export declare class Overlay3DIcon<MetadataType = DefaultMetadataType> implements Overlay3D<MetadataType> {
+export declare class Overlay3DIcon<ContentType = DefaultOverlay3DContentType> implements Overlay3D<ContentType> {
     private readonly _position;
     private readonly _minPixelSize;
     private readonly _maxPixelSize;
     private readonly _setAdaptiveScale;
     private readonly _iconRadius;
     private readonly _hoverSprite?;
-    private readonly _iconMetadata?;
+    private readonly _content;
     private readonly _raycastBoundingSphere;
     private _adaptiveScale;
     private _visible;
@@ -41,7 +41,7 @@ export declare class Overlay3DIcon<MetadataType = DefaultMetadataType> implement
     private _color;
     private readonly _ndcPosition;
     private readonly _events;
-    constructor(iconParameters: IconParameters, iconMetadata?: MetadataType);
+    constructor(iconParameters: IconParameters, content: ContentType);
     on(event: 'selected', callback: SelectedDelegate): void;
     on(event: 'parametersChange', callback: ParametersChangeDelegate): void;
     off(event: 'selected', callback: SelectedDelegate): void;
@@ -55,14 +55,14 @@ export declare class Overlay3DIcon<MetadataType = DefaultMetadataType> implement
         domElement: HTMLElement;
     }): void;
     setColor(color: Color): void;
-    get color(): Color;
-    getMetadata(): MetadataType | undefined;
+    getColor(): Color;
+    getContent(): ContentType;
     get adaptiveScale(): number;
     set culled(culled: boolean);
     get culled(): boolean;
-    set visible(visible: boolean);
-    get visible(): boolean;
-    get position(): Vector3;
+    setVisible(visible: boolean): void;
+    getVisible(): boolean;
+    getPosition(): Vector3;
     intersect(ray: Ray): Vector3 | null;
     dispose(): void;
     private setupAdaptiveScaling;

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

@@ -2,31 +2,48 @@
  * Copyright 2023 Cognite AS
  */
 import { Overlay3D } from './Overlay3D';
-export type DefaultMetadataType = {
-    text?: string;
-    [key: string]: string | undefined;
+/**
+ * The default metadata type contained in Overlays
+ */
+export type DefaultOverlay3DContentType = {
+    [key: string]: string;
 };
-export type OverlayInfo<MetadataType = DefaultMetadataType> = {
+/**
+ * Data used in creating an overlay
+ */
+export type OverlayInfo<ContentType = DefaultOverlay3DContentType> = {
+    /**
+     * Position of the overlay
+     */
     position: THREE.Vector3;
-    metadata?: MetadataType;
+    /**
+     * The data contained in this overlay
+     */
+    content: ContentType;
+    /**
+     * The color of this overlay. Will be set by collection if undefined
+     */
     color?: THREE.Color;
 };
-export interface OverlayCollection<MetadataType> {
+/**
+ * A set of overlays managed
+ */
+export interface OverlayCollection<ContentType> {
     /**
      * Get all overlays in the collection.
      * */
-    getOverlays(): Overlay3D<MetadataType>[];
+    getOverlays(): Overlay3D<ContentType>[];
     /**
      * Add overlays to the collection.
      * @param overlays Overlays to add to the collection.
      * @returns The added overlays.
      */
-    addOverlays(overlays: OverlayInfo<MetadataType>[]): Overlay3D<MetadataType>[];
+    addOverlays(overlays: OverlayInfo<ContentType>[]): Overlay3D<ContentType>[];
     /**
      * Remove overlays from the collection.
      * @param overlays Overlays to remove from the collection.
      */
-    removeOverlays(overlays: Overlay3D<MetadataType>[]): void;
+    removeOverlays(overlays: Overlay3D<ContentType>[]): void;
     /**
      * Remove all overlays from the collection.
      */

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 { SmartOverlayTool, SmartOverlayToolParameters, OverlayEventHandler, OverlayToolEvent } from './src/SmartOverlay/SmartOverlayTool';
+export { Overlay3DTool, Overlay3DToolParameters, OverlayEventHandler, OverlayToolEvent } 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/{SmartOverlay/SmartOverlayTool.d.ts → Overlay3D/Overlay3DTool.d.ts}

@@ -4,18 +4,27 @@
 import { Cognite3DViewer } from '../../../api';
 import { DisposedDelegate } from '../../../utilities';
 import * as THREE from 'three';
-import { OverlayInfo, DefaultMetadataType, OverlayCollection, Overlay3D } from '../../../3d-overlays';
+import { OverlayInfo, DefaultOverlay3DContentType, OverlayCollection, Overlay3D } from '../../../3d-overlays';
 import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+/**
+ * Events related to overlays
+ */
 export type OverlayToolEvent = 'hover' | 'click' | 'disposed';
-export type OverlayEventHandler<MetadataType> = (event: {
-    targetOverlay: Overlay3D<MetadataType>;
+/**
+ * Type for handlers of overlay events
+ */
+export type OverlayEventHandler<ContentType> = (event: {
+    targetOverlay: Overlay3D<ContentType>;
     htmlOverlay: HTMLElement;
     mousePosition: {
         clientX: number;
         clientY: number;
     };
 }) => void;
-export type SmartOverlayToolParameters = {
+/**
+ * Parameters for instantiating the Overlay3DTool
+ */
+export type Overlay3DToolParameters = {
     /**
      * Max point markers size in pixels. Different platforms has limitations for this value.
      * On Android and MacOS in Chrome maximum is 64. Windows in Chrome and MacOS Safari desktops can support up to 500.
@@ -27,7 +36,10 @@ export type SmartOverlayToolParameters = {
      */
     defaultOverlayColor: THREE.Color;
 };
-export declare class SmartOverlayTool<MetadataType = DefaultMetadataType> extends Cognite3DViewerToolBase {
+/**
+ * Tool for adding and interacting with 2D overlays positioned at points in
+ */
+export declare class Overlay3DTool<ContentType = DefaultOverlay3DContentType> extends Cognite3DViewerToolBase {
     private readonly _viewer;
     private readonly _textOverlay;
     private readonly _defaultOverlayColor;
@@ -38,29 +50,38 @@ export declare class SmartOverlayTool<MetadataType = DefaultMetadataType> extend
     private _isVisible;
     private _textOverlayVisible;
     private readonly _events;
-    constructor(viewer: Cognite3DViewer, toolParameters?: SmartOverlayToolParameters);
+    constructor(viewer: Cognite3DViewer, toolParameters?: Overlay3DToolParameters);
     /**
      * Creates new OverlayCollection.
      * @param overlays Array of overlays to add.
      * @returns Overlay group containing it's id.
      */
-    createOverlayCollection(overlays?: OverlayInfo<MetadataType>[]): OverlayCollection<MetadataType>;
+    createOverlayCollection(overlays?: OverlayInfo<ContentType>[]): OverlayCollection<ContentType>;
     /**
      * Removes overlays that were added with addOverlays method.
      * @param overlayCollection Id of the overlay group to remove.
      */
-    removeOverlayCollection(overlayCollection: OverlayCollection<MetadataType>): void;
+    removeOverlayCollection(overlayCollection: OverlayCollection<ContentType>): void;
     /**
      * Gets all added overlay collections.
      */
-    get collections(): OverlayCollection<MetadataType>[];
+    getCollections(): OverlayCollection<ContentType>[];
     /**
      * Sets whether overlays are visible.
      */
-    set visible(visible: boolean);
-    get visible(): boolean;
-    set textOverlayVisible(visible: boolean);
-    get textOverlayVisible(): boolean;
+    setVisible(visible: boolean): void;
+    /**
+     * Gets whether overlays are visible.
+     */
+    getVisible(): boolean;
+    /**
+     * Sets whether text overlay is visible.
+     */
+    setTextOverlayVisible(visible: boolean): void;
+    /**
+     * Gets whether text overlay is visible.
+     */
+    getTextOverlayVisible(): boolean;
     /**
      * Removes all overlays.
      */
@@ -70,12 +91,15 @@ export declare class SmartOverlayTool<MetadataType = DefaultMetadataType> extend
      * @param event event to subscribe to.
      * @param eventHandler
      */
-    on(event: 'hover', eventHandler: OverlayEventHandler<MetadataType>): void;
-    on(event: 'click', eventHandler: OverlayEventHandler<MetadataType>): void;
+    on(event: 'hover', eventHandler: OverlayEventHandler<ContentType>): void;
+    on(event: 'click', eventHandler: OverlayEventHandler<ContentType>): void;
     on(event: 'disposed', eventHandler: DisposedDelegate): void;
-    off(event: 'hover', eventHandler: OverlayEventHandler<MetadataType>): void;
-    off(event: 'click', eventHandler: OverlayEventHandler<MetadataType>): void;
+    off(event: 'hover', eventHandler: OverlayEventHandler<ContentType>): void;
+    off(event: 'click', eventHandler: OverlayEventHandler<ContentType>): void;
     off(event: 'disposed', eventHandler: DisposedDelegate): void;
+    /**
+     * Dispose of resources used by this tool
+     */
     dispose(): void;
     private readonly onMouseMove;
     private readonly onMouseClick;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.2.0-dev.20230524",
+  "version": "4.2.0-dev.20230525",
   "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": {
@@ -102,7 +102,7 @@
     "concurrently": "8.0.1",
     "cross-env": "7.0.3",
     "dat.gui": "0.7.9",
-    "eslint": "8.40.0",
+    "eslint": "8.41.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-jsdoc": "44.2.4",