Skip to main content
Version: Next

Class: TreeIndexNodeCollection

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:17

Node collection that holds a set of nodes defined by a set of tree indices.

Extends

Constructors

Constructor

new TreeIndexNodeCollection(treeIndexSet?): TreeIndexNodeCollection

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:23

Parameters

treeIndexSet?

IndexSet

Returns

TreeIndexNodeCollection

Overrides

NodeCollection.constructor

Constructor

new TreeIndexNodeCollection(treeIndices?): TreeIndexNodeCollection

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:24

Parameters

treeIndices?

Iterable<number, any, any>

Returns

TreeIndexNodeCollection

Overrides

NodeCollection.constructor

Constructor

new TreeIndexNodeCollection(treeIndexRange?): TreeIndexNodeCollection

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:25

Parameters

treeIndexRange?

NumericRange

Returns

TreeIndexNodeCollection

Overrides

NodeCollection.constructor

Properties

classToken

readonly static classToken: "TreeIndexNodeCollection" = 'TreeIndexNodeCollection'

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:18

Accessors

classToken

Get Signature

get classToken(): string

Defined in: packages/cad-styling/src/NodeCollection.ts:23

Returns

string

Inherited from

NodeCollection.classToken


isLoading

Get Signature

get isLoading(): boolean

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:110

Returns

boolean

Overrides

NodeCollection.isLoading

Methods

addAreaPoints()

addAreaPoints(points): void

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:96

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


addAreas()

addAreas(areas): void

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:84

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


clear()

clear(): void

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:56

Sets this set to hold an empty set.

Returns

void

Overrides

NodeCollection.clear


clearAreas()

clearAreas(): void

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:106

Returns

void


getAreas()

getAreas(): AreaCollection

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:65

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


getIndexSet()

getIndexSet(): IndexSet

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:61

Returns

IndexSet

Overrides

NodeCollection.getIndexSet


off()

off(event, listener): void

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

Parameters

event

"changed"

listener

() => void

Returns

void

Inherited from

NodeCollection.off


on()

on(event, listener): void

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

Parameters

event

"changed"

listener

() => void

Returns

void

Inherited from

NodeCollection.on


serialize()

serialize(): SerializedNodeCollection

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:114

Returns

SerializedNodeCollection

Overrides

NodeCollection.serialize


updateSet()

Call Signature

updateSet(treeIndices): void

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:37

Parameters
treeIndices

IndexSet

Returns

void

Call Signature

updateSet(treeIndices): void

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:38

Parameters
treeIndices

NumericRange

Returns

void

Call Signature

updateSet(treeIndices): void

Defined in: packages/cad-styling/src/TreeIndexNodeCollection.ts:39

Parameters
treeIndices

Iterable<number>

Returns

void