@cognite/reveal 3.1.0 → 4.0.0-dev.20221025

package/packages/nodes-api/src/NodesLocalClient.d.ts

@@ -1,30 +1,30 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { NodesApiClient } from './NodesApiClient';
-import { CogniteInternalId } from '@cognite/sdk';
-export declare class NodesLocalClient implements NodesApiClient {
-    constructor();
-    mapTreeIndicesToNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
-    mapNodeIdsToTreeIndices(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
-    /**
-     * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
-     * of) given a set of node IDs.
-     */
-    determineTreeIndexAndSubtreeSizesByNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeIds: CogniteInternalId[]): Promise<{
-        treeIndex: number;
-        subtreeSize: number;
-    }[]>;
-    /**
-     * Not supported.
-     */
-    determineNodeAncestorsByNodeId(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeId: CogniteInternalId, _generation: number): Promise<{
-        treeIndex: number;
-        subtreeSize: number;
-    }>;
-    /**
-     * Not supported.
-     */
-    getBoundingBoxesByNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeIds: CogniteInternalId[]): Promise<THREE.Box3[]>;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { NodesApiClient } from './NodesApiClient';
+import { CogniteInternalId } from '@cognite/sdk';
+export declare class NodesLocalClient implements NodesApiClient {
+    constructor();
+    mapTreeIndicesToNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
+    mapNodeIdsToTreeIndices(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
+    /**
+     * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
+     * of) given a set of node IDs.
+     */
+    determineTreeIndexAndSubtreeSizesByNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeIds: CogniteInternalId[]): Promise<{
+        treeIndex: number;
+        subtreeSize: number;
+    }[]>;
+    /**
+     * Not supported.
+     */
+    determineNodeAncestorsByNodeId(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeId: CogniteInternalId, _generation: number): Promise<{
+        treeIndex: number;
+        subtreeSize: number;
+    }>;
+    /**
+     * Not supported.
+     */
+    getBoundingBoxesByNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeIds: CogniteInternalId[]): Promise<THREE.Box3[]>;
+}

package/packages/nodes-api/src/types.d.ts

@@ -1,10 +1,10 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CogniteInternalId } from '@cognite/sdk';
-export declare type ByTreeIndicesResponse = {
-    items: CogniteInternalId[];
-};
-export declare type ByNodeIdsResponse = {
-    items: number[];
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CogniteInternalId } from '@cognite/sdk';
+export declare type ByTreeIndicesResponse = {
+    items: CogniteInternalId[];
+};
+export declare type ByNodeIdsResponse = {
+    items: number[];
+};

package/packages/pointcloud-styling/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export { CompletePointCloudAppearance, PointCloudAppearance, DefaultPointCloudAppearance, applyDefaultsToPointCloudAppearance } from './src/PointCloudAppearance';
+export { StyledPointCloudObjectCollection } from './src/StyledPointCloudObjectCollection';
+export { PointCloudObjectCollection } from './src/PointCloudObjectCollection';
+export { AnnotationIdPointCloudObjectCollection } from './src/AnnotationIdPointCloudObjectCollection';

package/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { PointCloudObjectCollection } from './PointCloudObjectCollection';
+/**
+ * A simple PointCloudObjectCollection that consists of an explicitly provided list of annotation IDs
+ */
+export declare class AnnotationIdPointCloudObjectCollection extends PointCloudObjectCollection {
+    private readonly _annotationIds;
+    constructor(ids: Iterable<number>);
+    getAnnotationIds(): Iterable<number>;
+    get isLoading(): false;
+}

package/packages/pointcloud-styling/src/PointCloudAppearance.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export declare type PointCloudAppearance = {
+    color?: [number, number, number];
+    visible?: boolean;
+};
+export declare type CompletePointCloudAppearance = Required<PointCloudAppearance>;
+export declare const DefaultPointCloudAppearance: CompletePointCloudAppearance;
+export declare function applyDefaultsToPointCloudAppearance(appearance: PointCloudAppearance): CompletePointCloudAppearance;

