Class PointOctree<T>

An octree that manages points.

Type Parameters

T

The type of the data.

Hierarchy

Octree
- PointOctree

Index

Constructors

constructor

new PointOctree<T>(min, max, bias?, maxPoints?, maxDepth?): PointOctree<T>
Constructs a new point octree.
Type Parameters
- T
Parameters
- min: Vector3
  
  The lower bounds of the tree.
- max: Vector3
  
  The upper bounds of the tree.
- bias: number = 0.0
  
  An octant boundary bias. The octree is considered "loose" with a bias greater than 0.
- maxPoints: number = 8
  
  The maximum amount of distinct points per leaf octant.
- maxDepth: number = 8
  
  The maximum tree depth level, starting at 0.
Returns PointOctree<T>
Overrides Octree.constructor
- Defined in points/PointOctree.ts:535

Properties

`Protected` root

root: Node

The root octant.

Accessors

children

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

Returns null | Node[]
Inherited from Octree.children
- Defined in core/Octree.ts:144

max

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

Returns Vector3
Inherited from Octree.max
- Defined in core/Octree.ts:138

min

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

Returns Vector3
Inherited from Octree.min
- Defined in core/Octree.ts:132

Methods

[iterator]

[iterator](): Iterator<Node, any, undefined>
Returns an iterator that traverses the octree and returns all leaf nodes.

Returns Iterator<Node, any, undefined>
An iterator.
Inherited from Octree.[iterator]
- Defined in core/Octree.ts:238

countPoints

countPoints(octant?): number
Counts the points in the given octant.
Parameters
- octant: PointOctant<T> = ...
  
  An octant. Defaults to the root octant.
Returns number
The amount of points.
- Defined in points/PointOctree.ts:588

cull

cull(region): Node[]
Recursively collects nodes that intersect with the specified region.
Parameters
- region: Box3 | Frustum
  
  A region.
Returns Node[]
The nodes.
Inherited from Octree.cull
- Defined in core/Octree.ts:169

findNearestPoint

findNearestPoint(point, maxDistance?, skipSelf?): null | PointContainer<T>
Finds the closest point to the given one.
Parameters
- point: Vector3
  
  A point.
- maxDistance: number = Number.POSITIVE_INFINITY
  
  An upper limit for the distance between the points.
- skipSelf: boolean = false
  
  Whether a point that is exactly at the given position should be skipped.
Returns null | PointContainer<T>
The nearest point, or null if there is none.
- Defined in points/PointOctree.ts:659

findNodesByLevel

findNodesByLevel(level): Node[]
Fetches all nodes of a specific depth level.
Parameters
- level: number
  
  The depth level.
Returns Node[]
The nodes.
Inherited from Octree.findNodesByLevel
- Defined in core/Octree.ts:196

findPoints

findPoints(point, radius, skipSelf?): PointContainer<T>[]
Finds points within a specific radius around a given point.
Parameters
- point: Vector3
  
  A position.
- radius: number
  
  A radius.
- skipSelf: boolean = false
  
  Whether a point that is exactly at the given position should be skipped.
Returns PointContainer<T>[]
A list of points.
- Defined in points/PointOctree.ts:683

get

get(point): null | T
Retrieves the data of the specified point.
Parameters
- point: Vector3
  
  A position.
Returns null | T
The data that belongs to the given point, or null if it doesn't exist.
- Defined in points/PointOctree.ts:630

getBias

getBias(): number
Returns the octree bias.

Returns number
The bias.
- Defined in points/PointOctree.ts:551

getCenter

getCenter(result): 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 Octree.getCenter
- Defined in core/Octree.ts:150

getDepth

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

Returns number
The depth.
Inherited from Octree.getDepth
- Defined in core/Octree.ts:183

getDimensions

getDimensions(result): 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 Octree.getDimensions
- Defined in core/Octree.ts:156

getIntersectingNodes

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

getMaxDepth

getMaxDepth(): number
Returns the maximum tree depth.

Returns number
The maximum tree depth.
- Defined in points/PointOctree.ts:575

getMaxPoints

getMaxPoints(): number
Returns the maximum amount of points per leaf octant.

Returns number
The maximum amount of points per leaf octant.
- Defined in points/PointOctree.ts:563

leaves

leaves(region?): Iterator<Node, any, undefined>
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: null | Box3 | Frustum = null
  
  A cull region.
Returns Iterator<Node, any, undefined>
An iterator.
Inherited from Octree.leaves
- Defined in core/Octree.ts:226

move

move(point, position): null | T
Moves an existing point to a new position. Has no effect if the point doesn't exist.
Parameters
- point: Vector3
  
  The point.
- position: Vector3
  
  The new position.
Returns null | T
The data of the updated point, or null if it didn't exist.
- Defined in points/PointOctree.ts:644

raycast

raycast(raycaster): RayPointIntersection<T>[]
Finds the points that intersect with the given ray.
Parameters
- raycaster: Raycaster
  
  The raycaster.
Returns RayPointIntersection<T>[]
The intersecting points.
- Defined in points/PointOctree.ts:698

remove

remove(point): null | T
Removes a point from the tree.
Parameters
- point: Vector3
  
  The point.
Returns null | T
The data entry of the removed point or null if it didn't exist.
- Defined in points/PointOctree.ts:617

set

set(point, data): boolean
Inserts a point into the octree.

If the point exists in the tree already, the data entry will be replaced.
Parameters
- point: Vector3
  
  The point.
- data: T
  
  Data that belongs to the point.
Returns boolean
Whether the operation was successful.
- Defined in points/PointOctree.ts:604

Class PointOctree<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

min: Vector3

max: Vector3

bias: number = 0.0

maxPoints: number = 8

maxDepth: number = 8

Returns PointOctree<T>

Properties

Protected root

Accessors

children

Returns null | Node[]

max

Returns Vector3

min

Returns Vector3

Methods

[iterator]

Returns Iterator<Node, any, undefined>

countPoints

Parameters

octant: PointOctant<T> = ...

Returns number

cull

Parameters

region: Box3 | Frustum

Returns Node[]

findNearestPoint

Parameters

point: Vector3

maxDistance: number = Number.POSITIVE_INFINITY

skipSelf: boolean = false

Returns null | PointContainer<T>

findNodesByLevel

Parameters

level: number

Returns Node[]

findPoints

Parameters

point: Vector3

radius: number

skipSelf: boolean = false

Returns PointContainer<T>[]

get

Parameters

point: Vector3

Returns null | T

getBias

Returns number

getCenter

Parameters

result: Vector3

Returns Vector3

getDepth

Returns number

getDimensions

Parameters

result: Vector3

Returns Vector3

getIntersectingNodes

Parameters

raycaster: Raycaster

Returns Node[]

getMaxDepth

Returns number

getMaxPoints

Returns number

`Protected` root