BoundingBox
class BoundingBox
Represents an axis-aligned bounding box in 3D space, defined by its minimum and maximum corner points.
Summary
Public companion functions |
|
|---|---|
BoundingBox |
fromCenterAndHalfExtents(center: Vector3, halfExtents: FloatSize3d)Creates a |
BoundingBox |
fromMinMax(min: Vector3, max: Vector3)Creates a |
Public properties |
|
|---|---|
Vector3 |
The center point of the box. |
FloatSize3d |
The distance from the center to each face of the box along the axes. |
Vector3 |
A |
Vector3 |
A |
Public companion functions
fromCenterAndHalfExtents
fun fromCenterAndHalfExtents(center: Vector3, halfExtents: FloatSize3d): BoundingBox
Creates a BoundingBox from a center point and its half-extents.
| Parameters | |
|---|---|
center: Vector3 |
The center point of the box. |
halfExtents: FloatSize3d |
The distance from the center to each face of the box. Each component must be greater than or equal to zero. |
| Returns | |
|---|---|
BoundingBox |
A new |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if any component of |
fromMinMax
fun fromMinMax(min: Vector3, max: Vector3): BoundingBox
Creates a BoundingBox with the given minimum and maximum corner points.
This factory method ensures that the created bounding box is valid by checking that each component of the min point is less than or equal to the corresponding component of the max point.
| Parameters | |
|---|---|
min: Vector3 |
A |
max: Vector3 |
A |
| Returns | |
|---|---|
BoundingBox |
A new |
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if any component of |
Public functions
Public properties
halfExtents
val halfExtents: FloatSize3d
The distance from the center to each face of the box along the axes. The total width, height, and depth of the box are twice the half-extent values.
max
val max: Vector3
A Vector3 representing the maximum corner of the box (highest x, y, and z values).
min
val min: Vector3
A Vector3 representing the minimum corner of the box (lowest x, y, and z values).