Skip to main content
Version: Next

Class: AssetNodeCollection

Represents a set of nodes associated with an [asset in Cognite Fusion]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. 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​

Constructors​

new AssetNodeCollection()​

new AssetNodeCollection(client, modelMetadataProvider): AssetNodeCollection

Parameters​

• client: CogniteClient

• modelMetadataProvider: CdfModelNodeCollectionDataProvider

Returns​

AssetNodeCollection

Overrides​

NodeCollection.constructor

Defined in​

packages/cad-styling/src/AssetNodeCollection.ts:36

Properties​

classToken​

readonly static classToken: "AssetNodeCollection" = '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​

NodeCollection . clear

Defined in​

packages/cad-styling/src/AssetNodeCollection.ts:139

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 (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​

AreaCollection

Overrides​

NodeCollection . getAreas

Defined in​

packages/cad-styling/src/AssetNodeCollection.ts:151

getFilter()​

getFilter(): undefined | object

Returns​

undefined | object

Defined in​

packages/cad-styling/src/AssetNodeCollection.ts:135

getIndexSet()​

getIndexSet(): IndexSet

Returns​

IndexSet

Overrides​

NodeCollection . getIndexSet

Defined in​

packages/cad-styling/src/AssetNodeCollection.ts:147

off()​

off(event, listener): void

Parameters​

• event: "changed"

• listener

Returns​

void

Inherited from​

NodeCollection . off

Defined in​

packages/cad-styling/src/NodeCollection.ts:32

on()​

on(event, listener): void

Parameters​

• event: "changed"

• listener

Returns​

void

Inherited from​

NodeCollection . on

Defined in​

packages/cad-styling/src/NodeCollection.ts:27

serialize()​

serialize(): SerializedNodeCollection

Returns​

SerializedNodeCollection

Overrides​

NodeCollection . serialize

Defined in​

packages/cad-styling/src/AssetNodeCollection.ts:155