Class Octree<T>

constructor

• new Octree<T>(bounds, keyDesign?): Octree<T>

• Constructs a new octree.

  Each octant can be uniquely identified by a 3D coordinate and a level. The tree depth is defined by the highest number of bits in the key design.

  If the bounds of the octree are defined directly, the cell size will depend on the bounds and the key design. Alternatively, the bounds can be calculated from a desired cell size via KeyDesign.calculateBounds.

  Type Parameters

  • T

  Parameters

  • bounds: Box3

    The bounds of the octree.
  • keyDesign: KeyDesign = ...

    The bit allotments for the octant coordinates.

  Returns Octree<T>

Readonly root

keyDesign

• get keyDesign(): KeyDesign

• The key design.

  Returns KeyDesign

max

• get max(): Vector3

• Returns Vector3

min

• get min(): Vector3

• Returns Vector3

[iterator]

• [iterator](): Iterator<OctantWrapper<T>, any, undefined>

• Returns an iterator that returns all leaf nodes.

  Returns Iterator<OctantWrapper<T>, any, undefined>

  An iterator.

calculateKeyCoordinates

• calculateKeyCoordinates(position, level, result): Vector3

• Calculates key coordinates based on a given position and level.

  Parameters

  • position: Vector3

    A position.
  • level: number

    The level.
  • result: Vector3

    A vector to store the result in.

  Returns Vector3

  The key coordinates.

clear

• clear(): void

• Removes all octants.

  Returns void

containsPoint

• containsPoint(point): boolean

• Checks if the given point lies inside this octree's boundaries.

  Parameters

  • point: Vector3

    A point.

  Returns boolean

  Whether the given point lies inside this octree.

cull

• cull(region): OctantWrapper<T>[]

• Recursively collects nodes that intersect with the specified region.

  Parameters

  • region: Box3 | Frustum

    A region.

  Returns OctantWrapper<T>[]

  The nodes.

delete

• delete(keyCoordinates, level?): void

• Removes a specific octant.

  Children and empty intermediate parent octants will be removed as well.

  Parameters

  • keyCoordinates: Vector3

    The key coordinates of the octant that should be removed.
  • level: number = 0

    The level of the octant.

  Returns void

findNodesByLevel

• findNodesByLevel(level): Node[]

• Parameters

  • level: number

  Returns Node[]

get

• get(keyCoordinates, level): undefined | null | T

• Retrieves data from a specific octant.

  Parameters

  • keyCoordinates: Vector3

    The key coordinates of the octant.
  • level: number

    The level of the octant.

  Returns undefined | null | T

  The data, or undefined if the octant doesn't exist.

getCellSize

• getCellSize(level, result): Vector3

• Returns the size of the cells in the specified grid.

  Parameters

  • level: number

    The level. Must be a positive integer.
  • result: Vector3

    A vector to store the result in.

  Returns Vector3

  The cell size.

getCenter

• getCenter(result): Vector3

• Parameters

  • result: Vector3

  Returns Vector3

getDepth

• getDepth(): number

• Returns number

getDimensions

• getDimensions(result): Vector3

• Parameters

  • result: Vector3

  Returns Vector3

getGrid

• getGrid(level): Map<number, Octant<T>>

• Returns the grid of the specified level.

  Parameters

  • level: number

    The level of the grid.

  Returns Map<number, Octant<T>>

  The requested grid.

  Throws

  If the given level is out of bounds.

getIntersectingNodes

• getIntersectingNodes(raycaster): OctantWrapper<T>[]

• Finds nodes that intersect with the given ray. The intersecting nodes are sorted by distance, closest first.

  Parameters

  • raycaster: Raycaster

    A raycaster.

  Returns OctantWrapper<T>[]

  The intersecting nodes.

getLevels

• getLevels(): number

• Returns the amount of depth levels.

  Returns number

  The levels.

getOctantByPoint

• getOctantByPoint(point, level?): undefined | Octant<T>

• Retrieves an octant of a specific level that contains the given point.

  Parameters

  • point: Vector3

    A point.
  • level: number = 0

    The level.

  Returns undefined | Octant<T>

  The octant, or undefined if it doesn't exist.

octants

• octants(level?): OctreeIterator<T>

• Returns a new octree iterator.

  The octants returned by this iterator are augmented wrappers with explicit positional information.

  Parameters

  • level: number = 0

    The depth level.

  Returns OctreeIterator<T>

  An octree iterator.

  See

  OctantWrapper

set

• set(keyCoordinates, level, data): void

• Adds data to a specific octant.

  Missing intermediate octants will be created automatically.

  Parameters

  • keyCoordinates: Vector3

    The key coordinates of the octant.
  • level: number

    The level of the octant.
  • data: null | T

    The data.

  Returns void