diff --git a/documentation/docs/examples/image360.mdx b/documentation/docs/examples/image360.mdx index 18f1bce55bc..7c71fe97561 100644 --- a/documentation/docs/examples/image360.mdx +++ b/documentation/docs/examples/image360.mdx @@ -27,17 +27,17 @@ exit360Image(): void ``` To visualize 360 images the data must have been previously ingested into [Cognite Data Fusion](https://www.cognite.com/en/product/cognite_data_fusion_industrial_dataops_platform). -More info on the ingestion process can be found [here](https://docs.cognite.com/cdf/3d/guides/360images_upload/). +More info on the ingestion process for 360 images can be found [here](https://docs.cognite.com/cdf/3d/guides/360images_upload/). Once the data is ingested, a set of 360 images can be added to the viewer with `viewer.add360ImageSet(...)`. `datasource` describes the source data type used for storing the 360 images. -At this time, the only valid `datasource` is `'events'`, but you can expect more to be added in the future. -The `eventFilter` property describes the filter that is used when fetching data from the data source. -This is a generic key-value pair and can point to any metdata that was set during ingestion. +Currently, the supported `datasource`s are `'events'` and `'datamodels'`. +The `second` argument describes the filter that is used when fetching data from the data source. +For events, this is a generic key-value pair and can point to any metdata that was set during ingestion. For datamodels, this is an identifier consisting of the Data Models `externalId` and `space` of the relevant 360 collection instance. `viewer.add360ImageSet(...)` will return a `Image360Collection` which contains each of the `image360` entities for this given set. The definition of `Image360Collection` can be found [here.](../api/@cognite/reveal/interfaces/Image360Collection) -The `AddImage360Options` is used for correcting / adding transformations to the set of 360 images. The declaration can be found [here.](../api/@cognite/reveal/index.md#addimage360options) +The `AddImage360Options` is used for correcting / adding transformations to the set of 360 images. The declaration can be found [here.](../api/@cognite/reveal/type-aliases/AddImage360Options) :::note The 360 images should be ingested with proper transformation data, and one should only rely on `AddImage360Options` when failing to do so or when using the same 360 images for multiple 3D models with different coordinate system. diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/AnnotationIdPointCloudObjectCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/AnnotationIdPointCloudObjectCollection.md new file mode 100644 index 00000000000..10b49140136 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/AnnotationIdPointCloudObjectCollection.md @@ -0,0 +1,117 @@ +# Class: AnnotationIdPointCloudObjectCollection + +A simple PointCloudObjectCollection that consists of an explicitly provided list of annotation IDs + +## Extends + +- [`PointCloudObjectCollection`](PointCloudObjectCollection.md) + +## Constructors + +### new AnnotationIdPointCloudObjectCollection() + +> **new AnnotationIdPointCloudObjectCollection**(`ids`): [`AnnotationIdPointCloudObjectCollection`](AnnotationIdPointCloudObjectCollection.md) + +#### Parameters + +• **ids**: `Iterable`\<`number`\> + +#### Returns + +[`AnnotationIdPointCloudObjectCollection`](AnnotationIdPointCloudObjectCollection.md) + +#### Overrides + +[`PointCloudObjectCollection`](PointCloudObjectCollection.md) . [`constructor`](PointCloudObjectCollection.md#constructors) + +#### Defined in + +[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L13) + +## Accessors + +### isLoading + +> `get` **isLoading**(): `false` + +#### Returns + +`false` + +whether the collection is still loading data in the background i.e. not yet ready for use + +#### Overrides + +[`PointCloudObjectCollection`](PointCloudObjectCollection.md) . [`isLoading`](PointCloudObjectCollection.md#isloading) + +#### Defined in + +[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L22) + +## Methods + +### getAnnotationIds() + +> **getAnnotationIds**(): `Iterable`\<`number`\> + +#### Returns + +`Iterable`\<`number`\> + +annotation IDs of the annotations for the objects represented by this PointCloudObjectCollection instance + +#### Overrides + +[`PointCloudObjectCollection`](PointCloudObjectCollection.md) . [`getAnnotationIds`](PointCloudObjectCollection.md#getannotationids) + +#### Defined in + +[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L18) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`PointCloudObjectCollection`](PointCloudObjectCollection.md) . [`off`](PointCloudObjectCollection.md#off) + +#### Defined in + +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`PointCloudObjectCollection`](PointCloudObjectCollection.md) . [`on`](PointCloudObjectCollection.md#on) + +#### Defined in + +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/AssetNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/AssetNodeCollection.md new file mode 100644 index 00000000000..9db26b5de8d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/AssetNodeCollection.md @@ -0,0 +1,247 @@ +# Class: AssetNodeCollection + +Represents a set of nodes associated with an [asset in Cognite Fusion][https://docs.cognite.com/api/v1/#tag/Assets](https://docs.cognite.com/api/v1/#tag/Assets) +linked to the 3D model using [asset mappings][https://docs.cognite.com/api/v1/#tag/3D-Asset-Mapping](https://docs.cognite.com/api/v1/#tag/3D-Asset-Mapping). A node +is considered to be part of an asset if it has a direct asset mapping or if one of its ancestors has an asset mapping +to the asset. + +## Extends + +- [`NodeCollection`](NodeCollection.md) + +## Constructors + +### new AssetNodeCollection() + +> **new AssetNodeCollection**(`client`, `modelMetadataProvider`): [`AssetNodeCollection`](AssetNodeCollection.md) + +#### Parameters + +• **client**: `CogniteClient` + +• **modelMetadataProvider**: [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +#### Returns + +[`AssetNodeCollection`](AssetNodeCollection.md) + +#### Overrides + +`NodeCollection.constructor` + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L36) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"AssetNodeCollection"` = `'AssetNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L27) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`classToken`](NodeCollection.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`isLoading`](NodeCollection.md#isloading) + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:43](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L43) + +## Methods + +### clear() + +> **clear**(): `void` + +#### Returns + +`void` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`clear`](NodeCollection.md#clear) + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:139](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L139) + +*** + +### executeFilter() + +> **executeFilter**(`filter`): `Promise`\<`void`\> + +Updates the node collection to hold nodes associated with the asset given, or +assets within the bounding box or all assets associated with the 3D model. + +#### Parameters + +• **filter** + +• **filter.assetId?**: `number` + +ID of a single [asset][https://docs.cognite.com/dev/concepts/resource_types/assets.html](https://docs.cognite.com/dev/concepts/resource_types/assets.html) (optional) + +• **filter.boundingBox?**: `Box3` + +When provided, only assets within the provided bounds will be included in the filter. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:54](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L54) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getAreas`](NodeCollection.md#getareas) + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:151](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L151) + +*** + +### getFilter() + +> **getFilter**(): `undefined` \| `object` + +#### Returns + +`undefined` \| `object` + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:135](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L135) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getIndexSet`](NodeCollection.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:147](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L147) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`off`](NodeCollection.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`on`](NodeCollection.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`serialize`](NodeCollection.md#serialize) + +#### Defined in + +[packages/cad-styling/src/AssetNodeCollection.ts:155](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L155) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/BoundingBoxClipper.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/BoundingBoxClipper.md new file mode 100644 index 00000000000..20a195b3d7d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/BoundingBoxClipper.md @@ -0,0 +1,153 @@ +# Class: BoundingBoxClipper + +## Constructors + +### new BoundingBoxClipper() + +> **new BoundingBoxClipper**(`box`?): [`BoundingBoxClipper`](BoundingBoxClipper.md) + +#### Parameters + +• **box?**: `Box3` + +#### Returns + +[`BoundingBoxClipper`](BoundingBoxClipper.md) + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L18) + +## Accessors + +### clippingPlanes + +> `get` **clippingPlanes**(): `Plane`[] + +#### Returns + +`Plane`[] + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:104](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L104) + +*** + +### maxX + +> `get` **maxX**(): `number` + +> `set` **maxX**(`x`): `void` + +#### Parameters + +• **x**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:55](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L55) + +*** + +### maxY + +> `get` **maxY**(): `number` + +> `set` **maxY**(`y`): `void` + +#### Parameters + +• **y**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:64](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L64) + +*** + +### maxZ + +> `get` **maxZ**(): `number` + +> `set` **maxZ**(`z`): `void` + +#### Parameters + +• **z**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:73](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L73) + +*** + +### minX + +> `get` **minX**(): `number` + +> `set` **minX**(`x`): `void` + +#### Parameters + +• **x**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L28) + +*** + +### minY + +> `get` **minY**(): `number` + +> `set` **minY**(`y`): `void` + +#### Parameters + +• **y**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L37) + +*** + +### minZ + +> `get` **minZ**(): `number` + +> `set` **minZ**(`z`): `void` + +#### Parameters + +• **z**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/cad-model/src/utilities/BoundingBoxClipper.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L46) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CameraManagerHelper.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CameraManagerHelper.md new file mode 100644 index 00000000000..fc2e0d714c7 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CameraManagerHelper.md @@ -0,0 +1,139 @@ +# Class: CameraManagerHelper + +Helper methods for implementing a camera manager. + +## Constructors + +### new CameraManagerHelper() + +> **new CameraManagerHelper**(): [`CameraManagerHelper`](CameraManagerHelper.md) + +#### Returns + +[`CameraManagerHelper`](CameraManagerHelper.md) + +## Methods + +### calculateCameraStateToFitBoundingBox() + +> `static` **calculateCameraStateToFitBoundingBox**(`camera`, `boundingBox`, `radiusFactor`): `object` + +Calculates camera position and target that allows to see the content of provided bounding box. + +#### Parameters + +• **camera**: `PerspectiveCamera` + +Used camera instance. + +• **boundingBox**: `Box3` + +Bounding box to be fitted. + +• **radiusFactor**: `number` = `2` + +The ratio of the distance from camera to center of box and radius of the box. + +#### Returns + +`object` + +##### position + +> **position**: `Vector3` + +##### target + +> **target**: `Vector3` + +#### Defined in + +[packages/camera-manager/src/CameraManagerHelper.ts:111](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L111) + +*** + +### calculateNewRotationFromTarget() + +> `static` **calculateNewRotationFromTarget**(`camera`, `newTarget`): `Quaternion` + +Calculates camera rotation from target + +#### Parameters + +• **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:70](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L70) + +*** + +### calculateNewTargetFromRotation() + +> `static` **calculateNewTargetFromRotation**(`camera`, `rotation`, `currentTarget`, `position`): `Vector3` + +Calculates camera target based on new camera rotation. + +#### Parameters + +• **camera**: `PerspectiveCamera` + +Used camera instance. + +• **rotation**: `Quaternion` + +New camera rotation in quaternion form. + +• **currentTarget**: `Vector3` + +Current camera target. + +• **position**: `Vector3` + +New camera position. + +#### Returns + +`Vector3` + +#### Defined in + +[packages/camera-manager/src/CameraManagerHelper.ts:43](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L43) + +*** + +### updateCameraNearAndFar() + +> `static` **updateCameraNearAndFar**(`camera`, `boundingBox`): `void` + +Updates near and far plane of the camera based on the bounding box. + +#### Parameters + +• **camera**: `PerspectiveCamera` + +Used camera instance. + +• **boundingBox**: `Box3` + +Bounding box of all objects on the scene. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/CameraManagerHelper.ts:80](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L80) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CdfNodeCollectionBase.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CdfNodeCollectionBase.md new file mode 100644 index 00000000000..d9196905b00 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CdfNodeCollectionBase.md @@ -0,0 +1,199 @@ +# Class: `abstract` CdfNodeCollectionBase + +Abstract class for implementing a set of nodes to be styled. + +## Extends + +- [`NodeCollection`](NodeCollection.md) + +## Extended by + +- [`NodeIdNodeCollection`](NodeIdNodeCollection.md) +- [`PropertyFilterNodeCollection`](PropertyFilterNodeCollection.md) +- [`SinglePropertyFilterNodeCollection`](SinglePropertyFilterNodeCollection.md) + +## Constructors + +### new CdfNodeCollectionBase() + +> **new CdfNodeCollectionBase**(`classToken`, `model`): [`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) + +#### Parameters + +• **classToken**: `string` + +• **model**: [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +#### Returns + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) + +#### Overrides + +`NodeCollection.constructor` + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L20) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`classToken`](NodeCollection.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`isLoading`](NodeCollection.md#isloading) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) + +## Methods + +### clear() + +> **clear**(): `void` + +Clears the node collection and interrupts any ongoing operations. + +#### Returns + +`void` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`clear`](NodeCollection.md#clear) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getAreas`](NodeCollection.md#getareas) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getIndexSet`](NodeCollection.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`off`](NodeCollection.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`on`](NodeCollection.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> `abstract` **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`serialize`](NodeCollection.md#serialize) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L46) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/ClusteredAreaCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/ClusteredAreaCollection.md new file mode 100644 index 00000000000..a0cd1f32b69 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/ClusteredAreaCollection.md @@ -0,0 +1,136 @@ +# Class: ClusteredAreaCollection + +AreaCollection that stores a representative box set by merging +inserted boxes that are overlapping or close to each other. +It uses simple heuristics to determine which boxes are to be merged. + +## Implements + +- [`AreaCollection`](../interfaces/AreaCollection.md) + +## Constructors + +### new ClusteredAreaCollection() + +> **new ClusteredAreaCollection**(): [`ClusteredAreaCollection`](ClusteredAreaCollection.md) + +#### Returns + +[`ClusteredAreaCollection`](ClusteredAreaCollection.md) + +## Accessors + +### isEmpty + +> `get` **isEmpty**(): `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[`AreaCollection`](../interfaces/AreaCollection.md) . [`isEmpty`](../interfaces/AreaCollection.md#isempty) + +#### Defined in + +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L17) + +## Methods + +### addAreas() + +> **addAreas**(`boxes`): `void` + +Add areas to be covered by the representative set of this +AreaCollection. + +#### Parameters + +• **boxes**: `Iterable`\<`Box3`\> + +#### Returns + +`void` + +#### Implementation of + +[`AreaCollection`](../interfaces/AreaCollection.md) . [`addAreas`](../interfaces/AreaCollection.md#addareas) + +#### Defined in + +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:35](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L35) + +*** + +### areas() + +> **areas**(): `Generator`\<`Box3`, `any`, `unknown`\> + +Return some set of boxes that cover the boxes inserted with `addAreas`. +It is required that each inserted box is completely covered by some +subset of boxes in the set returned from `areas` + +#### Returns + +`Generator`\<`Box3`, `any`, `unknown`\> + +#### Implementation of + +[`AreaCollection`](../interfaces/AreaCollection.md) . [`areas`](../interfaces/AreaCollection.md#areas) + +#### Defined in + +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L21) + +*** + +### intersectWith() + +> **intersectWith**(`boxes`): `void` + +Alter the representative set to cover only the intersection between the +representative set of this AreaCollection and the incoming boxes. +Note that the intersection of two representative sets A' and B' that +represent the original box sets A and B will cover the intersection between +A and B, and will thus be a valid representative set for the intersection of A and B. + +#### Parameters + +• **boxes**: `Iterable`\<`Box3`\> + +#### Returns + +`void` + +#### Implementation of + +[`AreaCollection`](../interfaces/AreaCollection.md) . [`intersectWith`](../interfaces/AreaCollection.md#intersectwith) + +#### Defined in + +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:39](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L39) + +*** + +### intersectsBox() + +> **intersectsBox**(`box`): `boolean` + +Return whether the input box intersects the AreaCollection. + +#### Parameters + +• **box**: `Box3` + +#### Returns + +`boolean` + +#### Implementation of + +[`AreaCollection`](../interfaces/AreaCollection.md) . [`intersectsBox`](../interfaces/AreaCollection.md#intersectsbox) + +#### Defined in + +[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Cognite3DViewer.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Cognite3DViewer.md new file mode 100644 index 00000000000..d2b4d869f17 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Cognite3DViewer.md @@ -0,0 +1,1694 @@ +# Class: Cognite3DViewer + +## Constructors + +### new Cognite3DViewer() + +> **new Cognite3DViewer**(`options`): [`Cognite3DViewer`](Cognite3DViewer.md) + +#### Parameters + +• **options**: [`Cognite3DViewerOptions`](../interfaces/Cognite3DViewerOptions.md) + +#### Returns + +[`Cognite3DViewer`](Cognite3DViewer.md) + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:259](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L259) + +## Accessors + +### cadBudget + +> `get` **cadBudget**(): [`CadModelBudget`](../type-aliases/CadModelBudget.md) + +Gets the current budget for downloading geometry for CAD models. Note that this +budget is shared between all added CAD models and not a per-model budget. + +> `set` **cadBudget**(`budget`): `void` + +Sets the current budget for downloading geometry for CAD models. Note that this +budget is shared between all added CAD models and not a per-model budget. + +#### Parameters + +• **budget**: [`CadModelBudget`](../type-aliases/CadModelBudget.md) + +#### Returns + +[`CadModelBudget`](../type-aliases/CadModelBudget.md) + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:213](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L213) + +*** + +### cameraManager + +> `get` **cameraManager**(): [`CameraManager`](../interfaces/CameraManager.md) + +#### Returns + +[`CameraManager`](../interfaces/CameraManager.md) + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:664](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L664) + +*** + +### canvas + +> `get` **canvas**(): `HTMLCanvasElement` + +Returns the rendering canvas, the DOM element where the renderer draws its output. + +#### Returns + +`HTMLCanvasElement` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:125](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L125) + +*** + +### domElement + +> `get` **domElement**(): `HTMLElement` + +The DOM element the viewer will insert its rendering canvas into. +The DOM element can be specified in the options when the viewer is created. +If not specified, the DOM element will be created automatically. +The DOM element cannot be changed after the viewer has been created. + +#### Returns + +`HTMLElement` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:135](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L135) + +*** + +### models + +> `get` **models**(): [`CogniteModel`](../type-aliases/CogniteModel.md)[] + +Gets a list of models currently added to the viewer. + +#### Returns + +[`CogniteModel`](../type-aliases/CogniteModel.md)[] + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:248](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L248) + +*** + +### pointCloudBudget + +> `get` **pointCloudBudget**(): [`PointCloudBudget`](../type-aliases/PointCloudBudget.md) + +Returns the point cloud budget. The budget is shared between all loaded +point cloud models. + +> `set` **pointCloudBudget**(`budget`): `void` + +Sets the point cloud budget. The budget is shared between all loaded +point cloud models. + +#### Parameters + +• **budget**: [`PointCloudBudget`](../type-aliases/PointCloudBudget.md) + +#### Returns + +[`PointCloudBudget`](../type-aliases/PointCloudBudget.md) + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:233](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L233) + +*** + +### renderParameters + +> `get` **renderParameters**(): [`RenderParameters`](../type-aliases/RenderParameters.md) + +Returns parameters of THREE.WebGLRenderer used by the viewer. + +#### Returns + +[`RenderParameters`](../type-aliases/RenderParameters.md) + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:142](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L142) + +## Methods + +### add360ImageSet() + +#### add360ImageSet(datasource, dataModelIdentifier) + +> **add360ImageSet**(`datasource`, `dataModelIdentifier`): `Promise` \<[`Image360Collection`](../interfaces/Image360Collection.md)\> + +Adds a set of 360 images to the scene from the /datamodels API in Cognite Data Fusion. + +##### Parameters + +• **datasource**: `"datamodels"` + +The data data source which holds the references to the 360 image sets. + +• **dataModelIdentifier**: [`Image360DataModelIdentifier`](../type-aliases/Image360DataModelIdentifier.md) + +The search parameters to apply when querying Cognite Datamodels that contains the 360 images. + +##### Returns + +`Promise` \<[`Image360Collection`](../interfaces/Image360Collection.md)\> + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:837](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L837) + +#### add360ImageSet(datasource, eventFilter, add360ImageOptions) + +> **add360ImageSet**(`datasource`, `eventFilter`, `add360ImageOptions`?): `Promise` \<[`Image360Collection`](../interfaces/Image360Collection.md)\> + +Adds a set of 360 images to the scene from the /events API in Cognite Data Fusion. + +##### Parameters + +• **datasource**: `"events"` + +The CDF data source which holds the references to the 360 image sets. + +• **eventFilter** + +The metadata filter to apply when querying events that contains the 360 images. + +• **add360ImageOptions?**: [`AddImage360Options`](../type-aliases/AddImage360Options.md) + +Options for behaviours when adding 360 images. + +##### Returns + +`Promise` \<[`Image360Collection`](../interfaces/Image360Collection.md)\> + +##### Example + +```js +const eventFilter = { site_id: "12345" }; +await viewer.add360ImageSet('events', eventFilter); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:852](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L852) + +*** + +### addCadModel() + +> **addCadModel**(`options`): `Promise` \<[`CogniteCadModel`](CogniteCadModel.md)\> + +Add a new CAD 3D model to the viewer. +Call [Cognite3DViewer.fitCameraToModel](Cognite3DViewer.md#fitcameratomodel) to see the model after the model has loaded. + +#### Parameters + +• **options**: [`AddModelOptions`](../interfaces/AddModelOptions.md) + +#### Returns + +`Promise` \<[`CogniteCadModel`](CogniteCadModel.md)\> + +#### Example + +```js +const options = { +modelId: 'COGNITE_3D_MODEL_ID', +revisionId: 'COGNITE_3D_REVISION_ID', +}; +viewer.addCadModel(options).then(model => { +viewer.fitCameraToModel(model, 0); +}); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:759](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L759) + +*** + +### addCustomObject() + +> **addCustomObject**(`customObject`): `void` + +**`Beta`** + +Add a CustomObject to the viewer. + +#### Parameters + +• **customObject**: [`ICustomObject`](../interfaces/ICustomObject.md) + +#### Returns + +`void` + +#### Example + +```js +const sphere = new THREE.Mesh( +new THREE.SphereGeometry(), +new THREE.MeshBasicMaterial() +); +const customObject = CustomObject(sphere); +customObject.isPartOfBoundingBox = false; +viewer.addCustomObject(customObject); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1078](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1078) + +*** + +### addModel() + +> **addModel**(`options`): `Promise` \<[`CogniteModel`](../type-aliases/CogniteModel.md)\> + +Add a new model to the viewer. +Call [Cognite3DViewer.fitCameraToModel](Cognite3DViewer.md#fitcameratomodel) to see the model after the model has loaded. + +#### Parameters + +• **options**: [`AddModelOptions`](../interfaces/AddModelOptions.md) + +#### Returns + +`Promise` \<[`CogniteModel`](../type-aliases/CogniteModel.md)\> + +#### Example + +```js +const options = { +modelId: 'COGNITE_3D_MODEL_ID', +revisionId: 'COGNITE_3D_REVISION_ID', +}; +viewer.addModel(options).then(model => { +viewer.fitCameraToModel(model, 0); +}); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:717](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L717) + +*** + +### addObject3D() + +> **addObject3D**(`object`): `void` + +Add a THREE.Object3D to the viewer. + +#### Parameters + +• **object**: `Object3D`\<`Object3DEventMap`\> + +#### Returns + +`void` + +#### Example + +```js +const sphere = new THREE.Mesh( +new THREE.SphereGeometry(), +new THREE.MeshBasicMaterial() +); +viewer.addObject3D(sphere); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1052](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1052) + +*** + +### addPointCloudModel() + +> **addPointCloudModel**(`options`): `Promise` \<[`CognitePointCloudModel`](CognitePointCloudModel.md)\> + +Add a new pointcloud 3D model to the viewer. +Call [Cognite3DViewer.fitCameraToModel](Cognite3DViewer.md#fitcameratomodel) to see the model after the model has loaded. + +#### Parameters + +• **options**: [`AddModelOptions`](../interfaces/AddModelOptions.md) + +#### Returns + +`Promise` \<[`CognitePointCloudModel`](CognitePointCloudModel.md)\> + +#### Example + +```js +const options = { +modelId: 'COGNITE_3D_MODEL_ID', +revisionId: 'COGNITE_3D_REVISION_ID', +}; +viewer.addPointCloudModel(options).then(model => { +viewer.fitCameraToModel(model, 0); +}); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:803](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L803) + +*** + +### createCustomObjectIntersectInput() + +> **createCustomObjectIntersectInput**(`pixelCoords`): [`CustomObjectIntersectInput`](CustomObjectIntersectInput.md) + +**`Beta`** + +Creates and initialize a CustomObjectIntersectInput to be used by CustomObject.intersectIfCloser method. + +#### Parameters + +• **pixelCoords**: `Vector2` + +A Vector2 containing pixel coordinates relative to the 3D viewer. + +#### Returns + +[`CustomObjectIntersectInput`](CustomObjectIntersectInput.md) + +A CustomObjectIntersectInput ready to use. + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1518](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1518) + +*** + +### determineModelType() + +> **determineModelType**(`modelId`, `revisionId`): `Promise`\<`""` \| [`SupportedModelTypes`](../type-aliases/SupportedModelTypes.md)\> + +Use to determine of which type the model is. + +#### Parameters + +• **modelId**: `number` + +The model's id. + +• **revisionId**: `number` + +The model's revision id. + +#### Returns + +`Promise`\<`""` \| [`SupportedModelTypes`](../type-aliases/SupportedModelTypes.md)\> + +Empty string if type is not supported. + +#### Example + +```typescript +const viewer = new Cognite3DViewer(...); +const type = await viewer.determineModelType(options.modelId, options.revisionId) +let model: CogniteModel +switch (type) { + case 'cad': + model = await viewer.addCadModel(options); + break; + case 'pointcloud': + model = await viewer.addPointCloudModel(options); + break; + default: + throw new Error('Model is not supported'); +} +viewer.fitCameraToModel(model); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1010](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1010) + +*** + +### dispose() + +> **dispose**(): `void` + +Dispose of WebGL resources. Can be used to free up memory when the viewer is no longer in use. + +#### Returns + +`void` + +#### See + +[https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects](https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects) +```js +// Viewer is no longer in use, free up memory +viewer.dispose(); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:447](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L447) + +*** + +### enter360Image() + +> **enter360Image**(`image360`, `revision`?): `Promise`\<`void`\> + +Enter visualization of a 360 image. + +#### Parameters + +• **image360**: [`Image360`](../interfaces/Image360.md) + +The 360 image to enter. + +• **revision?**: [`Image360Revision`](../interfaces/Image360Revision.md) + +The image revision to use. If not provided the newest revision will be shown. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:927](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L927) + +*** + +### exit360Image() + +> **exit360Image**(): `void` + +Exit visualization of the 360 image. + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:937](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L937) + +*** + +### fitCameraToBoundingBox() + +> **fitCameraToBoundingBox**(`box`, `duration`?, `radiusFactor`?): `void` + +Move camera to a place where the content of a bounding box is visible to the camera. + +#### Parameters + +• **box**: `Box3` + +The bounding box in world space. + +• **duration?**: `number` + +The duration of the animation moving the camera. Set this to 0 (zero) to disable animation. + +• **radiusFactor?**: `number` = `2` + +The ratio of the distance from camera to center of box and radius of the box. + +#### Returns + +`void` + +#### Example + +```js +// Fit camera to bounding box over 500 milliseconds +viewer.fitCameraToBoundingBox(boundingBox, 500); +``` +```js +// Fit camera to bounding box instantaneously +viewer.fitCameraToBoundingBox(boundingBox, 0); +``` +```js +// Place the camera closer to the bounding box +viewer.fitCameraToBoundingBox(boundingBox, 500, 2); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1303](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1303) + +*** + +### fitCameraToModel() + +> **fitCameraToModel**(`model`, `duration`?): `void` + +Move camera to a place where the 3D model is visible. +It uses the bounding box of the 3D model and calls [Cognite3DViewer.fitCameraToBoundingBox](Cognite3DViewer.md#fitcameratoboundingbox). + +#### Parameters + +• **model**: [`CogniteModel`](../type-aliases/CogniteModel.md) + +The 3D model. + +• **duration?**: `number` + +The duration of the animation moving the camera. Set this to 0 (zero) to disable animation. + +#### Returns + +`void` + +#### Example + +```js +// Fit camera to model +viewer.fitCameraToModel(model); +``` +```js +// Fit camera to model over 500 milliseconds +viewer.fitCameraToModel(model, 500); +``` +```js +// Fit camera to model instantly +viewer.fitCameraToModel(model, 0); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1258](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1258) + +*** + +### fitCameraToModels() + +> **fitCameraToModels**(`models`?, `duration`?, `restrictToMostGeometry`?): `void` + +Move camera to a place where a set of 3D models are visible. + +#### Parameters + +• **models?**: [`CogniteModel`](../type-aliases/CogniteModel.md)[] + +Optional 3D models to focus the camera on. If no models are provided the camera will fit to all models. + +• **duration?**: `number` + +The duration of the animation moving the camera. Set this to 0 (zero) to disable animation. + +• **restrictToMostGeometry?**: `boolean` = `false` + +If true, attempt to remove junk geometry from the boundingBox to allow setting a good camera position. + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1269](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1269) + +*** + +### get360AnnotationIntersectionFromPixel() + +> **get360AnnotationIntersectionFromPixel**(`offsetX`, `offsetY`): `Promise`\<`null` \| [`Image360AnnotationIntersection`](../type-aliases/Image360AnnotationIntersection.md)\> + +Check for intersections with 360 annotations through the given pixel. +Similar to [Cognite3DViewer.getIntersectionFromPixel](Cognite3DViewer.md#getintersectionfrompixel), but checks 360 image annotations +instead of models. + +#### Parameters + +• **offsetX**: `number` + +• **offsetY**: `number` + +#### Returns + +`Promise`\<`null` \| [`Image360AnnotationIntersection`](../type-aliases/Image360AnnotationIntersection.md)\> + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1635](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1635) + +*** + +### get360ImageCollections() + +> **get360ImageCollections**(): [`Image360Collection`](../interfaces/Image360Collection.md)[] + +Returns a list of added 360 image collections. + +#### Returns + +[`Image360Collection`](../interfaces/Image360Collection.md)[] + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:891](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L891) + +*** + +### getActive360ImageInfo() + +> **getActive360ImageInfo**(): `undefined` \| [`Image360WithCollection`](../type-aliases/Image360WithCollection.md) + +Returns the currently entered 360 image. + +#### Returns + +`undefined` \| [`Image360WithCollection`](../type-aliases/Image360WithCollection.md) + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:898](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L898) + +*** + +### getAnyIntersectionFromPixel() + +> **getAnyIntersectionFromPixel**(`pixelCoords`, `options`?): `Promise`\<`undefined` \| [`AnyIntersection`](../type-aliases/AnyIntersection.md)\> + +**`Beta`** + +Raycasting model(s) for finding where the ray intersects with all models, including custom objects. + +#### Parameters + +• **pixelCoords**: `Vector2` + +Pixel coordinate in pixels (relative to the domElement). + +• **options?** + +• **options.predicate?** + +Check whether a CustomObject should be intersected. + +• **options.stopOnHitting360Icon?**: `boolean` + +#### Returns + +`Promise`\<`undefined` \| [`AnyIntersection`](../type-aliases/AnyIntersection.md)\> + +A promise that if there was an intersection then return the intersection object - otherwise it +returns `null` if there were no intersections. + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1576](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1576) + +*** + +### ~~getClippingPlanes()~~ + +> **getClippingPlanes**(): `Plane`[] + +Returns the current active global clipping planes. + +#### Returns + +`Plane`[] + +#### Deprecated + +Use [Cognite3DViewer.getGlobalClippingPlanes](Cognite3DViewer.md#getglobalclippingplanes) instead. + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1201](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1201) + +*** + +### getGlobalClippingPlanes() + +> **getGlobalClippingPlanes**(): `Plane`[] + +Returns the current active global clipping planes. + +#### Returns + +`Plane`[] + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1208](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1208) + +*** + +### getIntersectionFromPixel() + +> **getIntersectionFromPixel**(`offsetX`, `offsetY`): `Promise`\<`null` \| [`Intersection`](../type-aliases/Intersection.md)\> + +Raycasting model(s) for finding where the ray intersects with the model. + +#### Parameters + +• **offsetX**: `number` + +X coordinate in pixels (relative to the domElement). + +• **offsetY**: `number` + +Y coordinate in pixels (relative to the domElement). + +#### Returns + +`Promise`\<`null` \| [`Intersection`](../type-aliases/Intersection.md)\> + +A promise that if there was an intersection then return the intersection object - otherwise it +returns `null` if there were no intersections. + +#### See + +[https://en.wikipedia.org/wiki/Ray_casting](https://en.wikipedia.org/wiki/Ray_casting) For more details on Ray casting. + +#### Examples + +```js +const offsetX = 50 // pixels from the left +const offsetY = 100 // pixels from the top +const intersection = await viewer.getIntersectionFromPixel(offsetX, offsetY); +if (intersection) // it was a hit + console.log( + 'You hit model ', intersection.model, + ' at the node with tree index ', intersection.treeIndex, + ' at this exact point ', intersection.point + ); +``` + +```js +const offsetX = 50 // pixels from the left +const offsetY = 100 // pixels from the top +const intersection = await viewer.getIntersectionFromPixel(offsetX, offsetY); +if (intersection) // it was a hit + console.log( + 'You hit model ', intersection.model, + ' at the point index ', intersection.pointIndex, + ' at this exact point ', intersection.point + ); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1559](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1559) + +*** + +### getNormalizedPixelCoordinates() + +> **getNormalizedPixelCoordinates**(`pixelCoords`): `Vector2` + +Converts a pixel coordinate to normalized device coordinate (in range [-1, 1]). + +#### Parameters + +• **pixelCoords**: `Vector2` + +A Vector2 containing pixel coordinates relative to the 3D viewer. + +#### Returns + +`Vector2` + +A Vector2 containing the normalized device coordinate (in range [-1, 1]). + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1499](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1499) + +*** + +### getPixelCoordinatesFromEvent() + +> **getPixelCoordinatesFromEvent**(`event`): `Vector2` + +Determines clicked or touched pixel coordinate as offset. + +#### Parameters + +• **event**: `PointerEvent` \| `WheelEvent` + +An PointerEvent or WheelEvent. + +#### Returns + +`Vector2` + +A Vector2 containing pixel coordinates relative to the 3D viewer. + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1508](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1508) + +*** + +### getSceneBoundingBox() + +> **getSceneBoundingBox**(): `Box3` + +**`Beta`** + +Returns the union of all bounding boxes in reveal, including custom objects. + +#### Returns + +`Box3` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1216](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1216) + +*** + +### getScreenshot() + +> **getScreenshot**(`width`, `height`, `includeUI`): `Promise`\<`string`\> + +Take a screenshot from the current camera position. When drawing UI, only the viewer DOM element and its children will be included in the image. +The DOM is scaled to fit any provided resolution, and as a result some elements can be positioned incorrectly in regards to the 3D render. + +`html2canvas` is used to draw UI and this has some limitations on what CSS properties it is able to render. See [the html2canvas documentation](https://html2canvas.hertzen.com/documentation) for details. + +#### Parameters + +• **width**: `number` = `...` + +Width of the final image. Default is current canvas size. + +• **height**: `number` = `...` + +Height of the final image. Default is current canvas size. + +• **includeUI**: `boolean` = `true` + +If false the screenshot will include only the rendered 3D. Default is true. + +#### Returns + +`Promise`\<`string`\> + +A [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) of the image ('image/png'). + +#### Example + +```js +// Take a screenshot with custom resolution +const url = await viewer.getScreenshot(1920, 1080); +``` +```js +// Add a screenshot with resolution of the canvas to the page +const url = await viewer.getScreenshot(); +const image = document.createElement('img'); +image.src = url; +document.body.appendChild(image); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1397](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1397) + +*** + +### getVersion() + +> **getVersion**(): `string` + +Returns reveal version installed. + +#### Returns + +`string` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:420](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L420) + +*** + +### getViewState() + +> **getViewState**(): [`ViewerState`](../type-aliases/ViewerState.md) + +Gets the current viewer state which includes the camera pose as well as applied styling. + +#### Returns + +[`ViewerState`](../type-aliases/ViewerState.md) + +JSON object containing viewer state. + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:681](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L681) + +*** + +### loadCameraFromModel() + +> **loadCameraFromModel**(`model`): `void` + +Attempts to load the camera settings from the settings stored for the +provided model. See [https://docs.cognite.com/api/v1/#operation/get3DRevision](https://docs.cognite.com/api/v1/#operation/get3DRevision) +and [https://docs.cognite.com/api/v1/#operation/update3DRevisions](https://docs.cognite.com/api/v1/#operation/update3DRevisions) for +information on how this setting is retrieved and stored. This setting can +also be changed through the 3D models management interface in Cognite Fusion. +If no camera configuration is stored in CDF, [Cognite3DViewer.fitCameraToModel](Cognite3DViewer.md#fitcameratomodel) +is used as a fallback. + +#### Parameters + +• **model**: [`CogniteModel`](../type-aliases/CogniteModel.md) + +The model to load camera settings from. + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1230](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1230) + +*** + +### off() + +Remove event listener from the viewer. +Call [Cognite3DViewer.on](Cognite3DViewer.md#on) to add event listener. + +#### Param + +#### Param + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"click"` \| `"hover"` + +• **callback**: [`PointerEventDelegate`](../type-aliases/PointerEventDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +viewer.off('click', onClick); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:583](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L583) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraChange"` + +• **callback**: [`CameraChangeDelegate`](../type-aliases/CameraChangeDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +viewer.off('cameraChange', onCameraChange); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:590](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L590) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraStop"` + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +viewer.off('cameraStop', onCameraStop); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:597](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L597) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +Unsubscribe the 'beforeSceneRendered'-event previously subscribed with [Cognite3DViewer.on](Cognite3DViewer.md#on). + +##### Parameters + +• **event**: `"beforeSceneRendered"` + +• **callback**: [`BeforeSceneRenderedDelegate`](../type-aliases/BeforeSceneRenderedDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:601](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L601) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"sceneRendered"` + +• **callback**: [`SceneRenderedDelegate`](../type-aliases/SceneRenderedDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +viewer.off('sceneRendered', updateStats); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:608](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L608) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"disposed"` + +• **callback**: [`DisposedDelegate`](../type-aliases/DisposedDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +viewer.off('disposed', clearAll); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:615](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L615) + +*** + +### on() + +Add event listener to the viewer. +Call [Cognite3DViewer.off](Cognite3DViewer.md#off) to remove an event listener. + +#### Param + +#### Param + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Triggered when the viewer is disposed. Listeners should clean up any +resources held and remove the reference to the viewer. + +##### Parameters + +• **event**: `"disposed"` + +• **callback**: [`DisposedDelegate`](../type-aliases/DisposedDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:490](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L490) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"click"` \| `"hover"` + +• **callback**: [`PointerEventDelegate`](../type-aliases/PointerEventDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +const onClick = (event) => { console.log(event.offsetX, event.offsetY) }; +viewer.on('click', onClick); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:499](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L499) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraChange"` + +• **callback**: [`CameraChangeDelegate`](../type-aliases/CameraChangeDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +viewer.on('cameraChange', (position, target) => { + console.log('Camera changed: ', position, target); +}); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:508](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L508) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraStop"` + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +##### Returns + +`void` + +##### Example + +```js +viewer.on('cameraStop', () => { + console.log('Camera stopped'); +}); +``` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:517](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L517) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Event that is triggered immediately before the scene is rendered. + +##### Parameters + +• **event**: `"beforeSceneRendered"` + +Metadata about the rendering frame. + +• **callback**: [`BeforeSceneRenderedDelegate`](../type-aliases/BeforeSceneRenderedDelegate.md) + +Callback to trigger when event occurs. + +##### Returns + +`void` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:523](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L523) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Event that is triggered immediately after the scene has been rendered. + +##### Parameters + +• **event**: `"sceneRendered"` + +Metadata about the rendering frame. + +• **callback**: [`SceneRenderedDelegate`](../type-aliases/SceneRenderedDelegate.md) + +Callback to trigger when the event occurs. + +##### Returns + +`void` + +##### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:529](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L529) + +*** + +### remove360ImageSet() + +> **remove360ImageSet**(`imageCollection`): `void` + +Removes a previously added 360 image collection from the viewer. + +#### Parameters + +• **imageCollection**: [`Image360Collection`](../interfaces/Image360Collection.md) + +Collection to remove. + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:918](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L918) + +*** + +### ~~remove360Images()~~ + +> **remove360Images**(...`image360Entities`): `Promise`\<`void`\> + +Remove a set of 360 images. + +#### Parameters + +• ...**image360Entities**: [`Image360`](../interfaces/Image360.md)[] + +#### Returns + +`Promise`\<`void`\> + +#### Deprecated + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:907](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L907) + +*** + +### removeCustomObject() + +> **removeCustomObject**(`customObject`): `void` + +**`Beta`** + +Remove a CustomObject from the viewer. + +#### Parameters + +• **customObject**: [`ICustomObject`](../interfaces/ICustomObject.md) + +#### Returns + +`void` + +#### Example + +```js +const sphere = new THREE.Mesh(new THREE.SphereGeometry(), new THREE.MeshBasicMaterial()); +const customObject = CustomObject(sphere); +viewer.addCustomObject(sphere); +viewer.removeCustomObject(sphere); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1121](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1121) + +*** + +### removeModel() + +> **removeModel**(`model`): `void` + +Removes a model that was previously added using [Cognite3DViewer.addModel](Cognite3DViewer.md#addmodel), +[Cognite3DViewer.addCadModel](Cognite3DViewer.md#addcadmodel) or [Cognite3DViewer.addPointCloudModel](Cognite3DViewer.md#addpointcloudmodel) +. + +#### Parameters + +• **model**: [`CogniteModel`](../type-aliases/CogniteModel.md) + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:950](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L950) + +*** + +### removeObject3D() + +> **removeObject3D**(`object`): `void` + +Remove a THREE.Object3D from the viewer. + +#### Parameters + +• **object**: `Object3D`\<`Object3DEventMap`\> + +#### Returns + +`void` + +#### Example + +```js +const sphere = new THREE.Mesh(new THREE.SphereGeometry(), new THREE.MeshBasicMaterial()); +viewer.addObject3D(sphere); +viewer.removeObject3D(sphere); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1100](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1100) + +*** + +### requestRedraw() + +> **requestRedraw**(): `void` + +Typically used when you perform some changes and can't see them unless you move camera. + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1310](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1310) + +*** + +### setBackgroundColor() + +> **setBackgroundColor**(`backgroundColor`): `void` + +Sets the color used as the clear color of the renderer. + +#### Parameters + +• **backgroundColor** + +• **backgroundColor.alpha?**: `number` + +• **backgroundColor.color?**: `Color` + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1138](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1138) + +*** + +### setCameraManager() + +> **setCameraManager**(`cameraManager`): `void` + +Sets the active camera manager instance for current Cognite3Dviewer. + +#### Parameters + +• **cameraManager**: [`CameraManager`](../interfaces/CameraManager.md) + +Camera manager instance. + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:672](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L672) + +*** + +### ~~setClippingPlanes()~~ + +> **setClippingPlanes**(`clippingPlanes`): `void` + +Sets per-pixel clipping planes. Pixels behind any of the planes will be sliced away. + +#### Parameters + +• **clippingPlanes**: `Plane`[] + +#### Returns + +`void` + +#### Deprecated + +Use [Cognite3DViewer.setGlobalClippingPlanes](Cognite3DViewer.md#setglobalclippingplanes) instead. + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1193](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1193) + +*** + +### setGlobalClippingPlanes() + +> **setGlobalClippingPlanes**(`clippingPlanes`): `void` + +Sets per-pixel clipping planes. Pixels behind any of the planes will be sliced away. + +#### Parameters + +• **clippingPlanes**: `Plane`[] + +The planes to use for clipping. + +#### Returns + +`void` + +#### Example + +```js +// Hide pixels with values less than 0 in the x direction +const plane = new THREE.Plane(new THREE.Vector3(1, 0, 0), 0); +viewer.setGlobalClippingPlanes([plane]); +``` +```js +// Hide pixels with values greater than 20 in the x direction + const plane = new THREE.Plane(new THREE.Vector3(-1, 0, 0), 20); +viewer.setGlobalClippingPlanes([plane]); +``` +```js +// Hide pixels with values less than 0 in the x direction or greater than 0 in the y direction +const xPlane = new THREE.Plane(new THREE.Vector3(1, 0, 0), 0); +const yPlane = new THREE.Plane(new THREE.Vector3(0, -1, 0), 0); +viewer.setGlobalClippingPlanes([xPlane, yPlane]); +``` +```js +// Hide pixels behind an arbitrary, non axis-aligned plane + const plane = new THREE.Plane(new THREE.Vector3(1.5, 20, -19), 20); +viewer.setGlobalClippingPlanes([plane]); +``` +```js +// Disable clipping planes + viewer.setGlobalClippingPlanes([]); +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1183](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1183) + +*** + +### setLogLevel() + +> **setLogLevel**(`level`): `void` + +Sets the log level. Used for debugging. +Defaults to 'none' (which is identical to 'silent'). + +#### Parameters + +• **level**: `"error"` \| `"none"` \| `"debug"` \| `"trace"` \| `"info"` \| `"warn"` \| `"silent"` + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:429](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L429) + +*** + +### setResolutionOptions() + +> **setResolutionOptions**(`options`): `void` + +Set options to control resolution of the viewer. This includes +settings for max resolution and limiting resolution when moving the camera. + +#### Parameters + +• **options**: [`ResolutionOptions`](../type-aliases/ResolutionOptions.md) + +Options to apply. + +#### Returns + +`void` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:407](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L407) + +*** + +### setViewState() + +> **setViewState**(`state`): `Promise`\<`void`\> + +Restores camera settings from the state provided, and clears all current styled +node collections and applies the `state` object. + +#### Parameters + +• **state**: [`ViewerState`](../type-aliases/ViewerState.md) + +Viewer state retrieved from [Cognite3DViewer.getViewState](Cognite3DViewer.md#getviewstate). + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:691](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L691) + +*** + +### worldToScreen() + +> **worldToScreen**(`point`, `normalize`?): `null` \| `Vector2` + +Convert a point in world space to its coordinates in the canvas. This can be used to place HTML objects near 3D objects on top of the 3D viewer. + +#### Parameters + +• **point**: `Vector3` + +World space coordinate. + +• **normalize?**: `boolean` + +Optional. If true, coordinates are normalized into [0,1]. If false, the values are in the range [0, \). + +#### Returns + +`null` \| `Vector2` + +Returns 2D coordinates if the point is visible on screen, or `null` if object is outside screen. + +#### See + +[https://www.w3schools.com/graphics/canvas_coordinates.asp](https://www.w3schools.com/graphics/canvas_coordinates.asp) For details on HTML Canvas Coordinates. + +#### Example + +```js +const boundingBoxCenter = new THREE.Vector3(); +// Find center of bounding box in world space +model.getBoundingBox(nodeId).getCenter(boundingBoxCenter); +// Screen coordinates of that point +const screenCoordinates = viewer.worldToScreen(boundingBoxCenter); +``` +```js +const boundingBoxCenter = new THREE.Vector3(); +// Find center of bounding box in world space +model.getBoundingBox(nodeId).getCenter(boundingBoxCenter); +// Screen coordinates of that point normalized in the range [0,1] +const screenCoordinates = viewer.worldToScreen(boundingBoxCenter, true); +``` +```js +const boundingBoxCenter = new THREE.Vector3(); +// Find center of bounding box in world space +model.getBoundingBox(nodeId).getCenter(boundingBoxCenter); +// Screen coordinates of that point +const screenCoordinates = viewer.worldToScreen(boundingBoxCenter); +if (screenCoordinates == null) { + // Object not visible on screen +} else { + // Object is visible on screen +} +``` + +#### Defined in + +[packages/api/src/public/migration/Cognite3DViewer.ts:1348](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1348) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CogniteCadModel.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CogniteCadModel.md new file mode 100644 index 00000000000..502de97a507 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CogniteCadModel.md @@ -0,0 +1,990 @@ +# Class: CogniteCadModel + +Provides metadata needed to get asset mappings for a CDF 3D model + +## Implements + +- [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +## Properties + +### modelId + +> `readonly` **modelId**: `number` + +The CDF model ID of the model. + +#### Implementation of + +[`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) . [`modelId`](../interfaces/CdfModelNodeCollectionDataProvider.md#modelid) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:77](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L77) + +*** + +### revisionId + +> `readonly` **revisionId**: `number` + +The CDF revision ID of the model. + +#### Implementation of + +[`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) . [`revisionId`](../interfaces/CdfModelNodeCollectionDataProvider.md#revisionid) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L81) + +*** + +### type + +> `readonly` **type**: [`SupportedModelTypes`](../type-aliases/SupportedModelTypes.md) = `'cad'` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L28) + +## Accessors + +### modelUnit + +> `get` **modelUnit**(): `""` \| [`WellKnownUnit`](../type-aliases/WellKnownUnit.md) + +Returns the unit the coordinates for the model is stored. Returns an empty string +if no unit has been stored. +Note that coordinates in Reveal always are converted to meters using [CogniteCadModel.modelUnitToMetersFactor](CogniteCadModel.md#modelunittometersfactor). + +#### Returns + +`""` \| [`WellKnownUnit`](../type-aliases/WellKnownUnit.md) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:42](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L42) + +*** + +### modelUnitToMetersFactor + +> `get` **modelUnitToMetersFactor**(): `undefined` \| `number` + +Returns the conversion factor that converts from model coordinates to meters. Note that this can +return undefined if the model has been stored in an unsupported unit. + +#### Returns + +`undefined` \| `number` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:52](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L52) + +*** + +### nodeCount + +> `get` **nodeCount**(): `number` + +Returns the number of nodes in the model. + +#### Returns + +`number` + +#### Implementation of + +[`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) . [`nodeCount`](../interfaces/CdfModelNodeCollectionDataProvider.md#nodecount) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:541](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L541) + +*** + +### styledNodeCollections + +> `get` **styledNodeCollections**(): `object`[] + +Returns all currently registered node collections and associated appearance. + +#### Returns + +`object`[] + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:144](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L144) + +*** + +### visible + +> `get` **visible**(): `boolean` + +Returns the model visibility. + +> `set` **visible**(`value`): `void` + +Sets the model visibility. + +#### Example + +```js +model.visible = false +``` + +#### Parameters + +• **value**: `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:70](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L70) + +## Methods + +### assignStyledNodeCollection() + +> **assignStyledNodeCollection**(`nodeCollection`, `appearance`, `importance`): `void` + +Customizes rendering style for a set of nodes, e.g. to highlight, hide +or color code a set of 3D objects. This allows for custom look and feel +of the 3D model which is useful to highlight certain parts or to +color code the 3D model based on information (e.g. coloring the 3D model +by construction status). + +The [NodeCollection](NodeCollection.md) can be updated dynamically and the rendered nodes will be +updated automatically as the styling changes. The appearance of the style nodes +cannot be changed. + +When nodes are in several styled sets, the style is combined in the order +the sets were added, i.e. styled sets added late can overwrite styled sets added +early. + +If the `nodeCollection` provided already has an assigned style, this style will +be replaced with style provided. + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +Dynamic set of nodes to apply the provided appearance to. + +• **appearance**: [`NodeAppearance`](../type-aliases/NodeAppearance.md) + +Appearance to style the provided set with. + +• **importance**: `number` = `0` + +The importance of this style. Can be used to manually order the order of styles, this can avoid the order of adding styles affecting the outcome. Optional and defaults to 0. + +#### Returns + +`void` + +#### Example + +```js +model.setDefaultNodeAppearance({ rendererGhosted: true }); +const visibleNodes = new TreeIndexNodeCollection(someTreeIndices); +model.assignStyledNodeCollection(visibleSet, { rendererGhosted: false }); +``` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:176](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L176) + +*** + +### dispose() + +> **dispose**(): `void` + +Cleans up used resources. + +#### Returns + +`void` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:317](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L317) + +*** + +### getAncestorTreeIndices() + +> **getAncestorTreeIndices**(`treeIndex`, `generation`): `Promise` \<[`NumericRange`](NumericRange.md)\> + +Determines the tree index range of a subtree of an ancestor of the provided +node defined by a tree index. + +#### Parameters + +• **treeIndex**: `number` + +Tree index of node to find ancestor tree index range for. + +• **generation**: `number` + +What "generation" to find. 0 is the node itself, +1 means parent, 2 means grandparent etc. If the node doesn't have as many +ancestors, the root of the model is returned. This can be determined by checking +that the range returned includes 0. + +#### Returns + +`Promise` \<[`NumericRange`](NumericRange.md)\> + +Tree index range of the subtree spanned by the ancestor at the +"generation" specified, or the root. + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:341](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L341) + +*** + +### getBoundingBoxByNodeId() + +> **getBoundingBoxByNodeId**(`nodeId`, `box`?): `Promise`\<`Box3`\> + +Fetches a bounding box from the CDF by the nodeId. + +#### Parameters + +• **nodeId**: `number` + +• **box?**: `Box3` + +Optional. Used to write result to. + +#### Returns + +`Promise`\<`Box3`\> + +#### Example + +```js +const box = new THREE.Box3() +const nodeId = 100500; +await model.getBoundingBoxByNodeId(nodeId, box); +// box now has the bounding box +``` +```js +// the following code does the same +const box = await model.getBoundingBoxByNodeId(nodeId); +``` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:471](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L471) + +*** + +### getBoundingBoxByTreeIndex() + +> **getBoundingBoxByTreeIndex**(`treeIndex`, `box`?): `Promise`\<`Box3`\> + +Determine the bounding box of the node identified by the tree index provided. Note that this +function uses the CDF API to look up the bounding box. + +#### Parameters + +• **treeIndex**: `number` + +Tree index of the node to find bounding box for. + +• **box?**: `Box3` + +Optional preallocated container to hold the bounding box. + +#### Returns + +`Promise`\<`Box3`\> + +#### Example + +```js +const box = new THREE.Box3() +const treeIndex = 42; +await model.getBoundingBoxByTreeIndex(treeIndex, box); +// box now has the bounding box +``` +```js +// the following code does the same +const box = await model.getBoundingBoxByTreeIndex(treeIndex); +``` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:517](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L517) + +*** + +### getBoundingBoxesByNodeIds() + +> **getBoundingBoxesByNodeIds**(`nodeIds`): `Promise`\<`Box3`[]\> + +Fetches a bounding box from the CDF by a list of nodeIds. + +#### Parameters + +• **nodeIds**: `number`[] + +#### Returns + +`Promise`\<`Box3`[]\> + +#### Example + +```js +const box = await model.getBoundingBoxByNodeIds([158239, 192837]); +``` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:486](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L486) + +*** + +### getCameraConfiguration() + +> **getCameraConfiguration**(): `undefined` \| [`CameraConfiguration`](../type-aliases/CameraConfiguration.md) + +Retrieves the camera position and target stored for the model. Typically this +is used to store a good starting position for a model. Returns `undefined` if there +isn't any stored camera configuration for the model. + +#### Returns + +`undefined` \| [`CameraConfiguration`](../type-aliases/CameraConfiguration.md) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:388](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L388) + +*** + +### getCdfToDefaultModelTransformation() + +> **getCdfToDefaultModelTransformation**(`out`?): `Matrix4` + +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 [CogniteCadModel.setModelTransformation](CogniteCadModel.md#setmodeltransformation) + +#### Parameters + +• **out?**: `Matrix4` + +Preallocated `THREE.Matrix4` (optional) + +#### Returns + +`Matrix4` + +#### Implementation of + +[`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) . [`getCdfToDefaultModelTransformation`](../interfaces/CdfModelNodeCollectionDataProvider.md#getcdftodefaultmodeltransformation) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:431](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L431) + +*** + +### getDefaultNodeAppearance() + +> **getDefaultNodeAppearance**(): [`NodeAppearance`](../type-aliases/NodeAppearance.md) + +Gets the default appearance for nodes that are not styled using +[CogniteCadModel.assignStyledNodeCollection](CogniteCadModel.md#assignstylednodecollection). + +#### Returns + +[`NodeAppearance`](../type-aliases/NodeAppearance.md) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:137](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L137) + +*** + +### getModelBoundingBox() + +> **getModelBoundingBox**(`outBoundingBox`?, `restrictToMostGeometry`?): `Box3` + +Determines the full bounding box of the model. + +#### Parameters + +• **outBoundingBox?**: `Box3` + +Optional. Used to write result to. + +• **restrictToMostGeometry?**: `boolean` + +Optional. When true, returned bounds are restricted to +where most of the geometry is located. This is useful for models that have junk geometry +located far from the "main" model. Added in version 1.3.0. + +#### Returns + +`Box3` + +Model bounding box. + +#### Example + +```js +const boundingBox = new THREE.Box3() +model.getModelBoundingBox(boundingBox); +// boundingBox now has the bounding box +``` +```js +// the following code does the same +const boundingBox = model.getModelBoundingBox(); +``` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:372](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L372) + +*** + +### getModelClippingPlanes() + +> **getModelClippingPlanes**(): `Plane`[] + +Get the clipping planes for this model. + +#### Returns + +`Plane`[] + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:421](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L421) + +*** + +### getModelTransformation() + +> **getModelTransformation**(`out`?): `Matrix4` + +Gets transformation matrix that has previously been set with [CogniteCadModel.setModelTransformation](CogniteCadModel.md#setmodeltransformation). + +#### Parameters + +• **out?**: `Matrix4` + +Preallocated `THREE.Matrix4` (optional). + +#### Returns + +`Matrix4` + +#### Implementation of + +[`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) . [`getModelTransformation`](../interfaces/CdfModelNodeCollectionDataProvider.md#getmodeltransformation) + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:406](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L406) + +*** + +### getSubtreeTreeIndices() + +> **getSubtreeTreeIndices**(`treeIndex`): `Promise` \<[`NumericRange`](NumericRange.md)\> + +Determines the range of tree indices for a given subtree. + +#### Parameters + +• **treeIndex**: `number` + +Index of the root of the subtree to get the index range for. + +#### Returns + +`Promise` \<[`NumericRange`](NumericRange.md)\> + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:325](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L325) + +*** + +### iterateNodesByTreeIndex() + +> **iterateNodesByTreeIndex**(`action`): `Promise`\<`void`\> + +Iterates over all nodes in the model and applies the provided action to each node (identified by tree index). +The passed action is applied incrementally to avoid main thread blocking, meaning that the changes can be partially +applied until promise is resolved (iteration is done). + +#### Parameters + +• **action** + +Function that will be called with a treeIndex argument. + +#### Returns + +`Promise`\<`void`\> + +Promise that is resolved once the iteration is done. + +#### Example + +```js +const logIndex = (treeIndex) => console.log(treeIndex); +await model.iterateNodesByTreeIndex(logIndex); // 0, 1, 2, ... +``` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:534](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L534) + +*** + +### iterateSubtreeByTreeIndex() + +> **iterateSubtreeByTreeIndex**(`treeIndex`, `action`): `Promise`\<`void`\> + +Iterates over all nodes in a subtree of the model and applies the provided action to each node +(identified by tree index). The provided node is included in the visited set. The passed action +is applied incrementally to avoid main thread blocking, meaning that the changes can be partially +applied until promise is resolved (iteration is done). + +#### Parameters + +• **treeIndex**: `number` + +Tree index of the top parent of the subtree. + +• **action** + +Function that will be called with a treeIndex argument. + +#### Returns + +`Promise`\<`void`\> + +Promise that is resolved once the iteration is done. + +#### Example + +```js +// make a subtree to be gray +await model.iterateNodesByTreeIndex(treeIndex => { + model.setNodeColorByTreeIndex(treeIndex, 127, 127, 127); +}); +``` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:561](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L561) + +*** + +### mapBoxFromCdfToModelCoordinates() + +> **mapBoxFromCdfToModelCoordinates**(`box`, `out`): `Box3` + +Map bounding box from CDF to model space, taking the model's custom transformation into account + +#### Parameters + +• **box**: `Box3` + +Box to compute transformation from + +• **out**: `Box3` = `...` + +Optional pre-allocated box + +#### Returns + +`Box3` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:450](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L450) + +*** + +### mapNodeIdToTreeIndex() + +> **mapNodeIdToTreeIndex**(`nodeId`): `Promise`\<`number`\> + +Maps a single node ID to tree index. This is useful when you e.g. have a +node ID from an asset mapping and want to highlight the given asset using +[CogniteCadModel.mapNodeIdsToTreeIndices](CogniteCadModel.md#mapnodeidstotreeindices) is recommended for better performance when +mapping multiple IDs. + +#### Parameters + +• **nodeId**: `number` + +A Node ID to map to a tree index. + +#### Returns + +`Promise`\<`number`\> + +TreeIndex of the provided node. + +#### Throws + +If an invalid/non-existant node ID is provided the function throws an error. + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:589](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L589) + +*** + +### mapNodeIdsToTreeIndices() + +> **mapNodeIdsToTreeIndices**(`nodeIds`): `Promise`\<`number`[]\> + +Maps a list of Node IDs to tree indices. This function is useful when you have +a list of nodes, e.g. from Asset Mappings, that you want to highlight, hide, +color etc in the viewer. + +#### Parameters + +• **nodeIds**: `number`[] + +List of node IDs to map to tree indices. + +#### Returns + +`Promise`\<`number`[]\> + +A list of tree indices corresponing to the elements in the input. + +#### Throws + +If an invalid/non-existant node ID is provided the function throws an error. + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:575](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L575) + +*** + +### mapPointFromCdfToModelCoordinates() + +> **mapPointFromCdfToModelCoordinates**(`point`, `out`): `Vector3` + +Map point from CDF to model space, taking the model's custom transformation into account + +#### Parameters + +• **point**: `Vector3` + +Point to compute transformation from + +• **out**: `Vector3` = `...` + +Optional pre-allocated point + +#### Returns + +`Vector3` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:440](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L440) + +*** + +### mapTreeIndexToNodeId() + +> **mapTreeIndexToNodeId**(`treeIndex`): `Promise`\<`number`\> + +Maps a single tree index to node ID for use with the API. If you have multiple +tree indices to map, [CogniteCadModel.mapNodeIdsToTreeIndices](CogniteCadModel.md#mapnodeidstotreeindices) is recommended for better +performance. + +#### Parameters + +• **treeIndex**: `number` + +A tree index to map to a Node ID. + +#### Returns + +`Promise`\<`number`\> + +TreeIndex of the provided node. + +#### Throws + +If an invalid/non-existent node ID is provided the function throws an error. + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:615](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L615) + +*** + +### mapTreeIndicesToNodeIds() + +> **mapTreeIndicesToNodeIds**(`treeIndices`): `Promise`\<`number`[]\> + +Maps a list of tree indices to node IDs for use with the Cognite SDK. +This function is useful if you have a list of tree indices, e.g. from +[CogniteCadModel.iterateSubtreeByTreeIndex](CogniteCadModel.md#iteratesubtreebytreeindex), and want to perform +some operations on these nodes using the SDK. + +#### Parameters + +• **treeIndices**: `number`[] + +Tree indices to map to node IDs. + +#### Returns + +`Promise`\<`number`[]\> + +A list of node IDs corresponding to the elements of the input. + +#### Throws + +If an invalid tree index is provided the function throws an error. + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:603](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L603) + +*** + +### removeAllStyledNodeCollections() + +> **removeAllStyledNodeCollections**(): `void` + +Removes all styled collections, resetting the appearance of all nodes to the +default appearance. + +#### Returns + +`void` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:209](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L209) + +*** + +### resetNodeTransform() + +> **resetNodeTransform**(`treeIndices`): `void` + +Resets the transformation for the nodes given. + +#### Parameters + +• **treeIndices**: [`NumericRange`](NumericRange.md) + +Tree indices of the nodes to reset transforms for. + +#### Returns + +`void` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:295](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L295) + +*** + +### resetNodeTransformByTreeIndex() + +> **resetNodeTransformByTreeIndex**(`treeIndex`, `applyToChildren`): `Promise`\<`number`\> + +Remove override transform of the node by tree index. + +#### Parameters + +• **treeIndex**: `number` + +• **applyToChildren**: `boolean` = `true` + +#### Returns + +`Promise`\<`number`\> + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:308](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L308) + +*** + +### setDefaultNodeAppearance() + +> **setDefaultNodeAppearance**(`appearance`): `void` + +Sets the default appearance for nodes that are not styled using +[CogniteCadModel.assignStyledNodeCollection](CogniteCadModel.md#assignstylednodecollection). Updating the default style can be an +expensive operation, so use with care. + +#### Parameters + +• **appearance**: [`NodeAppearance`](../type-aliases/NodeAppearance.md) + +Default node appearance. + +#### Returns + +`void` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:129](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L129) + +*** + +### setModelClippingPlanes() + +> **setModelClippingPlanes**(`clippingPlanes`): `void` + +Sets the clipping planes for this model. They will be combined with the +global clipping planes. + +#### Parameters + +• **clippingPlanes**: `Plane`[] + +#### Returns + +`void` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:414](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L414) + +*** + +### setModelTransformation() + +> **setModelTransformation**(`matrix`): `void` + +Sets transformation matrix of the model. This overrides the current transformation. + +#### Parameters + +• **matrix**: `Matrix4` + +Transformation matrix. + +#### Returns + +`void` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:396](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L396) + +*** + +### setNodeTransform() + +> **setNodeTransform**(`treeIndices`, `transformMatrix`, `boundingBox`?, `space`?): `void` + +Apply a transformation matrix to the tree indices given, changing +rotation, scale and/or position. + +Note that setting multiple transformations for the same +node isn't supported and might lead to undefined results. + +#### Parameters + +• **treeIndices**: [`NumericRange`](NumericRange.md) + +Tree indices of nodes to apply the transformation to. + +• **transformMatrix**: `Matrix4` + +Transformation to apply. + +• **boundingBox?**: `Box3` + +Optional bounding box for the nodes before any transformation is applied. If given, it is assumed that all the nodes' geometry fit inside. + +• **space?**: `"model"` \| `"world"` = `'world'` + +Space to apply the transformation in. Defaults to 'world'. + +#### Returns + +`void` + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:225](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L225) + +*** + +### setNodeTransformByTreeIndex() + +> **setNodeTransformByTreeIndex**(`treeIndex`, `transform`, `applyToChildren`, `space`): `Promise`\<`number`\> + +Set override transform of the node by tree index. + +#### Parameters + +• **treeIndex**: `number` + +• **transform**: `Matrix4` + +• **applyToChildren**: `boolean` = `true` + +• **space**: `"model"` \| `"world"` = `'world'` + +#### Returns + +`Promise`\<`number`\> + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:279](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L279) + +*** + +### unassignStyledNodeCollection() + +> **unassignStyledNodeCollection**(`nodeCollection`): `void` + +Removes styling for previously added styled collection, resetting the style to the default (or +the style imposed by other styled collections). + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +Node collection previously added using [CogniteCadModel.assignStyledNodeCollection](CogniteCadModel.md#assignstylednodecollection). + +#### Returns + +`void` + +#### Throws + +Error if node collection isn't assigned to the model. + +#### Defined in + +[packages/cad-model/src/wrappers/CogniteCadModel.ts:195](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L195) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CognitePointCloudModel.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CognitePointCloudModel.md new file mode 100644 index 00000000000..1eb3b9732c6 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CognitePointCloudModel.md @@ -0,0 +1,703 @@ +# Class: CognitePointCloudModel + +## Properties + +### modelId + +> `readonly` **modelId**: `number` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L30) + +*** + +### revisionId + +> `readonly` **revisionId**: `number` + +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/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L34) + +*** + +### type + +> `readonly` **type**: [`SupportedModelTypes`](../type-aliases/SupportedModelTypes.md) = `'pointcloud'` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:29](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L29) + +## Accessors + +### pointColorType + +> `get` **pointColorType**(): [`PointColorType`](../enumerations/PointColorType.md) + +Determines how points currently are colored. + +> `set` **pointColorType**(`type`): `void` + +Specifies how points are colored. + +#### Default + +```ts +PointColorType.Rgb +``` + +#### Example + +```js +model.pointColorType = PointColorType.Rgb +``` + +#### Parameters + +• **type**: [`PointColorType`](../enumerations/PointColorType.md) + +#### Returns + +[`PointColorType`](../enumerations/PointColorType.md) + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:186](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L186) + +*** + +### pointShape + +> `get` **pointShape**(): [`PointShape`](../enumerations/PointShape.md) + +Sets the point shape of each rendered point in the point cloud. + +#### Default + +`PointShape.Circle` + +#### See + +[PointShape](../enumerations/PointShape.md). + +> `set` **pointShape**(`shape`): `void` + +Gets the point shape of each rendered point in the point cloud. + +#### See + +[PointShape](../enumerations/PointShape.md). + +#### Parameters + +• **shape**: [`PointShape`](../enumerations/PointShape.md) + +#### Returns + +[`PointShape`](../enumerations/PointShape.md) + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:238](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L238) + +*** + +### pointSize + +> `get` **pointSize**(): `number` + +Returns the size of each rendered point in the point cloud. + +> `set` **pointSize**(`size`): `void` + +Sets the size of each rendered point in the point cloud. + +#### Default + +`1` + +#### Parameters + +• **size**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:205](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L205) + +*** + +### pointSizeType + +> `get` **pointSizeType**(): [`PointSizeType`](../enumerations/PointSizeType.md) + +Get the point size type. + +> `set` **pointSizeType**(`type`): `void` + +Set the point size type for the point cloud. +The point size type can be either Fixed or Adaptive. + +#### Default + +`PointSizeType.Adaptive` + +#### Parameters + +• **type**: [`PointSizeType`](../enumerations/PointSizeType.md) + +#### Returns + +[`PointSizeType`](../enumerations/PointSizeType.md) + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:220](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L220) + +*** + +### stylableObjectCount + +> `get` **stylableObjectCount**(): `number` + +#### Returns + +`number` + +The number of stylable objects + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:358](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L358) + +*** + +### styledCollections + +> `get` **styledCollections**(): [`StyledPointCloudObjectCollection`](StyledPointCloudObjectCollection.md)[] + +Gets the object collections that have been assigned a style + +#### Returns + +[`StyledPointCloudObjectCollection`](StyledPointCloudObjectCollection.md)[] + +All object collections and their associated style + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:303](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L303) + +*** + +### visible + +> `get` **visible**(): `boolean` + +Returns the model visibility. + +> `set` **visible**(`value`): `void` + +Sets the model visibility. + +#### Example + +```js +model.visible = false +``` + +#### Parameters + +• **value**: `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:264](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L264) + +*** + +### visiblePointCount + +> `get` **visiblePointCount**(): `number` + +Returns the current number of visible/loaded points. + +#### Returns + +`number` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:179](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L179) + +## Methods + +### assignStyledObjectCollection() + +> **assignStyledObjectCollection**(`objectCollection`, `appearance`): `void` + +Assign a style to a collection of objects. If the object collection has been assigned +a style previously, the previous style will be replaced by the new one. + +#### Parameters + +• **objectCollection**: [`PointCloudObjectCollection`](PointCloudObjectCollection.md) + +The object collection to assign a style to + +• **appearance**: [`PointCloudAppearance`](../type-aliases/PointCloudAppearance.md) + +The style to assign to the object collection + +#### Returns + +`void` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:313](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L313) + +*** + +### dispose() + +> **dispose**(): `void` + +Used to clean up memory. + +#### Returns + +`void` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L58) + +*** + +### getCameraConfiguration() + +> **getCameraConfiguration**(): `undefined` \| [`CameraConfiguration`](../type-aliases/CameraConfiguration.md) + +Retrieves the camera position and target stored for the model. Typically this +is used to store a good starting position for a model. Returns `undefined` if there +isn't any stored camera configuration for the model. + +#### Returns + +`undefined` \| [`CameraConfiguration`](../type-aliases/CameraConfiguration.md) + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:84](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L84) + +*** + +### getCdfToDefaultModelTransformation() + +> **getCdfToDefaultModelTransformation**(`out`?): `Matrix4` + +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](CognitePointCloudModel.md#setmodeltransformation) + +#### Parameters + +• **out?**: `Matrix4` + +Preallocated `THREE.Matrix4` (optional) + +#### Returns + +`Matrix4` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:111](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L111) + +*** + +### getClasses() + +> **getClasses**(): `object`[] + +Returns a list of sorted classification names and codes present in the model. +Names will be the custom names provided by the user, or a default one if none have been provided. + +#### Returns + +`object`[] + +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/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L172) + +*** + +### getDefaultPointCloudAppearance() + +> **getDefaultPointCloudAppearance**(): [`PointCloudAppearance`](../type-aliases/PointCloudAppearance.md) + +Gets default point appearance + +#### Returns + +[`PointCloudAppearance`](../type-aliases/PointCloudAppearance.md) + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:286](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L286) + +*** + +### getModelBoundingBox() + +> **getModelBoundingBox**(`outBoundingBox`?): `Box3` + +#### Parameters + +• **outBoundingBox?**: `Box3` + +Optional. Used to write result to. + +#### Returns + +`Box3` + +Model's bounding box. + +#### Example + +```js +const boundingBox = new THREE.Box3() +model.getModelBoundingBox(boundingBox); +// boundingBox now has the bounding box +``` +```js +// the following code does the same +const boundingBox = model.getModelBoundingBox(); +``` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:75](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L75) + +*** + +### getModelClippingPlanes() + +> **getModelClippingPlanes**(): `Plane`[] + +Get the clipping planes for this model. + +#### Returns + +`Plane`[] + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:279](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L279) + +*** + +### getModelTransformation() + +> **getModelTransformation**(`out`?): `Matrix4` + +Gets transformation matrix that has previously been +set with [CognitePointCloudModel.setModelTransformation](CognitePointCloudModel.md#setmodeltransformation). + +#### Parameters + +• **out?**: `Matrix4` + +Preallocated `THREE.Matrix4` (optional). + +#### Returns + +`Matrix4` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:101](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L101) + +*** + +### hasClass() + +> **hasClass**(`pointClass`): `boolean` + +Returns true if the model has values with the given classification class. + +#### Parameters + +• **pointClass**: `number` + +ASPRS classification class code. Either one of the well known +classes from [WellKnownAsprsPointClassCodes](../enumerations/WellKnownAsprsPointClassCodes.md) or a number for user defined classes. + +#### Returns + +`boolean` + +True if model has values in the class given. + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:163](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L163) + +*** + +### isClassVisible() + +> **isClassVisible**(`pointClass`): `boolean` + +Determines if points from a given class are visible. + +#### Parameters + +• **pointClass**: `number` + +ASPRS classification class code. Either one of the well known +classes from [WellKnownAsprsPointClassCodes](../enumerations/WellKnownAsprsPointClassCodes.md) or a number for user defined classes. + +#### Returns + +`boolean` + +True if points from the given class will be visible. + +#### Throws + +Error if the model doesn't have the class given. + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:153](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L153) + +*** + +### mapBoxFromCdfToModelCoordinates() + +> **mapBoxFromCdfToModelCoordinates**(`box`, `out`): `Box3` + +Map bounding box from CDF to model space, taking the model's custom transformation into account + +#### Parameters + +• **box**: `Box3` + +Box to compute transformation from + +• **out**: `Box3` = `...` + +Optional pre-allocated box + +#### Returns + +`Box3` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:130](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L130) + +*** + +### mapPointFromCdfToModelCoordinates() + +> **mapPointFromCdfToModelCoordinates**(`point`, `out`): `Vector3` + +Map point from CDF to model space, taking the model's custom transformation into account + +#### Parameters + +• **point**: `Vector3` + +Point to compute transformation from + +• **out**: `Vector3` = `...` + +Optional pre-allocated point + +#### Returns + +`Vector3` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:120](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L120) + +*** + +### removeAllStyledObjectCollections() + +> **removeAllStyledObjectCollections**(): `void` + +Removes styling on all object collections in this model + +#### Returns + +`void` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:350](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L350) + +*** + +### setClassVisible() + +> **setClassVisible**(`pointClass`, `visible`): `void` + +Sets a visible filter on points of a given class. + +#### Parameters + +• **pointClass**: `number` + +ASPRS classification class code. Either one of the well known +classes from [WellKnownAsprsPointClassCodes](../enumerations/WellKnownAsprsPointClassCodes.md) or a number for user defined classes. + +• **visible**: `boolean` + +Boolean flag that determines if the point class type should be visible or not. + +#### Returns + +`void` + +#### Throws + +Error if the model doesn't have the class given. + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:142](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L142) + +*** + +### setDefaultPointCloudAppearance() + +> **setDefaultPointCloudAppearance**(`appearance`): `void` + +Sets default apparance for points that are not styled otherwise + +#### Parameters + +• **appearance**: [`PointCloudAppearance`](../type-aliases/PointCloudAppearance.md) + +Appearance to assign as default + +#### Returns + +`void` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:294](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L294) + +*** + +### setModelClippingPlanes() + +> **setModelClippingPlanes**(`clippingPlanes`): `void` + +Sets the clipping planes for this model. They will be combined with the +global clipping planes. + +#### Parameters + +• **clippingPlanes**: `Plane`[] + +#### Returns + +`void` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:272](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L272) + +*** + +### setModelTransformation() + +> **setModelTransformation**(`transformationMatrix`): `void` + +Sets transformation matrix of the model. This overrides the current transformation. + +#### Parameters + +• **transformationMatrix**: `Matrix4` + +The new transformation matrix + +#### Returns + +`void` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:92](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L92) + +*** + +### traverseStylableObjects() + +> **traverseStylableObjects**(`callback`): `void` + +Iterates through all stylable objects for this model + +#### Parameters + +• **callback** + +#### Returns + +`void` + +#### Example + +```js +model.traverseStylableObjects( + annotationMetadata => console.log(annotationMetadata.annotationId) +); +``` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:371](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L371) + +*** + +### unassignStyledObjectCollection() + +> **unassignStyledObjectCollection**(`objectCollection`): `void` + +Unassign style from an already styled object collection. + +#### Parameters + +• **objectCollection**: [`PointCloudObjectCollection`](PointCloudObjectCollection.md) + +The object collection from which to remove the style + +#### Returns + +`void` + +#### Defined in + +[packages/pointclouds/src/CognitePointCloudModel.ts:331](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L331) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CombineNodeCollectionBase.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CombineNodeCollectionBase.md new file mode 100644 index 00000000000..d52a6cba04e --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CombineNodeCollectionBase.md @@ -0,0 +1,238 @@ +# Class: `abstract` CombineNodeCollectionBase + +Node collection that combines the result from multiple underlying node collections. + +## Extends + +- [`NodeCollection`](NodeCollection.md) + +## Extended by + +- [`IntersectionNodeCollection`](IntersectionNodeCollection.md) +- [`UnionNodeCollection`](UnionNodeCollection.md) + +## Constructors + +### new CombineNodeCollectionBase() + +> **new CombineNodeCollectionBase**(`classToken`, `nodeCollections`?): [`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) + +#### Parameters + +• **classToken**: `string` + +• **nodeCollections?**: [`NodeCollection`](NodeCollection.md)[] + +#### Returns + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) + +#### Overrides + +`NodeCollection.constructor` + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L17) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`classToken`](NodeCollection.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +**`Override`** + +#### Returns + +`boolean` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`isLoading`](NodeCollection.md#isloading) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) + +## Methods + +### add() + +> **add**(`nodeCollection`): `void` + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) + +*** + +### clear() + +> **clear**(): `void` + +Clears all underlying node collections. + +#### Returns + +`void` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`clear`](NodeCollection.md#clear) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) + +*** + +### getAreas() + +> `abstract` **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getAreas`](NodeCollection.md#getareas) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:73](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L73) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +**`Override`** + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getIndexSet`](NodeCollection.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`off`](NodeCollection.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`on`](NodeCollection.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### remove() + +> **remove**(`nodeCollection`): `void` + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) + +*** + +### serialize() + +> `abstract` **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`serialize`](NodeCollection.md#serialize) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:71](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L71) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/ComboControls.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/ComboControls.md new file mode 100644 index 00000000000..9ef7595438d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/ComboControls.md @@ -0,0 +1,238 @@ +# Class: ComboControls + +## Extends + +- `EventDispatcher` \<[`ComboControlsEventType`](../type-aliases/ComboControlsEventType.md)\> + +## Constructors + +### new ComboControls() + +> **new ComboControls**(`camera`, `domElement`): [`ComboControls`](ComboControls.md) + +#### Parameters + +• **camera**: `PerspectiveCamera` \| `OrthographicCamera` + +• **domElement**: `HTMLElement` + +#### Returns + +[`ComboControls`](ComboControls.md) + +#### Overrides + +`EventDispatcher.constructor` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:68](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L68) + +## Properties + +### dispose() + +> **dispose**: () => `void` + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L38) + +## Accessors + +### cameraRawRotation + +> `get` **cameraRawRotation**(): `Quaternion` + +Camera rotation to be used by the camera instead of target-based rotation. +This rotation is used only when set to non-default quaternion value (not identity rotation quaternion). +Externally, value is updated by `CameraManager` when `setState` method with non-zero rotation is called. Automatically +resets to default value when `setState` method is called with no rotation value. + +#### Returns + +`Quaternion` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:130](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L130) + +*** + +### enabled + +> `get` **enabled**(): `boolean` + +Returns true if these controls are enabled. + +> `set` **enabled**(`newEnabledValue`): `void` + +Sets the enabled state of these controls. + +#### Parameters + +• **newEnabledValue**: `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:108](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L108) + +*** + +### options + +> `get` **options**(): `Readonly` \<[`ComboControlsOptions`](../type-aliases/ComboControlsOptions.md)\> + +Gets current Combo Controls options. + +> `set` **options**(`options`): `void` + +Sets Combo Controls options. + +Only the provided options will be changed, any undefined options will be kept as is. + +#### Parameters + +• **options**: `Partial` \<[`ComboControlsOptions`](../type-aliases/ComboControlsOptions.md)\> + +#### Returns + +`Readonly` \<[`ComboControlsOptions`](../type-aliases/ComboControlsOptions.md)\> + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:92](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L92) + +## Methods + +### getScrollTarget() + +> **getScrollTarget**(): `Vector3` + +#### Returns + +`Vector3` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:138](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L138) + +*** + +### getState() + +> **getState**(): `object` + +#### Returns + +`object` + +##### position + +> **position**: `Vector3` + +##### target + +> **target**: `Vector3` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:142](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L142) + +*** + +### setScrollTarget() + +> **setScrollTarget**(`target`): `void` + +#### Parameters + +• **target**: `Vector3` + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:149](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L149) + +*** + +### setState() + +> **setState**(`position`, `target`): `void` + +#### Parameters + +• **position**: `Vector3` + +• **target**: `Vector3` + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:153](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L153) + +*** + +### setViewTarget() + +> **setViewTarget**(`target`): `void` + +#### Parameters + +• **target**: `Vector3` + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:164](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L164) + +*** + +### triggerCameraChangeEvent() + +> **triggerCameraChangeEvent**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:260](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L260) + +*** + +### update() + +> **update**(`deltaTimeS`, `forceUpdate`): `boolean` + +#### Parameters + +• **deltaTimeS**: `number` + +• **forceUpdate**: `boolean` = `false` + +#### Returns + +`boolean` + +#### Defined in + +[packages/camera-manager/src/ComboControls.ts:197](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L197) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CustomObject.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CustomObject.md new file mode 100644 index 00000000000..1c6fdcd584f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CustomObject.md @@ -0,0 +1,259 @@ +# Class: CustomObject + +**`Beta`** + +This class encasulate a Object3D, and made it possible to add flags to it. +It might be extended with more flags in the future. + +## Implements + +- [`ICustomObject`](../interfaces/ICustomObject.md) + +## Constructors + +### new CustomObject() + +> **new CustomObject**(`object`): [`CustomObject`](CustomObject.md) + +**`Beta`** + +Constructor + +#### Parameters + +• **object**: `Object3D`\<`Object3DEventMap`\> + +#### Returns + +[`CustomObject`](CustomObject.md) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L26) + +## Accessors + +### isPartOfBoundingBox + +> `get` **isPartOfBoundingBox**(): `boolean` + +**`Beta`** + +Set or get whether it should be part of the combined bounding box or not. +Default is true. + +> `set` **isPartOfBoundingBox**(`value`): `void` + +**`Beta`** + +#### Parameters + +• **value**: `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`isPartOfBoundingBox`](../interfaces/ICustomObject.md#ispartofboundingbox) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:43](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L43) + +*** + +### object + +> `get` **object**(): `Object3D`\<`Object3DEventMap`\> + +**`Beta`** + +Get the Object3D + +#### Returns + +`Object3D`\<`Object3DEventMap`\> + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`object`](../interfaces/ICustomObject.md#object) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:34](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L34) + +*** + +### shouldPick + +> `get` **shouldPick**(): `boolean` + +**`Beta`** + +Set or get whether it should be picked by the camera manager +Default is false. + +> `set` **shouldPick**(`value`): `void` + +**`Beta`** + +#### Parameters + +• **value**: `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`shouldPick`](../interfaces/ICustomObject.md#shouldpick) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:56](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L56) + +*** + +### shouldPickBoundingBox + +> `get` **shouldPickBoundingBox**(): `boolean` + +**`Beta`** + +Set or get whether it should be also give the bounding box when picked by the camera +Default is false. + +> `set` **shouldPickBoundingBox**(`value`): `void` + +**`Beta`** + +#### Parameters + +• **value**: `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`shouldPickBoundingBox`](../interfaces/ICustomObject.md#shouldpickboundingbox) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L69) + +*** + +### useDepthTest + +> `get` **useDepthTest**(): `boolean` + +**`Beta`** + +Get whether it should be rendered with depth test (on top on other objects) +Default is true. + +> `set` **useDepthTest**(`value`): `void` + +**`Beta`** + +#### Parameters + +• **value**: `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`useDepthTest`](../interfaces/ICustomObject.md#usedepthtest) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:82](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L82) + +## Methods + +### beforeRender() + +> **beforeRender**(`_camera`): `void` + +**`Beta`** + +This method is called before rendering of the custom object + +#### Parameters + +• **\_camera**: `PerspectiveCamera` + +#### Returns + +`void` + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`beforeRender`](../interfaces/ICustomObject.md#beforerender) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:139](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L139) + +*** + +### getBoundingBox() + +> **getBoundingBox**(`target`): `Box3` + +**`Beta`** + +Get the bounding box from the object + +#### Parameters + +• **target**: `Box3` + +#### Returns + +`Box3` + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`getBoundingBox`](../interfaces/ICustomObject.md#getboundingbox) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:94](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L94) + +*** + +### intersectIfCloser() + +> **intersectIfCloser**(`intersectInput`, `closestDistance`): `undefined` \| [`CustomObjectIntersection`](../type-aliases/CustomObjectIntersection.md) + +**`Beta`** + +Intersect the object with the raycaster. +This function can be overridden to provide custom intersection logic. + +#### Parameters + +• **intersectInput**: [`CustomObjectIntersectInput`](CustomObjectIntersectInput.md) + +• **closestDistance**: `undefined` \| `number` + +#### Returns + +`undefined` \| [`CustomObjectIntersection`](../type-aliases/CustomObjectIntersection.md) + +#### Implementation of + +[`ICustomObject`](../interfaces/ICustomObject.md) . [`intersectIfCloser`](../interfaces/ICustomObject.md#intersectifcloser) + +#### Defined in + +[packages/utilities/src/customObject/CustomObject.ts:104](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObject.ts#L104) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CustomObjectIntersectInput.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CustomObjectIntersectInput.md new file mode 100644 index 00000000000..1ff553066cc --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/CustomObjectIntersectInput.md @@ -0,0 +1,97 @@ +# Class: CustomObjectIntersectInput + +**`Beta`** + +This class is used as input for intersecting custom objects + +## Constructors + +### new CustomObjectIntersectInput() + +> **new CustomObjectIntersectInput**(`normalizedCoords`, `camera`, `clippingPlanes`): [`CustomObjectIntersectInput`](CustomObjectIntersectInput.md) + +**`Beta`** + +#### Parameters + +• **normalizedCoords**: `Vector2` + +• **camera**: `PerspectiveCamera` + +• **clippingPlanes**: `undefined` \| `Plane`[] = `undefined` + +#### Returns + +[`CustomObjectIntersectInput`](CustomObjectIntersectInput.md) + +#### Defined in + +[packages/utilities/src/customObject/CustomObjectIntersectInput.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObjectIntersectInput.ts#L18) + +## Properties + +### camera + +> `readonly` **camera**: `PerspectiveCamera` + +**`Beta`** + +#### Defined in + +[packages/utilities/src/customObject/CustomObjectIntersectInput.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObjectIntersectInput.ts#L14) + +*** + +### clippingPlanes + +> `readonly` **clippingPlanes**: `undefined` \| `Plane`[] + +**`Beta`** + +#### Defined in + +[packages/utilities/src/customObject/CustomObjectIntersectInput.ts:15](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObjectIntersectInput.ts#L15) + +*** + +### normalizedCoords + +> `readonly` **normalizedCoords**: `Vector2` + +**`Beta`** + +#### Defined in + +[packages/utilities/src/customObject/CustomObjectIntersectInput.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObjectIntersectInput.ts#L13) + +*** + +### raycaster + +> `readonly` **raycaster**: `Raycaster` + +**`Beta`** + +#### Defined in + +[packages/utilities/src/customObject/CustomObjectIntersectInput.ts:16](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObjectIntersectInput.ts#L16) + +## Methods + +### isVisible() + +> **isVisible**(`point`): `boolean` + +**`Beta`** + +#### Parameters + +• **point**: `Vector3` + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/customObject/CustomObjectIntersectInput.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObjectIntersectInput.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/DebouncedCameraStopEventTrigger.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/DebouncedCameraStopEventTrigger.md new file mode 100644 index 00000000000..726938ab586 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/DebouncedCameraStopEventTrigger.md @@ -0,0 +1,80 @@ +# Class: DebouncedCameraStopEventTrigger + +Simple helper class to trigger a stop event whenever a camera manager's +camera hasn't changed for a little while. + +## Constructors + +### new DebouncedCameraStopEventTrigger() + +> **new DebouncedCameraStopEventTrigger**(`cameraManager`, `debounceTimeMs`): [`DebouncedCameraStopEventTrigger`](DebouncedCameraStopEventTrigger.md) + +#### Parameters + +• **cameraManager**: [`CameraManager`](../interfaces/CameraManager.md) + +• **debounceTimeMs**: `number` = `100` + +#### Returns + +[`DebouncedCameraStopEventTrigger`](DebouncedCameraStopEventTrigger.md) + +#### Defined in + +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L21) + +## Methods + +### dispose() + +> **dispose**(): `void` + +Deallocate resources associated with this object + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:45](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L45) + +*** + +### subscribe() + +> **subscribe**(`callback`): `void` + +Subscribe to the stop events generated by this trigger + +#### Parameters + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:31](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L31) + +*** + +### unsubscribe() + +> **unsubscribe**(`callback`): `void` + +Unsubscribe from the stop events + +#### Parameters + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L38) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/DefaultCameraManager.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/DefaultCameraManager.md new file mode 100644 index 00000000000..5d6447b16c5 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/DefaultCameraManager.md @@ -0,0 +1,423 @@ +# Class: DefaultCameraManager + +Default implementation of [CameraManager](../interfaces/CameraManager.md). Uses target-based orbit controls combined with +keyboard and mouse navigation possibility. Supports automatic update of camera near and far +planes and animated change of camera position and target. + +## Implements + +- [`CameraManager`](../interfaces/CameraManager.md) + +## Properties + +### automaticControlsSensitivity + +> **automaticControlsSensitivity**: `boolean` = `true` + +When false, the sensitivity of the camera controls will not be updated automatically. +This can be useful to better control the sensitivity of the 3D navigation. + +When not set, control the sensitivity of the camera using `viewer.cameraManager.cameraControls.minDistance` +and `viewer.cameraManager.cameraControls.maxDistance`. + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:108](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L108) + +*** + +### automaticNearFarPlane + +> **automaticNearFarPlane**: `boolean` = `true` + +When false, camera near and far planes will not be updated automatically (defaults to true). +This can be useful when you have custom content in the 3D view and need to better +control the view frustum. + +When automatic camera near/far planes are disabled, you are responsible for setting +this on your own. + +#### Example + +``` +viewer.camera.near = 0.1; +viewer.camera.far = 1000.0; +viewer.camera.updateProjectionMatrix(); +``` + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:100](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L100) + +## Accessors + +### keyboardNavigationEnabled + +> `get` **keyboardNavigationEnabled**(): `boolean` + +Whether keyboard control of the camera is enabled/disabled. + +> `set` **keyboardNavigationEnabled**(`enabled`): `void` + +Sets whether keyboard control of the camera is enabled/disabled. + +#### Parameters + +• **enabled**: `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:194](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L194) + +## Methods + +### activate() + +> **activate**(`cameraManager`?): `void` + +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 viewer. + +#### Parameters + +• **cameraManager?**: [`CameraManager`](../interfaces/CameraManager.md) + +Previously used camera manager. + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`activate`](../interfaces/CameraManager.md#activate) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:237](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L237) + +*** + +### deactivate() + +> **deactivate**(): `void` + +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 viewer. + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`deactivate`](../interfaces/CameraManager.md#deactivate) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:251](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L251) + +*** + +### dispose() + +> **dispose**(): `void` + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`dispose`](../interfaces/CameraManager.md#dispose) + +#### Obvious + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:289](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L289) + +*** + +### fitCameraToBoundingBox() + +> **fitCameraToBoundingBox**(`box`, `duration`?, `radiusFactor`?): `void` + +Moves camera to a place where the content of a bounding box is visible to the camera. + +#### Parameters + +• **box**: `Box3` + +The bounding box in world space. + +• **duration?**: `number` + +The duration of the animation moving the camera. + +• **radiusFactor?**: `number` = `2` + +The ratio of the distance from camera to center of box and radius of the box. + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`fitCameraToBoundingBox`](../interfaces/CameraManager.md#fitcameratoboundingbox) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:164](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L164) + +*** + +### getCamera() + +> **getCamera**(): `PerspectiveCamera` + +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. + +#### Returns + +`PerspectiveCamera` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`getCamera`](../interfaces/CameraManager.md#getcamera) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:198](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L198) + +*** + +### getCameraControlsOptions() + +> **getCameraControlsOptions**(): [`CameraControlsOptions`](../type-aliases/CameraControlsOptions.md) + +Gets current camera controls options. + +#### Returns + +[`CameraControlsOptions`](../type-aliases/CameraControlsOptions.md) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:262](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L262) + +*** + +### getCameraState() + +> **getCameraState**(): `Required` \<[`CameraState`](../type-aliases/CameraState.md)\> + +Get camera's state + +#### Returns + +`Required` \<[`CameraState`](../type-aliases/CameraState.md)\> + +Camera state: position, target and rotation. + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`getCameraState`](../interfaces/CameraManager.md#getcamerastate) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:229](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L229) + +*** + +### getComboControlsOptions() + +> **getComboControlsOptions**(): `Readonly` \<[`ComboControlsOptions`](../type-aliases/ComboControlsOptions.md)\> + +Gets current Combo Controls options. + +#### Returns + +`Readonly` \<[`ComboControlsOptions`](../type-aliases/ComboControlsOptions.md)\> + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:172](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L172) + +*** + +### off() + +> **off**(`event`, `callback`): `void` + +Unsubscribes from changes of the camera event. + +#### Parameters + +• **event**: `"cameraChange"` \| `"cameraStop"` + +The event type. + +• **callback**: [`CameraEventDelegate`](../type-aliases/CameraEventDelegate.md) + +Callback function to be unsubscribed. + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`off`](../interfaces/CameraManager.md#off) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:151](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L151) + +*** + +### on() + +> **on**(`event`, `callback`): `void` + +Subscribes to events on this camera manager. There are several event types: +'cameraChange' - Subscribes to changes of the camera. This is used by Reveal to react on changes of the camera. +'cameraStop' - Subscribes to events indicating the camera has stopped + +#### Parameters + +• **event**: `"cameraChange"` \| `"cameraStop"` + +The event type. + +• **callback**: [`CameraEventDelegate`](../type-aliases/CameraEventDelegate.md) + +Callback to be called when the event is fired. + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`on`](../interfaces/CameraManager.md#on) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:138](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L138) + +*** + +### setCameraControlsOptions() + +> **setCameraControlsOptions**(`controlsOptions`): `void` + +Sets camera controls options to customize camera controls modes. See [CameraControlsOptions](../type-aliases/CameraControlsOptions.md). + +#### Parameters + +• **controlsOptions**: [`CameraControlsOptions`](../type-aliases/CameraControlsOptions.md) + +JSON object with camera controls options. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:270](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L270) + +*** + +### setCameraState() + +> **setCameraState**(`state`): `void` + +Sets camera state. All parameters are optional. Rotation and target can't be set at the same time, +if so, error will be thrown. Set rotation is preserved until next call of setCameraState with +empty rotation field. + +#### Parameters + +• **state**: [`CameraState`](../type-aliases/CameraState.md) + +Camera state. +* + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`setCameraState`](../interfaces/CameraManager.md#setcamerastate) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:208](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L208) + +*** + +### setComboControlsOptions() + +> **setComboControlsOptions**(`options`): `void` + +Sets Combo Controls options. +Only provided options will be changed, any undefined options will be kept as is. + +#### Parameters + +• **options**: `Partial` \<[`ComboControlsOptions`](../type-aliases/ComboControlsOptions.md)\> + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:180](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L180) + +*** + +### update() + +> **update**(`deltaTime`, `boundingBox`): `void` + +Updates internal state of camera manager. Expected to update visual state of the camera +as well as it's near and far planes if needed. Called in `requestAnimationFrame`-loop. +Reveal performance affects frequency with which this method is called. + +#### Parameters + +• **deltaTime**: `number` + +Delta time since last update in seconds. + +• **boundingBox**: `Box3` + +Global bounding box of the model(s) and any custom objects added to the scene. + +#### Returns + +`void` + +#### Implementation of + +[`CameraManager`](../interfaces/CameraManager.md) . [`update`](../interfaces/CameraManager.md#update) + +#### Defined in + +[packages/camera-manager/src/DefaultCameraManager.ts:280](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L280) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/FlexibleControlsOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/FlexibleControlsOptions.md new file mode 100644 index 00000000000..616c2f72466 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/FlexibleControlsOptions.md @@ -0,0 +1,711 @@ +# Class: FlexibleControlsOptions + +**`Beta`** + +## Constructors + +### new FlexibleControlsOptions() + +> **new FlexibleControlsOptions**(): [`FlexibleControlsOptions`](FlexibleControlsOptions.md) + +**`Beta`** + +#### Returns + +[`FlexibleControlsOptions`](FlexibleControlsOptions.md) + +## Properties + +### animationDuration + +> **animationDuration**: `number` = `300` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:33](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L33) + +*** + +### automaticNearFarPlane + +> **automaticNearFarPlane**: `boolean` = `true` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:48](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L48) + +*** + +### automaticSensitivity + +> **automaticSensitivity**: `boolean` = `true` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:52](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L52) + +*** + +### controlsType + +> **controlsType**: [`FlexibleControlsType`](../enumerations/FlexibleControlsType.md) = `FlexibleControlsType.Orbit` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L23) + +*** + +### dampingFactor + +> **dampingFactor**: `number` = `0.25` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L46) + +*** + +### defaultFov + +> **defaultFov**: `number` = `60` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:89](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L89) + +*** + +### enableChangeControlsTypeOn123Key + +> **enableChangeControlsTypeOn123Key**: `boolean` = `true` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:29](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L29) + +*** + +### enableDamping + +> **enableDamping**: `boolean` = `true` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:45](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L45) + +*** + +### enableKeyboardNavigation + +> **enableKeyboardNavigation**: `boolean` = `true` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L30) + +*** + +### innerMarkerColor + +> **innerMarkerColor**: `string` = `'#FFFFFF'` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:95](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L95) + +*** + +### keyboardDollySpeed + +> **keyboardDollySpeed**: `number` = `200` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:77](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L77) + +*** + +### keyboardFastMoveFactor + +> **keyboardFastMoveFactor**: `number` = `5` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:78](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L78) + +*** + +### keyboardFastRotationFactor + +> **keyboardFastRotationFactor**: `number` = `2` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:62](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L62) + +*** + +### keyboardPanSpeed + +> **keyboardPanSpeed**: `number` = `100` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:76](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L76) + +*** + +### keyboardRotationSpeedAzimuth + +> **keyboardRotationSpeedAzimuth**: `number` = `DEFAULT_KEYBOARD_ROTATION_SPEED` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:60](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L60) + +*** + +### keyboardRotationSpeedPolar + +> **keyboardRotationSpeedPolar**: `number` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:61](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L61) + +*** + +### keyboardSpeed + +> **keyboardSpeed**: `number` = `1` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:75](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L75) + +*** + +### maxAzimuthAngle + +> **maxAzimuthAngle**: `number` = `Infinity` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:42](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L42) + +*** + +### maxOrthographicZoom + +> **maxOrthographicZoom**: `number` = `Infinity` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:67](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L67) + +*** + +### maxPolarAngle + +> **maxPolarAngle**: `number` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:40](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L40) + +*** + +### maxSensitivity + +> **maxSensitivity**: `number` = `0.8` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:55](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L55) + +*** + +### maximumFov + +> **maximumFov**: `number` = `100` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:88](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L88) + +*** + +### maximumTimeBetweenRaycasts + +> **maximumTimeBetweenRaycasts**: `number` = `1000` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:35](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L35) + +*** + +### minAzimuthAngle + +> **minAzimuthAngle**: `number` = `-Infinity` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:41](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L41) + +*** + +### minOrthographicZoom + +> **minOrthographicZoom**: `number` = `0` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:66](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L66) + +*** + +### minPolarAngle + +> **minPolarAngle**: `number` = `DEFAULT_MIN_POLAR_ANGLE` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:39](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L39) + +*** + +### minSensitivity + +> **minSensitivity**: `number` = `0.1` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:54](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L54) + +*** + +### minimumFov + +> **minimumFov**: `number` = `5` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:87](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L87) + +*** + +### minimumTimeBetweenRaycasts + +> **minimumTimeBetweenRaycasts**: `number` = `200` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:34](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L34) + +*** + +### mouseClickType + +> **mouseClickType**: [`FlexibleMouseActionType`](../enumerations/FlexibleMouseActionType.md) = `FlexibleMouseActionType.SetTarget` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L27) + +*** + +### mouseDistanceThresholdBetweenRaycasts + +> **mouseDistanceThresholdBetweenRaycasts**: `number` = `5` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:36](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L36) + +*** + +### mouseDollySpeed + +> **mouseDollySpeed**: `number` = `100` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:72](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L72) + +*** + +### mouseDoubleClickType + +> **mouseDoubleClickType**: [`FlexibleMouseActionType`](../enumerations/FlexibleMouseActionType.md) = `FlexibleMouseActionType.SetTargetAndCameraPosition` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L28) + +*** + +### mousePanSpeed + +> **mousePanSpeed**: `number` = `25` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:71](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L71) + +*** + +### mouseRotationSpeedAzimuth + +> **mouseRotationSpeedAzimuth**: `number` = `DEFAULT_POINTER_ROTATION_SPEED` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L58) + +*** + +### mouseRotationSpeedPolar + +> **mouseRotationSpeedPolar**: `number` = `DEFAULT_POINTER_ROTATION_SPEED` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:59](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L59) + +*** + +### mouseWheelAction + +> **mouseWheelAction**: [`FlexibleWheelZoomType`](../enumerations/FlexibleWheelZoomType.md) = `FlexibleWheelZoomType.Auto` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L26) + +*** + +### orthographicCameraDollyFactor + +> **orthographicCameraDollyFactor**: `number` = `0.3` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:84](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L84) + +*** + +### outerMarkerColor + +> **outerMarkerColor**: `string` = `'#FF2222'` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:94](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L94) + +*** + +### pinchEpsilon + +> **pinchEpsilon**: `number` = `0.1` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L81) + +*** + +### pinchPanSpeed + +> **pinchPanSpeed**: `number` = `50` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:82](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L82) + +*** + +### relativeMarkerSize + +> **relativeMarkerSize**: `number` = `0.018` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:93](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L93) + +*** + +### sensitivity + +> **sensitivity**: `number` = `0.4` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:51](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L51) + +*** + +### sensitivityDiagonalFraction + +> **sensitivityDiagonalFraction**: `number` = `0.001` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:53](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L53) + +*** + +### showTarget + +> **showTarget**: `boolean` = `true` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:92](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L92) + +*** + +### wheelDollySpeed + +> **wheelDollySpeed**: `number` = `0.5` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:70](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L70) + +*** + +### zoomFraction + +> **zoomFraction**: `number` = `0.05` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:65](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L65) + +## Accessors + +### realMouseWheelAction + +> `get` **realMouseWheelAction**(): [`FlexibleWheelZoomType`](../enumerations/FlexibleWheelZoomType.md) + +**`Beta`** + +#### Returns + +[`FlexibleWheelZoomType`](../enumerations/FlexibleWheelZoomType.md) + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:101](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L101) + +*** + +### shouldPick + +> `get` **shouldPick**(): `boolean` + +**`Beta`** + +#### Returns + +`boolean` + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:110](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L110) + +## Methods + +### getKeyboardSpeed() + +> **getKeyboardSpeed**(`shift`): `number` + +**`Beta`** + +#### Parameters + +• **shift**: `boolean` + +#### Returns + +`number` + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:121](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L121) + +*** + +### getLegalAzimuthAngle() + +> **getLegalAzimuthAngle**(`azimuthAngle`): `number` + +**`Beta`** + +#### Parameters + +• **azimuthAngle**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:136](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L136) + +*** + +### getLegalFov() + +> **getLegalFov**(`fov`): `number` + +**`Beta`** + +#### Parameters + +• **fov**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:132](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L132) + +*** + +### getLegalPolarAngle() + +> **getLegalPolarAngle**(`polarAngle`): `number` + +**`Beta`** + +#### Parameters + +• **polarAngle**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:140](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L140) + +*** + +### getLegalSensitivity() + +> **getLegalSensitivity**(`controlsSensitivity`): `number` + +**`Beta`** + +#### Parameters + +• **controlsSensitivity**: `number` + +#### Returns + +`number` + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts:144](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsOptions.ts#L144) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/IndexSet.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/IndexSet.md new file mode 100644 index 00000000000..195a808b3c4 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/IndexSet.md @@ -0,0 +1,331 @@ +# Class: IndexSet + +## Constructors + +### new IndexSet() + +> **new IndexSet**(`values`?): [`IndexSet`](IndexSet.md) + +#### Parameters + +• **values?**: `Iterable`\<`number`\> + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L13) + +### new IndexSet() + +> **new IndexSet**(`values`?): [`IndexSet`](IndexSet.md) + +#### Parameters + +• **values?**: [`NumericRange`](NumericRange.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L14) + +## Accessors + +### count + +> `get` **count**(): `number` + +#### Returns + +`number` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:68](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L68) + +## Methods + +### add() + +> **add**(`index`): `void` + +#### Parameters + +• **index**: `number` + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:33](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L33) + +*** + +### addRange() + +> **addRange**(`range`): `void` + +#### Parameters + +• **range**: [`NumericRange`](NumericRange.md) + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:39](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L39) + +*** + +### clear() + +> **clear**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:217](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L217) + +*** + +### clone() + +> **clone**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:221](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L221) + +*** + +### contains() + +> **contains**(`index`): `boolean` + +#### Parameters + +• **index**: `number` + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:60](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L60) + +*** + +### differenceWith() + +> **differenceWith**(`otherSet`): [`IndexSet`](IndexSet.md) + +#### Parameters + +• **otherSet**: [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:135](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L135) + +*** + +### forEachRange() + +> **forEachRange**(`visitor`): `void` + +#### Parameters + +• **visitor** + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L27) + +*** + +### hasIntersectionWith() + +> **hasIntersectionWith**(`otherSet`): `boolean` + +#### Parameters + +• **otherSet**: [`IndexSet`](IndexSet.md) \| `Set`\<`number`\> + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:145](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L145) + +*** + +### hasIntersectionWithMap() + +> **hasIntersectionWithMap**(`otherMap`): `boolean` + +#### Parameters + +• **otherMap**: `Map`\<`number`, `number`\> + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:163](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L163) + +*** + +### intersectWith() + +> **intersectWith**(`otherSet`): [`IndexSet`](IndexSet.md) + +#### Parameters + +• **otherSet**: [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:177](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L177) + +*** + +### invertedRanges() + +> **invertedRanges**(): [`NumericRange`](NumericRange.md)[] + +#### Returns + +[`NumericRange`](NumericRange.md)[] + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:105](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L105) + +*** + +### remove() + +> **remove**(`index`): `void` + +#### Parameters + +• **index**: `number` + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:47](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L47) + +*** + +### removeRange() + +> **removeRange**(`range`): `void` + +#### Parameters + +• **range**: [`NumericRange`](NumericRange.md) + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:52](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L52) + +*** + +### toIndexArray() + +> **toIndexArray**(): `number`[] + +#### Returns + +`number`[] + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:84](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L84) + +*** + +### toPlainSet() + +> **toPlainSet**(): `Set`\<`number`\> + +#### Returns + +`Set`\<`number`\> + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:98](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L98) + +*** + +### toRangeArray() + +> **toRangeArray**(): [`NumericRange`](NumericRange.md)[] + +#### Returns + +[`NumericRange`](NumericRange.md)[] + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:76](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L76) + +*** + +### unionWith() + +> **unionWith**(`otherSet`): [`IndexSet`](IndexSet.md) + +#### Parameters + +• **otherSet**: [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Defined in + +[packages/utilities/src/indexset/IndexSet.ts:123](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/indexset/IndexSet.ts#L123) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/IntersectionNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/IntersectionNodeCollection.md new file mode 100644 index 00000000000..7ef5da3487d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/IntersectionNodeCollection.md @@ -0,0 +1,267 @@ +# Class: IntersectionNodeCollection + +Node collection that is the intersection between a set of underlying node collections. + +## Extends + +- [`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) + +## Constructors + +### new IntersectionNodeCollection() + +> **new IntersectionNodeCollection**(`nodeCollections`?): [`IntersectionNodeCollection`](IntersectionNodeCollection.md) + +#### Parameters + +• **nodeCollections?**: [`NodeCollection`](NodeCollection.md)[] + +#### Returns + +[`IntersectionNodeCollection`](IntersectionNodeCollection.md) + +#### Overrides + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`constructor`](CombineNodeCollectionBase.md#constructors) + +#### Defined in + +[packages/cad-styling/src/IntersectionNodeCollection.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L22) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"IntersectionNodeCollection"` = `'IntersectionNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/IntersectionNodeCollection.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L20) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`classToken`](CombineNodeCollectionBase.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +**`Override`** + +#### Returns + +`boolean` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`isLoading`](CombineNodeCollectionBase.md#isloading) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) + +## Methods + +### add() + +> **add**(`nodeCollection`): `void` + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`add`](CombineNodeCollectionBase.md#add) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) + +*** + +### clear() + +> **clear**(): `void` + +Clears all underlying node collections. + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`clear`](CombineNodeCollectionBase.md#clear) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Overrides + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`getAreas`](CombineNodeCollectionBase.md#getareas) + +#### Defined in + +[packages/cad-styling/src/IntersectionNodeCollection.ts:52](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L52) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +**`Override`** + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`getIndexSet`](CombineNodeCollectionBase.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) + +*** + +### makeDirty() + +> **makeDirty**(): `void` + +#### Returns + +`void` + +#### Overrides + +`CombineNodeCollectionBase.makeDirty` + +#### Defined in + +[packages/cad-styling/src/IntersectionNodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L46) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`off`](CombineNodeCollectionBase.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`on`](CombineNodeCollectionBase.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### remove() + +> **remove**(`nodeCollection`): `void` + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`remove`](CombineNodeCollectionBase.md#remove) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`serialize`](CombineNodeCollectionBase.md#serialize) + +#### Defined in + +[packages/cad-styling/src/IntersectionNodeCollection.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L26) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/InvertedNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/InvertedNodeCollection.md new file mode 100644 index 00000000000..7a9c7c60cd6 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/InvertedNodeCollection.md @@ -0,0 +1,207 @@ +# Class: InvertedNodeCollection + +Node collection that inverts the result from another node collection. + +## Extends + +- [`NodeCollection`](NodeCollection.md) + +## Constructors + +### new InvertedNodeCollection() + +> **new InvertedNodeCollection**(`model`, `innerSet`): [`InvertedNodeCollection`](InvertedNodeCollection.md) + +#### Parameters + +• **model**: [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +• **innerSet**: [`NodeCollection`](NodeCollection.md) + +#### Returns + +[`InvertedNodeCollection`](InvertedNodeCollection.md) + +#### Overrides + +`NodeCollection.constructor` + +#### Defined in + +[packages/cad-styling/src/InvertedNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L21) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"InvertedNodeCollection"` = `'InvertedNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/InvertedNodeCollection.ts:15](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L15) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`classToken`](NodeCollection.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`isLoading`](NodeCollection.md#isloading) + +#### Defined in + +[packages/cad-styling/src/InvertedNodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L32) + +## Methods + +### clear() + +> **clear**(): `never` + +Not supported. + +#### Returns + +`never` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`clear`](NodeCollection.md#clear) + +#### Throws + +Always throws an error. + +#### Defined in + +[packages/cad-styling/src/InvertedNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L58) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getAreas`](NodeCollection.md#getareas) + +#### Defined in + +[packages/cad-styling/src/InvertedNodeCollection.ts:47](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L47) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getIndexSet`](NodeCollection.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/InvertedNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L36) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`off`](NodeCollection.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`on`](NodeCollection.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`serialize`](NodeCollection.md#serialize) + +#### Defined in + +[packages/cad-styling/src/InvertedNodeCollection.ts:51](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L51) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NodeCollection.md new file mode 100644 index 00000000000..ff70360cd4a --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NodeCollection.md @@ -0,0 +1,139 @@ +# Class: `abstract` NodeCollection + +Abstract class for implementing a set of nodes to be styled. + +## Extended by + +- [`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) +- [`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) +- [`TreeIndexNodeCollection`](TreeIndexNodeCollection.md) +- [`AssetNodeCollection`](AssetNodeCollection.md) +- [`InvertedNodeCollection`](InvertedNodeCollection.md) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` `abstract` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L37) + +## Methods + +### clear() + +> `abstract` **clear**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L45) + +*** + +### getAreas() + +> `abstract` **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:44](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L44) + +*** + +### getIndexSet() + +> `abstract` **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L38) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> `abstract` **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L46) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NodeIdNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NodeIdNodeCollection.md new file mode 100644 index 00000000000..c672a1f8030 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NodeIdNodeCollection.md @@ -0,0 +1,254 @@ +# Class: NodeIdNodeCollection + +Collection that holds a set of nodes including children identified by nodeIds. Note that +this involves remapping IDs to "tree indices" and subtree sized used by Reveal using +the CDF API. Its often better to use one of the other node collections or + +## See + +whenever possible for best performance. + +## Extends + +- [`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) + +## Constructors + +### new NodeIdNodeCollection() + +> **new NodeIdNodeCollection**(`client`, `model`): [`NodeIdNodeCollection`](NodeIdNodeCollection.md) + +#### Parameters + +• **client**: `CogniteClient` + +• **model**: [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +#### Returns + +[`NodeIdNodeCollection`](NodeIdNodeCollection.md) + +#### Overrides + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`constructor`](CdfNodeCollectionBase.md#constructors) + +#### Defined in + +[packages/cad-styling/src/NodeIdNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L25) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"NodeIdNodeCollection"` = `'NodeIdNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/NodeIdNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L18) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`classToken`](CdfNodeCollectionBase.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`isLoading`](CdfNodeCollectionBase.md#isloading) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) + +## Methods + +### clear() + +> **clear**(): `void` + +Clears the node collection and interrupts any ongoing operations. + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`clear`](CdfNodeCollectionBase.md#clear) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) + +*** + +### executeFilter() + +> **executeFilter**(`nodeIds`): `Promise`\<`void`\> + +Populates the collection with the nodes with the IDs provided. All children of +the nodes are also included in the collection. + +#### Parameters + +• **nodeIds**: `number`[] + +IDs of nodes to include in the collection. + +#### Returns + +`Promise`\<`void`\> + +Promise that resolves when the collection is populated. + +#### Defined in + +[packages/cad-styling/src/NodeIdNodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L37) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`getAreas`](CdfNodeCollectionBase.md#getareas) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`getIndexSet`](CdfNodeCollectionBase.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`off`](CdfNodeCollectionBase.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`on`](CdfNodeCollectionBase.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`serialize`](CdfNodeCollectionBase.md#serialize) + +#### Defined in + +[packages/cad-styling/src/NodeIdNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L58) + +*** + +### deserialize() + +> `static` **deserialize**(`descriptor`, `context`): `Promise` \<[`NodeIdNodeCollection`](NodeIdNodeCollection.md)\> + +#### Parameters + +• **descriptor**: [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +• **context**: [`NodeCollectionSerializationContext`](../type-aliases/NodeCollectionSerializationContext.md) + +#### Returns + +`Promise` \<[`NodeIdNodeCollection`](NodeIdNodeCollection.md)\> + +#### Defined in + +[packages/cad-styling/src/NodeIdNodeCollection.ts:65](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L65) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NumericRange.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NumericRange.md new file mode 100644 index 00000000000..8b9292d3314 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/NumericRange.md @@ -0,0 +1,275 @@ +# Class: NumericRange + +## Constructors + +### new NumericRange() + +> **new NumericRange**(`from`, `count`): [`NumericRange`](NumericRange.md) + +#### Parameters + +• **from**: `number` + +• **count**: `number` + +#### Returns + +[`NumericRange`](NumericRange.md) + +#### Defined in + +[packages/utilities/src/NumericRange.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L10) + +## Properties + +### count + +> `readonly` **count**: `number` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:7](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L7) + +*** + +### from + +> `readonly` **from**: `number` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:6](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L6) + +*** + +### toInclusive + +> `readonly` **toInclusive**: `number` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:8](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L8) + +## Methods + +### contains() + +> **contains**(`value`): `boolean` + +#### Parameters + +• **value**: `number` + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L38) + +*** + +### equal() + +> **equal**(`other`): `boolean` + +#### Parameters + +• **other**: [`NumericRange`](NumericRange.md) + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:34](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L34) + +*** + +### forEach() + +> **forEach**(`action`): `void` + +#### Parameters + +• **action** + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:72](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L72) + +*** + +### intersectionWith() + +> **intersectionWith**(`range`): `undefined` \| [`NumericRange`](NumericRange.md) + +#### Parameters + +• **range**: [`NumericRange`](NumericRange.md) + +#### Returns + +`undefined` \| [`NumericRange`](NumericRange.md) + +#### Defined in + +[packages/utilities/src/NumericRange.ts:50](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L50) + +*** + +### intersects() + +> **intersects**(`range`): `boolean` + +#### Parameters + +• **range**: [`NumericRange`](NumericRange.md) + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:42](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L42) + +*** + +### intersectsOrCoinciding() + +> **intersectsOrCoinciding**(`range`): `boolean` + +#### Parameters + +• **range**: [`NumericRange`](NumericRange.md) + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L46) + +*** + +### isInside() + +> **isInside**(`range`): `boolean` + +#### Parameters + +• **range**: [`NumericRange`](NumericRange.md) + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:61](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L61) + +*** + +### toArray() + +> **toArray**(): `number`[] + +#### Returns + +`number`[] + +#### Defined in + +[packages/utilities/src/NumericRange.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L30) + +*** + +### toString() + +> **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:78](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L78) + +*** + +### union() + +> **union**(`range`): [`NumericRange`](NumericRange.md) + +#### Parameters + +• **range**: [`NumericRange`](NumericRange.md) + +#### Returns + +[`NumericRange`](NumericRange.md) + +#### Defined in + +[packages/utilities/src/NumericRange.ts:65](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L65) + +*** + +### values() + +> **values**(): `Generator`\<`number`, `any`, `unknown`\> + +#### Returns + +`Generator`\<`number`, `any`, `unknown`\> + +#### Defined in + +[packages/utilities/src/NumericRange.ts:24](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L24) + +*** + +### createFromInterval() + +> `static` **createFromInterval**(`from`, `toInclusive`): [`NumericRange`](NumericRange.md) + +#### Parameters + +• **from**: `number` + +• **toInclusive**: `number` + +#### Returns + +[`NumericRange`](NumericRange.md) + +#### Defined in + +[packages/utilities/src/NumericRange.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L20) + +*** + +### isNumericRange() + +> `static` **isNumericRange**(`value`): `value is NumericRange` + +#### Parameters + +• **value**: `any` + +#### Returns + +`value is NumericRange` + +#### Defined in + +[packages/utilities/src/NumericRange.ts:82](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/NumericRange.ts#L82) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Overlay3DCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Overlay3DCollection.md new file mode 100644 index 00000000000..01ae4fa995a --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Overlay3DCollection.md @@ -0,0 +1,197 @@ +# Class: Overlay3DCollection\ + +A collection of overlay icons with associated data + +## Extends + +- `Object3D` + +## Type Parameters + +• **MetadataType** = [`DefaultOverlay3DContentType`](../type-aliases/DefaultOverlay3DContentType.md) + +## Implements + +- [`OverlayCollection`](../interfaces/OverlayCollection.md)\<`MetadataType`\> + +## Constructors + +### new Overlay3DCollection() + +> **new Overlay3DCollection**\<`MetadataType`\>(`overlayInfos`, `options`?): [`Overlay3DCollection`](Overlay3DCollection.md)\<`MetadataType`\> + +Construct a collection of 3D overlay icons + +#### Parameters + +• **overlayInfos**: [`OverlayInfo`](../type-aliases/OverlayInfo.md)\<`MetadataType`\>[] + +Initializes the collection with the list of overlays. The length +of the list will be the maximum allowed number of icons in this collection, unless it's empty, +in which case a default maximum limit will be used instead + +• **options?**: [`Overlay3DCollectionOptions`](../type-aliases/Overlay3DCollectionOptions.md) + +Additional options for this overlay collection + +#### Returns + +[`Overlay3DCollection`](Overlay3DCollection.md)\<`MetadataType`\> + +#### Overrides + +`Object3D.constructor` + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:68](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L68) + +## Methods + +### addOverlays() + +> **addOverlays**(`overlayInfos`): [`Overlay3D`](../interfaces/Overlay3D.md)\<`MetadataType`\>[] + +Add more overlays into this collection + +#### Parameters + +• **overlayInfos**: [`OverlayInfo`](../type-aliases/OverlayInfo.md)\<`MetadataType`\>[] + +#### Returns + +[`Overlay3D`](../interfaces/Overlay3D.md)\<`MetadataType`\>[] + +#### Implementation of + +[`OverlayCollection`](../interfaces/OverlayCollection.md) . [`addOverlays`](../interfaces/OverlayCollection.md#addoverlays) + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:115](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L115) + +*** + +### dispose() + +> **dispose**(): `void` + +Dispose this collection and icons with all associated resources + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:216](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L216) + +*** + +### getOverlays() + +> **getOverlays**(): [`Overlay3D`](../interfaces/Overlay3D.md)\<`MetadataType`\>[] + +Get the overlay icons contained in this collection + +#### Returns + +[`Overlay3D`](../interfaces/Overlay3D.md)\<`MetadataType`\>[] + +#### Implementation of + +[`OverlayCollection`](../interfaces/OverlayCollection.md) . [`getOverlays`](../interfaces/OverlayCollection.md#getoverlays) + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:108](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L108) + +*** + +### intersectOverlays() + +> **intersectOverlays**(`normalizedCoordinates`, `camera`): `undefined` \| [`Overlay3D`](../interfaces/Overlay3D.md)\<`MetadataType`\> + +Run intersection on icons in this collection. Returns the closest hit + +#### Parameters + +• **normalizedCoordinates**: `Vector2` + +• **camera**: `Camera` + +#### Returns + +`undefined` \| [`Overlay3D`](../interfaces/Overlay3D.md)\<`MetadataType`\> + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:166](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L166) + +*** + +### removeAllOverlays() + +> **removeAllOverlays**(): `void` + +Clean up all icons in this collection + +#### Returns + +`void` + +#### Implementation of + +[`OverlayCollection`](../interfaces/OverlayCollection.md) . [`removeAllOverlays`](../interfaces/OverlayCollection.md#removealloverlays) + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:156](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L156) + +*** + +### removeOverlays() + +> **removeOverlays**(`overlays`): `void` + +Remove the listed overlays from this collection + +#### Parameters + +• **overlays**: [`Overlay3D`](../interfaces/Overlay3D.md)\<`MetadataType`\>[] + +#### Returns + +`void` + +#### Implementation of + +[`OverlayCollection`](../interfaces/OverlayCollection.md) . [`removeOverlays`](../interfaces/OverlayCollection.md#removeoverlays) + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:146](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L146) + +*** + +### setVisibility() + +> **setVisibility**(`visibility`): `void` + +Set whether this collection is visible or not + +#### Parameters + +• **visibility**: `boolean` + +#### Returns + +`void` + +#### Implementation of + +[`OverlayCollection`](../interfaces/OverlayCollection.md) . [`setVisibility`](../interfaces/OverlayCollection.md#setvisibility) + +#### Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:101](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L101) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointCloudObjectCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointCloudObjectCollection.md new file mode 100644 index 00000000000..7846739c5ab --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointCloudObjectCollection.md @@ -0,0 +1,89 @@ +# Class: `abstract` PointCloudObjectCollection + +Base class for collections of point cloud objects intended for styling operations + +## Extended by + +- [`AnnotationIdPointCloudObjectCollection`](AnnotationIdPointCloudObjectCollection.md) + +## Constructors + +### new PointCloudObjectCollection() + +> **new PointCloudObjectCollection**(): [`PointCloudObjectCollection`](PointCloudObjectCollection.md) + +#### Returns + +[`PointCloudObjectCollection`](PointCloudObjectCollection.md) + +## Accessors + +### isLoading + +> `get` `abstract` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +whether the collection is still loading data in the background i.e. not yet ready for use + +#### Defined in + +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L23) + +## Methods + +### getAnnotationIds() + +> `abstract` **getAnnotationIds**(): `Iterable`\<`number`\> + +#### Returns + +`Iterable`\<`number`\> + +annotation IDs of the annotations for the objects represented by this PointCloudObjectCollection instance + +#### Defined in + +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L18) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Defined in + +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Defined in + +[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointerEvents.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointerEvents.md new file mode 100644 index 00000000000..6c89da20a34 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointerEvents.md @@ -0,0 +1,159 @@ +# Class: PointerEvents + +**`Beta`** + +This base should be extended for listen to various pointer events. + +## Constructors + +### new PointerEvents() + +> **new PointerEvents**(): [`PointerEvents`](PointerEvents.md) + +**`Beta`** + +#### Returns + +[`PointerEvents`](PointerEvents.md) + +## Accessors + +### isEnabled + +> `get` **isEnabled**(): `boolean` + +**`Beta`** + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/events/PointerEvents.ts:31](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEvents.ts#L31) + +## Methods + +### onClick() + +> **onClick**(`_event`): `Promise`\<`void`\> + +**`Beta`** + +#### Parameters + +• **\_event**: `PointerEvent` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/utilities/src/events/PointerEvents.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEvents.ts#L12) + +*** + +### onDoubleClick() + +> **onDoubleClick**(`_event`): `Promise`\<`void`\> + +**`Beta`** + +#### Parameters + +• **\_event**: `PointerEvent` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/utilities/src/events/PointerEvents.ts:16](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEvents.ts#L16) + +*** + +### onHover() + +> **onHover**(`_event`): `void` + +**`Beta`** + +#### Parameters + +• **\_event**: `PointerEvent` + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/events/PointerEvents.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEvents.ts#L10) + +*** + +### onPointerDown() + +> **onPointerDown**(`_event`, `_leftButton`): `Promise`\<`void`\> + +**`Beta`** + +#### Parameters + +• **\_event**: `PointerEvent` + +• **\_leftButton**: `boolean` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/utilities/src/events/PointerEvents.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEvents.ts#L20) + +*** + +### onPointerDrag() + +> **onPointerDrag**(`_event`, `_leftButton`): `Promise`\<`void`\> + +**`Beta`** + +#### Parameters + +• **\_event**: `PointerEvent` + +• **\_leftButton**: `boolean` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/utilities/src/events/PointerEvents.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEvents.ts#L27) + +*** + +### onPointerUp() + +> **onPointerUp**(`_event`, `_leftButton`): `Promise`\<`void`\> + +**`Beta`** + +#### Parameters + +• **\_event**: `PointerEvent` + +• **\_leftButton**: `boolean` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/utilities/src/events/PointerEvents.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEvents.ts#L23) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointerEventsTarget.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointerEventsTarget.md new file mode 100644 index 00000000000..397ed9d96ab --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PointerEventsTarget.md @@ -0,0 +1,64 @@ +# Class: PointerEventsTarget + +**`Beta`** + +This class fires click, double click, hover end similar events at a PointerEvents +onClick will fired if it's a single click, and the mouse hasn't move too much +If onDoubleClick is fired, the onClick will not be fired +onHover will be fired only if the mouse button is not pressed and not to often +If mouse, the onDoubleClick and onClick is fired when the left mouse button is pressed +onPointerDrag will be fired wnen the mouse button is pressed and the mouse is moving + +## Constructors + +### new PointerEventsTarget() + +> **new PointerEventsTarget**(`domElement`, `events`): [`PointerEventsTarget`](PointerEventsTarget.md) + +**`Beta`** + +#### Parameters + +• **domElement**: `HTMLElement` + +• **events**: [`PointerEvents`](PointerEvents.md) + +#### Returns + +[`PointerEventsTarget`](PointerEventsTarget.md) + +#### Defined in + +[packages/utilities/src/events/PointerEventsTarget.ts:49](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEventsTarget.ts#L49) + +## Methods + +### addEventListeners() + +> **addEventListeners**(): `void` + +**`Beta`** + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/events/PointerEventsTarget.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEventsTarget.ts#L58) + +*** + +### removeEventListeners() + +> **removeEventListeners**(): `void` + +**`Beta`** + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/events/PointerEventsTarget.ts:65](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/PointerEventsTarget.ts#L65) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PropertyFilterNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PropertyFilterNodeCollection.md new file mode 100644 index 00000000000..de893e9524a --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/PropertyFilterNodeCollection.md @@ -0,0 +1,235 @@ +# Class: PropertyFilterNodeCollection + +Represents a set of nodes that has matching node properties to a provided filter. Note that +a node is considered to match if it or a [NodeCollection](NodeCollection.md) ancestors match the filter. + +## Extends + +- [`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) + +## Constructors + +### new PropertyFilterNodeCollection() + +> **new PropertyFilterNodeCollection**(`client`, `model`, `options`): [`PropertyFilterNodeCollection`](PropertyFilterNodeCollection.md) + +#### Parameters + +• **client**: `CogniteClient` + +• **model**: [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +• **options**: [`PropertyFilterNodeCollectionOptions`](../type-aliases/PropertyFilterNodeCollectionOptions.md) = `{}` + +#### Returns + +[`PropertyFilterNodeCollection`](PropertyFilterNodeCollection.md) + +#### Overrides + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`constructor`](CdfNodeCollectionBase.md#constructors) + +#### Defined in + +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:44](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L44) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"PropertyFilterNodeCollection"` = `'PropertyFilterNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L32) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`classToken`](CdfNodeCollectionBase.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`isLoading`](CdfNodeCollectionBase.md#isloading) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) + +## Methods + +### clear() + +> **clear**(): `void` + +Clears the node collection and interrupts any ongoing operations. + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`clear`](CdfNodeCollectionBase.md#clear) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) + +*** + +### executeFilter() + +> **executeFilter**(`filter`): `Promise`\<`void`\> + +Populates the node collection with nodes matching the provided filter. This will replace +the current nodes held by the filter. + +#### Parameters + +• **filter** + +A filter for matching node properties. + +#### Returns + +`Promise`\<`void`\> + +#### Example + +``` +set.executeFilter({ 'PDMS': { 'Module': 'AQ550' }}); +``` + +#### Defined in + +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:64](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L64) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`getAreas`](CdfNodeCollectionBase.md#getareas) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`getIndexSet`](CdfNodeCollectionBase.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`off`](CdfNodeCollectionBase.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`on`](CdfNodeCollectionBase.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`serialize`](CdfNodeCollectionBase.md#serialize) + +#### Defined in + +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:83](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L83) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/SinglePropertyFilterNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/SinglePropertyFilterNodeCollection.md new file mode 100644 index 00000000000..0c6308f09a7 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/SinglePropertyFilterNodeCollection.md @@ -0,0 +1,247 @@ +# Class: SinglePropertyFilterNodeCollection + +Node collection that filters nodes based on a node property from a list of values, similarly to how +`SELECT ... IN (...)` works. This is useful when looking up nodes based on a list of identifiers, +nodes within a set of areas or systems. The node set is optimized for matching with properties with +a large number of values (i.e. thousands). + +## Extends + +- [`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) + +## Constructors + +### new SinglePropertyFilterNodeCollection() + +> **new SinglePropertyFilterNodeCollection**(`client`, `model`, `options`): [`SinglePropertyFilterNodeCollection`](SinglePropertyFilterNodeCollection.md) + +Construct a new node set. + +#### Parameters + +• **client**: `CogniteClient` + +CogniteClient authenticated to the project the model is loaded from. + +• **model**: [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +CAD model. + +• **options**: [`PropertyFilterNodeCollectionOptions`](../type-aliases/PropertyFilterNodeCollectionOptions.md) = `{}` + +#### Returns + +[`SinglePropertyFilterNodeCollection`](SinglePropertyFilterNodeCollection.md) + +#### Overrides + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`constructor`](CdfNodeCollectionBase.md#constructors) + +#### Defined in + +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:41](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L41) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"SinglePropertyNodeCollection"` = `'SinglePropertyNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:24](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L24) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`classToken`](CdfNodeCollectionBase.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`isLoading`](CdfNodeCollectionBase.md#isloading) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) + +## Methods + +### clear() + +> **clear**(): `void` + +Clears the node collection and interrupts any ongoing operations. + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`clear`](CdfNodeCollectionBase.md#clear) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) + +*** + +### executeFilter() + +> **executeFilter**(`propertyCategory`, `propertyKey`, `propertyValues`): `Promise`\<`void`\> + +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 +during construction of the node set, the total number of batches will be requestPartitions*numberOfBatches. + +#### Parameters + +• **propertyCategory**: `string` + +Node property category, e.g. `'PDMS'`. + +• **propertyKey**: `string` + +Node property key, e.g. `':FU'`. + +• **propertyValues**: `string`[] + +Lookup values, e.g. `["AR100APG539","AP500INF534","AP400INF553", ...]` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:62](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L62) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`getAreas`](CdfNodeCollectionBase.md#getareas) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`getIndexSet`](CdfNodeCollectionBase.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`off`](CdfNodeCollectionBase.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`on`](CdfNodeCollectionBase.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`CdfNodeCollectionBase`](CdfNodeCollectionBase.md) . [`serialize`](CdfNodeCollectionBase.md#serialize) + +#### Defined in + +[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:97](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L97) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/StyledPointCloudObjectCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/StyledPointCloudObjectCollection.md new file mode 100644 index 00000000000..7643af83236 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/StyledPointCloudObjectCollection.md @@ -0,0 +1,43 @@ +# Class: StyledPointCloudObjectCollection + +Represents an object collection that is associated with an appearance + +## Constructors + +### new StyledPointCloudObjectCollection() + +> **new StyledPointCloudObjectCollection**(`objectCollection`, `style`): [`StyledPointCloudObjectCollection`](StyledPointCloudObjectCollection.md) + +#### Parameters + +• **objectCollection**: [`PointCloudObjectCollection`](PointCloudObjectCollection.md) + +• **style**: `Required` \<[`PointCloudAppearance`](../type-aliases/PointCloudAppearance.md)\> + +#### Returns + +[`StyledPointCloudObjectCollection`](StyledPointCloudObjectCollection.md) + +#### Defined in + +[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) + +## Properties + +### objectCollection + +> **objectCollection**: [`PointCloudObjectCollection`](PointCloudObjectCollection.md) + +#### Defined in + +[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L13) + +*** + +### style + +> **style**: `Required` \<[`PointCloudAppearance`](../type-aliases/PointCloudAppearance.md)\> + +#### Defined in + +[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/TreeIndexNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/TreeIndexNodeCollection.md new file mode 100644 index 00000000000..b59b4bbeeba --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/TreeIndexNodeCollection.md @@ -0,0 +1,350 @@ +# Class: TreeIndexNodeCollection + +Node collection that holds a set of nodes defined by a set of tree indices. + +## Extends + +- [`NodeCollection`](NodeCollection.md) + +## Constructors + +### new TreeIndexNodeCollection() + +> **new TreeIndexNodeCollection**(`treeIndexSet`?): [`TreeIndexNodeCollection`](TreeIndexNodeCollection.md) + +#### Parameters + +• **treeIndexSet?**: [`IndexSet`](IndexSet.md) + +#### Returns + +[`TreeIndexNodeCollection`](TreeIndexNodeCollection.md) + +#### Overrides + +`NodeCollection.constructor` + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L23) + +### new TreeIndexNodeCollection() + +> **new TreeIndexNodeCollection**(`treeIndices`?): [`TreeIndexNodeCollection`](TreeIndexNodeCollection.md) + +#### Parameters + +• **treeIndices?**: `Iterable`\<`number`\> + +#### Returns + +[`TreeIndexNodeCollection`](TreeIndexNodeCollection.md) + +#### Overrides + +`NodeCollection.constructor` + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:24](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L24) + +### new TreeIndexNodeCollection() + +> **new TreeIndexNodeCollection**(`treeIndexRange`?): [`TreeIndexNodeCollection`](TreeIndexNodeCollection.md) + +#### Parameters + +• **treeIndexRange?**: [`NumericRange`](NumericRange.md) + +#### Returns + +[`TreeIndexNodeCollection`](TreeIndexNodeCollection.md) + +#### Overrides + +`NodeCollection.constructor` + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L25) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"TreeIndexNodeCollection"` = `'TreeIndexNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L18) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`classToken`](NodeCollection.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`isLoading`](NodeCollection.md#isloading) + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:110](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L110) + +## Methods + +### addAreaPoints() + +> **addAreaPoints**(`points`): `void` + +Add points to this node collection's area set. +This effectively adds boxes of size 1x1x1 meter with the points as their centers. + +#### Parameters + +• **points**: `Vector3`[] + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:96](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L96) + +*** + +### addAreas() + +> **addAreas**(`areas`): `void` + +Add areas to this node collection's area set. +Nearby areas may be clustered and merged together to keep +the number of areas in the set small. + +#### Parameters + +• **areas**: `Box3`[] + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:84](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L84) + +*** + +### clear() + +> **clear**(): `void` + +Sets this set to hold an empty set. + +#### Returns + +`void` + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`clear`](NodeCollection.md#clear) + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:56](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L56) + +*** + +### clearAreas() + +> **clearAreas**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:106](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L106) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getAreas`](NodeCollection.md#getareas) + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:65](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L65) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`getIndexSet`](NodeCollection.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:61](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L61) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`off`](NodeCollection.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`NodeCollection`](NodeCollection.md) . [`on`](NodeCollection.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`NodeCollection`](NodeCollection.md) . [`serialize`](NodeCollection.md#serialize) + +#### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:114](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L114) + +*** + +### updateSet() + +#### updateSet(treeIndices) + +> **updateSet**(`treeIndices`): `void` + +##### Parameters + +• **treeIndices**: [`IndexSet`](IndexSet.md) + +##### Returns + +`void` + +##### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L37) + +#### updateSet(treeIndices) + +> **updateSet**(`treeIndices`): `void` + +##### Parameters + +• **treeIndices**: [`NumericRange`](NumericRange.md) + +##### Returns + +`void` + +##### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L38) + +#### updateSet(treeIndices) + +> **updateSet**(`treeIndices`): `void` + +##### Parameters + +• **treeIndices**: `Iterable`\<`number`\> + +##### Returns + +`void` + +##### Defined in + +[packages/cad-styling/src/TreeIndexNodeCollection.ts:39](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L39) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/UnionNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/UnionNodeCollection.md new file mode 100644 index 00000000000..1fb9dccb275 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/UnionNodeCollection.md @@ -0,0 +1,249 @@ +# Class: UnionNodeCollection + +Node collection that takes the set union of multiple node collections. + +## Extends + +- [`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) + +## Constructors + +### new UnionNodeCollection() + +> **new UnionNodeCollection**(`nodeCollections`?): [`UnionNodeCollection`](UnionNodeCollection.md) + +#### Parameters + +• **nodeCollections?**: [`NodeCollection`](NodeCollection.md)[] + +#### Returns + +[`UnionNodeCollection`](UnionNodeCollection.md) + +#### Overrides + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`constructor`](CombineNodeCollectionBase.md#constructors) + +#### Defined in + +[packages/cad-styling/src/UnionNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L21) + +## Properties + +### classToken + +> `readonly` `static` **classToken**: `"UnionNodeCollection"` = `'UnionNodeCollection'` + +#### Defined in + +[packages/cad-styling/src/UnionNodeCollection.ts:19](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L19) + +## Accessors + +### classToken + +> `get` **classToken**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`classToken`](CombineNodeCollectionBase.md#classtoken) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L23) + +*** + +### isLoading + +> `get` **isLoading**(): `boolean` + +**`Override`** + +#### Returns + +`boolean` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`isLoading`](CombineNodeCollectionBase.md#isloading) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) + +## Methods + +### add() + +> **add**(`nodeCollection`): `void` + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`add`](CombineNodeCollectionBase.md#add) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) + +*** + +### clear() + +> **clear**(): `void` + +Clears all underlying node collections. + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`clear`](CombineNodeCollectionBase.md#clear) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) + +*** + +### getAreas() + +> **getAreas**(): [`AreaCollection`](../interfaces/AreaCollection.md) + +Returns areas surrounding the nodes in the collection. The areas +are boxes in "ThreeJS coordinates". Note that not all +implementations supports this. + +#### Returns + +[`AreaCollection`](../interfaces/AreaCollection.md) + +#### Overrides + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`getAreas`](CombineNodeCollectionBase.md#getareas) + +#### Defined in + +[packages/cad-styling/src/UnionNodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L45) + +*** + +### getIndexSet() + +> **getIndexSet**(): [`IndexSet`](IndexSet.md) + +**`Override`** + +#### Returns + +[`IndexSet`](IndexSet.md) + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`getIndexSet`](CombineNodeCollectionBase.md#getindexset) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) + +*** + +### off() + +> **off**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`off`](CombineNodeCollectionBase.md#off) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L32) + +*** + +### on() + +> **on**(`event`, `listener`): `void` + +#### Parameters + +• **event**: `"changed"` + +• **listener** + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`on`](CombineNodeCollectionBase.md#on) + +#### Defined in + +[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollection.ts#L27) + +*** + +### remove() + +> **remove**(`nodeCollection`): `void` + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](NodeCollection.md) + +#### Returns + +`void` + +#### Inherited from + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`remove`](CombineNodeCollectionBase.md#remove) + +#### Defined in + +[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) + +*** + +### serialize() + +> **serialize**(): [`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Returns + +[`SerializedNodeCollection`](../type-aliases/SerializedNodeCollection.md) + +#### Overrides + +[`CombineNodeCollectionBase`](CombineNodeCollectionBase.md) . [`serialize`](CombineNodeCollectionBase.md#serialize) + +#### Defined in + +[packages/cad-styling/src/UnionNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L25) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Vector3Pool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Vector3Pool.md new file mode 100644 index 00000000000..5b0da0eafda --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/classes/Vector3Pool.md @@ -0,0 +1,55 @@ +# Class: Vector3Pool + +**`Beta`** + +Represents a pool of Vector3 objects that can be reused. + +## Constructors + +### new Vector3Pool() + +> **new Vector3Pool**(`size`): [`Vector3Pool`](Vector3Pool.md) + +**`Beta`** + +Creates a new Vector3Pool instance. + +#### Parameters + +• **size**: `number` = `30` + +The size of the pool (default: 30) + +#### Returns + +[`Vector3Pool`](Vector3Pool.md) + +#### Defined in + +[packages/utilities/src/three/Vector3Pool.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/three/Vector3Pool.ts#L20) + +## Methods + +### getNext() + +> **getNext**(`copyFrom`?): `Vector3` + +**`Beta`** + +Gets the next available Vector3 object from the pool. + +#### Parameters + +• **copyFrom?**: `Vector3` + +An optional Vector3 object to copy the values from + +#### Returns + +`Vector3` + +The next available Vector3 object + +#### Defined in + +[packages/utilities/src/three/Vector3Pool.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/three/Vector3Pool.ts#L30) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleControlsType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleControlsType.md new file mode 100644 index 00000000000..7d76869e4d6 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleControlsType.md @@ -0,0 +1,39 @@ +# Enumeration: FlexibleControlsType + +**`Beta`** + +## Enumeration Members + +### FirstPerson + +> **FirstPerson**: `"firstPerson"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsType.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsType.ts#L10) + +*** + +### Orbit + +> **Orbit**: `"orbit"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsType.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsType.ts#L11) + +*** + +### OrbitInCenter + +> **OrbitInCenter**: `"orbitInCenter"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleControlsType.ts:9](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleControlsType.ts#L9) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleMouseActionType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleMouseActionType.md new file mode 100644 index 00000000000..754a2b18db2 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleMouseActionType.md @@ -0,0 +1,51 @@ +# Enumeration: FlexibleMouseActionType + +**`Beta`** + +## Enumeration Members + +### None + +> **None**: `"none"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts:9](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts#L9) + +*** + +### SetTarget + +> **SetTarget**: `"setTarget"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts#L10) + +*** + +### SetTargetAndCameraDirection + +> **SetTargetAndCameraDirection**: `"setTargetAndCameraDirection"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts#L11) + +*** + +### SetTargetAndCameraPosition + +> **SetTargetAndCameraPosition**: `"setTargetAndCameraPosition"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleMouseActionType.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleWheelZoomType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleWheelZoomType.md new file mode 100644 index 00000000000..b2ce5e24791 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/FlexibleWheelZoomType.md @@ -0,0 +1,63 @@ +# Enumeration: FlexibleWheelZoomType + +**`Beta`** + +Sets mouse wheel initiated action. + +Modes: + +'ToTarget' - zooms just to the current target (center of the screen) of the camera. + +'PastCursor' - zooms in the direction of the ray coming from camera through cursor screen position, allows going through objects. + +'ToCursor' - mouse wheel scroll zooms towards the point on the model where cursor is hovering over, doesn't allow going through objects. + +Default is 'zoomPastCursor'. + +## Enumeration Members + +### Auto + +> **Auto**: `"auto"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts#L25) + +*** + +### Center + +> **Center**: `"center"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts#L22) + +*** + +### PastCursor + +> **PastCursor**: `"pastCursor"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts#L23) + +*** + +### ToCursor + +> **ToCursor**: `"toCursor"` + +**`Beta`** + +#### Defined in + +[packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts:24](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/FlexibleWheelZoomType.ts#L24) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/NodeOutlineColor.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/NodeOutlineColor.md new file mode 100644 index 00000000000..e9f8ddf7a31 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/NodeOutlineColor.md @@ -0,0 +1,81 @@ +# Enumeration: NodeOutlineColor + +## Enumeration Members + +### Black + +> **Black**: `2` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L10) + +*** + +### Blue + +> **Blue**: `4` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L12) + +*** + +### Cyan + +> **Cyan**: `3` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L11) + +*** + +### Green + +> **Green**: `5` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L13) + +*** + +### NoOutline + +> **NoOutline**: `0` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:8](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L8) + +*** + +### Orange + +> **Orange**: `7` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:15](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L15) + +*** + +### Red + +> **Red**: `6` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L14) + +*** + +### White + +> **White**: `1` + +#### Defined in + +[packages/cad-styling/src/NodeAppearance.ts:9](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L9) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointColorType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointColorType.md new file mode 100644 index 00000000000..2ab95a1aca8 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointColorType.md @@ -0,0 +1,91 @@ +# Enumeration: PointColorType + +## Enumeration Members + +### Classification + +> **Classification**: `8` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L27) + +*** + +### Depth + +> **Depth**: `2` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L18) + +*** + +### Elevation + +> **Elevation**: `3` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L21) + +*** + +### Height + +> **Height**: `3` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:19](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L19) + +*** + +### Intensity + +> **Intensity**: `4` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L22) + +*** + +### LevelOfDetail + +> **LevelOfDetail**: `6` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L25) + +*** + +### Lod + +> **Lod**: `6` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L23) + +*** + +### PointIndex + +> **PointIndex**: `7` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L26) + +*** + +### Rgb + +> **Rgb**: `0` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointShape.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointShape.md new file mode 100644 index 00000000000..fa0cdc204ce --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointShape.md @@ -0,0 +1,31 @@ +# Enumeration: PointShape + +## Enumeration Members + +### Circle + +> **Circle**: `1` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L12) + +*** + +### Paraboloid + +> **Paraboloid**: `2` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L13) + +*** + +### Square + +> **Square**: `0` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointSizeType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointSizeType.md new file mode 100644 index 00000000000..79a864d293f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/PointSizeType.md @@ -0,0 +1,31 @@ +# Enumeration: PointSizeType + +## Enumeration Members + +### Adaptive + +> **Adaptive**: `2` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:7](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L7) + +*** + +### Attenuated + +> **Attenuated**: `1` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:6](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L6) + +*** + +### Fixed + +> **Fixed**: `0` + +#### Defined in + +[packages/rendering/src/pointcloud-rendering/enums.ts:5](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L5) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/WellKnownAsprsPointClassCodes.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/WellKnownAsprsPointClassCodes.md new file mode 100644 index 00000000000..4731a0bdc62 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/enumerations/WellKnownAsprsPointClassCodes.md @@ -0,0 +1,279 @@ +# Enumeration: WellKnownAsprsPointClassCodes + +ASPRS well known point class types. + +## See + +[http://www.asprs.org/wp-content/uploads/2019/03/LAS_1_4_r14.pdf](http://www.asprs.org/wp-content/uploads/2019/03/LAS_1_4_r14.pdf) (page 30) + +## Enumeration Members + +### BridgeDeck + +> **BridgeDeck**: `17` + +Note that [WellKnownAsprsPointClassCodes.ReservedOrBridgeDeck](WellKnownAsprsPointClassCodes.md#reservedorbridgedeck) has been used +historically. + +#### Defined in + +[packages/pointclouds/src/types.ts:59](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L59) + +*** + +### Building + +> **Building**: `6` + +#### Defined in + +[packages/pointclouds/src/types.ts:24](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L24) + +*** + +### Created + +> **Created**: `0` + +Created, never classified. + +#### Defined in + +[packages/pointclouds/src/types.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L18) + +*** + +### Default + +> **Default**: `-1` + +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/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L14) + +*** + +### Ground + +> **Ground**: `2` + +#### Defined in + +[packages/pointclouds/src/types.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L20) + +*** + +### HighNoise + +> **HighNoise**: `18` + +High point, or "high noise". +Note that [WellKnownAsprsPointClassCodes.ReservedOrHighPoint](WellKnownAsprsPointClassCodes.md#reservedorhighpoint) has been used +historically. + +#### Defined in + +[packages/pointclouds/src/types.ts:65](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L65) + +*** + +### HighVegetation + +> **HighVegetation**: `5` + +#### Defined in + +[packages/pointclouds/src/types.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L23) + +*** + +### IgnoredGround + +> **IgnoredGround**: `20` + +E.g. breakline proximity. + +#### Defined in + +[packages/pointclouds/src/types.ts:73](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L73) + +*** + +### LowPoint + +> **LowPoint**: `7` + +Low point, typically "low noise". + +#### Defined in + +[packages/pointclouds/src/types.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L28) + +*** + +### LowVegetation + +> **LowVegetation**: `3` + +#### Defined in + +[packages/pointclouds/src/types.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L21) + +*** + +### MedVegetation + +> **MedVegetation**: `4` + +#### Defined in + +[packages/pointclouds/src/types.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L22) + +*** + +### OverheadStructure + +> **OverheadStructure**: `19` + +E.g. conveyors, mining equipment, traffic lights. + +#### Defined in + +[packages/pointclouds/src/types.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L69) + +*** + +### Rail + +> **Rail**: `10` + +#### Defined in + +[packages/pointclouds/src/types.ts:35](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L35) + +*** + +### ReservedOrBridgeDeck + +> **ReservedOrBridgeDeck**: `12` + +In previous revisions of LAS this was "Bridge deck", but in more recent +revisions this value is reserved. + +#### Defined in + +[packages/pointclouds/src/types.ts:41](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L41) + +*** + +### ReservedOrHighPoint + +> **ReservedOrHighPoint**: `8` + +In previous revisions of LAS this was High point ("high noise"), in more recent +revisions this value is reserved. + +#### Defined in + +[packages/pointclouds/src/types.ts:33](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L33) + +*** + +### RoadSurface + +> **RoadSurface**: `11` + +#### Defined in + +[packages/pointclouds/src/types.ts:36](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L36) + +*** + +### Snow + +> **Snow**: `21` + +#### Defined in + +[packages/pointclouds/src/types.ts:74](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L74) + +*** + +### TemporalExclusion + +> **TemporalExclusion**: `22` + +Features excluded due to changes over time between data sources – e.g., water +levels, landslides, permafrost + +#### Defined in + +[packages/pointclouds/src/types.ts:79](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L79) + +*** + +### TransmissionTower + +> **TransmissionTower**: `15` + +#### Defined in + +[packages/pointclouds/src/types.ts:50](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L50) + +*** + +### Unclassified + +> **Unclassified**: `1` + +#### Defined in + +[packages/pointclouds/src/types.ts:19](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L19) + +*** + +### Water + +> **Water**: `9` + +#### Defined in + +[packages/pointclouds/src/types.ts:34](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L34) + +*** + +### WireConductor + +> **WireConductor**: `14` + +Wire conductor (phase). + +#### Defined in + +[packages/pointclouds/src/types.ts:49](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L49) + +*** + +### WireGuard + +> **WireGuard**: `13` + +Wire guard shield. + +#### Defined in + +[packages/pointclouds/src/types.ts:45](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L45) + +*** + +### WireStructureConnector + +> **WireStructureConnector**: `16` + +Wire-structure connector (e.g. insulator). + +#### Defined in + +[packages/pointclouds/src/types.ts:54](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/types.ts#L54) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/classes/CdfModelIdentifier.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/classes/CdfModelIdentifier.md new file mode 100644 index 00000000000..6343c6d10e6 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/classes/CdfModelIdentifier.md @@ -0,0 +1,78 @@ +# Class: CdfModelIdentifier + +Identifies a 3D model stored in CDF by the combination of a modelId, a revisionId +and a format. + +## Implements + +- [`ModelIdentifier`](../interfaces/ModelIdentifier.md) + +## Constructors + +### new CdfModelIdentifier() + +> **new CdfModelIdentifier**(`modelId`, `revisionId`): [`CdfModelIdentifier`](CdfModelIdentifier.md) + +#### Parameters + +• **modelId**: `number` + +• **revisionId**: `number` + +#### Returns + +[`CdfModelIdentifier`](CdfModelIdentifier.md) + +#### Defined in + +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:16](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L16) + +## Properties + +### modelId + +> `readonly` **modelId**: `number` + +#### Defined in + +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L13) + +*** + +### revealInternalId + +> `readonly` **revealInternalId**: `symbol` + +Unique ID of the model. + +#### Implementation of + +[`ModelIdentifier`](../interfaces/ModelIdentifier.md) . [`revealInternalId`](../interfaces/ModelIdentifier.md#revealinternalid) + +#### Defined in + +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L11) + +*** + +### revisionId + +> `readonly` **revisionId**: `number` + +#### Defined in + +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L14) + +## Methods + +### toString() + +> **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/model-identifiers/CdfModelIdentifier.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/enumerations/File3dFormat.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/enumerations/File3dFormat.md new file mode 100644 index 00000000000..07697616073 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/enumerations/File3dFormat.md @@ -0,0 +1,33 @@ +# Enumeration: File3dFormat + +## Enumeration Members + +### AnyFormat + +> **AnyFormat**: `"all-outputs"` + +#### Defined in + +[packages/data-providers/src/types.ts:100](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L100) + +*** + +### EptPointCloud + +> **EptPointCloud**: `"ept-pointcloud"` + +#### Defined in + +[packages/data-providers/src/types.ts:95](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L95) + +*** + +### GltfCadModel + +> **GltfCadModel**: `"gltf-directory"` + +Reveal v9 and above (GLTF based output) + +#### Defined in + +[packages/data-providers/src/types.ts:99](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L99) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/index.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/index.md new file mode 100644 index 00000000000..afc1aae804c --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/index.md @@ -0,0 +1,22 @@ +# @cognite/reveal/extensions/datasource + +## Index + +### Enumerations + +- [File3dFormat](enumerations/File3dFormat.md) + +### Classes + +- [CdfModelIdentifier](classes/CdfModelIdentifier.md) + +### Interfaces + +- [BinaryFileProvider](interfaces/BinaryFileProvider.md) +- [BlobOutputMetadata](interfaces/BlobOutputMetadata.md) +- [DataSource](interfaces/DataSource.md) +- [JsonFileProvider](interfaces/JsonFileProvider.md) +- [ModelDataProvider](interfaces/ModelDataProvider.md) +- [ModelIdentifier](interfaces/ModelIdentifier.md) +- [ModelMetadataProvider](interfaces/ModelMetadataProvider.md) +- [NodesApiClient](interfaces/NodesApiClient.md) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/BinaryFileProvider.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/BinaryFileProvider.md new file mode 100644 index 00000000000..c214f972d71 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/BinaryFileProvider.md @@ -0,0 +1,27 @@ +# Interface: BinaryFileProvider + +## Extended by + +- [`ModelDataProvider`](ModelDataProvider.md) + +## Methods + +### getBinaryFile() + +> **getBinaryFile**(`baseUrl`, `fileName`, `abortSignal`?): `Promise`\<`ArrayBuffer`\> + +#### Parameters + +• **baseUrl**: `string` + +• **fileName**: `string` + +• **abortSignal?**: `AbortSignal` + +#### Returns + +`Promise`\<`ArrayBuffer`\> + +#### Defined in + +[packages/data-providers/src/types.ts:19](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L19) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/BlobOutputMetadata.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/BlobOutputMetadata.md new file mode 100644 index 00000000000..5f0b408ff50 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/BlobOutputMetadata.md @@ -0,0 +1,31 @@ +# Interface: BlobOutputMetadata + +## Properties + +### blobId + +> **blobId**: `number` + +#### Defined in + +[packages/data-providers/src/types.ts:104](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L104) + +*** + +### format + +> **format**: `string` + +#### Defined in + +[packages/data-providers/src/types.ts:105](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L105) + +*** + +### version + +> **version**: `number` + +#### Defined in + +[packages/data-providers/src/types.ts:106](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L106) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/DataSource.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/DataSource.md new file mode 100644 index 00000000000..80fde417538 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/DataSource.md @@ -0,0 +1,54 @@ +# Interface: DataSource + +Describes how Reveal data is stored, and provides means to create custom storage providers +that Reveal will fetch data from. + +## Methods + +### getModelDataProvider() + +> **getModelDataProvider**(): [`ModelDataProvider`](ModelDataProvider.md) + +Gets a client that is able to download geometry and other files +for models. + +#### Returns + +[`ModelDataProvider`](ModelDataProvider.md) + +#### Defined in + +[packages/data-source/src/DataSource.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-source/src/DataSource.ts#L28) + +*** + +### getModelMetadataProvider() + +> **getModelMetadataProvider**(): [`ModelMetadataProvider`](ModelMetadataProvider.md) + +Gets a metadata provider for models. + +#### Returns + +[`ModelMetadataProvider`](ModelMetadataProvider.md) + +#### Defined in + +[packages/data-source/src/DataSource.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-source/src/DataSource.ts#L22) + +*** + +### getNodesApiClient() + +> **getNodesApiClient**(): [`NodesApiClient`](NodesApiClient.md) + +Gets a node API client that is able to fetch data about +models. + +#### Returns + +[`NodesApiClient`](NodesApiClient.md) + +#### Defined in + +[packages/data-source/src/DataSource.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-source/src/DataSource.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/JsonFileProvider.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/JsonFileProvider.md new file mode 100644 index 00000000000..30c957b2f12 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/JsonFileProvider.md @@ -0,0 +1,25 @@ +# Interface: JsonFileProvider + +## Extended by + +- [`ModelDataProvider`](ModelDataProvider.md) + +## Methods + +### getJsonFile() + +> **getJsonFile**(`baseUrl`, `fileName`): `Promise`\<`any`\> + +#### Parameters + +• **baseUrl**: `string` + +• **fileName**: `string` + +#### Returns + +`Promise`\<`any`\> + +#### Defined in + +[packages/data-providers/src/types.ts:15](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L15) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelDataProvider.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelDataProvider.md new file mode 100644 index 00000000000..faa3d29ce80 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelDataProvider.md @@ -0,0 +1,71 @@ +# Interface: ModelDataProvider + +Provides data for 3D models. + +## Extends + +- [`JsonFileProvider`](JsonFileProvider.md) . [`BinaryFileProvider`](BinaryFileProvider.md) + +## Methods + +### getBinaryFile() + +> **getBinaryFile**(`baseUrl`, `fileName`, `abortSignal`?): `Promise`\<`ArrayBuffer`\> + +Downloads a binary blob. + +#### Parameters + +• **baseUrl**: `string` + +Base URL of the model. + +• **fileName**: `string` + +Filename of binary file. + +• **abortSignal?**: `AbortSignal` + +Optional abort signal that can be used to cancel an in progress fetch. + +#### Returns + +`Promise`\<`ArrayBuffer`\> + +#### Overrides + +[`BinaryFileProvider`](BinaryFileProvider.md) . [`getBinaryFile`](BinaryFileProvider.md#getbinaryfile) + +#### Defined in + +[packages/data-providers/src/ModelDataProvider.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/ModelDataProvider.ts#L23) + +*** + +### getJsonFile() + +> **getJsonFile**(`baseUrl`, `fileName`): `Promise`\<`any`\> + +Download and parse a JSON file and return the resulting struct. + +#### Parameters + +• **baseUrl**: `string` + +Base URL of the model. + +• **fileName**: `string` + +Filename of JSON file. + +#### Returns + +`Promise`\<`any`\> + +#### Overrides + +[`JsonFileProvider`](JsonFileProvider.md) . [`getJsonFile`](JsonFileProvider.md#getjsonfile) + +#### Defined in + +[packages/data-providers/src/ModelDataProvider.ts:16](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/ModelDataProvider.ts#L16) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelIdentifier.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelIdentifier.md new file mode 100644 index 00000000000..c14a799f8b2 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelIdentifier.md @@ -0,0 +1,15 @@ +# Interface: ModelIdentifier + +Identifies a 3D model. Typically, implementations will use [CdfModelIdentifier](../classes/CdfModelIdentifier.md). + +## Properties + +### revealInternalId + +> `readonly` **revealInternalId**: `symbol` + +Unique ID of the model. + +#### Defined in + +[packages/data-providers/src/ModelIdentifier.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/ModelIdentifier.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelMetadataProvider.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelMetadataProvider.md new file mode 100644 index 00000000000..7ebc6d3a27a --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/ModelMetadataProvider.md @@ -0,0 +1,79 @@ +# Interface: ModelMetadataProvider + +Provides metadata for 3D models. + +## Methods + +### getModelCamera() + +> **getModelCamera**(`identifier`): `Promise`\<`undefined` \| `object`\> + +#### Parameters + +• **identifier**: [`ModelIdentifier`](ModelIdentifier.md) + +#### Returns + +`Promise`\<`undefined` \| `object`\> + +#### Defined in + +[packages/data-providers/src/ModelMetadataProvider.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L14) + +*** + +### getModelMatrix() + +> **getModelMatrix**(`identifier`, `format`): `Promise`\<`Matrix4`\> + +#### Parameters + +• **identifier**: [`ModelIdentifier`](ModelIdentifier.md) + +• **format**: `string` + +#### Returns + +`Promise`\<`Matrix4`\> + +#### Defined in + +[packages/data-providers/src/ModelMetadataProvider.ts:15](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L15) + +*** + +### getModelOutputs() + +> **getModelOutputs**(`modelIdentifier`): `Promise` \<[`BlobOutputMetadata`](BlobOutputMetadata.md)[]\> + +#### Parameters + +• **modelIdentifier**: [`ModelIdentifier`](ModelIdentifier.md) + +#### Returns + +`Promise` \<[`BlobOutputMetadata`](BlobOutputMetadata.md)[]\> + +#### Defined in + +[packages/data-providers/src/ModelMetadataProvider.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L12) + +*** + +### getModelUri() + +> **getModelUri**(`identifier`, `formatMetadata`): `Promise`\<`string`\> + +#### Parameters + +• **identifier**: [`ModelIdentifier`](ModelIdentifier.md) + +• **formatMetadata**: [`BlobOutputMetadata`](BlobOutputMetadata.md) + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[packages/data-providers/src/ModelMetadataProvider.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L13) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/NodesApiClient.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/NodesApiClient.md new file mode 100644 index 00000000000..4ada7a28f46 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/extensions/datasource/interfaces/NodesApiClient.md @@ -0,0 +1,153 @@ +# Interface: NodesApiClient + +Client for retrieving metadata information about CAD nodes. + +## Methods + +### determineNodeAncestorsByNodeId() + +> **determineNodeAncestorsByNodeId**(`modelId`, `revisionId`, `nodeId`, `generation`): `Promise`\<`object`\> + +Determine ancestor subtree span of a given node. If the node doesn't have an +ancestor at the generation given, the span of the root node is returned. + +#### Parameters + +• **modelId**: `number` + +ID of 3D model + +• **revisionId**: `number` + +ID of 3D model revision + +• **nodeId**: `number` + +Node ID of node + +• **generation**: `number` + +Generation to retrieve (0 means node itself, 1 is parent, 2 grand-parent etc). + +#### Returns + +`Promise`\<`object`\> + +##### subtreeSize + +> **subtreeSize**: `number` + +##### treeIndex + +> **treeIndex**: `number` + +#### Defined in + +[packages/nodes-api/src/NodesApiClient.ts:51](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/nodes-api/src/NodesApiClient.ts#L51) + +*** + +### determineTreeIndexAndSubtreeSizesByNodeIds() + +> **determineTreeIndexAndSubtreeSizesByNodeIds**(`modelId`, `revisionId`, `nodeIds`): `Promise`\<`object`[]\> + +Determines tree index and subtreeSize (i.e. span of the subtree a node is parent +of) given a set of node IDs. + +#### Parameters + +• **modelId**: `number` + +• **revisionId**: `number` + +• **nodeIds**: `number`[] + +#### Returns + +`Promise`\<`object`[]\> + +#### Defined in + +[packages/nodes-api/src/NodesApiClient.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/nodes-api/src/NodesApiClient.ts#L37) + +*** + +### getBoundingBoxesByNodeIds() + +> **getBoundingBoxesByNodeIds**(`modelId`, `revisionId`, `nodeIds`): `Promise`\<`Box3`[]\> + +Determines the bounds of the individual nodes provided. Note that the returned +boxes will be in "CDF coordinates" and not transformed using +the model transformation for the given model. + +#### Parameters + +• **modelId**: `number` + +ID of 3D model + +• **revisionId**: `number` + +ID of 3D model revision + +• **nodeIds**: `number`[] + +Node IDs of nodes + +#### Returns + +`Promise`\<`Box3`[]\> + +#### Defined in + +[packages/nodes-api/src/NodesApiClient.ts:67](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/nodes-api/src/NodesApiClient.ts#L67) + +*** + +### mapNodeIdsToTreeIndices() + +> **mapNodeIdsToTreeIndices**(`modelId`, `revisionId`, `nodeIds`): `Promise`\<`number`[]\> + +Maps a set of "node IDs" that identify nodes, to the respective +"tree indexes". + +#### Parameters + +• **modelId**: `number` + +• **revisionId**: `number` + +• **nodeIds**: `number`[] + +#### Returns + +`Promise`\<`number`[]\> + +#### Defined in + +[packages/nodes-api/src/NodesApiClient.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/nodes-api/src/NodesApiClient.ts#L27) + +*** + +### mapTreeIndicesToNodeIds() + +> **mapTreeIndicesToNodeIds**(`modelId`, `revisionId`, `treeIndices`): `Promise`\<`number`[]\> + +Maps a set of "tree indexes" that identify nodes, to the respective +"node IDs". + +#### Parameters + +• **modelId**: `number` + +• **revisionId**: `number` + +• **treeIndices**: `number`[] + +#### Returns + +`Promise`\<`number`[]\> + +#### Defined in + +[packages/nodes-api/src/NodesApiClient.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/nodes-api/src/NodesApiClient.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getNormalizedPixelCoordinates.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getNormalizedPixelCoordinates.md new file mode 100644 index 00000000000..03c7f689c23 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getNormalizedPixelCoordinates.md @@ -0,0 +1,19 @@ +# Function: getNormalizedPixelCoordinates() + +> **getNormalizedPixelCoordinates**(`domElement`, `pixelX`, `pixelY`): `THREE.Vector2` + +## Parameters + +• **domElement**: `HTMLElement` + +• **pixelX**: `number` + +• **pixelY**: `number` + +## Returns + +`THREE.Vector2` + +## Defined in + +[packages/utilities/src/worldToViewport.ts:82](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/worldToViewport.ts#L82) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getNormalizedPixelCoordinatesBySize.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getNormalizedPixelCoordinatesBySize.md new file mode 100644 index 00000000000..dea33c76456 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getNormalizedPixelCoordinatesBySize.md @@ -0,0 +1,23 @@ +# Function: getNormalizedPixelCoordinatesBySize() + +> **getNormalizedPixelCoordinatesBySize**(`pixelX`, `pixelY`, `width`, `height`): `THREE.Vector2` + +Converts a pixel coordinate to normalized device coordinate (in range [-1, 1]) + +## Parameters + +• **pixelX**: `number` + +• **pixelY**: `number` + +• **width**: `number` + +• **height**: `number` + +## Returns + +`THREE.Vector2` + +## Defined in + +[packages/utilities/src/worldToViewport.ts:73](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/worldToViewport.ts#L73) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getWheelEventDelta.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getWheelEventDelta.md new file mode 100644 index 00000000000..e611d5ef879 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/getWheelEventDelta.md @@ -0,0 +1,21 @@ +# Function: getWheelEventDelta() + +> **getWheelEventDelta**(`event`): `number` + +**`Beta`** + +Determines number of deltas when mouse scroll + +## Parameters + +• **event**: `WheelEvent` + +An WheelEvent + +## Returns + +`number` + +## Defined in + +[packages/utilities/src/events/getWheelEventDelta.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/getWheelEventDelta.ts#L10) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/isFlexibleCameraManager.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/isFlexibleCameraManager.md new file mode 100644 index 00000000000..0679c83da06 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/isFlexibleCameraManager.md @@ -0,0 +1,19 @@ +# Function: isFlexibleCameraManager() + +> **isFlexibleCameraManager**(`manager`): `manager is IFlexibleCameraManager` + +**`Beta`** + +Check id the CameraManager is a IFlexibleCameraManager + +## Parameters + +• **manager**: [`CameraManager`](../interfaces/CameraManager.md) + +## Returns + +`manager is IFlexibleCameraManager` + +## Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:112](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L112) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/registerNodeCollectionType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/registerNodeCollectionType.md new file mode 100644 index 00000000000..d64db47417f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/functions/registerNodeCollectionType.md @@ -0,0 +1,21 @@ +# Function: registerNodeCollectionType() + +> **registerNodeCollectionType**\<`T`\>(`nodeCollectionTypeName`, `deserializer`): `void` + +## Type Parameters + +• **T** *extends* [`NodeCollection`](../classes/NodeCollection.md) + +## Parameters + +• **nodeCollectionTypeName**: `string` + +• **deserializer** + +## Returns + +`void` + +## Defined in + +[packages/cad-styling/src/NodeCollectionDeserializer.ts:156](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollectionDeserializer.ts#L156) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/index.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/index.md new file mode 100644 index 00000000000..560c64bfa29 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/index.md @@ -0,0 +1,142 @@ +# @cognite/reveal + +## Index + +### Enumerations + +- [FlexibleControlsType](enumerations/FlexibleControlsType.md) +- [FlexibleMouseActionType](enumerations/FlexibleMouseActionType.md) +- [FlexibleWheelZoomType](enumerations/FlexibleWheelZoomType.md) +- [NodeOutlineColor](enumerations/NodeOutlineColor.md) +- [PointColorType](enumerations/PointColorType.md) +- [PointShape](enumerations/PointShape.md) +- [PointSizeType](enumerations/PointSizeType.md) +- [WellKnownAsprsPointClassCodes](enumerations/WellKnownAsprsPointClassCodes.md) + +### Classes + +- [AnnotationIdPointCloudObjectCollection](classes/AnnotationIdPointCloudObjectCollection.md) +- [AssetNodeCollection](classes/AssetNodeCollection.md) +- [BoundingBoxClipper](classes/BoundingBoxClipper.md) +- [CameraManagerHelper](classes/CameraManagerHelper.md) +- [CdfNodeCollectionBase](classes/CdfNodeCollectionBase.md) +- [ClusteredAreaCollection](classes/ClusteredAreaCollection.md) +- [Cognite3DViewer](classes/Cognite3DViewer.md) +- [CogniteCadModel](classes/CogniteCadModel.md) +- [CognitePointCloudModel](classes/CognitePointCloudModel.md) +- [CombineNodeCollectionBase](classes/CombineNodeCollectionBase.md) +- [ComboControls](classes/ComboControls.md) +- [CustomObject](classes/CustomObject.md) +- [CustomObjectIntersectInput](classes/CustomObjectIntersectInput.md) +- [DebouncedCameraStopEventTrigger](classes/DebouncedCameraStopEventTrigger.md) +- [DefaultCameraManager](classes/DefaultCameraManager.md) +- [FlexibleControlsOptions](classes/FlexibleControlsOptions.md) +- [IndexSet](classes/IndexSet.md) +- [IntersectionNodeCollection](classes/IntersectionNodeCollection.md) +- [InvertedNodeCollection](classes/InvertedNodeCollection.md) +- [NodeCollection](classes/NodeCollection.md) +- [NodeIdNodeCollection](classes/NodeIdNodeCollection.md) +- [NumericRange](classes/NumericRange.md) +- [Overlay3DCollection](classes/Overlay3DCollection.md) +- [PointCloudObjectCollection](classes/PointCloudObjectCollection.md) +- [PointerEvents](classes/PointerEvents.md) +- [PointerEventsTarget](classes/PointerEventsTarget.md) +- [PropertyFilterNodeCollection](classes/PropertyFilterNodeCollection.md) +- [SinglePropertyFilterNodeCollection](classes/SinglePropertyFilterNodeCollection.md) +- [StyledPointCloudObjectCollection](classes/StyledPointCloudObjectCollection.md) +- [TreeIndexNodeCollection](classes/TreeIndexNodeCollection.md) +- [UnionNodeCollection](classes/UnionNodeCollection.md) +- [Vector3Pool](classes/Vector3Pool.md) + +### Interfaces + +- [AddModelOptions](interfaces/AddModelOptions.md) +- [AreaCollection](interfaces/AreaCollection.md) +- [CameraManager](interfaces/CameraManager.md) +- [CdfModelNodeCollectionDataProvider](interfaces/CdfModelNodeCollectionDataProvider.md) +- [Cognite3DViewerOptions](interfaces/Cognite3DViewerOptions.md) +- [ICustomObject](interfaces/ICustomObject.md) +- [IFlexibleCameraManager](interfaces/IFlexibleCameraManager.md) +- [Image360](interfaces/Image360.md) +- [Image360Annotation](interfaces/Image360Annotation.md) +- [Image360Collection](interfaces/Image360Collection.md) +- [Image360Revision](interfaces/Image360Revision.md) +- [Image360Visualization](interfaces/Image360Visualization.md) +- [Overlay3D](interfaces/Overlay3D.md) +- [OverlayCollection](interfaces/OverlayCollection.md) + +### Type Aliases + +- [AddImage360Options](type-aliases/AddImage360Options.md) +- [AnyIntersection](type-aliases/AnyIntersection.md) +- [AssetAnnotationImage360Info](type-aliases/AssetAnnotationImage360Info.md) +- [BeforeSceneRenderedDelegate](type-aliases/BeforeSceneRenderedDelegate.md) +- [CadIntersection](type-aliases/CadIntersection.md) +- [CadModelBudget](type-aliases/CadModelBudget.md) +- [CameraChangeDelegate](type-aliases/CameraChangeDelegate.md) +- [CameraConfiguration](type-aliases/CameraConfiguration.md) +- [CameraControlsOptions](type-aliases/CameraControlsOptions.md) +- [CameraEventDelegate](type-aliases/CameraEventDelegate.md) +- [CameraManagerEventType](type-aliases/CameraManagerEventType.md) +- [CameraState](type-aliases/CameraState.md) +- [CameraStopDelegate](type-aliases/CameraStopDelegate.md) +- [ClippingPlanesState](type-aliases/ClippingPlanesState.md) +- [CogniteModel](type-aliases/CogniteModel.md) +- [ComboControlsEventType](type-aliases/ComboControlsEventType.md) +- [ComboControlsOptions](type-aliases/ComboControlsOptions.md) +- [CompletePointCloudAppearance](type-aliases/CompletePointCloudAppearance.md) +- [CustomObjectIntersection](type-aliases/CustomObjectIntersection.md) +- [DefaultOverlay3DContentType](type-aliases/DefaultOverlay3DContentType.md) +- [DisposedDelegate](type-aliases/DisposedDelegate.md) +- [EdlOptions](type-aliases/EdlOptions.md) +- [FlexibleControlsTypeChangeDelegate](type-aliases/FlexibleControlsTypeChangeDelegate.md) +- [GeometryFilter](type-aliases/GeometryFilter.md) +- [Image360AnnotationAppearance](type-aliases/Image360AnnotationAppearance.md) +- [Image360AnnotationAssetFilter](type-aliases/Image360AnnotationAssetFilter.md) +- [Image360AnnotationAssetQueryResult](type-aliases/Image360AnnotationAssetQueryResult.md) +- [Image360AnnotationFilterOptions](type-aliases/Image360AnnotationFilterOptions.md) +- [Image360AnnotationIntersection](type-aliases/Image360AnnotationIntersection.md) +- [Image360DataModelIdentifier](type-aliases/Image360DataModelIdentifier.md) +- [Image360EnteredDelegate](type-aliases/Image360EnteredDelegate.md) +- [Image360ExitedDelegate](type-aliases/Image360ExitedDelegate.md) +- [Image360IconStyle](type-aliases/Image360IconStyle.md) +- [Image360WithCollection](type-aliases/Image360WithCollection.md) +- [ImageAssetLinkAnnotationInfo](type-aliases/ImageAssetLinkAnnotationInfo.md) +- [Intersection](type-aliases/Intersection.md) +- [ModelState](type-aliases/ModelState.md) +- [NodeAppearance](type-aliases/NodeAppearance.md) +- [NodeCollectionSerializationContext](type-aliases/NodeCollectionSerializationContext.md) +- [OnLoadingCallback](type-aliases/OnLoadingCallback.md) +- [Overlay3DCollectionOptions](type-aliases/Overlay3DCollectionOptions.md) +- [OverlayInfo](type-aliases/OverlayInfo.md) +- [PointCloudAppearance](type-aliases/PointCloudAppearance.md) +- [PointCloudBudget](type-aliases/PointCloudBudget.md) +- [PointCloudIntersection](type-aliases/PointCloudIntersection.md) +- [PointCloudObjectMetadata](type-aliases/PointCloudObjectMetadata.md) +- [PointerEventData](type-aliases/PointerEventData.md) +- [PointerEventDelegate](type-aliases/PointerEventDelegate.md) +- [PropertyFilterNodeCollectionOptions](type-aliases/PropertyFilterNodeCollectionOptions.md) +- [RenderParameters](type-aliases/RenderParameters.md) +- [ResolutionOptions](type-aliases/ResolutionOptions.md) +- [SceneRenderedDelegate](type-aliases/SceneRenderedDelegate.md) +- [SerializableNodeAppearance](type-aliases/SerializableNodeAppearance.md) +- [SerializedNodeCollection](type-aliases/SerializedNodeCollection.md) +- [SupportedModelTypes](type-aliases/SupportedModelTypes.md) +- [ViewerState](type-aliases/ViewerState.md) +- [WellKnownUnit](type-aliases/WellKnownUnit.md) + +### Variables + +- [CAMERA\_MANAGER\_EVENT\_TYPE\_LIST](variables/CAMERA_MANAGER_EVENT_TYPE_LIST.md) +- [CDF\_TO\_VIEWER\_TRANSFORMATION](variables/CDF_TO_VIEWER_TRANSFORMATION.md) +- [DefaultNodeAppearance](variables/DefaultNodeAppearance.md) +- [DefaultPointCloudAppearance](variables/DefaultPointCloudAppearance.md) +- [REVEAL\_VERSION](variables/REVEAL_VERSION.md) + +### Functions + +- [getNormalizedPixelCoordinates](functions/getNormalizedPixelCoordinates.md) +- [getNormalizedPixelCoordinatesBySize](functions/getNormalizedPixelCoordinatesBySize.md) +- [getWheelEventDelta](functions/getWheelEventDelta.md) +- [isFlexibleCameraManager](functions/isFlexibleCameraManager.md) +- [registerNodeCollectionType](functions/registerNodeCollectionType.md) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/AddModelOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/AddModelOptions.md new file mode 100644 index 00000000000..ce342e862f4 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/AddModelOptions.md @@ -0,0 +1,41 @@ +# Interface: AddModelOptions + +## Properties + +### geometryFilter? + +> `optional` **geometryFilter**: [`GeometryFilter`](../type-aliases/GeometryFilter.md) + +#### Defined in + +[packages/api/src/public/migration/types.ts:215](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L215) + +*** + +### localPath? + +> `optional` **localPath**: `string` + +#### Defined in + +[packages/api/src/public/migration/types.ts:214](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L214) + +*** + +### modelId + +> **modelId**: `number` + +#### Defined in + +[packages/api/src/public/migration/types.ts:211](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L211) + +*** + +### revisionId + +> **revisionId**: `number` + +#### Defined in + +[packages/api/src/public/migration/types.ts:212](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L212) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/AreaCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/AreaCollection.md new file mode 100644 index 00000000000..2621667424c --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/AreaCollection.md @@ -0,0 +1,103 @@ +# Interface: AreaCollection + +Represents a collection of areas/axis-aligned +bounding boxes for use e.g. for load prioritization. Implementations +are not expected to store all areas inserted with `addAreas`, +but rather some "representative box set" covering the inserted areas. +Performance will be better the fewer boxes the representative set contains, +while the effectiveness of node prioritization will suffer if the +representative set covers too much area that is not part +of the inserted boxes + +## Properties + +### isEmpty + +> `readonly` **isEmpty**: `boolean` + +#### Defined in + +[packages/cad-styling/src/prioritized/AreaCollection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L18) + +## Methods + +### addAreas() + +> **addAreas**(`boxes`): `void` + +Add areas to be covered by the representative set of this +AreaCollection. + +#### Parameters + +• **boxes**: `Iterable`\<`Box3`\> + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/prioritized/AreaCollection.ts:36](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L36) + +*** + +### areas() + +> **areas**(): `Generator`\<`Box3`, `any`, `unknown`\> + +Return some set of boxes that cover the boxes inserted with `addAreas`. +It is required that each inserted box is completely covered by some +subset of boxes in the set returned from `areas` + +#### Returns + +`Generator`\<`Box3`, `any`, `unknown`\> + +#### Defined in + +[packages/cad-styling/src/prioritized/AreaCollection.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L25) + +*** + +### intersectWith() + +> **intersectWith**(`boxes`): `void` + +Alter the representative set to cover only the intersection between the +representative set of this AreaCollection and the incoming boxes. +Note that the intersection of two representative sets A' and B' that +represent the original box sets A and B will cover the intersection between +A and B, and will thus be a valid representative set for the intersection of A and B. + +#### Parameters + +• **boxes**: `Iterable`\<`Box3`\> + +#### Returns + +`void` + +#### Defined in + +[packages/cad-styling/src/prioritized/AreaCollection.ts:45](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L45) + +*** + +### intersectsBox() + +> **intersectsBox**(`box`): `boolean` + +Return whether the input box intersects the AreaCollection. + +#### Parameters + +• **box**: `Box3` + +#### Returns + +`boolean` + +#### Defined in + +[packages/cad-styling/src/prioritized/AreaCollection.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L30) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/CameraManager.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/CameraManager.md new file mode 100644 index 00000000000..90ab07342f7 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/CameraManager.md @@ -0,0 +1,328 @@ +# Interface: CameraManager + +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 the viewer. Implementations +must trigger the `cameraChange`-event when camera is changed. +The default implementation is [DefaultCameraManager](../classes/DefaultCameraManager.md). + +## Extended by + +- [`IFlexibleCameraManager`](IFlexibleCameraManager.md) + +## Methods + +### activate() + +> **activate**(`cameraManager`?): `void` + +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 viewer. + +#### Parameters + +• **cameraManager?**: [`CameraManager`](CameraManager.md) + +Previously used camera manager. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:61](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L61) + +*** + +### deactivate() + +> **deactivate**(): `void` + +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 viewer. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L69) + +*** + +### dispose() + +> **dispose**(): `void` + +#### Returns + +`void` + +#### Obvious + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:109](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L109) + +*** + +### fitCameraToBoundingBox() + +> **fitCameraToBoundingBox**(`boundingBox`, `duration`?, `radiusFactor`?): `void` + +Moves camera to a place where the content of a bounding box is visible to the camera. + +#### Parameters + +• **boundingBox**: `Box3` + +The bounding box in world space. + +• **duration?**: `number` + +The duration of the animation moving the camera. + +• **radiusFactor?**: `number` + +The ratio of the distance from camera to center of box and radius of the box. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:97](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L97) + +*** + +### getCamera() + +> **getCamera**(): `PerspectiveCamera` + +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. + +#### Returns + +`PerspectiveCamera` + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:29](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L29) + +*** + +### getCameraState() + +> **getCameraState**(): `Required` \<[`CameraState`](../type-aliases/CameraState.md)\> + +Get camera's state + +#### Returns + +`Required` \<[`CameraState`](../type-aliases/CameraState.md)\> + +Camera state: position, target and rotation. + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:52](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L52) + +*** + +### off() + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +Unsubscribes from changes of the camera event. + +##### Parameters + +• **event**: `"cameraChange"` + +The event type. + +• **callback**: [`CameraChangeDelegate`](../type-aliases/CameraChangeDelegate.md) + +Callback function to be unsubscribed. + +##### Returns + +`void` + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:87](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L87) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraStop"` + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:88](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L88) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraChange"` \| `"cameraStop"` + +• **callback**: [`CameraEventDelegate`](../type-aliases/CameraEventDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:89](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L89) + +*** + +### on() + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Subscribes to events on this camera manager. There are several event types: +'cameraChange' - Subscribes to changes of the camera. This is used by Reveal to react on changes of the camera. +'cameraStop' - Subscribes to events indicating the camera has stopped + +##### Parameters + +• **event**: `"cameraChange"` + +The event type. + +• **callback**: [`CameraChangeDelegate`](../type-aliases/CameraChangeDelegate.md) + +Callback to be called when the event is fired. + +##### Returns + +`void` + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:78](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L78) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraStop"` + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:79](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L79) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"cameraChange"` \| `"cameraStop"` + +• **callback**: [`CameraEventDelegate`](../type-aliases/CameraEventDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:80](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L80) + +*** + +### setCameraState() + +> **setCameraState**(`state`): `void` + +Set camera's state. Rotation and target can't be set at the same time as they could conflict, +should throw an error if both are passed with non-zero value inside state. + +#### Parameters + +• **state**: [`CameraState`](../type-aliases/CameraState.md) + +Camera state, all fields are optional. + +#### Returns + +`void` + +#### Example + +```js +// store position, target +const { position, target } = cameraManager.getCameraState(); +// restore position, target +cameraManager.setCameraState({ position, target }); +``` + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L46) + +*** + +### update() + +> **update**(`deltaTime`, `boundingBox`): `void` + +Updates internal state of camera manager. Expected to update visual state of the camera +as well as it's near and far planes if needed. Called in `requestAnimationFrame`-loop. +Reveal performance affects frequency with which this method is called. + +#### Parameters + +• **deltaTime**: `number` + +Delta time since last update in seconds. + +• **boundingBox**: `Box3` + +Global bounding box of the model(s) and any custom objects added to the scene. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:105](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L105) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/CdfModelNodeCollectionDataProvider.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/CdfModelNodeCollectionDataProvider.md new file mode 100644 index 00000000000..1d71c9be7a4 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/CdfModelNodeCollectionDataProvider.md @@ -0,0 +1,79 @@ +# Interface: CdfModelNodeCollectionDataProvider + +Provides metadata needed to get asset mappings for a CDF 3D model + +## Properties + +### modelId + +> **modelId**: `number` + +Model and revision IDs for the model + +#### Defined in + +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:31](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L31) + +*** + +### nodeCount + +> **nodeCount**: `number` + +Total count of nodes in the model + +#### Defined in + +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L26) + +*** + +### revisionId + +> **revisionId**: `number` + +#### Defined in + +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L32) + +## Methods + +### getCdfToDefaultModelTransformation() + +> **getCdfToDefaultModelTransformation**(`out`?): `Matrix4` + +Gets the default transformation of the model from CDF space. +The current total transformation of the model from the backend to its transform in ThreeJS space +is thus `model.getCdfToDefaultModelTransformation() * model.getModelTransformation()`. + +#### Parameters + +• **out?**: `Matrix4` + +#### Returns + +`Matrix4` + +#### Defined in + +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L21) + +*** + +### getModelTransformation() + +> **getModelTransformation**(`out`?): `Matrix4` + +Gets the transformation of the model in ThreeJS space + +#### Parameters + +• **out?**: `Matrix4` + +#### Returns + +`Matrix4` + +#### Defined in + +[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Cognite3DViewerOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Cognite3DViewerOptions.md new file mode 100644 index 00000000000..90c4d78fefb --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Cognite3DViewerOptions.md @@ -0,0 +1,282 @@ +# Interface: Cognite3DViewerOptions + +## Properties + +### antiAliasingHint? + +> `optional` **antiAliasingHint**: `"disabled"` \| `"fxaa"` \| `"msaa2+fxaa"` \| `"msaa4+fxaa"` \| `"msaa8+fxaa"` \| `"msaa16+fxaa"` \| `"msaa2"` \| `"msaa4"` \| `"msaa8"` \| `"msaa16"` + +Hints Reveal to use a given anti-aliasing technique. + +Fast approximate anti-aliasing (FXAA) is a fast technique that will remove some, but not all aliasing effects. See +https://en.wikipedia.org/wiki/Fast_approximate_anti-aliasing. + +Multi-sampling anti-aliasinbg (MSAA) is a technique for taking multiple samples per pixel to avoid aliasing effects. +This mode requires WebGL 2. See https://www.khronos.org/opengl/wiki/Multisampling. + +The combined modes will apply both MSAA and FXAA anti-aliasing and yields the best visual result. + +When using the MSAA modes combined with FXAA Reveal will fall back to FXAA on WebGL 1. There is no fallback for the +"plain" MSAA modes on WebGL 1. + +Currently the default mode is FXAA, but this is subject to change. + +#### Defined in + +[packages/api/src/public/migration/types.ts:116](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L116) + +*** + +### cameraManager? + +> `optional` **cameraManager**: [`CameraManager`](CameraManager.md) + +Camera manager instance that is used for controlling the camera. +It is responsible for all manipulations that are done with the camera, +including animations and modification of state. Also, gives ability +to provide custom `PerspectiveCamera` instance to [Cognite3DViewer](../classes/Cognite3DViewer.md). +Default implementation is [DefaultCameraManager](../classes/DefaultCameraManager.md). + +#### Defined in + +[packages/api/src/public/migration/types.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L81) + +*** + +### continuousModelStreaming? + +> `optional` **continuousModelStreaming**: `boolean` + +Allows for controlling if geometry streaming should be halted when +the camera is moving. Note that this option should left to false on +low-end devices as more loading can cause frame drops. + +Default value is set to true. + +#### Defined in + +[packages/api/src/public/migration/types.ts:176](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L176) + +*** + +### customDataSource? + +> `optional` **customDataSource**: [`DataSource`](../extensions/datasource/interfaces/DataSource.md) + +Allows providing a custom data source that Reveal will +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](../extensions/datasource/classes/CdfModelIdentifier.md). + +This cannot be used together with Cognite3DViewerOptions._localModels. + +#### Defined in + +[packages/api/src/public/migration/types.ts:167](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L167) + +*** + +### domElement? + +> `optional` **domElement**: `HTMLElement` + +An existing DOM element that we will render canvas into. + +#### Defined in + +[packages/api/src/public/migration/types.ts:50](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L50) + +*** + +### enableEdges? + +> `optional` **enableEdges**: `boolean` + +Enables / disables visualizing the edges of geometry. Defaults to true. + +#### Defined in + +[packages/api/src/public/migration/types.ts:152](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L152) + +*** + +### hasEventListeners? + +> `optional` **hasEventListeners**: `boolean` + +**`Beta`** + +Add event listerers around, default is having event listeners. + +#### Defined in + +[packages/api/src/public/migration/types.ts:204](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L204) + +*** + +### loadingIndicatorStyle? + +> `optional` **loadingIndicatorStyle**: `object` + +Style the loading indicator. + +#### opacity + +> **opacity**: `number` + +Opacity of the spinner in fractions. Valid values are between +0.2 and 1.0. Defaults to 1.0. + +#### placement + +> **placement**: `"topLeft"` \| `"topRight"` \| `"bottomLeft"` \| `"bottomRight"` + +What corner the spinner should be placed in. Defaults top topLeft. + +#### Defined in + +[packages/api/src/public/migration/types.ts:63](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L63) + +*** + +### logMetrics? + +> `optional` **logMetrics**: `boolean` + +Send anonymous usage statistics. + +#### Defined in + +[packages/api/src/public/migration/types.ts:53](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L53) + +*** + +### onLoading? + +> `optional` **onLoading**: [`OnLoadingCallback`](../type-aliases/OnLoadingCallback.md) + +Callback to download stream progress. + +#### Defined in + +[packages/api/src/public/migration/types.ts:155](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L155) + +*** + +### pointCloudEffects? + +> `optional` **pointCloudEffects**: `object` + +Point cloud visualisation effects parameteres. + +#### edlOptions? + +> `optional` **edlOptions**: `"disabled"` \| `Partial` \<[`EdlOptions`](../type-aliases/EdlOptions.md)\> + +Eye Dome Lighting (EDL) effect, considerably improves depth perception of point cloud model. + +#### pointBlending? + +> `optional` **pointBlending**: `boolean` + +Point blending effect, creates more "stable" texture on objects surfaces if point sizing is +big enough. Can cause significant decrease in performance on some machines. + +#### Defined in + +[packages/api/src/public/migration/types.ts:137](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L137) + +*** + +### renderTargetOptions? + +> `optional` **renderTargetOptions**: `object` + +Render to offscreen buffer instead of canvas. + +#### autoSetSize? + +> `optional` **autoSetSize**: `boolean` + +#### target + +> **target**: `WebGLRenderTarget`\<`Texture`\> + +#### Defined in + +[packages/api/src/public/migration/types.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L58) + +*** + +### renderer? + +> `optional` **renderer**: `WebGLRenderer` + +Renderer used to visualize model (optional). +Note that when providing a custom renderer, this should be configured with +`'powerPreference': 'high-performance'` for best performance. + +#### Defined in + +[packages/api/src/public/migration/types.ts:87](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L87) + +*** + +### ~~rendererResolutionThreshold?~~ + +> `optional` **rendererResolutionThreshold**: `number` + +Generally Reveal will follow the resolution given by the size +of the encapsulating DOM element of the Canvas [Cognite3DViewerOptions.domElement](Cognite3DViewerOptions.md#domelement). +To ensure managable performance, Reveal will by default set an upper threshold to limit +the resolution. Setting the [Cognite3DViewerOptions.rendererResolutionThreshold](Cognite3DViewerOptions.md#rendererresolutionthreshold) will +set this upper limit of what resolution Reveal will allow. + +#### Deprecated + +Use [Cognite3DViewer.setResolutionOptions](../classes/Cognite3DViewer.md#setresolutionoptions) instead. + +#### Defined in + +[packages/api/src/public/migration/types.ts:98](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L98) + +*** + +### sdk + +> **sdk**: `CogniteClient` + +Initialized connection to CDF used to load data. + +#### Defined in + +[packages/api/src/public/migration/types.ts:47](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L47) + +*** + +### ssaoQualityHint? + +> `optional` **ssaoQualityHint**: `"disabled"` \| `"medium"` \| `"high"` \| `"veryhigh"` + +Hints the renderer of the quality it should aim for for screen space ambient occlusion, +an effect creating shadows and that gives the rendered image more depth. + +#### Defined in + +[packages/api/src/public/migration/types.ts:132](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L132) + +*** + +### useFlexibleCameraManager? + +> `optional` **useFlexibleCameraManager**: `boolean` + +**`Beta`** + +Use the new flexible camera manager or not, default not to be used. + +#### Defined in + +[packages/api/src/public/migration/types.ts:198](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L198) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/ICustomObject.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/ICustomObject.md new file mode 100644 index 00000000000..04f5ee8b74a --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/ICustomObject.md @@ -0,0 +1,169 @@ +# Interface: ICustomObject + +**`Beta`** + +This interface encasulate a Object3D, and made it possible to add flags to it. +It might be extended with more flags in the future. + +## Accessors + +### isPartOfBoundingBox + +> `get` **isPartOfBoundingBox**(): `boolean` + +**`Beta`** + +Get whether it should be part of the combined bounding box or not. +Default is true. + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L26) + +*** + +### object + +> `get` **object**(): `Object3D`\<`Object3DEventMap`\> + +**`Beta`** + +Get the Object3D + +#### Returns + +`Object3D`\<`Object3DEventMap`\> + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:19](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L19) + +*** + +### shouldPick + +> `get` **shouldPick**(): `boolean` + +**`Beta`** + +Get whether it should be picked by the camera manager +Default is false. + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:33](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L33) + +*** + +### shouldPickBoundingBox + +> `get` **shouldPickBoundingBox**(): `boolean` + +**`Beta`** + +Set or get whether it should be also give the bounding box when picked by the camera +Default is false. + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:40](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L40) + +*** + +### useDepthTest + +> `get` **useDepthTest**(): `boolean` + +**`Beta`** + +Get whether it should be rendered with depth test (on top on other objects) +Default is true. + +#### Returns + +`boolean` + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:47](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L47) + +## Methods + +### beforeRender() + +> **beforeRender**(`camera`): `void` + +**`Beta`** + +This method is called before rendering of the custom object + +#### Parameters + +• **camera**: `PerspectiveCamera` + +#### Returns + +`void` + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L69) + +*** + +### getBoundingBox() + +> **getBoundingBox**(`target`): `Box3` + +**`Beta`** + +Get the bounding box from the object + +#### Parameters + +• **target**: `Box3` + +#### Returns + +`Box3` + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:53](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L53) + +*** + +### intersectIfCloser() + +> **intersectIfCloser**(`intersectInput`, `closestDistance`): `undefined` \| [`CustomObjectIntersection`](../type-aliases/CustomObjectIntersection.md) + +**`Beta`** + +Intersect the object with the raycaster. +This function can be overridden to provide custom intersection logic. + +#### Parameters + +• **intersectInput**: [`CustomObjectIntersectInput`](../classes/CustomObjectIntersectInput.md) + +• **closestDistance**: `undefined` \| `number` + +#### Returns + +`undefined` \| [`CustomObjectIntersection`](../type-aliases/CustomObjectIntersection.md) + +#### Defined in + +[packages/utilities/src/customObject/ICustomObject.ts:60](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/ICustomObject.ts#L60) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/IFlexibleCameraManager.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/IFlexibleCameraManager.md new file mode 100644 index 00000000000..d81985c0001 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/IFlexibleCameraManager.md @@ -0,0 +1,721 @@ +# Interface: IFlexibleCameraManager + +**`Beta`** + +Flexible implementation of [CameraManager](CameraManager.md). The user can switch between Orbit, FirstPerson or OrbitInCenter +Supports automatic update of camera near and far planes and animated change of camera position and target. +It provides additional functionality for controlling camera behavior and rotation. + +## Extends + +- [`CameraManager`](CameraManager.md) + +## Accessors + +### controlsType + +> `get` **controlsType**(): [`FlexibleControlsType`](../enumerations/FlexibleControlsType.md) + +**`Beta`** + +Get current FlexibleControlsType type + +> `set` **controlsType**(`value`): `void` + +**`Beta`** + +Set current FlexibleControlsType type + +#### Parameters + +• **value**: [`FlexibleControlsType`](../enumerations/FlexibleControlsType.md) + +#### Returns + +[`FlexibleControlsType`](../enumerations/FlexibleControlsType.md) + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L26) + +*** + +### options + +> `get` **options**(): [`FlexibleControlsOptions`](../classes/FlexibleControlsOptions.md) + +**`Beta`** + +Set the options for the camera manager + +#### Returns + +[`FlexibleControlsOptions`](../classes/FlexibleControlsOptions.md) + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L37) + +## Methods + +### activate() + +> **activate**(`cameraManager`?): `void` + +**`Beta`** + +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 viewer. + +#### Parameters + +• **cameraManager?**: [`CameraManager`](CameraManager.md) + +Previously used camera manager. + +#### Returns + +`void` + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`activate`](CameraManager.md#activate) + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:61](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L61) + +*** + +### addControlsTypeChangeListener() + +> **addControlsTypeChangeListener**(`callback`): `void` + +**`Beta`** + +Adds a listener for changes in the controls type of the camera manager. + +#### Parameters + +• **callback**: [`FlexibleControlsTypeChangeDelegate`](../type-aliases/FlexibleControlsTypeChangeDelegate.md) + +The callback function to be invoked when the controls type changes. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:52](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L52) + +*** + +### deactivate() + +> **deactivate**(): `void` + +**`Beta`** + +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 viewer. + +#### Returns + +`void` + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`deactivate`](CameraManager.md#deactivate) + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L69) + +*** + +### dispose() + +> **dispose**(): `void` + +**`Beta`** + +#### Returns + +`void` + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`dispose`](CameraManager.md#dispose) + +#### Obvious + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:109](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L109) + +*** + +### fitCameraToBoundingBox() + +> **fitCameraToBoundingBox**(`boundingBox`, `duration`?, `radiusFactor`?): `void` + +**`Beta`** + +Moves camera to a place where the content of a bounding box is visible to the camera. + +#### Parameters + +• **boundingBox**: `Box3` + +The bounding box in world space. + +• **duration?**: `number` + +The duration of the animation moving the camera. + +• **radiusFactor?**: `number` + +The ratio of the distance from camera to center of box and radius of the box. + +#### Returns + +`void` + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`fitCameraToBoundingBox`](CameraManager.md#fitcameratoboundingbox) + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:97](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L97) + +*** + +### getCamera() + +> **getCamera**(): `PerspectiveCamera` + +**`Beta`** + +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. + +#### Returns + +`PerspectiveCamera` + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`getCamera`](CameraManager.md#getcamera) + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:29](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L29) + +*** + +### getCameraState() + +> **getCameraState**(): `Required` \<[`CameraState`](../type-aliases/CameraState.md)\> + +**`Beta`** + +Get camera's state + +#### Returns + +`Required` \<[`CameraState`](../type-aliases/CameraState.md)\> + +Camera state: position, target and rotation. + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`getCameraState`](CameraManager.md#getcamerastate) + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:52](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L52) + +*** + +### off() + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +**`Beta`** + +Unsubscribes from changes of the camera event. + +##### Parameters + +• **event**: `"cameraChange"` + +The event type. + +• **callback**: [`CameraChangeDelegate`](../type-aliases/CameraChangeDelegate.md) + +Callback function to be unsubscribed. + +##### Returns + +`void` + +##### Inherited from + +[`CameraManager`](CameraManager.md) . [`off`](CameraManager.md#off) + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:87](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L87) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +**`Beta`** + +##### Parameters + +• **event**: `"cameraStop"` + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +##### Returns + +`void` + +##### Inherited from + +[`CameraManager`](CameraManager.md) . [`off`](CameraManager.md#off) + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:88](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L88) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +**`Beta`** + +##### Parameters + +• **event**: `"cameraChange"` \| `"cameraStop"` + +• **callback**: [`CameraEventDelegate`](../type-aliases/CameraEventDelegate.md) + +##### Returns + +`void` + +##### Inherited from + +[`CameraManager`](CameraManager.md) . [`off`](CameraManager.md#off) + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:89](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L89) + +*** + +### on() + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +**`Beta`** + +Subscribes to events on this camera manager. There are several event types: +'cameraChange' - Subscribes to changes of the camera. This is used by Reveal to react on changes of the camera. +'cameraStop' - Subscribes to events indicating the camera has stopped + +##### Parameters + +• **event**: `"cameraChange"` + +The event type. + +• **callback**: [`CameraChangeDelegate`](../type-aliases/CameraChangeDelegate.md) + +Callback to be called when the event is fired. + +##### Returns + +`void` + +##### Inherited from + +[`CameraManager`](CameraManager.md) . [`on`](CameraManager.md#on) + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:78](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L78) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +**`Beta`** + +##### Parameters + +• **event**: `"cameraStop"` + +• **callback**: [`CameraStopDelegate`](../type-aliases/CameraStopDelegate.md) + +##### Returns + +`void` + +##### Inherited from + +[`CameraManager`](CameraManager.md) . [`on`](CameraManager.md#on) + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:79](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L79) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +**`Beta`** + +##### Parameters + +• **event**: `"cameraChange"` \| `"cameraStop"` + +• **callback**: [`CameraEventDelegate`](../type-aliases/CameraEventDelegate.md) + +##### Returns + +`void` + +##### Inherited from + +[`CameraManager`](CameraManager.md) . [`on`](CameraManager.md#on) + +##### Defined in + +[packages/camera-manager/src/CameraManager.ts:80](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L80) + +*** + +### onClick() + +> **onClick**(`event`): `Promise`\<`void`\> + +**`Beta`** + +Called when a click event is triggered + +#### Parameters + +• **event**: `PointerEvent` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:64](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L64) + +*** + +### onDoubleClick() + +> **onDoubleClick**(`event`): `Promise`\<`void`\> + +**`Beta`** + +Called when double click event is triggered + +#### Parameters + +• **event**: `PointerEvent` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:70](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L70) + +*** + +### onFocusChanged() + +> **onFocusChanged**(`haveFocus`): `void` + +**`Beta`** + +Called when focus is changed + +#### Parameters + +• **haveFocus**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:105](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L105) + +*** + +### onKey() + +> **onKey**(`event`, `down`): `void` + +**`Beta`** + +Called when a key is pressed or released + +#### Parameters + +• **event**: `KeyboardEvent` + +• **down**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:99](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L99) + +*** + +### onPointerDown() + +> **onPointerDown**(`event`, `leftButton`): `Promise`\<`void`\> + +**`Beta`** + +Called when pointer is pressed + +#### Parameters + +• **event**: `PointerEvent` + +• **leftButton**: `boolean` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:76](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L76) + +*** + +### onPointerDrag() + +> **onPointerDrag**(`event`, `leftButton`): `Promise`\<`void`\> + +**`Beta`** + +Called when pointer is dragged + +#### Parameters + +• **event**: `PointerEvent` + +• **leftButton**: `boolean` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:82](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L82) + +*** + +### onPointerUp() + +> **onPointerUp**(`event`, `leftButton`): `Promise`\<`void`\> + +**`Beta`** + +Called when pointer is released + +#### Parameters + +• **event**: `PointerEvent` + +• **leftButton**: `boolean` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:88](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L88) + +*** + +### onWheel() + +> **onWheel**(`event`, `delta`): `Promise`\<`void`\> + +**`Beta`** + +Called when wheel event is triggered + +#### Parameters + +• **event**: `WheelEvent` + +• **delta**: `number` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:93](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L93) + +*** + +### removeControlsTypeChangeListener() + +> **removeControlsTypeChangeListener**(`callback`): `void` + +**`Beta`** + +Removes a listener for changes in the controls type of the camera manager. + +#### Parameters + +• **callback**: [`FlexibleControlsTypeChangeDelegate`](../type-aliases/FlexibleControlsTypeChangeDelegate.md) + +The callback function to be removed from the controls type change listeners. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L58) + +*** + +### rotateCameraTo() + +> **rotateCameraTo**(`direction`, `animationDuration`): `void` + +**`Beta`** + +Rotates the camera to look in the specified direction. +Supports automatic update of camera near and far planes and animated change of camera position and target. + +#### Parameters + +• **direction**: `Vector3` + +The direction to rotate the camera towards. + +• **animationDuration**: `number` + +The duration of the rotation animation in milliseconds. + +#### Returns + +`void` + +#### Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L46) + +*** + +### setCameraState() + +> **setCameraState**(`state`): `void` + +**`Beta`** + +Set camera's state. Rotation and target can't be set at the same time as they could conflict, +should throw an error if both are passed with non-zero value inside state. + +#### Parameters + +• **state**: [`CameraState`](../type-aliases/CameraState.md) + +Camera state, all fields are optional. + +#### Returns + +`void` + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`setCameraState`](CameraManager.md#setcamerastate) + +#### Example + +```js +// store position, target +const { position, target } = cameraManager.getCameraState(); +// restore position, target +cameraManager.setCameraState({ position, target }); +``` + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L46) + +*** + +### update() + +> **update**(`deltaTime`, `boundingBox`): `void` + +**`Beta`** + +Updates internal state of camera manager. Expected to update visual state of the camera +as well as it's near and far planes if needed. Called in `requestAnimationFrame`-loop. +Reveal performance affects frequency with which this method is called. + +#### Parameters + +• **deltaTime**: `number` + +Delta time since last update in seconds. + +• **boundingBox**: `Box3` + +Global bounding box of the model(s) and any custom objects added to the scene. + +#### Returns + +`void` + +#### Inherited from + +[`CameraManager`](CameraManager.md) . [`update`](CameraManager.md#update) + +#### Defined in + +[packages/camera-manager/src/CameraManager.ts:105](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraManager.ts#L105) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360.md new file mode 100644 index 00000000000..0bf6e23d032 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360.md @@ -0,0 +1,127 @@ +# Interface: Image360 + +A single 360 image "station", which may consist of several revisions +captured in approximately the same location + +## Properties + +### id + +> `readonly` **id**: `string` + +Get Id of 360 image entity. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:42](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L42) + +*** + +### image360Visualization + +> `readonly` **image360Visualization**: [`Image360Visualization`](Image360Visualization.md) + +The object containing the unit cube with the 360 images. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:36](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L36) + +*** + +### label + +> `readonly` **label**: `undefined` \| `string` + +Get label of 360 image entity. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:48](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L48) + +*** + +### transform + +> `readonly` **transform**: `Matrix4` + +Get a copy of the model-to-world transformation matrix +of the given 360 image. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L30) + +## Methods + +### getActiveRevision() + +> **getActiveRevision**(): [`Image360Revision`](Image360Revision.md) + +Get the revision that is currently loaded for this entry. + +#### Returns + +[`Image360Revision`](Image360Revision.md) + +The active revision. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:60](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L60) + +*** + +### getIconColor() + +> **getIconColor**(): `Color` \| `"default"` + +Get a copy of the color assigned to the icon of this entity + +#### Returns + +`Color` \| `"default"` + +The currently assign color, or 'default' if none is assigned + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:67](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L67) + +*** + +### getRevisions() + +> **getRevisions**(): [`Image360Revision`](Image360Revision.md)[] + +List all historical images for this entity. + +#### Returns + +[`Image360Revision`](Image360Revision.md)[] + +A list of available revisions. + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:54](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L54) + +*** + +### setIconColor() + +> **setIconColor**(`color`): `void` + +Assign a color to the icon of this entity + +#### Parameters + +• **color**: `Color` \| `"default"` + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/entity/Image360.ts:72](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L72) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Annotation.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Annotation.md new file mode 100644 index 00000000000..7f6d4ab7604 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Annotation.md @@ -0,0 +1,107 @@ +# Interface: 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/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/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 + +• **out?**: `Vector3` + +#### Returns + +`Vector3` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:40](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L40) + +*** + +### getColor() + +> **getColor**(): `Color` + +Get the individual display color of this annotation. + +#### Returns + +`Color` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L20) + +*** + +### getVisible() + +> **getVisible**(): `boolean` + +Get whether this annotation is visible + +#### Returns + +`boolean` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/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 + +• **color?**: `Color` + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L25) + +*** + +### setVisible() + +> **setVisible**(`visible`?): `void` + +Set whether this annotation should be visible. Default: true + +#### Parameters + +• **visible?**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/annotation/Image360Annotation.ts:35](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/annotation/Image360Annotation.ts#L35) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Collection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Collection.md new file mode 100644 index 00000000000..efe84023986 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Collection.md @@ -0,0 +1,351 @@ +# Interface: Image360Collection + +A wrapper that represents a set of 360 images. + +## Properties + +### id + +> `readonly` **id**: `string` + +The id of the collection. + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L69) + +*** + +### image360Entities + +> `readonly` **image360Entities**: [`Image360`](Image360.md)[] + +A list containing all the 360 images in this set. + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:80](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L80) + +*** + +### label + +> `readonly` **label**: `undefined` \| `string` + +The label of the collection. + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:75](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L75) + +*** + +### 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:86](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L86) + +## Methods + +### findImageAnnotations() + +> **findImageAnnotations**(`filter`): `Promise` \<[`Image360AnnotationAssetQueryResult`](../type-aliases/Image360AnnotationAssetQueryResult.md)[]\> + +Find 360 images associated with an asset through CDF annotations + +#### Parameters + +• **filter**: [`Image360AnnotationAssetFilter`](../type-aliases/Image360AnnotationAssetFilter.md) + +#### Returns + +`Promise` \<[`Image360AnnotationAssetQueryResult`](../type-aliases/Image360AnnotationAssetQueryResult.md)[]\> + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:149](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L149) + +*** + +### getAnnotationsInfo() + +> **getAnnotationsInfo**(`source`): `Promise` \<[`AssetAnnotationImage360Info`](../type-aliases/AssetAnnotationImage360Info.md)[]\> + +Get IDs of all CDF assets and related image/revision associated with this +360 image collection through CDF annotations + +#### Parameters + +• **source**: `"assets"` + +#### Returns + +`Promise` \<[`AssetAnnotationImage360Info`](../type-aliases/AssetAnnotationImage360Info.md)[]\> + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:164](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L164) + +*** + +### ~~getAssetIds()~~ + +> **getAssetIds**(): `Promise`\<`IdEither`[]\> + +Get IDs of all CDF assets associated with this 360 image collection through CDF annotations + +#### Returns + +`Promise`\<`IdEither`[]\> + +#### Deprecated + +Use [Image360Collection.getAnnotationsInfo](Image360Collection.md#getannotationsinfo) + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:156](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L156) + +*** + +### getDefaultAnnotationStyle() + +> **getDefaultAnnotationStyle**(): [`Image360AnnotationAppearance`](../type-aliases/Image360AnnotationAppearance.md) + +Get the assigned default style affecting all annotations + +#### Returns + +[`Image360AnnotationAppearance`](../type-aliases/Image360AnnotationAppearance.md) + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:139](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L139) + +*** + +### getIconsVisibility() + +> **getIconsVisibility**(): `boolean` + +Gets visibility of all 360 image icons. + +#### Returns + +`boolean` + +true if all icons are visible, false if all icons are invisible + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:110](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L110) + +*** + +### getModelTransformation() + +> **getModelTransformation**(`out`?): `Matrix4` + +Gets the transformation matrix of the collection + +#### Parameters + +• **out?**: `Matrix4` + +#### Returns + +`Matrix4` + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:97](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L97) + +*** + +### off() + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +Unsubscribes from 360 image dataset event. + +##### Parameters + +• **event**: `"image360Entered"` + +The event type. + +• **callback**: [`Image360EnteredDelegate`](../type-aliases/Image360EnteredDelegate.md) + +Callback function to be unsubscribed. + +##### Returns + +`void` + +##### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:133](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L133) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"image360Exited"` + +• **callback**: [`Image360ExitedDelegate`](../type-aliases/Image360ExitedDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:134](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L134) + +*** + +### on() + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Subscribes to events on 360 Image datasets. There are several event types: +'image360Entered' - Subscribes to a event for entering 360 image mode. +'image360Exited' - Subscribes to events indicating 360 image mode has exited. + +##### Parameters + +• **event**: `"image360Entered"` + +The event type. + +• **callback**: [`Image360EnteredDelegate`](../type-aliases/Image360EnteredDelegate.md) + +Callback to be called when the event is fired. + +##### Returns + +`void` + +##### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:125](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L125) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"image360Exited"` + +• **callback**: [`Image360ExitedDelegate`](../type-aliases/Image360ExitedDelegate.md) + +##### Returns + +`void` + +##### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:126](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L126) + +*** + +### set360IconCullingRestrictions() + +> **set360IconCullingRestrictions**(`radius`, `pointLimit`): `void` + +Specify parameters used to determine the number of icons that are visible when entering 360 Images. + +#### Parameters + +• **radius**: `number` + +Only icons within the given radius will be made visible. + +• **pointLimit**: `number` + +Limit the number of points within the given radius. Points closer to the camera will be prioritized. + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:104](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L104) + +*** + +### setDefaultAnnotationStyle() + +> **setDefaultAnnotationStyle**(`appearance`): `void` + +Assign a default style which affects all annotations + +#### Parameters + +• **appearance**: [`Image360AnnotationAppearance`](../type-aliases/Image360AnnotationAppearance.md) + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:144](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L144) + +*** + +### setIconsVisibility() + +> **setIconsVisibility**(`visible`): `void` + +Set visibility of all 360 image icons. + +#### Parameters + +• **visible**: `boolean` + +If true all icons are made visible according to the active culling scheme. If false all icons are hidden. + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:116](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L116) + +*** + +### setModelTransformation() + +> **setModelTransformation**(`matrix`): `void` + +Sets the transformation matrix to be applied to the collection. + +#### Parameters + +• **matrix**: `Matrix4` + +The transformation matrix to be applied to the collection. + +#### Returns + +`void` + +#### Defined in + +[packages/360-images/src/collection/Image360Collection.ts:92](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L92) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Revision.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Revision.md new file mode 100644 index 00000000000..2da0bf887f8 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Revision.md @@ -0,0 +1,48 @@ +# Interface: Image360Revision + +Interface used to manage historical revisions of [Image360](Image360.md). +One instance represents one specific image revision. + +## Properties + +### date + +> `readonly` **date**: `undefined` \| `Date` + +The date of this revision. Undefined if the revision is undated. + +#### Defined in + +[packages/360-images/src/entity/Image360Revision.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360Revision.ts#L17) + +## Methods + +### getAnnotations() + +> **getAnnotations**(): `Promise` \<[`Image360Annotation`](Image360Annotation.md)[]\> + +The annotations associated with this revision. + +#### Returns + +`Promise` \<[`Image360Annotation`](Image360Annotation.md)[]\> + +#### Defined in + +[packages/360-images/src/entity/Image360Revision.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360Revision.ts#L22) + +*** + +### getPreviewThumbnailUrl() + +> **getPreviewThumbnailUrl**(): `Promise`\<`undefined` \| `string`\> + +Get the thumbnail url for this revision. + +#### Returns + +`Promise`\<`undefined` \| `string`\> + +#### Defined in + +[packages/360-images/src/entity/Image360Revision.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360Revision.ts#L27) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Visualization.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Visualization.md new file mode 100644 index 00000000000..2d823d3cc49 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Image360Visualization.md @@ -0,0 +1,15 @@ +# Interface: Image360Visualization + +Interface to control visualization of a 360 image + +## Properties + +### opacity + +> **opacity**: `number` + +Opaqueness of the 360 image + +#### Defined in + +[packages/360-images/src/entity/Image360Visualization.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360Visualization.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Overlay3D.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Overlay3D.md new file mode 100644 index 00000000000..3038682483d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/Overlay3D.md @@ -0,0 +1,111 @@ +# Interface: Overlay3D\ + +Represents one 3d overlay + +## Type Parameters + +• **ContentType** + +## Methods + +### getColor() + +> **getColor**(): `Color` + +Get the display color of this overlay. + +#### Returns + +`Color` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3D.ts#L30) + +*** + +### getContent() + +> **getContent**(): `ContentType` + +Get the metadata associated with this overlay. + +#### Returns + +`ContentType` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:34](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3D.ts#L34) + +*** + +### getPosition() + +> **getPosition**(): `Vector3` + +Get the position of this overlay. + +#### Returns + +`Vector3` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3D.ts#L22) + +*** + +### getVisible() + +> **getVisible**(): `boolean` + +Get whether this overlay is visible. + +#### Returns + +`boolean` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3D.ts#L18) + +*** + +### setColor() + +> **setColor**(`color`): `void` + +Set the display color of this overlay. + +#### Parameters + +• **color**: `Color` + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3D.ts#L26) + +*** + +### setVisible() + +> **setVisible**(`visible`): `void` + +Set whether this overlay should be visible. + +#### Parameters + +• **visible**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/Overlay3D.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3D.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/OverlayCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/OverlayCollection.md new file mode 100644 index 00000000000..db09b2a16d2 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/interfaces/OverlayCollection.md @@ -0,0 +1,105 @@ +# Interface: OverlayCollection\ + +A set of overlays managed. + +## Type Parameters + +• **ContentType** + +## Methods + +### addOverlays() + +> **addOverlays**(`overlays`): [`Overlay3D`](Overlay3D.md)\<`ContentType`\>[] + +Add overlays to the collection. + +#### Parameters + +• **overlays**: [`OverlayInfo`](../type-aliases/OverlayInfo.md)\<`ContentType`\>[] + +Overlays to add to the collection. + +#### Returns + +[`Overlay3D`](Overlay3D.md)\<`ContentType`\>[] + +The added overlays. + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:47](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/OverlayCollection.ts#L47) + +*** + +### getOverlays() + +> **getOverlays**(): [`Overlay3D`](Overlay3D.md)\<`ContentType`\>[] + +Get all overlays in the collection. + +#### Returns + +[`Overlay3D`](Overlay3D.md)\<`ContentType`\>[] + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:40](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/OverlayCollection.ts#L40) + +*** + +### removeAllOverlays() + +> **removeAllOverlays**(): `void` + +Remove all overlays from the collection. + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/OverlayCollection.ts#L58) + +*** + +### removeOverlays() + +> **removeOverlays**(`overlays`): `void` + +Remove overlays from the collection. + +#### Parameters + +• **overlays**: [`Overlay3D`](Overlay3D.md)\<`ContentType`\>[] + +Overlays to remove from the collection. + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:53](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/OverlayCollection.ts#L53) + +*** + +### setVisibility() + +> **setVisibility**(`visibility`): `void` + +Sets whether overlays in the collection should be visible. + +#### Parameters + +• **visibility**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:63](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/OverlayCollection.ts#L63) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisGizmoOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisGizmoOptions.md new file mode 100644 index 00000000000..686cc2dd045 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisGizmoOptions.md @@ -0,0 +1,317 @@ +# Class: AxisGizmoOptions + +**`Beta`** + +Options for styling the AxisGizmoTool + +## Constructors + +### new AxisGizmoOptions() + +> **new AxisGizmoOptions**(): [`AxisGizmoOptions`](AxisGizmoOptions.md) + +**`Beta`** + +#### Returns + +[`AxisGizmoOptions`](AxisGizmoOptions.md) + +## Properties + +### animationDuration + +> **animationDuration**: `number` = `1000` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:33](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L33) + +*** + +### bobbleLineWidth + +> **bobbleLineWidth**: `number` = `2` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L20) + +*** + +### bubbleRadius + +> **bubbleRadius**: `number` = `10` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:16](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L16) + +*** + +### corner + +> **corner**: [`Corner`](../enumerations/Corner.md) = `Corner.BottomRight` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L13) + +*** + +### darkColors + +> **darkColors**: `number`[] + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L32) + +*** + +### focusCircleAlpha + +> **focusCircleAlpha**: `number` = `0.45` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:29](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L29) + +*** + +### focusCircleColor + +> **focusCircleColor**: `string` = `'#888888'` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L28) + +*** + +### fontFamily + +> **fontFamily**: `string` = `'arial'` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:24](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L24) + +*** + +### fontSize + +> **fontSize**: `string` = `'12px'` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:23](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L23) + +*** + +### fontWeight + +> **fontWeight**: `string` = `'bold'` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:25](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L25) + +*** + +### fontYAdjust + +> **fontYAdjust**: `number` = `1` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L30) + +*** + +### insideMargin + +> **insideMargin**: `number` = `8` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L17) + +*** + +### lightColors + +> **lightColors**: `number`[] + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:31](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L31) + +*** + +### normalTextColor + +> **normalTextColor**: `string` = `'#151515'` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L26) + +*** + +### primaryLineWidth + +> **primaryLineWidth**: `number` = `3` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L18) + +*** + +### secondaryLineWidth + +> **secondaryLineWidth**: `number` = `0` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:19](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L19) + +*** + +### selectedTextColor + +> **selectedTextColor**: `string` = `'#FFFFFF'` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L27) + +*** + +### size + +> **size**: `number` = `125` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L12) + +*** + +### useGeoLabels + +> **useGeoLabels**: `boolean` = `true` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L21) + +*** + +### xMargin + +> **xMargin**: `number` = `10` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L14) + +*** + +### yMargin + +> **yMargin**: `number` = `10` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:15](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L15) + +*** + +### yUp + +> **yUp**: `boolean` = `false` + +**`Beta`** + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L22) + +## Accessors + +### radius + +> `get` **radius**(): `number` + +**`Beta`** + +#### Returns + +`number` + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L37) + +## Methods + +### getFont() + +> **getFont**(): `string` + +**`Beta`** + +Get the font style. + +#### Returns + +`string` + +The font style. + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoOptions.ts:44](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoOptions.ts#L44) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisGizmoTool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisGizmoTool.md new file mode 100644 index 00000000000..bbbeef3c69b --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisGizmoTool.md @@ -0,0 +1,124 @@ +# Class: AxisGizmoTool + +**`Beta`** + +Class for axis gizmo like the one in Blender + +## Extends + +- [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Constructors + +### new AxisGizmoTool() + +> **new AxisGizmoTool**(`option`?): [`AxisGizmoTool`](AxisGizmoTool.md) + +**`Beta`** + +#### Parameters + +• **option?**: [`AxisGizmoOptions`](AxisGizmoOptions.md) + +#### Returns + +[`AxisGizmoTool`](AxisGizmoTool.md) + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`constructor`](Cognite3DViewerToolBase.md#constructors) + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoTool.ts:48](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoTool.ts#L48) + +## Accessors + +### options + +> `get` **options**(): [`AxisGizmoOptions`](AxisGizmoOptions.md) + +**`Beta`** + +#### Returns + +[`AxisGizmoOptions`](AxisGizmoOptions.md) + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoTool.ts:100](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoTool.ts#L100) + +## Methods + +### connect() + +> **connect**(`viewer`): `void` + +**`Beta`** + +Connects the AxisGizmoTool to a Cognite3DViewer instance. + +#### Parameters + +• **viewer**: [`Cognite3DViewer`](../../classes/Cognite3DViewer.md) + +The Cognite3DViewer instance to connect to. +Note: After it is connected to the viewer the tool can not be moved or +changed size by changing the fields: size, corner, yMargin and yMargin +in the AxisGizmoOptions + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoTool.ts:84](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoTool.ts#L84) + +*** + +### dispose() + +> **dispose**(): `void` + +**`Beta`** + +#### Returns + +`void` + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`dispose`](Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/AxisGizmo/AxisGizmoTool.ts:60](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisGizmo/AxisGizmoTool.ts#L60) + +*** + +### off() + +> **off**(`event`, `handler`): `void` + +**`Beta`** + +Unregisters an event handler for the 'disposed'-event. + +#### Parameters + +• **event**: `"disposed"` + +• **handler** + +#### Returns + +`void` + +#### Inherited from + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`off`](Cognite3DViewerToolBase.md#off) + +#### Defined in + +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisViewTool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisViewTool.md new file mode 100644 index 00000000000..171b63e1044 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/AxisViewTool.md @@ -0,0 +1,78 @@ +# Class: AxisViewTool + +Base class for tools attaching to a [Cognite3DViewer](../../classes/Cognite3DViewer.md). + +## Extends + +- [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Constructors + +### new AxisViewTool() + +> **new AxisViewTool**(`viewer`, `config`?): [`AxisViewTool`](AxisViewTool.md) + +#### Parameters + +• **viewer**: [`Cognite3DViewer`](../../classes/Cognite3DViewer.md) + +• **config?**: [`AxisBoxConfig`](../type-aliases/AxisBoxConfig.md) + +#### Returns + +[`AxisViewTool`](AxisViewTool.md) + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`constructor`](Cognite3DViewerToolBase.md#constructors) + +#### Defined in + +[packages/tools/src/AxisView/AxisViewTool.ts:39](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L39) + +## Methods + +### dispose() + +> **dispose**(): `void` + +Disposes the element and triggeres the 'disposed' event before clearing the list +of dipose-listeners. + +#### Returns + +`void` + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`dispose`](Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/AxisView/AxisViewTool.ts:63](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L63) + +*** + +### off() + +> **off**(`event`, `handler`): `void` + +Unregisters an event handler for the 'disposed'-event. + +#### Parameters + +• **event**: `"disposed"` + +• **handler** + +#### Returns + +`void` + +#### Inherited from + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`off`](Cognite3DViewerToolBase.md#off) + +#### Defined in + +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Cognite3DViewerToolBase.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Cognite3DViewerToolBase.md new file mode 100644 index 00000000000..0e247ae44ec --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Cognite3DViewerToolBase.md @@ -0,0 +1,62 @@ +# Class: `abstract` Cognite3DViewerToolBase + +Base class for tools attaching to a [Cognite3DViewer](../../classes/Cognite3DViewer.md). + +## Extended by + +- [`HtmlOverlayTool`](HtmlOverlayTool.md) +- [`DebugCameraTool`](DebugCameraTool.md) +- [`AxisViewTool`](AxisViewTool.md) +- [`AxisGizmoTool`](AxisGizmoTool.md) +- [`Overlay3DTool`](Overlay3DTool.md) +- [`TimelineTool`](TimelineTool.md) +- [`MeasurementTool`](MeasurementTool.md) + +## Constructors + +### new Cognite3DViewerToolBase() + +> **new Cognite3DViewerToolBase**(): [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +#### Returns + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Methods + +### dispose() + +> **dispose**(): `void` + +Disposes the element and triggeres the 'disposed' event before clearing the list +of dipose-listeners. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Cognite3DViewerToolBase.ts:53](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L53) + +*** + +### off() + +> **off**(`event`, `handler`): `void` + +Unregisters an event handler for the 'disposed'-event. + +#### Parameters + +• **event**: `"disposed"` + +• **handler** + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/DebugCameraTool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/DebugCameraTool.md new file mode 100644 index 00000000000..afc0183ba17 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/DebugCameraTool.md @@ -0,0 +1,105 @@ +# Class: DebugCameraTool + +Base class for tools attaching to a [Cognite3DViewer](../../classes/Cognite3DViewer.md). + +## Extends + +- [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Constructors + +### new DebugCameraTool() + +> **new DebugCameraTool**(`viewer`): [`DebugCameraTool`](DebugCameraTool.md) + +#### Parameters + +• **viewer**: [`Cognite3DViewer`](../../classes/Cognite3DViewer.md) + +#### Returns + +[`DebugCameraTool`](DebugCameraTool.md) + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`constructor`](Cognite3DViewerToolBase.md#constructors) + +#### Defined in + +[packages/tools/src/DebugCameraTool.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/DebugCameraTool.ts#L20) + +## Methods + +### dispose() + +> **dispose**(): `void` + +**`Override`** + +Removes all elements and detaches from the viewer. + +#### Returns + +`void` + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`dispose`](Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/DebugCameraTool.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/DebugCameraTool.ts#L32) + +*** + +### hideCameraHelper() + +> **hideCameraHelper**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/DebugCameraTool.ts:43](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/DebugCameraTool.ts#L43) + +*** + +### off() + +> **off**(`event`, `handler`): `void` + +Unregisters an event handler for the 'disposed'-event. + +#### Parameters + +• **event**: `"disposed"` + +• **handler** + +#### Returns + +`void` + +#### Inherited from + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`off`](Cognite3DViewerToolBase.md#off) + +#### Defined in + +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) + +*** + +### showCameraHelper() + +> **showCameraHelper**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/DebugCameraTool.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/DebugCameraTool.ts#L37) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/HtmlOverlayTool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/HtmlOverlayTool.md new file mode 100644 index 00000000000..c98794d26be --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/HtmlOverlayTool.md @@ -0,0 +1,236 @@ +# Class: HtmlOverlayTool + +Manages HTMLoverlays for [Cognite3DViewer](../../classes/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. + +Attached elements *must* have CSS style 'position: absolute'. It's also recommended +in most cases to have styles 'pointer-events: none' and 'touch-action: none' to avoid +interfering with 3D navigation. Consider also applying 'transform: translate(-50%, -50%)' +to anchor the center of the element rather than the top-left corner. In some cases the +`zIndex`-attribute is necessary for the element to appear on top of the viewer. + +## Example + +```js +const el = document.createElement('div'); +el.style.position = 'absolute'; // Required! +// Anchor to center of element +el.style.transform = 'translate(-50%, -50%)'; +// Avoid being target for events +el.style.pointerEvents = 'none; +el.style.touchAction = 'none'; +// Render in front of other elements +el.style.zIndex = 10; + +el.style.color = 'red'; +el.innerHtml = '

Overlay

'; + +const overlayTool = new HtmlOverlayTool(viewer); +overlayTool.add(el, new THREE.Vector3(10, 10, 10)); +// ... +overlayTool.remove(el); +// or, to remove all attached elements +overlayTool.clear(); + +// detach the tool from the viewer +overlayTool.dispose(); +``` + +## Extends + +- [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Constructors + +### new HtmlOverlayTool() + +> **new HtmlOverlayTool**(`viewer`, `options`?): [`HtmlOverlayTool`](HtmlOverlayTool.md) + +#### Parameters + +• **viewer**: [`Cognite3DViewer`](../../classes/Cognite3DViewer.md) + +• **options?**: [`HtmlOverlayToolOptions`](../type-aliases/HtmlOverlayToolOptions.md) + +#### Returns + +[`HtmlOverlayTool`](HtmlOverlayTool.md) + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`constructor`](Cognite3DViewerToolBase.md#constructors) + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:172](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L172) + +## Accessors + +### elements + +> `get` **elements**(): `object`[] + +Returns all added HTML elements along with their 3D positions. + +#### Returns + +`object`[] + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:192](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L192) + +## Methods + +### add() + +> **add**(`htmlElement`, `position3D`, `options`): `void` + +Registers a HTML overlay that will be updated on rendering. + +#### Parameters + +• **htmlElement**: `HTMLElement` + +• **position3D**: `Vector3` + +• **options**: [`HtmlOverlayOptions`](../type-aliases/HtmlOverlayOptions.md) = `{}` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:216](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L216) + +*** + +### clear() + +> **clear**(): `void` + +Removes all attached HTML overlay elements. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:266](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L266) + +*** + +### dispose() + +> **dispose**(): `void` + +**`Override`** + +Removes all elements and detaches from the viewer. + +#### Returns + +`void` + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`dispose`](Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:202](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L202) + +*** + +### forceUpdate() + +> **forceUpdate**(`customCamera`?): `void` + +Updates positions of all overlays. This is automatically managed and there +shouldn't be any reason to trigger this unless the attached elements are +modified externally. + +Calling this function often might cause degraded performance. + +#### Parameters + +• **customCamera?**: `PerspectiveCamera` + +Optional camera to be used in place of viewerCamera when calculating positions + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:301](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L301) + +*** + +### off() + +> **off**(`event`, `handler`): `void` + +Unregisters an event handler for the 'disposed'-event. + +#### Parameters + +• **event**: `"disposed"` + +• **handler** + +#### Returns + +`void` + +#### Inherited from + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`off`](Cognite3DViewerToolBase.md#off) + +#### Defined in + +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) + +*** + +### remove() + +> **remove**(`htmlElement`): `void` + +Removes a overlay and removes it from the DOM. + +#### Parameters + +• **htmlElement**: `HTMLElement` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:254](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L254) + +*** + +### visible() + +> **visible**(`enable`): `void` + +Hide/unhide all HTML overlay elements. + +#### Parameters + +• **enable**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:278](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L278) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Keyframe.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Keyframe.md new file mode 100644 index 00000000000..26311d1e4de --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Keyframe.md @@ -0,0 +1,122 @@ +# Class: Keyframe + +Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline + +## Constructors + +### new Keyframe() + +> **new Keyframe**(`model`, `date`): [`Keyframe`](Keyframe.md) + +#### Parameters + +• **model**: [`CogniteCadModel`](../../classes/CogniteCadModel.md) + +• **date**: `Date` + +#### Returns + +[`Keyframe`](Keyframe.md) + +#### Defined in + +[packages/tools/src/Timeline/Keyframe.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/Keyframe.ts#L17) + +## Methods + +### activate() + +> **activate**(): `void` + +Assigns the styles for the node set for the model for this Keyframe + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/Keyframe.ts:33](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/Keyframe.ts#L33) + +*** + +### assignStyledNodeCollection() + +> **assignStyledNodeCollection**(`nodeCollection`, `nodeAppearance`): `void` + +Add node & style to the collection. If the collection has been added, the style is updated to the +appearance provided. + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](../../classes/NodeCollection.md) + +Node set to apply the Styles + +• **nodeAppearance**: [`NodeAppearance`](../../type-aliases/NodeAppearance.md) + +Style to assign to the node collection + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/Keyframe.ts:54](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/Keyframe.ts#L54) + +*** + +### deactivate() + +> **deactivate**(): `void` + +Removes the style for the model + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/Keyframe.ts:42](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/Keyframe.ts#L42) + +*** + +### getKeyframeDate() + +> **getKeyframeDate**(): `Date` + +Get date of the Keyframe + +#### Returns + +`Date` + +date + +#### Defined in + +[packages/tools/src/Timeline/Keyframe.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/Keyframe.ts#L26) + +*** + +### unassignStyledNodeCollection() + +> **unassignStyledNodeCollection**(`nodeCollection`): `void` + +Remove Node & Style for this keyframe's nodeCollection and nodeAppearance + +#### Parameters + +• **nodeCollection**: [`NodeCollection`](../../classes/NodeCollection.md) + +Nodes to be unassign from node collection + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/Keyframe.ts:69](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/Keyframe.ts#L69) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/MeasurementTool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/MeasurementTool.md new file mode 100644 index 00000000000..c3958f264d2 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/MeasurementTool.md @@ -0,0 +1,577 @@ +# Class: MeasurementTool + +Enables [Cognite3DViewer](../../classes/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 +user to customise the measuring units based on their convinience with the callback. + +## Examples + +```js +const measurementTool = new MeasurementTool(viewer); +measurementTool.enterMeasurementMode(); +// ... +measurementTool.exitMeasurementMode(); + +// detach the tool from the viewer +measurementTool.dispose(); +``` + +```js +const measurementTool = new MeasurementTool(viewer, {distanceToLabelCallback: (distanceInMeters) => { + // 1 meters = 3.281 feet + const distancesInFeet = distanceInMeters * 3.281; + return { distanceInMeters: distancesInFeet, units: 'ft'}; + }}); + measurementTool.enterMeasurementMode(); +``` + +## Extends + +- [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Constructors + +### new MeasurementTool() + +> **new MeasurementTool**(`viewer`, `options`?): [`MeasurementTool`](MeasurementTool.md) + +#### Parameters + +• **viewer**: [`Cognite3DViewer`](../../classes/Cognite3DViewer.md) + +• **options?**: [`MeasurementOptions`](../type-aliases/MeasurementOptions.md) + +#### Returns + +[`MeasurementTool`](MeasurementTool.md) + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`constructor`](Cognite3DViewerToolBase.md#constructors) + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:93](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L93) + +## Accessors + +### isInMeasurementMode + +> `get` **isInMeasurementMode**(): `boolean` + +Returns measurement mode state, is measurement mode started or ended. + +#### Returns + +`boolean` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:56](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L56) + +## Methods + +### addMeasurement() + +> **addMeasurement**(`startPoint`, `endPoint`): [`Measurement`](../type-aliases/Measurement.md) + +Adds a measurement directly. E.g. to restore a previous state programatically + +#### Parameters + +• **startPoint**: `Vector3` + +• **endPoint**: `Vector3` + +#### Returns + +[`Measurement`](../type-aliases/Measurement.md) + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:288](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L288) + +*** + +### dispose() + +> **dispose**(): `void` + +Dispose Measurement Tool. + +#### Returns + +`void` + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`dispose`](Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:396](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L396) + +*** + +### enterMeasurementMode() + +> **enterMeasurementMode**(): `void` + +Enter into point to point measurement mode. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:237](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L237) + +*** + +### exitMeasurementMode() + +> **exitMeasurementMode**(): `void` + +Exit measurement mode. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:255](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L255) + +*** + +### getAllMeasurements() + +> **getAllMeasurements**(): [`Measurement`](../type-aliases/Measurement.md)[] + +Get all measurements from [Cognite3DViewer](../../classes/Cognite3DViewer.md). + +#### Returns + +[`Measurement`](../type-aliases/Measurement.md)[] + +Array of Measurements containing Id, start point, end point & measured distance. + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:375](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L375) + +*** + +### off() + +Unsubscribe to the Measurement event + +#### Param + +`MeasurementEvents` event + +#### Param + +Callback to measurements events + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"disposed"` + +• **callback**: [`DisposedDelegate`](../../type-aliases/DisposedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`off`](Cognite3DViewerToolBase.md#off) + +##### Example + +```js +measurementTool.off('disposed', onMeasurementDispose); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:181](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L181) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"added"` + +• **callback**: [`MeasurementAddedDelegate`](../type-aliases/MeasurementAddedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.off` + +##### Example + +```js +measurementTool.off('added', onMeasurementAdded); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:189](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L189) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"started"` + +• **callback**: [`MeasurementStartedDelegate`](../type-aliases/MeasurementStartedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.off` + +##### Example + +```js +measurementTool.off('started', onMeasurementStarted); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:197](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L197) + +#### off(event, callback) + +> **off**(`event`, `callback`): `void` + +##### Parameters + +• **event**: `"ended"` + +• **callback**: [`MeasurementEndedDelegate`](../type-aliases/MeasurementEndedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.off` + +##### Example + +```js +measurementTool.off('ended', onMeasurementEnded); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:205](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L205) + +*** + +### on() + +Subscribe to the Measurement events + +#### Param + +`MeasurementEvents` event + +#### Param + +Callback to measurements events + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Triggered when the tool is disposed. Listeners should clean up any +resources held and remove the reference to the tool. + +##### Parameters + +• **event**: `"disposed"` + +• **callback**: [`DisposedDelegate`](../../type-aliases/DisposedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.on` + +##### Example + +```js +measurementTool.on('disposed', onMeasurementDispose); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:119](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L119) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Triggered when a measurement is added into the Cognite3DViewer. + +##### Parameters + +• **event**: `"added"` + +• **callback**: [`MeasurementAddedDelegate`](../type-aliases/MeasurementAddedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.on` + +##### Example + +```js +measurementTool.on('added', onMeasurementAdded); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:128](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L128) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Triggered when a measurement mode is started. + +##### Parameters + +• **event**: `"started"` + +• **callback**: [`MeasurementStartedDelegate`](../type-aliases/MeasurementStartedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.on` + +##### Example + +```js +measurementTool.on('started', onMeasurementStarted); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:137](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L137) + +#### on(event, callback) + +> **on**(`event`, `callback`): `void` + +Triggered when measurement mode is ended. + +##### Parameters + +• **event**: `"ended"` + +• **callback**: [`MeasurementEndedDelegate`](../type-aliases/MeasurementEndedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.on` + +##### Example + +```js +measurementTool.on('ended', onMeasurementEnded); +``` + +##### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:146](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L146) + +*** + +### removeAllMeasurements() + +> **removeAllMeasurements**(): `void` + +Removes all measurements from the Cognite3DViewer. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:308](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L308) + +*** + +### removeMeasurement() + +> **removeMeasurement**(`measurement`): `void` + +Removes a measurement from the Cognite3DViewer. + +#### Parameters + +• **measurement**: [`Measurement`](../type-aliases/Measurement.md) + +Measurement to be removed from Cognite3DViewer. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:273](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L273) + +*** + +### setLineOptions() + +> **setLineOptions**(`options`): `void` + +Sets Measurement line width, color and label units value for the next measurment. + +#### Parameters + +• **options**: [`MeasurementOptions`](../type-aliases/MeasurementOptions.md) + +MeasurementOptions to set line width, color and callback for custom operation on measurement labels. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:332](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L332) + +*** + +### setMeasurementLabelsVisible() + +> **setMeasurementLabelsVisible**(`enable`): `void` + +Sets the visiblity of labels in the Measurement. + +#### Parameters + +• **enable**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:321](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L321) + +*** + +### updateLineColor() + +> **updateLineColor**(`measurement`, `color`): `void` + +Update selected line color. + +#### Parameters + +• **measurement**: [`Measurement`](../type-aliases/Measurement.md) + +Measurement to be updated. + +• **color**: `Color` + +Color of the measuring line. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:360](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L360) + +*** + +### updateLineWidth() + +> **updateLineWidth**(`measurement`, `lineWidth`): `void` + +Update selected line width. + +#### Parameters + +• **measurement**: [`Measurement`](../type-aliases/Measurement.md) + +Measurement to be updated. + +• **lineWidth**: `number` + +Width of the measuring line. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:344](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L344) + +*** + +### visible() + +> **visible**(`enable`): `void` + +Hide/unhide all measurements + +#### Parameters + +• **enable**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Measurement/MeasurementTool.ts:383](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L383) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Overlay3DTool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Overlay3DTool.md new file mode 100644 index 00000000000..91f43d58258 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/Overlay3DTool.md @@ -0,0 +1,354 @@ +# Class: Overlay3DTool\ + +Tool for adding and interacting with 2D overlays positioned at points in + +## Extends + +- [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Type Parameters + +• **ContentType** = [`DefaultOverlay3DContentType`](../../type-aliases/DefaultOverlay3DContentType.md) + +## Constructors + +### new Overlay3DTool() + +> **new Overlay3DTool**\<`ContentType`\>(`viewer`, `toolParameters`?): [`Overlay3DTool`](Overlay3DTool.md)\<`ContentType`\> + +#### Parameters + +• **viewer**: [`Cognite3DViewer`](../../classes/Cognite3DViewer.md) + +• **toolParameters?**: [`Overlay3DToolParameters`](../type-aliases/Overlay3DToolParameters.md) + +#### Returns + +[`Overlay3DTool`](Overlay3DTool.md)\<`ContentType`\> + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`constructor`](Cognite3DViewerToolBase.md#constructors) + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:97](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L97) + +## Methods + +### clear() + +> **clear**(): `void` + +Removes all overlays. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:193](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L193) + +*** + +### createOverlayCollection() + +> **createOverlayCollection**(`overlays`?, `options`?): [`OverlayCollection`](../../interfaces/OverlayCollection.md)\<`ContentType`\> + +Creates new OverlayCollection. + +#### Parameters + +• **overlays?**: [`OverlayInfo`](../../type-aliases/OverlayInfo.md)\<`ContentType`\>[] + +Array of overlays to add. + +• **options?**: [`OverlayCollectionOptions`](../type-aliases/OverlayCollectionOptions.md) + +#### Returns + +[`OverlayCollection`](../../interfaces/OverlayCollection.md)\<`ContentType`\> + +Overlay group containing it's id. + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:114](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L114) + +*** + +### dispose() + +> **dispose**(): `void` + +Dispose of resources used by this tool + +#### Returns + +`void` + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`dispose`](Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:249](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L249) + +*** + +### getCollections() + +> **getCollections**(): [`OverlayCollection`](../../interfaces/OverlayCollection.md)\<`ContentType`\>[] + +Gets all added overlay collections. + +#### Returns + +[`OverlayCollection`](../../interfaces/OverlayCollection.md)\<`ContentType`\>[] + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:152](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L152) + +*** + +### getTextOverlayVisible() + +> **getTextOverlayVisible**(): `boolean` + +Gets whether text overlay is visible. + +#### Returns + +`boolean` + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:186](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L186) + +*** + +### getVisible() + +> **getVisible**(): `boolean` + +Gets whether overlays are visible. + +#### Returns + +`boolean` + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:171](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L171) + +*** + +### off() + +#### off(event, eventHandler) + +> **off**(`event`, `eventHandler`): `void` + +Unregisters an event handler for the 'disposed'-event. + +##### Parameters + +• **event**: `"hover"` + +• **eventHandler**: [`OverlayEventHandler`](../type-aliases/OverlayEventHandler.md)\<`ContentType`\> + +##### Returns + +`void` + +##### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`off`](Cognite3DViewerToolBase.md#off) + +##### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:226](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L226) + +#### off(event, eventHandler) + +> **off**(`event`, `eventHandler`): `void` + +##### Parameters + +• **event**: `"click"` + +• **eventHandler**: [`OverlayEventHandler`](../type-aliases/OverlayEventHandler.md)\<`ContentType`\> + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.off` + +##### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:227](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L227) + +#### off(event, eventHandler) + +> **off**(`event`, `eventHandler`): `void` + +##### Parameters + +• **event**: `"disposed"` + +• **eventHandler**: [`DisposedDelegate`](../../type-aliases/DisposedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.off` + +##### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:228](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L228) + +*** + +### on() + +#### on(event, eventHandler) + +> **on**(`event`, `eventHandler`): `void` + +Subscribes to overlay events. + +##### Parameters + +• **event**: `"hover"` + +event to subscribe to. + +• **eventHandler**: [`OverlayEventHandler`](../type-aliases/OverlayEventHandler.md)\<`ContentType`\> + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.on` + +##### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:206](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L206) + +#### on(event, eventHandler) + +> **on**(`event`, `eventHandler`): `void` + +##### Parameters + +• **event**: `"click"` + +• **eventHandler**: [`OverlayEventHandler`](../type-aliases/OverlayEventHandler.md)\<`ContentType`\> + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.on` + +##### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:207](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L207) + +#### on(event, eventHandler) + +> **on**(`event`, `eventHandler`): `void` + +##### Parameters + +• **event**: `"disposed"` + +• **eventHandler**: [`DisposedDelegate`](../../type-aliases/DisposedDelegate.md) + +##### Returns + +`void` + +##### Overrides + +`Cognite3DViewerToolBase.on` + +##### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:208](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L208) + +*** + +### removeOverlayCollection() + +> **removeOverlayCollection**(`overlayCollection`): `void` + +Removes overlays that were added with addOverlays method. + +#### Parameters + +• **overlayCollection**: [`OverlayCollection`](../../interfaces/OverlayCollection.md)\<`ContentType`\> + +Id of the overlay group to remove. + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:137](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L137) + +*** + +### setTextOverlayVisible() + +> **setTextOverlayVisible**(`visible`): `void` + +Sets whether text overlay is visible. +Default is false. + +#### Parameters + +• **visible**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:179](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L179) + +*** + +### setVisible() + +> **setVisible**(`visible`): `void` + +Sets whether overlays are visible. + +#### Parameters + +• **visible**: `boolean` + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:159](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L159) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/TimelineTool.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/TimelineTool.md new file mode 100644 index 00000000000..7bdcc4b35bf --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/classes/TimelineTool.md @@ -0,0 +1,310 @@ +# Class: TimelineTool + +Tool to applying styles to nodes based on date to play them over in Timeline + +## Extends + +- [`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) + +## Constructors + +### new TimelineTool() + +> **new TimelineTool**(`cadModel`): [`TimelineTool`](TimelineTool.md) + +#### Parameters + +• **cadModel**: [`CogniteCadModel`](../../classes/CogniteCadModel.md) + +#### Returns + +[`TimelineTool`](TimelineTool.md) + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`constructor`](Cognite3DViewerToolBase.md#constructors) + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L22) + +## Methods + +### createKeyframe() + +> **createKeyframe**(`date`): [`Keyframe`](Keyframe.md) + +Create Key frame for the Timeline + +#### Parameters + +• **date**: `Date` + +date value by Date.now() since January 1, 1970 + +#### Returns + +[`Keyframe`](Keyframe.md) + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:63](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L63) + +*** + +### dispose() + +> **dispose**(): `void` + +Disposes the element and triggeres the 'disposed' event before clearing the list +of dipose-listeners. + +#### Returns + +`void` + +#### Overrides + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`dispose`](Cognite3DViewerToolBase.md#dispose) + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:184](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L184) + +*** + +### getAllKeyframes() + +> **getAllKeyframes**(): [`Keyframe`](Keyframe.md)[] + +Provides all Keyframes in the Timeline + +#### Returns + +[`Keyframe`](Keyframe.md)[] + +All Keyframes in Timeline + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:180](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L180) + +*** + +### getKeyframeByDate() + +> **getKeyframeByDate**(`date`): `undefined` \| [`Keyframe`](Keyframe.md) + +Returns the keyframe at the date given, or undefined if not found. + +#### Parameters + +• **date**: `Date` + +#### Returns + +`undefined` \| [`Keyframe`](Keyframe.md) + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:76](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L76) + +*** + +### off() + +> **off**(`event`, `handler`): `void` + +Unregisters an event handler for the 'disposed'-event. + +#### Parameters + +• **event**: `"disposed"` + +• **handler** + +#### Returns + +`void` + +#### Inherited from + +[`Cognite3DViewerToolBase`](Cognite3DViewerToolBase.md) . [`off`](Cognite3DViewerToolBase.md#off) + +#### Defined in + +[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) + +*** + +### pause() + +> **pause**(): `void` + +Pause any ongoing playback + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:161](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L161) + +*** + +### play() + +> **play**(`startDate`, `endDate`, `totalDurationInMilliSeconds`): `void` + +Starts playback of Timeline + +#### Parameters + +• **startDate**: `Date` + +Keyframe date to start the Playback of Keyframes + +• **endDate**: `Date` + +Keyframe date to stop the Playback of Keyframes + +• **totalDurationInMilliSeconds**: `number` + +Number of milliseconds for all Keyframe within startDate & endDate to be rendered + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:110](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L110) + +*** + +### removeKeyframe() + +> **removeKeyframe**(`keyframe`): `void` + +Removes the Keyframe from the timeline. Does nothing if the keyframe isn't part of the timeline. + +#### Parameters + +• **keyframe**: [`Keyframe`](Keyframe.md) + +Keyframe to be removed from the timeline + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:84](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L84) + +*** + +### removeKeyframeByDate() + +> **removeKeyframeByDate**(`date`): `void` + +Removes the Keyframe from the Timeline + +#### Parameters + +• **date**: `Date` + +Date of the Keyframe to be removed from the Timeline + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:96](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L96) + +*** + +### resume() + +> **resume**(): `void` + +Resume any paused playback + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:170](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L170) + +*** + +### stop() + +> **stop**(): `void` + +Stops any ongoing playback + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:151](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L151) + +*** + +### subscribe() + +> **subscribe**(`event`, `listener`): `void` + +Subscribe to the Date changed event + +#### Parameters + +• **event**: `"dateChanged"` + +`dateChanged` event + +• **listener**: [`TimelineDateUpdateDelegate`](../type-aliases/TimelineDateUpdateDelegate.md) + +Listen to Timeline date Update during Playback + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:34](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L34) + +*** + +### unsubscribe() + +> **unsubscribe**(`event`, `listener`): `void` + +Unsubscribe to the Date changed event + +#### Parameters + +• **event**: `"dateChanged"` + +`dateChanged` event + +• **listener**: [`TimelineDateUpdateDelegate`](../type-aliases/TimelineDateUpdateDelegate.md) + +Remove Listen to Timeline date Update + +#### Returns + +`void` + +#### Defined in + +[packages/tools/src/Timeline/TimelineTool.ts:49](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/TimelineTool.ts#L49) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/enumerations/Corner.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/enumerations/Corner.md new file mode 100644 index 00000000000..d10ab3060b1 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/enumerations/Corner.md @@ -0,0 +1,43 @@ +# Enumeration: Corner + +A corner of the anything. + +## Enumeration Members + +### BottomLeft + +> **BottomLeft**: `2` + +#### Defined in + +[packages/tools/src/utilities/Corner.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/utilities/Corner.ts#L12) + +*** + +### BottomRight + +> **BottomRight**: `3` + +#### Defined in + +[packages/tools/src/utilities/Corner.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/utilities/Corner.ts#L13) + +*** + +### TopLeft + +> **TopLeft**: `1` + +#### Defined in + +[packages/tools/src/utilities/Corner.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/utilities/Corner.ts#L11) + +*** + +### TopRight + +> **TopRight**: `0` + +#### Defined in + +[packages/tools/src/utilities/Corner.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/utilities/Corner.ts#L10) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/index.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/index.md new file mode 100644 index 00000000000..089b290ddbf --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/index.md @@ -0,0 +1,44 @@ +# @cognite/reveal/tools + +## Index + +### Enumerations + +- [Corner](enumerations/Corner.md) + +### Classes + +- [AxisGizmoOptions](classes/AxisGizmoOptions.md) +- [AxisGizmoTool](classes/AxisGizmoTool.md) +- [AxisViewTool](classes/AxisViewTool.md) +- [Cognite3DViewerToolBase](classes/Cognite3DViewerToolBase.md) +- [DebugCameraTool](classes/DebugCameraTool.md) +- [HtmlOverlayTool](classes/HtmlOverlayTool.md) +- [Keyframe](classes/Keyframe.md) +- [MeasurementTool](classes/MeasurementTool.md) +- [Overlay3DTool](classes/Overlay3DTool.md) +- [TimelineTool](classes/TimelineTool.md) + +### Type Aliases + +- [AbsolutePosition](type-aliases/AbsolutePosition.md) +- [AxisBoxCompassConfig](type-aliases/AxisBoxCompassConfig.md) +- [AxisBoxConfig](type-aliases/AxisBoxConfig.md) +- [AxisBoxFaceConfig](type-aliases/AxisBoxFaceConfig.md) +- [DistanceToLabelDelegate](type-aliases/DistanceToLabelDelegate.md) +- [HtmlOverlayCreateClusterDelegate](type-aliases/HtmlOverlayCreateClusterDelegate.md) +- [HtmlOverlayOptions](type-aliases/HtmlOverlayOptions.md) +- [HtmlOverlayPositionUpdatedDelegate](type-aliases/HtmlOverlayPositionUpdatedDelegate.md) +- [HtmlOverlayToolClusteringOptions](type-aliases/HtmlOverlayToolClusteringOptions.md) +- [HtmlOverlayToolOptions](type-aliases/HtmlOverlayToolOptions.md) +- [Measurement](type-aliases/Measurement.md) +- [MeasurementAddedDelegate](type-aliases/MeasurementAddedDelegate.md) +- [MeasurementEndedDelegate](type-aliases/MeasurementEndedDelegate.md) +- [MeasurementOptions](type-aliases/MeasurementOptions.md) +- [MeasurementStartedDelegate](type-aliases/MeasurementStartedDelegate.md) +- [Overlay3DToolParameters](type-aliases/Overlay3DToolParameters.md) +- [OverlayCollectionOptions](type-aliases/OverlayCollectionOptions.md) +- [OverlayEventHandler](type-aliases/OverlayEventHandler.md) +- [OverlayToolEvent](type-aliases/OverlayToolEvent.md) +- [RelativePosition](type-aliases/RelativePosition.md) +- [TimelineDateUpdateDelegate](type-aliases/TimelineDateUpdateDelegate.md) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AbsolutePosition.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AbsolutePosition.md new file mode 100644 index 00000000000..639d935e0d2 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AbsolutePosition.md @@ -0,0 +1,19 @@ +# Type Alias: AbsolutePosition + +> **AbsolutePosition**: `object` + +Absolute position in pixels. + +## Type declaration + +### xAbsolute + +> **xAbsolute**: `number` + +### yAbsolute + +> **yAbsolute**: `number` + +## Defined in + +[packages/tools/src/AxisView/types.ts:49](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisView/types.ts#L49) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxCompassConfig.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxCompassConfig.md new file mode 100644 index 00000000000..a778a648129 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxCompassConfig.md @@ -0,0 +1,36 @@ +# Type Alias: AxisBoxCompassConfig + +> **AxisBoxCompassConfig**: `object` + +Configuration of the compass. + +## Type declaration + +### fontColor? + +> `optional` **fontColor**: `THREE.Color` + +### fontSize? + +> `optional` **fontSize**: `number` + +### labelDelta? + +> `optional` **labelDelta**: `number` + +Offset in radians of the orientation indicator. + +### ringLabel? + +> `optional` **ringLabel**: `string` + +Label of the orientation indicator. Defaults +to 'N' for north. + +### tickColor? + +> `optional` **tickColor**: `THREE.Color` + +## Defined in + +[packages/tools/src/AxisView/types.ts:81](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisView/types.ts#L81) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxConfig.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxConfig.md new file mode 100644 index 00000000000..33a23fd4864 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxConfig.md @@ -0,0 +1,69 @@ +# Type Alias: AxisBoxConfig + +> **AxisBoxConfig**: `object` + +Configuration of [AxisViewTool](../classes/AxisViewTool.md). + +## Type declaration + +### animationSpeed? + +> `optional` **animationSpeed**: `number` + +How long the camera animation lasts when +clicking a face of the orientation box. + +### compass? + +> `optional` **compass**: [`AxisBoxCompassConfig`](AxisBoxCompassConfig.md) + +Configuration of the compass "base" of the tool. + +### faces? + +> `optional` **faces**: `object` + +Configuration for each of the faces of the orientation box. +Note that Reveal uses a right-handed Y up coordinate system, +which might differ from the original model space. To account +for this, you might want to reassign labels of the faces. + +### faces.xNegativeFace? + +> `optional` **xNegativeFace**: [`AxisBoxFaceConfig`](AxisBoxFaceConfig.md) + +### faces.xPositiveFace? + +> `optional` **xPositiveFace**: [`AxisBoxFaceConfig`](AxisBoxFaceConfig.md) + +### faces.yNegativeFace? + +> `optional` **yNegativeFace**: [`AxisBoxFaceConfig`](AxisBoxFaceConfig.md) + +### faces.yPositiveFace? + +> `optional` **yPositiveFace**: [`AxisBoxFaceConfig`](AxisBoxFaceConfig.md) + +### faces.zNegativeFace? + +> `optional` **zNegativeFace**: [`AxisBoxFaceConfig`](AxisBoxFaceConfig.md) + +### faces.zPositiveFace? + +> `optional` **zPositiveFace**: [`AxisBoxFaceConfig`](AxisBoxFaceConfig.md) + +### position? + +> `optional` **position**: [`AbsolutePosition`](AbsolutePosition.md) \| [`RelativePosition`](RelativePosition.md) + +Position, either absolute or relative. + +### size? + +> `optional` **size**: `number` + +Size in pixels of the axis tool. + +## Defined in + +[packages/tools/src/AxisView/types.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisView/types.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxFaceConfig.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxFaceConfig.md new file mode 100644 index 00000000000..19058db3a1d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/AxisBoxFaceConfig.md @@ -0,0 +1,37 @@ +# Type Alias: AxisBoxFaceConfig + +> **AxisBoxFaceConfig**: `object` + +Configuration of each face of the orientation box. + +## Type declaration + +### faceColor? + +> `optional` **faceColor**: `THREE.Color` + +### fontColor? + +> `optional` **fontColor**: `THREE.Color` + +### fontSize? + +> `optional` **fontSize**: `number` + +### label? + +> `optional` **label**: `string` + +Label of the respective face, e.g. 'X' or 'Right'. + +### outlineColor? + +> `optional` **outlineColor**: `THREE.Color` + +### outlineSize? + +> `optional` **outlineSize**: `number` + +## Defined in + +[packages/tools/src/AxisView/types.ts:66](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisView/types.ts#L66) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/DistanceToLabelDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/DistanceToLabelDelegate.md new file mode 100644 index 00000000000..d01a2dcf430 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/DistanceToLabelDelegate.md @@ -0,0 +1,17 @@ +# Type Alias: DistanceToLabelDelegate() + +> **DistanceToLabelDelegate**: (`distanceInMeters`) => `string` + +Custom callback for users to change measurement label content. + +## Parameters + +• **distanceInMeters**: `number` + +## Returns + +`string` + +## Defined in + +[packages/tools/src/Measurement/types.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/types.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayCreateClusterDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayCreateClusterDelegate.md new file mode 100644 index 00000000000..939d5890f21 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayCreateClusterDelegate.md @@ -0,0 +1,18 @@ +# Type Alias: HtmlOverlayCreateClusterDelegate() + +> **HtmlOverlayCreateClusterDelegate**: (`overlayElements`) => `HTMLElement` + +Callback that is triggered when a set of overlays are clustered together in +[HtmlOverlayTool](../classes/HtmlOverlayTool.md). + +## Parameters + +• **overlayElements**: `object`[] + +## Returns + +`HTMLElement` + +## Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L32) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayOptions.md new file mode 100644 index 00000000000..0f8ef6932ac --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayOptions.md @@ -0,0 +1,24 @@ +# Type Alias: HtmlOverlayOptions + +> **HtmlOverlayOptions**: `object` + +Options for an overlay added using [HtmlOverlayTool.add](../classes/HtmlOverlayTool.md#add). + +## Type declaration + +### positionUpdatedCallback? + +> `optional` **positionUpdatedCallback**: [`HtmlOverlayPositionUpdatedDelegate`](HtmlOverlayPositionUpdatedDelegate.md) + +Callback that is triggered whenever the position of the overlay is updated. Optional. + +### userData? + +> `optional` **userData**: `any` + +Optional user specified data that is provided to the [HtmlOverlayCreateClusterDelegate](HtmlOverlayCreateClusterDelegate.md) and +[HtmlOverlayPositionUpdatedDelegate](HtmlOverlayPositionUpdatedDelegate.md). + +## Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:42](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L42) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayPositionUpdatedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayPositionUpdatedDelegate.md new file mode 100644 index 00000000000..f9d46f2dad1 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayPositionUpdatedDelegate.md @@ -0,0 +1,26 @@ +# Type Alias: HtmlOverlayPositionUpdatedDelegate() + +> **HtmlOverlayPositionUpdatedDelegate**: (`element`, `position2D`, `position3D`, `distanceToCamera`, `userData`) => `void` + +Callback that is triggered whenever the 2D position of an overlay is updated +in [HtmlOverlayTool](../classes/HtmlOverlayTool.md). + +## Parameters + +• **element**: `HTMLElement` + +• **position2D**: `THREE.Vector2` + +• **position3D**: `THREE.Vector3` + +• **distanceToCamera**: `number` + +• **userData**: `any` + +## Returns + +`void` + +## Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:20](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L20) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolClusteringOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolClusteringOptions.md new file mode 100644 index 00000000000..958cdb7e0ba --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolClusteringOptions.md @@ -0,0 +1,33 @@ +# Type Alias: HtmlOverlayToolClusteringOptions + +> **HtmlOverlayToolClusteringOptions**: `object` + +Controls how close overlay elements are clustered together. + +## Type declaration + +### createClusterElementCallback + +> **createClusterElementCallback**: [`HtmlOverlayCreateClusterDelegate`](HtmlOverlayCreateClusterDelegate.md) + +Callback that is triggered when a set of overlays are clustered together +to create a "composite" element as a placeholder for the clustered elements. +Note that this callback will be triggered every frame for each cluster so it +must be performant. + +### mode + +> **mode**: `"overlapInScreenSpace"` + +Currently only 'overlapInScreenSpace' is supported. In this mode, +overlays are clustered together into a single element as defined by +the HtmlOverlayToolClusteringOptions.createClusterElementCallback and hidden when they overlap +in screen space. The composite element is placed at the midpoint of +all clustered elements. + +Clustered elements are faded in/out using CSS styling `transition`, +`opacity` and `visibility`. + +## Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:57](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L57) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolOptions.md new file mode 100644 index 00000000000..ca60f6bc557 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolOptions.md @@ -0,0 +1,17 @@ +# Type Alias: HtmlOverlayToolOptions + +> **HtmlOverlayToolOptions**: `object` + +Options for the visualization of overlays + +## Type declaration + +### clusteringOptions? + +> `optional` **clusteringOptions**: [`HtmlOverlayToolClusteringOptions`](HtmlOverlayToolClusteringOptions.md) + +Options for clustering the HTML overlays + +## Defined in + +[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:82](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L82) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/Measurement.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/Measurement.md new file mode 100644 index 00000000000..a7bf8eec35f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/Measurement.md @@ -0,0 +1,25 @@ +# Type Alias: Measurement + +> **Measurement**: `object` + +## Type declaration + +### distanceInMeters + +> `readonly` **distanceInMeters**: `number` + +### endPoint + +> `readonly` **endPoint**: `Vector3` + +### measurementId + +> `readonly` **measurementId**: `number` + +### startPoint + +> `readonly` **startPoint**: `Vector3` + +## Defined in + +[packages/tools/src/Measurement/types.ts:7](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/types.ts#L7) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementAddedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementAddedDelegate.md new file mode 100644 index 00000000000..25bc2e64d6f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementAddedDelegate.md @@ -0,0 +1,17 @@ +# Type Alias: MeasurementAddedDelegate() + +> **MeasurementAddedDelegate**: (`measurement`) => `void` + +Delegate for measurement added events. + +## Parameters + +• **measurement**: [`Measurement`](Measurement.md) + +## Returns + +`void` + +## Defined in + +[packages/tools/src/Measurement/types.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/types.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementEndedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementEndedDelegate.md new file mode 100644 index 00000000000..7c160746cf7 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementEndedDelegate.md @@ -0,0 +1,13 @@ +# Type Alias: MeasurementEndedDelegate() + +> **MeasurementEndedDelegate**: () => `void` + +Delegate for measurement ended events. + +## Returns + +`void` + +## Defined in + +[packages/tools/src/Measurement/types.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/types.ts#L32) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementOptions.md new file mode 100644 index 00000000000..85f3328ac19 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementOptions.md @@ -0,0 +1,27 @@ +# Type Alias: MeasurementOptions + +> **MeasurementOptions**: `object` + +Measurement tool option with user custom callback, line width & color. + +## Type declaration + +### color? + +> `optional` **color**: `Color` + +Line color in 32 bit hex. + +### distanceToLabelCallback? + +> `optional` **distanceToLabelCallback**: [`DistanceToLabelDelegate`](DistanceToLabelDelegate.md) + +### lineWidth? + +> `optional` **lineWidth**: `number` + +Line width in cm. Note that the minium drawn line will be ~2 pixels. + +## Defined in + +[packages/tools/src/Measurement/types.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/types.ts#L37) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementStartedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementStartedDelegate.md new file mode 100644 index 00000000000..7a9517cf78b --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/MeasurementStartedDelegate.md @@ -0,0 +1,13 @@ +# Type Alias: MeasurementStartedDelegate() + +> **MeasurementStartedDelegate**: () => `void` + +Delegate for measurement started events. + +## Returns + +`void` + +## Defined in + +[packages/tools/src/Measurement/types.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Measurement/types.ts#L27) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/Overlay3DToolParameters.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/Overlay3DToolParameters.md new file mode 100644 index 00000000000..3a462e1d73e --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/Overlay3DToolParameters.md @@ -0,0 +1,25 @@ +# Type Alias: Overlay3DToolParameters + +> **Overlay3DToolParameters**: `object` + +Parameters for instantiating the Overlay3DTool + +## Type declaration + +### defaultOverlayColor + +> **defaultOverlayColor**: `THREE.Color` + +Sets default overlay color for newly added labels. + +### maxPointSize? + +> `optional` **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/Overlay3D/Overlay3DTool.ts:41](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L41) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayCollectionOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayCollectionOptions.md new file mode 100644 index 00000000000..30830242fc3 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayCollectionOptions.md @@ -0,0 +1,36 @@ +# Type Alias: OverlayCollectionOptions + +> **OverlayCollectionOptions**: `object` + +Parameters for instantiating the OverlayCollection. + +## Type declaration + +### defaultOverlayColor? + +> `optional` **defaultOverlayColor**: `THREE.Color` + +Sets default overlay color for newly added overlays. +Default is yellow. + +### overlayTexture? + +> `optional` **overlayTexture**: `THREE.Texture` + +Sets default texture for all overlays of this OverlayCollection. +Must be a square texture, recommended size is at least `maxPointSize` for +not pixelated overlays. + +### overlayTextureMask? + +> `optional` **overlayTextureMask**: `THREE.Texture` + +Sets default mask for all overlays of this OverlayCollection, +denoting where overlay color should be placed compared to texture color. +Must be a square texture with the same size as `overlayTexture`. +Texture should be monochrome. Internally, R channel is used for +denoting pixels that should be colored by texture and not by overlay color. + +## Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:57](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L57) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayEventHandler.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayEventHandler.md new file mode 100644 index 00000000000..37aea15f057 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayEventHandler.md @@ -0,0 +1,31 @@ +# Type Alias: OverlayEventHandler()\ + +> **OverlayEventHandler**\<`ContentType`\>: (`event`) => `void` + +Type for handlers of overlay events + +## Type Parameters + +• **ContentType** + +## Parameters + +• **event** + +• **event.htmlTextOverlay**: `HTMLElement` + +• **event.mousePosition** + +• **event.mousePosition.offsetX**: `number` + +• **event.mousePosition.offsetY**: `number` + +• **event.targetOverlay**: [`Overlay3D`](../../interfaces/Overlay3D.md)\<`ContentType`\> + +## Returns + +`void` + +## Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:32](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L32) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayToolEvent.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayToolEvent.md new file mode 100644 index 00000000000..4f1573ab44d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/OverlayToolEvent.md @@ -0,0 +1,9 @@ +# Type Alias: OverlayToolEvent + +> **OverlayToolEvent**: `"hover"` \| `"click"` \| `"disposed"` + +Events related to overlays + +## Defined in + +[packages/tools/src/Overlay3D/Overlay3DTool.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Overlay3D/Overlay3DTool.ts#L27) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/RelativePosition.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/RelativePosition.md new file mode 100644 index 00000000000..cb0bf89db88 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/RelativePosition.md @@ -0,0 +1,20 @@ +# Type Alias: RelativePosition + +> **RelativePosition**: `object` + +Relative position from a corner of the viewer +and a given padding. + +## Type declaration + +### corner + +> **corner**: [`Corner`](../enumerations/Corner.md) + +### padding + +> **padding**: `THREE.Vector2` + +## Defined in + +[packages/tools/src/AxisView/types.ts:58](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/AxisView/types.ts#L58) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/TimelineDateUpdateDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/TimelineDateUpdateDelegate.md new file mode 100644 index 00000000000..e9b21b17e07 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/tools/type-aliases/TimelineDateUpdateDelegate.md @@ -0,0 +1,25 @@ +# Type Alias: TimelineDateUpdateDelegate() + +> **TimelineDateUpdateDelegate**: (`event`) => `void` + +Delegate for Timeline Date update + +## Parameters + +• **event** + +• **event.activeKeyframe**: [`Keyframe`](../classes/Keyframe.md) \| `undefined` + +• **event.date**: `Date` + +• **event.endDate**: `Date` + +• **event.startDate**: `Date` + +## Returns + +`void` + +## Defined in + +[packages/tools/src/Timeline/types.ts:8](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/tools/src/Timeline/types.ts#L8) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AddImage360Options.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AddImage360Options.md new file mode 100644 index 00000000000..4603b16a86c --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AddImage360Options.md @@ -0,0 +1,33 @@ +# Type Alias: AddImage360Options + +> **AddImage360Options**: `object` + +## Type declaration + +### annotationFilter? + +> `optional` **annotationFilter**: [`Image360AnnotationFilterOptions`](Image360AnnotationFilterOptions.md) + +Annotation options. + +### collectionTransform? + +> `optional` **collectionTransform**: `Matrix4` + +An optional transformation which will be applied to all 360 images that are fetched. + +### preMultipliedRotation? + +> `optional` **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:218](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L218) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AnyIntersection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AnyIntersection.md new file mode 100644 index 00000000000..332b5207bcc --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AnyIntersection.md @@ -0,0 +1,7 @@ +# Type Alias: AnyIntersection + +> **AnyIntersection**: [`CadIntersection`](CadIntersection.md) \| [`PointCloudIntersection`](PointCloudIntersection.md) \| [`CustomObjectIntersection`](CustomObjectIntersection.md) + +## Defined in + +[packages/api/src/public/migration/types.ts:294](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L294) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AssetAnnotationImage360Info.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AssetAnnotationImage360Info.md new file mode 100644 index 00000000000..2ec0f359bc9 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/AssetAnnotationImage360Info.md @@ -0,0 +1,29 @@ +# Type Alias: AssetAnnotationImage360Info + +> **AssetAnnotationImage360Info**: `object` + +Asset search return type, including information about the image in which the asset is found + +## Type declaration + +### annotationInfo + +> **annotationInfo**: [`ImageAssetLinkAnnotationInfo`](ImageAssetLinkAnnotationInfo.md) + +Reference to the relevant asset + +### imageEntity + +> **imageEntity**: [`Image360`](../interfaces/Image360.md) + +The image entity in which the asset was found + +### imageRevision + +> **imageRevision**: [`Image360Revision`](../interfaces/Image360Revision.md) + +The image revision in which the asset was found + +## Defined in + +[packages/360-images/src/collection/Image360Collection.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L28) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/BeforeSceneRenderedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/BeforeSceneRenderedDelegate.md new file mode 100644 index 00000000000..f12392499d2 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/BeforeSceneRenderedDelegate.md @@ -0,0 +1,23 @@ +# Type Alias: BeforeSceneRenderedDelegate() + +> **BeforeSceneRenderedDelegate**: (`event`) => `void` + +Delegate for event triggered when scene is about to be rendered. + +## Parameters + +• **event** + +• **event.camera**: `PerspectiveCamera` + +• **event.frameNumber**: `number` + +• **event.renderer**: `WebGLRenderer` + +## Returns + +`void` + +## Defined in + +[packages/utilities/src/events/types.ts:27](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/types.ts#L27) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CadIntersection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CadIntersection.md new file mode 100644 index 00000000000..f8f5c78280b --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CadIntersection.md @@ -0,0 +1,39 @@ +# Type Alias: CadIntersection + +> **CadIntersection**: `object` + +## Type declaration + +### distanceToCamera + +> **distanceToCamera**: `number` + +Distance from the camera to the intersection. + +### model + +> **model**: [`CogniteCadModel`](../classes/CogniteCadModel.md) + +The model that was intersected. + +### point + +> **point**: `Vector3` + +Coordinate of the intersection. + +### treeIndex + +> **treeIndex**: `number` + +Tree index of the intersected 3D node. + +### type + +> **type**: `"cad"` + +The intersection type. + +## Defined in + +[packages/api/src/public/migration/types.ts:234](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L234) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CadModelBudget.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CadModelBudget.md new file mode 100644 index 00000000000..c56f69817d9 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CadModelBudget.md @@ -0,0 +1,28 @@ +# Type Alias: CadModelBudget + +> **CadModelBudget**: `object` + +Represents a measurement of how much geometry can be loaded. + +## Type declaration + +### ~~highDetailProximityThreshold~~ + +> `readonly` **highDetailProximityThreshold**: `number` + +Sectors within this distance from the camera will always be loaded in high details. + +#### Deprecated + +This is only used for 3D models processed prior to the Reveal 3.0 release (Q1 2022). + +### maximumRenderCost + +> `readonly` **maximumRenderCost**: `number` + +Maximum render cost. This number can be thought of as triangle count, although the number +doesn't match this directly. + +## Defined in + +[packages/cad-geometry-loaders/src/CadModelBudget.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-geometry-loaders/src/CadModelBudget.ts#L10) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraChangeDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraChangeDelegate.md new file mode 100644 index 00000000000..922ef2eda9e --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraChangeDelegate.md @@ -0,0 +1,17 @@ +# Type Alias: CameraChangeDelegate() + +> **CameraChangeDelegate**: (`position`, `target`) => `void` + +## Parameters + +• **position**: `Vector3` + +• **target**: `Vector3` + +## Returns + +`void` + +## Defined in + +[packages/camera-manager/src/types.ts:62](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/types.ts#L62) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraConfiguration.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraConfiguration.md new file mode 100644 index 00000000000..da37276228c --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraConfiguration.md @@ -0,0 +1,19 @@ +# Type Alias: CameraConfiguration + +> **CameraConfiguration**: `object` + +Represents a camera configuration, consisting of a camera position and target. + +## Type declaration + +### position + +> `readonly` **position**: `Vector3` + +### target + +> `readonly` **target**: `Vector3` + +## Defined in + +[packages/utilities/src/CameraConfiguration.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/CameraConfiguration.ts#L10) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraControlsOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraControlsOptions.md new file mode 100644 index 00000000000..f44a8c97481 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraControlsOptions.md @@ -0,0 +1,42 @@ +# Type Alias: CameraControlsOptions + +> **CameraControlsOptions**: `object` + +## Type declaration + +### changeCameraPositionOnDoubleClick? + +> `optional` **changeCameraPositionOnDoubleClick**: `boolean` + +Enables or disables change of camera position on mouse doubke click. New target is then set to the point of the model under current cursor +position and the a camera position is set half way to this point + +Default is false. + +### changeCameraTargetOnClick? + +> `optional` **changeCameraTargetOnClick**: `boolean` + +Enables or disables change of camera target on mouse click. New target is then set to the point of the model under current cursor position. + +Default is false. + +### mouseWheelAction? + +> `optional` **mouseWheelAction**: `"zoomToTarget"` \| `"zoomPastCursor"` \| `"zoomToCursor"` + +Sets mouse wheel initiated action. + +Modes: + +'zoomToTarget' - zooms just to the current target (center of the screen) of the camera. + +'zoomPastCursor' - zooms in the direction of the ray coming from camera through cursor screen position, allows going through objects. + +'zoomToCursor' - mouse wheel scroll zooms towards the point on the model where cursor is hovering over, doesn't allow going through objects. + +Default is 'zoomPastCursor'. + +## Defined in + +[packages/camera-manager/src/CameraControlsOptions.ts:5](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/CameraControlsOptions.ts#L5) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraEventDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraEventDelegate.md new file mode 100644 index 00000000000..90b3316c350 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraEventDelegate.md @@ -0,0 +1,9 @@ +# Type Alias: CameraEventDelegate + +> **CameraEventDelegate**: [`CameraChangeDelegate`](CameraChangeDelegate.md) \| [`CameraStopDelegate`](CameraStopDelegate.md) + +Union type of all camera event delegates + +## Defined in + +[packages/camera-manager/src/types.ts:73](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/types.ts#L73) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraManagerEventType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraManagerEventType.md new file mode 100644 index 00000000000..3405c29b114 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraManagerEventType.md @@ -0,0 +1,9 @@ +# Type Alias: CameraManagerEventType + +> **CameraManagerEventType**: *typeof* [`CAMERA_MANAGER_EVENT_TYPE_LIST`](../variables/CAMERA_MANAGER_EVENT_TYPE_LIST.md)\[`number`\] + +Union type of the supported camera manager event types + +## Defined in + +[packages/camera-manager/src/types.ts:108](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/types.ts#L108) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraState.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraState.md new file mode 100644 index 00000000000..10be9192c93 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraState.md @@ -0,0 +1,28 @@ +# Type Alias: CameraState + +> **CameraState**: `object` + +## Type declaration + +### position? + +> `optional` **position**: `Vector3` + +Camera position in world space. + +### rotation? + +> `optional` **rotation**: `Quaternion` + +Camera local rotation in quaternion form. + +### target? + +> `optional` **target**: `Vector3` + +Camera target in world space. +* + +## Defined in + +[packages/camera-manager/src/types.ts:43](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/types.ts#L43) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraStopDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraStopDelegate.md new file mode 100644 index 00000000000..a1cd2a2798d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CameraStopDelegate.md @@ -0,0 +1,11 @@ +# Type Alias: CameraStopDelegate() + +> **CameraStopDelegate**: () => `void` + +## Returns + +`void` + +## Defined in + +[packages/camera-manager/src/types.ts:68](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/types.ts#L68) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ClippingPlanesState.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ClippingPlanesState.md new file mode 100644 index 00000000000..c6a5a16b903 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ClippingPlanesState.md @@ -0,0 +1,25 @@ +# Type Alias: ClippingPlanesState + +> **ClippingPlanesState**: `object` + +## Type declaration + +### constant + +> **constant**: `number` + +### nx + +> **nx**: `number` + +### ny + +> **ny**: `number` + +### nz + +> **nz**: `number` + +## Defined in + +[packages/api/src/utilities/ViewStateHelper.ts:28](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/utilities/ViewStateHelper.ts#L28) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CogniteModel.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CogniteModel.md new file mode 100644 index 00000000000..f1e10a244f3 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CogniteModel.md @@ -0,0 +1,9 @@ +# Type Alias: CogniteModel + +> **CogniteModel**: [`CogniteCadModel`](../classes/CogniteCadModel.md) \| [`CognitePointCloudModel`](../classes/CognitePointCloudModel.md) + +Type abstraction for CogniteCadModel or CognitePointCloudModel;. + +## Defined in + +[packages/api/src/public/types.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/types.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ComboControlsEventType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ComboControlsEventType.md new file mode 100644 index 00000000000..4fd83dfb3d6 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ComboControlsEventType.md @@ -0,0 +1,27 @@ +# Type Alias: ComboControlsEventType + +> **ComboControlsEventType**: `object` + +The event type for events emitted by [ComboControls](../classes/ComboControls.md). + +## Type declaration + +### cameraChange + +> **cameraChange**: `object` + +### cameraChange.camera + +> **camera**: `object` + +### cameraChange.camera.position + +> **position**: `Vector3` + +### cameraChange.camera.target + +> **target**: `Vector3` + +## Defined in + +[packages/camera-manager/src/ComboControls.ts:31](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControls.ts#L31) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ComboControlsOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ComboControlsOptions.md new file mode 100644 index 00000000000..2f919d61f92 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ComboControlsOptions.md @@ -0,0 +1,161 @@ +# Type Alias: ComboControlsOptions + +> **ComboControlsOptions**: `object` + +Exposed options for Combo Controls + +## Type declaration + +### EPSILON + +> **EPSILON**: `number` + +### dampingFactor + +> **dampingFactor**: `number` + +### dollyFactor + +> **dollyFactor**: `number` + +### dynamicTarget + +> **dynamicTarget**: `boolean` + +### enableDamping + +> **enableDamping**: `boolean` + +### enableKeyboardNavigation + +> **enableKeyboardNavigation**: `boolean` + +### firstPersonRotationFactor + +> **firstPersonRotationFactor**: `number` + +### keyboardDollySpeed + +> **keyboardDollySpeed**: `number` + +### keyboardPanSpeed + +> **keyboardPanSpeed**: `number` + +### keyboardRotationSpeedAzimuth + +> **keyboardRotationSpeedAzimuth**: `number` + +### keyboardRotationSpeedPolar + +> **keyboardRotationSpeedPolar**: `number` + +### keyboardSpeedFactor + +> **keyboardSpeedFactor**: `number` + +How much quicker keyboard navigation will be with 'shift' pressed + +### lookAtViewTarget + +> **lookAtViewTarget**: `boolean` + +### maxAzimuthAngle + +> **maxAzimuthAngle**: `number` + +Radians + +### maxDeltaDownscaleCoefficient + +> **maxDeltaDownscaleCoefficient**: `number` + +### maxDeltaRatio + +> **maxDeltaRatio**: `number` + +### maxPolarAngle + +> **maxPolarAngle**: `number` + +Radians + +### maxZoom + +> **maxZoom**: `number` + +### minAzimuthAngle + +> **minAzimuthAngle**: `number` + +Radians + +### minDeltaDownscaleCoefficient + +> **minDeltaDownscaleCoefficient**: `number` + +### minDeltaRatio + +> **minDeltaRatio**: `number` + +### minDistance + +> **minDistance**: `number` + +### minPolarAngle + +> **minPolarAngle**: `number` + +Radians + +### minZoom + +> **minZoom**: `number` + +### minZoomDistance + +> **minZoomDistance**: `number` + +### mouseFirstPersonRotationSpeed + +> **mouseFirstPersonRotationSpeed**: `number` + +### orthographicCameraDollyFactor + +> **orthographicCameraDollyFactor**: `number` + +### panDollyMinDistanceFactor + +> **panDollyMinDistanceFactor**: `number` + +### pinchEpsilon + +> **pinchEpsilon**: `number` + +### pinchPanSpeed + +> **pinchPanSpeed**: `number` + +### pointerRotationSpeedAzimuth + +> **pointerRotationSpeedAzimuth**: `number` + +Radians per pixel + +### pointerRotationSpeedPolar + +> **pointerRotationSpeedPolar**: `number` + +Radians per pixel + +### useScrollTarget + +> **useScrollTarget**: `boolean` + +### zoomToCursor + +> **zoomToCursor**: `boolean` + +## Defined in + +[packages/camera-manager/src/ComboControlsOptions.ts:8](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/ComboControlsOptions.ts#L8) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CompletePointCloudAppearance.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CompletePointCloudAppearance.md new file mode 100644 index 00000000000..a471a3fa416 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CompletePointCloudAppearance.md @@ -0,0 +1,7 @@ +# Type Alias: CompletePointCloudAppearance + +> **CompletePointCloudAppearance**: `Required` \<[`PointCloudAppearance`](PointCloudAppearance.md)\> + +## Defined in + +[packages/pointcloud-styling/src/PointCloudAppearance.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CustomObjectIntersection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CustomObjectIntersection.md new file mode 100644 index 00000000000..5ab9131f910 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/CustomObjectIntersection.md @@ -0,0 +1,61 @@ +# Type Alias: CustomObjectIntersection + +> **CustomObjectIntersection**: `object` + +**`Beta`** + +This class is used as output intersecting custom objects + +## Type declaration + +### boundingBox? + +> `optional` **boundingBox**: `Box3` + +**`Beta`** + +The bounding box of the part of the CustomObject that was intersected. + +### customObject + +> **customObject**: [`ICustomObject`](../interfaces/ICustomObject.md) + +**`Beta`** + +The CustomObject that was intersected. + +### distanceToCamera + +> **distanceToCamera**: `number` + +**`Beta`** + +Distance from the camera to the intersection. + +### point + +> **point**: `Vector3` + +**`Beta`** + +Coordinate of the intersection. + +### type + +> **type**: `"customObject"` + +**`Beta`** + +The intersection type. + +### userData? + +> `optional` **userData**: `any` + +**`Beta`** + +Additional info, for instance which part of the CustomObject was intersected. + +## Defined in + +[packages/utilities/src/customObject/CustomObjectIntersection.ts:12](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/customObject/CustomObjectIntersection.ts#L12) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/DefaultOverlay3DContentType.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/DefaultOverlay3DContentType.md new file mode 100644 index 00000000000..a93ec914262 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/DefaultOverlay3DContentType.md @@ -0,0 +1,13 @@ +# Type Alias: DefaultOverlay3DContentType + +> **DefaultOverlay3DContentType**: `object` + +The default metadata type contained in Overlays + +## Index Signature + + \[`key`: `string`\]: `string` + +## Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/OverlayCollection.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/DisposedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/DisposedDelegate.md new file mode 100644 index 00000000000..6e51b8f5734 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/DisposedDelegate.md @@ -0,0 +1,11 @@ +# Type Alias: DisposedDelegate() + +> **DisposedDelegate**: () => `void` + +## Returns + +`void` + +## Defined in + +[packages/utilities/src/events/types.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/types.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/EdlOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/EdlOptions.md new file mode 100644 index 00000000000..85bfaafc714 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/EdlOptions.md @@ -0,0 +1,23 @@ +# Type Alias: EdlOptions + +> **EdlOptions**: `object` + +Configuration parameters for Eye Dome Lighting (EDL) point cloud post-processing effect. + +## Type declaration + +### radius + +> **radius**: `number` + +Radius of sampled points in pixels. Determines thickness of edges addet on top of points. + +### strength + +> **strength**: `number` + +Determines how pronounced the effect is. Lower values result in more transparent edges. + +## Defined in + +[packages/rendering/src/rendering/types.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/rendering/src/rendering/types.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/FlexibleControlsTypeChangeDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/FlexibleControlsTypeChangeDelegate.md new file mode 100644 index 00000000000..240463c7081 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/FlexibleControlsTypeChangeDelegate.md @@ -0,0 +1,15 @@ +# Type Alias: FlexibleControlsTypeChangeDelegate() + +> **FlexibleControlsTypeChangeDelegate**: (`controlsType`) => `void` + +## Parameters + +• **controlsType**: [`FlexibleControlsType`](../enumerations/FlexibleControlsType.md) + +## Returns + +`void` + +## Defined in + +[packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/Flexible/IFlexibleCameraManager.ts#L13) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/GeometryFilter.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/GeometryFilter.md new file mode 100644 index 00000000000..0e716519386 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/GeometryFilter.md @@ -0,0 +1,31 @@ +# Type Alias: GeometryFilter + +> **GeometryFilter**: `object` + +## Type declaration + +### boundingBox? + +> `optional` **boundingBox**: `Box3` + +The bounds to load geometry within. By default this box is in CDF coordinate space which +will be transformed into coordinates relative to the model using the the model transformation +which can be specified using [the CDF API](https://docs.cognite.com/api/v1/#operation/update3DRevisions), +or set in [Cognite Fusion](https://fusion.cognite.com/). + +#### See + +GeometryFilter.isBoundingBoxInModelCoordinates. + +### isBoundingBoxInModelCoordinates? + +> `optional` **isBoundingBoxInModelCoordinates**: `boolean` + +When set, the geometry filter `boundingBox` will be considered to be in "Reveal/ThreeJS space". +Rather than CDF space which is the default. When using Reveal space, the model transformation +which can be specified using [the CDF API](https://docs.cognite.com/api/v1/#operation/update3DRevisions), +or set in [Cognite Fusion](https://fusion.cognite.com/). + +## Defined in + +[packages/cad-model/src/types.ts:24](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/types.ts#L24) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAppearance.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAppearance.md new file mode 100644 index 00000000000..bd51f45f38b --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAppearance.md @@ -0,0 +1,23 @@ +# Type Alias: Image360AnnotationAppearance + +> **Image360AnnotationAppearance**: `object` + +The appearance of a 360 image annotation + +## Type declaration + +### color? + +> `optional` **color**: `Color` + +The color of the annotation. Default: Random, based on annotation label + +### visible? + +> `optional` **visible**: `boolean` + +Whether the annotation is visible. Default: true + +## Defined in + +[packages/360-images/src/annotation/types.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/annotation/types.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAssetFilter.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAssetFilter.md new file mode 100644 index 00000000000..d852695440f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAssetFilter.md @@ -0,0 +1,17 @@ +# Type Alias: Image360AnnotationAssetFilter + +> **Image360AnnotationAssetFilter**: `object` + +Filter for finding annotations related to an asset + +## Type declaration + +### assetRef + +> **assetRef**: `IdEither` + +Reference to the wanted asset + +## Defined in + +[packages/360-images/src/collection/Image360Collection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L18) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAssetQueryResult.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAssetQueryResult.md new file mode 100644 index 00000000000..824266d954f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationAssetQueryResult.md @@ -0,0 +1,29 @@ +# Type Alias: Image360AnnotationAssetQueryResult + +> **Image360AnnotationAssetQueryResult**: `object` + +Result item from an asset annotation query + +## Type declaration + +### annotation + +> **annotation**: [`Image360Annotation`](../interfaces/Image360Annotation.md) + +The found annotation + +### image + +> **image**: [`Image360`](../interfaces/Image360.md) + +The Image360 to which the result annotation belongs + +### revision + +> **revision**: [`Image360Revision`](../interfaces/Image360Revision.md) + +The image revision to which the result annotation belongs + +## Defined in + +[packages/360-images/src/collection/Image360Collection.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/collection/Image360Collection.ts#L46) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationFilterOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationFilterOptions.md new file mode 100644 index 00000000000..e2b279af606 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationFilterOptions.md @@ -0,0 +1,23 @@ +# Type Alias: Image360AnnotationFilterOptions + +> **Image360AnnotationFilterOptions**: `object` + +Options for loading annotations in 360 images + +## Type declaration + +### status? + +> `optional` **status**: `"all"` \| `AnnotationStatus` \| `AnnotationStatus`[] + +Allow annotations matching this/these statuses. 'all' will match all annotations + +#### Default + +```ts +'approved' +``` + +## Defined in + +[packages/360-images/src/annotation/types.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/annotation/types.ts#L26) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationIntersection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationIntersection.md new file mode 100644 index 00000000000..166595c3885 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360AnnotationIntersection.md @@ -0,0 +1,29 @@ +# Type Alias: Image360AnnotationIntersection + +> **Image360AnnotationIntersection**: `object` + +Describes an intersection with a 360 image annotation + +## Type declaration + +### annotation + +> **annotation**: [`Image360Annotation`](../interfaces/Image360Annotation.md) + +The intersected annotation + +### direction + +> **direction**: `Vector3` + +The world direction from the camera to the intersection point + +### type + +> **type**: `"image360Annotation"` + +The intersection type. + +## Defined in + +[packages/360-images/src/annotation/Image360AnnotationIntersection.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/annotation/Image360AnnotationIntersection.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360DataModelIdentifier.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360DataModelIdentifier.md new file mode 100644 index 00000000000..cd131c70172 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360DataModelIdentifier.md @@ -0,0 +1,19 @@ +# Type Alias: Image360DataModelIdentifier + +> **Image360DataModelIdentifier**: `object` + +An identifier uniquely determining an instance of a Cognite Data Model + +## Type declaration + +### image360CollectionExternalId + +> **image360CollectionExternalId**: `string` + +### space + +> **space**: `string` + +## Defined in + +[packages/data-providers/src/image-360-data-providers/descriptor-providers/datamodels/Cdf360DataModelsDescriptorProvider.ts:26](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/image-360-data-providers/descriptor-providers/datamodels/Cdf360DataModelsDescriptorProvider.ts#L26) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360EnteredDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360EnteredDelegate.md new file mode 100644 index 00000000000..061d01028de --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360EnteredDelegate.md @@ -0,0 +1,19 @@ +# Type Alias: Image360EnteredDelegate() + +> **Image360EnteredDelegate**: (`image360`, `revision`) => `void` + +Delegate for 360 image mode entered events. + +## Parameters + +• **image360**: [`Image360`](../interfaces/Image360.md) + +• **revision**: [`Image360Revision`](../interfaces/Image360Revision.md) + +## Returns + +`void` + +## Defined in + +[packages/360-images/src/types.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/types.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360ExitedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360ExitedDelegate.md new file mode 100644 index 00000000000..f59528e3305 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360ExitedDelegate.md @@ -0,0 +1,13 @@ +# Type Alias: Image360ExitedDelegate() + +> **Image360ExitedDelegate**: () => `void` + +Delegate for 360 image mode exited events. + +## Returns + +`void` + +## Defined in + +[packages/360-images/src/types.ts:16](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/types.ts#L16) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360IconStyle.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360IconStyle.md new file mode 100644 index 00000000000..dd169102a17 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360IconStyle.md @@ -0,0 +1,17 @@ +# Type Alias: Image360IconStyle + +> **Image360IconStyle**: `object` + +Image360 icon style + +## Type declaration + +### color? + +> `optional` **color**: `Color` + +A color tint to apply to the 360 icon + +## Defined in + +[packages/360-images/src/entity/Image360.ts:13](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/360-images/src/entity/Image360.ts#L13) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360WithCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360WithCollection.md new file mode 100644 index 00000000000..729c4c518e3 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Image360WithCollection.md @@ -0,0 +1,19 @@ +# Type Alias: Image360WithCollection + +> **Image360WithCollection**: `object` + +A tuple of a 360 image and its collection. + +## Type declaration + +### image360 + +> **image360**: [`Image360`](../interfaces/Image360.md) + +### image360Collection + +> **image360Collection**: [`Image360Collection`](../interfaces/Image360Collection.md) + +## Defined in + +[packages/api/src/public/types.ts:21](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/types.ts#L21) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ImageAssetLinkAnnotationInfo.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ImageAssetLinkAnnotationInfo.md new file mode 100644 index 00000000000..f41b220cff1 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ImageAssetLinkAnnotationInfo.md @@ -0,0 +1,17 @@ +# Type Alias: ImageAssetLinkAnnotationInfo + +> **ImageAssetLinkAnnotationInfo**: `Omit`\<`AnnotationModel`, `"data"`\> & `object` + +A CDF AnnotationModel with a narrower type representing an image asset link + +## Type declaration + +### data + +> **data**: `AnnotationsCogniteAnnotationTypesImagesAssetLink` + +The data associated with the image asset link + +## Defined in + +[packages/data-providers/src/types.ts:46](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/types.ts#L46) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Intersection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Intersection.md new file mode 100644 index 00000000000..72d3c1b3183 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Intersection.md @@ -0,0 +1,7 @@ +# Type Alias: Intersection + +> **Intersection**: [`CadIntersection`](CadIntersection.md) \| [`PointCloudIntersection`](PointCloudIntersection.md) + +## Defined in + +[packages/api/src/public/migration/types.ts:287](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L287) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ModelState.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ModelState.md new file mode 100644 index 00000000000..69e5bc9f638 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ModelState.md @@ -0,0 +1,25 @@ +# Type Alias: ModelState + +> **ModelState**: `object` + +## Type declaration + +### defaultNodeAppearance + +> **defaultNodeAppearance**: [`SerializableNodeAppearance`](SerializableNodeAppearance.md) + +### modelId + +> **modelId**: `number` + +### revisionId + +> **revisionId**: `number` + +### styledSets + +> **styledSets**: `object`[] + +## Defined in + +[packages/api/src/utilities/ViewStateHelper.ts:35](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/utilities/ViewStateHelper.ts#L35) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/NodeAppearance.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/NodeAppearance.md new file mode 100644 index 00000000000..5461d7ace44 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/NodeAppearance.md @@ -0,0 +1,77 @@ +# Type Alias: NodeAppearance + +> **NodeAppearance**: `object` + +Type for defining node appearance profiles to style a 3D CAD model. + +## See + +[DefaultNodeAppearance](../variables/DefaultNodeAppearance.md) + +## Type declaration + +### color? + +> `readonly` `optional` **color**: `Color` + +Overrides the default color of the node in RGB. Black, +or `new Color(0, 0, 0)` means no override. + +### outlineColor? + +> `readonly` `optional` **outlineColor**: [`NodeOutlineColor`](../enumerations/NodeOutlineColor.md) + +When set, an outline is drawn around the +node to make it stand out. + +### prioritizedForLoadingHint? + +> `readonly` `optional` **prioritizedForLoadingHint**: `number` + +When provided, this value can be used to prioritize certain areas of the +3D model to be loaded. This can be useful to prioritize key objects in the +3D model to always be loaded. + +When non-zero, sectors containing geometry in the vicinity of the prioritized +sectors are given an *extra* priority. Recommended values are in range 1 (somewhat +higher priority to be loaded) to 10 (very likely to be loaded). Usually values around 4-5 +is recommended. + +Prioritized nodes are loaded at the expense of non-prioritized areas. There are no +guarantees that the nodes are actually loaded, and the more prioritized areas/nodes +provided, the less likely it is that the hint is obeyed. + +Extra priority doesn't accumulate when sectors are prioritized because they intersect/contain +several nodes. + +**This is an advanced feature and not recommended for most users** + +#### Version + +Only works with 3D models converted later than Q4 2021. + +### renderGhosted? + +> `readonly` `optional` **renderGhosted**: `boolean` + +When set to true, the node is rendered ghosted, i.e. +transparent with a fixed color. This has no effect if NodeAppearance.renderInFront +is `true`. + +### renderInFront? + +> `readonly` `optional` **renderInFront**: `boolean` + +When set to true, the node is rendered in front +of all other nodes even if it's occluded. +Note that this take precedence over NodeAppearance.renderGhosted. + +### visible? + +> `readonly` `optional` **visible**: `boolean` + +Overrides the visibility of the node. + +## Defined in + +[packages/cad-styling/src/NodeAppearance.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/NodeCollectionSerializationContext.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/NodeCollectionSerializationContext.md new file mode 100644 index 00000000000..bdded034aea --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/NodeCollectionSerializationContext.md @@ -0,0 +1,17 @@ +# Type Alias: NodeCollectionSerializationContext + +> **NodeCollectionSerializationContext**: `object` + +## Type declaration + +### client + +> **client**: `CogniteClient` + +### model + +> **model**: [`CdfModelNodeCollectionDataProvider`](../interfaces/CdfModelNodeCollectionDataProvider.md) + +## Defined in + +[packages/cad-styling/src/NodeCollectionDeserializer.ts:22](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeCollectionDeserializer.ts#L22) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/OnLoadingCallback.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/OnLoadingCallback.md new file mode 100644 index 00000000000..4e48a5f1b91 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/OnLoadingCallback.md @@ -0,0 +1,19 @@ +# Type Alias: OnLoadingCallback() + +> **OnLoadingCallback**: (`itemsLoaded`, `itemsRequested`, `itemsCulled`) => `void` + +## Parameters + +• **itemsLoaded**: `number` + +• **itemsRequested**: `number` + +• **itemsCulled**: `number` + +## Returns + +`void` + +## Defined in + +[packages/api/src/public/migration/types.ts:30](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L30) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Overlay3DCollectionOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Overlay3DCollectionOptions.md new file mode 100644 index 00000000000..c859038863a --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/Overlay3DCollectionOptions.md @@ -0,0 +1,35 @@ +# Type Alias: Overlay3DCollectionOptions + +> **Overlay3DCollectionOptions**: `object` + +Constructor options for the Overlay3DCollection + +## Type declaration + +### defaultOverlayColor? + +> `optional` **defaultOverlayColor**: `Color` + +The default color to apply to overlay icons without a color on their own + +### maxPointSize? + +> `optional` **maxPointSize**: `number` + +The maximum display size of each icon in pixels + +### overlayTexture? + +> `optional` **overlayTexture**: `Texture` + +The texture to display as icons in this collection + +### overlayTextureMask? + +> `optional` **overlayTextureMask**: `Texture` + +A texture mask for marking what pixels are transparent in the supplied overlayTexture + +## Defined in + +[packages/3d-overlays/src/Overlay3DCollection.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/Overlay3DCollection.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/OverlayInfo.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/OverlayInfo.md new file mode 100644 index 00000000000..e29b98b6fb6 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/OverlayInfo.md @@ -0,0 +1,33 @@ +# Type Alias: OverlayInfo\ + +> **OverlayInfo**\<`ContentType`\>: `object` + +Data used in creating an overlay. + +## Type Parameters + +• **ContentType** = [`DefaultOverlay3DContentType`](DefaultOverlay3DContentType.md) + +## Type declaration + +### color? + +> `optional` **color**: `Color` + +The color of this overlay. Will be set by collection if undefined + +### content + +> **content**: `ContentType` + +The data contained in this overlay + +### position + +> **position**: `Vector3` + +Position of the overlay + +## Defined in + +[packages/3d-overlays/src/OverlayCollection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/3d-overlays/src/OverlayCollection.ts#L18) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudAppearance.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudAppearance.md new file mode 100644 index 00000000000..478eef22294 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudAppearance.md @@ -0,0 +1,17 @@ +# Type Alias: PointCloudAppearance + +> **PointCloudAppearance**: `object` + +## Type declaration + +### color? + +> `optional` **color**: `Color` + +### visible? + +> `optional` **visible**: `boolean` + +## Defined in + +[packages/pointcloud-styling/src/PointCloudAppearance.ts:7](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L7) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudBudget.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudBudget.md new file mode 100644 index 00000000000..73b80301ffa --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudBudget.md @@ -0,0 +1,19 @@ +# Type Alias: PointCloudBudget + +> **PointCloudBudget**: `object` + +Represents a budget of how many point from point clouds can be +loaded at the same time. + +## Type declaration + +### numberOfPoints + +> `readonly` **numberOfPoints**: `number` + +Total number of points that can be loaded for all point clouds models +accumulated. + +## Defined in + +[packages/pointclouds/src/PointCloudBudget.ts:10](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/PointCloudBudget.ts#L10) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudIntersection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudIntersection.md new file mode 100644 index 00000000000..745440fdc57 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudIntersection.md @@ -0,0 +1,51 @@ +# Type Alias: PointCloudIntersection + +> **PointCloudIntersection**: `object` + +## Type declaration + +### annotationId + +> **annotationId**: `number` + +Annotation Id of the intersected object within a pointcloud. (0 if not applicable) + +### assetRef? + +> `optional` **assetRef**: `AnnotationsAssetRef` + +Reference to the asset associated to the intersected point cloud object, if any. + +### distanceToCamera + +> **distanceToCamera**: `number` + +Distance from the camera to the intersection. + +### model + +> **model**: [`CognitePointCloudModel`](../classes/CognitePointCloudModel.md) + +The model that was intersected. + +### point + +> **point**: `Vector3` + +Coordinate of the intersection. + +### pointIndex + +> **pointIndex**: `number` + +The index of the point that was intersected. + +### type + +> **type**: `"pointcloud"` + +The intersection type. + +## Defined in + +[packages/pointclouds/src/PointCloudIntersection.ts:8](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointclouds/src/PointCloudIntersection.ts#L8) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudObjectMetadata.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudObjectMetadata.md new file mode 100644 index 00000000000..c9c6c882c9c --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointCloudObjectMetadata.md @@ -0,0 +1,39 @@ +# Type Alias: PointCloudObjectMetadata + +> **PointCloudObjectMetadata**: `object` + +Metadata for a single point cloud object + +## Type declaration + +### annotationId + +> **annotationId**: `number` + +The CDF Annotation ID associated with the point cloud object. + +### ~~assetId?~~ + +> `optional` **assetId**: `number` + +The CDF Asset ID associated with the point cloud object, if any. + +#### Deprecated + +Use PointCloudObjectMetadata.assetRef instead. + +### assetRef? + +> `optional` **assetRef**: `AnnotationsAssetRef` + +Asset identifiers for asset associated with this point cloud object, if any. + +### boundingBox + +> **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/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/data-providers/src/pointcloud-stylable-object-providers/types.ts#L21) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointerEventData.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointerEventData.md new file mode 100644 index 00000000000..1d14482b1f5 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointerEventData.md @@ -0,0 +1,21 @@ +# Type Alias: PointerEventData + +> **PointerEventData**: `object` + +## Type declaration + +### button? + +> `optional` **button**: `number` + +### offsetX + +> **offsetX**: `number` + +### offsetY + +> **offsetY**: `number` + +## Defined in + +[packages/utilities/src/events/types.ts:17](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/types.ts#L17) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointerEventDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointerEventDelegate.md new file mode 100644 index 00000000000..d1e31816b59 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PointerEventDelegate.md @@ -0,0 +1,15 @@ +# Type Alias: PointerEventDelegate() + +> **PointerEventDelegate**: (`event`) => `void` + +## Parameters + +• **event**: [`PointerEventData`](PointerEventData.md) + +## Returns + +`void` + +## Defined in + +[packages/utilities/src/events/types.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/types.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PropertyFilterNodeCollectionOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PropertyFilterNodeCollectionOptions.md new file mode 100644 index 00000000000..fad552de6ce --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/PropertyFilterNodeCollectionOptions.md @@ -0,0 +1,19 @@ +# Type Alias: PropertyFilterNodeCollectionOptions + +> **PropertyFilterNodeCollectionOptions**: `object` + +Options for [PropertyFilterNodeCollection](../classes/PropertyFilterNodeCollection.md). + +## Type declaration + +### requestPartitions? + +> `optional` **requestPartitions**: `number` + +How many partitions to split the request into. More partitions can yield better performance +for queries with very large result set (in order of magnitude 100.000 plus). +Defaults to 1. + +## Defined in + +[packages/cad-styling/src/PropertyFilterNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L18) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/RenderParameters.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/RenderParameters.md new file mode 100644 index 00000000000..eeaae48b32d --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/RenderParameters.md @@ -0,0 +1,17 @@ +# Type Alias: RenderParameters + +> **RenderParameters**: `object` + +Some parameters of WebGLRenderer initialized with [Cognite3DViewer](../classes/Cognite3DViewer.md). + +## Type declaration + +### renderSize + +> **renderSize**: `Vector2` + +Current width and height of the renderer's output canvas, in pixels. + +## Defined in + +[packages/api/src/public/migration/types.ts:35](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L35) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ResolutionOptions.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ResolutionOptions.md new file mode 100644 index 00000000000..63916514ca4 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ResolutionOptions.md @@ -0,0 +1,29 @@ +# Type Alias: ResolutionOptions + +> **ResolutionOptions**: `object` + +## Type declaration + +### maxRenderResolution? + +> `optional` **maxRenderResolution**: `number` + +Generally Reveal will follow the resolution given by the size +of the encapsulating DOM element of the Canvas [Cognite3DViewerOptions.domElement](../interfaces/Cognite3DViewerOptions.md#domelement). +To ensure managable performance, Reveal will by default set an upper threshold to limit +the resolution. The `maxRenderResolution` option will +directly control this upper limit. It corresponds to the number of pixels in the render target. + +### movingCameraResolutionFactor? + +> `optional` **movingCameraResolutionFactor**: `number` + +A factor that will scale down the resolution when moving the camera. This can +be used to achieve a better user experience on devices with limited hardware. +Values must be greater than 0 and at most 1. +This factor is applied to the number of physical pixels of the canvas. +A value of e.g. 0.25 will approximately divide the number of pixels rendered on the screen by four. + +## Defined in + +[packages/api/src/public/migration/types.ts:263](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/public/migration/types.ts#L263) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SceneRenderedDelegate.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SceneRenderedDelegate.md new file mode 100644 index 00000000000..161fd515f12 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SceneRenderedDelegate.md @@ -0,0 +1,23 @@ +# Type Alias: SceneRenderedDelegate() + +> **SceneRenderedDelegate**: (`event`) => `void` + +## Parameters + +• **event** + +• **event.camera**: `PerspectiveCamera` + +• **event.frameNumber**: `number` + +• **event.renderTime**: `number` + +• **event.renderer**: `WebGLRenderer` + +## Returns + +`void` + +## Defined in + +[packages/utilities/src/events/types.ts:37](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/events/types.ts#L37) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SerializableNodeAppearance.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SerializableNodeAppearance.md new file mode 100644 index 00000000000..3f558a9556f --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SerializableNodeAppearance.md @@ -0,0 +1,67 @@ +# Type Alias: SerializableNodeAppearance + +> **SerializableNodeAppearance**: `object` + +Type that represents a [NodeAppearance](NodeAppearance.md) in a serializable format + +## Type declaration + +### color? + +> `readonly` `optional` **color**: [`number`, `number`, `number`] + +Color as an RGB number tuple, with values in the range [0, 255] + +### outlineColor? + +> `readonly` `optional` **outlineColor**: [`NodeOutlineColor`](../enumerations/NodeOutlineColor.md) + +Outline color, + +#### See + +[NodeAppearance](NodeAppearance.md) + +### prioritizedForLoadingHint? + +> `readonly` `optional` **prioritizedForLoadingHint**: `number` + +Prioritized loading hint, + +#### See + +[NodeAppearance](NodeAppearance.md) + +### renderGhosted? + +> `readonly` `optional` **renderGhosted**: `boolean` + +Whether to render ghosted, + +#### See + +[NodeAppearance](NodeAppearance.md) + +### renderInFront? + +> `readonly` `optional` **renderInFront**: `boolean` + +Whether to render in front, + +#### See + +[NodeAppearance](NodeAppearance.md) + +### visible? + +> `readonly` `optional` **visible**: `boolean` + +Visibility, + +#### See + +[NodeAppearance](NodeAppearance.md) + +## Defined in + +[packages/cad-styling/src/NodeAppearance.ts:77](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L77) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SerializedNodeCollection.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SerializedNodeCollection.md new file mode 100644 index 00000000000..d1ec5f1513c --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SerializedNodeCollection.md @@ -0,0 +1,21 @@ +# Type Alias: SerializedNodeCollection + +> **SerializedNodeCollection**: `object` + +## Type declaration + +### options? + +> `optional` **options**: `any` + +### state + +> **state**: `any` + +### token + +> **token**: `string` + +## Defined in + +[packages/cad-styling/src/SerializedNodeCollection.ts:4](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/SerializedNodeCollection.ts#L4) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SupportedModelTypes.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SupportedModelTypes.md new file mode 100644 index 00000000000..d738c8139e7 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/SupportedModelTypes.md @@ -0,0 +1,7 @@ +# Type Alias: SupportedModelTypes + +> **SupportedModelTypes**: `"pointcloud"` \| `"cad"` + +## Defined in + +[packages/model-base/src/SupportedModelTypes.ts:4](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/model-base/src/SupportedModelTypes.ts#L4) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ViewerState.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ViewerState.md new file mode 100644 index 00000000000..08c55f3b44a --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/ViewerState.md @@ -0,0 +1,53 @@ +# Type Alias: ViewerState + +> **ViewerState**: `object` + +## Type declaration + +### camera? + +> `optional` **camera**: `object` + +### camera.position + +> **position**: `object` + +### camera.position.x + +> **x**: `number` + +### camera.position.y + +> **y**: `number` + +### camera.position.z + +> **z**: `number` + +### camera.target + +> **target**: `object` + +### camera.target.x + +> **x**: `number` + +### camera.target.y + +> **y**: `number` + +### camera.target.z + +> **z**: `number` + +### clippingPlanes? + +> `optional` **clippingPlanes**: [`ClippingPlanesState`](ClippingPlanesState.md)[] + +### models? + +> `optional` **models**: [`ModelState`](ModelState.md)[] + +## Defined in + +[packages/api/src/utilities/ViewStateHelper.ts:19](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/src/utilities/ViewStateHelper.ts#L19) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/WellKnownUnit.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/WellKnownUnit.md new file mode 100644 index 00000000000..0c292680d8b --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/type-aliases/WellKnownUnit.md @@ -0,0 +1,9 @@ +# Type Alias: WellKnownUnit + +> **WellKnownUnit**: `"Meters"` \| `"Centimeters"` \| `"Millimeters"` \| `"Micrometers"` \| `"Kilometers"` \| `"Feet"` \| `"Inches"` \| `"Yards"` \| `"Miles"` \| `"Mils"` \| `"Microinches"` + +Units supported by [CogniteCadModel](../classes/CogniteCadModel.md). + +## Defined in + +[packages/cad-model/src/types.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-model/src/types.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/CAMERA_MANAGER_EVENT_TYPE_LIST.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/CAMERA_MANAGER_EVENT_TYPE_LIST.md new file mode 100644 index 00000000000..1c719e8b47e --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/CAMERA_MANAGER_EVENT_TYPE_LIST.md @@ -0,0 +1,9 @@ +# Variable: CAMERA\_MANAGER\_EVENT\_TYPE\_LIST + +> `const` **CAMERA\_MANAGER\_EVENT\_TYPE\_LIST**: readonly [`"cameraChange"`, `"cameraStop"`] + +List of supported event types (adapted from https://stackoverflow.com/questions/44480644/string-union-to-string-array) + +## Defined in + +[packages/camera-manager/src/types.ts:103](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/camera-manager/src/types.ts#L103) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/CDF_TO_VIEWER_TRANSFORMATION.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/CDF_TO_VIEWER_TRANSFORMATION.md new file mode 100644 index 00000000000..19ef425b249 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/CDF_TO_VIEWER_TRANSFORMATION.md @@ -0,0 +1,10 @@ +# Variable: CDF\_TO\_VIEWER\_TRANSFORMATION + +> `const` **CDF\_TO\_VIEWER\_TRANSFORMATION**: `Matrix4` = `cadFromCdfToThreeMatrix` + +The transformation matrix from CDF coordinates to ThreeJS/Reveal. +Note that this is already applied to Reveal models. + +## Defined in + +[packages/utilities/src/constants.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/utilities/src/constants.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/DefaultNodeAppearance.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/DefaultNodeAppearance.md new file mode 100644 index 00000000000..bd2e5bb2f79 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/DefaultNodeAppearance.md @@ -0,0 +1,97 @@ +# Variable: DefaultNodeAppearance + +> `const` **DefaultNodeAppearance**: `object` + +A set of default node appearances used in Reveal. + +## Type declaration + +### Default + +> **Default**: [`NodeAppearance`](../type-aliases/NodeAppearance.md) = `DefaultAppearance` + +### Ghosted + +> **Ghosted**: [`NodeAppearance`](../type-aliases/NodeAppearance.md) = `GhostedAppearance` + +### Hidden + +> **Hidden**: [`NodeAppearance`](../type-aliases/NodeAppearance.md) = `HiddenAppearance` + +### Highlighted + +> **Highlighted**: `object` + +### Highlighted.color? + +> `readonly` `optional` **color**: `Color` + +Overrides the default color of the node in RGB. Black, +or `new Color(0, 0, 0)` means no override. + +### Highlighted.outlineColor? + +> `readonly` `optional` **outlineColor**: [`NodeOutlineColor`](../enumerations/NodeOutlineColor.md) + +When set, an outline is drawn around the +node to make it stand out. + +### Highlighted.prioritizedForLoadingHint? + +> `readonly` `optional` **prioritizedForLoadingHint**: `number` + +When provided, this value can be used to prioritize certain areas of the +3D model to be loaded. This can be useful to prioritize key objects in the +3D model to always be loaded. + +When non-zero, sectors containing geometry in the vicinity of the prioritized +sectors are given an *extra* priority. Recommended values are in range 1 (somewhat +higher priority to be loaded) to 10 (very likely to be loaded). Usually values around 4-5 +is recommended. + +Prioritized nodes are loaded at the expense of non-prioritized areas. There are no +guarantees that the nodes are actually loaded, and the more prioritized areas/nodes +provided, the less likely it is that the hint is obeyed. + +Extra priority doesn't accumulate when sectors are prioritized because they intersect/contain +several nodes. + +**This is an advanced feature and not recommended for most users** + +#### Version + +Only works with 3D models converted later than Q4 2021. + +### Highlighted.renderGhosted? + +> `readonly` `optional` **renderGhosted**: `boolean` + +When set to true, the node is rendered ghosted, i.e. +transparent with a fixed color. This has no effect if NodeAppearance.renderInFront +is `true`. + +### Highlighted.renderInFront? + +> `readonly` `optional` **renderInFront**: `boolean` + +When set to true, the node is rendered in front +of all other nodes even if it's occluded. +Note that this take precedence over NodeAppearance.renderGhosted. + +### Highlighted.visible? + +> `readonly` `optional` **visible**: `boolean` + +Overrides the visibility of the node. + +### InFront + +> **InFront**: [`NodeAppearance`](../type-aliases/NodeAppearance.md) = `InFrontAppearance` + +### Outlined + +> **Outlined**: [`NodeAppearance`](../type-aliases/NodeAppearance.md) = `OutlinedAppearance` + +## Defined in + +[packages/cad-styling/src/NodeAppearance.ts:142](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/cad-styling/src/NodeAppearance.ts#L142) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/DefaultPointCloudAppearance.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/DefaultPointCloudAppearance.md new file mode 100644 index 00000000000..03abb190f82 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/DefaultPointCloudAppearance.md @@ -0,0 +1,7 @@ +# Variable: DefaultPointCloudAppearance + +> `const` **DefaultPointCloudAppearance**: [`CompletePointCloudAppearance`](../type-aliases/CompletePointCloudAppearance.md) + +## Defined in + +[packages/pointcloud-styling/src/PointCloudAppearance.ts:14](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L14) diff --git a/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/REVEAL_VERSION.md b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/REVEAL_VERSION.md new file mode 100644 index 00000000000..8c14131a226 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/@cognite/reveal/variables/REVEAL_VERSION.md @@ -0,0 +1,7 @@ +# Variable: REVEAL\_VERSION + +> `const` **REVEAL\_VERSION**: `string` = `process.env.VERSION` + +## Defined in + +[packages/api/index.ts:11](https://github.com/cognitedata/reveal/blob/2acd9d17229d2bc8e309653b4d6a39ad941e44f1/viewer/packages/api/index.ts#L11) diff --git a/documentation/versioned_docs/version-4.x/api/_category_.yml b/documentation/versioned_docs/version-4.x/api/_category_.yml deleted file mode 100644 index 24a46026174..00000000000 --- a/documentation/versioned_docs/version-4.x/api/_category_.yml +++ /dev/null @@ -1 +0,0 @@ -label: "API" \ No newline at end of file diff --git a/documentation/versioned_docs/version-4.x/api/classes/_category_.yml b/documentation/versioned_docs/version-4.x/api/classes/_category_.yml deleted file mode 100644 index 55c7980a464..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Classes" -position: 3 \ No newline at end of file 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 deleted file mode 100644 index 60f71a10ba0..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AnnotationIdPointCloudObjectCollection.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: "cognite_reveal.AnnotationIdPointCloudObjectCollection" -title: "Class: AnnotationIdPointCloudObjectCollection" -sidebar_label: "AnnotationIdPointCloudObjectCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).AnnotationIdPointCloudObjectCollection - -A simple PointCloudObjectCollection that consists of an explicitly provided list of annotation IDs - -## Hierarchy - -- [`PointCloudObjectCollection`](cognite_reveal.PointCloudObjectCollection.md) - - ↳ **`AnnotationIdPointCloudObjectCollection`** - -## Constructors - -### constructor - -• **new AnnotationIdPointCloudObjectCollection**(`ids`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ids` | `Iterable`\<`number`\> | - -#### Overrides - -[PointCloudObjectCollection](cognite_reveal.PointCloudObjectCollection.md).[constructor](cognite_reveal.PointCloudObjectCollection.md#constructor) - -#### Defined in - -[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L13) - -## Accessors - -### isLoading - -• `get` **isLoading**(): ``false`` - -#### Returns - -``false`` - -whether the collection is still loading data in the background i.e. not yet ready for use - -#### Overrides - -PointCloudObjectCollection.isLoading - -#### Defined in - -[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L22) - -## Methods - -### getAnnotationIds - -▸ **getAnnotationIds**(): `Iterable`\<`number`\> - -#### Returns - -`Iterable`\<`number`\> - -annotation IDs of the annotations for the objects represented by this PointCloudObjectCollection instance - -#### Overrides - -[PointCloudObjectCollection](cognite_reveal.PointCloudObjectCollection.md).[getAnnotationIds](cognite_reveal.PointCloudObjectCollection.md#getannotationids) - -#### Defined in - -[packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/AnnotationIdPointCloudObjectCollection.ts#L18) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[PointCloudObjectCollection](cognite_reveal.PointCloudObjectCollection.md).[off](cognite_reveal.PointCloudObjectCollection.md#off) - -#### Defined in - -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[PointCloudObjectCollection](cognite_reveal.PointCloudObjectCollection.md).[on](cognite_reveal.PointCloudObjectCollection.md#on) - -#### Defined in - -[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 deleted file mode 100644 index b5cd5ac0d36..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.AssetNodeCollection.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -id: "cognite_reveal.AssetNodeCollection" -title: "Class: AssetNodeCollection" -sidebar_label: "AssetNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).AssetNodeCollection - -Represents a set of nodes associated with an [asset in Cognite Fusion][https://docs.cognite.com/api/v1/#tag/Assets](https://docs.cognite.com/api/v1/#tag/Assets) -linked to the 3D model using [asset mappings][https://docs.cognite.com/api/v1/#tag/3D-Asset-Mapping](https://docs.cognite.com/api/v1/#tag/3D-Asset-Mapping). A node -is considered to be part of an asset if it has a direct asset mapping or if one of its ancestors has an asset mapping -to the asset. - -## Hierarchy - -- [`NodeCollection`](cognite_reveal.NodeCollection.md) - - ↳ **`AssetNodeCollection`** - -## Constructors - -### constructor - -• **new AssetNodeCollection**(`client`, `modelMetadataProvider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `client` | `default` | -| `modelMetadataProvider` | [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) | - -#### Overrides - -NodeCollection.constructor - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L36) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"AssetNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L27) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NodeCollection.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -NodeCollection.isLoading - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:43](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L43) - -## Methods - -### clear - -▸ **clear**(): `void` - -#### Returns - -`void` - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[clear](cognite_reveal.NodeCollection.md#clear) - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:135](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L135) - -___ - -### executeFilter - -▸ **executeFilter**(`filter`): `Promise`\<`void`\> - -Updates the node collection to hold nodes associated with the asset given, or -assets within the bounding box or all assets associated with the 3D model. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter` | `Object` | | -| `filter.assetId?` | `number` | ID of a single [asset][https://docs.cognite.com/dev/concepts/resource_types/assets.html](https://docs.cognite.com/dev/concepts/resource_types/assets.html) (optional) | -| `filter.boundingBox?` | `Box3` | When provided, only assets within the provided bounds will be included in the filter. | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:54](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L54) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getAreas](cognite_reveal.NodeCollection.md#getareas) - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:147](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L147) - -___ - -### getFilter - -▸ **getFilter**(): `undefined` \| \{ `assetId?`: `number` ; `boundingBox?`: `Box3` } - -#### Returns - -`undefined` \| \{ `assetId?`: `number` ; `boundingBox?`: `Box3` } - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:131](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L131) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getIndexSet](cognite_reveal.NodeCollection.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/AssetNodeCollection.ts:143](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/AssetNodeCollection.ts#L143) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[off](cognite_reveal.NodeCollection.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[on](cognite_reveal.NodeCollection.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[serialize](cognite_reveal.NodeCollection.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index 8f90510dea1..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.BoundingBoxClipper.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -id: "cognite_reveal.BoundingBoxClipper" -title: "Class: BoundingBoxClipper" -sidebar_label: "BoundingBoxClipper" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).BoundingBoxClipper - -## Constructors - -### constructor - -• **new BoundingBoxClipper**(`box?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `box?` | `Box3` | - -#### Defined in - -[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 - -### clippingPlanes - -• `get` **clippingPlanes**(): `Plane`[] - -#### Returns - -`Plane`[] - -#### Defined in - -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:104](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L104) - -___ - -### maxX - -• `get` **maxX**(): `number` - -#### Returns - -`number` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L50) - -___ - -### maxY - -• `get` **maxY**(): `number` - -#### Returns - -`number` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `y` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L59) - -___ - -### maxZ - -• `get` **maxZ**(): `number` - -#### Returns - -`number` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `z` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:68](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L68) - -___ - -### minX - -• `get` **minX**(): `number` - -#### Returns - -`number` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L23) - -___ - -### minY - -• `get` **minY**(): `number` - -#### Returns - -`number` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `y` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/utilities/BoundingBoxClipper.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/utilities/BoundingBoxClipper.ts#L32) - -___ - -### minZ - -• `get` **minZ**(): `number` - -#### Returns - -`number` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `z` | `number` | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 7bdcf9bfeac..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CameraManagerHelper.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -id: "cognite_reveal.CameraManagerHelper" -title: "Class: CameraManagerHelper" -sidebar_label: "CameraManagerHelper" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).CameraManagerHelper - -Helper methods for implementing a camera manager. - -## Constructors - -### constructor - -• **new CameraManagerHelper**() - -## Methods - -### calculateCameraStateToFitBoundingBox - -▸ `Static` **calculateCameraStateToFitBoundingBox**(`camera`, `box`, `radiusFactor?`): `Object` - -Calculates camera position and target that allows to see the content of provided bounding box. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `camera` | `PerspectiveCamera` | `undefined` | Used camera instance. | -| `box` | `Box3` | `undefined` | Bounding box to be fitted. | -| `radiusFactor` | `number` | `2` | The ratio of the distance from camera to center of box and radius of the box. | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `position` | `Vector3` | -| `target` | `Vector3` | - -#### Defined in - -[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) - -___ - -### calculateNewTargetFromRotation - -▸ `Static` **calculateNewTargetFromRotation**(`camera`, `rotation`, `currentTarget`): `Vector3` - -Calculates camera target based on new camera rotation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `camera` | `PerspectiveCamera` | Used camera instance. | -| `rotation` | `Quaternion` | New camera rotation in quaternion form. | -| `currentTarget` | `Vector3` | Current camera target. | - -#### Returns - -`Vector3` - -#### Defined in - -[packages/camera-manager/src/CameraManagerHelper.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManagerHelper.ts#L42) - -___ - -### updateCameraNearAndFar - -▸ `Static` **updateCameraNearAndFar**(`camera`, `combinedBbox`): `void` - -Updates near and far plane of the camera based on the bounding box. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `camera` | `PerspectiveCamera` | Used camera instance. | -| `combinedBbox` | `Box3` | Bounding box of all objects on the scene. | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 2453a2648e1..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CdfNodeCollectionBase.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -id: "cognite_reveal.CdfNodeCollectionBase" -title: "Class: CdfNodeCollectionBase" -sidebar_label: "CdfNodeCollectionBase" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).CdfNodeCollectionBase - -Abstract class for implementing a set of nodes to be styled. - -## Hierarchy - -- [`NodeCollection`](cognite_reveal.NodeCollection.md) - - ↳ **`CdfNodeCollectionBase`** - - ↳↳ [`NodeIdNodeCollection`](cognite_reveal.NodeIdNodeCollection.md) - - ↳↳ [`PropertyFilterNodeCollection`](cognite_reveal.PropertyFilterNodeCollection.md) - - ↳↳ [`SinglePropertyFilterNodeCollection`](cognite_reveal.SinglePropertyFilterNodeCollection.md) - -## Constructors - -### constructor - -• **new CdfNodeCollectionBase**(`classToken`, `model`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `classToken` | `string` | -| `model` | [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) | - -#### Overrides - -NodeCollection.constructor - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L20) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NodeCollection.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -NodeCollection.isLoading - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) - -## Methods - -### clear - -▸ **clear**(): `void` - -Clears the node collection and interrupts any ongoing operations. - -#### Returns - -`void` - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[clear](cognite_reveal.NodeCollection.md#clear) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getAreas](cognite_reveal.NodeCollection.md#getareas) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getIndexSet](cognite_reveal.NodeCollection.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[off](cognite_reveal.NodeCollection.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[on](cognite_reveal.NodeCollection.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ `Abstract` **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[serialize](cognite_reveal.NodeCollection.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index 315b71676ab..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ClusteredAreaCollection.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -id: "cognite_reveal.ClusteredAreaCollection" -title: "Class: ClusteredAreaCollection" -sidebar_label: "ClusteredAreaCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).ClusteredAreaCollection - -AreaCollection that stores a representative box set by merging -inserted boxes that are overlapping or close to each other. -It uses simple heuristics to determine which boxes are to be merged. - -## Implements - -- [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -## Constructors - -### constructor - -• **new ClusteredAreaCollection**() - -## Accessors - -### isEmpty - -• `get` **isEmpty**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -[AreaCollection](../interfaces/cognite_reveal.AreaCollection.md).[isEmpty](../interfaces/cognite_reveal.AreaCollection.md#isempty) - -#### Defined in - -[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 - -### addAreas - -▸ **addAreas**(`boxes`): `void` - -Add areas to be covered by the representative set of this -AreaCollection. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `boxes` | `Iterable`\<`Box3`\> | - -#### Returns - -`void` - -#### Implementation of - -[AreaCollection](../interfaces/cognite_reveal.AreaCollection.md).[addAreas](../interfaces/cognite_reveal.AreaCollection.md#addareas) - -#### Defined in - -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L34) - -___ - -### areas - -▸ **areas**(): `Generator`\<`Box3`, `any`, `unknown`\> - -Return some set of boxes that cover the boxes inserted with `addAreas`. -It is required that each inserted box is completely covered by some -subset of boxes in the set returned from `areas` - -#### Returns - -`Generator`\<`Box3`, `any`, `unknown`\> - -#### Implementation of - -[AreaCollection](../interfaces/cognite_reveal.AreaCollection.md).[areas](../interfaces/cognite_reveal.AreaCollection.md#areas) - -#### Defined in - -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L20) - -___ - -### intersectWith - -▸ **intersectWith**(`boxes`): `void` - -Alter the representative set to cover only the intersection between the -representative set of this AreaCollection and the incoming boxes. -Note that the intersection of two representative sets A' and B' that -represent the original box sets A and B will cover the intersection between -A and B, and will thus be a valid representative set for the intersection of A and B. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `boxes` | `Iterable`\<`Box3`\> | - -#### Returns - -`void` - -#### Implementation of - -[AreaCollection](../interfaces/cognite_reveal.AreaCollection.md).[intersectWith](../interfaces/cognite_reveal.AreaCollection.md#intersectwith) - -#### Defined in - -[packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/ClusteredAreaCollection.ts#L38) - -___ - -### intersectsBox - -▸ **intersectsBox**(`box`): `boolean` - -Return whether the input box intersects the AreaCollection. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `box` | `Box3` | - -#### Returns - -`boolean` - -#### Implementation of - -[AreaCollection](../interfaces/cognite_reveal.AreaCollection.md).[intersectsBox](../interfaces/cognite_reveal.AreaCollection.md#intersectsbox) - -#### Defined in - -[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 deleted file mode 100644 index 98164e068dd..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.Cognite3DViewer.md +++ /dev/null @@ -1,1395 +0,0 @@ ---- -id: "cognite_reveal.Cognite3DViewer" -title: "Class: Cognite3DViewer" -sidebar_label: "Cognite3DViewer" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).Cognite3DViewer - -## Constructors - -### constructor - -• **new Cognite3DViewer**(`options`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`Cognite3DViewerOptions`](../interfaces/cognite_reveal.Cognite3DViewerOptions.md) | - -#### Defined in - -[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 - -### cadBudget - -• `get` **cadBudget**(): [`CadModelBudget`](../modules/cognite_reveal.md#cadmodelbudget) - -Gets the current budget for downloading geometry for CAD models. Note that this -budget is shared between all added CAD models and not a per-model budget. - -#### Returns - -[`CadModelBudget`](../modules/cognite_reveal.md#cadmodelbudget) - -#### Defined in - -[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` - -Sets the current budget for downloading geometry for CAD models. Note that this -budget is shared between all added CAD models and not a per-model budget. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `budget` | [`CadModelBudget`](../modules/cognite_reveal.md#cadmodelbudget) | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:207](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L207) - -___ - -### cameraManager - -• `get` **cameraManager**(): [`CameraManager`](../interfaces/cognite_reveal.CameraManager.md) - -#### Returns - -[`CameraManager`](../interfaces/cognite_reveal.CameraManager.md) - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:647](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L647) - -___ - -### canvas - -• `get` **canvas**(): `HTMLCanvasElement` - -Returns the rendering canvas, the DOM element where the renderer draws its output. - -#### Returns - -`HTMLCanvasElement` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:111](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L111) - -___ - -### domElement - -• `get` **domElement**(): `HTMLElement` - -The DOM element the viewer will insert its rendering canvas into. -The DOM element can be specified in the options when the viewer is created. -If not specified, the DOM element will be created automatically. -The DOM element cannot be changed after the viewer has been created. - -#### Returns - -`HTMLElement` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:121](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L121) - -___ - -### models - -• `get` **models**(): [`CogniteModel`](../modules/cognite_reveal.md#cognitemodel)[] - -Gets a list of models currently added to the viewer. - -#### Returns - -[`CogniteModel`](../modules/cognite_reveal.md#cognitemodel)[] - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:232](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L232) - -___ - -### pointCloudBudget - -• `get` **pointCloudBudget**(): [`PointCloudBudget`](../modules/cognite_reveal.md#pointcloudbudget) - -Returns the point cloud budget. The budget is shared between all loaded -point cloud models. - -#### Returns - -[`PointCloudBudget`](../modules/cognite_reveal.md#pointcloudbudget) - -#### Defined in - -[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` - -Sets the point cloud budget. The budget is shared between all loaded -point cloud models. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `budget` | [`PointCloudBudget`](../modules/cognite_reveal.md#pointcloudbudget) | - -#### Returns - -`void` - -#### Defined in - -[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 - -### add360ImageSet - -▸ **add360ImageSet**(`datasource`, `eventFilter`, `add360ImageOptions?`): `Promise`\<[`Image360Collection`](../interfaces/cognite_reveal.Image360Collection.md)\> - -Adds a set of 360 images to the scene from the /events API in Cognite Data Fusion. - -**`Example`** - -```js -const eventFilter = { site_id: "12345" }; -await viewer.add360ImageSet('events', eventFilter); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `datasource` | ``"events"`` | The CDF data source which holds the references to the 360 image sets. | -| `eventFilter` | `Object` | The metadata filter to apply when querying events that contains the 360 images. | -| `add360ImageOptions?` | [`AddImage360Options`](../modules/cognite_reveal.md#addimage360options) | Options for behaviours when adding 360 images. | - -#### Returns - -`Promise`\<[`Image360Collection`](../interfaces/cognite_reveal.Image360Collection.md)\> - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:787](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L787) - -___ - -### addCadModel - -▸ **addCadModel**(`options`): `Promise`\<[`CogniteCadModel`](cognite_reveal.CogniteCadModel.md)\> - -Add a new CAD 3D model to the viewer. -Call [fitCameraToModel](cognite_reveal.Cognite3DViewer.md#fitcameratomodel) to see the model after the model has loaded. - -**`Example`** - -```js -const options = { -modelId: 'COGNITE_3D_MODEL_ID', -revisionId: 'COGNITE_3D_REVISION_ID', -}; -viewer.addCadModel(options).then(model => { -viewer.fitCameraToModel(model, 0); -}); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`AddModelOptions`](../interfaces/cognite_reveal.AddModelOptions.md) | - -#### Returns - -`Promise`\<[`CogniteCadModel`](cognite_reveal.CogniteCadModel.md)\> - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:733](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L733) - -___ - -### addModel - -▸ **addModel**(`options`): `Promise`\<[`CogniteModel`](../modules/cognite_reveal.md#cognitemodel)\> - -Add a new model to the viewer. -Call [fitCameraToModel](cognite_reveal.Cognite3DViewer.md#fitcameratomodel) to see the model after the model has loaded. - -**`Example`** - -```js -const options = { -modelId: 'COGNITE_3D_MODEL_ID', -revisionId: 'COGNITE_3D_REVISION_ID', -}; -viewer.addModel(options).then(model => { -viewer.fitCameraToModel(model, 0); -}); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`AddModelOptions`](../interfaces/cognite_reveal.AddModelOptions.md) | - -#### Returns - -`Promise`\<[`CogniteModel`](../modules/cognite_reveal.md#cognitemodel)\> - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:700](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L700) - -___ - -### addObject3D - -▸ **addObject3D**(`object`): `void` - -Add a THREE.Object3D to the viewer. - -**`Example`** - -```js -const sphere = new THREE.Mesh( -new THREE.SphereGeometry(), -new THREE.MeshBasicMaterial() -); -viewer.addObject3D(sphere); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `Object3D`\<`Event`\> | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:950](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L950) - -___ - -### addPointCloudModel - -▸ **addPointCloudModel**(`options`): `Promise`\<[`CognitePointCloudModel`](cognite_reveal.CognitePointCloudModel.md)\> - -Add a new pointcloud 3D model to the viewer. -Call [fitCameraToModel](cognite_reveal.Cognite3DViewer.md#fitcameratomodel) to see the model after the model has loaded. - -**`Example`** - -```js -const options = { -modelId: 'COGNITE_3D_MODEL_ID', -revisionId: 'COGNITE_3D_REVISION_ID', -}; -viewer.addPointCloudModel(options).then(model => { -viewer.fitCameraToModel(model, 0); -}); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`AddModelOptions`](../interfaces/cognite_reveal.AddModelOptions.md) | - -#### Returns - -`Promise`\<[`CognitePointCloudModel`](cognite_reveal.CognitePointCloudModel.md)\> - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:761](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L761) - -___ - -### determineModelType - -▸ **determineModelType**(`modelId`, `revisionId`): `Promise`\<``""`` \| [`SupportedModelTypes`](../modules/cognite_reveal.md#supportedmodeltypes)\> - -Use to determine of which type the model is. - -**`Example`** - -```typescript -const viewer = new Cognite3DViewer(...); -const type = await viewer.determineModelType(options.modelId, options.revisionId) -let model: CogniteModel -switch (type) { - case 'cad': - model = await viewer.addCadModel(options); - break; - case 'pointcloud': - model = await viewer.addPointCloudModel(options); - break; - default: - throw new Error('Model is not supported'); -} -viewer.fitCameraToModel(model); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `modelId` | `number` | The model's id. | -| `revisionId` | `number` | The model's revision id. | - -#### Returns - -`Promise`\<``""`` \| [`SupportedModelTypes`](../modules/cognite_reveal.md#supportedmodeltypes)\> - -Empty string if type is not supported. - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:917](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L917) - -___ - -### dispose - -▸ **dispose**(): `void` - -Dispose of WebGL resources. Can be used to free up memory when the viewer is no longer in use. - -**`See`** - -[https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects](https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects) -```ts -// Viewer is no longer in use, free up memory -viewer.dispose(); -```. - -#### Returns - -`void` - -#### Defined in - -[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`, `revision?`): `Promise`\<`void`\> - -Enter visualization of a 360 image. - -#### Parameters - -| 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 - -`Promise`\<`void`\> - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:835](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L835) - -___ - -### exit360Image - -▸ **exit360Image**(): `void` - -Exit visualization of the 360 image. - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:845](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L845) - -___ - -### fitCameraToBoundingBox - -▸ **fitCameraToBoundingBox**(`box`, `duration?`, `radiusFactor?`): `void` - -Move camera to a place where the content of a bounding box is visible to the camera. - -**`Example`** - -```js -// Fit camera to bounding box over 500 milliseconds -viewer.fitCameraToBoundingBox(boundingBox, 500); -``` -```js -// Fit camera to bounding box instantaneously -viewer.fitCameraToBoundingBox(boundingBox, 0); -``` -```js -// Place the camera closer to the bounding box -viewer.fitCameraToBoundingBox(boundingBox, 500, 2); -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `box` | `Box3` | `undefined` | The bounding box in world space. | -| `duration?` | `number` | `undefined` | The duration of the animation moving the camera. Set this to 0 (zero) to disable animation. | -| `radiusFactor` | `number` | `2` | The ratio of the distance from camera to center of box and radius of the box. | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1142](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1142) - -___ - -### fitCameraToModel - -▸ **fitCameraToModel**(`model`, `duration?`): `void` - -Move camera to a place where the 3D model is visible. -It uses the bounding box of the 3D model and calls [fitCameraToBoundingBox](cognite_reveal.Cognite3DViewer.md#fitcameratoboundingbox). - -**`Example`** - -```js -// Fit camera to model -viewer.fitCameraToModel(model); -``` -```js -// Fit camera to model over 500 milliseconds -viewer.fitCameraToModel(model, 500); -``` -```js -// Fit camera to model instantly -viewer.fitCameraToModel(model, 0); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `model` | [`CogniteModel`](../modules/cognite_reveal.md#cognitemodel) | The 3D model. | -| `duration?` | `number` | The duration of the animation moving the camera. Set this to 0 (zero) to disable animation. | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1097](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1097) - -___ - -### fitCameraToModels - -▸ **fitCameraToModels**(`models?`, `duration?`, `restrictToMostGeometry?`): `void` - -Move camera to a place where a set of 3D models are visible. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `models?` | [`CogniteModel`](../modules/cognite_reveal.md#cognitemodel)[] | `undefined` | Optional 3D models to focus the camera on. If no models are provided the camera will fit to all models. | -| `duration?` | `number` | `undefined` | The duration of the animation moving the camera. Set this to 0 (zero) to disable animation. | -| `restrictToMostGeometry` | `boolean` | `false` | If true, attempt to remove junk geometry from the bounds to allow setting a good camera position. | - -#### Returns - -`void` - -#### Defined in - -[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) - -___ - -### getClippingPlanes - -▸ **getClippingPlanes**(): `Plane`[] - -Returns the current active global clipping planes. - -**`Deprecated`** - -Use [getGlobalClippingPlanes](cognite_reveal.Cognite3DViewer.md#getglobalclippingplanes) instead. - -#### Returns - -`Plane`[] - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1048](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1048) - -___ - -### getGlobalClippingPlanes - -▸ **getGlobalClippingPlanes**(): `Plane`[] - -Returns the current active global clipping planes. - -#### Returns - -`Plane`[] - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1055](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1055) - -___ - -### getIntersectionFromPixel - -▸ **getIntersectionFromPixel**(`offsetX`, `offsetY`): `Promise`\<``null`` \| [`Intersection`](../modules/cognite_reveal.md#intersection)\> - -Raycasting model(s) for finding where the ray intersects with the model. - -**`See`** - -[https://en.wikipedia.org/wiki/Ray_casting](https://en.wikipedia.org/wiki/Ray_casting) For more details on Ray casting. - -**`Example`** - -For CAD model -```js -const offsetX = 50 // pixels from the left -const offsetY = 100 // pixels from the top -const intersection = await viewer.getIntersectionFromPixel(offsetX, offsetY); -if (intersection) // it was a hit - console.log( - 'You hit model ', intersection.model, - ' at the node with tree index ', intersection.treeIndex, - ' at this exact point ', intersection.point - ); -``` - -**`Example`** - -For point cloud -```js -const offsetX = 50 // pixels from the left -const offsetY = 100 // pixels from the top -const intersection = await viewer.getIntersectionFromPixel(offsetX, offsetY); -if (intersection) // it was a hit - console.log( - 'You hit model ', intersection.model, - ' at the point index ', intersection.pointIndex, - ' at this exact point ', intersection.point - ); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `offsetX` | `number` | X coordinate in pixels (relative to the domElement). | -| `offsetY` | `number` | Y coordinate in pixels (relative to the domElement). | - -#### Returns - -`Promise`\<``null`` \| [`Intersection`](../modules/cognite_reveal.md#intersection)\> - -A promise that if there was an intersection then return the intersection object - otherwise it -returns `null` if there were no intersections. - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1364](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1364) - -___ - -### getScreenshot - -▸ **getScreenshot**(`width?`, `height?`, `includeUI?`): `Promise`\<`string`\> - -Take a screenshot from the current camera position. When drawing UI, only the viewer DOM element and its children will be included in the image. -The DOM is scaled to fit any provided resolution, and as a result some elements can be positioned incorrectly in regards to the 3D render. - -`html2canvas` is used to draw UI and this has some limitations on what CSS properties it is able to render. See [the html2canvas documentation](https://html2canvas.hertzen.com/documentation) for details. - -**`Example`** - -```js -// Take a screenshot with custom resolution -const url = await viewer.getScreenshot(1920, 1080); -``` -```js -// Add a screenshot with resolution of the canvas to the page -const url = await viewer.getScreenshot(); -const image = document.createElement('img'); -image.src = url; -document.body.appendChild(image); -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `width` | `number` | `undefined` | Width of the final image. Default is current canvas size. | -| `height` | `number` | `undefined` | Height of the final image. Default is current canvas size. | -| `includeUI` | `boolean` | `true` | If false the screenshot will include only the rendered 3D. Default is true. | - -#### Returns - -`Promise`\<`string`\> - -A [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) of the image ('image/png'). - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1234](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1234) - -___ - -### getVersion - -▸ **getVersion**(): `string` - -Returns reveal version installed. - -#### Returns - -`string` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:400](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L400) - -___ - -### getViewState - -▸ **getViewState**(): [`ViewerState`](../modules/cognite_reveal.md#viewerstate) - -Gets the current viewer state which includes the camera pose as well as applied styling. - -#### Returns - -[`ViewerState`](../modules/cognite_reveal.md#viewerstate) - -JSON object containing viewer state. - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:664](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L664) - -___ - -### loadCameraFromModel - -▸ **loadCameraFromModel**(`model`): `void` - -Attempts to load the camera settings from the settings stored for the -provided model. See [https://docs.cognite.com/api/v1/#operation/get3DRevision](https://docs.cognite.com/api/v1/#operation/get3DRevision) -and [https://docs.cognite.com/api/v1/#operation/update3DRevisions](https://docs.cognite.com/api/v1/#operation/update3DRevisions) for -information on how this setting is retrieved and stored. This setting can -also be changed through the 3D models management interface in Cognite Fusion. -If no camera configuration is stored in CDF, [fitCameraToModel](cognite_reveal.Cognite3DViewer.md#fitcameratomodel) -is used as a fallback. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `model` | [`CogniteModel`](../modules/cognite_reveal.md#cognitemodel) | The model to load camera settings from. | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1069](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1069) - -___ - -### off - -▸ **off**(`event`, `callback`): `void` - -**`Example`** - -```js -viewer.off('click', onClick); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"click"`` \| ``"hover"`` | -| `callback` | [`PointerEventDelegate`](../modules/cognite_reveal.md#pointereventdelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -**`Example`** - -```js -viewer.off('cameraChange', onCameraChange); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"cameraChange"`` | -| `callback` | [`CameraChangeDelegate`](../modules/cognite_reveal.md#camerachangedelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -Unsubscribe the 'beforeSceneRendered'-event previously subscribed with [on](cognite_reveal.Cognite3DViewer.md#on). - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"beforeSceneRendered"`` | -| `callback` | [`BeforeSceneRenderedDelegate`](../modules/cognite_reveal.md#beforescenerendereddelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -**`Example`** - -```js -viewer.off('sceneRendered', updateStats); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"sceneRendered"`` | -| `callback` | [`SceneRenderedDelegate`](../modules/cognite_reveal.md#scenerendereddelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -**`Example`** - -```js -viewer.off('disposed', clearAll); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `callback` | [`DisposedDelegate`](../modules/cognite_reveal.md#disposeddelegate) | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:595](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L595) - -___ - -### on - -▸ **on**(`event`, `callback`): `void` - -Triggered when the viewer is disposed. Listeners should clean up any -resources held and remove the reference to the viewer. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `callback` | [`DisposedDelegate`](../modules/cognite_reveal.md#disposeddelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -**`Example`** - -```js -const onClick = (event) => { console.log(event.offsetX, event.offsetY) }; -viewer.on('click', onClick); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"click"`` \| ``"hover"`` | -| `callback` | [`PointerEventDelegate`](../modules/cognite_reveal.md#pointereventdelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -**`Example`** - -```js -viewer.on('cameraChange', (position, target) => { - console.log('Camera changed: ', position, target); -}); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"cameraChange"`` | -| `callback` | [`CameraChangeDelegate`](../modules/cognite_reveal.md#camerachangedelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -Event that is triggered immediately before the scene is rendered. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"beforeSceneRendered"`` | Metadata about the rendering frame. | -| `callback` | [`BeforeSceneRenderedDelegate`](../modules/cognite_reveal.md#beforescenerendereddelegate) | Callback to trigger when event occurs. | - -#### Returns - -`void` - -#### Defined in - -[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` - -Event that is triggered immediately after the scene has been rendered. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"sceneRendered"`` | Metadata about the rendering frame. | -| `callback` | [`SceneRenderedDelegate`](../modules/cognite_reveal.md#scenerendereddelegate) | Callback to trigger when the event occurs. | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:506](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L506) - -___ - -### remove360Images - -▸ **remove360Images**(`...image360Entities`): `Promise`\<`void`\> - -Remove a set of 360 images. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...image360Entities` | [`Image360`](../interfaces/cognite_reveal.Image360.md)[] | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:823](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L823) - -___ - -### removeModel - -▸ **removeModel**(`model`): `void` - -Removes a model that was previously added using [addModel](cognite_reveal.Cognite3DViewer.md#addmodel), -[addCadModel](cognite_reveal.Cognite3DViewer.md#addcadmodel) or [addPointCloudModel](cognite_reveal.Cognite3DViewer.md#addpointcloudmodel) -. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `model` | [`CogniteModel`](../modules/cognite_reveal.md#cognitemodel) | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:858](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L858) - -___ - -### removeObject3D - -▸ **removeObject3D**(`object`): `void` - -Remove a THREE.Object3D from the viewer. - -**`Example`** - -```js -const sphere = new THREE.Mesh(new THREE.SphereGeometry(), new THREE.MeshBasicMaterial()); -viewer.addObject3D(sphere); -viewer.removeObject3D(sphere); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `object` | `Object3D`\<`Event`\> | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:970](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L970) - -___ - -### requestRedraw - -▸ **requestRedraw**(): `void` - -Typically used when you perform some changes and can't see them unless you move camera. - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1149](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1149) - -___ - -### setBackgroundColor - -▸ **setBackgroundColor**(`backgroundColor`): `void` - -Sets the color used as the clear color of the renderer. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `backgroundColor` | `Object` | -| `backgroundColor.alpha?` | `number` | -| `backgroundColor.color?` | `Color` | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:985](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L985) - -___ - -### setCameraManager - -▸ **setCameraManager**(`cameraManager`): `void` - -Sets the active camera manager instance for current Cognite3Dviewer. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cameraManager` | [`CameraManager`](../interfaces/cognite_reveal.CameraManager.md) | Camera manager instance. | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:655](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L655) - -___ - -### setClippingPlanes - -▸ **setClippingPlanes**(`clippingPlanes`): `void` - -Sets per-pixel clipping planes. Pixels behind any of the planes will be sliced away. - -**`Deprecated`** - -Use [setGlobalClippingPlanes](cognite_reveal.Cognite3DViewer.md#setglobalclippingplanes) instead. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `clippingPlanes` | `Plane`[] | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1040](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1040) - -___ - -### setGlobalClippingPlanes - -▸ **setGlobalClippingPlanes**(`clippingPlanes`): `void` - -Sets per-pixel clipping planes. Pixels behind any of the planes will be sliced away. - -**`Example`** - -```js -// Hide pixels with values less than 0 in the x direction -const plane = new THREE.Plane(new THREE.Vector3(1, 0, 0), 0); -viewer.setGlobalClippingPlanes([plane]); -``` -```js -// Hide pixels with values greater than 20 in the x direction - const plane = new THREE.Plane(new THREE.Vector3(-1, 0, 0), 20); -viewer.setGlobalClippingPlanes([plane]); -``` -```js -// Hide pixels with values less than 0 in the x direction or greater than 0 in the y direction -const xPlane = new THREE.Plane(new THREE.Vector3(1, 0, 0), 0); -const yPlane = new THREE.Plane(new THREE.Vector3(0, -1, 0), 0); -viewer.setGlobalClippingPlanes([xPlane, yPlane]); -``` -```js -// Hide pixels behind an arbitrary, non axis-aligned plane - const plane = new THREE.Plane(new THREE.Vector3(1.5, 20, -19), 20); -viewer.setGlobalClippingPlanes([plane]); -``` -```js -// Disable clipping planes - viewer.setGlobalClippingPlanes([]); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `clippingPlanes` | `Plane`[] | The planes to use for clipping. | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:1030](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L1030) - -___ - -### setLogLevel - -▸ **setLogLevel**(`level`): `void` - -Sets the log level. Used for debugging. -Defaults to 'none' (which is identical to 'silent'). - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `level` | ``"error"`` \| ``"debug"`` \| ``"none"`` \| ``"trace"`` \| ``"info"`` \| ``"warn"`` \| ``"silent"`` | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:409](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L409) - -___ - -### setResolutionOptions - -▸ **setResolutionOptions**(`options`): `void` - -Set options to control resolution of the viewer. This includes -settings for max resolution and limiting resolution when moving the camera. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`ResolutionOptions`](../modules/cognite_reveal.md#resolutionoptions) | Options to apply. | - -#### Returns - -`void` - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:387](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L387) - -___ - -### setViewState - -▸ **setViewState**(`state`): `Promise`\<`void`\> - -Restores camera settings from the state provided, and clears all current styled -node collections and applies the `state` object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | [`ViewerState`](../modules/cognite_reveal.md#viewerstate) | Viewer state retrieved from [getViewState](cognite_reveal.Cognite3DViewer.md#getviewstate). | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/api/src/public/migration/Cognite3DViewer.ts:674](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/Cognite3DViewer.ts#L674) - -___ - -### worldToScreen - -▸ **worldToScreen**(`point`, `normalize?`): ``null`` \| `Vector2` - -Convert a point in world space to its coordinates in the canvas. This can be used to place HTML objects near 3D objects on top of the 3D viewer. - -**`See`** - -[https://www.w3schools.com/graphics/canvas_coordinates.asp](https://www.w3schools.com/graphics/canvas_coordinates.asp) For details on HTML Canvas Coordinates. - -**`Example`** - -```js -const boundingBoxCenter = new THREE.Vector3(); -// Find center of bounding box in world space -model.getBoundingBox(nodeId).getCenter(boundingBoxCenter); -// Screen coordinates of that point -const screenCoordinates = viewer.worldToScreen(boundingBoxCenter); -``` -```js -const boundingBoxCenter = new THREE.Vector3(); -// Find center of bounding box in world space -model.getBoundingBox(nodeId).getCenter(boundingBoxCenter); -// Screen coordinates of that point normalized in the range [0,1] -const screenCoordinates = viewer.worldToScreen(boundingBoxCenter, true); -``` -```js -const boundingBoxCenter = new THREE.Vector3(); -// Find center of bounding box in world space -model.getBoundingBox(nodeId).getCenter(boundingBoxCenter); -// Screen coordinates of that point -const screenCoordinates = viewer.worldToScreen(boundingBoxCenter); -if (screenCoordinates == null) { - // Object not visible on screen -} else { - // Object is visible on screen -} -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `point` | `Vector3` | World space coordinate. | -| `normalize?` | `boolean` | Optional. If true, coordinates are normalized into [0,1]. If false, the values are in the range [0, \). | - -#### Returns - -``null`` \| `Vector2` - -Returns 2D coordinates if the point is visible on screen, or `null` if object is outside screen. - -#### Defined in - -[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 deleted file mode 100644 index ac16aa7377e..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CogniteCadModel.md +++ /dev/null @@ -1,940 +0,0 @@ ---- -id: "cognite_reveal.CogniteCadModel" -title: "Class: CogniteCadModel" -sidebar_label: "CogniteCadModel" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).CogniteCadModel - -Provides metadata needed to get asset mappings for a CDF 3D model - -## Implements - -- [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) - -## Properties - -### modelId - -• `Readonly` **modelId**: `number` - -The CDF model ID of the model. - -#### Implementation of - -[CdfModelNodeCollectionDataProvider](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md).[modelId](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md#modelid) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:75](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L75) - -___ - -### revisionId - -• `Readonly` **revisionId**: `number` - -The CDF revision ID of the model. - -#### Implementation of - -[CdfModelNodeCollectionDataProvider](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md).[revisionId](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md#revisionid) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:79](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L79) - -___ - -### type - -• `Readonly` **type**: [`SupportedModelTypes`](../modules/cognite_reveal.md#supportedmodeltypes) = `'cad'` - -#### Defined in - -[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 - -### modelUnit - -• `get` **modelUnit**(): ``""`` \| [`WellKnownUnit`](../modules/cognite_reveal.md#wellknownunit) - -Returns the unit the coordinates for the model is stored. Returns an empty string -if no unit has been stored. -Note that coordinates in Reveal always are converted to meters using [modelUnitToMetersFactor](cognite_reveal.CogniteCadModel.md#modelunittometersfactor). - -#### Returns - -``""`` \| [`WellKnownUnit`](../modules/cognite_reveal.md#wellknownunit) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:40](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L40) - -___ - -### modelUnitToMetersFactor - -• `get` **modelUnitToMetersFactor**(): `undefined` \| `number` - -Returns the conversion factor that converts from model coordinates to meters. Note that this can -return undefined if the model has been stored in an unsupported unit. - -#### Returns - -`undefined` \| `number` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L50) - -___ - -### nodeCount - -• `get` **nodeCount**(): `number` - -Returns the number of nodes in the model. - -#### Returns - -`number` - -#### Implementation of - -[CdfModelNodeCollectionDataProvider](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md).[nodeCount](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md#nodecount) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:458](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L458) - -___ - -### styledNodeCollections - -• `get` **styledNodeCollections**(): \{ `appearance`: [`NodeAppearance`](../modules/cognite_reveal.md#nodeappearance) ; `nodeCollection`: [`NodeCollection`](cognite_reveal.NodeCollection.md) }[] - -Returns all currently registered node collections and associated appearance. - -#### Returns - -\{ `appearance`: [`NodeAppearance`](../modules/cognite_reveal.md#nodeappearance) ; `nodeCollection`: [`NodeCollection`](cognite_reveal.NodeCollection.md) }[] - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:127](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L127) - -___ - -### visible - -• `get` **visible**(): `boolean` - -Returns the model visibility. - -#### Returns - -`boolean` - -#### Defined in - -[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` - -Sets the model visibility. - -**`Example`** - -```js -model.visible = false -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[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 - -### assignStyledNodeCollection - -▸ **assignStyledNodeCollection**(`nodeCollection`, `appearance`): `void` - -Customizes rendering style for a set of nodes, e.g. to highlight, hide -or color code a set of 3D objects. This allows for custom look and feel -of the 3D model which is useful to highlight certain parts or to -color code the 3D model based on information (e.g. coloring the 3D model -by construction status). - -The [NodeCollection](cognite_reveal.NodeCollection.md) can be updated dynamically and the rendered nodes will be -updated automatically as the styling changes. The appearance of the style nodes -cannot be changed. - -When nodes are in several styled sets, the style is combined in the order -the sets were added, i.e. styled sets added late can overwrite styled sets added -early. - -If the `nodeCollection` provided already has an assigned style, this style will -be replaced with style provided. - -**`Example`** - -```js -model.setDefaultNodeAppearance({ rendererGhosted: true }); -const visibleNodes = new TreeIndexNodeCollection(someTreeIndices); -model.assignStyledNodeCollection(visibleSet, { rendererGhosted: false }); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | Dynamic set of nodes to apply the provided appearance to. | -| `appearance` | [`NodeAppearance`](../modules/cognite_reveal.md#nodeappearance) | Appearance to style the provided set with. | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:158](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L158) - -___ - -### dispose - -▸ **dispose**(): `void` - -Cleans up used resources. - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:247](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L247) - -___ - -### getAncestorTreeIndices - -▸ **getAncestorTreeIndices**(`treeIndex`, `generation`): `Promise`\<[`NumericRange`](cognite_reveal.NumericRange.md)\> - -Determines the tree index range of a subtree of an ancestor of the provided -node defined by a tree index. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndex` | `number` | Tree index of node to find ancestor tree index range for. | -| `generation` | `number` | What "generation" to find. 0 is the node itself, 1 means parent, 2 means grandparent etc. If the node doesn't have as many ancestors, the root of the model is returned. This can be determined by checking that the range returned includes 0. | - -#### Returns - -`Promise`\<[`NumericRange`](cognite_reveal.NumericRange.md)\> - -Tree index range of the subtree spanned by the ancestor at the -"generation" specified, or the root. - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:271](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L271) - -___ - -### getBoundingBoxByNodeId - -▸ **getBoundingBoxByNodeId**(`nodeId`, `box?`): `Promise`\<`Box3`\> - -Fetches a bounding box from the CDF by the nodeId. - -**`Example`** - -```js -const box = new THREE.Box3() -const nodeId = 100500; -await model.getBoundingBoxByNodeId(nodeId, box); -// box now has the bounding box -``` -```js -// the following code does the same -const box = await model.getBoundingBoxByNodeId(nodeId); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeId` | `number` | | -| `box?` | `Box3` | Optional. Used to write result to. | - -#### Returns - -`Promise`\<`Box3`\> - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:399](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L399) - -___ - -### getBoundingBoxByTreeIndex - -▸ **getBoundingBoxByTreeIndex**(`treeIndex`, `box?`): `Promise`\<`Box3`\> - -Determine the bounding box of the node identified by the tree index provided. Note that this -function uses the CDF API to look up the bounding box. - -**`Example`** - -```js -const box = new THREE.Box3() -const treeIndex = 42; -await model.getBoundingBoxByTreeIndex(treeIndex, box); -// box now has the bounding box -``` -```js -// the following code does the same -const box = await model.getBoundingBoxByTreeIndex(treeIndex); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndex` | `number` | Tree index of the node to find bounding box for. | -| `box?` | `Box3` | Optional preallocated container to hold the bounding box. | - -#### Returns - -`Promise`\<`Box3`\> - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:434](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L434) - -___ - -### getCameraConfiguration - -▸ **getCameraConfiguration**(): `undefined` \| [`CameraConfiguration`](../modules/cognite_reveal.md#cameraconfiguration) - -Retrieves the camera position and target stored for the model. Typically this -is used to store a good starting position for a model. Returns `undefined` if there -isn't any stored camera configuration for the model. - -#### Returns - -`undefined` \| [`CameraConfiguration`](../modules/cognite_reveal.md#cameraconfiguration) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:318](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L318) - -___ - -### getCdfToDefaultModelTransformation - -▸ **getCdfToDefaultModelTransformation**(`out?`): `Matrix4` - -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 [setModelTransformation](cognite_reveal.CogniteCadModel.md#setmodeltransformation) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `out?` | `Matrix4` | Preallocated `THREE.Matrix4` (optional) | - -#### Returns - -`Matrix4` - -#### Implementation of - -[CdfModelNodeCollectionDataProvider](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md).[getCdfToDefaultModelTransformation](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md#getcdftodefaultmodeltransformation) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:359](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L359) - -___ - -### getDefaultNodeAppearance - -▸ **getDefaultNodeAppearance**(): [`NodeAppearance`](../modules/cognite_reveal.md#nodeappearance) - -Gets the default appearance for nodes that are not styled using -[assignStyledNodeCollection](cognite_reveal.CogniteCadModel.md#assignstylednodecollection). - -#### Returns - -[`NodeAppearance`](../modules/cognite_reveal.md#nodeappearance) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:120](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L120) - -___ - -### getModelBoundingBox - -▸ **getModelBoundingBox**(`outBbox?`, `restrictToMostGeometry?`): `Box3` - -Determines the full bounding box of the model. - -**`Example`** - -```js -const box = new THREE.Box3() -model.getModelBoundingBox(box); -// box now has the bounding box -``` -```js -// the following code does the same -const box = model.getModelBoundingBox(); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outBbox?` | `Box3` | Optional. Used to write result to. | -| `restrictToMostGeometry?` | `boolean` | Optional. When true, returned bounds are restricted to where most of the geometry is located. This is useful for models that have junk geometry located far from the "main" model. Added in version 1.3.0. | - -#### Returns - -`Box3` - -Model bounding box. - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:302](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L302) - -___ - -### getModelClippingPlanes - -▸ **getModelClippingPlanes**(): `Plane`[] - -Get the clipping planes for this model. - -#### Returns - -`Plane`[] - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:349](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L349) - -___ - -### getModelTransformation - -▸ **getModelTransformation**(`out?`): `Matrix4` - -Gets transformation matrix that has previously been set with [setModelTransformation](cognite_reveal.CogniteCadModel.md#setmodeltransformation). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `out?` | `Matrix4` | Preallocated `THREE.Matrix4` (optional). | - -#### Returns - -`Matrix4` - -#### Implementation of - -[CdfModelNodeCollectionDataProvider](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md).[getModelTransformation](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md#getmodeltransformation) - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:334](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L334) - -___ - -### getSubtreeTreeIndices - -▸ **getSubtreeTreeIndices**(`treeIndex`): `Promise`\<[`NumericRange`](cognite_reveal.NumericRange.md)\> - -Determines the range of tree indices for a given subtree. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndex` | `number` | Index of the root of the subtree to get the index range for. | - -#### Returns - -`Promise`\<[`NumericRange`](cognite_reveal.NumericRange.md)\> - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:255](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L255) - -___ - -### iterateNodesByTreeIndex - -▸ **iterateNodesByTreeIndex**(`action`): `Promise`\<`void`\> - -Iterates over all nodes in the model and applies the provided action to each node (identified by tree index). -The passed action is applied incrementally to avoid main thread blocking, meaning that the changes can be partially -applied until promise is resolved (iteration is done). - -**`Example`** - -```js -const logIndex = (treeIndex) => console.log(treeIndex); -await model.iterateNodesByTreeIndex(logIndex); // 0, 1, 2, ... -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `action` | (`treeIndex`: `number`) => `void` | Function that will be called with a treeIndex argument. | - -#### Returns - -`Promise`\<`void`\> - -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/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L451) - -___ - -### iterateSubtreeByTreeIndex - -▸ **iterateSubtreeByTreeIndex**(`treeIndex`, `action`): `Promise`\<`void`\> - -Iterates over all nodes in a subtree of the model and applies the provided action to each node -(identified by tree index). The provided node is included in the visited set. The passed action -is applied incrementally to avoid main thread blocking, meaning that the changes can be partially -applied until promise is resolved (iteration is done). - -**`Example`** - -```js -// make a subtree to be gray -await model.iterateNodesByTreeIndex(treeIndex => { - model.setNodeColorByTreeIndex(treeIndex, 127, 127, 127); -}); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndex` | `number` | Tree index of the top parent of the subtree. | -| `action` | (`treeIndex`: `number`) => `void` | Function that will be called with a treeIndex argument. | - -#### Returns - -`Promise`\<`void`\> - -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/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L478) - -___ - -### mapBoxFromCdfToModelCoordinates - -▸ **mapBoxFromCdfToModelCoordinates**(`box`, `out?`): `Box3` - -Map bounding box from CDF to model space, taking the model's custom transformation into account - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `box` | `Box3` | Box to compute transformation from | -| `out` | `Box3` | Optional pre-allocated box | - -#### Returns - -`Box3` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:378](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L378) - -___ - -### mapNodeIdToTreeIndex - -▸ **mapNodeIdToTreeIndex**(`nodeId`): `Promise`\<`number`\> - -Maps a single node ID to tree index. This is useful when you e.g. have a -node ID from an asset mapping and want to highlight the given asset using -[mapNodeIdsToTreeIndices](cognite_reveal.CogniteCadModel.md#mapnodeidstotreeindices) is recommended for better performance when -mapping multiple IDs. - -**`Throws`** - -If an invalid/non-existant node ID is provided the function throws an error. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeId` | `number` | A Node ID to map to a tree index. | - -#### Returns - -`Promise`\<`number`\> - -TreeIndex of the provided node. - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:506](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L506) - -___ - -### mapNodeIdsToTreeIndices - -▸ **mapNodeIdsToTreeIndices**(`nodeIds`): `Promise`\<`number`[]\> - -Maps a list of Node IDs to tree indices. This function is useful when you have -a list of nodes, e.g. from Asset Mappings, that you want to highlight, hide, -color etc in the viewer. - -**`Throws`** - -If an invalid/non-existant node ID is provided the function throws an error. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeIds` | `number`[] | List of node IDs to map to tree indices. | - -#### Returns - -`Promise`\<`number`[]\> - -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/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L492) - -___ - -### mapPointFromCdfToModelCoordinates - -▸ **mapPointFromCdfToModelCoordinates**(`point`, `out?`): `Vector3` - -Map point from CDF to model space, taking the model's custom transformation into account - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `point` | `Vector3` | Point to compute transformation from | -| `out` | `Vector3` | Optional pre-allocated point | - -#### Returns - -`Vector3` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:368](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L368) - -___ - -### mapTreeIndexToNodeId - -▸ **mapTreeIndexToNodeId**(`treeIndex`): `Promise`\<`number`\> - -Maps a single tree index to node ID for use with the API. If you have multiple -tree indices to map, [mapNodeIdsToTreeIndices](cognite_reveal.CogniteCadModel.md#mapnodeidstotreeindices) is recommended for better -performance. - -**`Throws`** - -If an invalid/non-existent node ID is provided the function throws an error. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndex` | `number` | A tree index to map to a Node ID. | - -#### Returns - -`Promise`\<`number`\> - -TreeIndex of the provided node. - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:532](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L532) - -___ - -### mapTreeIndicesToNodeIds - -▸ **mapTreeIndicesToNodeIds**(`treeIndices`): `Promise`\<`number`[]\> - -Maps a list of tree indices to node IDs for use with the Cognite SDK. -This function is useful if you have a list of tree indices, e.g. from -[iterateSubtreeByTreeIndex](cognite_reveal.CogniteCadModel.md#iteratesubtreebytreeindex), and want to perform -some operations on these nodes using the SDK. - -**`Throws`** - -If an invalid tree index is provided the function throws an error. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndices` | `number`[] | Tree indices to map to node IDs. | - -#### Returns - -`Promise`\<`number`[]\> - -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/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L520) - -___ - -### removeAllStyledNodeCollections - -▸ **removeAllStyledNodeCollections**(): `void` - -Removes all styled collections, resetting the appearance of all nodes to the -default appearance. - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:190](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L190) - -___ - -### resetNodeTransform - -▸ **resetNodeTransform**(`treeIndices`): `void` - -Resets the transformation for the nodes given. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndices` | [`NumericRange`](cognite_reveal.NumericRange.md) | Tree indices of the nodes to reset transforms for. | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:229](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L229) - -___ - -### resetNodeTransformByTreeIndex - -▸ **resetNodeTransformByTreeIndex**(`treeIndex`, `applyToChildren?`): `Promise`\<`number`\> - -Remove override transform of the node by tree index. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `treeIndex` | `number` | `undefined` | -| `applyToChildren` | `boolean` | `true` | - -#### Returns - -`Promise`\<`number`\> - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:238](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L238) - -___ - -### setDefaultNodeAppearance - -▸ **setDefaultNodeAppearance**(`appearance`): `void` - -Sets the default appearance for nodes that are not styled using -[assignStyledNodeCollection](cognite_reveal.CogniteCadModel.md#assignstylednodecollection). Updating the default style can be an -expensive operation, so use with care. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appearance` | [`NodeAppearance`](../modules/cognite_reveal.md#nodeappearance) | Default node appearance. | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:112](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L112) - -___ - -### setModelClippingPlanes - -▸ **setModelClippingPlanes**(`clippingPlanes`): `void` - -Sets the clipping planes for this model. They will be combined with the -global clipping planes. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `clippingPlanes` | `Plane`[] | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:342](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L342) - -___ - -### setModelTransformation - -▸ **setModelTransformation**(`matrix`): `void` - -Sets transformation matrix of the model. This overrides the current transformation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `matrix` | `Matrix4` | Transformation matrix. | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:326](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L326) - -___ - -### setNodeTransform - -▸ **setNodeTransform**(`treeIndices`, `transformMatrix`): `void` - -Apply a transformation matrix to the tree indices given, changing -rotation, scale and/or position. - -Note that setting multiple transformations for the same -node isn't supported and might lead to undefined results. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `treeIndices` | [`NumericRange`](cognite_reveal.NumericRange.md) | Tree indices of nodes to apply the transformation to. | -| `transformMatrix` | `Matrix4` | Transformation to apply. | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:204](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L204) - -___ - -### setNodeTransformByTreeIndex - -▸ **setNodeTransformByTreeIndex**(`treeIndex`, `transform`, `applyToChildren?`): `Promise`\<`number`\> - -Set override transform of the node by tree index. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `treeIndex` | `number` | `undefined` | -| `transform` | `Matrix4` | `undefined` | -| `applyToChildren` | `boolean` | `true` | - -#### Returns - -`Promise`\<`number`\> - -#### Defined in - -[packages/cad-model/src/wrappers/CogniteCadModel.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/wrappers/CogniteCadModel.ts#L215) - -___ - -### unassignStyledNodeCollection - -▸ **unassignStyledNodeCollection**(`nodeCollection`): `void` - -Removes styling for previously added styled collection, resetting the style to the default (or -the style imposed by other styled collections). - -**`Throws`** - -Error if node collection isn't assigned to the model. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | Node collection previously added using [assignStyledNodeCollection](cognite_reveal.CogniteCadModel.md#assignstylednodecollection). | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index f0c341b5b05..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CognitePointCloudModel.md +++ /dev/null @@ -1,709 +0,0 @@ ---- -id: "cognite_reveal.CognitePointCloudModel" -title: "Class: CognitePointCloudModel" -sidebar_label: "CognitePointCloudModel" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).CognitePointCloudModel - -## Properties - -### modelId - -• `Readonly` **modelId**: `number` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L30) - -___ - -### revisionId - -• `Readonly` **revisionId**: `number` - -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/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L34) - -___ - -### type - -• `Readonly` **type**: [`SupportedModelTypes`](../modules/cognite_reveal.md#supportedmodeltypes) = `'pointcloud'` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:29](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L29) - -## Accessors - -### pointColorType - -• `get` **pointColorType**(): [`PointColorType`](../enums/cognite_reveal.PointColorType.md) - -Determines how points currently are colored. - -#### Returns - -[`PointColorType`](../enums/cognite_reveal.PointColorType.md) - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:186](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L186) - -• `set` **pointColorType**(`type`): `void` - -Specifies how points are colored. - -**`Default`** - -```ts -PointColorType.Rgb -``` - -**`Example`** - -```js -model.pointColorType = PointColorType.Rgb -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | [`PointColorType`](../enums/cognite_reveal.PointColorType.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:198](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L198) - -___ - -### pointShape - -• `get` **pointShape**(): [`PointShape`](../enums/cognite_reveal.PointShape.md) - -Sets the point shape of each rendered point in the point cloud. - -**`Default`** - -`PointShape.Circle` - -**`See`** - -[PointShape](../enums/cognite_reveal.PointShape.md). - -#### Returns - -[`PointShape`](../enums/cognite_reveal.PointShape.md) - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:238](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L238) - -• `set` **pointShape**(`shape`): `void` - -Gets the point shape of each rendered point in the point cloud. - -**`See`** - -[PointShape](../enums/cognite_reveal.PointShape.md). - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `shape` | [`PointShape`](../enums/cognite_reveal.PointShape.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:246](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L246) - -___ - -### pointSize - -• `get` **pointSize**(): `number` - -Returns the size of each rendered point in the point cloud. - -#### Returns - -`number` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:205](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L205) - -• `set` **pointSize**(`size`): `void` - -Sets the size of each rendered point in the point cloud. - -**`Default`** - -`1` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `size` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:213](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L213) - -___ - -### pointSizeType - -• `get` **pointSizeType**(): [`PointSizeType`](../enums/cognite_reveal.PointSizeType.md) - -Get the point size type. - -#### Returns - -[`PointSizeType`](../enums/cognite_reveal.PointSizeType.md) - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:220](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L220) - -• `set` **pointSizeType**(`type`): `void` - -Set the point size type for the point cloud. -The point size type can be either Fixed or Adaptive. - -**`Default`** - -`PointSizeType.Adaptive` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | [`PointSizeType`](../enums/cognite_reveal.PointSizeType.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:229](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L229) - -___ - -### stylableObjectCount - -• `get` **stylableObjectCount**(): `number` - -#### Returns - -`number` - -The number of stylable objects - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:340](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L340) - -___ - -### styledCollections - -• `get` **styledCollections**(): [`StyledPointCloudObjectCollection`](cognite_reveal.StyledPointCloudObjectCollection.md)[] - -Gets the object collections that have been assigned a style - -#### Returns - -[`StyledPointCloudObjectCollection`](cognite_reveal.StyledPointCloudObjectCollection.md)[] - -All object collections and their associated style - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:285](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L285) - -___ - -### visiblePointCount - -• `get` **visiblePointCount**(): `number` - -Returns the current number of visible/loaded points. - -#### Returns - -`number` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:179](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L179) - -## Methods - -### assignStyledObjectCollection - -▸ **assignStyledObjectCollection**(`objectCollection`, `appearance`): `void` - -Assign a style to a collection of objects. If the object collection has been assigned -a style previously, the previous style will be replaced by the new one. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objectCollection` | [`PointCloudObjectCollection`](cognite_reveal.PointCloudObjectCollection.md) | The object collection to assign a style to | -| `appearance` | [`PointCloudAppearance`](../modules/cognite_reveal.md#pointcloudappearance) | The style to assign to the object collection | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:295](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L295) - -___ - -### dispose - -▸ **dispose**(): `void` - -Used to clean up memory. - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:58](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L58) - -___ - -### getCameraConfiguration - -▸ **getCameraConfiguration**(): `undefined` \| [`CameraConfiguration`](../modules/cognite_reveal.md#cameraconfiguration) - -Retrieves the camera position and target stored for the model. Typically this -is used to store a good starting position for a model. Returns `undefined` if there -isn't any stored camera configuration for the model. - -#### Returns - -`undefined` \| [`CameraConfiguration`](../modules/cognite_reveal.md#cameraconfiguration) - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L84) - -___ - -### getCdfToDefaultModelTransformation - -▸ **getCdfToDefaultModelTransformation**(`out?`): `Matrix4` - -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 [setModelTransformation](cognite_reveal.CognitePointCloudModel.md#setmodeltransformation) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `out?` | `Matrix4` | Preallocated `THREE.Matrix4` (optional) | - -#### Returns - -`Matrix4` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:111](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L111) - -___ - -### getClasses - -▸ **getClasses**(): \{ `code`: `number` ; `name`: `string` }[] - -Returns a list of sorted classification names and codes present in the model. -Names will be the custom names provided by the user, or a default one if none have been provided. - -#### Returns - -\{ `code`: `number` ; `name`: `string` }[] - -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/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L172) - -___ - -### getDefaultPointCloudAppearance - -▸ **getDefaultPointCloudAppearance**(): [`PointCloudAppearance`](../modules/cognite_reveal.md#pointcloudappearance) - -Gets default point appearance - -#### Returns - -[`PointCloudAppearance`](../modules/cognite_reveal.md#pointcloudappearance) - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:268](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L268) - -___ - -### getModelBoundingBox - -▸ **getModelBoundingBox**(`outBbox?`): `Box3` - -**`Example`** - -```js -const box = new THREE.Box3() -model.getModelBoundingBox(box); -// box now has the bounding box -``` -```js -// the following code does the same -const box = model.getModelBoundingBox(); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outBbox?` | `Box3` | Optional. Used to write result to. | - -#### Returns - -`Box3` - -Model's bounding box. - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:75](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L75) - -___ - -### getModelClippingPlanes - -▸ **getModelClippingPlanes**(): `Plane`[] - -Get the clipping planes for this model. - -#### Returns - -`Plane`[] - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:261](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L261) - -___ - -### getModelTransformation - -▸ **getModelTransformation**(`out?`): `Matrix4` - -Gets transformation matrix that has previously been -set with [setModelTransformation](cognite_reveal.CognitePointCloudModel.md#setmodeltransformation). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `out?` | `Matrix4` | Preallocated `THREE.Matrix4` (optional). | - -#### Returns - -`Matrix4` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:101](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L101) - -___ - -### hasClass - -▸ **hasClass**(`pointClass`): `boolean` - -Returns true if the model has values with the given classification class. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `pointClass` | `number` | ASPRS classification class code. Either one of the well known classes from [WellKnownAsprsPointClassCodes](../enums/cognite_reveal.WellKnownAsprsPointClassCodes.md) or a number for user defined classes. | - -#### Returns - -`boolean` - -True if model has values in the class given. - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:163](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L163) - -___ - -### isClassVisible - -▸ **isClassVisible**(`pointClass`): `boolean` - -Determines if points from a given class are visible. - -**`Throws`** - -Error if the model doesn't have the class given. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `pointClass` | `number` | ASPRS classification class code. Either one of the well known classes from [WellKnownAsprsPointClassCodes](../enums/cognite_reveal.WellKnownAsprsPointClassCodes.md) or a number for user defined classes. | - -#### Returns - -`boolean` - -True if points from the given class will be visible. - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:153](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L153) - -___ - -### mapBoxFromCdfToModelCoordinates - -▸ **mapBoxFromCdfToModelCoordinates**(`box`, `out?`): `Box3` - -Map bounding box from CDF to model space, taking the model's custom transformation into account - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `box` | `Box3` | Box to compute transformation from | -| `out` | `Box3` | Optional pre-allocated box | - -#### Returns - -`Box3` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:130](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L130) - -___ - -### mapPointFromCdfToModelCoordinates - -▸ **mapPointFromCdfToModelCoordinates**(`point`, `out?`): `Vector3` - -Map point from CDF to model space, taking the model's custom transformation into account - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `point` | `Vector3` | Point to compute transformation from | -| `out` | `Vector3` | Optional pre-allocated point | - -#### Returns - -`Vector3` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:120](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L120) - -___ - -### removeAllStyledObjectCollections - -▸ **removeAllStyledObjectCollections**(): `void` - -Removes styling on all object collections in this model - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:332](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L332) - -___ - -### setClassVisible - -▸ **setClassVisible**(`pointClass`, `visible`): `void` - -Sets a visible filter on points of a given class. - -**`Throws`** - -Error if the model doesn't have the class given. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `pointClass` | `number` | ASPRS classification class code. Either one of the well known classes from [WellKnownAsprsPointClassCodes](../enums/cognite_reveal.WellKnownAsprsPointClassCodes.md) or a number for user defined classes. | -| `visible` | `boolean` | Boolean flag that determines if the point class type should be visible or not. | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:142](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L142) - -___ - -### setDefaultPointCloudAppearance - -▸ **setDefaultPointCloudAppearance**(`appearance`): `void` - -Sets default apparance for points that are not styled otherwise - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appearance` | [`PointCloudAppearance`](../modules/cognite_reveal.md#pointcloudappearance) | Appearance to assign as default | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:276](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L276) - -___ - -### setModelClippingPlanes - -▸ **setModelClippingPlanes**(`clippingPlanes`): `void` - -Sets the clipping planes for this model. They will be combined with the -global clipping planes. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `clippingPlanes` | `Plane`[] | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:254](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L254) - -___ - -### setModelTransformation - -▸ **setModelTransformation**(`transformationMatrix`): `void` - -Sets transformation matrix of the model. This overrides the current transformation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transformationMatrix` | `Matrix4` | The new transformation matrix | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:92](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L92) - -___ - -### traverseStylableObjects - -▸ **traverseStylableObjects**(`callback`): `void` - -Iterates through all stylable objects for this model - -**`Example`** - -```js -model.traverseStylableObjects( - annotationMetadata => console.log(annotationMetadata.annotationId) -); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | (`annotationMetadata`: [`PointCloudObjectMetadata`](../modules/cognite_reveal.md#pointcloudobjectmetadata)) => `void` | - -#### Returns - -`void` - -#### Defined in - -[packages/pointclouds/src/CognitePointCloudModel.ts:353](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/CognitePointCloudModel.ts#L353) - -___ - -### unassignStyledObjectCollection - -▸ **unassignStyledObjectCollection**(`objectCollection`): `void` - -Unassign style from an already styled object collection. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `objectCollection` | [`PointCloudObjectCollection`](cognite_reveal.PointCloudObjectCollection.md) | The object collection from which to remove the style | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index bb0bcd5ee4c..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.CombineNodeCollectionBase.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -id: "cognite_reveal.CombineNodeCollectionBase" -title: "Class: CombineNodeCollectionBase" -sidebar_label: "CombineNodeCollectionBase" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).CombineNodeCollectionBase - -Node collection that combines the result from multiple underlying node collections. - -## Hierarchy - -- [`NodeCollection`](cognite_reveal.NodeCollection.md) - - ↳ **`CombineNodeCollectionBase`** - - ↳↳ [`IntersectionNodeCollection`](cognite_reveal.IntersectionNodeCollection.md) - - ↳↳ [`UnionNodeCollection`](cognite_reveal.UnionNodeCollection.md) - -## Constructors - -### constructor - -• **new CombineNodeCollectionBase**(`classToken`, `nodeCollections?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `classToken` | `string` | -| `nodeCollections?` | [`NodeCollection`](cognite_reveal.NodeCollection.md)[] | - -#### Overrides - -NodeCollection.constructor - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L17) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NodeCollection.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -NodeCollection.isLoading - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) - -## Methods - -### add - -▸ **add**(`nodeCollection`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) - -___ - -### clear - -▸ **clear**(): `void` - -Clears all underlying node collections. - -#### Returns - -`void` - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[clear](cognite_reveal.NodeCollection.md#clear) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) - -___ - -### getAreas - -▸ `Abstract` **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getAreas](cognite_reveal.NodeCollection.md#getareas) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:73](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L73) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getIndexSet](cognite_reveal.NodeCollection.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[off](cognite_reveal.NodeCollection.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[on](cognite_reveal.NodeCollection.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### remove - -▸ **remove**(`nodeCollection`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) - -___ - -### serialize - -▸ `Abstract` **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[serialize](cognite_reveal.NodeCollection.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index 8cd92c43817..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ComboControls.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -id: "cognite_reveal.ComboControls" -title: "Class: ComboControls" -sidebar_label: "ComboControls" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).ComboControls - -## Hierarchy - -- `EventDispatcher` - - ↳ **`ComboControls`** - -## Constructors - -### constructor - -• **new ComboControls**(`camera`, `domElement`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `camera` | `PerspectiveCamera` \| `OrthographicCamera` | -| `domElement` | `HTMLElement` | - -#### Overrides - -EventDispatcher.constructor - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:218](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L218) - -## Properties - -### dispose - -• **dispose**: () => `void` - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:115](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L115) - -## Accessors - -### cameraRawRotation - -• `get` **cameraRawRotation**(): `Quaternion` - -Camera rotation to be used by the camera instead of target-based rotation. -This rotation is used only when set to non-default quaternion value (not identity rotation quaternion). -Externally, value is updated by `CameraManager` when `setState` method with non-zero rotation is called. Automatically -resets to default value when `setState` method is called with no rotation value. - -#### Returns - -`Quaternion` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:337](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L337) - -___ - -### enabled - -• `get` **enabled**(): `boolean` - -Returns true if these controls are enabled. - -#### Returns - -`boolean` - -#### Defined in - -[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` - -Sets the enabled state of these controls. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `newEnabledValue` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:207](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L207) - -___ - -### options - -• `get` **options**(): `Readonly`\<[`ComboControlsOptions`](../modules/cognite_reveal.md#combocontrolsoptions)\> - -Gets current Combo Controls options. - -#### Returns - -`Readonly`\<[`ComboControlsOptions`](../modules/cognite_reveal.md#combocontrolsoptions)\> - -#### Defined in - -[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` - -Sets Combo Controls options. - -Only the provided options will be changed, any undefined options will be kept as is. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Partial`\<[`ComboControlsOptions`](../modules/cognite_reveal.md#combocontrolsoptions)\> | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:193](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L193) - -## Methods - -### getScrollTarget - -▸ **getScrollTarget**(): `Vector3` - -#### Returns - -`Vector3` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:350](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L350) - -___ - -### getState - -▸ **getState**(): `Object` - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `position` | `Vector3` | -| `target` | `Vector3` | - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:312](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L312) - -___ - -### setScrollTarget - -▸ **setScrollTarget**(`target`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `target` | `Vector3` | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:346](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L346) - -___ - -### setState - -▸ **setState**(`position`, `target`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `position` | `Vector3` | -| `target` | `Vector3` | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:320](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L320) - -___ - -### setViewTarget - -▸ **setViewTarget**(`target`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `target` | `Vector3` | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:341](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L341) - -___ - -### triggerCameraChangeEvent - -▸ **triggerCameraChangeEvent**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:354](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L354) - -___ - -### update - -▸ **update**(`deltaTime`, `forceUpdate?`): `boolean` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `deltaTime` | `number` | `undefined` | -| `forceUpdate` | `boolean` | `false` | - -#### Returns - -`boolean` - -#### Defined in - -[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 deleted file mode 100644 index eb3ef8360b8..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DebouncedCameraStopEventTrigger.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: "cognite_reveal.DebouncedCameraStopEventTrigger" -title: "Class: DebouncedCameraStopEventTrigger" -sidebar_label: "DebouncedCameraStopEventTrigger" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).DebouncedCameraStopEventTrigger - -Simple helper class to trigger a stop event whenever a camera manager's -camera hasn't changed for a little while. - -## Constructors - -### constructor - -• **new DebouncedCameraStopEventTrigger**(`cameraManager`, `debounceTimeMs?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `cameraManager` | [`CameraManager`](../interfaces/cognite_reveal.CameraManager.md) | `undefined` | -| `debounceTimeMs` | `number` | `100` | - -#### Defined in - -[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 - -### dispose - -▸ **dispose**(): `void` - -Deallocate resources associated with this object - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L47) - -___ - -### subscribe - -▸ **subscribe**(`callback`): `void` - -Subscribe to the stop events generated by this trigger - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | [`CameraStopDelegate`](../modules/cognite_reveal.md#camerastopdelegate) | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/utils/DebouncedCameraStopEventTrigger.ts#L33) - -___ - -### unsubscribe - -▸ **unsubscribe**(`callback`): `void` - -Unsubscribe from the stop events - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callback` | [`CameraStopDelegate`](../modules/cognite_reveal.md#camerastopdelegate) | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index d2845422f86..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.DefaultCameraManager.md +++ /dev/null @@ -1,426 +0,0 @@ ---- -id: "cognite_reveal.DefaultCameraManager" -title: "Class: DefaultCameraManager" -sidebar_label: "DefaultCameraManager" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).DefaultCameraManager - -Default implementation of [CameraManager](../interfaces/cognite_reveal.CameraManager.md). Uses target-based orbit controls combined with -keyboard and mouse navigation possibility. Supports automatic update of camera near and far -planes and animated change of camera position and target. - -## Implements - -- [`CameraManager`](../interfaces/cognite_reveal.CameraManager.md) - -## Properties - -### automaticControlsSensitivity - -• **automaticControlsSensitivity**: `boolean` = `true` - -When false, the sensitivity of the camera controls will not be updated automatically. -This can be useful to better control the sensitivity of the 3D navigation. - -When not set, control the sensitivity of the camera using `viewer.cameraManager.cameraControls.minDistance` -and `viewer.cameraManager.cameraControls.maxDistance`. - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:103](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L103) - -___ - -### automaticNearFarPlane - -• **automaticNearFarPlane**: `boolean` = `true` - -When false, camera near and far planes will not be updated automatically (defaults to true). -This can be useful when you have custom content in the 3D view and need to better -control the view frustum. - -When automatic camera near/far planes are disabled, you are responsible for setting -this on your own. - -**`Example`** - -``` -viewer.camera.near = 0.1; -viewer.camera.far = 1000.0; -viewer.camera.updateProjectionMatrix(); -``` - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:95](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L95) - -## Accessors - -### keyboardNavigationEnabled - -• `get` **keyboardNavigationEnabled**(): `boolean` - -Whether keyboard control of the camera is enabled/disabled. - -#### Returns - -`boolean` - -#### Defined in - -[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` - -Sets whether keyboard control of the camera is enabled/disabled. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `enabled` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:183](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L183) - -## Methods - -### activate - -▸ **activate**(`cameraManager?`): `void` - -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 viewer. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cameraManager?` | [`CameraManager`](../interfaces/cognite_reveal.CameraManager.md) | Previously used camera manager. | - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[activate](../interfaces/cognite_reveal.CameraManager.md#activate) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:232](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L232) - -___ - -### deactivate - -▸ **deactivate**(): `void` - -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 viewer. - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[deactivate](../interfaces/cognite_reveal.CameraManager.md#deactivate) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:246](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L246) - -___ - -### dispose - -▸ **dispose**(): `void` - -**`Obvious`** - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[dispose](../interfaces/cognite_reveal.CameraManager.md#dispose) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:285](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L285) - -___ - -### fitCameraToBoundingBox - -▸ **fitCameraToBoundingBox**(`box`, `duration?`, `radiusFactor?`): `void` - -Moves camera to a place where the content of a bounding box is visible to the camera. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `box` | `Box3` | `undefined` | The bounding box in world space. | -| `duration?` | `number` | `undefined` | The duration of the animation moving the camera. | -| `radiusFactor` | `number` | `2` | The ratio of the distance from camera to center of box and radius of the box. | - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[fitCameraToBoundingBox](../interfaces/cognite_reveal.CameraManager.md#fitcameratoboundingbox) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:159](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L159) - -___ - -### getCamera - -▸ **getCamera**(): `PerspectiveCamera` - -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. - -#### Returns - -`PerspectiveCamera` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[getCamera](../interfaces/cognite_reveal.CameraManager.md#getcamera) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:194](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L194) - -___ - -### getCameraControlsOptions - -▸ **getCameraControlsOptions**(): [`CameraControlsOptions`](../modules/cognite_reveal.md#cameracontrolsoptions) - -Gets current camera controls options. - -#### Returns - -[`CameraControlsOptions`](../modules/cognite_reveal.md#cameracontrolsoptions) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:257](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L257) - -___ - -### getCameraState - -▸ **getCameraState**(): `Required`\<[`CameraState`](../modules/cognite_reveal.md#camerastate)\> - -Get camera's state - -#### Returns - -`Required`\<[`CameraState`](../modules/cognite_reveal.md#camerastate)\> - -Camera state: position, target and rotation. - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[getCameraState](../interfaces/cognite_reveal.CameraManager.md#getcamerastate) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:224](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L224) - -___ - -### getComboControlsOptions - -▸ **getComboControlsOptions**(): `Readonly`\<[`ComboControlsOptions`](../modules/cognite_reveal.md#combocontrolsoptions)\> - -Gets current Combo Controls options. - -#### Returns - -`Readonly`\<[`ComboControlsOptions`](../modules/cognite_reveal.md#combocontrolsoptions)\> - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:168](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L168) - -___ - -### off - -▸ **off**(`event`, `callback`): `void` - -Unsubscribes from changes of the camera event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"cameraChange"`` \| ``"cameraStop"`` | The event type. | -| `callback` | [`CameraEventDelegate`](../modules/cognite_reveal.md#cameraeventdelegate) | Callback function to be unsubscribed. | - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[off](../interfaces/cognite_reveal.CameraManager.md#off) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:146](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L146) - -___ - -### on - -▸ **on**(`event`, `callback`): `void` - -Subscribes to events on this camera manager. There are several event types: -'cameraChange' - Subscribes to changes of the camera. This is used by Reveal to react on changes of the camera. -'cameraStop' - Subscribes to events indicating the camera has stopped - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"cameraChange"`` \| ``"cameraStop"`` | The event type. | -| `callback` | [`CameraEventDelegate`](../modules/cognite_reveal.md#cameraeventdelegate) | Callback to be called when the event is fired. | - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[on](../interfaces/cognite_reveal.CameraManager.md#on) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:133](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L133) - -___ - -### setCameraControlsOptions - -▸ **setCameraControlsOptions**(`controlsOptions`): `void` - -Sets camera controls options to customize camera controls modes. See [CameraControlsOptions](../modules/cognite_reveal.md#cameracontrolsoptions). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `controlsOptions` | [`CameraControlsOptions`](../modules/cognite_reveal.md#cameracontrolsoptions) | JSON object with camera controls options. | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:265](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L265) - -___ - -### setCameraState - -▸ **setCameraState**(`state`): `void` - -Sets camera state. All parameters are optional. Rotation and target can't be set at the same time, -if so, error will be thrown. Set rotation is preserved until next call of setCameraState with -empty rotation field. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | [`CameraState`](../modules/cognite_reveal.md#camerastate) | Camera state. * | - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[setCameraState](../interfaces/cognite_reveal.CameraManager.md#setcamerastate) - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:204](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L204) - -___ - -### setComboControlsOptions - -▸ **setComboControlsOptions**(`options`): `void` - -Sets Combo Controls options. -Only provided options will be changed, any undefined options will be kept as is. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Partial`\<[`ComboControlsOptions`](../modules/cognite_reveal.md#combocontrolsoptions)\> | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/DefaultCameraManager.ts:176](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/DefaultCameraManager.ts#L176) - -___ - -### update - -▸ **update**(`deltaTime`, `boundingBox`): `void` - -Updates internal state of camera manager. Expected to update visual state of the camera -as well as it's near and far planes if needed. Called in `requestAnimationFrame`-loop. -Reveal performance affects frequency with which this method is called. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deltaTime` | `number` | Delta time since last update in seconds. | -| `boundingBox` | `Box3` | Global bounding box of the model(s) and any custom objects added to the scene. | - -#### Returns - -`void` - -#### Implementation of - -[CameraManager](../interfaces/cognite_reveal.CameraManager.md).[update](../interfaces/cognite_reveal.CameraManager.md#update) - -#### Defined in - -[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 deleted file mode 100644 index 703bb109bf9..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IndexSet.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -id: "cognite_reveal.IndexSet" -title: "Class: IndexSet" -sidebar_label: "IndexSet" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).IndexSet - -## Constructors - -### constructor - -• **new IndexSet**(`values?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | `Iterable`\<`number`\> | - -#### Defined in - -[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?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `values?` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L14) - -## Accessors - -### count - -• `get` **count**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:68](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L68) - -## Methods - -### add - -▸ **add**(`index`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L33) - -___ - -### addRange - -▸ **addRange**(`range`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `range` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:39](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L39) - -___ - -### clear - -▸ **clear**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:211](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L211) - -___ - -### clone - -▸ **clone**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L215) - -___ - -### contains - -▸ **contains**(`index`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:60](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L60) - -___ - -### differenceWith - -▸ **differenceWith**(`otherSet`): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `otherSet` | [`IndexSet`](cognite_reveal.IndexSet.md) | - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:135](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L135) - -___ - -### forEachRange - -▸ **forEachRange**(`visitor`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `visitor` | (`range`: [`NumericRange`](cognite_reveal.NumericRange.md)) => `void` | - -#### Returns - -`void` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L27) - -___ - -### hasIntersectionWith - -▸ **hasIntersectionWith**(`otherSet`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `otherSet` | [`IndexSet`](cognite_reveal.IndexSet.md) \| `Set`\<`number`\> \| `Map`\<`number`, `number`\> | - -#### Returns - -`boolean` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:145](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L145) - -___ - -### intersectWith - -▸ **intersectWith**(`otherSet`): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `otherSet` | [`IndexSet`](cognite_reveal.IndexSet.md) | - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:171](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L171) - -___ - -### invertedRanges - -▸ **invertedRanges**(): [`NumericRange`](cognite_reveal.NumericRange.md)[] - -#### Returns - -[`NumericRange`](cognite_reveal.NumericRange.md)[] - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:105](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L105) - -___ - -### remove - -▸ **remove**(`index`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L47) - -___ - -### removeRange - -▸ **removeRange**(`range`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `range` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`void` - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:52](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L52) - -___ - -### toIndexArray - -▸ **toIndexArray**(): `number`[] - -#### Returns - -`number`[] - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L84) - -___ - -### toPlainSet - -▸ **toPlainSet**(): `Set`\<`number`\> - -#### Returns - -`Set`\<`number`\> - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:98](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L98) - -___ - -### toRangeArray - -▸ **toRangeArray**(): [`NumericRange`](cognite_reveal.NumericRange.md)[] - -#### Returns - -[`NumericRange`](cognite_reveal.NumericRange.md)[] - -#### Defined in - -[packages/utilities/src/indexset/IndexSet.ts:76](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/indexset/IndexSet.ts#L76) - -___ - -### unionWith - -▸ **unionWith**(`otherSet`): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `otherSet` | [`IndexSet`](cognite_reveal.IndexSet.md) | - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Defined in - -[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 deleted file mode 100644 index 7dc2bbe3e21..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.IntersectionNodeCollection.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -id: "cognite_reveal.IntersectionNodeCollection" -title: "Class: IntersectionNodeCollection" -sidebar_label: "IntersectionNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).IntersectionNodeCollection - -Node collection that is the intersection between a set of underlying node collections. - -## Hierarchy - -- [`CombineNodeCollectionBase`](cognite_reveal.CombineNodeCollectionBase.md) - - ↳ **`IntersectionNodeCollection`** - -## Constructors - -### constructor - -• **new IntersectionNodeCollection**(`nodeCollections?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollections?` | [`NodeCollection`](cognite_reveal.NodeCollection.md)[] | - -#### Overrides - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[constructor](cognite_reveal.CombineNodeCollectionBase.md#constructor) - -#### Defined in - -[packages/cad-styling/src/IntersectionNodeCollection.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L22) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"IntersectionNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/IntersectionNodeCollection.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L20) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -CombineNodeCollectionBase.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -CombineNodeCollectionBase.isLoading - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) - -## Methods - -### add - -▸ **add**(`nodeCollection`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[add](cognite_reveal.CombineNodeCollectionBase.md#add) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) - -___ - -### clear - -▸ **clear**(): `void` - -Clears all underlying node collections. - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[clear](cognite_reveal.CombineNodeCollectionBase.md#clear) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Overrides - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[getAreas](cognite_reveal.CombineNodeCollectionBase.md#getareas) - -#### Defined in - -[packages/cad-styling/src/IntersectionNodeCollection.ts:52](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L52) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[getIndexSet](cognite_reveal.CombineNodeCollectionBase.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) - -___ - -### makeDirty - -▸ **makeDirty**(): `void` - -#### Returns - -`void` - -#### Overrides - -CombineNodeCollectionBase.makeDirty - -#### Defined in - -[packages/cad-styling/src/IntersectionNodeCollection.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/IntersectionNodeCollection.ts#L46) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[off](cognite_reveal.CombineNodeCollectionBase.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[on](cognite_reveal.CombineNodeCollectionBase.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### remove - -▸ **remove**(`nodeCollection`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[remove](cognite_reveal.CombineNodeCollectionBase.md#remove) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[serialize](cognite_reveal.CombineNodeCollectionBase.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index 06d9952047f..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.InvertedNodeCollection.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -id: "cognite_reveal.InvertedNodeCollection" -title: "Class: InvertedNodeCollection" -sidebar_label: "InvertedNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).InvertedNodeCollection - -Node collection that inverts the result from another node collection. - -## Hierarchy - -- [`NodeCollection`](cognite_reveal.NodeCollection.md) - - ↳ **`InvertedNodeCollection`** - -## Constructors - -### constructor - -• **new InvertedNodeCollection**(`model`, `innerSet`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `model` | [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) | -| `innerSet` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | - -#### Overrides - -NodeCollection.constructor - -#### Defined in - -[packages/cad-styling/src/InvertedNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L21) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"InvertedNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/InvertedNodeCollection.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L15) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NodeCollection.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -NodeCollection.isLoading - -#### Defined in - -[packages/cad-styling/src/InvertedNodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L32) - -## Methods - -### clear - -▸ **clear**(): `never` - -Not supported. - -**`Throws`** - -Always throws an error. - -#### Returns - -`never` - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[clear](cognite_reveal.NodeCollection.md#clear) - -#### Defined in - -[packages/cad-styling/src/InvertedNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L58) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getAreas](cognite_reveal.NodeCollection.md#getareas) - -#### Defined in - -[packages/cad-styling/src/InvertedNodeCollection.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L47) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getIndexSet](cognite_reveal.NodeCollection.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/InvertedNodeCollection.ts:36](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/InvertedNodeCollection.ts#L36) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[off](cognite_reveal.NodeCollection.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[on](cognite_reveal.NodeCollection.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[serialize](cognite_reveal.NodeCollection.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index b81354588bc..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeCollection.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -id: "cognite_reveal.NodeCollection" -title: "Class: NodeCollection" -sidebar_label: "NodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).NodeCollection - -Abstract class for implementing a set of nodes to be styled. - -## Hierarchy - -- **`NodeCollection`** - - ↳ [`CdfNodeCollectionBase`](cognite_reveal.CdfNodeCollectionBase.md) - - ↳ [`CombineNodeCollectionBase`](cognite_reveal.CombineNodeCollectionBase.md) - - ↳ [`TreeIndexNodeCollection`](cognite_reveal.TreeIndexNodeCollection.md) - - ↳ [`AssetNodeCollection`](cognite_reveal.AssetNodeCollection.md) - - ↳ [`InvertedNodeCollection`](cognite_reveal.InvertedNodeCollection.md) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `Abstract` `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L37) - -## Methods - -### clear - -▸ `Abstract` **clear**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L45) - -___ - -### getAreas - -▸ `Abstract` **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:44](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L44) - -___ - -### getIndexSet - -▸ `Abstract` **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L38) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ `Abstract` **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Defined in - -[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 deleted file mode 100644 index 800831c6d0d..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NodeIdNodeCollection.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -id: "cognite_reveal.NodeIdNodeCollection" -title: "Class: NodeIdNodeCollection" -sidebar_label: "NodeIdNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).NodeIdNodeCollection - -Collection that holds a set of nodes including children identified by nodeIds. Note that -this involves remapping IDs to "tree indices" and subtree sized used by Reveal using -the CDF API. Its often better to use one of the other node collections or @see \{@link TreeIndexNodeCollection} -whenever possible for best performance. - -## Hierarchy - -- [`CdfNodeCollectionBase`](cognite_reveal.CdfNodeCollectionBase.md) - - ↳ **`NodeIdNodeCollection`** - -## Constructors - -### constructor - -• **new NodeIdNodeCollection**(`client`, `model`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `client` | `default` | -| `model` | [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) | - -#### Overrides - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[constructor](cognite_reveal.CdfNodeCollectionBase.md#constructor) - -#### Defined in - -[packages/cad-styling/src/NodeIdNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L25) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"NodeIdNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/NodeIdNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L18) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -CdfNodeCollectionBase.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -CdfNodeCollectionBase.isLoading - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) - -## Methods - -### clear - -▸ **clear**(): `void` - -Clears the node collection and interrupts any ongoing operations. - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[clear](cognite_reveal.CdfNodeCollectionBase.md#clear) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) - -___ - -### executeFilter - -▸ **executeFilter**(`nodeIds`): `Promise`\<`void`\> - -Populates the collection with the nodes with the IDs provided. All children of -the nodes are also included in the collection. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeIds` | `number`[] | IDs of nodes to include in the collection. | - -#### Returns - -`Promise`\<`void`\> - -Promise that resolves when the collection is populated. - -#### Defined in - -[packages/cad-styling/src/NodeIdNodeCollection.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L37) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[getAreas](cognite_reveal.CdfNodeCollectionBase.md#getareas) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[getIndexSet](cognite_reveal.CdfNodeCollectionBase.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[off](cognite_reveal.CdfNodeCollectionBase.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[on](cognite_reveal.CdfNodeCollectionBase.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[serialize](cognite_reveal.CdfNodeCollectionBase.md#serialize) - -#### Defined in - -[packages/cad-styling/src/NodeIdNodeCollection.ts:58](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeIdNodeCollection.ts#L58) - -___ - -### deserialize - -▸ `Static` **deserialize**(`descriptor`, `context`): `Promise`\<[`NodeIdNodeCollection`](cognite_reveal.NodeIdNodeCollection.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `descriptor` | [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) | -| `context` | [`NodeCollectionSerializationContext`](../modules/cognite_reveal.md#nodecollectionserializationcontext) | - -#### Returns - -`Promise`\<[`NodeIdNodeCollection`](cognite_reveal.NodeIdNodeCollection.md)\> - -#### Defined in - -[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 deleted file mode 100644 index 156ed5f4923..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.NumericRange.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -id: "cognite_reveal.NumericRange" -title: "Class: NumericRange" -sidebar_label: "NumericRange" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).NumericRange - -## Constructors - -### constructor - -• **new NumericRange**(`from`, `count`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `number` | -| `count` | `number` | - -#### Defined in - -[packages/utilities/src/NumericRange.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L10) - -## Properties - -### count - -• `Readonly` **count**: `number` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:7](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L7) - -___ - -### from - -• `Readonly` **from**: `number` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:6](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L6) - -___ - -### toInclusive - -• `Readonly` **toInclusive**: `number` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L8) - -## Methods - -### contains - -▸ **contains**(`value`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L38) - -___ - -### equal - -▸ **equal**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L34) - -___ - -### forEach - -▸ **forEach**(`action`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `action` | (`value`: `number`) => `void` | - -#### Returns - -`void` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:72](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L72) - -___ - -### intersectionWith - -▸ **intersectionWith**(`range`): `undefined` \| [`NumericRange`](cognite_reveal.NumericRange.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `range` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`undefined` \| [`NumericRange`](cognite_reveal.NumericRange.md) - -#### Defined in - -[packages/utilities/src/NumericRange.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L50) - -___ - -### intersects - -▸ **intersects**(`range`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `range` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L42) - -___ - -### intersectsOrCoinciding - -▸ **intersectsOrCoinciding**(`range`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `range` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L46) - -___ - -### isInside - -▸ **isInside**(`range`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `range` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:61](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L61) - -___ - -### toArray - -▸ **toArray**(): `number`[] - -#### Returns - -`number`[] - -#### Defined in - -[packages/utilities/src/NumericRange.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L30) - -___ - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/utilities/src/NumericRange.ts:78](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L78) - -___ - -### union - -▸ **union**(`range`): [`NumericRange`](cognite_reveal.NumericRange.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `range` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -[`NumericRange`](cognite_reveal.NumericRange.md) - -#### Defined in - -[packages/utilities/src/NumericRange.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L65) - -___ - -### values - -▸ **values**(): `Generator`\<`number`, `any`, `unknown`\> - -#### Returns - -`Generator`\<`number`, `any`, `unknown`\> - -#### Defined in - -[packages/utilities/src/NumericRange.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L24) - -___ - -### createFromInterval - -▸ `Static` **createFromInterval**(`from`, `toInclusive`): [`NumericRange`](cognite_reveal.NumericRange.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `from` | `number` | -| `toInclusive` | `number` | - -#### Returns - -[`NumericRange`](cognite_reveal.NumericRange.md) - -#### Defined in - -[packages/utilities/src/NumericRange.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/NumericRange.ts#L20) - -___ - -### isNumericRange - -▸ `Static` **isNumericRange**(`value`): value is NumericRange - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -value is NumericRange - -#### Defined in - -[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 deleted file mode 100644 index 7e8c69fe327..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PointCloudObjectCollection.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -id: "cognite_reveal.PointCloudObjectCollection" -title: "Class: PointCloudObjectCollection" -sidebar_label: "PointCloudObjectCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).PointCloudObjectCollection - -Base class for collections of point cloud objects intended for styling operations - -## Hierarchy - -- **`PointCloudObjectCollection`** - - ↳ [`AnnotationIdPointCloudObjectCollection`](cognite_reveal.AnnotationIdPointCloudObjectCollection.md) - -## Constructors - -### constructor - -• **new PointCloudObjectCollection**() - -## Accessors - -### isLoading - -• `Abstract` `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -whether the collection is still loading data in the background i.e. not yet ready for use - -#### Defined in - -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L23) - -## Methods - -### getAnnotationIds - -▸ `Abstract` **getAnnotationIds**(): `Iterable`\<`number`\> - -#### Returns - -`Iterable`\<`number`\> - -annotation IDs of the annotations for the objects represented by this PointCloudObjectCollection instance - -#### Defined in - -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L18) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -[packages/pointcloud-styling/src/PointCloudObjectCollection.ts:30](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudObjectCollection.ts#L30) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 0d7d1c30831..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.PropertyFilterNodeCollection.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -id: "cognite_reveal.PropertyFilterNodeCollection" -title: "Class: PropertyFilterNodeCollection" -sidebar_label: "PropertyFilterNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).PropertyFilterNodeCollection - -Represents a set of nodes that has matching node properties to a provided filter. Note that -a node is considered to match if it or a [NodeCollection](cognite_reveal.NodeCollection.md) ancestors match the filter. - -## Hierarchy - -- [`CdfNodeCollectionBase`](cognite_reveal.CdfNodeCollectionBase.md) - - ↳ **`PropertyFilterNodeCollection`** - -## Constructors - -### constructor - -• **new PropertyFilterNodeCollection**(`client`, `model`, `options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `client` | `default` | -| `model` | [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) | -| `options` | [`PropertyFilterNodeCollectionOptions`](../modules/cognite_reveal.md#propertyfilternodecollectionoptions) | - -#### Overrides - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[constructor](cognite_reveal.CdfNodeCollectionBase.md#constructor) - -#### Defined in - -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:44](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L44) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"PropertyFilterNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L32) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -CdfNodeCollectionBase.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -CdfNodeCollectionBase.isLoading - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) - -## Methods - -### clear - -▸ **clear**(): `void` - -Clears the node collection and interrupts any ongoing operations. - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[clear](cognite_reveal.CdfNodeCollectionBase.md#clear) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) - -___ - -### executeFilter - -▸ **executeFilter**(`filter`): `Promise`\<`void`\> - -Populates the node collection with nodes matching the provided filter. This will replace -the current nodes held by the filter. - -**`Example`** - -``` -set.executeFilter({ 'PDMS': { 'Module': 'AQ550' }}); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter` | `Object` | A filter for matching node properties. | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/cad-styling/src/PropertyFilterNodeCollection.ts:64](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/PropertyFilterNodeCollection.ts#L64) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[getAreas](cognite_reveal.CdfNodeCollectionBase.md#getareas) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[getIndexSet](cognite_reveal.CdfNodeCollectionBase.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[off](cognite_reveal.CdfNodeCollectionBase.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[on](cognite_reveal.CdfNodeCollectionBase.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[serialize](cognite_reveal.CdfNodeCollectionBase.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index eccee82078a..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.SinglePropertyFilterNodeCollection.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -id: "cognite_reveal.SinglePropertyFilterNodeCollection" -title: "Class: SinglePropertyFilterNodeCollection" -sidebar_label: "SinglePropertyFilterNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).SinglePropertyFilterNodeCollection - -Node collection that filters nodes based on a node property from a list of values, similarly to how -`SELECT ... IN (...)` works. This is useful when looking up nodes based on a list of identifiers, -nodes within a set of areas or systems. The node set is optimized for matching with properties with -a large number of values (i.e. thousands). - -## Hierarchy - -- [`CdfNodeCollectionBase`](cognite_reveal.CdfNodeCollectionBase.md) - - ↳ **`SinglePropertyFilterNodeCollection`** - -## Constructors - -### constructor - -• **new SinglePropertyFilterNodeCollection**(`client`, `model`, `options?`) - -Construct a new node set. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `client` | `default` | CogniteClient authenticated to the project the model is loaded from. | -| `model` | [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) | CAD model. | -| `options` | [`PropertyFilterNodeCollectionOptions`](../modules/cognite_reveal.md#propertyfilternodecollectionoptions) | | - -#### Overrides - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[constructor](cognite_reveal.CdfNodeCollectionBase.md#constructor) - -#### Defined in - -[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:41](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L41) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"SinglePropertyNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L24) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -CdfNodeCollectionBase.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -CdfNodeCollectionBase.isLoading - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L25) - -## Methods - -### clear - -▸ **clear**(): `void` - -Clears the node collection and interrupts any ongoing operations. - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[clear](cognite_reveal.CdfNodeCollectionBase.md#clear) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L69) - -___ - -### executeFilter - -▸ **executeFilter**(`propertyCategory`, `propertyKey`, `propertyValues`): `Promise`\<`void`\> - -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 [requestPartitions](../modules/cognite_reveal.md#requestpartitions) -during construction of the node set, the total number of batches will be requestPartitions*numberOfBatches. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `propertyCategory` | `string` | Node property category, e.g. `'PDMS'`. | -| `propertyKey` | `string` | Node property key, e.g. `':FU'`. | -| `propertyValues` | `string`[] | Lookup values, e.g. `["AR100APG539","AP500INF534","AP400INF553", ...]` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts:62](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SinglePropertyFilterNodeCollection.ts#L62) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[getAreas](cognite_reveal.CdfNodeCollectionBase.md#getareas) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L81) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[getIndexSet](cognite_reveal.CdfNodeCollectionBase.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/CdfNodeCollectionBase.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfNodeCollectionBase.ts#L77) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[off](cognite_reveal.CdfNodeCollectionBase.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[on](cognite_reveal.CdfNodeCollectionBase.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[CdfNodeCollectionBase](cognite_reveal.CdfNodeCollectionBase.md).[serialize](cognite_reveal.CdfNodeCollectionBase.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index 3df99e9b55f..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.StyledPointCloudObjectCollection.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: "cognite_reveal.StyledPointCloudObjectCollection" -title: "Class: StyledPointCloudObjectCollection" -sidebar_label: "StyledPointCloudObjectCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).StyledPointCloudObjectCollection - -Represents an object collection that is associated with an appearance - -## Constructors - -### constructor - -• **new StyledPointCloudObjectCollection**(`objectCollection`, `style`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `objectCollection` | [`PointCloudObjectCollection`](cognite_reveal.PointCloudObjectCollection.md) | -| `style` | `Required`\<[`PointCloudAppearance`](../modules/cognite_reveal.md#pointcloudappearance)\> | - -#### Defined in - -[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) - -## Properties - -### objectCollection - -• **objectCollection**: [`PointCloudObjectCollection`](cognite_reveal.PointCloudObjectCollection.md) - -#### Defined in - -[packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/StyledPointCloudObjectCollection.ts#L12) - -___ - -### style - -• **style**: `Required`\<[`PointCloudAppearance`](../modules/cognite_reveal.md#pointcloudappearance)\> - -#### Defined in - -[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 deleted file mode 100644 index 0fd910f7e30..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.ThickLine.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -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 deleted file mode 100644 index 9533cb03a5e..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.TreeIndexNodeCollection.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -id: "cognite_reveal.TreeIndexNodeCollection" -title: "Class: TreeIndexNodeCollection" -sidebar_label: "TreeIndexNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).TreeIndexNodeCollection - -Node collection that holds a set of nodes defined by a set of tree indices. - -## Hierarchy - -- [`NodeCollection`](cognite_reveal.NodeCollection.md) - - ↳ **`TreeIndexNodeCollection`** - -## Constructors - -### constructor - -• **new TreeIndexNodeCollection**(`treeIndexSet?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `treeIndexSet?` | [`IndexSet`](cognite_reveal.IndexSet.md) | - -#### Overrides - -NodeCollection.constructor - -#### Defined in - -[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?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `treeIndices?` | `Iterable`\<`number`\> | - -#### Overrides - -NodeCollection.constructor - -#### Defined in - -[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?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `treeIndexRange?` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Overrides - -NodeCollection.constructor - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L25) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"TreeIndexNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L18) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NodeCollection.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Overrides - -NodeCollection.isLoading - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:110](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L110) - -## Methods - -### addAreaPoints - -▸ **addAreaPoints**(`points`): `void` - -Add points to this node collection's area set. -This effectively adds boxes of size 1x1x1 meter with the points as their centers. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `points` | `Vector3`[] | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:96](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L96) - -___ - -### addAreas - -▸ **addAreas**(`areas`): `void` - -Add areas to this node collection's area set. -Nearby areas may be clustered and merged together to keep -the number of areas in the set small. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `areas` | `Box3`[] | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L84) - -___ - -### clear - -▸ **clear**(): `void` - -Sets this set to hold an empty set. - -#### Returns - -`void` - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[clear](cognite_reveal.NodeCollection.md#clear) - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:56](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L56) - -___ - -### clearAreas - -▸ **clearAreas**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:106](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L106) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getAreas](cognite_reveal.NodeCollection.md#getareas) - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L65) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[getIndexSet](cognite_reveal.NodeCollection.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:61](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L61) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[off](cognite_reveal.NodeCollection.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[NodeCollection](cognite_reveal.NodeCollection.md).[on](cognite_reveal.NodeCollection.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[NodeCollection](cognite_reveal.NodeCollection.md).[serialize](cognite_reveal.NodeCollection.md#serialize) - -#### Defined in - -[packages/cad-styling/src/TreeIndexNodeCollection.ts:114](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/TreeIndexNodeCollection.ts#L114) - -___ - -### updateSet - -▸ **updateSet**(`treeIndices`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `treeIndices` | [`IndexSet`](cognite_reveal.IndexSet.md) | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `treeIndices` | [`NumericRange`](cognite_reveal.NumericRange.md) | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `treeIndices` | `Iterable`\<`number`\> | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 0bbee2f5c8d..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal.UnionNodeCollection.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -id: "cognite_reveal.UnionNodeCollection" -title: "Class: UnionNodeCollection" -sidebar_label: "UnionNodeCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).UnionNodeCollection - -Node collection that takes the set union of multiple node collections. - -## Hierarchy - -- [`CombineNodeCollectionBase`](cognite_reveal.CombineNodeCollectionBase.md) - - ↳ **`UnionNodeCollection`** - -## Constructors - -### constructor - -• **new UnionNodeCollection**(`nodeCollections?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollections?` | [`NodeCollection`](cognite_reveal.NodeCollection.md)[] | - -#### Overrides - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[constructor](cognite_reveal.CombineNodeCollectionBase.md#constructor) - -#### Defined in - -[packages/cad-styling/src/UnionNodeCollection.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L21) - -## Properties - -### classToken - -▪ `Static` `Readonly` **classToken**: ``"UnionNodeCollection"`` - -#### Defined in - -[packages/cad-styling/src/UnionNodeCollection.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L19) - -## Accessors - -### classToken - -• `get` **classToken**(): `string` - -#### Returns - -`string` - -#### Inherited from - -CombineNodeCollectionBase.classToken - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L23) - -___ - -### isLoading - -• `get` **isLoading**(): `boolean` - -#### Returns - -`boolean` - -#### Inherited from - -CombineNodeCollectionBase.isLoading - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L67) - -## Methods - -### add - -▸ **add**(`nodeCollection`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[add](cognite_reveal.CombineNodeCollectionBase.md#add) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L26) - -___ - -### clear - -▸ **clear**(): `void` - -Clears all underlying node collections. - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[clear](cognite_reveal.CombineNodeCollectionBase.md#clear) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L46) - -___ - -### getAreas - -▸ **getAreas**(): [`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -Returns areas surrounding the nodes in the collection. The areas -are boxes in "ThreeJS coordinates". Note that not all -implementations supports this. - -#### Returns - -[`AreaCollection`](../interfaces/cognite_reveal.AreaCollection.md) - -#### Overrides - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[getAreas](cognite_reveal.CombineNodeCollectionBase.md#getareas) - -#### Defined in - -[packages/cad-styling/src/UnionNodeCollection.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/UnionNodeCollection.ts#L45) - -___ - -### getIndexSet - -▸ **getIndexSet**(): [`IndexSet`](cognite_reveal.IndexSet.md) - -#### Returns - -[`IndexSet`](cognite_reveal.IndexSet.md) - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[getIndexSet](cognite_reveal.CombineNodeCollectionBase.md#getindexset) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L59) - -___ - -### off - -▸ **off**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[off](cognite_reveal.CombineNodeCollectionBase.md#off) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L32) - -___ - -### on - -▸ **on**(`event`, `listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"changed"`` | -| `listener` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[on](cognite_reveal.CombineNodeCollectionBase.md#on) - -#### Defined in - -[packages/cad-styling/src/NodeCollection.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollection.ts#L27) - -___ - -### remove - -▸ **remove**(`nodeCollection`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | - -#### Returns - -`void` - -#### Inherited from - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[remove](cognite_reveal.CombineNodeCollectionBase.md#remove) - -#### Defined in - -[packages/cad-styling/src/CombineNodeCollectionBase.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CombineNodeCollectionBase.ts#L32) - -___ - -### serialize - -▸ **serialize**(): [`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Returns - -[`SerializedNodeCollection`](../modules/cognite_reveal.md#serializednodecollection) - -#### Overrides - -[CombineNodeCollectionBase](cognite_reveal.CombineNodeCollectionBase.md).[serialize](cognite_reveal.CombineNodeCollectionBase.md#serialize) - -#### Defined in - -[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 deleted file mode 100644 index 3dba63c0ebf..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.CdfModelIdentifier" -title: "Class: CdfModelIdentifier" -sidebar_label: "CdfModelIdentifier" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).CdfModelIdentifier - -Identifies a 3D model stored in CDF by the combination of a modelId, a revisionId -and a format. - -## Implements - -- [`ModelIdentifier`](../interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md) - -## Constructors - -### constructor - -• **new CdfModelIdentifier**(`modelId`, `revisionId`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `modelId` | `number` | -| `revisionId` | `number` | - -#### Defined in - -[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 - -### modelId - -• `Readonly` **modelId**: `number` - -#### Defined in - -[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) - -___ - -### revealInternalId - -• `Readonly` **revealInternalId**: `symbol` - -Unique ID of the model. - -#### Implementation of - -[ModelIdentifier](../interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md).[revealInternalId](../interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md#revealinternalid) - -#### Defined in - -[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) - -___ - -### revisionId - -• `Readonly` **revisionId**: `number` - -#### Defined in - -[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 - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[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 deleted file mode 100644 index f506e2a1983..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.AxisViewTool.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: "cognite_reveal_tools.AxisViewTool" -title: "Class: AxisViewTool" -sidebar_label: "AxisViewTool" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).AxisViewTool - -Base class for tools attaching to a [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). - -## Hierarchy - -- [`Cognite3DViewerToolBase`](cognite_reveal_tools.Cognite3DViewerToolBase.md) - - ↳ **`AxisViewTool`** - -## Constructors - -### constructor - -• **new AxisViewTool**(`viewer`, `config?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `viewer` | [`Cognite3DViewer`](cognite_reveal.Cognite3DViewer.md) | -| `config?` | [`AxisBoxConfig`](../modules/cognite_reveal_tools.md#axisboxconfig) | - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[constructor](cognite_reveal_tools.Cognite3DViewerToolBase.md#constructor) - -#### Defined in - -[packages/tools/src/AxisView/AxisViewTool.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L45) - -## Methods - -### 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/AxisView/AxisViewTool.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/AxisViewTool.ts#L69) - -___ - -### off - -▸ **off**(`event`, `handler`): `void` - -Unregisters an event handler for the 'disposed'-event. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[off](cognite_reveal_tools.Cognite3DViewerToolBase.md#off) - -#### Defined in - -[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 deleted file mode 100644 index 10b32c57581..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Cognite3DViewerToolBase.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: "cognite_reveal_tools.Cognite3DViewerToolBase" -title: "Class: Cognite3DViewerToolBase" -sidebar_label: "Cognite3DViewerToolBase" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).Cognite3DViewerToolBase - -Base class for tools attaching to a [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). - -## Hierarchy - -- **`Cognite3DViewerToolBase`** - - ↳ [`HtmlOverlayTool`](cognite_reveal_tools.HtmlOverlayTool.md) - - ↳ [`DebugCameraTool`](cognite_reveal_tools.DebugCameraTool.md) - - ↳ [`AxisViewTool`](cognite_reveal_tools.AxisViewTool.md) - - ↳ [`SmartOverlayTool`](cognite_reveal_tools.SmartOverlayTool.md) - - ↳ [`TimelineTool`](cognite_reveal_tools.TimelineTool.md) - - ↳ [`MeasurementTool`](cognite_reveal_tools.MeasurementTool.md) - -## Constructors - -### constructor - -• **new Cognite3DViewerToolBase**() - -## Methods - -### dispose - -▸ **dispose**(): `void` - -Disposes the element and triggeres the 'disposed' event before clearing the list -of dipose-listeners. - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Cognite3DViewerToolBase.ts:53](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L53) - -___ - -### off - -▸ **off**(`event`, `handler`): `void` - -Unregisters an event handler for the 'disposed'-event. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 62bb4a8a95a..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.DebugCameraTool.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: "cognite_reveal_tools.DebugCameraTool" -title: "Class: DebugCameraTool" -sidebar_label: "DebugCameraTool" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).DebugCameraTool - -Base class for tools attaching to a [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). - -## Hierarchy - -- [`Cognite3DViewerToolBase`](cognite_reveal_tools.Cognite3DViewerToolBase.md) - - ↳ **`DebugCameraTool`** - -## Constructors - -### constructor - -• **new DebugCameraTool**(`viewer`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `viewer` | [`Cognite3DViewer`](cognite_reveal.Cognite3DViewer.md) | - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[constructor](cognite_reveal_tools.Cognite3DViewerToolBase.md#constructor) - -#### Defined in - -[packages/tools/src/DebugCameraTool.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/DebugCameraTool.ts#L20) - -## Methods - -### dispose - -▸ **dispose**(): `void` - -Removes all elements and detaches from the viewer. - -#### Returns - -`void` - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[dispose](cognite_reveal_tools.Cognite3DViewerToolBase.md#dispose) - -#### Defined in - -[packages/tools/src/DebugCameraTool.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/DebugCameraTool.ts#L32) - -___ - -### hideCameraHelper - -▸ **hideCameraHelper**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/DebugCameraTool.ts:43](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/DebugCameraTool.ts#L43) - -___ - -### off - -▸ **off**(`event`, `handler`): `void` - -Unregisters an event handler for the 'disposed'-event. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[off](cognite_reveal_tools.Cognite3DViewerToolBase.md#off) - -#### Defined in - -[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) - -___ - -### showCameraHelper - -▸ **showCameraHelper**(): `void` - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index ef3f2dc5142..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.HtmlOverlayTool.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -id: "cognite_reveal_tools.HtmlOverlayTool" -title: "Class: HtmlOverlayTool" -sidebar_label: "HtmlOverlayTool" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).HtmlOverlayTool - -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. - -Attached elements *must* have CSS style 'position: absolute'. It's also recommended -in most cases to have styles 'pointer-events: none' and 'touch-action: none' to avoid -interfering with 3D navigation. Consider also applying 'transform: translate(-50%, -50%)' -to anchor the center of the element rather than the top-left corner. In some cases the -`zIndex`-attribute is necessary for the element to appear on top of the viewer. - -**`Example`** - -```js -const el = document.createElement('div'); -el.style.position = 'absolute'; // Required! -// Anchor to center of element -el.style.transform = 'translate(-50%, -50%)'; -// Avoid being target for events -el.style.pointerEvents = 'none; -el.style.touchAction = 'none'; -// Render in front of other elements -el.style.zIndex = 10; - -el.style.color = 'red'; -el.innerHtml = '

Overlay

'; - -const overlayTool = new HtmlOverlayTool(viewer); -overlayTool.add(el, new THREE.Vector3(10, 10, 10)); -// ... -overlayTool.remove(el); -// or, to remove all attached elements -overlayTool.clear(); - -// detach the tool from the viewer -overlayTool.dispose(); -``` - -## Hierarchy - -- [`Cognite3DViewerToolBase`](cognite_reveal_tools.Cognite3DViewerToolBase.md) - - ↳ **`HtmlOverlayTool`** - -## Constructors - -### constructor - -• **new HtmlOverlayTool**(`viewer`, `options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `viewer` | [`Cognite3DViewer`](cognite_reveal.Cognite3DViewer.md) | -| `options?` | [`HtmlOverlayToolOptions`](../modules/cognite_reveal_tools.md#htmloverlaytooloptions) | - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[constructor](cognite_reveal_tools.Cognite3DViewerToolBase.md#constructor) - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:171](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L171) - -## Accessors - -### elements - -• `get` **elements**(): \{ `element`: `HTMLElement` ; `position3D`: `Vector3` }[] - -Returns all added HTML elements along with their 3D positions. - -#### Returns - -\{ `element`: `HTMLElement` ; `position3D`: `Vector3` }[] - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:191](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L191) - -## Methods - -### add - -▸ **add**(`htmlElement`, `position3D`, `options?`): `void` - -Registers a HTML overlay that will be updated on rendering. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `htmlElement` | `HTMLElement` | -| `position3D` | `Vector3` | -| `options` | [`HtmlOverlayOptions`](../modules/cognite_reveal_tools.md#htmloverlayoptions) | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L215) - -___ - -### clear - -▸ **clear**(): `void` - -Removes all attached HTML overlay elements. - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:263](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L263) - -___ - -### dispose - -▸ **dispose**(): `void` - -Removes all elements and detaches from the viewer. - -#### Returns - -`void` - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[dispose](cognite_reveal_tools.Cognite3DViewerToolBase.md#dispose) - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:201](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L201) - -___ - -### forceUpdate - -▸ **forceUpdate**(`customCamera?`): `void` - -Updates positions of all overlays. This is automatically managed and there -shouldn't be any reason to trigger this unless the attached elements are -modified externally. - -Calling this function often might cause degraded performance. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `customCamera?` | `PerspectiveCamera` | Optional camera to be used in place of viewerCamera when calculating positions | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:298](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L298) - -___ - -### off - -▸ **off**(`event`, `handler`): `void` - -Unregisters an event handler for the 'disposed'-event. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[off](cognite_reveal_tools.Cognite3DViewerToolBase.md#off) - -#### Defined in - -[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) - -___ - -### remove - -▸ **remove**(`htmlElement`): `void` - -Removes a overlay and removes it from the DOM. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `htmlElement` | `HTMLElement` | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:251](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L251) - -___ - -### visible - -▸ **visible**(`enable`): `void` - -Hide/unhide all HTML overlay elements. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `enable` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 677d253cca9..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.Keyframe.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -id: "cognite_reveal_tools.Keyframe" -title: "Class: Keyframe" -sidebar_label: "Keyframe" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).Keyframe - -Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline - -## Constructors - -### constructor - -• **new Keyframe**(`model`, `date`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `model` | [`CogniteCadModel`](cognite_reveal.CogniteCadModel.md) | -| `date` | `Date` | - -#### Defined in - -[packages/tools/src/Timeline/Keyframe.ts:17](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L17) - -## Methods - -### activate - -▸ **activate**(): `void` - -Assigns the styles for the node set for the model for this Keyframe - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/Keyframe.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L33) - -___ - -### assignStyledNodeCollection - -▸ **assignStyledNodeCollection**(`nodeCollection`, `nodeAppearance`): `void` - -Add node & style to the collection. If the collection has been added, the style is updated to the -appearance provided. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | Node set to apply the Styles | -| `nodeAppearance` | [`NodeAppearance`](../modules/cognite_reveal.md#nodeappearance) | Style to assign to the node collection | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/Keyframe.ts:54](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L54) - -___ - -### deactivate - -▸ **deactivate**(): `void` - -Removes the style for the model - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/Keyframe.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L42) - -___ - -### getKeyframeDate - -▸ **getKeyframeDate**(): `Date` - -Get date of the Keyframe - -#### Returns - -`Date` - -date - -#### Defined in - -[packages/tools/src/Timeline/Keyframe.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/Keyframe.ts#L26) - -___ - -### unassignStyledNodeCollection - -▸ **unassignStyledNodeCollection**(`nodeCollection`): `void` - -Remove Node & Style for this keyframe's nodeCollection and nodeAppearance - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `nodeCollection` | [`NodeCollection`](cognite_reveal.NodeCollection.md) | Nodes to be unassign from node collection | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 42037b4f58c..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.MeasurementTool.md +++ /dev/null @@ -1,533 +0,0 @@ ---- -id: "cognite_reveal_tools.MeasurementTool" -title: "Class: MeasurementTool" -sidebar_label: "MeasurementTool" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).MeasurementTool - -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 -user to customise the measuring units based on their convinience with the callback. - -**`Example`** - -```js -const measurementTool = new MeasurementTool(viewer); -measurementTool.enterMeasurementMode(); -// ... -measurementTool.exitMeasurementMode(); - -// detach the tool from the viewer -measurementTool.dispose(); -``` - -**`Example`** - -```jsx runnable -const measurementTool = new MeasurementTool(viewer, {distanceToLabelCallback: (distanceInMeters) => { - // 1 meters = 3.281 feet - const distancesInFeet = distanceInMeters * 3.281; - return { distanceInMeters: distancesInFeet, units: 'ft'}; - }}); - measurementTool.enterMeasurementMode(); -``` - -## Hierarchy - -- [`Cognite3DViewerToolBase`](cognite_reveal_tools.Cognite3DViewerToolBase.md) - - ↳ **`MeasurementTool`** - -## Constructors - -### constructor - -• **new MeasurementTool**(`viewer`, `options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `viewer` | [`Cognite3DViewer`](cognite_reveal.Cognite3DViewer.md) | -| `options?` | [`MeasurementOptions`](../modules/cognite_reveal_tools.md#measurementoptions) | - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[constructor](cognite_reveal_tools.Cognite3DViewerToolBase.md#constructor) - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:91](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L91) - -## Accessors - -### isInMeasurementMode - -• `get` **isInMeasurementMode**(): `boolean` - -Returns measurement mode state, is measurement mode started or ended. - -#### Returns - -`boolean` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:54](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L54) - -## Methods - -### dispose - -▸ **dispose**(): `void` - -Dispose Measurement Tool. - -#### Returns - -`void` - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[dispose](cognite_reveal_tools.Cognite3DViewerToolBase.md#dispose) - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:367](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L367) - -___ - -### enterMeasurementMode - -▸ **enterMeasurementMode**(): `void` - -Enter into point to point measurement mode. - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:235](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L235) - -___ - -### exitMeasurementMode - -▸ **exitMeasurementMode**(): `void` - -Exit measurement mode. - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:249](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L249) - -___ - -### getAllMeasurements - -▸ **getAllMeasurements**(): [`Measurement`](../modules/cognite_reveal_tools.md#measurement)[] - -Get all measurements from [Cognite3DViewer](cognite_reveal.Cognite3DViewer.md). - -#### Returns - -[`Measurement`](../modules/cognite_reveal_tools.md#measurement)[] - -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/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L346) - -___ - -### off - -▸ **off**(`event`, `callback`): `void` - -**`Example`** - -```js -measurementTool.off('disposed', onMeasurementDispose); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `callback` | [`DisposedDelegate`](../modules/cognite_reveal.md#disposeddelegate) | - -#### Returns - -`void` - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[off](cognite_reveal_tools.Cognite3DViewerToolBase.md#off) - -#### Defined in - -[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` - -**`Example`** - -```js -measurementTool.off('added', onMeasurementAdded); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"added"`` | -| `callback` | [`MeasurementAddedDelegate`](../modules/cognite_reveal_tools.md#measurementaddeddelegate) | - -#### Returns - -`void` - -#### Overrides - -Cognite3DViewerToolBase.off - -#### Defined in - -[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` - -**`Example`** - -```js -measurementTool.off('started', onMeasurementStarted); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"started"`` | -| `callback` | [`MeasurementStartedDelegate`](../modules/cognite_reveal_tools.md#measurementstarteddelegate) | - -#### Returns - -`void` - -#### Overrides - -Cognite3DViewerToolBase.off - -#### Defined in - -[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` - -**`Example`** - -```js -measurementTool.off('ended', onMeasurementEnded); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"ended"`` | -| `callback` | [`MeasurementEndedDelegate`](../modules/cognite_reveal_tools.md#measurementendeddelegate) | - -#### Returns - -`void` - -#### Overrides - -Cognite3DViewerToolBase.off - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:203](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L203) - -___ - -### on - -▸ **on**(`event`, `callback`): `void` - -Triggered when the tool is disposed. Listeners should clean up any -resources held and remove the reference to the tool. - -**`Example`** - -```js -measurementTool.on('disposed', onMeasurementDispose); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `callback` | [`DisposedDelegate`](../modules/cognite_reveal.md#disposeddelegate) | - -#### Returns - -`void` - -#### Overrides - -Cognite3DViewerToolBase.on - -#### Defined in - -[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` - -Triggered when a measurement is added into the Cognite3DViewer. - -**`Example`** - -```js -measurementTool.on('added', onMeasurementAdded); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"added"`` | -| `callback` | [`MeasurementAddedDelegate`](../modules/cognite_reveal_tools.md#measurementaddeddelegate) | - -#### Returns - -`void` - -#### Overrides - -Cognite3DViewerToolBase.on - -#### Defined in - -[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` - -Triggered when a measurement mode is started. - -**`Example`** - -```js -measurementTool.on('started', onMeasurementStarted); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"started"`` | -| `callback` | [`MeasurementStartedDelegate`](../modules/cognite_reveal_tools.md#measurementstarteddelegate) | - -#### Returns - -`void` - -#### Overrides - -Cognite3DViewerToolBase.on - -#### Defined in - -[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` - -Triggered when measurement mode is ended. - -**`Example`** - -```js -measurementTool.on('ended', onMeasurementEnded); -``` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"ended"`` | -| `callback` | [`MeasurementEndedDelegate`](../modules/cognite_reveal_tools.md#measurementendeddelegate) | - -#### Returns - -`void` - -#### Overrides - -Cognite3DViewerToolBase.on - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:144](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L144) - -___ - -### removeAllMeasurements - -▸ **removeAllMeasurements**(): `void` - -Removes all measurements from the Cognite3DViewer. - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:279](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L279) - -___ - -### removeMeasurement - -▸ **removeMeasurement**(`measurement`): `void` - -Removes a measurement from the Cognite3DViewer. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `measurement` | [`Measurement`](../modules/cognite_reveal_tools.md#measurement) | Measurement to be removed from Cognite3DViewer. | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:264](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L264) - -___ - -### setLineOptions - -▸ **setLineOptions**(`options`): `void` - -Sets Measurement line width, color and label units value for the next measurment. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`MeasurementOptions`](../modules/cognite_reveal_tools.md#measurementoptions) | MeasurementOptions to set line width, color and callback for custom operation on measurement labels. | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:303](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L303) - -___ - -### setMeasurementLabelsVisible - -▸ **setMeasurementLabelsVisible**(`enable`): `void` - -Sets the visiblity of labels in the Measurement. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `enable` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:292](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L292) - -___ - -### updateLineColor - -▸ **updateLineColor**(`measurement`, `color`): `void` - -Update selected line color. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `measurement` | [`Measurement`](../modules/cognite_reveal_tools.md#measurement) | Measurement to be updated. | -| `color` | `Color` | Color of the measuring line. | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:331](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L331) - -___ - -### updateLineWidth - -▸ **updateLineWidth**(`measurement`, `lineWidth`): `void` - -Update selected line width. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `measurement` | [`Measurement`](../modules/cognite_reveal_tools.md#measurement) | Measurement to be updated. | -| `lineWidth` | `number` | Width of the measuring line. | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/MeasurementTool.ts:315](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementTool.ts#L315) - -___ - -### visible - -▸ **visible**(`enable`): `void` - -Hide/unhide all measurements - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `enable` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 13ae76af6cb..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.SmartOverlayTool.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -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 deleted file mode 100644 index 9abf082e312..00000000000 --- a/documentation/versioned_docs/version-4.x/api/classes/cognite_reveal_tools.TimelineTool.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -id: "cognite_reveal_tools.TimelineTool" -title: "Class: TimelineTool" -sidebar_label: "TimelineTool" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).TimelineTool - -Tool to applying styles to nodes based on date to play them over in Timeline - -## Hierarchy - -- [`Cognite3DViewerToolBase`](cognite_reveal_tools.Cognite3DViewerToolBase.md) - - ↳ **`TimelineTool`** - -## Constructors - -### constructor - -• **new TimelineTool**(`cadModel`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `cadModel` | [`CogniteCadModel`](cognite_reveal.CogniteCadModel.md) | - -#### Overrides - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[constructor](cognite_reveal_tools.Cognite3DViewerToolBase.md#constructor) - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L22) - -## Methods - -### createKeyframe - -▸ **createKeyframe**(`date`): [`Keyframe`](cognite_reveal_tools.Keyframe.md) - -Create Key frame for the Timeline - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `date` | `Date` | date value by Date.now() since January 1, 1970 | - -#### Returns - -[`Keyframe`](cognite_reveal_tools.Keyframe.md) - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:63](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L63) - -___ - -### 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/Timeline/TimelineTool.ts:184](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L184) - -___ - -### getAllKeyframes - -▸ **getAllKeyframes**(): [`Keyframe`](cognite_reveal_tools.Keyframe.md)[] - -Provides all Keyframes in the Timeline - -#### Returns - -[`Keyframe`](cognite_reveal_tools.Keyframe.md)[] - -All Keyframes in Timeline - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:180](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L180) - -___ - -### getKeyframeByDate - -▸ **getKeyframeByDate**(`date`): `undefined` \| [`Keyframe`](cognite_reveal_tools.Keyframe.md) - -Returns the keyframe at the date given, or undefined if not found. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `date` | `Date` | - -#### Returns - -`undefined` \| [`Keyframe`](cognite_reveal_tools.Keyframe.md) - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:76](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L76) - -___ - -### off - -▸ **off**(`event`, `handler`): `void` - -Unregisters an event handler for the 'disposed'-event. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"disposed"`` | -| `handler` | () => `void` | - -#### Returns - -`void` - -#### Inherited from - -[Cognite3DViewerToolBase](cognite_reveal_tools.Cognite3DViewerToolBase.md).[off](cognite_reveal_tools.Cognite3DViewerToolBase.md#off) - -#### Defined in - -[packages/tools/src/Cognite3DViewerToolBase.ts:38](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Cognite3DViewerToolBase.ts#L38) - -___ - -### pause - -▸ **pause**(): `void` - -Pause any ongoing playback - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:161](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L161) - -___ - -### play - -▸ **play**(`startDate`, `endDate`, `totalDurationInMilliSeconds`): `void` - -Starts playback of Timeline - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `startDate` | `Date` | Keyframe date to start the Playback of Keyframes | -| `endDate` | `Date` | Keyframe date to stop the Playback of Keyframes | -| `totalDurationInMilliSeconds` | `number` | Number of milliseconds for all Keyframe within startDate & endDate to be rendered | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:110](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L110) - -___ - -### removeKeyframe - -▸ **removeKeyframe**(`keyframe`): `void` - -Removes the Keyframe from the timeline. Does nothing if the keyframe isn't part of the timeline. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `keyframe` | [`Keyframe`](cognite_reveal_tools.Keyframe.md) | Keyframe to be removed from the timeline | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L84) - -___ - -### removeKeyframeByDate - -▸ **removeKeyframeByDate**(`date`): `void` - -Removes the Keyframe from the Timeline - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `date` | `Date` | Date of the Keyframe to be removed from the Timeline | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:96](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L96) - -___ - -### resume - -▸ **resume**(): `void` - -Resume any paused playback - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:170](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L170) - -___ - -### stop - -▸ **stop**(): `void` - -Stops any ongoing playback - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:151](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L151) - -___ - -### subscribe - -▸ **subscribe**(`event`, `listener`): `void` - -Subscribe to the Date changed event - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"dateChanged"`` | `dateChanged` event | -| `listener` | [`TimelineDateUpdateDelegate`](../modules/cognite_reveal_tools.md#timelinedateupdatedelegate) | Listen to Timeline date Update during Playback | - -#### Returns - -`void` - -#### Defined in - -[packages/tools/src/Timeline/TimelineTool.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Timeline/TimelineTool.ts#L34) - -___ - -### unsubscribe - -▸ **unsubscribe**(`event`, `listener`): `void` - -Unsubscribe to the Date changed event - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"dateChanged"`` | `dateChanged` event | -| `listener` | [`TimelineDateUpdateDelegate`](../modules/cognite_reveal_tools.md#timelinedateupdatedelegate) | Remove Listen to Timeline date Update | - -#### Returns - -`void` - -#### Defined in - -[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/_category_.yml b/documentation/versioned_docs/version-4.x/api/enums/_category_.yml deleted file mode 100644 index 1687a9e03fd..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Enumerations" -position: 2 \ No newline at end of file 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 deleted file mode 100644 index 8b7b94ac50d..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.NodeOutlineColor.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: "cognite_reveal.NodeOutlineColor" -title: "Enumeration: NodeOutlineColor" -sidebar_label: "NodeOutlineColor" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).NodeOutlineColor - -## Enumeration Members - -### Black - -• **Black** = ``2`` - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L10) - -___ - -### Blue - -• **Blue** = ``4`` - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L12) - -___ - -### Cyan - -• **Cyan** = ``3`` - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L11) - -___ - -### Green - -• **Green** = ``5`` - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L13) - -___ - -### NoOutline - -• **NoOutline** = ``0`` - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L8) - -___ - -### Orange - -• **Orange** = ``7`` - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L15) - -___ - -### Red - -• **Red** = ``6`` - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L14) - -___ - -### White - -• **White** = ``1`` - -#### Defined in - -[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 deleted file mode 100644 index 73e22af4ade..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointColorType.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: "cognite_reveal.PointColorType" -title: "Enumeration: PointColorType" -sidebar_label: "PointColorType" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).PointColorType - -## Enumeration Members - -### Classification - -• **Classification** = ``8`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L25) - -___ - -### Depth - -• **Depth** = ``2`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L18) - -___ - -### Elevation - -• **Elevation** = ``3`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L20) - -___ - -### Height - -• **Height** = ``3`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L19) - -___ - -### Intensity - -• **Intensity** = ``4`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L21) - -___ - -### LevelOfDetail - -• **LevelOfDetail** = ``6`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L23) - -___ - -### Lod - -• **Lod** = ``6`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L22) - -___ - -### PointIndex - -• **PointIndex** = ``7`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L24) - -___ - -### Rgb - -• **Rgb** = ``0`` - -#### Defined in - -[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 deleted file mode 100644 index 798bbe276cf..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointShape.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: "cognite_reveal.PointShape" -title: "Enumeration: PointShape" -sidebar_label: "PointShape" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).PointShape - -## Enumeration Members - -### Circle - -• **Circle** = ``1`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L12) - -___ - -### Paraboloid - -• **Paraboloid** = ``2`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L13) - -___ - -### Square - -• **Square** = ``0`` - -#### Defined in - -[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 deleted file mode 100644 index 2d7649442ee..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.PointSizeType.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: "cognite_reveal.PointSizeType" -title: "Enumeration: PointSizeType" -sidebar_label: "PointSizeType" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).PointSizeType - -## Enumeration Members - -### Adaptive - -• **Adaptive** = ``2`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:7](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L7) - -___ - -### Attenuated - -• **Attenuated** = ``1`` - -#### Defined in - -[packages/rendering/src/pointcloud-rendering/enums.ts:6](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/pointcloud-rendering/enums.ts#L6) - -___ - -### Fixed - -• **Fixed** = ``0`` - -#### Defined in - -[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 deleted file mode 100644 index bdb246c31e5..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal.WellKnownAsprsPointClassCodes.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -id: "cognite_reveal.WellKnownAsprsPointClassCodes" -title: "Enumeration: WellKnownAsprsPointClassCodes" -sidebar_label: "WellKnownAsprsPointClassCodes" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).WellKnownAsprsPointClassCodes - -ASPRS well known point class types. - -**`See`** - -[http://www.asprs.org/wp-content/uploads/2019/03/LAS_1_4_r14.pdf](http://www.asprs.org/wp-content/uploads/2019/03/LAS_1_4_r14.pdf) (page 30) - -## Enumeration Members - -### BridgeDeck - -• **BridgeDeck** = ``17`` - -Note that [ReservedOrBridgeDeck](cognite_reveal.WellKnownAsprsPointClassCodes.md#reservedorbridgedeck) has been used -historically. - -#### Defined in - -[packages/pointclouds/src/types.ts:59](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L59) - -___ - -### Building - -• **Building** = ``6`` - -#### Defined in - -[packages/pointclouds/src/types.ts:24](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L24) - -___ - -### Created - -• **Created** = ``0`` - -Created, never classified. - -#### Defined in - -[packages/pointclouds/src/types.ts:18](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L18) - -___ - -### Default - -• **Default** = ``-1`` - -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/e9e26d38/viewer/packages/pointclouds/src/types.ts#L14) - -___ - -### Ground - -• **Ground** = ``2`` - -#### Defined in - -[packages/pointclouds/src/types.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L20) - -___ - -### HighNoise - -• **HighNoise** = ``18`` - -High point, or "high noise". -Note that [ReservedOrHighPoint](cognite_reveal.WellKnownAsprsPointClassCodes.md#reservedorhighpoint) has been used -historically. - -#### Defined in - -[packages/pointclouds/src/types.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L65) - -___ - -### HighVegetation - -• **HighVegetation** = ``5`` - -#### Defined in - -[packages/pointclouds/src/types.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L23) - -___ - -### IgnoredGround - -• **IgnoredGround** = ``20`` - -E.g. breakline proximity. - -#### Defined in - -[packages/pointclouds/src/types.ts:73](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L73) - -___ - -### LowPoint - -• **LowPoint** = ``7`` - -Low point, typically "low noise". - -#### Defined in - -[packages/pointclouds/src/types.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L28) - -___ - -### LowVegetation - -• **LowVegetation** = ``3`` - -#### Defined in - -[packages/pointclouds/src/types.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L21) - -___ - -### MedVegetation - -• **MedVegetation** = ``4`` - -#### Defined in - -[packages/pointclouds/src/types.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L22) - -___ - -### OverheadStructure - -• **OverheadStructure** = ``19`` - -E.g. conveyors, mining equipment, traffic lights. - -#### Defined in - -[packages/pointclouds/src/types.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L69) - -___ - -### Rail - -• **Rail** = ``10`` - -#### Defined in - -[packages/pointclouds/src/types.ts:35](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L35) - -___ - -### ReservedOrBridgeDeck - -• **ReservedOrBridgeDeck** = ``12`` - -In previous revisions of LAS this was "Bridge deck", but in more recent -revisions this value is reserved. - -#### Defined in - -[packages/pointclouds/src/types.ts:41](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L41) - -___ - -### ReservedOrHighPoint - -• **ReservedOrHighPoint** = ``8`` - -In previous revisions of LAS this was High point ("high noise"), in more recent -revisions this value is reserved. - -#### Defined in - -[packages/pointclouds/src/types.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L33) - -___ - -### RoadSurface - -• **RoadSurface** = ``11`` - -#### Defined in - -[packages/pointclouds/src/types.ts:36](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L36) - -___ - -### Snow - -• **Snow** = ``21`` - -#### Defined in - -[packages/pointclouds/src/types.ts:74](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L74) - -___ - -### TemporalExclusion - -• **TemporalExclusion** = ``22`` - -Features excluded due to changes over time between data sources – e.g., water -levels, landslides, permafrost - -#### Defined in - -[packages/pointclouds/src/types.ts:79](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L79) - -___ - -### TransmissionTower - -• **TransmissionTower** = ``15`` - -#### Defined in - -[packages/pointclouds/src/types.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L50) - -___ - -### Unclassified - -• **Unclassified** = ``1`` - -#### Defined in - -[packages/pointclouds/src/types.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L19) - -___ - -### UserDefinableOffset - -• **UserDefinableOffset** = ``64`` - -First user definable class identifier (64). -Values up to and including 63 are reserved - -#### Defined in - -[packages/pointclouds/src/types.ts:85](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L85) - -___ - -### Water - -• **Water** = ``9`` - -#### Defined in - -[packages/pointclouds/src/types.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L34) - -___ - -### WireConductor - -• **WireConductor** = ``14`` - -Wire conductor (phase). - -#### Defined in - -[packages/pointclouds/src/types.ts:49](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L49) - -___ - -### WireGuard - -• **WireGuard** = ``13`` - -Wire guard shield. - -#### Defined in - -[packages/pointclouds/src/types.ts:45](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/types.ts#L45) - -___ - -### WireStructureConnector - -• **WireStructureConnector** = ``16`` - -Wire-structure connector (e.g. insulator). - -#### Defined in - -[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 deleted file mode 100644 index 1a511d76f22..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_extensions_datasource.File3dFormat.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.File3dFormat" -title: "Enumeration: File3dFormat" -sidebar_label: "File3dFormat" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).File3dFormat - -## Enumeration Members - -### AnyFormat - -• **AnyFormat** = ``"all-outputs"`` - -#### Defined in - -[packages/data-providers/src/types.ts:76](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L76) - -___ - -### EptPointCloud - -• **EptPointCloud** = ``"ept-pointcloud"`` - -#### Defined in - -[packages/data-providers/src/types.ts:71](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L71) - -___ - -### GltfCadModel - -• **GltfCadModel** = ``"gltf-directory"`` - -Reveal v9 and above (GLTF based output) - -#### Defined in - -[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 deleted file mode 100644 index 9541c9beb60..00000000000 --- a/documentation/versioned_docs/version-4.x/api/enums/cognite_reveal_tools.Corner.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: "cognite_reveal_tools.Corner" -title: "Enumeration: Corner" -sidebar_label: "Corner" -custom_edit_url: null ---- - -[@cognite/reveal/tools](../modules/cognite_reveal_tools.md).Corner - -A corner of the viewer. - -## Enumeration Members - -### BottomLeft - -• **BottomLeft** = ``2`` - -#### Defined in - -[packages/tools/src/AxisView/types.ts:101](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L101) - -___ - -### BottomRight - -• **BottomRight** = ``3`` - -#### Defined in - -[packages/tools/src/AxisView/types.ts:102](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L102) - -___ - -### TopLeft - -• **TopLeft** = ``1`` - -#### Defined in - -[packages/tools/src/AxisView/types.ts:100](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L100) - -___ - -### TopRight - -• **TopRight** = ``0`` - -#### Defined in - -[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/index.md b/documentation/versioned_docs/version-4.x/api/index.md index 1bf110772c9..4b7f70af17e 100644 --- a/documentation/versioned_docs/version-4.x/api/index.md +++ b/documentation/versioned_docs/version-4.x/api/index.md @@ -1,15 +1,7 @@ ---- -id: "index" -title: "@cognite/reveal" -sidebar_label: "Readme" -sidebar_position: 0 -custom_edit_url: null ---- - `@cognite/reveal` supports `Node16` [module resolution](https://www.typescriptlang.org/tsconfig#moduleResolution), and if enabled in the consuming application will expose three modules: -- [@cognite/reveal](/api/modules/cognite_reveal.md) is the main module and has the main entry point of Reveal, [`Cognite3DViewer`](/api/classes/cognite_reveal.Cognite3DViewer.md). CAD models are represented by [`CogniteCadModel`](/api/classes/cognite_reveal.CogniteCadModel.md) and points clouds by [`CognitePointCloudModel`](/api/classes/cognite_reveal.CognitePointCloudModel.md). -- [@congite/reveal/tools](/api/modules/cognite_reveal_tools.md) contains a set of tools, e.g. [`AxisViewTool`](/api/classes/cognite_reveal_tools.AxisViewTool.md), [`TimelineTool`](/api/classes/cognite_reveal_tools.TimelineTool.md), and [`HtmlOverlayTool`](/api/classes/cognite_reveal_tools.HtmlOverlayTool.md) that works with `Cognite3DViewer`. -- [@cognite/reveal/extensions/datasource](/api/modules/cognite_reveal_extensions_datasource.md) allows providing custom data sources for geometry and model metadata. +- [@cognite/reveal](/api/@cognite/reveal/index.md) is the main module and has the main entry point of Reveal, [`Cognite3DViewer`](/api/@cognite/reveal/classes/Cognite3DViewer.md). CAD models are represented by [`CogniteCadModel`](/api/@cognite/reveal/classes/CogniteCadModel.md) and points clouds by [`CognitePointCloudModel`](/api/@cognite/reveal/classes/CognitePointCloudModel.md). +- [@congite/reveal/tools](/api/@cognite/reveal/tools/index.md) contains a set of tools, e.g. [`AxisViewTool`](/api/@cognite/reveal/tools/classes/AxisViewTool.md), [`TimelineTool`](/api/@cognite/reveal/tools/classes/TimelineTool.md), and [`HtmlOverlayTool`](/api/@cognite/reveal/tools/classes/HtmlOverlayTool.md) that works with `Cognite3DViewer`. +- [@cognite/reveal/extensions/datasource](/api/@cognite/reveal/extensions/datasource/index.md) allows providing custom data sources for geometry and model metadata. :::note If the consuming application does not enable `Node16` module resolution, then all types must be imported from `@cognite/reveal`. diff --git a/documentation/versioned_docs/version-4.x/api/interfaces/_category_.yml b/documentation/versioned_docs/version-4.x/api/interfaces/_category_.yml deleted file mode 100644 index 43bec88cfa0..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Interfaces" -position: 4 \ No newline at end of file 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 deleted file mode 100644 index a22d04cc45f..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AddModelOptions.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: "cognite_reveal.AddModelOptions" -title: "Interface: AddModelOptions" -sidebar_label: "AddModelOptions" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).AddModelOptions - -## Properties - -### geometryFilter - -• `Optional` **geometryFilter**: [`GeometryFilter`](../modules/cognite_reveal.md#geometryfilter) - -#### Defined in - -[packages/api/src/public/migration/types.ts:200](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L200) - -___ - -### localPath - -• `Optional` **localPath**: `string` - -#### Defined in - -[packages/api/src/public/migration/types.ts:199](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L199) - -___ - -### modelId - -• **modelId**: `number` - -#### Defined in - -[packages/api/src/public/migration/types.ts:196](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L196) - -___ - -### revisionId - -• **revisionId**: `number` - -#### Defined in - -[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 deleted file mode 100644 index b114d34f86d..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.AreaCollection.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -id: "cognite_reveal.AreaCollection" -title: "Interface: AreaCollection" -sidebar_label: "AreaCollection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).AreaCollection - -Represents a collection of areas/axis-aligned -bounding boxes for use e.g. for load prioritization. Implementations -are not expected to store all areas inserted with `addAreas`, -but rather some "representative box set" covering the inserted areas. -Performance will be better the fewer boxes the representative set contains, -while the effectiveness of node prioritization will suffer if the -representative set covers too much area that is not part -of the inserted boxes - -## Implemented by - -- [`ClusteredAreaCollection`](../classes/cognite_reveal.ClusteredAreaCollection.md) - -## Properties - -### isEmpty - -• `Readonly` **isEmpty**: `boolean` - -#### Defined in - -[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 - -### addAreas - -▸ **addAreas**(`boxes`): `void` - -Add areas to be covered by the representative set of this -AreaCollection. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `boxes` | `Iterable`\<`Box3`\> | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/prioritized/AreaCollection.ts:34](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L34) - -___ - -### areas - -▸ **areas**(): `Generator`\<`Box3`, `any`, `unknown`\> - -Return some set of boxes that cover the boxes inserted with `addAreas`. -It is required that each inserted box is completely covered by some -subset of boxes in the set returned from `areas` - -#### Returns - -`Generator`\<`Box3`, `any`, `unknown`\> - -#### Defined in - -[packages/cad-styling/src/prioritized/AreaCollection.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L23) - -___ - -### intersectWith - -▸ **intersectWith**(`boxes`): `void` - -Alter the representative set to cover only the intersection between the -representative set of this AreaCollection and the incoming boxes. -Note that the intersection of two representative sets A' and B' that -represent the original box sets A and B will cover the intersection between -A and B, and will thus be a valid representative set for the intersection of A and B. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `boxes` | `Iterable`\<`Box3`\> | - -#### Returns - -`void` - -#### Defined in - -[packages/cad-styling/src/prioritized/AreaCollection.ts:43](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/prioritized/AreaCollection.ts#L43) - -___ - -### intersectsBox - -▸ **intersectsBox**(`box`): `boolean` - -Return whether the input box intersects the AreaCollection. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `box` | `Box3` | - -#### Returns - -`boolean` - -#### Defined in - -[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 deleted file mode 100644 index a63ae86e143..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CameraManager.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -id: "cognite_reveal.CameraManager" -title: "Interface: CameraManager" -sidebar_label: "CameraManager" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).CameraManager - -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 the viewer. Implementations -must trigger the `cameraChange`-event when camera is changed. -The default implementation is [DefaultCameraManager](../classes/cognite_reveal.DefaultCameraManager.md). - -## Implemented by - -- [`DefaultCameraManager`](../classes/cognite_reveal.DefaultCameraManager.md) - -## Methods - -### activate - -▸ **activate**(`cameraManager?`): `void` - -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 viewer. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cameraManager?` | [`CameraManager`](cognite_reveal.CameraManager.md) | Previously used camera manager. | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:61](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L61) - -___ - -### deactivate - -▸ **deactivate**(): `void` - -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 viewer. - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:69](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L69) - -___ - -### dispose - -▸ **dispose**(): `void` - -**`Obvious`** - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:109](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L109) - -___ - -### fitCameraToBoundingBox - -▸ **fitCameraToBoundingBox**(`boundingBox`, `duration?`, `radiusFactor?`): `void` - -Moves camera to a place where the content of a bounding box is visible to the camera. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `boundingBox` | `Box3` | The bounding box in world space. | -| `duration?` | `number` | The duration of the animation moving the camera. | -| `radiusFactor?` | `number` | The ratio of the distance from camera to center of box and radius of the box. | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:97](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L97) - -___ - -### getCamera - -▸ **getCamera**(): `PerspectiveCamera` - -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. - -#### Returns - -`PerspectiveCamera` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:29](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L29) - -___ - -### getCameraState - -▸ **getCameraState**(): `Required`\<[`CameraState`](../modules/cognite_reveal.md#camerastate)\> - -Get camera's state - -#### Returns - -`Required`\<[`CameraState`](../modules/cognite_reveal.md#camerastate)\> - -Camera state: position, target and rotation. - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:52](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L52) - -___ - -### off - -▸ **off**(`event`, `callback`): `void` - -Unsubscribes from changes of the camera event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"cameraChange"`` | The event type. | -| `callback` | [`CameraChangeDelegate`](../modules/cognite_reveal.md#camerachangedelegate) | Callback function to be unsubscribed. | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"cameraStop"`` | -| `callback` | [`CameraStopDelegate`](../modules/cognite_reveal.md#camerastopdelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"cameraChange"`` \| ``"cameraStop"`` | -| `callback` | [`CameraEventDelegate`](../modules/cognite_reveal.md#cameraeventdelegate) | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:89](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L89) - -___ - -### on - -▸ **on**(`event`, `callback`): `void` - -Subscribes to events on this camera manager. There are several event types: -'cameraChange' - Subscribes to changes of the camera. This is used by Reveal to react on changes of the camera. -'cameraStop' - Subscribes to events indicating the camera has stopped - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"cameraChange"`` | The event type. | -| `callback` | [`CameraChangeDelegate`](../modules/cognite_reveal.md#camerachangedelegate) | Callback to be called when the event is fired. | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"cameraStop"`` | -| `callback` | [`CameraStopDelegate`](../modules/cognite_reveal.md#camerastopdelegate) | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"cameraChange"`` \| ``"cameraStop"`` | -| `callback` | [`CameraEventDelegate`](../modules/cognite_reveal.md#cameraeventdelegate) | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:80](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L80) - -___ - -### setCameraState - -▸ **setCameraState**(`state`): `void` - -Set camera's state. Rotation and target can't be set at the same time as they could conflict, -should throw an error if both are passed with non-zero value inside state. - -**`Example`** - -```js -// store position, target -const { position, target } = cameraManager.getCameraState(); -// restore position, target -cameraManager.setCameraState({ position, target }); -``` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | [`CameraState`](../modules/cognite_reveal.md#camerastate) | Camera state, all fields are optional. | - -#### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/CameraManager.ts:46](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/CameraManager.ts#L46) - -___ - -### update - -▸ **update**(`deltaTime`, `boundingBox`): `void` - -Updates internal state of camera manager. Expected to update visual state of the camera -as well as it's near and far planes if needed. Called in `requestAnimationFrame`-loop. -Reveal performance affects frequency with which this method is called. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deltaTime` | `number` | Delta time since last update in seconds. | -| `boundingBox` | `Box3` | Global bounding box of the model(s) and any custom objects added to the scene. | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index 056cd359715..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: "cognite_reveal.CdfModelNodeCollectionDataProvider" -title: "Interface: CdfModelNodeCollectionDataProvider" -sidebar_label: "CdfModelNodeCollectionDataProvider" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).CdfModelNodeCollectionDataProvider - -Provides metadata needed to get asset mappings for a CDF 3D model - -## Implemented by - -- [`CogniteCadModel`](../classes/cognite_reveal.CogniteCadModel.md) - -## Properties - -### modelId - -• **modelId**: `number` - -Model and revision IDs for the model - -#### Defined in - -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:31](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L31) - -___ - -### nodeCount - -• **nodeCount**: `number` - -Total count of nodes in the model - -#### Defined in - -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L26) - -___ - -### revisionId - -• **revisionId**: `number` - -#### Defined in - -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L32) - -## Methods - -### getCdfToDefaultModelTransformation - -▸ **getCdfToDefaultModelTransformation**(`out?`): `Matrix4` - -Gets the default transformation of the model from CDF space. -The current total transformation of the model from the backend to its transform in ThreeJS space -is thus `model.getCdfToDefaultModelTransformation() * model.getModelTransformation()`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `out?` | `Matrix4` | - -#### Returns - -`Matrix4` - -#### Defined in - -[packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts:21](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/CdfModelNodeCollectionDataProvider.ts#L21) - -___ - -### getModelTransformation - -▸ **getModelTransformation**(`out?`): `Matrix4` - -Gets the transformation of the model in ThreeJS space - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `out?` | `Matrix4` | - -#### Returns - -`Matrix4` - -#### Defined in - -[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 deleted file mode 100644 index 8c8f9f2e59b..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Cognite3DViewerOptions.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -id: "cognite_reveal.Cognite3DViewerOptions" -title: "Interface: Cognite3DViewerOptions" -sidebar_label: "Cognite3DViewerOptions" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).Cognite3DViewerOptions - -## Properties - -### antiAliasingHint - -• `Optional` **antiAliasingHint**: ``"disabled"`` \| ``"fxaa"`` \| ``"msaa2+fxaa"`` \| ``"msaa4+fxaa"`` \| ``"msaa8+fxaa"`` \| ``"msaa16+fxaa"`` \| ``"msaa2"`` \| ``"msaa4"`` \| ``"msaa8"`` \| ``"msaa16"`` - -Hints Reveal to use a given anti-aliasing technique. - -Fast approximate anti-aliasing (FXAA) is a fast technique that will remove some, but not all aliasing effects. See -https://en.wikipedia.org/wiki/Fast_approximate_anti-aliasing. - -Multi-sampling anti-aliasinbg (MSAA) is a technique for taking multiple samples per pixel to avoid aliasing effects. -This mode requires WebGL 2. See https://www.khronos.org/opengl/wiki/Multisampling. - -The combined modes will apply both MSAA and FXAA anti-aliasing and yields the best visual result. - -When using the MSAA modes combined with FXAA Reveal will fall back to FXAA on WebGL 1. There is no fallback for the -"plain" MSAA modes on WebGL 1. - -Currently the default mode is FXAA, but this is subject to change. - -#### Defined in - -[packages/api/src/public/migration/types.ts:113](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L113) - -___ - -### cameraManager - -• `Optional` **cameraManager**: [`CameraManager`](cognite_reveal.CameraManager.md) - -Camera manager instance that is used for controlling the camera. -It is responsible for all manipulations that are done with the camera, -including animations and modification of state. Also, gives ability -to provide custom `THREE.PerspectiveCamera` instance to [Cognite3DViewer](../classes/cognite_reveal.Cognite3DViewer.md). -Default implementation is [DefaultCameraManager](../classes/cognite_reveal.DefaultCameraManager.md). - -#### Defined in - -[packages/api/src/public/migration/types.ts:78](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L78) - -___ - -### continuousModelStreaming - -• `Optional` **continuousModelStreaming**: `boolean` - -Allows for controlling if geometry streaming should be halted when -the camera is moving. Note that this option should left to false on -low-end devices as more loading can cause frame drops. - -Default value is set to true. - -#### Defined in - -[packages/api/src/public/migration/types.ts:173](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L173) - -___ - -### customDataSource - -• `Optional` **customDataSource**: [`DataSource`](cognite_reveal_extensions_datasource.DataSource.md) - -Allows providing a custom data source that Reveal will -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](../classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md). - -This cannot be used together with Cognite3DViewerOptions._localModels. - -#### Defined in - -[packages/api/src/public/migration/types.ts:164](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L164) - -___ - -### domElement - -• `Optional` **domElement**: `HTMLElement` - -An existing DOM element that we will render canvas into. - -#### Defined in - -[packages/api/src/public/migration/types.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L47) - -___ - -### enableEdges - -• `Optional` **enableEdges**: `boolean` - -Enables / disables visualizing the edges of geometry. Defaults to true. - -#### Defined in - -[packages/api/src/public/migration/types.ts:149](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L149) - -___ - -### loadingIndicatorStyle - -• `Optional` **loadingIndicatorStyle**: `Object` - -Style the loading indicator. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `opacity` | `number` | Opacity of the spinner in fractions. Valid values are between 0.2 and 1.0. Defaults to 1.0. | -| `placement` | ``"topLeft"`` \| ``"topRight"`` \| ``"bottomLeft"`` \| ``"bottomRight"`` | What corner the spinner should be placed in. Defaults top topLeft. | - -#### Defined in - -[packages/api/src/public/migration/types.ts:60](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L60) - -___ - -### logMetrics - -• `Optional` **logMetrics**: `boolean` - -Send anonymous usage statistics. - -#### Defined in - -[packages/api/src/public/migration/types.ts:50](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L50) - -___ - -### onLoading - -• `Optional` **onLoading**: [`OnLoadingCallback`](../modules/cognite_reveal.md#onloadingcallback) - -Callback to download stream progress. - -#### Defined in - -[packages/api/src/public/migration/types.ts:152](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L152) - -___ - -### pointCloudEffects - -• `Optional` **pointCloudEffects**: `Object` - -Point cloud visualisation effects parameteres. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `edlOptions?` | ``"disabled"`` \| `Partial`\<[`EdlOptions`](../modules/cognite_reveal.md#edloptions)\> | Eye Dome Lighting (EDL) effect, considerably improves depth perception of point cloud model. | -| `pointBlending?` | `boolean` | Point blending effect, creates more "stable" texture on objects surfaces if point sizing is big enough. Can cause significant decrease in performance on some machines. | - -#### Defined in - -[packages/api/src/public/migration/types.ts:134](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L134) - -___ - -### renderTargetOptions - -• `Optional` **renderTargetOptions**: `Object` - -Render to offscreen buffer instead of canvas. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `autoSetSize?` | `boolean` | -| `target` | `WebGLRenderTarget` | - -#### Defined in - -[packages/api/src/public/migration/types.ts:55](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L55) - -___ - -### renderer - -• `Optional` **renderer**: `WebGLRenderer` - -Renderer used to visualize model (optional). -Note that when providing a custom renderer, this should be configured with -`'powerPreference': 'high-performance'` for best performance. - -#### Defined in - -[packages/api/src/public/migration/types.ts:84](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L84) - -___ - -### rendererResolutionThreshold - -• `Optional` **rendererResolutionThreshold**: `number` - -Generally Reveal will follow the resolution given by the size -of the encapsulating DOM element of the Canvas [domElement](cognite_reveal.Cognite3DViewerOptions.md#domelement). -To ensure managable performance, Reveal will by default set an upper threshold to limit -the resolution. Setting the [rendererResolutionThreshold](cognite_reveal.Cognite3DViewerOptions.md#rendererresolutionthreshold) will -set this upper limit of what resolution Reveal will allow. - -**`Deprecated`** - -Use [setResolutionOptions](../classes/cognite_reveal.Cognite3DViewer.md#setresolutionoptions) instead. - -#### Defined in - -[packages/api/src/public/migration/types.ts:95](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L95) - -___ - -### sdk - -• **sdk**: `default` - -Initialized connection to CDF used to load data. - -#### Defined in - -[packages/api/src/public/migration/types.ts:44](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L44) - -___ - -### ssaoQualityHint - -• `Optional` **ssaoQualityHint**: ``"disabled"`` \| ``"medium"`` \| ``"high"`` \| ``"veryhigh"`` - -Hints the renderer of the quality it should aim for for screen space ambient occlusion, -an effect creating shadows and that gives the rendered image more depth. - -#### Defined in - -[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 deleted file mode 100644 index 4aac489c66a..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: "cognite_reveal.Image360" -title: "Interface: Image360" -sidebar_label: "Image360" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).Image360 - -## Properties - -### image360Visualization - -• `Readonly` **image360Visualization**: [`Image360Visualization`](cognite_reveal.Image360Visualization.md) - -The object containing the unit cube with the 360 images. - -#### Defined in - -[packages/360-images/src/entity/Image360.ts:26](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/entity/Image360.ts#L26) - -___ - -### transform - -• `Readonly` **transform**: `Matrix4` - -Get a copy of the model-to-world transformation matrix -of the given 360 image. - -#### Defined in - -[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 deleted file mode 100644 index aa2ba0b96e4..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Annotation.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -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 deleted file mode 100644 index 7af79793c0e..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Collection.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -id: "cognite_reveal.Image360Collection" -title: "Interface: Image360Collection" -sidebar_label: "Image360Collection" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).Image360Collection - -A wrapper that represents a set of 360 images. - -## Properties - -### image360Entities - -• `Readonly` **image360Entities**: [`Image360`](cognite_reveal.Image360.md)[] - -A list containing all the 360 images in this set. - -#### Defined in - -[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` - -Unsubscribes from 360 image dataset event. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"image360Entered"`` | The event type. | -| `callback` | [`Image360EnteredDelegate`](../modules/cognite_reveal.md#image360entereddelegate) | Callback function to be unsubscribed. | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"image360Exited"`` | -| `callback` | [`Image360ExitedDelegate`](../modules/cognite_reveal.md#image360exiteddelegate) | - -#### Returns - -`void` - -#### Defined in - -[packages/360-images/src/collection/Image360Collection.ts:82](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L82) - -___ - -### on - -▸ **on**(`event`, `callback`): `void` - -Subscribes to events on 360 Image datasets. There are several event types: -'image360Entered' - Subscribes to a event for entering 360 image mode. -'image360Exited' - Subscribes to events indicating 360 image mode has exited. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `event` | ``"image360Entered"`` | The event type. | -| `callback` | [`Image360EnteredDelegate`](../modules/cognite_reveal.md#image360entereddelegate) | Callback to be called when the event is fired. | - -#### Returns - -`void` - -#### Defined in - -[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` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | ``"image360Exited"`` | -| `callback` | [`Image360ExitedDelegate`](../modules/cognite_reveal.md#image360exiteddelegate) | - -#### Returns - -`void` - -#### Defined in - -[packages/360-images/src/collection/Image360Collection.ts:74](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/collection/Image360Collection.ts#L74) - -___ - -### set360IconCullingRestrictions - -▸ **set360IconCullingRestrictions**(`radius`, `pointLimit`): `void` - -Specify parameters used to determine the number of icons that are visible when entering 360 Images. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `radius` | `number` | Only icons within the given radius will be made visible. | -| `pointLimit` | `number` | Limit the number of points within the given radius. Points closer to the camera will be prioritized. | - -#### Returns - -`void` - -#### Defined in - -[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) - -___ - -### setIconsVisibility - -▸ **setIconsVisibility**(`visible`): `void` - -Set visibility of all 360 image icons. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `visible` | `boolean` | If true all icons are made visible according to the active culling scheme. If false all icons are hidden. | - -#### Returns - -`void` - -#### Defined in - -[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 deleted file mode 100644 index fa0ad88cfab..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Revision.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -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 deleted file mode 100644 index 5d5f7648e60..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Image360Visualization.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: "cognite_reveal.Image360Visualization" -title: "Interface: Image360Visualization" -sidebar_label: "Image360Visualization" -custom_edit_url: null ---- - -[@cognite/reveal](../modules/cognite_reveal.md).Image360Visualization - -Interface to control visualization of a 360 image - -## Properties - -### opacity - -• **opacity**: `number` - -Opaqueness of the 360 image - -#### Defined in - -[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 deleted file mode 100644 index 1032263feee..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.Overlay3D.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -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 deleted file mode 100644 index 696ff84d3c1..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal.OverlayCollection.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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 deleted file mode 100644 index 23dda73bb01..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BinaryFileProvider.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.BinaryFileProvider" -title: "Interface: BinaryFileProvider" -sidebar_label: "BinaryFileProvider" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).BinaryFileProvider - -## Hierarchy - -- **`BinaryFileProvider`** - - ↳ [`ModelDataProvider`](cognite_reveal_extensions_datasource.ModelDataProvider.md) - -## Methods - -### getBinaryFile - -▸ **getBinaryFile**(`baseUrl`, `fileName`, `abortSignal?`): `Promise`\<`ArrayBuffer`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `baseUrl` | `string` | -| `fileName` | `string` | -| `abortSignal?` | `AbortSignal` | - -#### Returns - -`Promise`\<`ArrayBuffer`\> - -#### Defined in - -[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 deleted file mode 100644 index 13c1e7cc3e8..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.BlobOutputMetadata.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.BlobOutputMetadata" -title: "Interface: BlobOutputMetadata" -sidebar_label: "BlobOutputMetadata" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).BlobOutputMetadata - -## Properties - -### blobId - -• **blobId**: `number` - -#### Defined in - -[packages/data-providers/src/types.ts:80](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L80) - -___ - -### format - -• **format**: `string` - -#### Defined in - -[packages/data-providers/src/types.ts:81](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/types.ts#L81) - -___ - -### version - -• **version**: `number` - -#### Defined in - -[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 deleted file mode 100644 index cabb98472bb..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.DataSource.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.DataSource" -title: "Interface: DataSource" -sidebar_label: "DataSource" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).DataSource - -Describes how Reveal data is stored, and provides means to create custom storage providers -that Reveal will fetch data from. - -## Methods - -### getModelDataProvider - -▸ **getModelDataProvider**(): [`ModelDataProvider`](cognite_reveal_extensions_datasource.ModelDataProvider.md) - -Gets a client that is able to download geometry and other files -for models. - -#### Returns - -[`ModelDataProvider`](cognite_reveal_extensions_datasource.ModelDataProvider.md) - -#### Defined in - -[packages/data-source/src/DataSource.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-source/src/DataSource.ts#L28) - -___ - -### getModelMetadataProvider - -▸ **getModelMetadataProvider**(): [`ModelMetadataProvider`](cognite_reveal_extensions_datasource.ModelMetadataProvider.md) - -Gets a metadata provider for models. - -#### Returns - -[`ModelMetadataProvider`](cognite_reveal_extensions_datasource.ModelMetadataProvider.md) - -#### Defined in - -[packages/data-source/src/DataSource.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-source/src/DataSource.ts#L22) - -___ - -### getNodesApiClient - -▸ **getNodesApiClient**(): [`NodesApiClient`](cognite_reveal_extensions_datasource.NodesApiClient.md) - -Gets a node API client that is able to fetch data about -models. - -#### Returns - -[`NodesApiClient`](cognite_reveal_extensions_datasource.NodesApiClient.md) - -#### Defined in - -[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 deleted file mode 100644 index 4b16fb538d2..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.JsonFileProvider.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.JsonFileProvider" -title: "Interface: JsonFileProvider" -sidebar_label: "JsonFileProvider" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).JsonFileProvider - -## Hierarchy - -- **`JsonFileProvider`** - - ↳ [`ModelDataProvider`](cognite_reveal_extensions_datasource.ModelDataProvider.md) - -## Methods - -### getJsonFile - -▸ **getJsonFile**(`baseUrl`, `fileName`): `Promise`\<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `baseUrl` | `string` | -| `fileName` | `string` | - -#### Returns - -`Promise`\<`any`\> - -#### Defined in - -[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 deleted file mode 100644 index e2058fee4bb..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelDataProvider.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.ModelDataProvider" -title: "Interface: ModelDataProvider" -sidebar_label: "ModelDataProvider" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).ModelDataProvider - -Provides data for 3D models. - -## Hierarchy - -- [`JsonFileProvider`](cognite_reveal_extensions_datasource.JsonFileProvider.md) - -- [`BinaryFileProvider`](cognite_reveal_extensions_datasource.BinaryFileProvider.md) - - ↳ **`ModelDataProvider`** - -## Methods - -### getBinaryFile - -▸ **getBinaryFile**(`baseUrl`, `fileName`, `abortSignal?`): `Promise`\<`ArrayBuffer`\> - -Downloads a binary blob. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `baseUrl` | `string` | Base URL of the model. | -| `fileName` | `string` | Filename of binary file. | -| `abortSignal?` | `AbortSignal` | Optional abort signal that can be used to cancel an in progress fetch. | - -#### Returns - -`Promise`\<`ArrayBuffer`\> - -#### Overrides - -[BinaryFileProvider](cognite_reveal_extensions_datasource.BinaryFileProvider.md).[getBinaryFile](cognite_reveal_extensions_datasource.BinaryFileProvider.md#getbinaryfile) - -#### Defined in - -[packages/data-providers/src/ModelDataProvider.ts:23](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelDataProvider.ts#L23) - -___ - -### getJsonFile - -▸ **getJsonFile**(`baseUrl`, `fileName`): `Promise`\<`any`\> - -Download and parse a JSON file and return the resulting struct. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `baseUrl` | `string` | Base URL of the model. | -| `fileName` | `string` | Filename of JSON file. | - -#### Returns - -`Promise`\<`any`\> - -#### Overrides - -[JsonFileProvider](cognite_reveal_extensions_datasource.JsonFileProvider.md).[getJsonFile](cognite_reveal_extensions_datasource.JsonFileProvider.md#getjsonfile) - -#### Defined in - -[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 deleted file mode 100644 index 5a40d89e2ea..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.ModelIdentifier" -title: "Interface: ModelIdentifier" -sidebar_label: "ModelIdentifier" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).ModelIdentifier - -Identifies a 3D model. Typically, implementations will use [CdfModelIdentifier](../classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md). - -## Implemented by - -- [`CdfModelIdentifier`](../classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md) - -## Properties - -### revealInternalId - -• `Readonly` **revealInternalId**: `symbol` - -Unique ID of the model. - -#### Defined in - -[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 deleted file mode 100644 index 97fd62338b5..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.ModelMetadataProvider.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.ModelMetadataProvider" -title: "Interface: ModelMetadataProvider" -sidebar_label: "ModelMetadataProvider" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).ModelMetadataProvider - -Provides metadata for 3D models. - -## Methods - -### getModelCamera - -▸ **getModelCamera**(`identifier`): `Promise`\<`undefined` \| \{ `position`: `Vector3` ; `target`: `Vector3` }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `identifier` | [`ModelIdentifier`](cognite_reveal_extensions_datasource.ModelIdentifier.md) | - -#### Returns - -`Promise`\<`undefined` \| \{ `position`: `Vector3` ; `target`: `Vector3` }\> - -#### Defined in - -[packages/data-providers/src/ModelMetadataProvider.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L14) - -___ - -### getModelMatrix - -▸ **getModelMatrix**(`identifier`, `format`): `Promise`\<`Matrix4`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `identifier` | [`ModelIdentifier`](cognite_reveal_extensions_datasource.ModelIdentifier.md) | -| `format` | `string` | - -#### Returns - -`Promise`\<`Matrix4`\> - -#### Defined in - -[packages/data-providers/src/ModelMetadataProvider.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L15) - -___ - -### getModelOutputs - -▸ **getModelOutputs**(`modelIdentifier`): `Promise`\<[`BlobOutputMetadata`](cognite_reveal_extensions_datasource.BlobOutputMetadata.md)[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `modelIdentifier` | [`ModelIdentifier`](cognite_reveal_extensions_datasource.ModelIdentifier.md) | - -#### Returns - -`Promise`\<[`BlobOutputMetadata`](cognite_reveal_extensions_datasource.BlobOutputMetadata.md)[]\> - -#### Defined in - -[packages/data-providers/src/ModelMetadataProvider.ts:12](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/data-providers/src/ModelMetadataProvider.ts#L12) - -___ - -### getModelUri - -▸ **getModelUri**(`identifier`, `formatMetadata`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `identifier` | [`ModelIdentifier`](cognite_reveal_extensions_datasource.ModelIdentifier.md) | -| `formatMetadata` | [`BlobOutputMetadata`](cognite_reveal_extensions_datasource.BlobOutputMetadata.md) | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[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 deleted file mode 100644 index 2b8b3438b81..00000000000 --- a/documentation/versioned_docs/version-4.x/api/interfaces/cognite_reveal_extensions_datasource.NodesApiClient.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource.NodesApiClient" -title: "Interface: NodesApiClient" -sidebar_label: "NodesApiClient" -custom_edit_url: null ---- - -[@cognite/reveal/extensions/datasource](../modules/cognite_reveal_extensions_datasource.md).NodesApiClient - -Client for retrieving metadata information about CAD nodes. - -## Methods - -### determineNodeAncestorsByNodeId - -▸ **determineNodeAncestorsByNodeId**(`modelId`, `revisionId`, `nodeId`, `generation`): `Promise`\<\{ `subtreeSize`: `number` ; `treeIndex`: `number` }\> - -Determine ancestor subtree span of a given node. If the node doesn't have an -ancestor at the generation given, the span of the root node is returned. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `modelId` | `number` | ID of 3D model | -| `revisionId` | `number` | ID of 3D model revision | -| `nodeId` | `number` | Node ID of node | -| `generation` | `number` | Generation to retrieve (0 means node itself, 1 is parent, 2 grand-parent etc). | - -#### Returns - -`Promise`\<\{ `subtreeSize`: `number` ; `treeIndex`: `number` }\> - -#### Defined in - -[packages/nodes-api/src/NodesApiClient.ts:51](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L51) - -___ - -### determineTreeIndexAndSubtreeSizesByNodeIds - -▸ **determineTreeIndexAndSubtreeSizesByNodeIds**(`modelId`, `revisionId`, `nodeIds`): `Promise`\<\{ `subtreeSize`: `number` ; `treeIndex`: `number` }[]\> - -Determines tree index and subtreeSize (i.e. span of the subtree a node is parent -of) given a set of node IDs. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `modelId` | `number` | -| `revisionId` | `number` | -| `nodeIds` | `number`[] | - -#### Returns - -`Promise`\<\{ `subtreeSize`: `number` ; `treeIndex`: `number` }[]\> - -#### Defined in - -[packages/nodes-api/src/NodesApiClient.ts:37](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L37) - -___ - -### getBoundingBoxesByNodeIds - -▸ **getBoundingBoxesByNodeIds**(`modelId`, `revisionId`, `nodeIds`): `Promise`\<`Box3`[]\> - -Determines the bounds of the individual nodes provided. Note that the returned -boxes will be in "CDF coordinates" and not transformed using -the model transformation for the given model. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `modelId` | `number` | ID of 3D model | -| `revisionId` | `number` | ID of 3D model revision | -| `nodeIds` | `number`[] | Node IDs of nodes | - -#### Returns - -`Promise`\<`Box3`[]\> - -#### Defined in - -[packages/nodes-api/src/NodesApiClient.ts:67](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L67) - -___ - -### mapNodeIdsToTreeIndices - -▸ **mapNodeIdsToTreeIndices**(`modelId`, `revisionId`, `nodeIds`): `Promise`\<`number`[]\> - -Maps a set of "node IDs" that identify nodes, to the respective -"tree indexes". - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `modelId` | `number` | -| `revisionId` | `number` | -| `nodeIds` | `number`[] | - -#### Returns - -`Promise`\<`number`[]\> - -#### Defined in - -[packages/nodes-api/src/NodesApiClient.ts:27](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/nodes-api/src/NodesApiClient.ts#L27) - -___ - -### mapTreeIndicesToNodeIds - -▸ **mapTreeIndicesToNodeIds**(`modelId`, `revisionId`, `treeIndices`): `Promise`\<`number`[]\> - -Maps a set of "tree indexes" that identify nodes, to the respective -"node IDs". - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `modelId` | `number` | -| `revisionId` | `number` | -| `treeIndices` | `number`[] | - -#### Returns - -`Promise`\<`number`[]\> - -#### Defined in - -[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.md b/documentation/versioned_docs/version-4.x/api/modules.md index fe77bec9fe7..b2f733b83a3 100644 --- a/documentation/versioned_docs/version-4.x/api/modules.md +++ b/documentation/versioned_docs/version-4.x/api/modules.md @@ -1,14 +1,7 @@ ---- -id: "modules" -title: "@cognite/reveal" -sidebar_label: "Table of Contents" -sidebar_position: 0.5 -hide_table_of_contents: true -custom_edit_url: null ---- +# @cognite/reveal ## Modules -- [@cognite/reveal](modules/cognite_reveal.md) -- [@cognite/reveal/extensions/datasource](modules/cognite_reveal_extensions_datasource.md) -- [@cognite/reveal/tools](modules/cognite_reveal_tools.md) +- [@cognite/reveal](@cognite/reveal/index.md) +- [@cognite/reveal/extensions/datasource](@cognite/reveal/extensions/datasource/index.md) +- [@cognite/reveal/tools](@cognite/reveal/tools/index.md) diff --git a/documentation/versioned_docs/version-4.x/api/modules/_category_.yml b/documentation/versioned_docs/version-4.x/api/modules/_category_.yml deleted file mode 100644 index 63f9c4e4016..00000000000 --- a/documentation/versioned_docs/version-4.x/api/modules/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Modules" -position: 1 \ No newline at end of file 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 deleted file mode 100644 index d1226171c05..00000000000 --- a/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal.md +++ /dev/null @@ -1,1087 +0,0 @@ ---- -id: "cognite_reveal" -title: "Module: @cognite/reveal" -sidebar_label: "@cognite/reveal" -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumerations - -- [NodeOutlineColor](../enums/cognite_reveal.NodeOutlineColor.md) -- [PointColorType](../enums/cognite_reveal.PointColorType.md) -- [PointShape](../enums/cognite_reveal.PointShape.md) -- [PointSizeType](../enums/cognite_reveal.PointSizeType.md) -- [WellKnownAsprsPointClassCodes](../enums/cognite_reveal.WellKnownAsprsPointClassCodes.md) - -## Classes - -- [AnnotationIdPointCloudObjectCollection](../classes/cognite_reveal.AnnotationIdPointCloudObjectCollection.md) -- [AssetNodeCollection](../classes/cognite_reveal.AssetNodeCollection.md) -- [BoundingBoxClipper](../classes/cognite_reveal.BoundingBoxClipper.md) -- [CameraManagerHelper](../classes/cognite_reveal.CameraManagerHelper.md) -- [CdfNodeCollectionBase](../classes/cognite_reveal.CdfNodeCollectionBase.md) -- [ClusteredAreaCollection](../classes/cognite_reveal.ClusteredAreaCollection.md) -- [Cognite3DViewer](../classes/cognite_reveal.Cognite3DViewer.md) -- [CogniteCadModel](../classes/cognite_reveal.CogniteCadModel.md) -- [CognitePointCloudModel](../classes/cognite_reveal.CognitePointCloudModel.md) -- [CombineNodeCollectionBase](../classes/cognite_reveal.CombineNodeCollectionBase.md) -- [ComboControls](../classes/cognite_reveal.ComboControls.md) -- [DebouncedCameraStopEventTrigger](../classes/cognite_reveal.DebouncedCameraStopEventTrigger.md) -- [DefaultCameraManager](../classes/cognite_reveal.DefaultCameraManager.md) -- [IndexSet](../classes/cognite_reveal.IndexSet.md) -- [IntersectionNodeCollection](../classes/cognite_reveal.IntersectionNodeCollection.md) -- [InvertedNodeCollection](../classes/cognite_reveal.InvertedNodeCollection.md) -- [NodeCollection](../classes/cognite_reveal.NodeCollection.md) -- [NodeIdNodeCollection](../classes/cognite_reveal.NodeIdNodeCollection.md) -- [NumericRange](../classes/cognite_reveal.NumericRange.md) -- [PointCloudObjectCollection](../classes/cognite_reveal.PointCloudObjectCollection.md) -- [PropertyFilterNodeCollection](../classes/cognite_reveal.PropertyFilterNodeCollection.md) -- [SinglePropertyFilterNodeCollection](../classes/cognite_reveal.SinglePropertyFilterNodeCollection.md) -- [StyledPointCloudObjectCollection](../classes/cognite_reveal.StyledPointCloudObjectCollection.md) -- [TreeIndexNodeCollection](../classes/cognite_reveal.TreeIndexNodeCollection.md) -- [UnionNodeCollection](../classes/cognite_reveal.UnionNodeCollection.md) - -## Interfaces - -- [AddModelOptions](../interfaces/cognite_reveal.AddModelOptions.md) -- [AreaCollection](../interfaces/cognite_reveal.AreaCollection.md) -- [CameraManager](../interfaces/cognite_reveal.CameraManager.md) -- [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 - -### AddImage360Options - -Ƭ **AddImage360Options**: `Object` - -#### Type declaration - -| 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`** ```ts true ``` | - -#### Defined in - -[packages/api/src/public/migration/types.ts:203](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L203) - -___ - -### BeforeSceneRenderedDelegate - -Ƭ **BeforeSceneRenderedDelegate**: (`event`: \{ `camera`: `THREE.PerspectiveCamera` ; `frameNumber`: `number` ; `renderer`: `THREE.WebGLRenderer` }) => `void` - -#### Type declaration - -▸ (`event`): `void` - -Delegate for event triggered when scene is about to be rendered. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `Object` | -| `event.camera` | `THREE.PerspectiveCamera` | -| `event.frameNumber` | `number` | -| `event.renderer` | `THREE.WebGLRenderer` | - -##### Returns - -`void` - -#### Defined in - -[packages/utilities/src/events/types.ts:25](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L25) - -___ - -### CadIntersection - -Ƭ **CadIntersection**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `distanceToCamera` | `number` | Distance from the camera to the intersection. | -| `model` | [`CogniteCadModel`](../classes/cognite_reveal.CogniteCadModel.md) | The model that was intersected. | -| `point` | `THREE.Vector3` | Coordinate of the intersection. | -| `treeIndex` | `number` | Tree index of the intersected 3D node. | -| `type` | ``"cad"`` | The intersection type. | - -#### Defined in - -[packages/api/src/public/migration/types.ts:215](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L215) - -___ - -### CadModelBudget - -Ƭ **CadModelBudget**: `Object` - -Represents a measurement of how much geometry can be loaded. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `highDetailProximityThreshold` | `number` | Sectors within this distance from the camera will always be loaded in high details. **`Deprecated`** This is only used for 3D models processed prior to the Reveal 3.0 release (Q1 2022). | -| `maximumRenderCost` | `number` | Maximum render cost. This number can be thought of as triangle count, although the number doesn't match this directly. | - -#### Defined in - -[packages/cad-geometry-loaders/src/CadModelBudget.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-geometry-loaders/src/CadModelBudget.ts#L10) - -___ - -### CameraChangeDelegate - -Ƭ **CameraChangeDelegate**: (`position`: `THREE.Vector3`, `target`: `THREE.Vector3`) => `void` - -#### Type declaration - -▸ (`position`, `target`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `position` | `THREE.Vector3` | -| `target` | `THREE.Vector3` | - -##### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/types.ts:85](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L85) - -___ - -### CameraConfiguration - -Ƭ **CameraConfiguration**: `Object` - -Represents a camera configuration, consisting of a camera position and target. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `position` | `THREE.Vector3` | -| `target` | `THREE.Vector3` | - -#### Defined in - -[packages/utilities/src/CameraConfiguration.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/CameraConfiguration.ts#L8) - -___ - -### CameraControlsOptions - -Ƭ **CameraControlsOptions**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `changeCameraTargetOnClick?` | `boolean` | Enables or disables change of camera target on mouse click. New target is then set to the point of the model under current cursor position. Default is false. | -| `mouseWheelAction?` | ``"zoomToTarget"`` \| ``"zoomPastCursor"`` \| ``"zoomToCursor"`` | Sets mouse wheel initiated action. Modes: 'zoomToTarget' - zooms just to the current target (center of the screen) of the camera. 'zoomPastCursor' - zooms in the direction of the ray coming from camera through cursor screen position, allows going through objects. 'zoomToCursor' - mouse wheel scroll zooms towards the point on the model where cursor is hovering over, doesn't allow going through objects. Default is 'zoomPastCursor'. | - -#### Defined in - -[packages/camera-manager/src/types.ts:5](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L5) - -___ - -### CameraEventDelegate - -Ƭ **CameraEventDelegate**: [`CameraChangeDelegate`](cognite_reveal.md#camerachangedelegate) \| [`CameraStopDelegate`](cognite_reveal.md#camerastopdelegate) - -Union type of all camera event delegates - -#### Defined in - -[packages/camera-manager/src/types.ts:96](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L96) - -___ - -### CameraManagerEventType - -Ƭ **CameraManagerEventType**: typeof [`CAMERA_MANAGER_EVENT_TYPE_LIST`](cognite_reveal.md#camera_manager_event_type_list)[`number`] - -Union type of the supported camera manager event types - -#### Defined in - -[packages/camera-manager/src/types.ts:123](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L123) - -___ - -### CameraState - -Ƭ **CameraState**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `position?` | `THREE.Vector3` | Camera position in world space. | -| `rotation?` | `THREE.Quaternion` | Camera local rotation in quaternion form. | -| `target?` | `THREE.Vector3` | Camera target in world space. * | - -#### Defined in - -[packages/camera-manager/src/types.ts:66](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L66) - -___ - -### CameraStopDelegate - -Ƭ **CameraStopDelegate**: () => `void` - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[packages/camera-manager/src/types.ts:91](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L91) - -___ - -### ClippingPlanesState - -Ƭ **ClippingPlanesState**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `constant` | `number` | -| `nx` | `number` | -| `ny` | `number` | -| `nz` | `number` | - -#### Defined in - -[packages/api/src/utilities/ViewStateHelper.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/utilities/ViewStateHelper.ts#L28) - -___ - -### CogniteModel - -Ƭ **CogniteModel**: [`CogniteCadModel`](../classes/cognite_reveal.CogniteCadModel.md) \| [`CognitePointCloudModel`](../classes/cognite_reveal.CognitePointCloudModel.md) - -Type abstraction for CogniteCadModel or CognitePointCloudModel;. - -#### Defined in - -[packages/api/src/public/types.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/types.ts#L11) - -___ - -### ComboControlsOptions - -Ƭ **ComboControlsOptions**: `Object` - -Exposed options for Combo Controls - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `EPSILON` | `number` | - | -| `dampingFactor` | `number` | - | -| `dollyFactor` | `number` | - | -| `dynamicTarget` | `boolean` | - | -| `enableDamping` | `boolean` | - | -| `enableKeyboardNavigation` | `boolean` | - | -| `firstPersonRotationFactor` | `number` | - | -| `keyboardDollySpeed` | `number` | - | -| `keyboardPanSpeed` | `number` | - | -| `keyboardRotationSpeedAzimuth` | `number` | - | -| `keyboardRotationSpeedPolar` | `number` | - | -| `keyboardSpeedFactor` | `number` | How much quicker keyboard navigation will be with 'shift' pressed | -| `lookAtViewTarget` | `boolean` | - | -| `maxAzimuthAngle` | `number` | Radians | -| `maxDeltaDownscaleCoefficient` | `number` | - | -| `maxDeltaRatio` | `number` | - | -| `maxPolarAngle` | `number` | Radians | -| `maxZoom` | `number` | - | -| `minAzimuthAngle` | `number` | Radians | -| `minDeltaDownscaleCoefficient` | `number` | - | -| `minDeltaRatio` | `number` | - | -| `minDistance` | `number` | - | -| `minPolarAngle` | `number` | Radians | -| `minZoom` | `number` | - | -| `minZoomDistance` | `number` | - | -| `mouseFirstPersonRotationSpeed` | `number` | - | -| `orthographicCameraDollyFactor` | `number` | - | -| `panDollyMinDistanceFactor` | `number` | - | -| `pinchEpsilon` | `number` | - | -| `pinchPanSpeed` | `number` | - | -| `pointerRotationSpeedAzimuth` | `number` | Radians per pixel | -| `pointerRotationSpeedPolar` | `number` | Radians per pixel | -| `useScrollTarget` | `boolean` | - | -| `zoomToCursor` | `boolean` | - | - -#### Defined in - -[packages/camera-manager/src/ComboControls.ts:47](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/ComboControls.ts#L47) - -___ - -### CompletePointCloudAppearance - -Ƭ **CompletePointCloudAppearance**: `Required`\<[`PointCloudAppearance`](cognite_reveal.md#pointcloudappearance)\> - -#### Defined in - -[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) - -___ - -### DisposedDelegate - -Ƭ **DisposedDelegate**: () => `void` - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[packages/utilities/src/events/types.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L20) - -___ - -### EdlOptions - -Ƭ **EdlOptions**: `Object` - -Configuration parameters for Eye Dome Lighting (EDL) point cloud post-processing effect. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `radius` | `number` | Radius of sampled points in pixels. Determines thickness of edges addet on top of points. | -| `strength` | `number` | Determines how pronounced the effect is. Lower values result in more transparent edges. | - -#### Defined in - -[packages/rendering/src/rendering/types.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/rendering/src/rendering/types.ts#L22) - -___ - -### GeometryFilter - -Ƭ **GeometryFilter**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `boundingBox?` | `THREE.Box3` | The bounds to load geometry within. By default this box is in CDF coordinate space which will be transformed into coordinates relative to the model using the the model transformation which can be specified using [the CDF API](https://docs.cognite.com/api/v1/#operation/update3DRevisions), or set in [Cognite Fusion](https://fusion.cognite.com/). **`See`** [isBoundingBoxInModelCoordinates](cognite_reveal.md#isboundingboxinmodelcoordinates). | -| `isBoundingBoxInModelCoordinates?` | `boolean` | When set, the geometry filter `boundingBox` will be considered to be in "Reveal/ThreeJS space". Rather than CDF space which is the default. When using Reveal space, the model transformation which can be specified using [the CDF API](https://docs.cognite.com/api/v1/#operation/update3DRevisions), or set in [Cognite Fusion](https://fusion.cognite.com/). | - -#### Defined in - -[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), `revision`: [`Image360Revision`](../interfaces/cognite_reveal.Image360Revision.md)) => `void` - -#### Type declaration - -▸ (`image360`, `revision`): `void` - -Delegate for 360 image mode entered events. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `image360` | [`Image360`](../interfaces/cognite_reveal.Image360.md) | -| `revision` | [`Image360Revision`](../interfaces/cognite_reveal.Image360Revision.md) | - -##### Returns - -`void` - -#### Defined in - -[packages/360-images/src/types.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/360-images/src/types.ts#L11) - -___ - -### Image360ExitedDelegate - -Ƭ **Image360ExitedDelegate**: () => `void` - -#### Type declaration - -▸ (): `void` - -Delegate for 360 image mode exited events. - -##### Returns - -`void` - -#### Defined in - -[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) - -___ - -### Intersection - -Ƭ **Intersection**: [`CadIntersection`](cognite_reveal.md#cadintersection) \| [`PointCloudIntersection`](cognite_reveal.md#pointcloudintersection) - -#### Defined in - -[packages/api/src/public/migration/types.ts:268](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L268) - -___ - -### ModelState - -Ƭ **ModelState**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `defaultNodeAppearance` | [`SerializableNodeAppearance`](cognite_reveal.md#serializablenodeappearance) | -| `modelId` | `number` | -| `revisionId` | `number` | -| `styledSets` | \{ `appearance`: [`SerializableNodeAppearance`](cognite_reveal.md#serializablenodeappearance) ; `options?`: `any` ; `state`: `any` ; `token`: `string` }[] | - -#### Defined in - -[packages/api/src/utilities/ViewStateHelper.ts:35](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/utilities/ViewStateHelper.ts#L35) - -___ - -### NodeAppearance - -Ƭ **NodeAppearance**: `Object` - -Type for defining node appearance profiles to style a 3D CAD model. - -**`See`** - -[DefaultNodeAppearance](cognite_reveal.md#defaultnodeappearance) - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `color?` | `Color` | Overrides the default color of the node in RGB. Black, or `new Color(0, 0, 0)` means no override. | -| `outlineColor?` | [`NodeOutlineColor`](../enums/cognite_reveal.NodeOutlineColor.md) | When set, an outline is drawn around the node to make it stand out. | -| `prioritizedForLoadingHint?` | `number` | When provided, this value can be used to prioritize certain areas of the 3D model to be loaded. This can be useful to prioritize key objects in the 3D model to always be loaded. When non-zero, sectors containing geometry in the vicinity of the prioritized sectors are given an *extra* priority. Recommended values are in range 1 (somewhat higher priority to be loaded) to 10 (very likely to be loaded). Usually values around 4-5 is recommended. Prioritized nodes are loaded at the expense of non-prioritized areas. There are no guarantees that the nodes are actually loaded, and the more prioritized areas/nodes provided, the less likely it is that the hint is obeyed. Extra priority doesn't accumulate when sectors are prioritized because they intersect/contain several nodes. **This is an advanced feature and not recommended for most users** **`Version`** Only works with 3D models converted later than Q4 2021. | -| `renderGhosted?` | `boolean` | When set to true, the node is rendered ghosted, i.e. transparent with a fixed color. This has no effect if [renderInFront](cognite_reveal.md#renderinfront) is `true`. | -| `renderInFront?` | `boolean` | When set to true, the node is rendered in front of all other nodes even if it's occluded. Note that this take precedence over [renderGhosted](cognite_reveal.md#renderghosted). | -| `visible?` | `boolean` | Overrides the visibility of the node. | - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L22) - -___ - -### NodeCollectionSerializationContext - -Ƭ **NodeCollectionSerializationContext**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `client` | `CogniteClient` | -| `model` | [`CdfModelNodeCollectionDataProvider`](../interfaces/cognite_reveal.CdfModelNodeCollectionDataProvider.md) | - -#### Defined in - -[packages/cad-styling/src/NodeCollectionDeserializer.ts:22](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeCollectionDeserializer.ts#L22) - -___ - -### OnLoadingCallback - -Ƭ **OnLoadingCallback**: (`itemsLoaded`: `number`, `itemsRequested`: `number`, `itemsCulled`: `number`) => `void` - -#### Type declaration - -▸ (`itemsLoaded`, `itemsRequested`, `itemsCulled`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `itemsLoaded` | `number` | -| `itemsRequested` | `number` | -| `itemsCulled` | `number` | - -##### Returns - -`void` - -#### Defined in - -[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) - -___ - -### PointCloudAppearance - -Ƭ **PointCloudAppearance**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `color?` | `Color` | -| `visible?` | `boolean` | - -#### Defined in - -[packages/pointcloud-styling/src/PointCloudAppearance.ts:7](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L7) - -___ - -### PointCloudBudget - -Ƭ **PointCloudBudget**: `Object` - -Represents a budget of how many point from point clouds can be -loaded at the same time. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `numberOfPoints` | `number` | Total number of points that can be loaded for all point clouds models accumulated. | - -#### Defined in - -[packages/pointclouds/src/PointCloudBudget.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointclouds/src/PointCloudBudget.ts#L10) - -___ - -### PointCloudIntersection - -Ƭ **PointCloudIntersection**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `annotationId` | `number` | Annotation Id of the intersected object within a pointcloud. (0 if not applicable) | -| `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` | 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/e9e26d38/viewer/packages/pointclouds/src/PointCloudIntersection.ts#L7) - -___ - -### PointCloudObjectMetadata - -Ƭ **PointCloudObjectMetadata**: `Object` - -Metadata for a single point cloud object - -#### Type declaration - -| 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 [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/e9e26d38/viewer/packages/data-providers/src/pointcloud-stylable-object-providers/types.ts#L21) - -___ - -### PointerEventData - -Ƭ **PointerEventData**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `button?` | `number` | -| `offsetX` | `number` | -| `offsetY` | `number` | - -#### Defined in - -[packages/utilities/src/events/types.ts:15](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L15) - -___ - -### PointerEventDelegate - -Ƭ **PointerEventDelegate**: (`event`: [`PointerEventData`](cognite_reveal.md#pointereventdata)) => `void` - -#### Type declaration - -▸ (`event`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | [`PointerEventData`](cognite_reveal.md#pointereventdata) | - -##### Returns - -`void` - -#### Defined in - -[packages/utilities/src/events/types.ts:9](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L9) - -___ - -### PropertyFilterNodeCollectionOptions - -Ƭ **PropertyFilterNodeCollectionOptions**: `Object` - -Options for [PropertyFilterNodeCollection](../classes/cognite_reveal.PropertyFilterNodeCollection.md). - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `requestPartitions?` | `number` | How many partitions to split the request into. More partitions can yield better performance for queries with very large result set (in order of magnitude 100.000 plus). Defaults to 1. | - -#### Defined in - -[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) - -___ - -### ResolutionOptions - -Ƭ **ResolutionOptions**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `maxRenderResolution?` | `number` | Generally Reveal will follow the resolution given by the size of the encapsulating DOM element of the Canvas [domElement](../interfaces/cognite_reveal.Cognite3DViewerOptions.md#domelement). To ensure managable performance, Reveal will by default set an upper threshold to limit the resolution. The `maxRenderResolution` option will directly control this upper limit. It corresponds to the number of pixels in the render target. | -| `movingCameraResolutionFactor?` | `number` | A factor that will scale down the resolution when moving the camera. This can be used to achieve a better user experience on devices with limited hardware. Values must be greater than 0 and at most 1. This factor is applied to the number of physical pixels of the canvas. A value of e.g. 0.25 will approximately divide the number of pixels rendered on the screen by four. | - -#### Defined in - -[packages/api/src/public/migration/types.ts:244](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/public/migration/types.ts#L244) - -___ - -### SceneRenderedDelegate - -Ƭ **SceneRenderedDelegate**: (`event`: \{ `camera`: `THREE.PerspectiveCamera` ; `frameNumber`: `number` ; `renderTime`: `number` ; `renderer`: `THREE.WebGLRenderer` }) => `void` - -#### Type declaration - -▸ (`event`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `Object` | -| `event.camera` | `THREE.PerspectiveCamera` | -| `event.frameNumber` | `number` | -| `event.renderTime` | `number` | -| `event.renderer` | `THREE.WebGLRenderer` | - -##### Returns - -`void` - -#### Defined in - -[packages/utilities/src/events/types.ts:35](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/events/types.ts#L35) - -___ - -### SerializableNodeAppearance - -Ƭ **SerializableNodeAppearance**: `Object` - -Type that represents a [NodeAppearance](cognite_reveal.md#nodeappearance) in a serializable format - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `color?` | [`number`, `number`, `number`] | Color as an RGB number tuple, with values in the range [0, 255] | -| `outlineColor?` | [`NodeOutlineColor`](../enums/cognite_reveal.NodeOutlineColor.md) | Outline color, **`See`** [NodeAppearance](cognite_reveal.md#nodeappearance) | -| `prioritizedForLoadingHint?` | `number` | Prioritized loading hint, **`See`** [NodeAppearance](cognite_reveal.md#nodeappearance) | -| `renderGhosted?` | `boolean` | Whether to render ghosted, **`See`** [NodeAppearance](cognite_reveal.md#nodeappearance) | -| `renderInFront?` | `boolean` | Whether to render in front, **`See`** [NodeAppearance](cognite_reveal.md#nodeappearance) | -| `visible?` | `boolean` | Visibility, **`See`** [NodeAppearance](cognite_reveal.md#nodeappearance) | - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:77](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L77) - -___ - -### SerializedNodeCollection - -Ƭ **SerializedNodeCollection**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `options?` | `any` | -| `state` | `any` | -| `token` | `string` | - -#### Defined in - -[packages/cad-styling/src/SerializedNodeCollection.ts:4](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/SerializedNodeCollection.ts#L4) - -___ - -### SupportedModelTypes - -Ƭ **SupportedModelTypes**: ``"pointcloud"`` \| ``"cad"`` - -#### Defined in - -[packages/model-base/src/SupportedModelTypes.ts:4](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/model-base/src/SupportedModelTypes.ts#L4) - -___ - -### ViewerState - -Ƭ **ViewerState**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `camera?` | \{ `position`: \{ `x`: `number` ; `y`: `number` ; `z`: `number` } ; `target`: \{ `x`: `number` ; `y`: `number` ; `z`: `number` } } | -| `camera.position` | \{ `x`: `number` ; `y`: `number` ; `z`: `number` } | -| `camera.position.x` | `number` | -| `camera.position.y` | `number` | -| `camera.position.z` | `number` | -| `camera.target` | \{ `x`: `number` ; `y`: `number` ; `z`: `number` } | -| `camera.target.x` | `number` | -| `camera.target.y` | `number` | -| `camera.target.z` | `number` | -| `clippingPlanes?` | [`ClippingPlanesState`](cognite_reveal.md#clippingplanesstate)[] | -| `models?` | [`ModelState`](cognite_reveal.md#modelstate)[] | - -#### Defined in - -[packages/api/src/utilities/ViewStateHelper.ts:19](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/src/utilities/ViewStateHelper.ts#L19) - -___ - -### WellKnownUnit - -Ƭ **WellKnownUnit**: ``"Meters"`` \| ``"Centimeters"`` \| ``"Millimeters"`` \| ``"Micrometers"`` \| ``"Kilometers"`` \| ``"Feet"`` \| ``"Inches"`` \| ``"Yards"`` \| ``"Miles"`` \| ``"Mils"`` \| ``"Microinches"`` - -Units supported by [CogniteCadModel](../classes/cognite_reveal.CogniteCadModel.md). - -#### Defined in - -[packages/cad-model/src/types.ts:10](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-model/src/types.ts#L10) - -## Variables - -### CAMERA\_MANAGER\_EVENT\_TYPE\_LIST - -• `Const` **CAMERA\_MANAGER\_EVENT\_TYPE\_LIST**: readonly [``"cameraChange"``, ``"cameraStop"``] - -List of supported event types (adapted from https://stackoverflow.com/questions/44480644/string-union-to-string-array) - -#### Defined in - -[packages/camera-manager/src/types.ts:118](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/camera-manager/src/types.ts#L118) - -___ - -### CDF\_TO\_VIEWER\_TRANSFORMATION - -• `Const` **CDF\_TO\_VIEWER\_TRANSFORMATION**: `Matrix4` = `cadFromCdfToThreeMatrix` - -The transformation matrix from CDF coordinates to ThreeJS/Reveal. -Note that this is already applied to Reveal models. - -#### Defined in - -[packages/utilities/src/constants.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/utilities/src/constants.ts#L14) - -___ - -### DefaultNodeAppearance - -• `Const` **DefaultNodeAppearance**: `Object` - -A set of default node appearances used in Reveal. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Default` | [`NodeAppearance`](cognite_reveal.md#nodeappearance) | -| `Ghosted` | [`NodeAppearance`](cognite_reveal.md#nodeappearance) | -| `Hidden` | [`NodeAppearance`](cognite_reveal.md#nodeappearance) | -| `Highlighted` | \{ `color?`: `Color` ; `outlineColor?`: [`NodeOutlineColor`](../enums/cognite_reveal.NodeOutlineColor.md) ; `prioritizedForLoadingHint?`: `number` ; `renderGhosted?`: `boolean` ; `renderInFront?`: `boolean` ; `visible?`: `boolean` } | -| `Highlighted.color?` | `Color` | -| `Highlighted.outlineColor?` | [`NodeOutlineColor`](../enums/cognite_reveal.NodeOutlineColor.md) | -| `Highlighted.prioritizedForLoadingHint?` | `number` | -| `Highlighted.renderGhosted?` | `boolean` | -| `Highlighted.renderInFront?` | `boolean` | -| `Highlighted.visible?` | `boolean` | -| `InFront` | [`NodeAppearance`](cognite_reveal.md#nodeappearance) | -| `Outlined` | [`NodeAppearance`](cognite_reveal.md#nodeappearance) | - -#### Defined in - -[packages/cad-styling/src/NodeAppearance.ts:142](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/cad-styling/src/NodeAppearance.ts#L142) - -___ - -### DefaultPointCloudAppearance - -• `Const` **DefaultPointCloudAppearance**: [`CompletePointCloudAppearance`](cognite_reveal.md#completepointcloudappearance) - -#### Defined in - -[packages/pointcloud-styling/src/PointCloudAppearance.ts:14](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/pointcloud-styling/src/PointCloudAppearance.ts#L14) - -___ - -### REVEAL\_VERSION - -• `Const` **REVEAL\_VERSION**: `string` = `process.env.VERSION` - -#### Defined in - -[packages/api/index.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/api/index.ts#L11) - -## Functions - -### registerNodeCollectionType - -▸ **registerNodeCollectionType**\<`T`\>(`nodeCollectionTypeName`, `deserializer`): `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`NodeCollection`](../classes/cognite_reveal.NodeCollection.md)\<`T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodeCollectionTypeName` | `string` | -| `deserializer` | (`descriptor`: [`SerializedNodeCollection`](cognite_reveal.md#serializednodecollection), `context`: [`NodeCollectionSerializationContext`](cognite_reveal.md#nodecollectionserializationcontext)) => `Promise`\<`T`\> | - -#### Returns - -`void` - -#### Defined in - -[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_extensions_datasource.md b/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal_extensions_datasource.md deleted file mode 100644 index e8161a734e6..00000000000 --- a/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal_extensions_datasource.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: "cognite_reveal_extensions_datasource" -title: "Module: @cognite/reveal/extensions/datasource" -sidebar_label: "@cognite/reveal/extensions/datasource" -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumerations - -- [File3dFormat](../enums/cognite_reveal_extensions_datasource.File3dFormat.md) - -## Classes - -- [CdfModelIdentifier](../classes/cognite_reveal_extensions_datasource.CdfModelIdentifier.md) - -## Interfaces - -- [BinaryFileProvider](../interfaces/cognite_reveal_extensions_datasource.BinaryFileProvider.md) -- [BlobOutputMetadata](../interfaces/cognite_reveal_extensions_datasource.BlobOutputMetadata.md) -- [DataSource](../interfaces/cognite_reveal_extensions_datasource.DataSource.md) -- [JsonFileProvider](../interfaces/cognite_reveal_extensions_datasource.JsonFileProvider.md) -- [ModelDataProvider](../interfaces/cognite_reveal_extensions_datasource.ModelDataProvider.md) -- [ModelIdentifier](../interfaces/cognite_reveal_extensions_datasource.ModelIdentifier.md) -- [ModelMetadataProvider](../interfaces/cognite_reveal_extensions_datasource.ModelMetadataProvider.md) -- [NodesApiClient](../interfaces/cognite_reveal_extensions_datasource.NodesApiClient.md) 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 deleted file mode 100644 index 99f62bba809..00000000000 --- a/documentation/versioned_docs/version-4.x/api/modules/cognite_reveal_tools.md +++ /dev/null @@ -1,475 +0,0 @@ ---- -id: "cognite_reveal_tools" -title: "Module: @cognite/reveal/tools" -sidebar_label: "@cognite/reveal/tools" -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumerations - -- [Corner](../enums/cognite_reveal_tools.Corner.md) - -## Classes - -- [AxisViewTool](../classes/cognite_reveal_tools.AxisViewTool.md) -- [Cognite3DViewerToolBase](../classes/cognite_reveal_tools.Cognite3DViewerToolBase.md) -- [DebugCameraTool](../classes/cognite_reveal_tools.DebugCameraTool.md) -- [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 - -### AbsolutePosition - -Ƭ **AbsolutePosition**: `Object` - -Absolute position in pixels. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `xAbsolute` | `number` | -| `yAbsolute` | `number` | - -#### Defined in - -[packages/tools/src/AxisView/types.ts:48](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L48) - -___ - -### AxisBoxCompassConfig - -Ƭ **AxisBoxCompassConfig**: `Object` - -Configuration of the compass. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fontColor?` | `THREE.Color` | - | -| `fontSize?` | `number` | - | -| `labelDelta?` | `number` | Offset in radians of the orientation indicator. | -| `ringLabel?` | `string` | Label of the orientation indicator. Defaults to 'N' for north. | -| `tickColor?` | `THREE.Color` | - | - -#### Defined in - -[packages/tools/src/AxisView/types.ts:80](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L80) - -___ - -### AxisBoxConfig - -Ƭ **AxisBoxConfig**: `Object` - -Configuration of [AxisViewTool](../classes/cognite_reveal_tools.AxisViewTool.md). - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `animationSpeed?` | `number` | How long the camera animation lasts when clicking a face of the orientation box. | -| `compass?` | [`AxisBoxCompassConfig`](cognite_reveal_tools.md#axisboxcompassconfig) | Configuration of the compass "base" of the tool. | -| `faces?` | \{ `xNegativeFace?`: [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) ; `xPositiveFace?`: [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) ; `yNegativeFace?`: [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) ; `yPositiveFace?`: [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) ; `zNegativeFace?`: [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) ; `zPositiveFace?`: [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) } | Configuration for each of the faces of the orientation box. Note that Reveal uses a right-handed Y up coordinate system, which might differ from the original model space. To account for this, you might want to reassign labels of the faces. | -| `faces.xNegativeFace?` | [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) | - | -| `faces.xPositiveFace?` | [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) | - | -| `faces.yNegativeFace?` | [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) | - | -| `faces.yPositiveFace?` | [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) | - | -| `faces.zNegativeFace?` | [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) | - | -| `faces.zPositiveFace?` | [`AxisBoxFaceConfig`](cognite_reveal_tools.md#axisboxfaceconfig) | - | -| `position?` | [`AbsolutePosition`](cognite_reveal_tools.md#absoluteposition) \| [`RelativePosition`](cognite_reveal_tools.md#relativeposition) | Position, either absolute or relative. | -| `size?` | `number` | Size in pixels of the axis tool. | - -#### Defined in - -[packages/tools/src/AxisView/types.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L11) - -___ - -### AxisBoxFaceConfig - -Ƭ **AxisBoxFaceConfig**: `Object` - -Configuration of each face of the orientation box. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `faceColor?` | `THREE.Color` | - | -| `fontColor?` | `THREE.Color` | - | -| `fontSize?` | `number` | - | -| `label?` | `string` | Label of the respective face, e.g. 'X' or 'Right'. | -| `outlineColor?` | `THREE.Color` | - | -| `outlineSize?` | `number` | - | - -#### Defined in - -[packages/tools/src/AxisView/types.ts:65](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/AxisView/types.ts#L65) - -___ - -### DistanceToLabelDelegate - -Ƭ **DistanceToLabelDelegate**: (`distanceInMeters`: `number`) => `string` - -#### Type declaration - -▸ (`distanceInMeters`): `string` - -Custom callback for users to change measurement label content. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `distanceInMeters` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/tools/src/Measurement/types.ts:8](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L8) - -___ - -### HtmlOverlayCreateClusterDelegate - -Ƭ **HtmlOverlayCreateClusterDelegate**: (`overlayElements`: \{ `htmlElement`: `HTMLElement` ; `userData`: `any` }[]) => `HTMLElement` - -#### Type declaration - -▸ (`overlayElements`): `HTMLElement` - -Callback that is triggered when a set of overlays are clustered together in -[HtmlOverlayTool](../classes/cognite_reveal_tools.HtmlOverlayTool.md). - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `overlayElements` | \{ `htmlElement`: `HTMLElement` ; `userData`: `any` }[] | - -##### Returns - -`HTMLElement` - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:32](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L32) - -___ - -### HtmlOverlayOptions - -Ƭ **HtmlOverlayOptions**: `Object` - -Options for an overlay added using [add](../classes/cognite_reveal_tools.HtmlOverlayTool.md#add). - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `positionUpdatedCallback?` | [`HtmlOverlayPositionUpdatedDelegate`](cognite_reveal_tools.md#htmloverlaypositionupdateddelegate) | Callback that is triggered whenever the position of the overlay is updated. Optional. | -| `userData?` | `any` | Optional user specified data that is provided to the [HtmlOverlayCreateClusterDelegate](cognite_reveal_tools.md#htmloverlaycreateclusterdelegate) and [HtmlOverlayPositionUpdatedDelegate](cognite_reveal_tools.md#htmloverlaypositionupdateddelegate). | - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:42](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L42) - -___ - -### HtmlOverlayPositionUpdatedDelegate - -Ƭ **HtmlOverlayPositionUpdatedDelegate**: (`element`: `HTMLElement`, `position2D`: `THREE.Vector2`, `position3D`: `THREE.Vector3`, `distanceToCamera`: `number`, `userData`: `any`) => `void` - -#### Type declaration - -▸ (`element`, `position2D`, `position3D`, `distanceToCamera`, `userData`): `void` - -Callback that is triggered whenever the 2D position of an overlay is updated -in [HtmlOverlayTool](../classes/cognite_reveal_tools.HtmlOverlayTool.md). - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `element` | `HTMLElement` | -| `position2D` | `THREE.Vector2` | -| `position3D` | `THREE.Vector3` | -| `distanceToCamera` | `number` | -| `userData` | `any` | - -##### Returns - -`void` - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:20](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L20) - -___ - -### HtmlOverlayToolClusteringOptions - -Ƭ **HtmlOverlayToolClusteringOptions**: `Object` - -Controls how close overlay elements are clustered together. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `createClusterElementCallback` | [`HtmlOverlayCreateClusterDelegate`](cognite_reveal_tools.md#htmloverlaycreateclusterdelegate) | Callback that is triggered when a set of overlays are clustered together to create a "composite" element as a placeholder for the clustered elements. Note that this callback will be triggered every frame for each cluster so it must be performant. | -| `mode` | ``"overlapInScreenSpace"`` | Currently only 'overlapInScreenSpace' is supported. In this mode, overlays are clustered together into a single element as defined by the [createClusterElementCallback](cognite_reveal_tools.md#createclusterelementcallback) and hidden when they overlap in screen space. The composite element is placed at the midpoint of all clustered elements. Clustered elements are faded in/out using CSS styling `transition`, `opacity` and `visibility`. | - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:57](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L57) - -___ - -### HtmlOverlayToolOptions - -Ƭ **HtmlOverlayToolOptions**: `Object` - -Options for the visualization of overlays - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `clusteringOptions?` | [`HtmlOverlayToolClusteringOptions`](cognite_reveal_tools.md#htmloverlaytoolclusteringoptions) | Options for clustering the HTML overlays | - -#### Defined in - -[packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts:82](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/HtmlOverlay/HtmlOverlayTool.ts#L82) - -___ - -### Measurement - -Ƭ **Measurement**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `distanceInMeters` | `number` | -| `endPoint` | `THREE.Vector3` | -| `measurementId` | `number` | -| `startPoint` | `THREE.Vector3` | - -#### Defined in - -[packages/tools/src/Measurement/MeasurementManager.ts:11](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/MeasurementManager.ts#L11) - -___ - -### MeasurementAddedDelegate - -Ƭ **MeasurementAddedDelegate**: (`event`: \{ `distanceInMeters`: `number` ; `endPoint`: `THREE.Vector3` ; `measurementId`: `number` ; `startPoint`: `THREE.Vector3` }) => `void` - -#### Type declaration - -▸ (`event`): `void` - -Delegate for measurement added events. - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `Object` | -| `event.distanceInMeters` | `number` | -| `event.endPoint` | `THREE.Vector3` | -| `event.measurementId` | `number` | -| `event.startPoint` | `THREE.Vector3` | - -##### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/types.ts:13](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L13) - -___ - -### MeasurementEndedDelegate - -Ƭ **MeasurementEndedDelegate**: () => `void` - -#### Type declaration - -▸ (): `void` - -Delegate for measurement ended events. - -##### Returns - -`void` - -#### Defined in - -[packages/tools/src/Measurement/types.ts:28](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L28) - -___ - -### MeasurementOptions - -Ƭ **MeasurementOptions**: `Object` - -Measurement tool option with user custom callback, line width & color. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `color?` | `THREE.Color` | Line color in 32 bit hex. | -| `distanceToLabelCallback?` | [`DistanceToLabelDelegate`](cognite_reveal_tools.md#distancetolabeldelegate) | - | -| `lineWidth?` | `number` | Line width in cm. Note that the minium drawn line will be ~2 pixels. | - -#### Defined in - -[packages/tools/src/Measurement/types.ts:33](https://github.com/cognitedata/reveal/blob/e9e26d38/viewer/packages/tools/src/Measurement/types.ts#L33) - -___ - -### MeasurementStartedDelegate - -Ƭ **MeasurementStartedDelegate**: () => `void` - -#### Type declaration - -▸ (): `void` - -Delegate for measurement started events. - -##### Returns - -`void` - -#### Defined in - -[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) - -___ - -### RelativePosition - -Ƭ **RelativePosition**: `Object` - -Relative position from a corner of the viewer -and a given padding. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `corner` | [`Corner`](../enums/cognite_reveal_tools.Corner.md) | -| `padding` | `THREE.Vector2` | - -#### Defined in - -[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) - -___ - -### TimelineDateUpdateDelegate - -Ƭ **TimelineDateUpdateDelegate**: (`event`: \{ `activeKeyframe`: [`Keyframe`](../classes/cognite_reveal_tools.Keyframe.md) \| `undefined` ; `date`: `Date` ; `endDate`: `Date` ; `startDate`: `Date` }) => `void` - -#### Type declaration - -▸ (`event`): `void` - -Delegate for Timeline Date update - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `Object` | -| `event.activeKeyframe` | [`Keyframe`](../classes/cognite_reveal_tools.Keyframe.md) \| `undefined` | -| `event.date` | `Date` | -| `event.endDate` | `Date` | -| `event.startDate` | `Date` | - -##### Returns - -`void` - -#### Defined in - -[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/api/typedoc-sidebar.cjs b/documentation/versioned_docs/version-4.x/api/typedoc-sidebar.cjs new file mode 100644 index 00000000000..94485471469 --- /dev/null +++ b/documentation/versioned_docs/version-4.x/api/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"@cognite/reveal","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"api/@cognite/reveal/enumerations/FlexibleControlsType","label":"FlexibleControlsType"},{"type":"doc","id":"api/@cognite/reveal/enumerations/FlexibleMouseActionType","label":"FlexibleMouseActionType"},{"type":"doc","id":"api/@cognite/reveal/enumerations/FlexibleWheelZoomType","label":"FlexibleWheelZoomType"},{"type":"doc","id":"api/@cognite/reveal/enumerations/NodeOutlineColor","label":"NodeOutlineColor"},{"type":"doc","id":"api/@cognite/reveal/enumerations/PointColorType","label":"PointColorType"},{"type":"doc","id":"api/@cognite/reveal/enumerations/PointShape","label":"PointShape"},{"type":"doc","id":"api/@cognite/reveal/enumerations/PointSizeType","label":"PointSizeType"},{"type":"doc","id":"api/@cognite/reveal/enumerations/WellKnownAsprsPointClassCodes","label":"WellKnownAsprsPointClassCodes"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"api/@cognite/reveal/classes/AnnotationIdPointCloudObjectCollection","label":"AnnotationIdPointCloudObjectCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/AssetNodeCollection","label":"AssetNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/BoundingBoxClipper","label":"BoundingBoxClipper"},{"type":"doc","id":"api/@cognite/reveal/classes/CameraManagerHelper","label":"CameraManagerHelper"},{"type":"doc","id":"api/@cognite/reveal/classes/CdfNodeCollectionBase","label":"CdfNodeCollectionBase"},{"type":"doc","id":"api/@cognite/reveal/classes/ClusteredAreaCollection","label":"ClusteredAreaCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/Cognite3DViewer","label":"Cognite3DViewer"},{"type":"doc","id":"api/@cognite/reveal/classes/CogniteCadModel","label":"CogniteCadModel"},{"type":"doc","id":"api/@cognite/reveal/classes/CognitePointCloudModel","label":"CognitePointCloudModel"},{"type":"doc","id":"api/@cognite/reveal/classes/CombineNodeCollectionBase","label":"CombineNodeCollectionBase"},{"type":"doc","id":"api/@cognite/reveal/classes/ComboControls","label":"ComboControls"},{"type":"doc","id":"api/@cognite/reveal/classes/CustomObject","label":"CustomObject"},{"type":"doc","id":"api/@cognite/reveal/classes/CustomObjectIntersectInput","label":"CustomObjectIntersectInput"},{"type":"doc","id":"api/@cognite/reveal/classes/DebouncedCameraStopEventTrigger","label":"DebouncedCameraStopEventTrigger"},{"type":"doc","id":"api/@cognite/reveal/classes/DefaultCameraManager","label":"DefaultCameraManager"},{"type":"doc","id":"api/@cognite/reveal/classes/FlexibleControlsOptions","label":"FlexibleControlsOptions"},{"type":"doc","id":"api/@cognite/reveal/classes/IndexSet","label":"IndexSet"},{"type":"doc","id":"api/@cognite/reveal/classes/IntersectionNodeCollection","label":"IntersectionNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/InvertedNodeCollection","label":"InvertedNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/NodeCollection","label":"NodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/NodeIdNodeCollection","label":"NodeIdNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/NumericRange","label":"NumericRange"},{"type":"doc","id":"api/@cognite/reveal/classes/Overlay3DCollection","label":"Overlay3DCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/PointCloudObjectCollection","label":"PointCloudObjectCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/PointerEvents","label":"PointerEvents"},{"type":"doc","id":"api/@cognite/reveal/classes/PointerEventsTarget","label":"PointerEventsTarget"},{"type":"doc","id":"api/@cognite/reveal/classes/PropertyFilterNodeCollection","label":"PropertyFilterNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/SinglePropertyFilterNodeCollection","label":"SinglePropertyFilterNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/StyledPointCloudObjectCollection","label":"StyledPointCloudObjectCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/TreeIndexNodeCollection","label":"TreeIndexNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/UnionNodeCollection","label":"UnionNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/classes/Vector3Pool","label":"Vector3Pool"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"api/@cognite/reveal/interfaces/AddModelOptions","label":"AddModelOptions"},{"type":"doc","id":"api/@cognite/reveal/interfaces/AreaCollection","label":"AreaCollection"},{"type":"doc","id":"api/@cognite/reveal/interfaces/CameraManager","label":"CameraManager"},{"type":"doc","id":"api/@cognite/reveal/interfaces/CdfModelNodeCollectionDataProvider","label":"CdfModelNodeCollectionDataProvider"},{"type":"doc","id":"api/@cognite/reveal/interfaces/Cognite3DViewerOptions","label":"Cognite3DViewerOptions"},{"type":"doc","id":"api/@cognite/reveal/interfaces/ICustomObject","label":"ICustomObject"},{"type":"doc","id":"api/@cognite/reveal/interfaces/IFlexibleCameraManager","label":"IFlexibleCameraManager"},{"type":"doc","id":"api/@cognite/reveal/interfaces/Image360","label":"Image360"},{"type":"doc","id":"api/@cognite/reveal/interfaces/Image360Annotation","label":"Image360Annotation"},{"type":"doc","id":"api/@cognite/reveal/interfaces/Image360Collection","label":"Image360Collection"},{"type":"doc","id":"api/@cognite/reveal/interfaces/Image360Revision","label":"Image360Revision"},{"type":"doc","id":"api/@cognite/reveal/interfaces/Image360Visualization","label":"Image360Visualization"},{"type":"doc","id":"api/@cognite/reveal/interfaces/Overlay3D","label":"Overlay3D"},{"type":"doc","id":"api/@cognite/reveal/interfaces/OverlayCollection","label":"OverlayCollection"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"api/@cognite/reveal/type-aliases/AddImage360Options","label":"AddImage360Options"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/AnyIntersection","label":"AnyIntersection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/AssetAnnotationImage360Info","label":"AssetAnnotationImage360Info"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/BeforeSceneRenderedDelegate","label":"BeforeSceneRenderedDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CadIntersection","label":"CadIntersection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CadModelBudget","label":"CadModelBudget"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CameraChangeDelegate","label":"CameraChangeDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CameraConfiguration","label":"CameraConfiguration"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CameraControlsOptions","label":"CameraControlsOptions"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CameraEventDelegate","label":"CameraEventDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CameraManagerEventType","label":"CameraManagerEventType"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CameraState","label":"CameraState"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CameraStopDelegate","label":"CameraStopDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/ClippingPlanesState","label":"ClippingPlanesState"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CogniteModel","label":"CogniteModel"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/ComboControlsEventType","label":"ComboControlsEventType"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/ComboControlsOptions","label":"ComboControlsOptions"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CompletePointCloudAppearance","label":"CompletePointCloudAppearance"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/CustomObjectIntersection","label":"CustomObjectIntersection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/DefaultOverlay3DContentType","label":"DefaultOverlay3DContentType"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/DisposedDelegate","label":"DisposedDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/EdlOptions","label":"EdlOptions"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/FlexibleControlsTypeChangeDelegate","label":"FlexibleControlsTypeChangeDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/GeometryFilter","label":"GeometryFilter"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360AnnotationAppearance","label":"Image360AnnotationAppearance"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360AnnotationAssetFilter","label":"Image360AnnotationAssetFilter"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360AnnotationAssetQueryResult","label":"Image360AnnotationAssetQueryResult"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360AnnotationFilterOptions","label":"Image360AnnotationFilterOptions"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360AnnotationIntersection","label":"Image360AnnotationIntersection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360DataModelIdentifier","label":"Image360DataModelIdentifier"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360EnteredDelegate","label":"Image360EnteredDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360ExitedDelegate","label":"Image360ExitedDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360IconStyle","label":"Image360IconStyle"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Image360WithCollection","label":"Image360WithCollection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/ImageAssetLinkAnnotationInfo","label":"ImageAssetLinkAnnotationInfo"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Intersection","label":"Intersection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/ModelState","label":"ModelState"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/NodeAppearance","label":"NodeAppearance"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/NodeCollectionSerializationContext","label":"NodeCollectionSerializationContext"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/OnLoadingCallback","label":"OnLoadingCallback"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/Overlay3DCollectionOptions","label":"Overlay3DCollectionOptions"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/OverlayInfo","label":"OverlayInfo"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/PointCloudAppearance","label":"PointCloudAppearance"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/PointCloudBudget","label":"PointCloudBudget"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/PointCloudIntersection","label":"PointCloudIntersection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/PointCloudObjectMetadata","label":"PointCloudObjectMetadata"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/PointerEventData","label":"PointerEventData"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/PointerEventDelegate","label":"PointerEventDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/PropertyFilterNodeCollectionOptions","label":"PropertyFilterNodeCollectionOptions"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/RenderParameters","label":"RenderParameters"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/ResolutionOptions","label":"ResolutionOptions"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/SceneRenderedDelegate","label":"SceneRenderedDelegate"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/SerializableNodeAppearance","label":"SerializableNodeAppearance"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/SerializedNodeCollection","label":"SerializedNodeCollection"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/SupportedModelTypes","label":"SupportedModelTypes"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/ViewerState","label":"ViewerState"},{"type":"doc","id":"api/@cognite/reveal/type-aliases/WellKnownUnit","label":"WellKnownUnit"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"api/@cognite/reveal/variables/CAMERA_MANAGER_EVENT_TYPE_LIST","label":"CAMERA_MANAGER_EVENT_TYPE_LIST"},{"type":"doc","id":"api/@cognite/reveal/variables/CDF_TO_VIEWER_TRANSFORMATION","label":"CDF_TO_VIEWER_TRANSFORMATION"},{"type":"doc","id":"api/@cognite/reveal/variables/DefaultNodeAppearance","label":"DefaultNodeAppearance"},{"type":"doc","id":"api/@cognite/reveal/variables/DefaultPointCloudAppearance","label":"DefaultPointCloudAppearance"},{"type":"doc","id":"api/@cognite/reveal/variables/REVEAL_VERSION","label":"REVEAL_VERSION"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"api/@cognite/reveal/functions/getNormalizedPixelCoordinates","label":"getNormalizedPixelCoordinates"},{"type":"doc","id":"api/@cognite/reveal/functions/getNormalizedPixelCoordinatesBySize","label":"getNormalizedPixelCoordinatesBySize"},{"type":"doc","id":"api/@cognite/reveal/functions/getWheelEventDelta","label":"getWheelEventDelta"},{"type":"doc","id":"api/@cognite/reveal/functions/isFlexibleCameraManager","label":"isFlexibleCameraManager"},{"type":"doc","id":"api/@cognite/reveal/functions/registerNodeCollectionType","label":"registerNodeCollectionType"}]}],"link":{"type":"doc","id":"api/@cognite/reveal/index"}},{"type":"category","label":"@cognite/reveal/extensions/datasource","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/enumerations/File3dFormat","label":"File3dFormat"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/classes/CdfModelIdentifier","label":"CdfModelIdentifier"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/BinaryFileProvider","label":"BinaryFileProvider"},{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/BlobOutputMetadata","label":"BlobOutputMetadata"},{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/DataSource","label":"DataSource"},{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/JsonFileProvider","label":"JsonFileProvider"},{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/ModelDataProvider","label":"ModelDataProvider"},{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/ModelIdentifier","label":"ModelIdentifier"},{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/ModelMetadataProvider","label":"ModelMetadataProvider"},{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/interfaces/NodesApiClient","label":"NodesApiClient"}]}],"link":{"type":"doc","id":"api/@cognite/reveal/extensions/datasource/index"}},{"type":"category","label":"@cognite/reveal/tools","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"api/@cognite/reveal/tools/enumerations/Corner","label":"Corner"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"api/@cognite/reveal/tools/classes/AxisGizmoOptions","label":"AxisGizmoOptions"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/AxisGizmoTool","label":"AxisGizmoTool"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/AxisViewTool","label":"AxisViewTool"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/Cognite3DViewerToolBase","label":"Cognite3DViewerToolBase"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/DebugCameraTool","label":"DebugCameraTool"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/HtmlOverlayTool","label":"HtmlOverlayTool"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/Keyframe","label":"Keyframe"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/MeasurementTool","label":"MeasurementTool"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/Overlay3DTool","label":"Overlay3DTool"},{"type":"doc","id":"api/@cognite/reveal/tools/classes/TimelineTool","label":"TimelineTool"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/AbsolutePosition","label":"AbsolutePosition"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/AxisBoxCompassConfig","label":"AxisBoxCompassConfig"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/AxisBoxConfig","label":"AxisBoxConfig"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/AxisBoxFaceConfig","label":"AxisBoxFaceConfig"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/DistanceToLabelDelegate","label":"DistanceToLabelDelegate"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/HtmlOverlayCreateClusterDelegate","label":"HtmlOverlayCreateClusterDelegate"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/HtmlOverlayOptions","label":"HtmlOverlayOptions"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/HtmlOverlayPositionUpdatedDelegate","label":"HtmlOverlayPositionUpdatedDelegate"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolClusteringOptions","label":"HtmlOverlayToolClusteringOptions"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/HtmlOverlayToolOptions","label":"HtmlOverlayToolOptions"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/Measurement","label":"Measurement"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/MeasurementAddedDelegate","label":"MeasurementAddedDelegate"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/MeasurementEndedDelegate","label":"MeasurementEndedDelegate"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/MeasurementOptions","label":"MeasurementOptions"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/MeasurementStartedDelegate","label":"MeasurementStartedDelegate"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/Overlay3DToolParameters","label":"Overlay3DToolParameters"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/OverlayCollectionOptions","label":"OverlayCollectionOptions"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/OverlayEventHandler","label":"OverlayEventHandler"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/OverlayToolEvent","label":"OverlayToolEvent"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/RelativePosition","label":"RelativePosition"},{"type":"doc","id":"api/@cognite/reveal/tools/type-aliases/TimelineDateUpdateDelegate","label":"TimelineDateUpdateDelegate"}]}],"link":{"type":"doc","id":"api/@cognite/reveal/tools/index"}}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/documentation/versioned_docs/version-4.x/api_readme.md b/documentation/versioned_docs/version-4.x/api_readme.md index d2d7a7453e1..4b7f70af17e 100644 --- a/documentation/versioned_docs/version-4.x/api_readme.md +++ b/documentation/versioned_docs/version-4.x/api_readme.md @@ -1,8 +1,8 @@ `@cognite/reveal` supports `Node16` [module resolution](https://www.typescriptlang.org/tsconfig#moduleResolution), and if enabled in the consuming application will expose three modules: -- [@cognite/reveal](/api/modules/cognite_reveal.md) is the main module and has the main entry point of Reveal, [`Cognite3DViewer`](/api/classes/cognite_reveal.Cognite3DViewer.md). CAD models are represented by [`CogniteCadModel`](/api/classes/cognite_reveal.CogniteCadModel.md) and points clouds by [`CognitePointCloudModel`](/api/classes/cognite_reveal.CognitePointCloudModel.md). -- [@congite/reveal/tools](/api/modules/cognite_reveal_tools.md) contains a set of tools, e.g. [`AxisViewTool`](/api/classes/cognite_reveal_tools.AxisViewTool.md), [`TimelineTool`](/api/classes/cognite_reveal_tools.TimelineTool.md), and [`HtmlOverlayTool`](/api/classes/cognite_reveal_tools.HtmlOverlayTool.md) that works with `Cognite3DViewer`. -- [@cognite/reveal/extensions/datasource](/api/modules/cognite_reveal_extensions_datasource.md) allows providing custom data sources for geometry and model metadata. +- [@cognite/reveal](/api/@cognite/reveal/index.md) is the main module and has the main entry point of Reveal, [`Cognite3DViewer`](/api/@cognite/reveal/classes/Cognite3DViewer.md). CAD models are represented by [`CogniteCadModel`](/api/@cognite/reveal/classes/CogniteCadModel.md) and points clouds by [`CognitePointCloudModel`](/api/@cognite/reveal/classes/CognitePointCloudModel.md). +- [@congite/reveal/tools](/api/@cognite/reveal/tools/index.md) contains a set of tools, e.g. [`AxisViewTool`](/api/@cognite/reveal/tools/classes/AxisViewTool.md), [`TimelineTool`](/api/@cognite/reveal/tools/classes/TimelineTool.md), and [`HtmlOverlayTool`](/api/@cognite/reveal/tools/classes/HtmlOverlayTool.md) that works with `Cognite3DViewer`. +- [@cognite/reveal/extensions/datasource](/api/@cognite/reveal/extensions/datasource/index.md) allows providing custom data sources for geometry and model metadata. :::note If the consuming application does not enable `Node16` module resolution, then all types must be imported from `@cognite/reveal`. -::: \ No newline at end of file +::: diff --git a/documentation/versioned_docs/version-4.x/components/LiveCodeSnippet.tsx b/documentation/versioned_docs/version-4.x/components/LiveCodeSnippet.tsx index ae5cdcc171d..5ee6010bee4 100644 --- a/documentation/versioned_docs/version-4.x/components/LiveCodeSnippet.tsx +++ b/documentation/versioned_docs/version-4.x/components/LiveCodeSnippet.tsx @@ -65,7 +65,6 @@ function transformCode(code: string): string { } if (viewer) { - resetViewerEventHandlers(viewer); if (model instanceof CogniteCadModel) { resetCogniteCadModel(model); } @@ -85,7 +84,6 @@ function onRunCode(code: string) { } export const LiveCodeSnippet = (props: LiveCodeSnippetProps) => { - let code: string = props.children; function setCode(newCode: string) { code = newCode; diff --git a/documentation/versioned_docs/version-4.x/examples/image360.mdx b/documentation/versioned_docs/version-4.x/examples/image360.mdx index fd5d595d32b..7c71fe97561 100644 --- a/documentation/versioned_docs/version-4.x/examples/image360.mdx +++ b/documentation/versioned_docs/version-4.x/examples/image360.mdx @@ -7,15 +7,15 @@ description: Using and displaying 360 images using Reveal import useBaseUrl from '@docusaurus/useBaseUrl'; 360 images is a common way to augment the 3D experience of your application. -A 360 image is a controllable panoramic image that surrounds the original point from which the shot was taken. +A 360 image is a controllable panoramic image that surrounds the original point from which the shot was taken. 360 images simulate being in the shoes of a photographer and looking around to the left, right, up and down as desired as well as zooming. The `Cognite3DViewer` entrypoint exposes the following methods related to 360 images. ```ts add360ImageSet( - datasource: 'events', - eventFilter: { [key: string]: string }, + datasource: 'events', + eventFilter: { [key: string]: string }, add360ImageOptions?: AddImage360Options ): Promise; @@ -27,17 +27,17 @@ exit360Image(): void ``` To visualize 360 images the data must have been previously ingested into [Cognite Data Fusion](https://www.cognite.com/en/product/cognite_data_fusion_industrial_dataops_platform). -More info on the ingestion process can be found [here](https://docs.cognite.com/cdf/3d/guides/360images_upload/). +More info on the ingestion process for 360 images can be found [here](https://docs.cognite.com/cdf/3d/guides/360images_upload/). Once the data is ingested, a set of 360 images can be added to the viewer with `viewer.add360ImageSet(...)`. `datasource` describes the source data type used for storing the 360 images. -At this time, the only valid `datasource` is `'events'`, but you can expect more to be added in the future. -The `eventFilter` property describes the filter that is used when fetching data from the data source. -This is a generic key-value pair and can point to any metdata that was set during ingestion. +Currently, the supported `datasource`s are `'events'` and `'datamodels'`. +The `second` argument describes the filter that is used when fetching data from the data source. +For events, this is a generic key-value pair and can point to any metdata that was set during ingestion. For datamodels, this is an identifier consisting of the Data Models `externalId` and `space` of the relevant 360 collection instance. `viewer.add360ImageSet(...)` will return a `Image360Collection` which contains each of the `image360` entities for this given set. -The definition of `Image360Collection` can be found [here.](../api/interfaces/cognite_reveal.Image360Collection) +The definition of `Image360Collection` can be found [here.](../api/@cognite/reveal/interfaces/Image360Collection) -The `AddImage360Options` is used for correcting / adding transformations to the set of 360 images. The declaration can be found [here.](../api/modules/cognite_reveal#addimage360options) +The `AddImage360Options` is used for correcting / adding transformations to the set of 360 images. The declaration can be found [here.](../api/@cognite/reveal/type-aliases/AddImage360Options) :::note The 360 images should be ingested with proper transformation data, and one should only rely on `AddImage360Options` when failing to do so or when using the same 360 images for multiple 3D models with different coordinate system. @@ -63,11 +63,11 @@ An example of entering into a 360 image can be seen here: To remove one or more 360 images you can use the `remove360Images(...)` method which will also cleanup icons and other related data to the instance. -The `Image360` declaration can be found here [here.](../api/interfaces/cognite_reveal.Image360) +The `Image360` declaration can be found here [here.](../api/@cognite/reveal/interfaces/Image360) The `transform` property from `Image360` represents the world transformation (rotation and translation) of the 360 image. 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 `image360Entered` event is also triggered when the [revision](#historical-images) of an image is changed. Subscribing to the events can look like @@ -104,4 +104,4 @@ 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 +``` diff --git a/documentation/versioned_docs/version-4.x/examples/point-to-point-measurement.mdx b/documentation/versioned_docs/version-4.x/examples/point-to-point-measurement.mdx index a8092143cbe..c25b5decfab 100644 --- a/documentation/versioned_docs/version-4.x/examples/point-to-point-measurement.mdx +++ b/documentation/versioned_docs/version-4.x/examples/point-to-point-measurement.mdx @@ -33,6 +33,8 @@ const measurementTool = new MeasurementTool(viewer); measurementTool.enterMeasurementMode(); ``` +Another way to add measurements is to call the `MeasurementTool.addMeasurement()` method. It takes the two endpoints of the measurement line as arguments. + ## Events The tool exposes events for subscribing to measurement start, end & added. In the below example, the mouse cursor is changed to a cross-hair while measuring. diff --git a/documentation/versioned_docs/version-4.x/examples/pointcloud.mdx b/documentation/versioned_docs/version-4.x/examples/pointcloud.mdx index fdd4b8cfa55..a4f6ce407a1 100644 --- a/documentation/versioned_docs/version-4.x/examples/pointcloud.mdx +++ b/documentation/versioned_docs/version-4.x/examples/pointcloud.mdx @@ -91,6 +91,21 @@ model.pointColorType = PointColorType.Depth; Other useful coloring schemes are `Rgb` (color) , `Classification` (color by point class) and `Intensity` (strength of the backscattered signal in a laser scan). +## Hide model + +Models can be temporarily hidden using `CognitePointCloudModel.visible`. +The viewer must be explicitly re-rendered after setting the visibility flag: + +```js runnable-4x +model.visible = false; +viewer.requestRedraw(); + +setTimeout(() => { + model.visible = true; + viewer.requestRedraw(); +}, 5000); +``` + ## Point cloud post processing effects ### Point blending diff --git a/documentation/versioned_docs/version-4.x/extending/camera-manager.mdx b/documentation/versioned_docs/version-4.x/extending/camera-manager.mdx index 17a554aa86e..d86f225ac35 100644 --- a/documentation/versioned_docs/version-4.x/extending/camera-manager.mdx +++ b/documentation/versioned_docs/version-4.x/extending/camera-manager.mdx @@ -17,7 +17,7 @@ In certain cases it can be useful to customize behaviour of the camera: To create a custom camera manager class, `CameraManager` interface from `@cognite/reveal` must be implemented and provided to `Cognite3DViewer` on construction using the `cameraManager`-option. You can also set camera manager -in runtime by calling `setCameraManager` method of `Cognite3DViewer` class. Interface is defined [here in the API reference](../api/interfaces/cognite_reveal.CameraManager.md). +in runtime by calling `setCameraManager` method of `Cognite3DViewer` class. Interface is defined [here in the API reference](../api/@cognite/reveal/interfaces/CameraManager.md). Main implementation specific functions are `setCameraState`, `fitCameraToBoundingBox` and `update`. Setting state shouldn't be possible when `rotation` and `target` are passed at the same time because they could conflict. @@ -160,4 +160,4 @@ the behaviour of camera controls (`OrbitControls` in this case). For calculating 3. Inside `update` method you should update `near` and `far` planes of the camera, which can be easily done using `updateCameraNearAndFar` method of `CameraManagerHelper`. -4. The functions `activate` and `deactivate` are called automatically when a new CameraManager is assigned to the Cognite3DViewer. These functions are intended to help manage enabling and disabling of input when the manager changes state. Return value of `get enabled` should reflect this state. \ No newline at end of file +4. The functions `activate` and `deactivate` are called automatically when a new CameraManager is assigned to the Cognite3DViewer. These functions are intended to help manage enabling and disabling of input when the manager changes state. Return value of `get enabled` should reflect this state. diff --git a/documentation/versioned_docs/version-4.x/migration-guide.md b/documentation/versioned_docs/version-4.x/migration-guide.md index 85646886d83..1a36e992ae7 100644 --- a/documentation/versioned_docs/version-4.x/migration-guide.md +++ b/documentation/versioned_docs/version-4.x/migration-guide.md @@ -15,7 +15,7 @@ We have however also added support for node's module `exports` such that if your "moduleResolution": "Node16", ``` -imports will still work the same way they did with Reveal 3.x. +imports will still work the same way they did with Reveal 3.x. Note that this may require a bump in typescript version. If this is not possible for you, then you need to change all imports to be `from @cognite/reveal`. @@ -34,7 +34,7 @@ const axisViewTool = new AxisViewTool(...); ## `connect-src data:` is now a required content-security-policy See [Installation](./installation.mdx#installation-for-projects-with-content-security-policy) for updated content security policies needed for Reveal. -Note that this is only relevant if you have a content-security-policy set up. +Note that this is only relevant if you have a content-security-policy set up. ## Three.js is now a peer-dependency For Reveal 4 we have changed threejs from being exported from Reveal and rather require applications that consume Reveal to import it. @@ -42,7 +42,7 @@ There are multiple reasons for this, but a major pain point has been that Reveal In addition, we also see a lot of applications ending up having multiple bundles of three.js which we are trying to alliviate. ## `Cognite3DViewer.setBackgroundColor` now has optional alpha parameter -The `setBackgroundColor` now supports settings alpha value. +The `setBackgroundColor` now supports settings alpha value. This becomes relevant when you want your 3D content to blend with your website. ## `Cognite3DModel` has been renamed to `CogniteCadModel` @@ -79,7 +79,7 @@ const style = { color: new THREE.Color(0, 1.0, 0) }; ## `CognitePointCloudModel`'s `getClasses` method now returns more data -Previously, a call to `pointCloudModel.getClasses()` (where `pointCloudModel` is an instance of `CognitePointCloudModel`) would return the available classification codes as a list of numbers. It now returns structs of type `\{ code: number, name: string }`, where `code` corresponds to the previously returned classification code, and `name` is a human-readable name of the class. +Previously, a call to `pointCloudModel.getClasses()` (where `pointCloudModel` is an instance of `CognitePointCloudModel`) would return the available classification codes as a list of numbers. It now returns structs of type `{ code: number, name: string }`, where `code` corresponds to the previously returned classification code, and `name` is a human-readable name of the class. ## Changes related to the `CameraManager` interface diff --git a/documentation/versioned_docs/version-4.x/utils/viewerUtilities.ts b/documentation/versioned_docs/version-4.x/utils/viewerUtilities.ts index 95d1d17a76e..889ef5df040 100644 --- a/documentation/versioned_docs/version-4.x/utils/viewerUtilities.ts +++ b/documentation/versioned_docs/version-4.x/utils/viewerUtilities.ts @@ -1,20 +1,8 @@ import { CogniteCadModel, - Cognite3DViewer, DefaultNodeAppearance, } from '@cognite/reveal'; -/** - * Resets all event handlers on the viewer provided. This uses - * internal functionality and actual applications needs to implement - * this to better approaches than this. - */ -export function resetViewerEventHandlers(viewer: Cognite3DViewer): void { - const eventListeners = (viewer as any)._events; - eventListeners.cameraChange.unsubscribeAll(); - eventListeners.click.unsubscribeAll(); - eventListeners.hover.unsubscribeAll(); -} /** * Resets state of model to the default state (i.e. appearance and styled sets) diff --git a/viewer/packages/tools/src/Measurement/MeasurementTool.ts b/viewer/packages/tools/src/Measurement/MeasurementTool.ts index 59fc24fd149..75fffd47f40 100644 --- a/viewer/packages/tools/src/Measurement/MeasurementTool.ts +++ b/viewer/packages/tools/src/Measurement/MeasurementTool.ts @@ -40,7 +40,7 @@ type MeasurementEvents = 'added' | 'started' | 'ended' | 'disposed'; * measurementTool.dispose(); * ``` * @example - * ```jsx runnable + * ```js * const measurementTool = new MeasurementTool(viewer, {distanceToLabelCallback: (distanceInMeters) => { * // 1 meters = 3.281 feet * const distancesInFeet = distanceInMeters * 3.281;