Interface Tree<T>

A tree data structure.

interface Tree<T extends Node = Node> {
    children?: Node[] | null;
    max: Vector3;
    min: Vector3;
    findNodesByLevel(level: number): T[];
    getCenter(result: Vector3): Vector3;
    getDepth(): number;
    getDimensions(result: Vector3): Vector3;
}

Type Parameters

T extends Node = Node

Hierarchy (View Summary)

Node
- Tree

Implemented by

Octree

Index

Properties

children? max min

Methods

findNodesByLevel getCenter getDepth getDimensions

Properties

`Optional`children

children?: Node[] | null

The children of this node.

max

The upper bounds of the node.

min

The lower bounds of this node.

Methods

findNodesByLevel

findNodesByLevel(level: number): T[]
Fetches all nodes of a specific depth level.
Parameters
- level: number
  The depth level.
Returns T[]
The nodes.
- Defined in core/Tree.ts:24

getCenter

getCenter(result: Vector3): Vector3
Calculates the center of this node.
Parameters
- result: Vector3
  A vector to store the result in.
Returns Vector3
A vector that describes the center of this node.
Inherited from Node.getCenter
- Defined in core/Node.ts:34

getDepth

getDepth(): number
Calculates the depth of this tree.

Returns number
The depth.
- Defined in core/Tree.ts:15

getDimensions

getDimensions(result: Vector3): Vector3
Calculates the size of this node.
Parameters
- result: Vector3
  A vector to store the result in.
Returns Vector3
A vector that describes the size of this node.
Inherited from Node.getDimensions
- Defined in core/Node.ts:43