Class Octree<T>

A pointer-based octree that subdivides space for fast spatial searches.

Type Parameters

T extends Node = Node
The type of the octants.

Hierarchy (View Summary)

Octree
- PointOctree

Implements

Tree<T>
Iterable<T>

Index

Constructors

Properties

Accessors

children max min

Methods

[iterator] cull findNodesByLevel getCenter getDepth getDimensions getIntersectingNodes leaves

Constructors

constructor

new Octree<T extends Node = Node>(root: T): Octree<T>
Constructs a new octree.
Type Parameters
- T extends Node = Node
  The type of the octants.
Parameters
- root: T
  The root node.
Returns Octree<T>
- Defined in core/Octree.ts:129

Properties

`Protected`root

root: T

The root octant.

Accessors

children

get children(): T[] | null
The children of this node.

Returns T[] | null
Implementation of Tree.children
- Defined in core/Octree.ts:147

max

get max(): Vector3
The upper bounds of the node.

Returns Vector3
Implementation of Tree.max
- Defined in core/Octree.ts:141

min

get min(): Vector3
The lower bounds of this node.

Returns Vector3
Implementation of Tree.min
- Defined in core/Octree.ts:135

Methods

[iterator]

"[iterator]"(): Iterator<T>
Returns an iterator that traverses the octree and returns all leaf nodes.

Returns Iterator<T>
An iterator.
Implementation of Iterable.[iterator]
- Defined in core/Octree.ts:241

cull

cull(region: BoxIntersector): T[]
Recursively collects nodes that intersect with the specified region.
Parameters
- region: BoxIntersector
  A region.
Returns T[]
The nodes.
- Defined in core/Octree.ts:172

findNodesByLevel

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

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.
Implementation of Tree.getCenter
- Defined in core/Octree.ts:153

getDepth

getDepth(): number
Calculates the current depth of this octree.

Returns number
The depth.
Implementation of Tree.getDepth
- Defined in core/Octree.ts:186

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.
Implementation of Tree.getDimensions
- Defined in core/Octree.ts:159

getIntersectingNodes

getIntersectingNodes(raycaster: Raycaster): T[]
Finds nodes that intersect with the given ray. The intersecting nodes are sorted by distance, closest first.
Parameters
- raycaster: Raycaster
  A raycaster.
Returns T[]
The intersecting nodes.
- Defined in core/Octree.ts:214

leaves

leaves(region?: BoxIntersector | null): OctreeIterator<T>
Returns an iterator that traverses the octree and returns leaf nodes.

When a cull region is provided, the iterator will only return leaves that intersect with that region.
Parameters
- region: BoxIntersector | null = null
  A cull region.
Returns OctreeIterator<T>
An iterator.
- Defined in core/Octree.ts:229