Class PointOctant<T>

An octant that contains points.

Type Parameters

T

The type of the data.

Hierarchy

Octant<PointData<T>>
- PointOctant

Index

Constructors

Properties

children data max min

Methods

contains distanceToCenterSquared distanceToSquared getCenter getDimensions merge redistribute split

Constructors

constructor

new PointOctant<T>(min, max): PointOctant<T>
Constructs a new point octant.
Type Parameters
- T
Parameters
- min: Vector3
  
  The lower bounds.
- max: Vector3
  
  The upper bounds.
Returns PointOctant<T>
Overrides Octant.constructor
- Defined in points/PointOctant.ts:22

Properties

children

children: null | Node[]

The children of this node.

data

data: null | PointData<T>

The data.

max

The upper bounds of the node.

min

The lower bounds of this node.

Methods

contains

contains(point, bias): boolean
Checks if the given point lies inside this octant's boundaries.

This method can also be used to check if this octant intersects a sphere by providing a radius as bias.
Parameters
- point: Vector3
  
  A point.
- bias: number
  
  A padding that extends the boundaries temporarily.
Returns boolean
Whether the given point lies inside this octant.
- Defined in points/PointOctant.ts:71

distanceToCenterSquared

distanceToCenterSquared(point): number
Calculates the squared distance from the center of this octant to the given point.
Parameters
- point: Vector3
  
  A point.
Returns number
The distance squared.
- Defined in points/PointOctant.ts:49

distanceToSquared

distanceToSquared(point): number
Calculates the squared distance from this octant to the given point.
Parameters
- point: Vector3
  
  A point.
Returns number
The distance squared.
- Defined in points/PointOctant.ts:35

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 Octant.getCenter
- Defined in core/Octant.ts:37

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 Octant.getDimensions
- Defined in core/Octant.ts:43

merge

merge(): void
Deletes all child nodes and collects their points.

Returns void
- Defined in points/PointOctant.ts:144

redistribute

redistribute(bias): void
Redistributes the points of this octant to its children.

Has no effect if there are no points or if this octant has no children.
Parameters
- bias: number
  
  A proximity threshold.
Returns void
- Defined in points/PointOctant.ts:95

split

split(): void
Splits this octant into eight smaller ones.

Returns void
Inherited from Octant.split
- Defined in core/Octant.ts:53

Generated using TypeDoc