AABB¶

C++ type: AABB

Description¶

An Axis-Aligned Bounding Box defined by a minimum and maximum Vector3 corner. All edges are parallel to the world axes, making AABB overlap tests extremely fast. AABBs are used throughout Doriax for mesh bounds queries, frustum culling, and physics broad-phase.

For rotated bounding volumes use OBB.

Properties¶

Type	Name	Langs
Vector3	minimum	C++ \| Lua
Vector3	maximum	C++ \| Lua

Static constants¶

Name	Description
`ZERO`	A valid AABB with all extents at zero

Methods¶

Type	Name	Langs
void	setExtents	C++ \| Lua
Vector3	getCenter	C++ \| Lua
Vector3	getSize	C++ \| Lua
Vector3	getHalfSize	C++ \| Lua
AABB&	merge	C++ \| Lua
AABB&	transform	C++ \| Lua
AABB	intersection	C++ \| Lua
bool	intersects	C++ \| Lua
bool	contains	C++ \| Lua
float	distance	C++ \| Lua
float	squaredDistance	C++ \| Lua
float	volume	C++ \| Lua
void	scale	C++ \| Lua
OBB	getOBB	C++ \| Lua
void	setNull / setInfinite / setFinite	C++ \| Lua
bool	isNull / isInfinite / isFinite	C++ \| Lua

Property details¶

minimum / maximum¶

Setter: void setMinimum(const Vector3& vec) / individual axis setters
Getter: const Vector3& getMinimum() const
Setter: void setMaximum(const Vector3& vec)
Getter: const Vector3& getMaximum() const

The two corner points of the box in world space.

Method details¶

setExtents¶

void setExtents(const Vector3& min, const Vector3& max)
void setExtents(float mx, float my, float mz, float Mx, float My, float Mz)

Sets both minimum and maximum in one call.

getCenter / getSize / getHalfSize¶

Vector3 getCenter() const
Vector3 getSize() const
Vector3 getHalfSize() const

getCenter() returns the midpoint. getSize() returns max - min. getHalfSize() returns half the size — convenient for physics and intersection tests.

merge¶

AABB& merge(const AABB& rhs)
AABB& merge(const Vector3& point)

Expands this AABB to also contain rhs or the given point.

transform¶

AABB& transform(const Matrix4& matrix)

Transforms the AABB by matrix. Note: an AABB after transformation is re-fitted, which may be larger than the OBB would be.

intersection¶

AABB intersection(const AABB& b2) const

Returns the AABB formed by the overlap of this box and b2. Returns a null AABB if there is no overlap.

intersects¶

bool intersects(const AABB& b2) const
bool intersects(const OBB& obb) const
bool intersects(const Plane& p) const
bool intersects(const Sphere& sp) const
bool intersects(const Vector3& v) const

Overlap tests against other volumes or a point.

C++Lua

AABB playerBounds = player.getWorldAABB();
AABB triggerZone(Vector3(-2,-1,-2), Vector3(2,1,2));
if (playerBounds.intersects(triggerZone)) {
    // player entered trigger
}

local playerBounds = player:getWorldAABB()
local triggerZone = AABB(Vector3(-2,-1,-2), Vector3(2,1,2))
if playerBounds:intersects(triggerZone) then
    -- player entered trigger
end

contains¶

bool contains(const Vector3& v) const
bool contains(const AABB& other) const

Returns true if this AABB fully contains the given point or box.

distance / squaredDistance¶

float distance(const Vector3& v) const
float squaredDistance(const Vector3& v) const

Distance from a point to the nearest surface of this box. Returns 0 if the point is inside.

volume¶

float volume() const

Returns the volume (max.x-min.x) * (max.y-min.y) * (max.z-min.z).

scale¶

void scale(const Vector3& s)

Scales the AABB from its centre by the given factor.

getOBB¶

OBB getOBB() const

Converts this AABB to an OBB with axis-aligned orientation.

null / infinite / finite¶

void setNull() / bool isNull()
void setInfinite() / bool isInfinite()
void setFinite() / bool isFinite()

An AABB can be in one of three states: null (undefined, no extent), finite (normal bounding box), or infinite (the entire space). Intersection tests respect these states.