Skip to main content
Version: Next

Class: TreeIndexNodeCollection

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

Extends​

Constructors​

new TreeIndexNodeCollection()​

new TreeIndexNodeCollection(treeIndexSet?): TreeIndexNodeCollection

Parameters​

• treeIndexSet?: IndexSet

Returns​

TreeIndexNodeCollection

Overrides​

NodeCollection.constructor

Defined in​

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

new TreeIndexNodeCollection()​

new TreeIndexNodeCollection(treeIndices?): TreeIndexNodeCollection

Parameters​

• treeIndices?: Iterable<number, any, any>

Returns​

TreeIndexNodeCollection

Overrides​

NodeCollection.constructor

Defined in​

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

new TreeIndexNodeCollection()​

new TreeIndexNodeCollection(treeIndexRange?): TreeIndexNodeCollection

Parameters​

• treeIndexRange?: NumericRange

Returns​

TreeIndexNodeCollection

Overrides​

NodeCollection.constructor

Defined in​

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

Properties​

classToken​

readonly static classToken: "TreeIndexNodeCollection" = 'TreeIndexNodeCollection'

Defined in​

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

Accessors​

classToken​

Get Signature​

get classToken(): string

Returns​

string

Inherited from​

NodeCollection.classToken

Defined in​

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

isLoading​

Get Signature​

get isLoading(): boolean

Returns​

boolean

Overrides​

NodeCollection.isLoading

Defined in​

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

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

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

clear()​

clear(): void

Sets this set to hold an empty set.

Returns​

void

Overrides​

NodeCollection.clear

Defined in​

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

clearAreas()​

clearAreas(): void

Returns​

void

Defined in​

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

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/TreeIndexNodeCollection.ts:65

getIndexSet()​

getIndexSet(): IndexSet

Returns​

IndexSet

Overrides​

NodeCollection.getIndexSet

Defined in​

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

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/TreeIndexNodeCollection.ts:114

updateSet()​

updateSet(treeIndices)​

updateSet(treeIndices): void

Parameters​

• treeIndices: IndexSet

Returns​

void

Defined in​

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

updateSet(treeIndices)​

updateSet(treeIndices): void

Parameters​

• treeIndices: NumericRange

Returns​

void

Defined in​

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

updateSet(treeIndices)​

updateSet(treeIndices): void

Parameters​

• treeIndices: Iterable<number, any, any>

Returns​

void

Defined in​

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