kite3d/io.github.yuroyami.kite3d.math/Box3

Box3

class Box3(val min: Vector3 = Vector3(Double.POSITIVE_INFINITY, Double.POSITIVE_INFINITY, Double.POSITIVE_INFINITY), val max: Vector3 = Vector3(Double.NEGATIVE_INFINITY, Double.NEGATIVE_INFINITY, Double.NEGATIVE_INFINITY))

An axis-aligned bounding box (AABB) in 3D space.

The box is mutable and not thread-safe. Use each instance from one thread only. Most methods change this and return it for chaining.

The constructor stores the given vectors by reference (it does not copy them). Passing the same vector as both bounds, or sharing a vector with another object, means later mutations are visible through every alias. Use set or clone when you need independent storage.

There is no setFromObject or expandByObject, because Kite3D has no scene objects. Pass the object's world-space vertices to setFromPoints or setFromBufferAttribute instead.

Constructors

constructor(min: Vector3 = Vector3(Double.POSITIVE_INFINITY, Double.POSITIVE_INFINITY, Double.POSITIVE_INFINITY), max: Vector3 = Vector3(Double.NEGATIVE_INFINITY, Double.NEGATIVE_INFINITY, Double.NEGATIVE_INFINITY))

Properties

val max: Vector3

The upper (max) boundary of the box.

val min: Vector3

The lower (min) boundary of the box.

Functions

fun applyMatrix4(matrix: Matrix4): Box3

Transforms this box by the 4x4 matrix matrix. The transform of an empty box is an empty box.

fun clampPoint(point: Vector3, target: Vector3): Vector3

Writes point clamped into this box's bounds into target.

fun clone(): Box3

Returns a new box with copied bounds (independent storage).

fun containsBox(box: Box3): Boolean

Returns true if this box fully contains box (an identical box counts as contained).

fun containsPoint(point: Vector3): Boolean

Returns true if point lies within or on the boundary of this box.

fun copy(box: Box3): Box3

Copies the bounds of box into this instance.

distanceToPoint

fun distanceToPoint(point: Vector3): Double

Returns the Euclidean distance from point to the nearest edge of this box (0 if inside). An empty box yields +Infinity.

open operator override fun equals(other: Any?): Boolean

Structural equality: true when other is a Box3 with equal bounds.

fun expandByPoint(point: Vector3): Box3

Expands this box to include point.

fun expandByScalar(scalar: Double): Box3

Expands each dimension by scalar. A negative scalar contracts the box and can invert it (making it isEmpty).

fun expandByVector(vector: Vector3): Box3

Expands this box equilaterally by vector (x on both horizontal sides, y on both vertical sides, z on both depth sides).

fun fromJSON(json: DoubleArray): Box3

Sets this box's bounds from json laid out as [minX, minY, minZ, maxX, maxY, maxZ].

getBoundingSphere

fun getBoundingSphere(target: Sphere): Sphere

Writes a bounding sphere that encloses this box into target (an empty sphere if this box is empty).

fun getCenter(target: Vector3): Vector3

Writes the center of this box into target (the zero vector if empty).

fun getParameter(point: Vector3, target: Vector3): Vector3

Writes point as a proportion of this box's width, height and depth into target.

fun getSize(target: Vector3): Vector3

Writes the dimensions (width/height/depth) of this box into target (the zero vector if empty).

open override fun hashCode(): Int

fun intersect(box: Box3): Box3

Intersects this box with box (keeps the overlapping region), making this box empty if there is no overlap.

fun intersectsBox(box: Box3): Boolean

Returns true if box intersects this box (touching edges count).

intersectsPlane

fun intersectsPlane(plane: Plane): Boolean

Returns true if plane intersects this box.

intersectsSphere

fun intersectsSphere(sphere: Sphere): Boolean

Returns true if sphere intersects this box.

intersectsTriangle

fun intersectsTriangle(triangle: Triangle): Boolean

Returns true if triangle intersects this box.

fun isEmpty(): Boolean

Returns true if this box encloses no volume. A box with equal lower and upper bounds is not empty. It still contains the single shared point.

fun makeEmpty(): Box3

Makes this box empty (encloses zero space): min = +infinity, max = -infinity.

fun set(min: Vector3, max: Vector3): Box3

Copies the values of min and max into this box's bounds.

fun setFromArray(array: DoubleArray): Box3

Sets this box to enclose the positions packed in array as x, y, z triples. The size of array must be a multiple of 3.

setFromBufferAttribute

fun setFromBufferAttribute(attribute: AttributeLike, count: Int): Box3

Sets this box to enclose the first count positions in attribute. AttributeLike has no size, so you pass count yourself.

setFromCenterAndSize

fun setFromCenterAndSize(center: Vector3, size: Vector3): Box3

Centers this box on center and sets its width, height and depth to size.

fun setFromPoints(points: Iterable<Vector3>): Box3

Sets this box to enclose all the given points. An empty sequence makes the box empty.

fun toJSON(): DoubleArray

Returns this box as [minX, minY, minZ, maxX, maxY, maxZ]. three.js returns an object with min and max arrays instead.

open override fun toString(): String

fun translate(offset: Vector3): Box3

Translates this box by offset, moving both bounds.

fun union(box: Box3): Box3

Unions this box with box (grows to enclose both).