Class BoundingBox

constructor

• new BoundingBox(center?: Vec3, halfExtents?: Vec3): BoundingBox

  Create a new BoundingBox instance. The bounding box is axis-aligned.

  Parameters

  • Optionalcenter: Vec3

    Center of box. The constructor takes a reference of this parameter. Defaults to (0, 0, 0).

  • OptionalhalfExtents: Vec3

    Half the distance across the box in each axis. The constructor takes a reference of this parameter. Defaults to (0.5, 0.5, 0.5).

  Returns BoundingBox

Readonlycenter

ReadonlyhalfExtents

add

• add(other: BoundingBox): void

  Combines two bounding boxes into one, enclosing both.

  Parameters

  • other: BoundingBox

    Bounding box to add.

  Returns void

clone

• clone(): BoundingBox

  Returns a clone of the AABB.

  Returns BoundingBox

  A duplicate AABB.

closestPoint

• closestPoint(point: Vec3, result?: Vec3): Vec3

  Return the point on the AABB closest to a given point. If the point is inside the AABB, the point itself is returned.

  Parameters

  • point: Vec3

    Point to find the closest point to.

  • Optionalresult: Vec3 = ...

    The vector to store the result in. If not provided, a new Vec3 is created and returned.

  Returns Vec3

  The closest point on the AABB.

  Example

  const box = new BoundingBox(new Vec3(0, 0, 0), new Vec3(1, 1, 1));
  const point = new Vec3(2, 0, 0);
  const closest = box.closestPoint(point); // Returns Vec3(1, 0, 0)
  Copy

  Example

  // Reuse a result vector to avoid allocations in hot paths
  const result = new Vec3();
  box.closestPoint(point, result);
  Copy

compute

• compute(
      vertices: number[] | Float32Array<ArrayBufferLike>,
      numVerts?: number,
  ): void

  Compute the size of the AABB to encapsulate all specified vertices.

  Parameters

  • vertices: number[] | Float32Array<ArrayBufferLike>

    The vertices used to compute the new size for the AABB.

  • OptionalnumVerts: number

    Number of vertices to use from the beginning of vertices array. All vertices are used if not specified.

  Returns void

containsPoint

• containsPoint(point: Vec3): boolean

  Test if a point is inside a AABB.

  Parameters

  • point: Vec3

    Point to test.

  Returns boolean

  True if the point is inside the AABB and false otherwise.

copy

• copy(src: BoundingBox): void

  Copies the contents of a source AABB.

  Parameters

  • src: BoundingBox

    The AABB to copy from.

  Returns void

getMax

• getMax(): Vec3

  Return the maximum corner of the AABB.

  Returns Vec3

  Maximum corner.

getMin

• getMin(): Vec3

  Return the minimum corner of the AABB.

  Returns Vec3

  Minimum corner.

intersects

• intersects(other: BoundingBox): boolean

  Test whether two axis-aligned bounding boxes intersect.

  Parameters

  • other: BoundingBox

    Bounding box to test against.

  Returns boolean

  True if there is an intersection.

intersectsBoundingSphere

• intersectsBoundingSphere(sphere: BoundingSphere): boolean

  Test if a Bounding Sphere is overlapping, enveloping, or inside this AABB.

  Parameters

  • sphere: BoundingSphere

    Bounding Sphere to test.

  Returns boolean

  True if the Bounding Sphere is overlapping, enveloping, or inside the AABB and false otherwise.

intersectsRay

• intersectsRay(ray: Ray, point?: Vec3): boolean

  Test if a ray intersects with the AABB.

  Parameters

  • ray: Ray

    Ray to test against (direction must be normalized).

  • Optionalpoint: Vec3

    If there is an intersection, the intersection point will be copied into here.

  Returns boolean

  True if there is an intersection.

setFromTransformedAabb

• setFromTransformedAabb(aabb: BoundingBox, m: Mat4, ignoreScale?: boolean): void

  Set an AABB to enclose the specified AABB if it were to be transformed by the specified 4x4 matrix.

  Parameters

  • aabb: BoundingBox

    Box to transform and enclose.

  • m: Mat4

    Transformation matrix to apply to source AABB.

  • ignoreScale: boolean = false

    If true is specified, a scale from the matrix is ignored. Defaults to false.

  Returns void

setMinMax

• setMinMax(min: Vec3, max: Vec3): void

  Sets the minimum and maximum corner of the AABB. Using this function is faster than assigning min and max separately.

  Parameters

  • min: Vec3

    The minimum corner of the AABB.

  • max: Vec3

    The maximum corner of the AABB.

  Returns void

StaticcomputeMinMax

• computeMinMax(
      vertices: number[] | Float32Array<ArrayBufferLike>,
      min: Vec3,
      max: Vec3,
      numVerts?: number,
  ): void

  Compute the min and max bounding values to encapsulate all specified vertices.

  Parameters

  • vertices: number[] | Float32Array<ArrayBufferLike>

    The vertices used to compute the new size for the AABB.

  • min: Vec3

    Stored computed min value.

  • max: Vec3

    Stored computed max value.

  • OptionalnumVerts: number = ...

    Number of vertices to use from the beginning of vertices array. All vertices are used if not specified.

  Returns void