@cognite/reveal 4.19.1 → 4.20.0

package/dist/packages/pointclouds/src/PointCloudNode.d.ts

@@ -5,10 +5,11 @@ import { CameraConfiguration } from '../../utilities';
 import { ClassificationInfo, PointCloudOctree, PickPoint } from './potree-three-loader';
 import { WellKnownAsprsPointClassCodes } from './types';
 import { PointColorType, PointShape, PointSizeType } from '../../rendering';
-import { PointCloudObjectMetadata, PointCloudObject } from '../../data-providers';
-import { CompletePointCloudAppearance, StyledPointCloudObjectCollection } from '../../pointcloud-styling';
+import { DataSourceType, PointCloudObject, PointCloudObjectMetadata } from '../../data-providers';
+import { CompletePointCloudAppearance } from '../../pointcloud-styling';
 import { Matrix4, Group, Box3, Color, type Camera, type Plane, type Ray, type WebGLRenderer } from 'three';
-export declare class PointCloudNode extends Group {
+import { StyledPointCloudVolumeCollection } from '../../pointcloud-styling';
+export declare class PointCloudNode<T extends DataSourceType = DataSourceType> extends Group {
     private readonly _cameraConfiguration?;
     private readonly _octree;
     private readonly _objectIdToAnnotationsMap;
@@ -18,7 +19,7 @@ export declare class PointCloudNode extends Group {
     private readonly _modelIdentifier;
     private readonly _sourceTransform;
     private readonly _customTransform;
-    constructor(modelIdentifier: symbol, sourceTransform: Matrix4, octree: PointCloudOctree, annotations: PointCloudObject[], classificationInfo: ClassificationInfo, cameraConfiguration?: CameraConfiguration);
+    constructor(modelIdentifier: symbol, sourceTransform: Matrix4, octree: PointCloudOctree, annotations: PointCloudObject<T>[], classificationInfo: ClassificationInfo, cameraConfiguration?: CameraConfiguration);
     get modelIdentifier(): symbol;
     get octree(): PointCloudOctree;
     get needsRedraw(): boolean;
@@ -78,13 +79,13 @@ export declare class PointCloudNode extends Group {
     setModelTransformation(matrix: Matrix4): void;
     getModelTransformation(out?: Matrix4): Matrix4;
     getCdfToDefaultModelTransformation(out?: Matrix4): Matrix4;
-    get stylableObjectAnnotationMetadata(): Iterable<PointCloudObjectMetadata>;
-    getStylableObjectMetadata(objectId: number): PointCloudObjectMetadata | undefined;
+    get stylableVolumeMetadata(): Iterable<PointCloudObjectMetadata<T>>;
+    getStylableObjectMetadata(objectId: number): PointCloudObjectMetadata<T> | undefined;
     get stylableObjectCount(): number;
     get defaultAppearance(): CompletePointCloudAppearance;
     set defaultAppearance(appearance: CompletePointCloudAppearance);
     set clippingPlanes(clippingPlanes: Plane[]);
-    assignStyledPointCloudObjectCollection(styledCollection: StyledPointCloudObjectCollection): void;
+    assignStyledPointCloudObjectCollection(styledCollection: StyledPointCloudVolumeCollection<T>): void;
     removeAllStyledPointCloudObjects(): void;
     dispose(): void;
 }

package/dist/packages/pointclouds/src/PointCloudPickingHandler.d.ts

@@ -4,37 +4,8 @@
 import * as THREE from 'three';
 import { IntersectInput } from '../../model-base';
 import { PointCloudNode } from './PointCloudNode';
-import { AnnotationsAssetRef } from '@cognite/sdk';
-export interface IntersectPointCloudNodeResult {
-    /**
-     * Distance from camera to intersected point.
-     */
-    distance: number;
-    /**
-     * Coordinate of the intersected point.
-     */
-    point: THREE.Vector3;
-    /**
-     * Point index in the point cloud of the intersected point.
-     */
-    pointIndex: number;
-    /**
-     * Point cloud node defining what model the point is a part of.
-     */
-    pointCloudNode: PointCloudNode;
-    /**
-     * The geometry object that was intersected.
-     */
-    object: THREE.Object3D;
-    /**
-     * annotationId of the clicked object within a pointcloud.
-     */
-    annotationId: number;
-    /**
-     * asset reference of the clicked object in the pointcloud, if any.
-     */
-    assetRef?: AnnotationsAssetRef;
-}
+import { DataSourceType } from '../../data-providers';
+import { IntersectPointCloudNodeResult } from './types';
 export declare class PointCloudPickingHandler {
     private readonly _normalized;
     private readonly _raycaster;
@@ -42,5 +13,5 @@ export declare class PointCloudPickingHandler {
     private static readonly PickingWindowSize;
     constructor(renderer: THREE.WebGLRenderer);
     dispose(): void;
-    intersectPointClouds(nodes: PointCloudNode[], input: IntersectInput): IntersectPointCloudNodeResult[];
+    intersectPointClouds(nodes: PointCloudNode<DataSourceType>[], input: IntersectInput): IntersectPointCloudNodeResult<DataSourceType>[];
 }

package/dist/packages/pointclouds/src/createPointCloudManager.d.ts

@@ -3,7 +3,7 @@
  */
 import { PointCloudManager } from './PointCloudManager';
 import * as THREE from 'three';
-import { ModelDataProvider, ModelMetadataProvider, PointCloudStylableObjectProvider } from '../../data-providers';
+import { DMDataSourceType, ModelDataProvider, ModelMetadataProvider, PointCloudStylableObjectProvider } from '../../data-providers';
 import { IPointClassificationsProvider } from './classificationsProviders/IPointClassificationsProvider';
 import { PointCloudMaterialManager } from '../../rendering';
-export declare function createPointCloudManager(modelMetadataProvider: ModelMetadataProvider, modelDataProvider: ModelDataProvider, pointCloudStylableObjectProvider: PointCloudStylableObjectProvider, classificationsProvider: IPointClassificationsProvider, pointCloudMaterialManager: PointCloudMaterialManager, scene: THREE.Scene, renderer: THREE.WebGLRenderer): PointCloudManager;
+export declare function createPointCloudManager(modelMetadataProvider: ModelMetadataProvider, modelDataProvider: ModelDataProvider, pointCloudStylableObjectProvider: PointCloudStylableObjectProvider, classificationsProvider: IPointClassificationsProvider, pointCloudDMProvider: PointCloudStylableObjectProvider<DMDataSourceType>, pointCloudMaterialManager: PointCloudMaterialManager, scene: THREE.Scene, renderer: THREE.WebGLRenderer): PointCloudManager;

package/dist/packages/pointclouds/src/potree-three-loader/Potree.d.ts

@@ -4,7 +4,7 @@ import { PointCloudOctree } from './tree/PointCloudOctree';
 import { IPotree } from './types/IPotree';
 import { IPointCloudTreeNodeBase } from './tree/IPointCloudTreeNodeBase';
 import { LRU } from './utils/lru';
-import { ModelDataProvider, PointCloudObject } from '../../../data-providers';
+import { ModelDataProvider, StylableObject } from '../../../data-providers';
 export declare class QueueItem {
     pointCloudIndex: number;
     weight: number;
@@ -23,7 +23,7 @@ export declare class Potree implements IPotree {
     lru: LRU;
     constructor(modelDataProvider: ModelDataProvider, pointCloudMaterialManager: PointCloudMaterialManager);
     reset(): void;
-    loadPointCloud(baseUrl: string, fileName: string, pointCloudObjects: PointCloudObject[], modelIdentifier: symbol): Promise<PointCloudOctree>;
+    loadPointCloud(baseUrl: string, fileName: string, stylableObject: StylableObject[], modelIdentifier: symbol): Promise<PointCloudOctree>;
     updatePointClouds(pointClouds: PointCloudOctree[], camera: Camera, renderer: WebGLRenderer): void;
     set shouldLoad(value: boolean);
     private innerUpdatePointClouds;

package/dist/packages/pointclouds/src/potree-three-loader/loading/EptLoader.d.ts

@@ -1,5 +1,5 @@
-import { ModelDataProvider, PointCloudObject } from '../../../../data-providers';
+import { ModelDataProvider, StylableObject } from '../../../../data-providers';
 import { PointCloudEptGeometry } from '../geometry/PointCloudEptGeometry';
 export declare class EptLoader {
-    static load(baseUrl: string, fileName: string, modelDataProvider: ModelDataProvider, objects: PointCloudObject[]): Promise<PointCloudEptGeometry>;
+    static load(baseUrl: string, fileName: string, modelDataProvider: ModelDataProvider, stylableObjects: StylableObject[]): Promise<PointCloudEptGeometry>;
 }

package/dist/packages/pointclouds/src/potree-three-loader/types/IPotree.d.ts

@@ -1,11 +1,11 @@
 import { Camera, WebGLRenderer } from 'three';
 import { LRU } from '../utils/lru';
 import { PointCloudOctree } from '../tree/PointCloudOctree';
-import { PointCloudObject } from '../../../../data-providers';
+import { StylableObject } from '../../../../data-providers';
 export interface IPotree {
     pointBudget: number;
     maxNumNodesLoading: number;
     lru: LRU;
-    loadPointCloud(baseUrl: string, fileName: string, objects: PointCloudObject[], modelIdentifier: symbol): Promise<PointCloudOctree>;
+    loadPointCloud(baseUrl: string, fileName: string, stylableObject: StylableObject[], modelIdentifier: symbol): Promise<PointCloudOctree>;
     updatePointClouds(pointClouds: PointCloudOctree[], camera: Camera, renderer: WebGLRenderer): void;
 }

package/dist/packages/pointclouds/src/potree-three-loader/utils/createObjectIdMaps.d.ts

@@ -1,6 +1,6 @@
 /*!
  * Copyright 2022 Cognite AS
  */
-import { PointCloudObject } from '../../../../data-providers';
+import { PointCloudObject, DataSourceType } from '../../../../data-providers';
 import { PointCloudObjectIdMaps } from '../../../../rendering';
-export declare function createObjectIdMaps(objects: PointCloudObject[]): PointCloudObjectIdMaps;
+export declare function createObjectIdMaps<T extends DataSourceType>(objects: PointCloudObject<T>[]): PointCloudObjectIdMaps;

package/dist/packages/pointclouds/src/typeGuards.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2024 Cognite AS
+ */
+import { ClassicDataSourceType, DataSourceType, DMDataSourceType } from '../../data-providers';
+import { CognitePointCloudModel } from './CognitePointCloudModel';
+/**
+ * Type guard to check if a point cloud model is DMDataSourceType type.
+ * @param model - The object to check.
+ * @returns True if the object is of type `CognitePointCloudModel<DMDataSourceType>`, false otherwise.
+ */
+export declare function isDMPointCloudModel(model: CognitePointCloudModel<DataSourceType>): model is CognitePointCloudModel<DMDataSourceType>;
+/**
+ * Type guard to check if a point cloud model is ClassicDataSourceType type.
+ * @param model - The object to check.
+ * @returns True if the object is of type `CognitePointCloudModel<ClassicDataSourceType>`, false otherwise.
+ */
+export declare function isClassicPointCloudModel(model: CognitePointCloudModel<DataSourceType>): model is CognitePointCloudModel<ClassicDataSourceType>;

package/dist/packages/pointclouds/src/types.d.ts

@@ -1,6 +1,9 @@
 /*!
  * Copyright 2021 Cognite AS
  */
+import { Object3D, Vector3 } from 'three';
+import { PointCloudNode } from './PointCloudNode';
+import { DataSourceType } from '../../data-providers';
 /**
  * ASPRS well known point class types.
  * @see {@link http://www.asprs.org/wp-content/uploads/2019/03/LAS_1_4_r14.pdf} (page 30)
@@ -77,3 +80,29 @@ export declare enum WellKnownAsprsPointClassCodes {
      */
     TemporalExclusion = 22
 }
+export type IntersectPointCloudNodeResult<T extends DataSourceType> = {
+    /**
+     * Distance from camera to intersected point.
+     */
+    distance: number;
+    /**
+     * Coordinate of the intersected point.
+     */
+    point: Vector3;
+    /**
+     * Point index in the point cloud of the intersected point.
+     */
+    pointIndex: number;
+    /**
+     * Point cloud node defining what model the point is a part of.
+     */
+    pointCloudNode: PointCloudNode<T>;
+    /**
+     * The geometry object that was intersected.
+     */
+    object: Object3D;
+    /**
+     * Volume metadata, e.g. asset reference
+     */
+    volumeMetadata?: T['pointCloudVolumeMetadata'];
+};

package/dist/packages/rendering/src/pointcloud-rendering/PointCloudObjectAppearanceTexture.d.ts

@@ -2,8 +2,9 @@
  * Copyright 2022 Cognite AS
  */
 import * as THREE from 'three';
-import { StyledPointCloudObjectCollection, PointCloudObjectCollection, CompletePointCloudAppearance } from '../../../pointcloud-styling';
+import { PointCloudAnnotationVolumeCollection, CompletePointCloudAppearance, StyledPointCloudVolumeCollection } from '../../../pointcloud-styling';
 import { PointCloudObjectIdMaps } from './PointCloudObjectIdMaps';
+import { DataSourceType } from '../../../data-providers';
 export declare class PointCloudObjectAppearanceTexture {
     private readonly _objectStyleTexture;
     private _needsReconstruction;
@@ -19,8 +20,8 @@ export declare class PointCloudObjectAppearanceTexture {
     private setObjectCollectionStyle;
     private resetTexture;
     onBeforeRender(): void;
-    assignStyledObjectSet(styledCollection: StyledPointCloudObjectCollection): void;
-    removeStyledObjectSet(collection: PointCloudObjectCollection): void;
+    assignStyledObjectSet(styledCollection: StyledPointCloudVolumeCollection<DataSourceType>): void;
+    removeStyledObjectSet(collection: PointCloudAnnotationVolumeCollection): void;
     removeAllStyledObjectSets(): void;
     set defaultAppearance(appearance: CompletePointCloudAppearance);
     get defaultAppearance(): CompletePointCloudAppearance;

package/dist/packages/rendering/src/pointcloud-rendering/PointCloudObjectIdMaps.d.ts

@@ -1,7 +1,8 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+import { DMInstanceRef } from '../../../data-providers';
 export type PointCloudObjectIdMaps = {
-    annotationToObjectIds: Map<number, number>;
-    objectToAnnotationIds: Map<number, number>;
+    annotationToObjectIds: Map<number | DMInstanceRef, number>;
+    objectToAnnotationIds: Map<number, number | DMInstanceRef>;
 };

package/dist/packages/tools/src/AxisGizmo/AxisGizmoTool.d.ts

@@ -1,6 +1,7 @@
 import { AxisGizmoOptions } from './AxisGizmoOptions';
 import { Cognite3DViewer } from '../../../api';
 import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
+import { DataSourceType } from '../../../data-providers';
 /**
  * Class for axis gizmo like the one in Blender
  * @beta
@@ -32,7 +33,7 @@ export declare class AxisGizmoTool extends Cognite3DViewerToolBase {
      * changed size by changing the fields: size, corner, yMargin and yMargin
      * in the AxisGizmoOptions
      */
-    connect(viewer: Cognite3DViewer): void;
+    connect(viewer: Cognite3DViewer<DataSourceType>): void;
     get options(): AxisGizmoOptions;
     private onPointerDown;
     private onPointerUp;

package/dist/packages/tools/src/DebugCameraTool.d.ts

@@ -3,12 +3,13 @@
  */
 import { Cognite3DViewerToolBase } from './Cognite3DViewerToolBase';
 import { Cognite3DViewer } from '../../api';
+import { DataSourceType } from '../../data-providers';
 export declare class DebugCameraTool extends Cognite3DViewerToolBase {
     private readonly _viewer;
     private readonly _onViewerDisposedHandler;
     private _cameraHelper?;
     private get viewerCamera();
-    constructor(viewer: Cognite3DViewer);
+    constructor(viewer: Cognite3DViewer<DataSourceType>);
     /**
      * Removes all elements and detaches from the viewer.
      * @override

package/dist/packages/tools/src/HtmlOverlay/HtmlOverlayTool.d.ts

@@ -4,6 +4,7 @@
 import * as THREE from 'three';
 import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
 import { Cognite3DViewer } from '../../../api';
+import { DataSourceType } from '../../../data-providers';
 /**
  * Callback that is triggered whenever the 2D position of an overlay is updated
  * in {@link HtmlOverlayTool}.
@@ -114,7 +115,7 @@ export declare class HtmlOverlayTool extends Cognite3DViewerToolBase {
     private get viewerDomElement();
     private get viewerCamera();
     private get viewerCanvas();
-    constructor(viewer: Cognite3DViewer, options?: HtmlOverlayToolOptions);
+    constructor(viewer: Cognite3DViewer<DataSourceType>, options?: HtmlOverlayToolOptions);
     /**
      * Returns all added HTML elements along with their 3D positions.
      */

package/dist/packages/tools/src/Measurement/MeasurementTool.d.ts

@@ -6,6 +6,7 @@ import { Cognite3DViewerToolBase } from '../Cognite3DViewerToolBase';
 import { DisposedDelegate } from '../../../utilities';
 import * as THREE from 'three';
 import { MeasurementAddedDelegate, MeasurementStartedDelegate, MeasurementEndedDelegate, MeasurementOptions, Measurement } from './types';
+import { DataSourceType } from '../../../data-providers';
 /**
  * Enables {@link Cognite3DViewer} to perform a point to point measurement.
  * This can be achieved by selecting a point on the 3D Object and drag the pointer to
@@ -55,7 +56,7 @@ export declare class MeasurementTool extends Cognite3DViewerToolBase {
     private readonly _events;
     private readonly _overlayOptions;
     private static readonly defaultLineOptions;
-    constructor(viewer: Cognite3DViewer, options?: MeasurementOptions);
+    constructor(viewer: Cognite3DViewer<DataSourceType>, options?: MeasurementOptions);
     /**
      * Triggered when the tool is disposed. Listeners should clean up any
      * resources held and remove the reference to the tool.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.19.1",
+  "version": "4.20.0",
   "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": {
@@ -15,7 +15,8 @@
     "Håkon Flatval <hakon.flatval@cognite.com>",
     "Savelii Novikov <savelii.novikov@cognite.com>",
     "Pramod S <pramod.s@cognite.com>",
-    "Astrid Kløve-Graue <astrid.graue@cognite.com>"
+    "Astrid Kløve-Graue <astrid.graue@cognite.com>",
+    "Nils Petter Fremming <nils.fremming@cognite.com>"
   ],
   "sideEffects": false,
   "main": "dist/index.js",

package/dist/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.d.ts

@@ -1,13 +0,0 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-import { PointCloudObjectCollection } from './PointCloudObjectCollection';
-import { CompletePointCloudAppearance } from './PointCloudAppearance';
-/**
- * Represents an object collection that is associated with an appearance
- */
-export declare class StyledPointCloudObjectCollection {
-    objectCollection: PointCloudObjectCollection;
-    style: CompletePointCloudAppearance;
-    constructor(objectCollection: PointCloudObjectCollection, style: CompletePointCloudAppearance);
-}