package/packages/pointcloud-styling/src/PointCloudObjectCollection.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+/**
+ * Base class for collections of point cloud objects intended for styling operations
+ */
+export declare abstract class PointCloudObjectCollection {
+    private readonly _changedEvent;
+    /**
+     * @returns annotation IDs of the annotations for the objects represented by this PointCloudObjectCollection instance
+     */
+    abstract getAnnotationIds(): Iterable<number>;
+    /**
+     * @returns whether the collection is still loading data in the background i.e. not yet ready for use
+     */
+    abstract get isLoading(): boolean;
+    on(event: 'changed', listener: () => void): void;
+    off(event: 'changed', listener: () => void): void;
+    /**
+     * Triggers the changed-event.
+     */
+    protected notifyChanged(): void;
+}

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

@@ -0,0 +1,13 @@
+/*!
+ * 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);
+}

package/packages/pointclouds/index.d.ts

@@ -1,15 +1,18 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-export { intersectPointClouds } from './src/picking';
-export { WellKnownAsprsPointClassCodes } from './src/types';
-export { PotreePointShape, PotreePointColorType, PotreePointSizeType } from './src/potree-three-loader';
-export { PointCloudNode } from './src/PointCloudNode';
-export { PointCloudManager } from './src/PointCloudManager';
-export { createPointCloudManager } from './src/createPointCloudManager';
-export { PointCloudBudget } from './src/PointCloudBudget';
-export { PointCloudIntersection } from './src/PointCloudIntersection';
-export { CognitePointCloudModel } from './src/CognitePointCloudModel';
-export { PotreeNodeWrapper } from './src/PotreeNodeWrapper';
-export { PotreeGroupWrapper } from './src/PotreeGroupWrapper';
-export { Potree, PointCloudOctree } from './src/PotreePnextLoader';
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export { PointCloudPickingHandler } from './src/PointCloudPickingHandler';
+export { WellKnownAsprsPointClassCodes } from './src/types';
+export { PointCloudNode } from './src/PointCloudNode';
+export { PointCloudManager } from './src/PointCloudManager';
+export { createPointCloudManager } from './src/createPointCloudManager';
+export { PointCloudBudget } from './src/PointCloudBudget';
+export { PointCloudIntersection } from './src/PointCloudIntersection';
+export { CognitePointCloudModel } from './src/CognitePointCloudModel';
+export { PotreeNodeWrapper } from './src/PotreeNodeWrapper';
+export { PotreeGroupWrapper } from './src/PotreeGroupWrapper';
+export { Potree, PointCloudOctree } from './src/PotreePnextLoader';
+export { PointCloudFactory } from './src/PointCloudFactory';
+export { IPointClassificationsProvider } from './src/classificationsProviders/IPointClassificationsProvider';
+export { LocalPointClassificationsProvider } from './src/classificationsProviders/LocalPointClassificationsProvider';
+export { UrlPointClassificationsProvider } from './src/classificationsProviders/UrlPointClassificationsProvider';

package/packages/pointclouds/src/CognitePointCloudModel.d.ts

@@ -1,131 +1,182 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { CameraConfiguration } from '../../utilities';
-import { WellKnownAsprsPointClassCodes } from './types';
-import { PotreePointColorType, PotreePointShape, PotreePointSizeType } from './potree-three-loader';
-import { SupportedModelTypes, CogniteModelBase } from '../../model-base';
-/**
- * Represents a point clouds model loaded from CDF.
- * @noInheritDoc
- * @module @cognite/reveal
- */
-export declare class CognitePointCloudModel extends THREE.Object3D implements CogniteModelBase {
-    readonly type: SupportedModelTypes;
-    readonly modelId: number;
-    /**
-     * The modelId of the point cloud model in Cognite Data Fusion.
-     */
-    readonly revisionId: number;
-    /**
-     * Used to clean up memory.
-     */
-    dispose(): void;
-    /**
-     * @param outBbox Optional. Used to write result to.
-     * @returns Model's bounding box.
-     * @example
-     * ```js
-     * const box = new THREE.Box3()
-     * model.getModelBoundingBox(box);
-     * // box now has the bounding box
-     *```
-     * ```js
-     * // the following code does the same
-     * const box = model.getModelBoundingBox();
-     * ```
-     */
-    getModelBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
-    /**
-     * Retrieves the camera position and target stored for the model. Typically this
-     * is used to store a good starting position for a model. Returns `undefined` if there
-     * isn't any stored camera configuration for the model.
-     */
-    getCameraConfiguration(): CameraConfiguration | undefined;
-    /**
-     * Sets transformation matrix of the model. This overrides the current transformation.
-     * @param transformationMatrix
-     */
-    setModelTransformation(transformationMatrix: THREE.Matrix4): void;
-    /**
-     * Gets transformation matrix of the model.
-     * @param out Preallocated `THREE.Matrix4` (optional).
-     */
-    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
-    /**
-     * Sets a visible filter on points of a given class.
-     * @param pointClass ASPRS classification class code. Either one of the well known
-     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
-     * @param visible Boolean flag that determines if the point class type should be visible or not.
-     * @throws Error if the model doesn't have the class given.
-     */
-    setClassVisible(pointClass: number | WellKnownAsprsPointClassCodes, visible: boolean): void;
-    /**
-     * Determines if points from a given class are visible.
-     * @param pointClass ASPRS classification class code. Either one of the well known
-     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
-     * @returns True if points from the given class will be visible.
-     * @throws Error if the model doesn't have the class given.
-     */
-    isClassVisible(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
-    /**
-     * Returns true if the model has values with the given classification class.
-     * @param pointClass ASPRS classification class code. Either one of the well known
-     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
-     * @returns True if model has values in the class given.
-     */
-    hasClass(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
-    /**
-     * Returns a list of sorted classification codes present in the model.
-     * @returns A sorted list of classification codes from the model.
-     */
-    getClasses(): Array<number | WellKnownAsprsPointClassCodes>;
-    /**
-     * Returns the current number of visible/loaded points.
-     */
-    get visiblePointCount(): number;
-    /**
-     * Determines how points currently are colored.
-     */
-    get pointColorType(): PotreePointColorType;
-    /**
-     * Specifies how points are colored.
-     * @default PotreePointColorType.Rgb
-     * @example
-     * ```js
-     * model.pointColorType = PotreePointColorType.Rgb
-     * ```
-     */
-    set pointColorType(type: PotreePointColorType);
-    /**
-     * Returns the size of each rendered point in the point cloud.
-     */
-    get pointSize(): number;
-    /**
-     * Sets the size of each rendered point in the point cloud.
-     * @default `1`
-     */
-    set pointSize(size: number);
-    /**
-     * Get the point size type.
-     */
-    get pointSizeType(): PotreePointSizeType;
-    /**
-     * Set the point size type for the point cloud.
-     * The point size type can be either Fixed or Adaptive.
-     * @default `PotreePointSizeType.Adaptive`
-     */
-    set pointSizeType(type: PotreePointSizeType);
-    /**
-     * Sets the point shape of each rendered point in the point cloud.
-     * @default `PotreePointShape.Circle`
-     * @see {@link PotreePointShape}.
-     */
-    get pointShape(): PotreePointShape;
-    /**
-     * Gets the point shape of each rendered point in the point cloud.
-     * @see {@link PotreePointShape}.
-     */
-    set pointShape(shape: PotreePointShape);
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { CameraConfiguration } from '../../utilities';
+import { WellKnownAsprsPointClassCodes } from './types';
+import { PointColorType, PointShape, PointSizeType } from '../../rendering';
+import { SupportedModelTypes, CogniteModelBase } from '../../model-base';
+import { PointCloudObjectMetadata } from '../../data-providers';
+import { StyledPointCloudObjectCollection, PointCloudObjectCollection, PointCloudAppearance } from '../../pointcloud-styling';
+/**
+ * Represents a point clouds model loaded from CDF.
+ * @noInheritDoc
+ * @module @cognite/reveal
+ */
+export declare class CognitePointCloudModel implements CogniteModelBase {
+    readonly type: SupportedModelTypes;
+    readonly modelId: number;
+    /**
+     * The modelId of the point cloud model in Cognite Data Fusion.
+     */
+    readonly revisionId: number;
+    private readonly _styledObjectCollections;
+    /**
+     * Used to clean up memory.
+     */
+    dispose(): void;
+    /**
+     * @param outBbox Optional. Used to write result to.
+     * @returns Model's bounding box.
+     * @example
+     * ```js
+     * const box = new THREE.Box3()
+     * model.getModelBoundingBox(box);
+     * // box now has the bounding box
+     *```
+     * ```js
+     * // the following code does the same
+     * const box = model.getModelBoundingBox();
+     * ```
+     */
+    getModelBoundingBox(outBbox?: THREE.Box3): THREE.Box3;
+    /**
+     * Retrieves the camera position and target stored for the model. Typically this
+     * is used to store a good starting position for a model. Returns `undefined` if there
+     * isn't any stored camera configuration for the model.
+     */
+    getCameraConfiguration(): CameraConfiguration | undefined;
+    /**
+     * Sets transformation matrix of the model. This overrides the current transformation.
+     * @param transformationMatrix
+     */
+    setModelTransformation(transformationMatrix: THREE.Matrix4): void;
+    /**
+     * Gets transformation matrix of the model.
+     * @param out Preallocated `THREE.Matrix4` (optional).
+     */
+    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+    /**
+     * Sets a visible filter on points of a given class.
+     * @param pointClass ASPRS classification class code. Either one of the well known
+     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
+     * @param visible Boolean flag that determines if the point class type should be visible or not.
+     * @throws Error if the model doesn't have the class given.
+     */
+    setClassVisible(pointClass: number | WellKnownAsprsPointClassCodes, visible: boolean): void;
+    /**
+     * Determines if points from a given class are visible.
+     * @param pointClass ASPRS classification class code. Either one of the well known
+     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
+     * @returns True if points from the given class will be visible.
+     * @throws Error if the model doesn't have the class given.
+     */
+    isClassVisible(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
+    /**
+     * Returns true if the model has values with the given classification class.
+     * @param pointClass ASPRS classification class code. Either one of the well known
+     * classes from {@link WellKnownAsprsPointClassCodes} or a number for user defined classes.
+     * @returns True if model has values in the class given.
+     */
+    hasClass(pointClass: number | WellKnownAsprsPointClassCodes): boolean;
+    /**
+     * Returns a list of sorted classification names and codes present in the model.
+     * Names will be the custom names provided by the user, or a default one if none have been provided.
+     * @returns A sorted list of classification codes and names from the model.
+     */
+    getClasses(): Array<{
+        name: string;
+        code: number | WellKnownAsprsPointClassCodes;
+    }>;
+    /**
+     * Returns the current number of visible/loaded points.
+     */
+    get visiblePointCount(): number;
+    /**
+     * Determines how points currently are colored.
+     */
+    get pointColorType(): PointColorType;
+    /**
+     * Specifies how points are colored.
+     * @default PointColorType.Rgb
+     * @example
+     * ```js
+     * model.pointColorType = PointColorType.Rgb
+     * ```
+     */
+    set pointColorType(type: PointColorType);
+    /**
+     * Returns the size of each rendered point in the point cloud.
+     */
+    get pointSize(): number;
+    /**
+     * Sets the size of each rendered point in the point cloud.
+     * @default `1`
+     */
+    set pointSize(size: number);
+    /**
+     * Get the point size type.
+     */
+    get pointSizeType(): PointSizeType;
+    /**
+     * Set the point size type for the point cloud.
+     * The point size type can be either Fixed or Adaptive.
+     * @default `PointSizeType.Adaptive`
+     */
+    set pointSizeType(type: PointSizeType);
+    /**
+     * Sets the point shape of each rendered point in the point cloud.
+     * @default `PointShape.Circle`
+     * @see {@link PointShape}.
+     */
+    get pointShape(): PointShape;
+    /**
+     * Gets the point shape of each rendered point in the point cloud.
+     * @see {@link PointShape}.
+     */
+    set pointShape(shape: PointShape);
+    /**
+     * Gets default point appearance
+     */
+    getDefaultPointCloudAppearance(): PointCloudAppearance;
+    /**
+     * Sets default apparance for points that are not styled otherwise
+     * @param appearance Appearance to assign as default
+     */
+    setDefaultPointCloudAppearance(appearance: PointCloudAppearance): void;
+    /**
+     * Gets the object collections that have been assigned a style
+     * @returns All object collections and their associated style
+     */
+    get styledCollections(): StyledPointCloudObjectCollection[];
+    /**
+     * Assign a style to a collection of objects. If the object collection has been assigned
+     * a style previously, the previous style will be replaced by the new one.
+     * @param objectCollection The object collection to assign a style to
+     * @param appearance The style to assign to the object collection
+     */
+    assignStyledObjectCollection(objectCollection: PointCloudObjectCollection, appearance: PointCloudAppearance): void;
+    /**
+     * Unassign style from an already styled object collection.
+     * @param objectCollection The object collection from which to remove the style
+     */
+    unassignStyledObjectCollection(objectCollection: PointCloudObjectCollection): void;
+    /**
+     * Removes styling on all object collections in this model
+     */
+    removeAllStyledObjectCollections(): void;
+    /**
+     * @returns The number of stylable objects
+     */
+    get stylableObjectCount(): number;
+    /**
+     * Iterates through all stylable objects for this model
+     * @example
+     * ```js
+     * model.traverseStylableObjects(
+     *     annotationMetadata => console.log(annotationMetadata.annotationId)
+     * );
+     * ```
+     */
+    traverseStylableObjects(callback: (annotationMetadata: PointCloudObjectMetadata) => void): void;
+}

package/packages/pointclouds/src/PointCloudBudget.d.ts

@@ -1,14 +1,14 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-/**
- * Represents a budget of how many point from point clouds can be
- * loaded at the same time.
- */
-export declare type PointCloudBudget = {
-    /**
-     * Total number of points that can be loaded for all point clouds models
-     * accumulated.
-     */
-    readonly numberOfPoints: number;
-};
+/*!
+ * Copyright 2022 Cognite AS
+ */
+/**
+ * Represents a budget of how many point from point clouds can be
+ * loaded at the same time.
+ */
+export declare type PointCloudBudget = {
+    /**
+     * Total number of points that can be loaded for all point clouds models
+     * accumulated.
+     */
+    readonly numberOfPoints: number;
+};

package/packages/pointclouds/src/PointCloudFactory.d.ts

@@ -1,13 +1,18 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { PotreeNodeWrapper } from './PotreeNodeWrapper';
-import { PointCloudMetadata } from './PointCloudMetadata';
-import { ModelDataProvider } from '../../modeldata-api';
-import { Potree } from './potree-three-loader';
-export declare class PointCloudFactory {
-    private readonly _potreeInstance;
-    constructor(modelLoader: ModelDataProvider);
-    get potreeInstance(): Potree;
-    createModel(modelMetadata: PointCloudMetadata): Promise<PotreeNodeWrapper>;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { PotreeNodeWrapper } from './PotreeNodeWrapper';
+import { PointCloudMetadata } from './PointCloudMetadata';
+import { PointCloudStylableObjectProvider } from '../../data-providers';
+import { IPointClassificationsProvider } from './classificationsProviders/IPointClassificationsProvider';
+import { ModelDataProvider } from '../../data-providers';
+import { PointCloudMaterialManager } from '../../rendering';
+export declare class PointCloudFactory {
+    private readonly _potreeInstance;
+    private readonly _pointCloudObjectProvider;
+    private readonly _classificationsProvider;
+    private readonly _pointCloudMaterialManager;
+    constructor(modelLoader: ModelDataProvider, pointCloudObjectProvider: PointCloudStylableObjectProvider, classificationsProvider: IPointClassificationsProvider, pointCloudMaterialManager: PointCloudMaterialManager);
+    dispose(): void;
+    createModel(modelMetadata: PointCloudMetadata): Promise<PotreeNodeWrapper>;
+}

package/packages/pointclouds/src/PointCloudIntersection.d.ts

@@ -1,26 +1,30 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-import { CognitePointCloudModel } from './CognitePointCloudModel';
-export declare type PointCloudIntersection = {
-    /**
-     * The intersection type.
-     */
-    type: 'pointcloud';
-    /**
-     * The model that was intersected.
-     */
-    model: CognitePointCloudModel;
-    /**
-     * Tree index of the intersected 3D node.
-     */
-    point: THREE.Vector3;
-    /**
-     * The index of the point that was intersected.
-     */
-    pointIndex: number;
-    /**
-     * Distance from the camera to the intersection.
-     */
-    distanceToCamera: number;
-};
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { CognitePointCloudModel } from './CognitePointCloudModel';
+export declare type PointCloudIntersection = {
+    /**
+     * The intersection type.
+     */
+    type: 'pointcloud';
+    /**
+     * The model that was intersected.
+     */
+    model: CognitePointCloudModel;
+    /**
+     * Tree index of the intersected 3D node.
+     */
+    point: THREE.Vector3;
+    /**
+     * The index of the point that was intersected.
+     */
+    pointIndex: number;
+    /**
+     * Distance from the camera to the intersection.
+     */
+    distanceToCamera: number;
+    /**
+     * Annotation Id of the intersected object within a pointcloud. (0 if not applicable)
+     */
+    annotationId: number;
+};