Class: TreeIndexNodeCollection
@cognite/reveal.TreeIndexNodeCollection
Node collection that holds a set of nodes defined by a set of tree indices.
Hierarchy
-
↳
TreeIndexNodeCollection
Constructors
constructor
• new TreeIndexNodeCollection(treeIndexSet?)
Parameters
| Name | Type |
|---|---|
treeIndexSet? | IndexSet |
Overrides
NodeCollection.constructor
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:23
• new TreeIndexNodeCollection(treeIndices?)
Parameters
| Name | Type |
|---|---|
treeIndices? | Iterable<number> |
Overrides
NodeCollection.constructor
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:24
• new TreeIndexNodeCollection(treeIndexRange?)
Parameters
| Name | Type |
|---|---|
treeIndexRange? | NumericRange |
Overrides
NodeCollection.constructor
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:25
Properties
classToken
▪ Static Readonly classToken: "TreeIndexNodeCollection"
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:18
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/TreeIndexNodeCollection.ts:99
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
| Name | Type |
|---|---|
points | Vector3[] |
Returns
void
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:85
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
| Name | Type |
|---|---|
areas | Box3[] |
Returns
void
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:73
clear
▸ clear(): void
Sets this set to hold an empty set.
Returns
void
Overrides
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:45
clearAreas
▸ clearAreas(): void
Returns
void
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:95
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/TreeIndexNodeCollection.ts:54
getIndexSet
▸ getIndexSet(): IndexSet
Returns
Overrides
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:50
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
Returns
Overrides
Defined in
packages/cad-styling/src/TreeIndexNodeCollection.ts:103
updateSet
▸ updateSet(treeIndices): void
Parameters
| Name | Type |
|---|---|
treeIndices | IndexSet |
Returns
void