Class OctreeNode

constructor

• new OctreeNode(
      bounds: BoundingBox,
      depth?: number,
      options?: OctreeOptions,
  ): OctreeNode

  Creates a new OctreeNode.

  Parameters

  • bounds: BoundingBox

    The bounds of this node.

  • depth: number = 0

    The current depth of this node.

  • options: OctreeOptions = {}

    The configuration options.

  Returns OctreeNode

bounds

children

objects

clear

• clear(): void

  Returns void

insert

• insert(obj: Collidable): boolean

  Inserts an object into the octree.

  Parameters

  • obj: Collidable

  Returns boolean

query

• query(
      frustum: Frustum,
      result: Collidable[],
      intersectedNodes?: Set<OctreeNode>,
  ): void

  Queries the octree for objects that intersect with the frustum.

  Parameters

  • frustum: Frustum
  • result: Collidable[]
  • OptionalintersectedNodes: Set<OctreeNode>

  Returns void

queryRay

• queryRay(
      ray: Ray,
      result: Collidable[],
      intersectedNodes?: Set<OctreeNode>,
  ): void

  Queries the octree for objects that intersect with a ray.

  Parameters

  • ray: Ray
  • result: Collidable[]
  • OptionalintersectedNodes: Set<OctreeNode>

  Returns void

queryVolume

• queryVolume(volume: BoundingVolume, result: Collidable[]): void

  Queries the octree for objects that intersect with a specific volume.

  Parameters

  • volume: BoundingVolume
  • result: Collidable[]

  Returns void

remove

• remove(obj: Collidable): boolean

  Removes an object from this node or its children. Collapses child nodes back to the pool if remaining descendant objects <= maxObjects.

  Parameters

  • obj: Collidable

    The object to remove.

  Returns boolean

  True if the object was found and removed.

Staticacquire

• acquire(
      boundsMin: Vector3D,
      boundsMax: Vector3D,
      depth: number,
      options: OctreeOptions,
  ): OctreeNode

  Parameters

  • boundsMin: Vector3D
  • boundsMax: Vector3D
  • depth: number
  • options: OctreeOptions

  Returns OctreeNode

Staticrelease

• release(node: OctreeNode): void

  Parameters

  • node: OctreeNode

  Returns void