Class BoxTree<TObject>

constructor

• new BoxTree<TObject extends BoxTreeObject = BoxTreeObject>(
      maxNodes?: number,
  ): BoxTree<TObject>

  Type Parameters

  • TObject extends BoxTreeObject = BoxTreeObject

  Parameters

  • maxNodes: number = 1e6

  Returns BoxTree<TObject>

Readonlybuffer

Readonlyf32

Readonlyi32

ReadonlyisBoxTree

size

• get size(): number

  Returns number

addItem

• addItem(item: TObject): void

  Parameters

  • item: TObject

  Returns void

countNodes

• countNodes(options?: { leavesOnly?: boolean; maxDepth?: number }): number

  Parameters

  • options: { leavesOnly?: boolean; maxDepth?: number } = {}

  Returns number

createSnapshot

• createSnapshot<TIdentifier extends string | number>(
      getIdentifier: (object: TObject) => TIdentifier,
  ): BoxTreeSnapshot<TIdentifier>

  Copies the allocated part into a dedicated shared buffer and resolves leaf objects to stable identifiers. Mutating the returned buffer cannot mutate the live scene tree.

  Type Parameters

  • TIdentifier extends string | number

  Parameters

  • getIdentifier: (object: TObject) => TIdentifier

  Returns BoxTreeSnapshot<TIdentifier>

getBoundingBox

• getBoundingBox(target: Box3): Box3

  Parameters

  • target: Box3

  Returns Box3

hasItem

• hasItem(item: TObject): boolean

  Parameters

  • item: TObject

  Returns boolean

intersectPoint

• intersectPoint(
      point: Vector3,
      boxExpansion?: number,
  ): BoxTreeIntersection<TObject>[]

  Parameters

  • point: Vector3
  • boxExpansion: number = 0

  Returns BoxTreeIntersection<TObject>[]

raycast

• raycast(ray: Ray, boxExpansion?: number): BoxTreeIntersection<TObject>[]

  Parameters

  • ray: Ray
  • boxExpansion: number = 0

  Returns BoxTreeIntersection<TObject>[]

readNode

• readNode(index: number, target: BoxTreeNode): BoxTreeNode

  Read a single node by slot index. Thin wrapper around the standalone readNodeFromBuffer.

  Parameters

  • index: number
  • target: BoxTreeNode

  Returns BoxTreeNode

removeItem

• removeItem(item: TObject): void

  Parameters

  • item: TObject

  Returns void

reset

• reset(): void

  Returns void

traverse

• traverse(
      callback: (node: BoxTreeNode, index: number, depth: number) => void,
      options?: { leavesOnly?: boolean; maxDepth?: number },
  ): void

  Parameters

  • callback: (node: BoxTreeNode, index: number, depth: number) => void
  • options: { leavesOnly?: boolean; maxDepth?: number } = {}

  Returns void

updateItem

• updateItem(item: TObject): void

  Parameters

  • item: TObject

  Returns void

writeNode

• writeNode(index: number, node: BoxTreeNode): void

  Write a node back into the buffer at the given slot index. Thin wrapper around the standalone writeNodeToBuffer.

  Parameters

  • index: number
  • node: BoxTreeNode

  Returns void