Skip to main content
Version: 3.x

Class: AssetNodeCollection

@cognite/reveal.AssetNodeCollection

Represents a set of nodes associated with an asset in Cognite Fusion linked to the 3D model using asset mappings. 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​

Constructors​

constructor​

• new AssetNodeCollection(client, modelMetadataProvider)

Parameters​

NameType
clientdefault
modelMetadataProviderCdfModelNodeCollectionDataProvider

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​

NodeCollection.clear

Defined in​

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


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​

NameTypeDescription
filterObject
filter.assetId?numberID of a single asset (optional)
filter.boundingBox?Box3When 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:135


getFilter​

▸ getFilter(): Object

Returns​

Object

NameType
assetId?number
boundingBox?Box3

Defined in​

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


getIndexSet​

▸ getIndexSet(): IndexSet

Returns​

IndexSet

Overrides​

NodeCollection.getIndexSet

Defined in​

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


off​

▸ off(event, listener): void

Parameters​

NameType
event"changed"
listener() => void

Returns​

void

Inherited from​

NodeCollection.off

Defined in​

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


on​

▸ on(event, listener): void

Parameters​

NameType
event"changed"
listener() => void

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:139