Class: AssetNodeCollection
@cognite/reveal.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
↳
AssetNodeCollection
Constructors
constructor
• new AssetNodeCollection(client, modelMetadataProvider)
Parameters
| Name | Type |
|---|---|
client | default |
modelMetadataProvider | CdfModelNodeCollectionDataProvider |
Overrides
NodeCollection.constructor
Defined in
packages/cad-styling/src/AssetNodeCollection.ts:36
Properties
classToken
▪ Static Readonly classToken: "AssetNodeCollection"
Defined in
packages/cad-styling/src/AssetNodeCollection.ts:27
Accessors
classToken
• get classToken(): string
Returns
string
Inherited from
NodeCollection.classToken
Defined in
packages/cad-styling/src/NodeCollection.ts:23
isLoading
• get isLoading(): boolean
Returns
boolean
Overrides
NodeCollection.isLoading
Defined in
packages/cad-styling/src/AssetNodeCollection.ts:43
Methods
clear
▸ clear(): void
Returns
void
Overrides
Defined in
packages/cad-styling/src/AssetNodeCollection.ts:135
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
getAreas
▸ getAreas(): AreaCollection
Returns areas surrounding the nodes in the collection. The areas are boxes in "ThreeJS coordinates". Note that not all implementations supports this.
Returns
Overrides
Defined in
packages/cad-styling/src/AssetNodeCollection.ts:147
getFilter
▸ getFilter(): undefined | { assetId?: number ; boundingBox?: Box3 }
Returns
undefined | { assetId?: number ; boundingBox?: Box3 }
Defined in
packages/cad-styling/src/AssetNodeCollection.ts:131
getIndexSet
▸ getIndexSet(): IndexSet
Returns
Overrides
Defined in
packages/cad-styling/src/AssetNodeCollection.ts:143
off
▸ off(event, listener): void
Parameters
| Name | Type |
|---|---|
event | "changed" |
listener | () => void |
Returns
void
Inherited from
Defined in
packages/cad-styling/src/NodeCollection.ts:32
on
▸ on(event, listener): void
Parameters
| Name | Type |
|---|---|
event | "changed" |
listener | () => void |
Returns
void
Inherited from
Defined in
packages/cad-styling/src/NodeCollection.ts:27
serialize
▸ serialize(): SerializedNodeCollection