From 87e6f628cc3b5cb64e704a9f4b43a4afd5c660eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kon=20Flatval?= <70905152+haakonflatval-cognite@users.noreply.github.com> Date: Mon, 26 Jun 2023 09:39:06 +0200 Subject: [PATCH] docs: update 4.x docs with image360 updates from 4.3 (#3406) --- ....AnnotationIdPointCloudObjectCollection.md | 10 +- .../cognite_reveal.AssetNodeCollection.md | 24 +- .../cognite_reveal.BoundingBoxClipper.md | 28 +- .../cognite_reveal.CameraManagerHelper.md | 31 +- .../cognite_reveal.CdfNodeCollectionBase.md | 18 +- .../cognite_reveal.ClusteredAreaCollection.md | 10 +- .../classes/cognite_reveal.Cognite3DViewer.md | 198 +++++++--- .../classes/cognite_reveal.CogniteCadModel.md | 78 ++-- .../cognite_reveal.CognitePointCloudModel.md | 74 ++-- ...ognite_reveal.CombineNodeCollectionBase.md | 22 +- .../classes/cognite_reveal.ComboControls.md | 28 +- ..._reveal.DebouncedCameraStopEventTrigger.md | 8 +- .../cognite_reveal.DefaultCameraManager.md | 42 +-- .../api/classes/cognite_reveal.IndexSet.md | 38 +- ...gnite_reveal.IntersectionNodeCollection.md | 26 +- .../cognite_reveal.InvertedNodeCollection.md | 20 +- .../classes/cognite_reveal.NodeCollection.md | 16 +- .../cognite_reveal.NodeIdNodeCollection.md | 24 +- .../classes/cognite_reveal.NumericRange.md | 34 +- ...gnite_reveal.PointCloudObjectCollection.md | 8 +- ...ite_reveal.PropertyFilterNodeCollection.md | 22 +- ...veal.SinglePropertyFilterNodeCollection.md | 24 +- ...reveal.StyledPointCloudObjectCollection.md | 6 +- .../api/classes/cognite_reveal.ThickLine.md | 201 ++++++++++ .../cognite_reveal.TreeIndexNodeCollection.md | 36 +- .../cognite_reveal.UnionNodeCollection.md | 24 +- ...xtensions_datasource.CdfModelIdentifier.md | 10 +- .../cognite_reveal_tools.AxisViewTool.md | 8 +- ...te_reveal_tools.Cognite3DViewerToolBase.md | 8 +- .../cognite_reveal_tools.DebugCameraTool.md | 12 +- .../cognite_reveal_tools.HtmlOverlayTool.md | 20 +- .../classes/cognite_reveal_tools.Keyframe.md | 12 +- .../cognite_reveal_tools.MeasurementTool.md | 46 +-- .../cognite_reveal_tools.SmartOverlayTool.md | 348 ++++++++++++++++++ .../cognite_reveal_tools.TimelineTool.md | 28 +- .../enums/cognite_reveal.NodeOutlineColor.md | 16 +- .../enums/cognite_reveal.PointColorType.md | 18 +- .../api/enums/cognite_reveal.PointShape.md | 6 +- .../api/enums/cognite_reveal.PointSizeType.md | 6 +- ...te_reveal.WellKnownAsprsPointClassCodes.md | 50 +-- ...veal_extensions_datasource.File3dFormat.md | 6 +- .../api/enums/cognite_reveal_tools.Corner.md | 8 +- .../cognite_reveal.AddModelOptions.md | 8 +- .../cognite_reveal.AreaCollection.md | 10 +- .../cognite_reveal.CameraManager.md | 36 +- ...veal.CdfModelNodeCollectionDataProvider.md | 10 +- .../cognite_reveal.Cognite3DViewerOptions.md | 34 +- .../api/interfaces/cognite_reveal.Image360.md | 56 ++- .../cognite_reveal.Image360Annotation.md | 88 +++++ .../cognite_reveal.Image360Collection.md | 71 +++- .../cognite_reveal.Image360Revision.md | 39 ++ .../cognite_reveal.Image360Visualization.md | 2 +- .../interfaces/cognite_reveal.Overlay3D.md | 118 ++++++ .../cognite_reveal.OverlayCollection.md | 114 ++++++ ...xtensions_datasource.BinaryFileProvider.md | 2 +- ...xtensions_datasource.BlobOutputMetadata.md | 6 +- ...reveal_extensions_datasource.DataSource.md | 6 +- ..._extensions_datasource.JsonFileProvider.md | 2 +- ...extensions_datasource.ModelDataProvider.md | 4 +- ...l_extensions_datasource.ModelIdentifier.md | 2 +- ...nsions_datasource.ModelMetadataProvider.md | 8 +- ...al_extensions_datasource.NodesApiClient.md | 10 +- .../version-4.x/api/modules/cognite_reveal.md | 266 ++++++++++--- .../api/modules/cognite_reveal_tools.md | 97 ++++- .../examples/image360-annotations.mdx | 78 ++++ .../version-4.x/examples/image360.mdx | 29 +- 66 files changed, 2105 insertions(+), 643 deletions(-) create mode 100644 documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ThickLine.md create mode 100644 documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.SmartOverlayTool.md create mode 100644 documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Annotation.md create mode 100644 documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Revision.md create mode 100644 documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Overlay3D.md create mode 100644 documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.OverlayCollection.md create mode 100644 documentation/versioned_docs/version-4.x/examples/image360-annotations.mdx diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AnnotationIdPointCloudObjectCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AnnotationIdPointCloudObjectCollection.md index 491e4b6f151..af4dc1af30a 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AnnotationIdPointCloudObjectCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AnnotationIdPointCloudObjectCollection.md @@ -33,7 +33,7 @@ A simple PointCloudObjectCollection that consists of an explicitly provided list #### Defined in -[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L13) +[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L13) ## Accessors @@ -53,7 +53,7 @@ PointCloudObjectCollection.isLoading #### Defined in -[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L22) +[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L22) ## Methods @@ -73,7 +73,7 @@ annotation IDs of the annotations for the objects represented by this PointCloud #### Defined in -[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L18) +[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L18) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) ___ @@ -123,4 +123,4 @@ ___ #### Defined in -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L25) +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AssetNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AssetNodeCollection.md index e284c8a892c..4c90144da6a 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AssetNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AssetNodeCollection.md @@ -37,7 +37,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L36) +[packages/cad-styling/src/AssetNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L36) ## Properties @@ -47,7 +47,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L27) +[packages/cad-styling/src/AssetNodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L27) ## Accessors @@ -65,7 +65,7 @@ NodeCollection.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -83,7 +83,7 @@ NodeCollection.isLoading #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:43](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L43) +[packages/cad-styling/src/AssetNodeCollection.ts:43](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L43) ## Methods @@ -101,7 +101,7 @@ NodeCollection.isLoading #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:135](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L135) +[packages/cad-styling/src/AssetNodeCollection.ts:135](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L135) ___ @@ -126,7 +126,7 @@ assets within the bounding box or all assets associated with the 3D model. #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:54](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L54) +[packages/cad-styling/src/AssetNodeCollection.ts:54](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L54) ___ @@ -148,7 +148,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:147](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L147) +[packages/cad-styling/src/AssetNodeCollection.ts:147](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L147) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:131](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L131) +[packages/cad-styling/src/AssetNodeCollection.ts:131](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L131) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:143](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L143) +[packages/cad-styling/src/AssetNodeCollection.ts:143](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L143) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -248,4 +248,4 @@ ___ #### Defined in -[packages/cad-styling/src/AssetNodeCollection.ts:151](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L151) +[packages/cad-styling/src/AssetNodeCollection.ts:151](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L151) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.BoundingBoxClipper.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.BoundingBoxClipper.md index 6f0a23c1744..8f90510dea1 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.BoundingBoxClipper.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.BoundingBoxClipper.md @@ -21,7 +21,7 @@ custom_edit_url: null #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:18](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L18) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L18) ## Accessors @@ -35,7 +35,7 @@ custom_edit_url: null #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:104](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L104) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:104](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L104) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:55](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L55) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:55](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L55) • `set` **maxX**(`x`): `void` @@ -65,7 +65,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:50](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L50) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L50) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:64](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L64) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:64](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L64) • `set` **maxY**(`y`): `void` @@ -95,7 +95,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:59](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L59) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L59) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:73](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L73) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:73](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L73) • `set` **maxZ**(`z`): `void` @@ -125,7 +125,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:68](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L68) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:68](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L68) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:28](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L28) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L28) • `set` **minX**(`x`): `void` @@ -155,7 +155,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L23) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L23) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L37) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L37) • `set` **minY**(`y`): `void` @@ -185,7 +185,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L32) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L32) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L46) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L46) • `set` **minZ**(`z`): `void` @@ -215,4 +215,4 @@ ___ #### Defined in -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:41](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L41) +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:41](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L41) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CameraManagerHelper.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CameraManagerHelper.md index 4c51d5f9fb2..7bdcf9bfeac 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CameraManagerHelper.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CameraManagerHelper.md @@ -42,7 +42,32 @@ Calculates camera position and target that allows to see the content of provided #### Defined in -[packages/camera-manager/src/CameraManagerHelper.ts:97](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L97) +[packages/camera-manager/src/CameraManagerHelper.ts:110](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L110) + +___ + +### calculateNewRotationFromTarget + +▸ `Static` **calculateNewRotationFromTarget**(`camera`, `newTarget`): `Quaternion` + +Calculates camera rotation from target + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `camera` | `PerspectiveCamera` | Used Camera instance | +| `newTarget` | `Vector3` | The target to compute rotation from | + +#### Returns + +`Quaternion` + +New camera rotationg + +#### Defined in + +[packages/camera-manager/src/CameraManagerHelper.ts:68](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L68) ___ @@ -66,7 +91,7 @@ Calculates camera target based on new camera rotation. #### Defined in -[packages/camera-manager/src/CameraManagerHelper.ts:42](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L42) +[packages/camera-manager/src/CameraManagerHelper.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L42) ___ @@ -89,4 +114,4 @@ Updates near and far plane of the camera based on the bounding box. #### Defined in -[packages/camera-manager/src/CameraManagerHelper.ts:66](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L66) +[packages/camera-manager/src/CameraManagerHelper.ts:79](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L79) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CdfNodeCollectionBase.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CdfNodeCollectionBase.md index b38d8197fca..2453a2648e1 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CdfNodeCollectionBase.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CdfNodeCollectionBase.md @@ -40,7 +40,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L20) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L20) ## Accessors @@ -58,7 +58,7 @@ NodeCollection.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -76,7 +76,7 @@ NodeCollection.isLoading #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) ## Methods @@ -96,7 +96,7 @@ Clears the node collection and interrupts any ongoing operations. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) ___ @@ -118,7 +118,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -204,4 +204,4 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L46) +[packages/cad-styling/src/NodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L46) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ClusteredAreaCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ClusteredAreaCollection.md index 640a8844eae..340411746bd 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ClusteredAreaCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ClusteredAreaCollection.md @@ -37,7 +37,7 @@ It uses simple heuristics to determine which boxes are to be merged. #### Defined in -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:16](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L16) +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:16](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L16) ## Methods @@ -64,7 +64,7 @@ AreaCollection. #### Defined in -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:34](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L34) +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L34) ___ @@ -86,7 +86,7 @@ subset of boxes in the set returned from `areas` #### Defined in -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L20) +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L20) ___ @@ -116,7 +116,7 @@ A and B, and will thus be a valid representative set for the intersection of A a #### Defined in -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:38](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L38) +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L38) ___ @@ -142,4 +142,4 @@ Return whether the input box intersects the AreaCollection. #### Defined in -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:24](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L24) +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L24) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.Cognite3DViewer.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.Cognite3DViewer.md index 75755ed8f4f..2bd81bdcd6d 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.Cognite3DViewer.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.Cognite3DViewer.md @@ -21,7 +21,7 @@ custom_edit_url: null #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:212](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L212) +[packages/api/src/public/migration/Cognite3DViewer.ts:243](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L243) ## Accessors @@ -38,7 +38,7 @@ budget is shared between all added CAD models and not a per-model budget. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:166](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L166) +[packages/api/src/public/migration/Cognite3DViewer.ts:197](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L197) • `set` **cadBudget**(`budget`): `void` @@ -57,7 +57,7 @@ budget is shared between all added CAD models and not a per-model budget. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:176](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L176) +[packages/api/src/public/migration/Cognite3DViewer.ts:207](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L207) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:584](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L584) +[packages/api/src/public/migration/Cognite3DViewer.ts:647](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L647) ___ @@ -87,7 +87,7 @@ Returns the rendering canvas, the DOM element where the renderer draws its outpu #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:90](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L90) +[packages/api/src/public/migration/Cognite3DViewer.ts:111](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L111) ___ @@ -106,7 +106,7 @@ The DOM element cannot be changed after the viewer has been created. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:100](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L100) +[packages/api/src/public/migration/Cognite3DViewer.ts:121](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L121) ___ @@ -122,7 +122,7 @@ Gets a list of models currently added to the viewer. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:201](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L201) +[packages/api/src/public/migration/Cognite3DViewer.ts:232](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L232) ___ @@ -139,7 +139,7 @@ point cloud models. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:186](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L186) +[packages/api/src/public/migration/Cognite3DViewer.ts:217](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L217) • `set` **pointCloudBudget**(`budget`): `void` @@ -158,7 +158,23 @@ point cloud models. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:194](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L194) +[packages/api/src/public/migration/Cognite3DViewer.ts:225](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L225) + +___ + +### renderParameters + +• `get` **renderParameters**(): [`RenderParameters`](../modules/cognite_reveal.md#renderparameters) + +Returns parameters of THREE.WebGLRenderer used by the viewer. + +#### Returns + +[`RenderParameters`](../modules/cognite_reveal.md#renderparameters) + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:128](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L128) ## Methods @@ -189,7 +205,7 @@ await viewer.add360ImageSet('events', eventFilter); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:724](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L724) +[packages/api/src/public/migration/Cognite3DViewer.ts:787](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L787) ___ @@ -224,7 +240,7 @@ viewer.fitCameraToModel(model, 0); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:670](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L670) +[packages/api/src/public/migration/Cognite3DViewer.ts:733](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L733) ___ @@ -259,7 +275,7 @@ viewer.fitCameraToModel(model, 0); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:637](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L637) +[packages/api/src/public/migration/Cognite3DViewer.ts:700](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L700) ___ @@ -291,7 +307,7 @@ viewer.addObject3D(sphere); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:886](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L886) +[packages/api/src/public/migration/Cognite3DViewer.ts:950](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L950) ___ @@ -326,7 +342,7 @@ viewer.fitCameraToModel(model, 0); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:698](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L698) +[packages/api/src/public/migration/Cognite3DViewer.ts:761](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L761) ___ @@ -370,7 +386,7 @@ Empty string if type is not supported. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:853](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L853) +[packages/api/src/public/migration/Cognite3DViewer.ts:917](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L917) ___ @@ -394,21 +410,22 @@ viewer.dispose(); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:390](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L390) +[packages/api/src/public/migration/Cognite3DViewer.ts:427](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L427) ___ ### enter360Image -▸ **enter360Image**(`image360`): `Promise`<`void`\> +▸ **enter360Image**(`image360`, `revision?`): `Promise`<`void`\> Enter visualization of a 360 image. #### Parameters -| Name | Type | -| :------ | :------ | -| `image360` | [`Image360`](../interfaces/cognite_reveal.Image360.md) | +| Name | Type | Description | +| :------ | :------ | :------ | +| `image360` | [`Image360`](../interfaces/cognite_reveal.Image360.md) | The 360 image to enter. | +| `revision?` | [`Image360Revision`](../interfaces/cognite_reveal.Image360Revision.md) | The image revision to use. If not provided the newest revision will be shown. | #### Returns @@ -416,7 +433,7 @@ Enter visualization of a 360 image. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:771](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L771) +[packages/api/src/public/migration/Cognite3DViewer.ts:835](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L835) ___ @@ -432,7 +449,7 @@ Exit visualization of the 360 image. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:781](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L781) +[packages/api/src/public/migration/Cognite3DViewer.ts:845](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L845) ___ @@ -471,7 +488,7 @@ viewer.fitCameraToBoundingBox(boundingBox, 500, 2); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1076](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1076) +[packages/api/src/public/migration/Cognite3DViewer.ts:1142](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1142) ___ @@ -510,7 +527,7 @@ viewer.fitCameraToModel(model, 0); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1031](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1031) +[packages/api/src/public/migration/Cognite3DViewer.ts:1097](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1097) ___ @@ -534,7 +551,32 @@ Move camera to a place where a set of 3D models are visible. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1042](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1042) +[packages/api/src/public/migration/Cognite3DViewer.ts:1108](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1108) + +___ + +### get360AnnotationIntersectionFromPixel + +▸ **get360AnnotationIntersectionFromPixel**(`offsetX`, `offsetY`): `Promise`<``null`` \| [`Image360AnnotationIntersection`](../modules/cognite_reveal.md#image360annotationintersection)\> + +Check for intersections with 360 annotations through the given pixel. +Similar to {getIntersectionFromPixel}, but checks 360 image annotations +instead of models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offsetX` | `number` | +| `offsetY` | `number` | + +#### Returns + +`Promise`<``null`` \| [`Image360AnnotationIntersection`](../modules/cognite_reveal.md#image360annotationintersection)\> + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1381](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1381) ___ @@ -554,7 +596,7 @@ Use [getGlobalClippingPlanes](cognite_reveal.Cognite3DViewer.md#getglobalclippin #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:982](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L982) +[packages/api/src/public/migration/Cognite3DViewer.ts:1048](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1048) ___ @@ -570,7 +612,7 @@ Returns the current active global clipping planes. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:989](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L989) +[packages/api/src/public/migration/Cognite3DViewer.ts:1055](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1055) ___ @@ -630,7 +672,7 @@ returns `null` if there were no intersections. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1298](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1298) +[packages/api/src/public/migration/Cognite3DViewer.ts:1364](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1364) ___ @@ -673,7 +715,7 @@ A [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Da #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1168](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1168) +[packages/api/src/public/migration/Cognite3DViewer.ts:1234](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1234) ___ @@ -689,7 +731,7 @@ Returns reveal version installed. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:363](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L363) +[packages/api/src/public/migration/Cognite3DViewer.ts:400](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L400) ___ @@ -707,7 +749,7 @@ JSON object containing viewer state. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:601](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L601) +[packages/api/src/public/migration/Cognite3DViewer.ts:664](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L664) ___ @@ -735,7 +777,7 @@ is used as a fallback. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1003](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1003) +[packages/api/src/public/migration/Cognite3DViewer.ts:1069](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1069) ___ @@ -762,7 +804,7 @@ viewer.off('click', onClick); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:512](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L512) +[packages/api/src/public/migration/Cognite3DViewer.ts:563](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L563) ▸ **off**(`event`, `callback`): `void` @@ -785,7 +827,30 @@ viewer.off('cameraChange', onCameraChange); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:519](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L519) +[packages/api/src/public/migration/Cognite3DViewer.ts:570](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L570) + +▸ **off**(`event`, `callback`): `void` + +**`Example`** + +```js +viewer.off('cameraStop', onCameraStop); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"cameraStop"`` | +| `callback` | [`CameraStopDelegate`](../modules/cognite_reveal.md#camerastopdelegate) | + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:577](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L577) ▸ **off**(`event`, `callback`): `void` @@ -804,7 +869,7 @@ Unsubscribe the 'beforeSceneRendered'-event previously subscribed with [on](cogn #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:523](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L523) +[packages/api/src/public/migration/Cognite3DViewer.ts:581](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L581) ▸ **off**(`event`, `callback`): `void` @@ -827,7 +892,7 @@ viewer.off('sceneRendered', updateStats); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:530](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L530) +[packages/api/src/public/migration/Cognite3DViewer.ts:588](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L588) ▸ **off**(`event`, `callback`): `void` @@ -850,7 +915,7 @@ viewer.off('disposed', clearAll); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:537](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L537) +[packages/api/src/public/migration/Cognite3DViewer.ts:595](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L595) ___ @@ -874,7 +939,7 @@ resources held and remove the reference to the viewer. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:430](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L430) +[packages/api/src/public/migration/Cognite3DViewer.ts:467](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L467) ▸ **on**(`event`, `callback`): `void` @@ -898,7 +963,7 @@ viewer.on('click', onClick); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:439](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L439) +[packages/api/src/public/migration/Cognite3DViewer.ts:476](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L476) ▸ **on**(`event`, `callback`): `void` @@ -923,7 +988,32 @@ viewer.on('cameraChange', (position, target) => { #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:448](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L448) +[packages/api/src/public/migration/Cognite3DViewer.ts:485](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L485) + +▸ **on**(`event`, `callback`): `void` + +**`Example`** + +```js +viewer.on('cameraStop', () => { + console.log('Camera stopped'); +}); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"cameraStop"`` | +| `callback` | [`CameraStopDelegate`](../modules/cognite_reveal.md#camerastopdelegate) | + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:494](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L494) ▸ **on**(`event`, `callback`): `void` @@ -942,7 +1032,7 @@ Event that is triggered immediately before the scene is rendered. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:454](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L454) +[packages/api/src/public/migration/Cognite3DViewer.ts:500](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L500) ▸ **on**(`event`, `callback`): `void` @@ -961,7 +1051,7 @@ Event that is triggered immediately after the scene has been rendered. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:460](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L460) +[packages/api/src/public/migration/Cognite3DViewer.ts:506](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L506) ___ @@ -983,7 +1073,7 @@ Remove a set of 360 images. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:760](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L760) +[packages/api/src/public/migration/Cognite3DViewer.ts:823](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L823) ___ @@ -1007,7 +1097,7 @@ Removes a model that was previously added using [addModel](cognite_reveal.Cognit #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:794](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L794) +[packages/api/src/public/migration/Cognite3DViewer.ts:858](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L858) ___ @@ -1037,7 +1127,7 @@ viewer.removeObject3D(sphere); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:906](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L906) +[packages/api/src/public/migration/Cognite3DViewer.ts:970](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L970) ___ @@ -1053,7 +1143,7 @@ Typically used when you perform some changes and can't see them unless you move #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1083](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1083) +[packages/api/src/public/migration/Cognite3DViewer.ts:1149](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1149) ___ @@ -1077,7 +1167,7 @@ Sets the color used as the clear color of the renderer. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:921](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L921) +[packages/api/src/public/migration/Cognite3DViewer.ts:985](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L985) ___ @@ -1099,7 +1189,7 @@ Sets the active camera manager instance for current Cognite3Dviewer. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:592](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L592) +[packages/api/src/public/migration/Cognite3DViewer.ts:655](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L655) ___ @@ -1125,7 +1215,7 @@ Use [setGlobalClippingPlanes](cognite_reveal.Cognite3DViewer.md#setglobalclippin #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:974](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L974) +[packages/api/src/public/migration/Cognite3DViewer.ts:1040](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1040) ___ @@ -1175,7 +1265,7 @@ viewer.setGlobalClippingPlanes([plane]); #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:964](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L964) +[packages/api/src/public/migration/Cognite3DViewer.ts:1030](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1030) ___ @@ -1198,7 +1288,7 @@ Defaults to 'none' (which is identical to 'silent'). #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:372](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L372) +[packages/api/src/public/migration/Cognite3DViewer.ts:409](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L409) ___ @@ -1221,7 +1311,7 @@ settings for max resolution and limiting resolution when moving the camera. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:350](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L350) +[packages/api/src/public/migration/Cognite3DViewer.ts:387](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L387) ___ @@ -1244,7 +1334,7 @@ node collections and applies the `state` object. #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:611](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L611) +[packages/api/src/public/migration/Cognite3DViewer.ts:674](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L674) ___ @@ -1302,4 +1392,4 @@ Returns 2D coordinates if the point is visible on screen, or `null` if object is #### Defined in -[packages/api/src/public/migration/Cognite3DViewer.ts:1121](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1121) +[packages/api/src/public/migration/Cognite3DViewer.ts:1187](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1187) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CogniteCadModel.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CogniteCadModel.md index b209d963f90..afdcd0d4ca7 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CogniteCadModel.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CogniteCadModel.md @@ -27,7 +27,7 @@ The CDF model ID of the model. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:75](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L75) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:75](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L75) ___ @@ -43,7 +43,7 @@ The CDF revision ID of the model. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:79](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L79) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:79](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L79) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:26](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L26) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L26) ## Accessors @@ -71,7 +71,7 @@ Note that coordinates in Reveal always are converted to meters using [modelUnitT #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:40](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L40) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:40](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L40) ___ @@ -88,7 +88,7 @@ return undefined if the model has been stored in an unsupported unit. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:50](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L50) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L50) ___ @@ -108,7 +108,7 @@ Returns the number of nodes in the model. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:458](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L458) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:458](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L458) ___ @@ -124,7 +124,7 @@ Returns all currently registered node collections and associated appearance. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:127](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L127) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:127](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L127) ___ @@ -140,7 +140,7 @@ Returns the model visibility. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:68](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L68) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:68](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L68) • `set` **visible**(`value`): `void` @@ -164,7 +164,7 @@ model.visible = false #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:61](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L61) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:61](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L61) ## Methods @@ -210,7 +210,7 @@ model.assignStyledNodeCollection(visibleSet, { rendererGhosted: false }); #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:158](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L158) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:158](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L158) ___ @@ -226,7 +226,7 @@ Cleans up used resources. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:247](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L247) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:247](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L247) ___ @@ -253,7 +253,7 @@ Tree index range of the subtree spanned by the ancestor at the #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:271](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L271) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:271](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L271) ___ @@ -289,7 +289,7 @@ const box = await model.getBoundingBoxByNodeId(nodeId); #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:399](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L399) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:399](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L399) ___ @@ -326,7 +326,7 @@ const box = await model.getBoundingBoxByTreeIndex(treeIndex); #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:434](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L434) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:434](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L434) ___ @@ -344,7 +344,7 @@ isn't any stored camera configuration for the model. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:318](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L318) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:318](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L318) ___ @@ -354,7 +354,7 @@ ___ Gets transformation from CDF space to ThreeJS space, which includes any additional "default" transformations assigned to this model. -Does not include any custom transformations set by CognitePointcloudmodel.setModelTransformation +Does not include any custom transformations set by [setModelTransformation](cognite_reveal.CogniteCadModel.md#setmodeltransformation) #### Parameters @@ -372,7 +372,7 @@ Does not include any custom transformations set by CognitePointcloudmodel.setMod #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:359](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L359) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:359](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L359) ___ @@ -389,7 +389,7 @@ Gets the default appearance for nodes that are not styled using #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:120](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L120) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:120](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L120) ___ @@ -426,7 +426,7 @@ Model bounding box. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:302](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L302) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:302](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L302) ___ @@ -442,7 +442,7 @@ Get the clipping planes for this model. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:349](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L349) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:349](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L349) ___ @@ -468,7 +468,7 @@ Gets transformation matrix that has previously been set with [setModelTransforma #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:334](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L334) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:334](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L334) ___ @@ -490,7 +490,7 @@ Determines the range of tree indices for a given subtree. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:255](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L255) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:255](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L255) ___ @@ -523,7 +523,7 @@ Promise that is resolved once the iteration is done. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:451](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L451) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:451](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L451) ___ @@ -560,7 +560,7 @@ Promise that is resolved once the iteration is done. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:478](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L478) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:478](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L478) ___ @@ -583,7 +583,7 @@ Map bounding box from CDF to model space, taking the model's custom transformati #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:378](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L378) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:378](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L378) ___ @@ -614,7 +614,7 @@ TreeIndex of the provided node. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:506](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L506) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:506](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L506) ___ @@ -644,7 +644,7 @@ A list of tree indices corresponing to the elements in the input. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:492](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L492) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:492](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L492) ___ @@ -667,7 +667,7 @@ Map point from CDF to model space, taking the model's custom transformation into #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:368](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L368) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:368](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L368) ___ @@ -697,7 +697,7 @@ TreeIndex of the provided node. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:532](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L532) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:532](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L532) ___ @@ -728,7 +728,7 @@ A list of node IDs corresponding to the elements of the input. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:520](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L520) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:520](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L520) ___ @@ -745,7 +745,7 @@ default appearance. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:190](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L190) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:190](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L190) ___ @@ -767,7 +767,7 @@ Resets the transformation for the nodes given. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:229](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L229) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:229](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L229) ___ @@ -790,7 +790,7 @@ Remove override transform of the node by tree index. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:238](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L238) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:238](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L238) ___ @@ -814,7 +814,7 @@ expensive operation, so use with care. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:112](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L112) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:112](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L112) ___ @@ -837,7 +837,7 @@ global clipping planes. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:342](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L342) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:342](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L342) ___ @@ -859,7 +859,7 @@ Sets transformation matrix of the model. This overrides the current transformati #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:326](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L326) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:326](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L326) ___ @@ -886,7 +886,7 @@ node isn't supported and might lead to undefined results. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:204](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L204) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:204](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L204) ___ @@ -910,7 +910,7 @@ Set override transform of the node by tree index. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:215](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L215) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L215) ___ @@ -937,4 +937,4 @@ Error if node collection isn't assigned to the model. #### Defined in -[packages/cad-model/src/wrappers/CogniteCadModel.ts:176](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L176) +[packages/cad-model/src/wrappers/CogniteCadModel.ts:176](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L176) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CognitePointCloudModel.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CognitePointCloudModel.md index b197b0c2c6e..4b18b4e6537 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CognitePointCloudModel.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CognitePointCloudModel.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:30](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L30) +[packages/pointclouds/src/CognitePointCloudModel.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L30) ___ @@ -27,7 +27,7 @@ The modelId of the point cloud model in Cognite Data Fusion. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:34](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L34) +[packages/pointclouds/src/CognitePointCloudModel.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L34) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:29](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L29) +[packages/pointclouds/src/CognitePointCloudModel.ts:29](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L29) ## Accessors @@ -53,7 +53,7 @@ Determines how points currently are colored. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:186](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L186) +[packages/pointclouds/src/CognitePointCloudModel.ts:186](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L186) • `set` **pointColorType**(`type`): `void` @@ -61,7 +61,9 @@ Specifies how points are colored. **`Default`** +```ts PointColorType.Rgb +``` **`Example`** @@ -81,7 +83,7 @@ model.pointColorType = PointColorType.Rgb #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:198](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L198) +[packages/pointclouds/src/CognitePointCloudModel.ts:198](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L198) ___ @@ -105,7 +107,7 @@ Sets the point shape of each rendered point in the point cloud. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:238](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L238) +[packages/pointclouds/src/CognitePointCloudModel.ts:238](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L238) • `set` **pointShape**(`shape`): `void` @@ -127,7 +129,7 @@ Gets the point shape of each rendered point in the point cloud. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:246](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L246) +[packages/pointclouds/src/CognitePointCloudModel.ts:246](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L246) ___ @@ -143,7 +145,7 @@ Returns the size of each rendered point in the point cloud. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:205](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L205) +[packages/pointclouds/src/CognitePointCloudModel.ts:205](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L205) • `set` **pointSize**(`size`): `void` @@ -165,7 +167,7 @@ Sets the size of each rendered point in the point cloud. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:213](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L213) +[packages/pointclouds/src/CognitePointCloudModel.ts:213](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L213) ___ @@ -181,7 +183,7 @@ Get the point size type. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:220](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L220) +[packages/pointclouds/src/CognitePointCloudModel.ts:220](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L220) • `set` **pointSizeType**(`type`): `void` @@ -204,7 +206,7 @@ The point size type can be either Fixed or Adaptive. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:229](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L229) +[packages/pointclouds/src/CognitePointCloudModel.ts:229](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L229) ___ @@ -220,7 +222,7 @@ The number of stylable objects #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:340](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L340) +[packages/pointclouds/src/CognitePointCloudModel.ts:340](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L340) ___ @@ -238,7 +240,7 @@ All object collections and their associated style #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:285](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L285) +[packages/pointclouds/src/CognitePointCloudModel.ts:285](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L285) ___ @@ -254,7 +256,7 @@ Returns the current number of visible/loaded points. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:179](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L179) +[packages/pointclouds/src/CognitePointCloudModel.ts:179](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L179) ## Methods @@ -278,7 +280,7 @@ a style previously, the previous style will be replaced by the new one. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:295](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L295) +[packages/pointclouds/src/CognitePointCloudModel.ts:295](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L295) ___ @@ -294,7 +296,7 @@ Used to clean up memory. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:58](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L58) +[packages/pointclouds/src/CognitePointCloudModel.ts:58](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L58) ___ @@ -312,7 +314,7 @@ isn't any stored camera configuration for the model. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:84](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L84) +[packages/pointclouds/src/CognitePointCloudModel.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L84) ___ @@ -322,7 +324,7 @@ ___ Gets transformation from CDF space to ThreeJS space, which includes any additional "default" transformations assigned to this model. -Does not include any custom transformations set by CognitePointcloudmodel.setModelTransformation +Does not include any custom transformations set by [setModelTransformation](cognite_reveal.CognitePointCloudModel.md#setmodeltransformation) #### Parameters @@ -336,7 +338,7 @@ Does not include any custom transformations set by CognitePointcloudmodel.setMod #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:111](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L111) +[packages/pointclouds/src/CognitePointCloudModel.ts:111](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L111) ___ @@ -355,7 +357,7 @@ A sorted list of classification codes and names from the model. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:172](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L172) +[packages/pointclouds/src/CognitePointCloudModel.ts:172](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L172) ___ @@ -371,7 +373,7 @@ Gets default point appearance #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:268](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L268) +[packages/pointclouds/src/CognitePointCloudModel.ts:268](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L268) ___ @@ -405,7 +407,7 @@ Model's bounding box. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:75](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L75) +[packages/pointclouds/src/CognitePointCloudModel.ts:75](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L75) ___ @@ -421,7 +423,7 @@ Get the clipping planes for this model. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:261](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L261) +[packages/pointclouds/src/CognitePointCloudModel.ts:261](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L261) ___ @@ -430,7 +432,7 @@ ___ ▸ **getModelTransformation**(`out?`): `Matrix4` Gets transformation matrix that has previously been -set with CognitePointCloudmodel.setModelTransformation. +set with [setModelTransformation](cognite_reveal.CognitePointCloudModel.md#setmodeltransformation). #### Parameters @@ -444,7 +446,7 @@ set with CognitePointCloudmodel.setModelTransformation. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:101](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L101) +[packages/pointclouds/src/CognitePointCloudModel.ts:101](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L101) ___ @@ -468,7 +470,7 @@ True if model has values in the class given. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:163](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L163) +[packages/pointclouds/src/CognitePointCloudModel.ts:163](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L163) ___ @@ -496,7 +498,7 @@ True if points from the given class will be visible. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:153](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L153) +[packages/pointclouds/src/CognitePointCloudModel.ts:153](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L153) ___ @@ -519,7 +521,7 @@ Map bounding box from CDF to model space, taking the model's custom transformati #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:130](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L130) +[packages/pointclouds/src/CognitePointCloudModel.ts:130](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L130) ___ @@ -542,7 +544,7 @@ Map point from CDF to model space, taking the model's custom transformation into #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:120](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L120) +[packages/pointclouds/src/CognitePointCloudModel.ts:120](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L120) ___ @@ -558,7 +560,7 @@ Removes styling on all object collections in this model #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:332](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L332) +[packages/pointclouds/src/CognitePointCloudModel.ts:332](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L332) ___ @@ -585,7 +587,7 @@ Error if the model doesn't have the class given. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:142](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L142) +[packages/pointclouds/src/CognitePointCloudModel.ts:142](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L142) ___ @@ -607,7 +609,7 @@ Sets default apparance for points that are not styled otherwise #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:276](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L276) +[packages/pointclouds/src/CognitePointCloudModel.ts:276](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L276) ___ @@ -630,7 +632,7 @@ global clipping planes. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:254](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L254) +[packages/pointclouds/src/CognitePointCloudModel.ts:254](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L254) ___ @@ -652,7 +654,7 @@ Sets transformation matrix of the model. This overrides the current transformati #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:92](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L92) +[packages/pointclouds/src/CognitePointCloudModel.ts:92](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L92) ___ @@ -682,7 +684,7 @@ model.traverseStylableObjects( #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:353](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L353) +[packages/pointclouds/src/CognitePointCloudModel.ts:353](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L353) ___ @@ -704,4 +706,4 @@ Unassign style from an already styled object collection. #### Defined in -[packages/pointclouds/src/CognitePointCloudModel.ts:313](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L313) +[packages/pointclouds/src/CognitePointCloudModel.ts:313](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L313) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CombineNodeCollectionBase.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CombineNodeCollectionBase.md index 7f0e7009e91..bb0bcd5ee4c 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CombineNodeCollectionBase.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CombineNodeCollectionBase.md @@ -38,7 +38,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:17](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L17) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L17) ## Accessors @@ -56,7 +56,7 @@ NodeCollection.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -74,7 +74,7 @@ NodeCollection.isLoading #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) ## Methods @@ -94,7 +94,7 @@ NodeCollection.isLoading #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) ___ @@ -114,7 +114,7 @@ Clears all underlying node collections. #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) ___ @@ -136,7 +136,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:73](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L73) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:73](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L73) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) ___ @@ -179,7 +179,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) ___ @@ -242,4 +242,4 @@ ___ #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:71](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L71) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:71](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L71) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ComboControls.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ComboControls.md index b6aa2155f4b..21c8d3086e2 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ComboControls.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ComboControls.md @@ -32,7 +32,7 @@ EventDispatcher.constructor #### Defined in -[packages/camera-manager/src/ComboControls.ts:218](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L218) +[packages/camera-manager/src/ComboControls.ts:218](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L218) ## Properties @@ -50,7 +50,7 @@ EventDispatcher.constructor #### Defined in -[packages/camera-manager/src/ComboControls.ts:115](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L115) +[packages/camera-manager/src/ComboControls.ts:115](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L115) ## Accessors @@ -69,7 +69,7 @@ resets to default value when `setState` method is called with no rotation value. #### Defined in -[packages/camera-manager/src/ComboControls.ts:337](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L337) +[packages/camera-manager/src/ComboControls.ts:337](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L337) ___ @@ -85,7 +85,7 @@ Returns true if these controls are enabled. #### Defined in -[packages/camera-manager/src/ComboControls.ts:200](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L200) +[packages/camera-manager/src/ComboControls.ts:200](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L200) • `set` **enabled**(`newEnabledValue`): `void` @@ -103,7 +103,7 @@ Sets the enabled state of these controls. #### Defined in -[packages/camera-manager/src/ComboControls.ts:207](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L207) +[packages/camera-manager/src/ComboControls.ts:207](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L207) ___ @@ -119,7 +119,7 @@ Gets current Combo Controls options. #### Defined in -[packages/camera-manager/src/ComboControls.ts:184](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L184) +[packages/camera-manager/src/ComboControls.ts:184](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L184) • `set` **options**(`options`): `void` @@ -139,7 +139,7 @@ Only the provided options will be changed, any undefined options will be kept as #### Defined in -[packages/camera-manager/src/ComboControls.ts:193](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L193) +[packages/camera-manager/src/ComboControls.ts:193](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L193) ## Methods @@ -153,7 +153,7 @@ Only the provided options will be changed, any undefined options will be kept as #### Defined in -[packages/camera-manager/src/ComboControls.ts:350](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L350) +[packages/camera-manager/src/ComboControls.ts:350](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L350) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/camera-manager/src/ComboControls.ts:312](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L312) +[packages/camera-manager/src/ComboControls.ts:312](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L312) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/camera-manager/src/ComboControls.ts:346](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L346) +[packages/camera-manager/src/ComboControls.ts:346](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L346) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[packages/camera-manager/src/ComboControls.ts:320](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L320) +[packages/camera-manager/src/ComboControls.ts:320](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L320) ___ @@ -233,7 +233,7 @@ ___ #### Defined in -[packages/camera-manager/src/ComboControls.ts:341](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L341) +[packages/camera-manager/src/ComboControls.ts:341](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L341) ___ @@ -247,7 +247,7 @@ ___ #### Defined in -[packages/camera-manager/src/ComboControls.ts:354](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L354) +[packages/camera-manager/src/ComboControls.ts:354](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L354) ___ @@ -268,4 +268,4 @@ ___ #### Defined in -[packages/camera-manager/src/ComboControls.ts:238](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L238) +[packages/camera-manager/src/ComboControls.ts:238](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L238) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DebouncedCameraStopEventTrigger.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DebouncedCameraStopEventTrigger.md index 99971260e23..eb3ef8360b8 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DebouncedCameraStopEventTrigger.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DebouncedCameraStopEventTrigger.md @@ -25,7 +25,7 @@ camera hasn't changed for a little while. #### Defined in -[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L21) +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L21) ## Methods @@ -41,7 +41,7 @@ Deallocate resources associated with this object #### Defined in -[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:47](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L47) +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L47) ___ @@ -63,7 +63,7 @@ Subscribe to the stop events generated by this trigger #### Defined in -[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:33](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L33) +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L33) ___ @@ -85,4 +85,4 @@ Unsubscribe from the stop events #### Defined in -[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:40](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L40) +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:40](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L40) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DefaultCameraManager.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DefaultCameraManager.md index a2df4a3df99..418ed48f0f7 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DefaultCameraManager.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DefaultCameraManager.md @@ -29,7 +29,7 @@ and `viewer.cameraManager.cameraControls.maxDistance`. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:103](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L103) +[packages/camera-manager/src/DefaultCameraManager.ts:103](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L103) ___ @@ -54,7 +54,7 @@ viewer.camera.updateProjectionMatrix(); #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:95](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L95) +[packages/camera-manager/src/DefaultCameraManager.ts:95](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L95) ## Accessors @@ -70,7 +70,7 @@ Whether keyboard control of the camera is enabled/disabled. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:190](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L190) +[packages/camera-manager/src/DefaultCameraManager.ts:190](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L190) • `set` **keyboardNavigationEnabled**(`enabled`): `void` @@ -88,7 +88,7 @@ Sets whether keyboard control of the camera is enabled/disabled. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:183](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L183) +[packages/camera-manager/src/DefaultCameraManager.ts:183](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L183) ## Methods @@ -99,7 +99,7 @@ Sets whether keyboard control of the camera is enabled/disabled. Set this manager as active and enable controls. Should update CameraManager.enabled to reflect the state of the manager. -Note that this is called automatically when a new CameraManager is set on the [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). +Note that this is called automatically when a new CameraManager is set on the viewer. #### Parameters @@ -117,7 +117,7 @@ Note that this is called automatically when a new CameraManager is set on the [C #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:232](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L232) +[packages/camera-manager/src/DefaultCameraManager.ts:232](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L232) ___ @@ -128,7 +128,7 @@ ___ Deactivate this manager and disable controls. Should update CameraManager.enabled to reflect the state of the manager. -Note that this is called automatically when a new CameraManager is set on the [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). +Note that this is called automatically when a new CameraManager is set on the viewer. #### Returns @@ -140,7 +140,7 @@ Note that this is called automatically when a new CameraManager is set on the [C #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:246](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L246) +[packages/camera-manager/src/DefaultCameraManager.ts:246](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L246) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:285](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L285) +[packages/camera-manager/src/DefaultCameraManager.ts:285](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L285) ___ @@ -188,7 +188,7 @@ Moves camera to a place where the content of a bounding box is visible to the ca #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:159](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L159) +[packages/camera-manager/src/DefaultCameraManager.ts:159](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L159) ___ @@ -196,7 +196,7 @@ ___ ▸ **getCamera**(): `PerspectiveCamera` -Returns the camera used for rendering in [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). +Returns the camera used for rendering the viewer. Note that the camera will not be modified directly by Reveal. Implementations must trigger the `cameraChange`-event whenever the camera changes. @@ -211,7 +211,7 @@ camera changes. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:194](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L194) +[packages/camera-manager/src/DefaultCameraManager.ts:194](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L194) ___ @@ -227,7 +227,7 @@ Gets current camera controls options. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:257](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L257) +[packages/camera-manager/src/DefaultCameraManager.ts:257](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L257) ___ @@ -249,7 +249,7 @@ Camera state: position, target and rotation. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:224](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L224) +[packages/camera-manager/src/DefaultCameraManager.ts:224](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L224) ___ @@ -265,7 +265,7 @@ Gets current Combo Controls options. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:168](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L168) +[packages/camera-manager/src/DefaultCameraManager.ts:168](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L168) ___ @@ -292,7 +292,7 @@ Unsubscribes from changes of the camera event. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:146](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L146) +[packages/camera-manager/src/DefaultCameraManager.ts:146](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L146) ___ @@ -321,7 +321,7 @@ Subscribes to events on this camera manager. There are several event types: #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:133](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L133) +[packages/camera-manager/src/DefaultCameraManager.ts:133](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L133) ___ @@ -343,7 +343,7 @@ Sets camera controls options to customize camera controls modes. See [CameraCont #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:265](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L265) +[packages/camera-manager/src/DefaultCameraManager.ts:265](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L265) ___ @@ -371,7 +371,7 @@ empty rotation field. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:204](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L204) +[packages/camera-manager/src/DefaultCameraManager.ts:204](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L204) ___ @@ -394,7 +394,7 @@ Only provided options will be changed, any undefined options will be kept as is. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:176](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L176) +[packages/camera-manager/src/DefaultCameraManager.ts:176](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L176) ___ @@ -423,4 +423,4 @@ Reveal performance affects frequency with which this method is called. #### Defined in -[packages/camera-manager/src/DefaultCameraManager.ts:275](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L275) +[packages/camera-manager/src/DefaultCameraManager.ts:275](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L275) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IndexSet.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IndexSet.md index 4c8778f89f8..60f4c499625 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IndexSet.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IndexSet.md @@ -21,7 +21,7 @@ custom_edit_url: null #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L13) +[packages/utilities/src/indexset/IndexSet.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L13) • **new IndexSet**(`values?`) @@ -33,7 +33,7 @@ custom_edit_url: null #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:14](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L14) +[packages/utilities/src/indexset/IndexSet.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L14) ## Accessors @@ -47,7 +47,7 @@ custom_edit_url: null #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:68](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L68) +[packages/utilities/src/indexset/IndexSet.ts:68](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L68) ## Methods @@ -67,7 +67,7 @@ custom_edit_url: null #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:33](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L33) +[packages/utilities/src/indexset/IndexSet.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L33) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:39](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L39) +[packages/utilities/src/indexset/IndexSet.ts:39](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L39) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:211](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L211) +[packages/utilities/src/indexset/IndexSet.ts:211](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L211) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:215](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L215) +[packages/utilities/src/indexset/IndexSet.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L215) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:60](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L60) +[packages/utilities/src/indexset/IndexSet.ts:60](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L60) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:135](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L135) +[packages/utilities/src/indexset/IndexSet.ts:135](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L135) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L27) +[packages/utilities/src/indexset/IndexSet.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L27) ___ @@ -195,7 +195,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:145](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L145) +[packages/utilities/src/indexset/IndexSet.ts:145](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L145) ___ @@ -215,7 +215,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:171](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L171) +[packages/utilities/src/indexset/IndexSet.ts:171](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L171) ___ @@ -229,7 +229,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:105](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L105) +[packages/utilities/src/indexset/IndexSet.ts:105](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L105) ___ @@ -249,7 +249,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:47](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L47) +[packages/utilities/src/indexset/IndexSet.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L47) ___ @@ -269,7 +269,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:52](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L52) +[packages/utilities/src/indexset/IndexSet.ts:52](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L52) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:84](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L84) +[packages/utilities/src/indexset/IndexSet.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L84) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:98](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L98) +[packages/utilities/src/indexset/IndexSet.ts:98](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L98) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:76](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L76) +[packages/utilities/src/indexset/IndexSet.ts:76](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L76) ___ @@ -331,4 +331,4 @@ ___ #### Defined in -[packages/utilities/src/indexset/IndexSet.ts:123](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/indexset/IndexSet.ts#L123) +[packages/utilities/src/indexset/IndexSet.ts:123](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L123) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IntersectionNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IntersectionNodeCollection.md index d5dc281a61e..7dc2bbe3e21 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IntersectionNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IntersectionNodeCollection.md @@ -33,7 +33,7 @@ Node collection that is the intersection between a set of underlying node collec #### Defined in -[packages/cad-styling/src/IntersectionNodeCollection.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L22) +[packages/cad-styling/src/IntersectionNodeCollection.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L22) ## Properties @@ -43,7 +43,7 @@ Node collection that is the intersection between a set of underlying node collec #### Defined in -[packages/cad-styling/src/IntersectionNodeCollection.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L20) +[packages/cad-styling/src/IntersectionNodeCollection.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L20) ## Accessors @@ -61,7 +61,7 @@ CombineNodeCollectionBase.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -79,7 +79,7 @@ CombineNodeCollectionBase.isLoading #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) ## Methods @@ -103,7 +103,7 @@ CombineNodeCollectionBase.isLoading #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) ___ @@ -123,7 +123,7 @@ Clears all underlying node collections. #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) ___ @@ -145,7 +145,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/IntersectionNodeCollection.ts:52](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L52) +[packages/cad-styling/src/IntersectionNodeCollection.ts:52](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L52) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) ___ @@ -181,7 +181,7 @@ CombineNodeCollectionBase.makeDirty #### Defined in -[packages/cad-styling/src/IntersectionNodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L46) +[packages/cad-styling/src/IntersectionNodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L46) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -231,7 +231,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) ___ @@ -273,4 +273,4 @@ ___ #### Defined in -[packages/cad-styling/src/IntersectionNodeCollection.ts:26](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L26) +[packages/cad-styling/src/IntersectionNodeCollection.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L26) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.InvertedNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.InvertedNodeCollection.md index 7a68d65ca20..06d9952047f 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.InvertedNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.InvertedNodeCollection.md @@ -34,7 +34,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/InvertedNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L21) +[packages/cad-styling/src/InvertedNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L21) ## Properties @@ -44,7 +44,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/InvertedNodeCollection.ts:15](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L15) +[packages/cad-styling/src/InvertedNodeCollection.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L15) ## Accessors @@ -62,7 +62,7 @@ NodeCollection.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -80,7 +80,7 @@ NodeCollection.isLoading #### Defined in -[packages/cad-styling/src/InvertedNodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L32) +[packages/cad-styling/src/InvertedNodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L32) ## Methods @@ -104,7 +104,7 @@ Always throws an error. #### Defined in -[packages/cad-styling/src/InvertedNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L58) +[packages/cad-styling/src/InvertedNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L58) ___ @@ -126,7 +126,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/InvertedNodeCollection.ts:47](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L47) +[packages/cad-styling/src/InvertedNodeCollection.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L47) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[packages/cad-styling/src/InvertedNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L36) +[packages/cad-styling/src/InvertedNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L36) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -212,4 +212,4 @@ ___ #### Defined in -[packages/cad-styling/src/InvertedNodeCollection.ts:51](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L51) +[packages/cad-styling/src/InvertedNodeCollection.ts:51](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L51) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeCollection.md index f69fc981bfa..b81354588bc 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeCollection.md @@ -35,7 +35,7 @@ Abstract class for implementing a set of nodes to be styled. #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L37) +[packages/cad-styling/src/NodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L37) ## Methods @@ -63,7 +63,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L45) +[packages/cad-styling/src/NodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L45) ___ @@ -81,7 +81,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/NodeCollection.ts:44](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L44) +[packages/cad-styling/src/NodeCollection.ts:44](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L44) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:38](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L38) +[packages/cad-styling/src/NodeCollection.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L38) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -151,4 +151,4 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L46) +[packages/cad-styling/src/NodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L46) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeIdNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeIdNodeCollection.md index a2d2f7d8644..d2530ef35af 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeIdNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeIdNodeCollection.md @@ -37,7 +37,7 @@ whenever possible for best performance. #### Defined in -[packages/cad-styling/src/NodeIdNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L25) +[packages/cad-styling/src/NodeIdNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L25) ## Properties @@ -47,7 +47,7 @@ whenever possible for best performance. #### Defined in -[packages/cad-styling/src/NodeIdNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L18) +[packages/cad-styling/src/NodeIdNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L18) ## Accessors @@ -65,7 +65,7 @@ CdfNodeCollectionBase.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -83,7 +83,7 @@ CdfNodeCollectionBase.isLoading #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) ## Methods @@ -103,7 +103,7 @@ Clears the node collection and interrupts any ongoing operations. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) ___ @@ -128,7 +128,7 @@ Promise that resolves when the collection is populated. #### Defined in -[packages/cad-styling/src/NodeIdNodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L37) +[packages/cad-styling/src/NodeIdNodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L37) ___ @@ -150,7 +150,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeIdNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L58) +[packages/cad-styling/src/NodeIdNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L58) ___ @@ -257,4 +257,4 @@ ___ #### Defined in -[packages/cad-styling/src/NodeIdNodeCollection.ts:65](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L65) +[packages/cad-styling/src/NodeIdNodeCollection.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L65) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NumericRange.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NumericRange.md index fa05f5f14f0..b4d902c80ad 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NumericRange.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NumericRange.md @@ -22,7 +22,7 @@ custom_edit_url: null #### Defined in -[packages/utilities/src/NumericRange.ts:10](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L10) +[packages/utilities/src/NumericRange.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L10) ## Properties @@ -32,7 +32,7 @@ custom_edit_url: null #### Defined in -[packages/utilities/src/NumericRange.ts:7](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L7) +[packages/utilities/src/NumericRange.ts:7](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L7) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:6](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L6) +[packages/utilities/src/NumericRange.ts:6](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L6) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:8](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L8) +[packages/utilities/src/NumericRange.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L8) ## Methods @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:38](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L38) +[packages/utilities/src/NumericRange.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L38) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:34](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L34) +[packages/utilities/src/NumericRange.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L34) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:72](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L72) +[packages/utilities/src/NumericRange.ts:72](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L72) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:50](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L50) +[packages/utilities/src/NumericRange.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L50) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:42](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L42) +[packages/utilities/src/NumericRange.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L42) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L46) +[packages/utilities/src/NumericRange.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L46) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:61](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L61) +[packages/utilities/src/NumericRange.ts:61](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L61) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:30](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L30) +[packages/utilities/src/NumericRange.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L30) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:78](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L78) +[packages/utilities/src/NumericRange.ts:78](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L78) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:65](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L65) +[packages/utilities/src/NumericRange.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L65) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:24](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L24) +[packages/utilities/src/NumericRange.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L24) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -[packages/utilities/src/NumericRange.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L20) +[packages/utilities/src/NumericRange.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L20) ___ @@ -295,4 +295,4 @@ value is NumericRange #### Defined in -[packages/utilities/src/NumericRange.ts:82](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/NumericRange.ts#L82) +[packages/utilities/src/NumericRange.ts:82](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L82) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PointCloudObjectCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PointCloudObjectCollection.md index 1dc0f1c4ace..c30f895bb90 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PointCloudObjectCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PointCloudObjectCollection.md @@ -35,7 +35,7 @@ whether the collection is still loading data in the background i.e. not yet read #### Defined in -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L23) +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L23) ## Methods @@ -51,7 +51,7 @@ annotation IDs of the annotations for the objects represented by this PointCloud #### Defined in -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L18) +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L18) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L25) +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PropertyFilterNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PropertyFilterNodeCollection.md index 1b2ebb25520..710134feb18 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PropertyFilterNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PropertyFilterNodeCollection.md @@ -36,7 +36,7 @@ a node is considered to match if it or a [NodeCollection](cognite_reveal.NodeCol #### Defined in -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:43](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L43) +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:44](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L44) ## Properties @@ -46,7 +46,7 @@ a node is considered to match if it or a [NodeCollection](cognite_reveal.NodeCol #### Defined in -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:31](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L31) +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L32) ## Accessors @@ -64,7 +64,7 @@ CdfNodeCollectionBase.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -82,7 +82,7 @@ CdfNodeCollectionBase.isLoading #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) ## Methods @@ -102,7 +102,7 @@ Clears the node collection and interrupts any ongoing operations. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) ___ @@ -131,7 +131,7 @@ set.executeFilter({ 'PDMS': { 'Module': 'AQ550' }}); #### Defined in -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:63](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L63) +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:64](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L64) ___ @@ -153,7 +153,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -239,4 +239,4 @@ ___ #### Defined in -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:82](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L82) +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:83](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L83) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.SinglePropertyFilterNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.SinglePropertyFilterNodeCollection.md index 8c226a7c97a..0c48f877cea 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.SinglePropertyFilterNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.SinglePropertyFilterNodeCollection.md @@ -40,7 +40,7 @@ Construct a new node set. #### Defined in -[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:41](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L41) +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:41](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L41) ## Properties @@ -50,7 +50,7 @@ Construct a new node set. #### Defined in -[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:24](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L24) +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L24) ## Accessors @@ -68,7 +68,7 @@ CdfNodeCollectionBase.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -86,7 +86,7 @@ CdfNodeCollectionBase.isLoading #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) ## Methods @@ -106,7 +106,7 @@ Clears the node collection and interrupts any ongoing operations. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) ___ @@ -116,7 +116,7 @@ ___ Execute filter asynchronously, replacing any existing filter active. When propertyValues contains more than 1000 elements, the operation will be split into multiple batches that -are executed in parallel. Note that when providing a PropertyFilterNodeCollectionOptions.requestPartitions +are executed in parallel. Note that when providing a [requestPartitions](../modules/cognite_reveal.md#requestpartitions) during construction of the node set, the total number of batches will be requestPartitions*numberOfBatches. #### Parameters @@ -133,7 +133,7 @@ during construction of the node set, the total number of batches will be request #### Defined in -[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:62](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L62) +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:62](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L62) ___ @@ -155,7 +155,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -241,4 +241,4 @@ ___ #### Defined in -[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:97](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L97) +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:97](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L97) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.StyledPointCloudObjectCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.StyledPointCloudObjectCollection.md index dd9e2770acb..a434ebe9588 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.StyledPointCloudObjectCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.StyledPointCloudObjectCollection.md @@ -24,7 +24,7 @@ Represents an object collection that is associated with an appearance #### Defined in -[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) +[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) ## Properties @@ -34,7 +34,7 @@ Represents an object collection that is associated with an appearance #### Defined in -[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) +[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) +[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ThickLine.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ThickLine.md new file mode 100644 index 00000000000..0fd910f7e30 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ThickLine.md @@ -0,0 +1,201 @@ +--- +id: "cognite_reveal.ThickLine" +title: "Class: ThickLine" +sidebar_label: "ThickLine" +custom_edit_url: null +--- + +[@cognite/reveal](../modules/cognite_reveal.md).ThickLine + +## Constructors + +### constructor + +• **new ThickLine**(`lineWidth`, `lineColor`, `startPoint`, `endPoint`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lineWidth` | `number` | +| `lineColor` | `Color` | +| `startPoint` | `Vector3` | +| `endPoint` | `Vector3` | + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:16](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L16) + +## Accessors + +### meshes + +• `get` **meshes**(): `Group` + +#### Returns + +`Group` + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:67](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L67) + +___ + +### visibility + +• `set` **visibility**(`visible`): `void` + +Set visibility + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visible` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:128](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L128) + +## Methods + +### dispose + +▸ **dispose**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:57](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L57) + +___ + +### getLineLength + +▸ **getLineLength**(): `number` + +Get the distance between the line start point & end point. + +#### Returns + +`number` + +Return distance between start & end point of the line. + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:97](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L97) + +___ + +### getMidPointOnLine + +▸ **getMidPointOnLine**(): `Vector3` + +Calculate mid point on the Line. + +#### Returns + +`Vector3` + +Returns mid point between start and end points. + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:105](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L105) + +___ + +### updateLineClippingPlanes + +▸ **updateLineClippingPlanes**(`clippingPlanes`): `void` + +Updates the line clipping planes + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `clippingPlanes` | `Plane`[] | current active global clipping planes. | + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:86](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L86) + +___ + +### updateLineColor + +▸ **updateLineColor**(`color`): `void` + +Update current line color. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `color` | `Color` | Color of the line mesh. | + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:121](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L121) + +___ + +### updateLineEndPoint + +▸ **updateLineEndPoint**(`endPoint`): `void` + +Update the line end point. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `endPoint` | `Vector3` | Second point of the line | + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:75](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L75) + +___ + +### updateLineWidth + +▸ **updateLineWidth**(`lineWidth`): `void` + +Update current line width. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineWidth` | `number` | Width of the line mesh. | + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/three/ThickLine.ts:113](https://github.com/cognitedata/reveal/blob/29826bff/viewer/packages/utilities/src/three/ThickLine.ts#L113) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.TreeIndexNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.TreeIndexNodeCollection.md index 0d7bb569392..b57ff166a50 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.TreeIndexNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.TreeIndexNodeCollection.md @@ -33,7 +33,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L23) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L23) • **new TreeIndexNodeCollection**(`treeIndices?`) @@ -49,7 +49,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:24](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L24) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L24) • **new TreeIndexNodeCollection**(`treeIndexRange?`) @@ -65,7 +65,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L25) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L25) ## Properties @@ -75,7 +75,7 @@ NodeCollection.constructor #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L18) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L18) ## Accessors @@ -93,7 +93,7 @@ NodeCollection.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -111,7 +111,7 @@ NodeCollection.isLoading #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:110](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L110) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:110](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L110) ## Methods @@ -134,7 +134,7 @@ This effectively adds boxes of size 1x1x1 meter with the points as their centers #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:96](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L96) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:96](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L96) ___ @@ -158,7 +158,7 @@ the number of areas in the set small. #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:84](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L84) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L84) ___ @@ -178,7 +178,7 @@ Sets this set to hold an empty set. #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:56](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L56) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:56](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L56) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:106](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L106) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:106](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L106) ___ @@ -214,7 +214,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:65](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L65) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L65) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:61](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L61) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:61](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L61) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:114](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L114) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:114](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L114) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L37) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L37) ▸ **updateSet**(`treeIndices`): `void` @@ -336,7 +336,7 @@ ___ #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:38](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L38) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L38) ▸ **updateSet**(`treeIndices`): `void` @@ -352,4 +352,4 @@ ___ #### Defined in -[packages/cad-styling/src/TreeIndexNodeCollection.ts:39](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L39) +[packages/cad-styling/src/TreeIndexNodeCollection.ts:39](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L39) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.UnionNodeCollection.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.UnionNodeCollection.md index aeca7887f01..0bbee2f5c8d 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.UnionNodeCollection.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.UnionNodeCollection.md @@ -33,7 +33,7 @@ Node collection that takes the set union of multiple node collections. #### Defined in -[packages/cad-styling/src/UnionNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L21) +[packages/cad-styling/src/UnionNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L21) ## Properties @@ -43,7 +43,7 @@ Node collection that takes the set union of multiple node collections. #### Defined in -[packages/cad-styling/src/UnionNodeCollection.ts:19](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L19) +[packages/cad-styling/src/UnionNodeCollection.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L19) ## Accessors @@ -61,7 +61,7 @@ CombineNodeCollectionBase.classToken #### Defined in -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L23) +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) ___ @@ -79,7 +79,7 @@ CombineNodeCollectionBase.isLoading #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) ## Methods @@ -103,7 +103,7 @@ CombineNodeCollectionBase.isLoading #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) ___ @@ -123,7 +123,7 @@ Clears all underlying node collections. #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) ___ @@ -145,7 +145,7 @@ implementations supports this. #### Defined in -[packages/cad-styling/src/UnionNodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L45) +[packages/cad-styling/src/UnionNodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L45) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L32) +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollection.ts#L27) +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) +[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) ___ @@ -255,4 +255,4 @@ ___ #### Defined in -[packages/cad-styling/src/UnionNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L25) +[packages/cad-styling/src/UnionNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md index bfd76036095..3dba63c0ebf 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md @@ -29,7 +29,7 @@ and a format. #### Defined in -[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:16](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L16) +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:16](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L16) ## Properties @@ -39,7 +39,7 @@ and a format. #### Defined in -[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L13) +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L13) ___ @@ -55,7 +55,7 @@ Unique ID of the model. #### Defined in -[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:11](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L11) +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L11) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:14](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L14) +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L14) ## Methods @@ -79,4 +79,4 @@ ___ #### Defined in -[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L22) +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.AxisViewTool.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.AxisViewTool.md index 3cd2718bdaa..f506e2a1983 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.AxisViewTool.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.AxisViewTool.md @@ -7,7 +7,7 @@ custom_edit_url: null [@cognite/reveal/tools](../modules/cognite_reveal_tools.md).AxisViewTool -Base class for tools attaching to a Cognite3DViewer. +Base class for tools attaching to a [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). ## Hierarchy @@ -34,7 +34,7 @@ Base class for tools attaching to a Cognite3DViewer. #### Defined in -[packages/tools/src/AxisView/AxisViewTool.ts:45](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L45) +[packages/tools/src/AxisView/AxisViewTool.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L45) ## Methods @@ -55,7 +55,7 @@ of dipose-listeners. #### Defined in -[packages/tools/src/AxisView/AxisViewTool.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L69) +[packages/tools/src/AxisView/AxisViewTool.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L69) ___ @@ -82,4 +82,4 @@ Unregisters an event handler for the 'disposed'-event. #### Defined in -[packages/tools/src/Cognite3DViewerToolBase.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L37) +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Cognite3DViewerToolBase.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Cognite3DViewerToolBase.md index f49a7b48759..10b32c57581 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Cognite3DViewerToolBase.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Cognite3DViewerToolBase.md @@ -7,7 +7,7 @@ custom_edit_url: null [@cognite/reveal/tools](../modules/cognite_reveal_tools.md).Cognite3DViewerToolBase -Base class for tools attaching to a Cognite3DViewer. +Base class for tools attaching to a [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). ## Hierarchy @@ -19,6 +19,8 @@ Base class for tools attaching to a Cognite3DViewer. ↳ [`AxisViewTool`](cognite_reveal_tools.AxisViewTool.md) + ↳ [`SmartOverlayTool`](cognite_reveal_tools.SmartOverlayTool.md) + ↳ [`TimelineTool`](cognite_reveal_tools.TimelineTool.md) ↳ [`MeasurementTool`](cognite_reveal_tools.MeasurementTool.md) @@ -44,7 +46,7 @@ of dipose-listeners. #### Defined in -[packages/tools/src/Cognite3DViewerToolBase.ts:52](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L52) +[packages/tools/src/Cognite3DViewerToolBase.ts:53](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L53) ___ @@ -67,4 +69,4 @@ Unregisters an event handler for the 'disposed'-event. #### Defined in -[packages/tools/src/Cognite3DViewerToolBase.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L37) +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.DebugCameraTool.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.DebugCameraTool.md index df5d25dea16..62bb4a8a95a 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.DebugCameraTool.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.DebugCameraTool.md @@ -7,7 +7,7 @@ custom_edit_url: null [@cognite/reveal/tools](../modules/cognite_reveal_tools.md).DebugCameraTool -Base class for tools attaching to a Cognite3DViewer. +Base class for tools attaching to a [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). ## Hierarchy @@ -33,7 +33,7 @@ Base class for tools attaching to a Cognite3DViewer. #### Defined in -[packages/tools/src/DebugCameraTool.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/DebugCameraTool.ts#L20) +[packages/tools/src/DebugCameraTool.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/DebugCameraTool.ts#L20) ## Methods @@ -53,7 +53,7 @@ Removes all elements and detaches from the viewer. #### Defined in -[packages/tools/src/DebugCameraTool.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/DebugCameraTool.ts#L32) +[packages/tools/src/DebugCameraTool.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/DebugCameraTool.ts#L32) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[packages/tools/src/DebugCameraTool.ts:43](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/DebugCameraTool.ts#L43) +[packages/tools/src/DebugCameraTool.ts:43](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/DebugCameraTool.ts#L43) ___ @@ -94,7 +94,7 @@ Unregisters an event handler for the 'disposed'-event. #### Defined in -[packages/tools/src/Cognite3DViewerToolBase.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L37) +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) ___ @@ -108,4 +108,4 @@ ___ #### Defined in -[packages/tools/src/DebugCameraTool.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/DebugCameraTool.ts#L37) +[packages/tools/src/DebugCameraTool.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/DebugCameraTool.ts#L37) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.HtmlOverlayTool.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.HtmlOverlayTool.md index f499a68e0b0..e1db74083ba 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.HtmlOverlayTool.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.HtmlOverlayTool.md @@ -7,7 +7,7 @@ custom_edit_url: null [@cognite/reveal/tools](../modules/cognite_reveal_tools.md).HtmlOverlayTool -Manages HTMLoverlays for Cognite3DViewer. Attaches HTML elements to a +Manages HTMLoverlays for [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). Attaches HTML elements to a 3D position and updates its position/visibility as user moves the camera. This is useful to create HTML overlays to highlight information about key positions in the 3D model. @@ -69,7 +69,7 @@ overlayTool.dispose(); #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:171](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L171) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:171](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L171) ## Accessors @@ -85,7 +85,7 @@ Returns all added HTML elements along with their 3D positions. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:191](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L191) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:191](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L191) ## Methods @@ -109,7 +109,7 @@ Registers a HTML overlay that will be updated on rendering. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:215](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L215) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L215) ___ @@ -125,7 +125,7 @@ Removes all attached HTML overlay elements. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:263](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L263) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:263](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L263) ___ @@ -145,7 +145,7 @@ Removes all elements and detaches from the viewer. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:201](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L201) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:201](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L201) ___ @@ -171,7 +171,7 @@ Calling this function often might cause degraded performance. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:298](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L298) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:298](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L298) ___ @@ -198,7 +198,7 @@ Unregisters an event handler for the 'disposed'-event. #### Defined in -[packages/tools/src/Cognite3DViewerToolBase.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L37) +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) ___ @@ -220,7 +220,7 @@ Removes a overlay and removes it from the DOM. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:251](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L251) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:251](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L251) ___ @@ -242,4 +242,4 @@ Hide/unhide all HTML overlay elements. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:275](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L275) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:275](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L275) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Keyframe.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Keyframe.md index 1aaaa5fd0a5..677d253cca9 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Keyframe.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Keyframe.md @@ -24,7 +24,7 @@ Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline #### Defined in -[packages/tools/src/Timeline/Keyframe.ts:17](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/Keyframe.ts#L17) +[packages/tools/src/Timeline/Keyframe.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L17) ## Methods @@ -40,7 +40,7 @@ Assigns the styles for the node set for the model for this Keyframe #### Defined in -[packages/tools/src/Timeline/Keyframe.ts:33](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/Keyframe.ts#L33) +[packages/tools/src/Timeline/Keyframe.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L33) ___ @@ -64,7 +64,7 @@ appearance provided. #### Defined in -[packages/tools/src/Timeline/Keyframe.ts:54](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/Keyframe.ts#L54) +[packages/tools/src/Timeline/Keyframe.ts:54](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L54) ___ @@ -80,7 +80,7 @@ Removes the style for the model #### Defined in -[packages/tools/src/Timeline/Keyframe.ts:42](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/Keyframe.ts#L42) +[packages/tools/src/Timeline/Keyframe.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L42) ___ @@ -98,7 +98,7 @@ date #### Defined in -[packages/tools/src/Timeline/Keyframe.ts:26](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/Keyframe.ts#L26) +[packages/tools/src/Timeline/Keyframe.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L26) ___ @@ -120,4 +120,4 @@ Remove Node & Style for this keyframe's nodeCollection and nodeAppearance #### Defined in -[packages/tools/src/Timeline/Keyframe.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/Keyframe.ts#L69) +[packages/tools/src/Timeline/Keyframe.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L69) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.MeasurementTool.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.MeasurementTool.md index 7bd41f4614b..42037b4f58c 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.MeasurementTool.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.MeasurementTool.md @@ -7,7 +7,7 @@ custom_edit_url: null [@cognite/reveal/tools](../modules/cognite_reveal_tools.md).MeasurementTool -Enables Cognite3DViewer to perform a point to point measurement. +Enables [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md) to perform a point to point measurement. This can be achieved by selecting a point on the 3D Object and drag the pointer to required point to get measurement of the distance. The tools default measurement is in "Meters" as supported in Reveal, but it also provides @@ -61,7 +61,7 @@ const measurementTool = new MeasurementTool(viewer, {distanceToLabelCallback: (d #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:91](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L91) +[packages/tools/src/Measurement/MeasurementTool.ts:91](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L91) ## Accessors @@ -77,7 +77,7 @@ Returns measurement mode state, is measurement mode started or ended. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:54](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L54) +[packages/tools/src/Measurement/MeasurementTool.ts:54](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L54) ## Methods @@ -97,7 +97,7 @@ Dispose Measurement Tool. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:367](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L367) +[packages/tools/src/Measurement/MeasurementTool.ts:367](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L367) ___ @@ -113,7 +113,7 @@ Enter into point to point measurement mode. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:235](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L235) +[packages/tools/src/Measurement/MeasurementTool.ts:235](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L235) ___ @@ -129,7 +129,7 @@ Exit measurement mode. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:249](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L249) +[packages/tools/src/Measurement/MeasurementTool.ts:249](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L249) ___ @@ -137,7 +137,7 @@ ___ ▸ **getAllMeasurements**(): [`Measurement`](../modules/cognite_reveal_tools.md#measurement)[] -Get all measurements from Cognite3DViewer. +Get all measurements from [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). #### Returns @@ -147,7 +147,7 @@ Array of Measurements containing Id, start point, end point & measured distance. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:346](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L346) +[packages/tools/src/Measurement/MeasurementTool.ts:346](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L346) ___ @@ -178,7 +178,7 @@ measurementTool.off('disposed', onMeasurementDispose); #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:179](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L179) +[packages/tools/src/Measurement/MeasurementTool.ts:179](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L179) ▸ **off**(`event`, `callback`): `void` @@ -205,7 +205,7 @@ Cognite3DViewerToolBase.off #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:187](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L187) +[packages/tools/src/Measurement/MeasurementTool.ts:187](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L187) ▸ **off**(`event`, `callback`): `void` @@ -232,7 +232,7 @@ Cognite3DViewerToolBase.off #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:195](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L195) +[packages/tools/src/Measurement/MeasurementTool.ts:195](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L195) ▸ **off**(`event`, `callback`): `void` @@ -259,7 +259,7 @@ Cognite3DViewerToolBase.off #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:203](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L203) +[packages/tools/src/Measurement/MeasurementTool.ts:203](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L203) ___ @@ -293,7 +293,7 @@ Cognite3DViewerToolBase.on #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:117](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L117) +[packages/tools/src/Measurement/MeasurementTool.ts:117](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L117) ▸ **on**(`event`, `callback`): `void` @@ -322,7 +322,7 @@ Cognite3DViewerToolBase.on #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:126](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L126) +[packages/tools/src/Measurement/MeasurementTool.ts:126](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L126) ▸ **on**(`event`, `callback`): `void` @@ -351,7 +351,7 @@ Cognite3DViewerToolBase.on #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:135](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L135) +[packages/tools/src/Measurement/MeasurementTool.ts:135](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L135) ▸ **on**(`event`, `callback`): `void` @@ -380,7 +380,7 @@ Cognite3DViewerToolBase.on #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:144](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L144) +[packages/tools/src/Measurement/MeasurementTool.ts:144](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L144) ___ @@ -396,7 +396,7 @@ Removes all measurements from the Cognite3DViewer. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:279](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L279) +[packages/tools/src/Measurement/MeasurementTool.ts:279](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L279) ___ @@ -418,7 +418,7 @@ Removes a measurement from the Cognite3DViewer. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:264](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L264) +[packages/tools/src/Measurement/MeasurementTool.ts:264](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L264) ___ @@ -440,7 +440,7 @@ Sets Measurement line width, color and label units value for the next measurment #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:303](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L303) +[packages/tools/src/Measurement/MeasurementTool.ts:303](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L303) ___ @@ -462,7 +462,7 @@ Sets the visiblity of labels in the Measurement. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:292](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L292) +[packages/tools/src/Measurement/MeasurementTool.ts:292](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L292) ___ @@ -485,7 +485,7 @@ Update selected line color. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:331](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L331) +[packages/tools/src/Measurement/MeasurementTool.ts:331](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L331) ___ @@ -508,7 +508,7 @@ Update selected line width. #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:315](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L315) +[packages/tools/src/Measurement/MeasurementTool.ts:315](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L315) ___ @@ -530,4 +530,4 @@ Hide/unhide all measurements #### Defined in -[packages/tools/src/Measurement/MeasurementTool.ts:354](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L354) +[packages/tools/src/Measurement/MeasurementTool.ts:354](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L354) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.SmartOverlayTool.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.SmartOverlayTool.md new file mode 100644 index 00000000000..97a4c15ddf4 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.SmartOverlayTool.md @@ -0,0 +1,348 @@ +--- +id: "cognite_reveal_tools.SmartOverlayTool" +title: "Class: SmartOverlayTool" +sidebar_label: "SmartOverlayTool" +custom_edit_url: null +--- + +[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).SmartOverlayTool + +Base class for tools attaching to a [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `MetadataType` | [`DefaultMetadataType`](../modules/cognite_reveal.md#defaultmetadatatype) | + +## Hierarchy + +- [`Cognite3DViewerToolBase`](cognite_reveal_tools.Cognite3DViewerToolBase.md) + + ↳ **`SmartOverlayTool`** + +## Constructors + +### constructor + +• **new SmartOverlayTool**<`MetadataType`\>(`viewer`, `toolParameters?`) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `MetadataType` | [`DefaultMetadataType`](../modules/cognite_reveal.md#defaultmetadatatype) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `viewer` | [`Cognite3DViewer`](cognite_reveal.Cognite3DViewer.md) | +| `toolParameters?` | [`SmartOverlayToolParameters`](../modules/cognite_reveal_tools.md#smartoverlaytoolparameters) | + +#### Overrides + +[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[constructor](cognite_reveal_tools.Cognite3DViewerToolBase.md#constructor) + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:57](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L57) + +## Accessors + +### collections + +• `get` **collections**(): [`OverlayCollection`](../interfaces/cognite_reveal.OverlayCollection.md)<`MetadataType`\>[] + +Gets all added overlay collections. + +#### Returns + +[`OverlayCollection`](../interfaces/cognite_reveal.OverlayCollection.md)<`MetadataType`\>[] + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:113](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L113) + +___ + +### textOverlayVisible + +• `get` **textOverlayVisible**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:138](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L138) + +• `set` **textOverlayVisible**(`visible`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visible` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:133](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L133) + +___ + +### visible + +• `get` **visible**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:129](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L129) + +• `set` **visible**(`visible`): `void` + +Sets whether overlays are visible. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visible` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:120](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L120) + +## Methods + +### clear + +▸ **clear**(): `void` + +Removes all overlays. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:145](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L145) + +___ + +### createOverlayCollection + +▸ **createOverlayCollection**(`overlays?`): [`OverlayCollection`](../interfaces/cognite_reveal.OverlayCollection.md)<`MetadataType`\> + +Creates new OverlayCollection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `overlays?` | [`OverlayInfo`](../modules/cognite_reveal.md#overlayinfo)<`MetadataType`\>[] | Array of overlays to add. | + +#### Returns + +[`OverlayCollection`](../interfaces/cognite_reveal.OverlayCollection.md)<`MetadataType`\> + +Overlay group containing it's id. + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:76](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L76) + +___ + +### dispose + +▸ **dispose**(): `void` + +Disposes the element and triggeres the 'disposed' event before clearing the list +of dipose-listeners. + +#### Returns + +`void` + +#### Overrides + +[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[dispose](cognite_reveal_tools.Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:198](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L198) + +___ + +### off + +▸ **off**(`event`, `eventHandler`): `void` + +Unregisters an event handler for the 'disposed'-event. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"hover"`` | +| `eventHandler` | [`OverlayEventHandler`](../modules/cognite_reveal_tools.md#overlayeventhandler)<`MetadataType`\> | + +#### Returns + +`void` + +#### Overrides + +[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[off](cognite_reveal_tools.Cognite3DViewerToolBase.md#off) + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:178](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L178) + +▸ **off**(`event`, `eventHandler`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"click"`` | +| `eventHandler` | [`OverlayEventHandler`](../modules/cognite_reveal_tools.md#overlayeventhandler)<`MetadataType`\> | + +#### Returns + +`void` + +#### Overrides + +Cognite3DViewerToolBase.off + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:179](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L179) + +▸ **off**(`event`, `eventHandler`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"disposed"`` | +| `eventHandler` | [`DisposedDelegate`](../modules/cognite_reveal.md#disposeddelegate) | + +#### Returns + +`void` + +#### Overrides + +Cognite3DViewerToolBase.off + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:180](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L180) + +___ + +### on + +▸ **on**(`event`, `eventHandler`): `void` + +Subscribes to overlay events. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"hover"`` | event to subscribe to. | +| `eventHandler` | [`OverlayEventHandler`](../modules/cognite_reveal_tools.md#overlayeventhandler)<`MetadataType`\> | | + +#### Returns + +`void` + +#### Overrides + +Cognite3DViewerToolBase.on + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:158](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L158) + +▸ **on**(`event`, `eventHandler`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"click"`` | +| `eventHandler` | [`OverlayEventHandler`](../modules/cognite_reveal_tools.md#overlayeventhandler)<`MetadataType`\> | + +#### Returns + +`void` + +#### Overrides + +Cognite3DViewerToolBase.on + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:159](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L159) + +▸ **on**(`event`, `eventHandler`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"disposed"`` | +| `eventHandler` | [`DisposedDelegate`](../modules/cognite_reveal.md#disposeddelegate) | + +#### Returns + +`void` + +#### Overrides + +Cognite3DViewerToolBase.on + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:160](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L160) + +___ + +### removeOverlayCollection + +▸ **removeOverlayCollection**(`overlayCollection`): `void` + +Removes overlays that were added with addOverlays method. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `overlayCollection` | [`OverlayCollection`](../interfaces/cognite_reveal.OverlayCollection.md)<`MetadataType`\> | Id of the overlay group to remove. | + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:98](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L98) diff --git a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.TimelineTool.md b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.TimelineTool.md index f4d2c085290..9abf082e312 100644 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.TimelineTool.md +++ b/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.TimelineTool.md @@ -33,7 +33,7 @@ Tool to applying styles to nodes based on date to play them over in Timeline #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L22) +[packages/tools/src/Timeline/TimelineTool.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L22) ## Methods @@ -55,7 +55,7 @@ Create Key frame for the Timeline #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:63](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L63) +[packages/tools/src/Timeline/TimelineTool.ts:63](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L63) ___ @@ -76,7 +76,7 @@ of dipose-listeners. #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:184](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L184) +[packages/tools/src/Timeline/TimelineTool.ts:184](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L184) ___ @@ -94,7 +94,7 @@ All Keyframes in Timeline #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:180](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L180) +[packages/tools/src/Timeline/TimelineTool.ts:180](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L180) ___ @@ -116,7 +116,7 @@ Returns the keyframe at the date given, or undefined if not found. #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:76](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L76) +[packages/tools/src/Timeline/TimelineTool.ts:76](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L76) ___ @@ -143,7 +143,7 @@ Unregisters an event handler for the 'disposed'-event. #### Defined in -[packages/tools/src/Cognite3DViewerToolBase.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L37) +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) ___ @@ -159,7 +159,7 @@ Pause any ongoing playback #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:161](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L161) +[packages/tools/src/Timeline/TimelineTool.ts:161](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L161) ___ @@ -183,7 +183,7 @@ Starts playback of Timeline #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:110](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L110) +[packages/tools/src/Timeline/TimelineTool.ts:110](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L110) ___ @@ -205,7 +205,7 @@ Removes the Keyframe from the timeline. Does nothing if the keyframe isn't part #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:84](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L84) +[packages/tools/src/Timeline/TimelineTool.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L84) ___ @@ -227,7 +227,7 @@ Removes the Keyframe from the Timeline #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:96](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L96) +[packages/tools/src/Timeline/TimelineTool.ts:96](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L96) ___ @@ -243,7 +243,7 @@ Resume any paused playback #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:170](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L170) +[packages/tools/src/Timeline/TimelineTool.ts:170](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L170) ___ @@ -259,7 +259,7 @@ Stops any ongoing playback #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:151](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L151) +[packages/tools/src/Timeline/TimelineTool.ts:151](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L151) ___ @@ -282,7 +282,7 @@ Subscribe to the Date changed event #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:34](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L34) +[packages/tools/src/Timeline/TimelineTool.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L34) ___ @@ -305,4 +305,4 @@ Unsubscribe to the Date changed event #### Defined in -[packages/tools/src/Timeline/TimelineTool.ts:49](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/TimelineTool.ts#L49) +[packages/tools/src/Timeline/TimelineTool.ts:49](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L49) diff --git a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.NodeOutlineColor.md b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.NodeOutlineColor.md index 5448308a9fd..8b7b94ac50d 100644 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.NodeOutlineColor.md +++ b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.NodeOutlineColor.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:10](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L10) +[packages/cad-styling/src/NodeAppearance.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L10) ___ @@ -25,7 +25,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L12) +[packages/cad-styling/src/NodeAppearance.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L12) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:11](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L11) +[packages/cad-styling/src/NodeAppearance.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L11) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L13) +[packages/cad-styling/src/NodeAppearance.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L13) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:8](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L8) +[packages/cad-styling/src/NodeAppearance.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L8) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:15](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L15) +[packages/cad-styling/src/NodeAppearance.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L15) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:14](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L14) +[packages/cad-styling/src/NodeAppearance.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L14) ___ @@ -85,4 +85,4 @@ ___ #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:9](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L9) +[packages/cad-styling/src/NodeAppearance.ts:9](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L9) diff --git a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointColorType.md b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointColorType.md index d19a8efbb86..73e22af4ade 100644 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointColorType.md +++ b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointColorType.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L25) +[packages/rendering/src/pointcloud-rendering/enums.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L25) ___ @@ -25,7 +25,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:18](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L18) +[packages/rendering/src/pointcloud-rendering/enums.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L18) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L20) +[packages/rendering/src/pointcloud-rendering/enums.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L20) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:19](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L19) +[packages/rendering/src/pointcloud-rendering/enums.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L19) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L21) +[packages/rendering/src/pointcloud-rendering/enums.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L21) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L23) +[packages/rendering/src/pointcloud-rendering/enums.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L23) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L22) +[packages/rendering/src/pointcloud-rendering/enums.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L22) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:24](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L24) +[packages/rendering/src/pointcloud-rendering/enums.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L24) ___ @@ -95,4 +95,4 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:17](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L17) +[packages/rendering/src/pointcloud-rendering/enums.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointShape.md b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointShape.md index c1655009184..798bbe276cf 100644 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointShape.md +++ b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointShape.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L12) +[packages/rendering/src/pointcloud-rendering/enums.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L12) ___ @@ -25,7 +25,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L13) +[packages/rendering/src/pointcloud-rendering/enums.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L13) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:11](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L11) +[packages/rendering/src/pointcloud-rendering/enums.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointSizeType.md b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointSizeType.md index c998df400eb..2d7649442ee 100644 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointSizeType.md +++ b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointSizeType.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:7](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L7) +[packages/rendering/src/pointcloud-rendering/enums.ts:7](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L7) ___ @@ -25,7 +25,7 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:6](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L6) +[packages/rendering/src/pointcloud-rendering/enums.ts:6](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L6) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -[packages/rendering/src/pointcloud-rendering/enums.ts:5](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L5) +[packages/rendering/src/pointcloud-rendering/enums.ts:5](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L5) diff --git a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.WellKnownAsprsPointClassCodes.md b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.WellKnownAsprsPointClassCodes.md index 69acf79e69f..bdb246c31e5 100644 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.WellKnownAsprsPointClassCodes.md +++ b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.WellKnownAsprsPointClassCodes.md @@ -24,7 +24,7 @@ historically. #### Defined in -[packages/pointclouds/src/types.ts:59](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L59) +[packages/pointclouds/src/types.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L59) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:24](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L24) +[packages/pointclouds/src/types.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L24) ___ @@ -46,7 +46,7 @@ Created, never classified. #### Defined in -[packages/pointclouds/src/types.ts:18](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L18) +[packages/pointclouds/src/types.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L18) ___ @@ -58,7 +58,7 @@ Special value for all other classes. Some point in Potree might be in this class #### Defined in -[packages/pointclouds/src/types.ts:14](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L14) +[packages/pointclouds/src/types.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L14) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L20) +[packages/pointclouds/src/types.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L20) ___ @@ -82,7 +82,7 @@ historically. #### Defined in -[packages/pointclouds/src/types.ts:65](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L65) +[packages/pointclouds/src/types.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L65) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L23) +[packages/pointclouds/src/types.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L23) ___ @@ -104,7 +104,7 @@ E.g. breakline proximity. #### Defined in -[packages/pointclouds/src/types.ts:73](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L73) +[packages/pointclouds/src/types.ts:73](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L73) ___ @@ -116,7 +116,7 @@ Low point, typically "low noise". #### Defined in -[packages/pointclouds/src/types.ts:28](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L28) +[packages/pointclouds/src/types.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L28) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L21) +[packages/pointclouds/src/types.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L21) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L22) +[packages/pointclouds/src/types.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L22) ___ @@ -148,7 +148,7 @@ E.g. conveyors, mining equipment, traffic lights. #### Defined in -[packages/pointclouds/src/types.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L69) +[packages/pointclouds/src/types.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L69) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:35](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L35) +[packages/pointclouds/src/types.ts:35](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L35) ___ @@ -171,7 +171,7 @@ revisions this value is reserved. #### Defined in -[packages/pointclouds/src/types.ts:41](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L41) +[packages/pointclouds/src/types.ts:41](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L41) ___ @@ -184,7 +184,7 @@ revisions this value is reserved. #### Defined in -[packages/pointclouds/src/types.ts:33](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L33) +[packages/pointclouds/src/types.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L33) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:36](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L36) +[packages/pointclouds/src/types.ts:36](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L36) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:74](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L74) +[packages/pointclouds/src/types.ts:74](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L74) ___ @@ -217,7 +217,7 @@ levels, landslides, permafrost #### Defined in -[packages/pointclouds/src/types.ts:79](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L79) +[packages/pointclouds/src/types.ts:79](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L79) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:50](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L50) +[packages/pointclouds/src/types.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L50) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:19](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L19) +[packages/pointclouds/src/types.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L19) ___ @@ -250,7 +250,7 @@ Values up to and including 63 are reserved #### Defined in -[packages/pointclouds/src/types.ts:85](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L85) +[packages/pointclouds/src/types.ts:85](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L85) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/pointclouds/src/types.ts:34](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L34) +[packages/pointclouds/src/types.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L34) ___ @@ -272,7 +272,7 @@ Wire conductor (phase). #### Defined in -[packages/pointclouds/src/types.ts:49](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L49) +[packages/pointclouds/src/types.ts:49](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L49) ___ @@ -284,7 +284,7 @@ Wire guard shield. #### Defined in -[packages/pointclouds/src/types.ts:45](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L45) +[packages/pointclouds/src/types.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L45) ___ @@ -296,4 +296,4 @@ Wire-structure connector (e.g. insulator). #### Defined in -[packages/pointclouds/src/types.ts:54](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/types.ts#L54) +[packages/pointclouds/src/types.ts:54](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L54) diff --git a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_extensions_datasource.File3dFormat.md b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_extensions_datasource.File3dFormat.md index eb2487d71bb..1a511d76f22 100644 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_extensions_datasource.File3dFormat.md +++ b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_extensions_datasource.File3dFormat.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/data-providers/src/types.ts:65](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L65) +[packages/data-providers/src/types.ts:76](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L76) ___ @@ -25,7 +25,7 @@ ___ #### Defined in -[packages/data-providers/src/types.ts:60](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L60) +[packages/data-providers/src/types.ts:71](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L71) ___ @@ -37,4 +37,4 @@ Reveal v9 and above (GLTF based output) #### Defined in -[packages/data-providers/src/types.ts:64](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L64) +[packages/data-providers/src/types.ts:75](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L75) diff --git a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_tools.Corner.md b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_tools.Corner.md index 859ec739b13..9541c9beb60 100644 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_tools.Corner.md +++ b/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_tools.Corner.md @@ -17,7 +17,7 @@ A corner of the viewer. #### Defined in -[packages/tools/src/AxisView/types.ts:100](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L100) +[packages/tools/src/AxisView/types.ts:101](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L101) ___ @@ -27,7 +27,7 @@ ___ #### Defined in -[packages/tools/src/AxisView/types.ts:101](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L101) +[packages/tools/src/AxisView/types.ts:102](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L102) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[packages/tools/src/AxisView/types.ts:99](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L99) +[packages/tools/src/AxisView/types.ts:100](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L100) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -[packages/tools/src/AxisView/types.ts:98](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L98) +[packages/tools/src/AxisView/types.ts:99](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L99) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AddModelOptions.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AddModelOptions.md index 8e88e4b505c..a22d04cc45f 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AddModelOptions.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AddModelOptions.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/api/src/public/migration/types.ts:187](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L187) +[packages/api/src/public/migration/types.ts:200](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L200) ___ @@ -25,7 +25,7 @@ ___ #### Defined in -[packages/api/src/public/migration/types.ts:186](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L186) +[packages/api/src/public/migration/types.ts:199](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L199) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[packages/api/src/public/migration/types.ts:183](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L183) +[packages/api/src/public/migration/types.ts:196](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L196) ___ @@ -45,4 +45,4 @@ ___ #### Defined in -[packages/api/src/public/migration/types.ts:184](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L184) +[packages/api/src/public/migration/types.ts:197](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L197) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AreaCollection.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AreaCollection.md index 9a89c7477cb..473ab7eb0d5 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AreaCollection.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AreaCollection.md @@ -28,7 +28,7 @@ of the inserted boxes #### Defined in -[packages/cad-styling/src/prioritized/AreaCollection.ts:16](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L16) +[packages/cad-styling/src/prioritized/AreaCollection.ts:16](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L16) ## Methods @@ -51,7 +51,7 @@ AreaCollection. #### Defined in -[packages/cad-styling/src/prioritized/AreaCollection.ts:34](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L34) +[packages/cad-styling/src/prioritized/AreaCollection.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L34) ___ @@ -69,7 +69,7 @@ subset of boxes in the set returned from `areas` #### Defined in -[packages/cad-styling/src/prioritized/AreaCollection.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L23) +[packages/cad-styling/src/prioritized/AreaCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L23) ___ @@ -95,7 +95,7 @@ A and B, and will thus be a valid representative set for the intersection of A a #### Defined in -[packages/cad-styling/src/prioritized/AreaCollection.ts:43](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L43) +[packages/cad-styling/src/prioritized/AreaCollection.ts:43](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L43) ___ @@ -117,4 +117,4 @@ Return whether the input box intersects the AreaCollection. #### Defined in -[packages/cad-styling/src/prioritized/AreaCollection.ts:28](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L28) +[packages/cad-styling/src/prioritized/AreaCollection.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L28) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CameraManager.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CameraManager.md index 815ceee0937..f166b59597d 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CameraManager.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CameraManager.md @@ -9,7 +9,7 @@ custom_edit_url: null Interface for manager responsible for all manipulations to the camera, including animations and modification of state. Implementations are responsible for -providing a `THREE.PerspectiveCamera` instance to [Cognite3DViewer](../classes/cognite_reveal.Cognite3DViewer.md). Implementations +providing a `THREE.PerspectiveCamera` instance to the viewer. Implementations must trigger the `cameraChange`-event when camera is changed. The default implementation is [DefaultCameraManager](../classes/cognite_reveal.DefaultCameraManager.md). @@ -26,7 +26,7 @@ The default implementation is [DefaultCameraManager](../classes/cognite_reveal.D Set this manager as active and enable controls. Should update CameraManager.enabled to reflect the state of the manager. -Note that this is called automatically when a new CameraManager is set on the [Cognite3DViewer](../classes/cognite_reveal.Cognite3DViewer.md). +Note that this is called automatically when a new CameraManager is set on the viewer. #### Parameters @@ -40,7 +40,7 @@ Note that this is called automatically when a new CameraManager is set on the [C #### Defined in -[packages/camera-manager/src/CameraManager.ts:59](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L59) +[packages/camera-manager/src/CameraManager.ts:61](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L61) ___ @@ -51,7 +51,7 @@ ___ Deactivate this manager and disable controls. Should update CameraManager.enabled to reflect the state of the manager. -Note that this is called automatically when a new CameraManager is set on the [Cognite3DViewer](../classes/cognite_reveal.Cognite3DViewer.md). +Note that this is called automatically when a new CameraManager is set on the viewer. #### Returns @@ -59,7 +59,7 @@ Note that this is called automatically when a new CameraManager is set on the [C #### Defined in -[packages/camera-manager/src/CameraManager.ts:67](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L67) +[packages/camera-manager/src/CameraManager.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L69) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[packages/camera-manager/src/CameraManager.ts:107](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L107) +[packages/camera-manager/src/CameraManager.ts:109](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L109) ___ @@ -99,7 +99,7 @@ Moves camera to a place where the content of a bounding box is visible to the ca #### Defined in -[packages/camera-manager/src/CameraManager.ts:95](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L95) +[packages/camera-manager/src/CameraManager.ts:97](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L97) ___ @@ -107,7 +107,7 @@ ___ ▸ **getCamera**(): `PerspectiveCamera` -Returns the camera used for rendering in [Cognite3DViewer](../classes/cognite_reveal.Cognite3DViewer.md). +Returns the camera used for rendering the viewer. Note that the camera will not be modified directly by Reveal. Implementations must trigger the `cameraChange`-event whenever the camera changes. @@ -118,7 +118,7 @@ camera changes. #### Defined in -[packages/camera-manager/src/CameraManager.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L27) +[packages/camera-manager/src/CameraManager.ts:29](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L29) ___ @@ -136,7 +136,7 @@ Camera state: position, target and rotation. #### Defined in -[packages/camera-manager/src/CameraManager.ts:50](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L50) +[packages/camera-manager/src/CameraManager.ts:52](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L52) ___ @@ -159,7 +159,7 @@ Unsubscribes from changes of the camera event. #### Defined in -[packages/camera-manager/src/CameraManager.ts:85](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L85) +[packages/camera-manager/src/CameraManager.ts:87](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L87) ▸ **off**(`event`, `callback`): `void` @@ -176,7 +176,7 @@ Unsubscribes from changes of the camera event. #### Defined in -[packages/camera-manager/src/CameraManager.ts:86](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L86) +[packages/camera-manager/src/CameraManager.ts:88](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L88) ▸ **off**(`event`, `callback`): `void` @@ -193,7 +193,7 @@ Unsubscribes from changes of the camera event. #### Defined in -[packages/camera-manager/src/CameraManager.ts:87](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L87) +[packages/camera-manager/src/CameraManager.ts:89](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L89) ___ @@ -218,7 +218,7 @@ Subscribes to events on this camera manager. There are several event types: #### Defined in -[packages/camera-manager/src/CameraManager.ts:76](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L76) +[packages/camera-manager/src/CameraManager.ts:78](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L78) ▸ **on**(`event`, `callback`): `void` @@ -235,7 +235,7 @@ Subscribes to events on this camera manager. There are several event types: #### Defined in -[packages/camera-manager/src/CameraManager.ts:77](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L77) +[packages/camera-manager/src/CameraManager.ts:79](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L79) ▸ **on**(`event`, `callback`): `void` @@ -252,7 +252,7 @@ Subscribes to events on this camera manager. There are several event types: #### Defined in -[packages/camera-manager/src/CameraManager.ts:78](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L78) +[packages/camera-manager/src/CameraManager.ts:80](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L80) ___ @@ -284,7 +284,7 @@ cameraManager.setCameraState({ position, target }); #### Defined in -[packages/camera-manager/src/CameraManager.ts:44](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L44) +[packages/camera-manager/src/CameraManager.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L46) ___ @@ -309,4 +309,4 @@ Reveal performance affects frequency with which this method is called. #### Defined in -[packages/camera-manager/src/CameraManager.ts:103](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/CameraManager.ts#L103) +[packages/camera-manager/src/CameraManager.ts:105](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L105) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md index 858b798c548..056cd359715 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md @@ -23,7 +23,7 @@ Model and revision IDs for the model #### Defined in -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:31](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L31) +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:31](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L31) ___ @@ -35,7 +35,7 @@ Total count of nodes in the model #### Defined in -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:26](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L26) +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L26) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L32) +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L32) ## Methods @@ -69,7 +69,7 @@ is thus `model.getCdfToDefaultModelTransformation() * model.getModelTransformati #### Defined in -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L21) +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L21) ___ @@ -91,4 +91,4 @@ Gets the transformation of the model in ThreeJS space #### Defined in -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:14](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L14) +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Cognite3DViewerOptions.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Cognite3DViewerOptions.md index 614bd220b2c..d521ee0231b 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Cognite3DViewerOptions.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Cognite3DViewerOptions.md @@ -30,7 +30,7 @@ Currently the default mode is FXAA, but this is subject to change. #### Defined in -[packages/api/src/public/migration/types.ts:100](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L100) +[packages/api/src/public/migration/types.ts:113](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L113) ___ @@ -46,7 +46,7 @@ Default implementation is [DefaultCameraManager](../classes/cognite_reveal.Defau #### Defined in -[packages/api/src/public/migration/types.ts:65](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L65) +[packages/api/src/public/migration/types.ts:78](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L78) ___ @@ -62,7 +62,7 @@ Default value is set to true. #### Defined in -[packages/api/src/public/migration/types.ts:160](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L160) +[packages/api/src/public/migration/types.ts:173](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L173) ___ @@ -75,13 +75,13 @@ use to load model data. Note that some features might not work when implementing a custom data source. Please refer to the Reveal documentation for details. -Note that the data source must support CdfModelIdentifier. +Note that the data source must support [CdfModelIdentifier](../classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md). -This cannot be used together with _localModels. +This cannot be used together with Cognite3DViewerOptions._localModels. #### Defined in -[packages/api/src/public/migration/types.ts:151](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L151) +[packages/api/src/public/migration/types.ts:164](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L164) ___ @@ -93,7 +93,7 @@ An existing DOM element that we will render canvas into. #### Defined in -[packages/api/src/public/migration/types.ts:34](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L34) +[packages/api/src/public/migration/types.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L47) ___ @@ -105,7 +105,7 @@ Enables / disables visualizing the edges of geometry. Defaults to true. #### Defined in -[packages/api/src/public/migration/types.ts:136](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L136) +[packages/api/src/public/migration/types.ts:149](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L149) ___ @@ -124,7 +124,7 @@ Style the loading indicator. #### Defined in -[packages/api/src/public/migration/types.ts:47](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L47) +[packages/api/src/public/migration/types.ts:60](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L60) ___ @@ -136,7 +136,7 @@ Send anonymous usage statistics. #### Defined in -[packages/api/src/public/migration/types.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L37) +[packages/api/src/public/migration/types.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L50) ___ @@ -148,7 +148,7 @@ Callback to download stream progress. #### Defined in -[packages/api/src/public/migration/types.ts:139](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L139) +[packages/api/src/public/migration/types.ts:152](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L152) ___ @@ -167,7 +167,7 @@ Point cloud visualisation effects parameteres. #### Defined in -[packages/api/src/public/migration/types.ts:121](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L121) +[packages/api/src/public/migration/types.ts:134](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L134) ___ @@ -186,7 +186,7 @@ Render to offscreen buffer instead of canvas. #### Defined in -[packages/api/src/public/migration/types.ts:42](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L42) +[packages/api/src/public/migration/types.ts:55](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L55) ___ @@ -200,7 +200,7 @@ Note that when providing a custom renderer, this should be configured with #### Defined in -[packages/api/src/public/migration/types.ts:71](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L71) +[packages/api/src/public/migration/types.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L84) ___ @@ -220,7 +220,7 @@ Use [setResolutionOptions](../classes/cognite_reveal.Cognite3DViewer.md#setresol #### Defined in -[packages/api/src/public/migration/types.ts:82](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L82) +[packages/api/src/public/migration/types.ts:95](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L95) ___ @@ -232,7 +232,7 @@ Initialized connection to CDF used to load data. #### Defined in -[packages/api/src/public/migration/types.ts:31](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L31) +[packages/api/src/public/migration/types.ts:44](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L44) ___ @@ -245,4 +245,4 @@ an effect creating shadows and that gives the rendered image more depth. #### Defined in -[packages/api/src/public/migration/types.ts:116](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L116) +[packages/api/src/public/migration/types.ts:129](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L129) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360.md index a9c35e27c2a..4aac489c66a 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360.md @@ -17,7 +17,7 @@ The object containing the unit cube with the 360 images. #### Defined in -[packages/360-images/src/entity/Image360.ts:19](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/entity/Image360.ts#L19) +[packages/360-images/src/entity/Image360.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360.ts#L26) ___ @@ -30,4 +30,56 @@ of the given 360 image. #### Defined in -[packages/360-images/src/entity/Image360.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/entity/Image360.ts#L13) +[packages/360-images/src/entity/Image360.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360.ts#L20) + +## Methods + +### getActiveRevision + +▸ **getActiveRevision**(): [`Image360Revision`](cognite_reveal.Image360Revision.md) + +Get the revision that is currently loaded for this entry. + +#### Returns + +[`Image360Revision`](cognite_reveal.Image360Revision.md) + +The active revision. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:43](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360.ts#L43) + +___ + +### getImageMetadata + +▸ **getImageMetadata**(): [`Image360Metadata`](../modules/cognite_reveal.md#image360metadata) + +Get additional information about this image and its active revision. + +#### Returns + +[`Image360Metadata`](../modules/cognite_reveal.md#image360metadata) + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:31](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360.ts#L31) + +___ + +### getRevisions + +▸ **getRevisions**(): [`Image360Revision`](cognite_reveal.Image360Revision.md)[] + +List all historical images for this entity. + +#### Returns + +[`Image360Revision`](cognite_reveal.Image360Revision.md)[] + +A list of available revisions. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360.ts#L37) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Annotation.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Annotation.md new file mode 100644 index 00000000000..aa2ba0b96e4 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Annotation.md @@ -0,0 +1,88 @@ +--- +id: "cognite_reveal.Image360Annotation" +title: "Interface: Image360Annotation" +sidebar_label: "Image360Annotation" +custom_edit_url: null +--- + +[@cognite/reveal](../modules/cognite_reveal.md).Image360Annotation + +An annotation associated with a 360 image revision + +## Properties + +### annotation + +• `Readonly` **annotation**: `AnnotationModel` + +The underlying CDF annotation + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L15) + +## Methods + +### getCenter + +▸ **getCenter**(`out?`): `Vector3` + +Get center of annotation, to e.g. point the camera toward it + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `out?` | `Vector3` | + +#### Returns + +`Vector3` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L30) + +___ + +### setColor + +▸ **setColor**(`color?`): `void` + +Set the display color of this annotation. Default: Random, based on annotation label + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `color?` | `Color` | + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L20) + +___ + +### setVisible + +▸ **setVisible**(`visible?`): `void` + +Set whether this annotation should be visible. Default: true + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visible?` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Collection.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Collection.md index 8da67cec5fa..5db27182d2c 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Collection.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Collection.md @@ -19,10 +19,45 @@ A list containing all the 360 images in this set. #### Defined in -[packages/360-images/src/collection/Image360Collection.ts:15](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/collection/Image360Collection.ts#L15) +[packages/360-images/src/collection/Image360Collection.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L45) + +___ + +### targetRevisionDate + +• **targetRevisionDate**: `undefined` \| `Date` + +If defined, any subsequently entered 360 images will load the revision that are closest to the target date. +If undefined, the most recent revision will be loaded. + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:51](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L51) ## Methods +### findImageAnnotation + +▸ **findImageAnnotation**(`filter`): `Promise`<[`Image360AnnotationAssetQueryResult`](../modules/cognite_reveal.md#image360annotationassetqueryresult)[]\> + +Find 360 images associated with a asset with the given assetRef + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `filter` | [`Image360AnnotationAssetFilter`](../modules/cognite_reveal.md#image360annotationassetfilter) | + +#### Returns + +`Promise`<[`Image360AnnotationAssetQueryResult`](../modules/cognite_reveal.md#image360annotationassetqueryresult)[]\> + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:92](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L92) + +___ + ### off ▸ **off**(`event`, `callback`): `void` @@ -42,7 +77,7 @@ Unsubscribes from 360 image dataset event. #### Defined in -[packages/360-images/src/collection/Image360Collection.ts:45](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/collection/Image360Collection.ts#L45) +[packages/360-images/src/collection/Image360Collection.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L81) ▸ **off**(`event`, `callback`): `void` @@ -59,7 +94,7 @@ Unsubscribes from 360 image dataset event. #### Defined in -[packages/360-images/src/collection/Image360Collection.ts:46](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/collection/Image360Collection.ts#L46) +[packages/360-images/src/collection/Image360Collection.ts:82](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L82) ___ @@ -84,7 +119,7 @@ Subscribes to events on 360 Image datasets. There are several event types: #### Defined in -[packages/360-images/src/collection/Image360Collection.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/collection/Image360Collection.ts#L37) +[packages/360-images/src/collection/Image360Collection.ts:73](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L73) ▸ **on**(`event`, `callback`): `void` @@ -101,7 +136,7 @@ Subscribes to events on 360 Image datasets. There are several event types: #### Defined in -[packages/360-images/src/collection/Image360Collection.ts:38](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/collection/Image360Collection.ts#L38) +[packages/360-images/src/collection/Image360Collection.ts:74](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L74) ___ @@ -124,7 +159,29 @@ Specify parameters used to determine the number of icons that are visible when e #### Defined in -[packages/360-images/src/collection/Image360Collection.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/collection/Image360Collection.ts#L22) +[packages/360-images/src/collection/Image360Collection.ts:58](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L58) + +___ + +### setDefaultAnnotationStyle + +▸ **setDefaultAnnotationStyle**(`appearance`): `void` + +Assign a default style which affects all annotations + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `appearance` | [`Image360AnnotationAppearance`](../modules/cognite_reveal.md#image360annotationappearance) | + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:87](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L87) ___ @@ -146,4 +203,4 @@ Set visibility of all 360 image icons. #### Defined in -[packages/360-images/src/collection/Image360Collection.ts:28](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/collection/Image360Collection.ts#L28) +[packages/360-images/src/collection/Image360Collection.ts:64](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L64) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Revision.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Revision.md new file mode 100644 index 00000000000..3421035274d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Revision.md @@ -0,0 +1,39 @@ +--- +id: "cognite_reveal.Image360Revision" +title: "Interface: Image360Revision" +sidebar_label: "Image360Revision" +custom_edit_url: null +--- + +[@cognite/reveal](../modules/cognite_reveal.md).Image360Revision + +Interface used to manage historical revisions of [Image360](cognite_reveal.Image360.md). +One instance represents one specific image revision. + +## Properties + +### date + +• `Readonly` **date**: `undefined` \| `Date` + +The date of this revision. Undefined if the revison is undated. + +#### Defined in + +[packages/360-images/src/entity/Image360Revision.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360Revision.ts#L17) + +## Methods + +### getAnnotations + +▸ **getAnnotations**(): `Promise`<[`Image360Annotation`](cognite_reveal.Image360Annotation.md)[]\> + +The annotations associated with this revision + +#### Returns + +`Promise`<[`Image360Annotation`](cognite_reveal.Image360Annotation.md)[]\> + +#### Defined in + +[packages/360-images/src/entity/Image360Revision.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360Revision.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Visualization.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Visualization.md index 8f4cf143771..5d5f7648e60 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Visualization.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Visualization.md @@ -19,4 +19,4 @@ Opaqueness of the 360 image #### Defined in -[packages/360-images/src/entity/Image360Visualization.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/entity/Image360Visualization.ts#L12) +[packages/360-images/src/entity/Image360Visualization.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360Visualization.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Overlay3D.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Overlay3D.md new file mode 100644 index 00000000000..1032263feee --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Overlay3D.md @@ -0,0 +1,118 @@ +--- +id: "cognite_reveal.Overlay3D" +title: "Interface: Overlay3D" +sidebar_label: "Overlay3D" +custom_edit_url: null +--- + +[@cognite/reveal](../modules/cognite_reveal.md).Overlay3D + +## Type parameters + +| Name | +| :------ | +| `MetadataType` | + +## Accessors + +### color + +• `get` **color**(): `Color` + +Get the display color of this overlay. + +#### Returns + +`Color` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/Overlay3D.ts#L24) + +___ + +### position + +• `get` **position**(): `Vector3` + +Get the position of this overlay. + +#### Returns + +`Vector3` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:16](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/Overlay3D.ts#L16) + +___ + +### visible + +• `get` **visible**(): `boolean` + +Get whether this overlay is visible. + +#### Returns + +`boolean` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/Overlay3D.ts#L12) + +• `set` **visible**(`visible`): `void` + +Set whether this overlay should be visible. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visible` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/Overlay3D.ts#L8) + +## Methods + +### getMetadata + +▸ **getMetadata**(): `undefined` \| `MetadataType` + +Get the metadata associated with this overlay. + +#### Returns + +`undefined` \| `MetadataType` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/Overlay3D.ts#L28) + +___ + +### setColor + +▸ **setColor**(`color`): `void` + +Set the display color of this overlay. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `color` | `Color` | + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/Overlay3D.ts#L20) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.OverlayCollection.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.OverlayCollection.md new file mode 100644 index 00000000000..a1c12886a02 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.OverlayCollection.md @@ -0,0 +1,114 @@ +--- +id: "cognite_reveal.OverlayCollection" +title: "Interface: OverlayCollection" +sidebar_label: "OverlayCollection" +custom_edit_url: null +--- + +[@cognite/reveal](../modules/cognite_reveal.md).OverlayCollection + +## Type parameters + +| Name | +| :------ | +| `MetadataType` | + +## Methods + +### addOverlays + +▸ **addOverlays**(`overlays`): [`Overlay3D`](cognite_reveal.Overlay3D.md)<`MetadataType`\>[] + +Add overlays to the collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `overlays` | [`OverlayInfo`](../modules/cognite_reveal.md#overlayinfo)<`MetadataType`\>[] | Overlays to add to the collection. | + +#### Returns + +[`Overlay3D`](cognite_reveal.Overlay3D.md)<`MetadataType`\>[] + +The added overlays. + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/OverlayCollection.ts#L28) + +___ + +### getOverlays + +▸ **getOverlays**(): [`Overlay3D`](cognite_reveal.Overlay3D.md)<`MetadataType`\>[] + +Get all overlays in the collection. + +#### Returns + +[`Overlay3D`](cognite_reveal.Overlay3D.md)<`MetadataType`\>[] + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/OverlayCollection.ts#L21) + +___ + +### removeAllOverlays + +▸ **removeAllOverlays**(): `void` + +Remove all overlays from the collection. + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:39](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/OverlayCollection.ts#L39) + +___ + +### removeOverlays + +▸ **removeOverlays**(`overlays`): `void` + +Remove overlays from the collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `overlays` | [`Overlay3D`](cognite_reveal.Overlay3D.md)<`MetadataType`\>[] | Overlays to remove from the collection. | + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/OverlayCollection.ts#L34) + +___ + +### setVisibility + +▸ **setVisibility**(`visibility`): `void` + +Sets whether overlays in the collection should be visible. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visibility` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:44](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/OverlayCollection.ts#L44) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BinaryFileProvider.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BinaryFileProvider.md index 186ae9a6a41..b062748a4f8 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BinaryFileProvider.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BinaryFileProvider.md @@ -33,4 +33,4 @@ custom_edit_url: null #### Defined in -[packages/data-providers/src/types.ts:11](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L11) +[packages/data-providers/src/types.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BlobOutputMetadata.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BlobOutputMetadata.md index c202e0e4241..13c1e7cc3e8 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BlobOutputMetadata.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BlobOutputMetadata.md @@ -15,7 +15,7 @@ custom_edit_url: null #### Defined in -[packages/data-providers/src/types.ts:69](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L69) +[packages/data-providers/src/types.ts:80](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L80) ___ @@ -25,7 +25,7 @@ ___ #### Defined in -[packages/data-providers/src/types.ts:70](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L70) +[packages/data-providers/src/types.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L81) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -[packages/data-providers/src/types.ts:71](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L71) +[packages/data-providers/src/types.ts:82](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L82) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.DataSource.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.DataSource.md index f7dad1ec4d3..cabb98472bb 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.DataSource.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.DataSource.md @@ -25,7 +25,7 @@ for models. #### Defined in -[packages/data-source/src/DataSource.ts:28](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-source/src/DataSource.ts#L28) +[packages/data-source/src/DataSource.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-source/src/DataSource.ts#L28) ___ @@ -41,7 +41,7 @@ Gets a metadata provider for models. #### Defined in -[packages/data-source/src/DataSource.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-source/src/DataSource.ts#L22) +[packages/data-source/src/DataSource.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-source/src/DataSource.ts#L22) ___ @@ -58,4 +58,4 @@ models. #### Defined in -[packages/data-source/src/DataSource.ts:17](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-source/src/DataSource.ts#L17) +[packages/data-source/src/DataSource.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-source/src/DataSource.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.JsonFileProvider.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.JsonFileProvider.md index b44f868450f..070baf8f908 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.JsonFileProvider.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.JsonFileProvider.md @@ -32,4 +32,4 @@ custom_edit_url: null #### Defined in -[packages/data-providers/src/types.ts:7](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/types.ts#L7) +[packages/data-providers/src/types.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L8) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelDataProvider.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelDataProvider.md index 2afde334063..fa3df6e20b8 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelDataProvider.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelDataProvider.md @@ -43,7 +43,7 @@ Downloads a binary blob. #### Defined in -[packages/data-providers/src/ModelDataProvider.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/ModelDataProvider.ts#L23) +[packages/data-providers/src/ModelDataProvider.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelDataProvider.ts#L23) ___ @@ -70,4 +70,4 @@ Download and parse a JSON file and return the resulting struct. #### Defined in -[packages/data-providers/src/ModelDataProvider.ts:16](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/ModelDataProvider.ts#L16) +[packages/data-providers/src/ModelDataProvider.ts:16](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelDataProvider.ts#L16) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md index 305c3d88c07..5a40d89e2ea 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md @@ -23,4 +23,4 @@ Unique ID of the model. #### Defined in -[packages/data-providers/src/ModelIdentifier.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/ModelIdentifier.ts#L12) +[packages/data-providers/src/ModelIdentifier.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelIdentifier.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelMetadataProvider.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelMetadataProvider.md index 1f3dbec7bd4..31c628753fe 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelMetadataProvider.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelMetadataProvider.md @@ -27,7 +27,7 @@ Provides metadata for 3D models. #### Defined in -[packages/data-providers/src/ModelMetadataProvider.ts:14](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L14) +[packages/data-providers/src/ModelMetadataProvider.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L14) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[packages/data-providers/src/ModelMetadataProvider.ts:15](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L15) +[packages/data-providers/src/ModelMetadataProvider.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L15) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[packages/data-providers/src/ModelMetadataProvider.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L12) +[packages/data-providers/src/ModelMetadataProvider.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L12) ___ @@ -89,4 +89,4 @@ ___ #### Defined in -[packages/data-providers/src/ModelMetadataProvider.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L13) +[packages/data-providers/src/ModelMetadataProvider.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L13) diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.NodesApiClient.md b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.NodesApiClient.md index 9d5dc7287a4..ff2fd4779b2 100644 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.NodesApiClient.md +++ b/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.NodesApiClient.md @@ -33,7 +33,7 @@ ancestor at the generation given, the span of the root node is returned. #### Defined in -[packages/nodes-api/src/NodesApiClient.ts:51](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/nodes-api/src/NodesApiClient.ts#L51) +[packages/nodes-api/src/NodesApiClient.ts:51](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L51) ___ @@ -58,7 +58,7 @@ of) given a set of node IDs. #### Defined in -[packages/nodes-api/src/NodesApiClient.ts:37](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/nodes-api/src/NodesApiClient.ts#L37) +[packages/nodes-api/src/NodesApiClient.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L37) ___ @@ -84,7 +84,7 @@ the model transformation for the given model. #### Defined in -[packages/nodes-api/src/NodesApiClient.ts:67](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/nodes-api/src/NodesApiClient.ts#L67) +[packages/nodes-api/src/NodesApiClient.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L67) ___ @@ -109,7 +109,7 @@ Maps a set of "node IDs" that identify nodes, to the respective #### Defined in -[packages/nodes-api/src/NodesApiClient.ts:27](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/nodes-api/src/NodesApiClient.ts#L27) +[packages/nodes-api/src/NodesApiClient.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L27) ___ @@ -134,4 +134,4 @@ Maps a set of "tree indexes" that identify nodes, to the respective #### Defined in -[packages/nodes-api/src/NodesApiClient.ts:17](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/nodes-api/src/NodesApiClient.ts#L17) +[packages/nodes-api/src/NodesApiClient.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal.md b/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal.md index af5dd6cc452..6de553ad3ee 100644 --- a/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal.md +++ b/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal.md @@ -50,8 +50,12 @@ custom_edit_url: null - [CdfModelNodeCollectionDataProvider](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) - [Cognite3DViewerOptions](../interfaces/cognite_reveal.Cognite3DViewerOptions.md) - [Image360](../interfaces/cognite_reveal.Image360.md) +- [Image360Annotation](../interfaces/cognite_reveal.Image360Annotation.md) - [Image360Collection](../interfaces/cognite_reveal.Image360Collection.md) +- [Image360Revision](../interfaces/cognite_reveal.Image360Revision.md) - [Image360Visualization](../interfaces/cognite_reveal.Image360Visualization.md) +- [Overlay3D](../interfaces/cognite_reveal.Overlay3D.md) +- [OverlayCollection](../interfaces/cognite_reveal.OverlayCollection.md) ## Type Aliases @@ -64,11 +68,11 @@ custom_edit_url: null | Name | Type | Description | | :------ | :------ | :------ | | `collectionTransform?` | `THREE.Matrix4` | An optional transformation which will be applied to all 360 images that are fetched. | -| `preMultipliedRotation?` | `boolean` | Set this to false if the 360 images' rotation is not pre-multiplied to fit the given model. **`Default`** true | +| `preMultipliedRotation?` | `boolean` | Set this to false if the 360 images' rotation is not pre-multiplied to fit the given model. **`Default`** ```ts true ``` | #### Defined in -[packages/api/src/public/migration/types.ts:190](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L190) +[packages/api/src/public/migration/types.ts:203](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L203) ___ @@ -97,7 +101,7 @@ Delegate for event triggered when scene is about to be rendered. #### Defined in -[packages/utilities/src/events/types.ts:25](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/events/types.ts#L25) +[packages/utilities/src/events/types.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L25) ___ @@ -117,7 +121,7 @@ ___ #### Defined in -[packages/api/src/public/migration/types.ts:202](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L202) +[packages/api/src/public/migration/types.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L215) ___ @@ -136,7 +140,7 @@ Represents a measurement of how much geometry can be loaded. #### Defined in -[packages/cad-geometry-loaders/src/CadModelBudget.ts:10](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-geometry-loaders/src/CadModelBudget.ts#L10) +[packages/cad-geometry-loaders/src/CadModelBudget.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-geometry-loaders/src/CadModelBudget.ts#L10) ___ @@ -161,7 +165,7 @@ ___ #### Defined in -[packages/camera-manager/src/types.ts:85](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/types.ts#L85) +[packages/camera-manager/src/types.ts:85](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L85) ___ @@ -180,7 +184,7 @@ Represents a camera configuration, consisting of a camera position and target. #### Defined in -[packages/utilities/src/CameraConfiguration.ts:8](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/CameraConfiguration.ts#L8) +[packages/utilities/src/CameraConfiguration.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/CameraConfiguration.ts#L8) ___ @@ -197,7 +201,7 @@ ___ #### Defined in -[packages/camera-manager/src/types.ts:5](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/types.ts#L5) +[packages/camera-manager/src/types.ts:5](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L5) ___ @@ -209,7 +213,7 @@ Union type of all camera event delegates #### Defined in -[packages/camera-manager/src/types.ts:96](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/types.ts#L96) +[packages/camera-manager/src/types.ts:96](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L96) ___ @@ -221,7 +225,7 @@ Union type of the supported camera manager event types #### Defined in -[packages/camera-manager/src/types.ts:123](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/types.ts#L123) +[packages/camera-manager/src/types.ts:123](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L123) ___ @@ -239,7 +243,7 @@ ___ #### Defined in -[packages/camera-manager/src/types.ts:66](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/types.ts#L66) +[packages/camera-manager/src/types.ts:66](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L66) ___ @@ -257,7 +261,7 @@ ___ #### Defined in -[packages/camera-manager/src/types.ts:91](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/types.ts#L91) +[packages/camera-manager/src/types.ts:91](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L91) ___ @@ -276,7 +280,7 @@ ___ #### Defined in -[packages/api/src/utilities/ViewStateHelper.ts:28](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/utilities/ViewStateHelper.ts#L28) +[packages/api/src/utilities/ViewStateHelper.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/utilities/ViewStateHelper.ts#L28) ___ @@ -288,7 +292,7 @@ Type abstraction for CogniteCadModel or CognitePointCloudModel;. #### Defined in -[packages/api/src/public/types.ts:11](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/types.ts#L11) +[packages/api/src/public/types.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/types.ts#L11) ___ @@ -339,7 +343,7 @@ Exposed options for Combo Controls #### Defined in -[packages/camera-manager/src/ComboControls.ts:47](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/ComboControls.ts#L47) +[packages/camera-manager/src/ComboControls.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L47) ___ @@ -349,7 +353,27 @@ ___ #### Defined in -[packages/pointcloud-styling/src/PointCloudAppearance.ts:12](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L12) +[packages/pointcloud-styling/src/PointCloudAppearance.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L12) + +___ + +### DefaultMetadataType + +Ƭ **DefaultMetadataType**: `Object` + +#### Index signature + +▪ [key: `string`]: `string` \| `undefined` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `text?` | `string` | + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:6](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/OverlayCollection.ts#L6) ___ @@ -367,7 +391,7 @@ ___ #### Defined in -[packages/utilities/src/events/types.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/events/types.ts#L20) +[packages/utilities/src/events/types.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L20) ___ @@ -386,7 +410,7 @@ Configuration parameters for Eye Dome Lighting (EDL) point cloud post-processing #### Defined in -[packages/rendering/src/rendering/types.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/rendering/src/rendering/types.ts#L22) +[packages/rendering/src/rendering/types.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/rendering/types.ts#L22) ___ @@ -403,17 +427,94 @@ ___ #### Defined in -[packages/cad-model/src/types.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/types.ts#L21) +[packages/cad-model/src/types.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/types.ts#L23) + +___ + +### Image360AnnotationAppearance + +Ƭ **Image360AnnotationAppearance**: `Object` + +The appearance of a 360 image annotation + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `color?` | `Color` | The color of the annotation. Default: Random, based on annotation label | +| `visible?` | `boolean` | Whether the annotation is visible. Default: true | + +#### Defined in + +[packages/360-images/src/annotation/types.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/annotation/types.ts#L10) + +___ + +### Image360AnnotationAssetFilter + +Ƭ **Image360AnnotationAssetFilter**: `Object` + +Filter for finding annotation related to asset + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `assetRef` | `IdEither` | + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:16](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L16) + +___ + +### Image360AnnotationAssetQueryResult + +Ƭ **Image360AnnotationAssetQueryResult**: `Object` + +Result item from an asset annotation query + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `annotation` | [`Image360Annotation`](../interfaces/cognite_reveal.Image360Annotation.md) | The found annotation | +| `image` | [`Image360`](../interfaces/cognite_reveal.Image360.md) | The Image360 to which the result annotation belongs | +| `revision` | [`Image360Revision`](../interfaces/cognite_reveal.Image360Revision.md) | The image revision to which the result annotation belongs | + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L23) + +___ + +### Image360AnnotationIntersection + +Ƭ **Image360AnnotationIntersection**: `Object` + +Describes an intersection with a 360 image annotation + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `annotation` | [`Image360Annotation`](../interfaces/cognite_reveal.Image360Annotation.md) | The intersected annotation | +| `direction` | `Vector3` | The world direction from the camera to the intersection point | +| `type` | ``"image360Annotation"`` | The intersection type. | + +#### Defined in + +[packages/360-images/src/annotation/Image360AnnotationIntersection.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/annotation/Image360AnnotationIntersection.ts#L11) ___ ### Image360EnteredDelegate -Ƭ **Image360EnteredDelegate**: (`image360`: [`Image360`](../interfaces/cognite_reveal.Image360.md)) => `void` +Ƭ **Image360EnteredDelegate**: (`image360`: [`Image360`](../interfaces/cognite_reveal.Image360.md), `revision`: [`Image360Revision`](../interfaces/cognite_reveal.Image360Revision.md)) => `void` #### Type declaration -▸ (`image360`): `void` +▸ (`image360`, `revision`): `void` Delegate for 360 image mode entered events. @@ -422,6 +523,7 @@ Delegate for 360 image mode entered events. | Name | Type | | :------ | :------ | | `image360` | [`Image360`](../interfaces/cognite_reveal.Image360.md) | +| `revision` | [`Image360Revision`](../interfaces/cognite_reveal.Image360Revision.md) | ##### Returns @@ -429,7 +531,7 @@ Delegate for 360 image mode entered events. #### Defined in -[packages/360-images/src/types.ts:10](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/types.ts#L10) +[packages/360-images/src/types.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/types.ts#L11) ___ @@ -449,7 +551,25 @@ Delegate for 360 image mode exited events. #### Defined in -[packages/360-images/src/types.ts:15](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/360-images/src/types.ts#L15) +[packages/360-images/src/types.ts:16](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/types.ts#L16) + +___ + +### Image360Metadata + +Ƭ **Image360Metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `collection` | `string` | +| `date?` | `Date` | +| `station` | `string` | + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360.ts#L8) ___ @@ -459,7 +579,7 @@ ___ #### Defined in -[packages/api/src/public/migration/types.ts:255](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L255) +[packages/api/src/public/migration/types.ts:268](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L268) ___ @@ -478,7 +598,7 @@ ___ #### Defined in -[packages/api/src/utilities/ViewStateHelper.ts:35](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/utilities/ViewStateHelper.ts#L35) +[packages/api/src/utilities/ViewStateHelper.ts:35](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/utilities/ViewStateHelper.ts#L35) ___ @@ -505,7 +625,7 @@ Type for defining node appearance profiles to style a 3D CAD model. #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L22) +[packages/cad-styling/src/NodeAppearance.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L22) ___ @@ -522,7 +642,7 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollectionDeserializer.ts:22](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollectionDeserializer.ts#L22) +[packages/cad-styling/src/NodeCollectionDeserializer.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollectionDeserializer.ts#L22) ___ @@ -548,7 +668,31 @@ ___ #### Defined in -[packages/api/src/public/migration/types.ts:24](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L24) +[packages/api/src/public/migration/types.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L27) + +___ + +### OverlayInfo + +Ƭ **OverlayInfo**<`MetadataType`\>: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `MetadataType` | [`DefaultMetadataType`](cognite_reveal.md#defaultmetadatatype) | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `color?` | `THREE.Color` | +| `metadata?` | `MetadataType` | +| `position` | `THREE.Vector3` | + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/3d-overlays/src/OverlayCollection.ts#L11) ___ @@ -565,7 +709,7 @@ ___ #### Defined in -[packages/pointcloud-styling/src/PointCloudAppearance.ts:7](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L7) +[packages/pointcloud-styling/src/PointCloudAppearance.ts:7](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L7) ___ @@ -584,7 +728,7 @@ loaded at the same time. #### Defined in -[packages/pointclouds/src/PointCloudBudget.ts:10](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/PointCloudBudget.ts#L10) +[packages/pointclouds/src/PointCloudBudget.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/PointCloudBudget.ts#L10) ___ @@ -600,13 +744,13 @@ ___ | `assetRef?` | `AnnotationsAssetRef` | Reference to the asset associated to the intersected point cloud object, if any. | | `distanceToCamera` | `number` | Distance from the camera to the intersection. | | `model` | [`CognitePointCloudModel`](../classes/cognite_reveal.CognitePointCloudModel.md) | The model that was intersected. | -| `point` | `THREE.Vector3` | Tree index of the intersected 3D node. | +| `point` | `THREE.Vector3` | Coordinate of the intersection. | | `pointIndex` | `number` | The index of the point that was intersected. | | `type` | ``"pointcloud"`` | The intersection type. | #### Defined in -[packages/pointclouds/src/PointCloudIntersection.ts:7](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointclouds/src/PointCloudIntersection.ts#L7) +[packages/pointclouds/src/PointCloudIntersection.ts:7](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/PointCloudIntersection.ts#L7) ___ @@ -621,13 +765,13 @@ Metadata for a single point cloud object | Name | Type | Description | | :------ | :------ | :------ | | `annotationId` | `number` | The CDF Annotation ID associated with the point cloud object. | -| `assetId?` | `number` | The CDF Asset ID associated with the point cloud object, if any. **`Deprecated`** Use PointCloudObjectMetadata.assetRef instead. | +| `assetId?` | `number` | The CDF Asset ID associated with the point cloud object, if any. **`Deprecated`** Use [assetRef](cognite_reveal.md#assetref) instead. | | `assetRef?` | `AnnotationsAssetRef` | Asset identifiers for asset associated with this point cloud object, if any. | | `boundingBox` | `Box3` | The bounding box of this annotation | #### Defined in -[packages/data-providers/src/pointcloud-stylable-object-providers/types.ts:21](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/data-providers/src/pointcloud-stylable-object-providers/types.ts#L21) +[packages/data-providers/src/pointcloud-stylable-object-providers/types.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/pointcloud-stylable-object-providers/types.ts#L21) ___ @@ -645,7 +789,7 @@ ___ #### Defined in -[packages/utilities/src/events/types.ts:15](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/events/types.ts#L15) +[packages/utilities/src/events/types.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L15) ___ @@ -669,7 +813,7 @@ ___ #### Defined in -[packages/utilities/src/events/types.ts:9](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/events/types.ts#L9) +[packages/utilities/src/events/types.ts:9](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L9) ___ @@ -687,7 +831,25 @@ Options for [PropertyFilterNodeCollection](../classes/cognite_reveal.PropertyFil #### Defined in -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:17](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L17) +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L18) + +___ + +### RenderParameters + +Ƭ **RenderParameters**: `Object` + +Some parameters of THREE.WebGLRenderer initialized with [Cognite3DViewer](../classes/cognite_reveal.Cognite3DViewer.md). + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `renderSize` | `THREE.Vector2` | Current width and height of the renderer's output canvas, in pixels. | + +#### Defined in + +[packages/api/src/public/migration/types.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L32) ___ @@ -704,7 +866,7 @@ ___ #### Defined in -[packages/api/src/public/migration/types.ts:231](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/public/migration/types.ts#L231) +[packages/api/src/public/migration/types.ts:244](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L244) ___ @@ -732,7 +894,7 @@ ___ #### Defined in -[packages/utilities/src/events/types.ts:35](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/events/types.ts#L35) +[packages/utilities/src/events/types.ts:35](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L35) ___ @@ -755,7 +917,7 @@ Type that represents a [NodeAppearance](cognite_reveal.md#nodeappearance) in a s #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:77](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L77) +[packages/cad-styling/src/NodeAppearance.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L77) ___ @@ -773,7 +935,7 @@ ___ #### Defined in -[packages/cad-styling/src/SerializedNodeCollection.ts:4](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/SerializedNodeCollection.ts#L4) +[packages/cad-styling/src/SerializedNodeCollection.ts:4](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SerializedNodeCollection.ts#L4) ___ @@ -783,7 +945,7 @@ ___ #### Defined in -[packages/model-base/src/SupportedModelTypes.ts:4](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/model-base/src/SupportedModelTypes.ts#L4) +[packages/model-base/src/SupportedModelTypes.ts:4](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/model-base/src/SupportedModelTypes.ts#L4) ___ @@ -809,7 +971,7 @@ ___ #### Defined in -[packages/api/src/utilities/ViewStateHelper.ts:19](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/src/utilities/ViewStateHelper.ts#L19) +[packages/api/src/utilities/ViewStateHelper.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/utilities/ViewStateHelper.ts#L19) ___ @@ -821,7 +983,7 @@ Units supported by [CogniteCadModel](../classes/cognite_reveal.CogniteCadModel.m #### Defined in -[packages/cad-model/src/types.ts:8](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-model/src/types.ts#L8) +[packages/cad-model/src/types.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/types.ts#L10) ## Variables @@ -833,7 +995,7 @@ List of supported event types (adapted from https://stackoverflow.com/questions/ #### Defined in -[packages/camera-manager/src/types.ts:118](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/camera-manager/src/types.ts#L118) +[packages/camera-manager/src/types.ts:118](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L118) ___ @@ -842,13 +1004,11 @@ ___ • `Const` **CDF\_TO\_VIEWER\_TRANSFORMATION**: `Matrix4` = `cadFromCdfToThreeMatrix` The transformation matrix from CDF coordinates to ThreeJS/Reveal. -Note that this is already applied to [CogniteCadModel](../classes/cognite_reveal.CogniteCadModel.md) and [CognitePointCloudModel](../classes/cognite_reveal.CognitePointCloudModel.md) -automatically, as it is factored into the matrix returned from e.g. -the [getCdfToDefaultModelTransformation](../classes/cognite_reveal.CogniteCadModel.md#getcdftodefaultmodeltransformation) method. +Note that this is already applied to Reveal models. #### Defined in -[packages/utilities/src/constants.ts:16](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/utilities/src/constants.ts#L16) +[packages/utilities/src/constants.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/constants.ts#L14) ___ @@ -877,7 +1037,7 @@ A set of default node appearances used in Reveal. #### Defined in -[packages/cad-styling/src/NodeAppearance.ts:142](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeAppearance.ts#L142) +[packages/cad-styling/src/NodeAppearance.ts:142](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L142) ___ @@ -887,7 +1047,7 @@ ___ #### Defined in -[packages/pointcloud-styling/src/PointCloudAppearance.ts:14](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L14) +[packages/pointcloud-styling/src/PointCloudAppearance.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L14) ___ @@ -897,7 +1057,7 @@ ___ #### Defined in -[packages/api/index.ts:11](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/api/index.ts#L11) +[packages/api/index.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/index.ts#L11) ## Functions @@ -924,4 +1084,4 @@ ___ #### Defined in -[packages/cad-styling/src/NodeCollectionDeserializer.ts:156](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/cad-styling/src/NodeCollectionDeserializer.ts#L156) +[packages/cad-styling/src/NodeCollectionDeserializer.ts:156](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollectionDeserializer.ts#L156) diff --git a/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal_tools.md b/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal_tools.md index 98ab3c1d66a..45ba89855ca 100644 --- a/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal_tools.md +++ b/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal_tools.md @@ -18,6 +18,7 @@ custom_edit_url: null - [HtmlOverlayTool](../classes/cognite_reveal_tools.HtmlOverlayTool.md) - [Keyframe](../classes/cognite_reveal_tools.Keyframe.md) - [MeasurementTool](../classes/cognite_reveal_tools.MeasurementTool.md) +- [SmartOverlayTool](../classes/cognite_reveal_tools.SmartOverlayTool.md) - [TimelineTool](../classes/cognite_reveal_tools.TimelineTool.md) ## Type Aliases @@ -37,7 +38,7 @@ Absolute position in pixels. #### Defined in -[packages/tools/src/AxisView/types.ts:47](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L47) +[packages/tools/src/AxisView/types.ts:48](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L48) ___ @@ -59,7 +60,7 @@ Configuration of the compass. #### Defined in -[packages/tools/src/AxisView/types.ts:79](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L79) +[packages/tools/src/AxisView/types.ts:80](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L80) ___ @@ -87,7 +88,7 @@ Configuration of [AxisViewTool](../classes/cognite_reveal_tools.AxisViewTool.md) #### Defined in -[packages/tools/src/AxisView/types.ts:10](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L10) +[packages/tools/src/AxisView/types.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L11) ___ @@ -110,7 +111,7 @@ Configuration of each face of the orientation box. #### Defined in -[packages/tools/src/AxisView/types.ts:64](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L64) +[packages/tools/src/AxisView/types.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L65) ___ @@ -136,7 +137,7 @@ Custom callback for users to change measurement label content. #### Defined in -[packages/tools/src/Measurement/types.ts:8](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/types.ts#L8) +[packages/tools/src/Measurement/types.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L8) ___ @@ -163,7 +164,7 @@ Callback that is triggered when a set of overlays are clustered together in #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:32](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L32) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L32) ___ @@ -182,7 +183,7 @@ Options for an overlay added using [add](../classes/cognite_reveal_tools.HtmlOve #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:42](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L42) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L42) ___ @@ -213,7 +214,7 @@ in [HtmlOverlayTool](../classes/cognite_reveal_tools.HtmlOverlayTool.md). #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:20](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L20) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L20) ___ @@ -232,7 +233,7 @@ Controls how close overlay elements are clustered together. #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:57](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L57) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:57](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L57) ___ @@ -250,7 +251,7 @@ Options for the visualization of overlays #### Defined in -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:82](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L82) +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:82](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L82) ___ @@ -269,7 +270,7 @@ ___ #### Defined in -[packages/tools/src/Measurement/MeasurementManager.ts:11](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/MeasurementManager.ts#L11) +[packages/tools/src/Measurement/MeasurementManager.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementManager.ts#L11) ___ @@ -299,7 +300,7 @@ Delegate for measurement added events. #### Defined in -[packages/tools/src/Measurement/types.ts:13](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/types.ts#L13) +[packages/tools/src/Measurement/types.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L13) ___ @@ -319,7 +320,7 @@ Delegate for measurement ended events. #### Defined in -[packages/tools/src/Measurement/types.ts:28](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/types.ts#L28) +[packages/tools/src/Measurement/types.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L28) ___ @@ -339,7 +340,7 @@ Measurement tool option with user custom callback, line width & color. #### Defined in -[packages/tools/src/Measurement/types.ts:33](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/types.ts#L33) +[packages/tools/src/Measurement/types.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L33) ___ @@ -359,7 +360,52 @@ Delegate for measurement started events. #### Defined in -[packages/tools/src/Measurement/types.ts:23](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Measurement/types.ts#L23) +[packages/tools/src/Measurement/types.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L23) + +___ + +### OverlayEventHandler + +Ƭ **OverlayEventHandler**<`MetadataType`\>: (`event`: { `htmlOverlay`: `HTMLElement` ; `mousePosition`: { `clientX`: `number` ; `clientY`: `number` } ; `targetOverlay`: [`Overlay3D`](../interfaces/cognite_reveal.Overlay3D.md)<`MetadataType`\> }) => `void` + +#### Type parameters + +| Name | +| :------ | +| `MetadataType` | + +#### Type declaration + +▸ (`event`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `Object` | +| `event.htmlOverlay` | `HTMLElement` | +| `event.mousePosition` | `Object` | +| `event.mousePosition.clientX` | `number` | +| `event.mousePosition.clientY` | `number` | +| `event.targetOverlay` | [`Overlay3D`](../interfaces/cognite_reveal.Overlay3D.md)<`MetadataType`\> | + +##### Returns + +`void` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L19) + +___ + +### OverlayToolEvent + +Ƭ **OverlayToolEvent**: ``"hover"`` \| ``"click"`` \| ``"disposed"`` + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L17) ___ @@ -379,7 +425,24 @@ and a given padding. #### Defined in -[packages/tools/src/AxisView/types.ts:56](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/AxisView/types.ts#L56) +[packages/tools/src/AxisView/types.ts:57](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L57) + +___ + +### SmartOverlayToolParameters + +Ƭ **SmartOverlayToolParameters**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `defaultOverlayColor` | `THREE.Color` | Sets default overlay color for newly added labels. | +| `maxPointSize?` | `number` | 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. Default is 64. | + +#### Defined in + +[packages/tools/src/SmartOverlay/SmartOverlayTool.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/SmartOverlay/SmartOverlayTool.ts#L25) ___ @@ -409,4 +472,4 @@ Delegate for Timeline Date update #### Defined in -[packages/tools/src/Timeline/types.ts:8](https://github.com/cognitedata/reveal/blob/917d1d190/viewer/packages/tools/src/Timeline/types.ts#L8) +[packages/tools/src/Timeline/types.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/types.ts#L8) diff --git a/documentation/versioned_docs/version-4.x/examples/image360-annotations.mdx b/documentation/versioned_docs/version-4.x/examples/image360-annotations.mdx new file mode 100644 index 00000000000..8c33a69d3d5 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/examples/image360-annotations.mdx @@ -0,0 +1,78 @@ +--- +id: image360-annotations +title: 360 Image Annotations +description: Displaying and using annotations on 360 images +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; + +360-images may be connected to _annotations_ that outline regions of interest in the images. They are only visible when the user has entered the 360 image with which they are associated. Reveal automatically finds and downloads any relevant annotations from CDF and displays them by default. + +### Annotation requirements + +Reveal only considers annotations following specific requirements. For an annotation to be found by Reveal, it must have its `annotatedResourceId` set to the ID of an image file belonging to the 360 image set. Furthermore, `annotatedResourceType` must be `"file"` and `annotationType` must be either `"images.ObjectDetection"` or `"images.AssetLink`". Currently, only annotations containing either a `boundingBox` or a `polygon` is supported, `polyline` annotations will not be displayed. Refer to [the CDF documentation](https://docs.cognite.com/api/v1/#tag/Annotations/operation/annotationsCreate) for details on the annotation types. + +Annotations are represented by `Image360Annotation` instances. The annotations associated with a given entity revision can be queried with the `getAnnotations()` method on the `Image360Revision` instance. Note that annotations are loaded lazily, i.e. they will only be loaded when entering the relevant 360 image revision or when calling `getAnnotations()`. + +## Styling Annotations + +The appearance of annotations can be changed both through a "default" style and through styling annotations individually. + +### Default style + +To set a default style for all annotations in an `Image360Collection`, you may call the `collection.setDefaultStyle(appearance)`, where `collection` is an `Image360Collection` instance. The `appearance` argument is an `Image360AnnotationAppearance` instance, which has the following content: + +#### `Image360AnnotationAppearance` + +| Field | Field type | Description | +|--------------|---------------------------|--------------------------------------------------| +| `color` | `THREE.Color?` | The color of the annotation | +| `visible` | `boolean?` | Whether the annotation should be visible or not | + +Leaving any of the fields undefined causes the annotations to revert to the original value for that property. + +Using this, we can e.g. hide all annotations using + +```js +collection.setDefaultAnnotationStyle({ visible: false }); +``` + +### Individual style + +Setting individual style can be done directly on an `Image360Annotation` object. Styling fields set this way will override those of the default appearance. E.g. to hide all annotations created by `'user0'` in a revision, you may write + +```js +revision + .getAnnotations() + .then(annotations => + annotations + .filter(annotation => annotation.annotation.creatingUser === 'user0') + .forEach(annotation => annotation.setVisible(false)) + ); +``` + +Since annotations are lazy-loaded, it is usually appropriate to only first apply styling upon entering the relevant revision. This can be done e.g. through registering a listener on the collection: + +```js +collection.on('image360Entered', (entity, revision) => { + revision + .getAnnotations() + .then(annotations => styleAnnotations(annotations)); +}); +``` + +## Mouse pointer interaction + +The application may react to mouse interactions with annotations by subscribing to e.g. click-events on the viewer object, and subsequently using the received mouse position in the `get360AnnotationIntersectionFromPixel` method on the `Cognite3DViewer` instance. Note that this method will only check interactions with annotations that are associated with the current image360 revision and visible. + +To e.g. color every clicked annotation with a blue color, you may write + +```js +viewer.on('click', event => { + viewer.get360AnnotationIntersectionFromPixel( + event.offsetX, event.offsetY + ).then( + intersection => intersection?.annotation.setColor(new THREE.Color(0, 0, 1)) + ); +}); +``` diff --git a/documentation/versioned_docs/version-4.x/examples/image360.mdx b/documentation/versioned_docs/version-4.x/examples/image360.mdx index 88db4bc1898..fd5d595d32b 100644 --- a/documentation/versioned_docs/version-4.x/examples/image360.mdx +++ b/documentation/versioned_docs/version-4.x/examples/image360.mdx @@ -69,14 +69,39 @@ The `transform` property from `Image360` represents the world transformation (ro The `Image360Visualization` object has convenience functionality related to the visualization of the 360 image such as setting the opacity of the given 360 image. ## Events -The `Image360Collection` exposes events `image360Entered` and `image360Exited` for subscribing to enter & exit from 360 image mode. +The `Image360Collection` exposes events `image360Entered` and `image360Exited` for subscribing to enter & exit from 360 image mode. The `image360Entered` event is also triggered when the [revision](#historical-images) of an image is changed. Subscribing to the events can look like ```ts const image360Collection = await viewer.add360ImageSet('events', { site_id: 'site-S01-area-a03' }); -image360Collection.on('image360Entered', (image360: Image360) => { +image360Collection.on('image360Entered', (image360: Image360, revision: Image360Revision) => { const position = new THREE.Vector3(); position.setFromMatrixPosition(image360.transform); alert(`360 Image mode entered at Image position: ${JSON.stringify(position)}`); }); image360Collection.on('image360Exited', () => { alert('Exited from 360 Image mode'); }); ``` + +## Historical images +Some image collections include 360 images with historical revisions. The `360Image` interface includes a `getRevisions` method used to obtain a list of all available revisions for that image. This list contains `Image360Revision` objects sorted by date, with the most recent revision at the beginning of the list. + +Each `Image360Revision` object has a `date` property that represents when the image was taken. If an image is undated, the `date` property will be `undefined`. +```ts +image360.getRevisions().forEach(availableRevision => console.log(availableRevision.date); +``` + +You can get the currently active revision for any `Image360` by using the `getActiveRevision` method. Optionally, you can retrieve the active revision when `image360Entered` is triggered, as the revision of the entered image is included in the event. +```ts +image360Collection.on('image360Entered', (image360: Image360, revision: Image360Revision) => { + const activeDate = image360.getActiveRevision().date; + const enteredDate = revision.date; + alert(`The result is the same: ${activeDate} is equal to ${enteredDate}`); +}; +``` + +To change the revision of an `Image360`, call the `enter360Image` method on `Cognite3DViewer`. Pass in the `Image360` you want to change, along with one of the available revisions for that image. +```ts +const revisions = image360.getRevisions(); +const newRevision = revisions[1]; +await viewer.enter360Image(image360, newRevision); +alert(`Revision changed to ${newRevision.date}`); +``` \ No newline at end of file