mal_math::TBox< T > Struct Template Reference

A templated bounding box structure in 3D. More...

#include "box.hpp"

Collaboration diagram for mal_math::TBox< T >:

Public Types
using	vector3 = vec<3, T>
	Type alias for 3D vectors.

Public Member Functions
constexpr vector3	size () const
	Returns the dimensions of the box.
constexpr vector3	center () const
	Returns the center point of the box.
constexpr T	radius () const
	Returns the radius of a sphere that tightly encloses the box.
void	reset ()
	Resets the box to its default state.
template<typename U >
void	expand (const TBox< U > &other)
	Expands the box to include another box.
template<AnyVec U> requires (U::size == 3)
void	expand (const U &point)
	Expands the box to include a point.
bool	contains (const vector3 &P) const
	Checks if the box contains a given point.
bool	Intersect (Ray const &ray, T &nearest_t) const
	Checks if a ray intersects with the box and updates the nearest intersection distance.
bool	Intersect (Ray const &ray, Intersection &nearest) const
	Checks if a ray intersects with the box and updates the nearest intersection point.

Static Public Member Functions
static constexpr TBox	empty ()
	Returns an empty box.
static constexpr TBox	unit ()
	Returns a unit box.

Public Attributes
vector3	min
	The minimum point of the box in 3D space.
vector3	max
	The maximum point of the box in 3D space.

Static Public Attributes
static constexpr T	Inf = std::numeric_limits<T>::infinity()
	Infinity value for the primitive type used to define the box coordinates.

Detailed Description

template<Primitive T>
struct mal_math::TBox< T >

A templated bounding box structure in 3D.

TBox is a structure that encapsulates a box defined by a minimum and maximum point in 3D space.

Template Parameters

T	The primitive type used to define the box coordinates (e.g., float, double).

Definition at line 19 of file box.hpp.

Member Typedef Documentation

vector3

template<Primitive T>

using mal_math::TBox< T >::vector3 = vec<3, T>

Type alias for 3D vectors.

Definition at line 21 of file box.hpp.

Member Function Documentation

center()

template<Primitive T>

vector3 mal_math::TBox< T >::center ( ) const

inlineconstexpr

Returns the center point of the box.

Definition at line 44 of file box.hpp.

contains()

template<Primitive T>

bool mal_math::TBox< T >::contains ( const vector3 & P ) const

inline

Checks if the box contains a given point.

Parameters

P	A 3D point.

Returns

true If the box contains the point.

false Otherwise.

Definition at line 89 of file box.hpp.

empty()

template<Primitive T>

static constexpr TBox mal_math::TBox< T >::empty ( )

inlinestaticconstexpr

Returns an empty box.

Returns

TBox An empty box with its minimum point set to positive infinity and its maximum point set to negative infinity.

Definition at line 34 of file box.hpp.

expand() [1/2]

template<Primitive T>

template<typename U >

void mal_math::TBox< T >::expand ( const TBox< U > & other )

inline

Expands the box to include another box.

Template Parameters

U	Type of the box to be used for expansion.

Parameters

other

Another bounding box.

Definition at line 64 of file box.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

expand() [2/2]

template<Primitive T>

template<AnyVec U>
requires (U::size == 3)

void mal_math::TBox< T >::expand ( const U & point )

inline

Expands the box to include a point.

Template Parameters

U	Type of the point to be used for expansion.

Parameters

point

A 3D point.

Definition at line 76 of file box.hpp.

Here is the call graph for this function:

Intersect() [1/2]

template<Primitive T>

bool mal_math::TBox< T >::Intersect ( Ray const & ray, Intersection & nearest ) const

inline

Checks if a ray intersects with the box and updates the nearest intersection point.

Parameters

	ray	The ray to be checked for intersection.
[out]	nearest	The nearest intersection point is stored here if an intersection occurs.

Returns

true If the ray intersects with the box.

false Otherwise.

Definition at line 155 of file box.hpp.

Here is the call graph for this function:

Intersect() [2/2]

template<Primitive T>

bool mal_math::TBox< T >::Intersect ( Ray const & ray, T & nearest_t ) const

inline

Checks if a ray intersects with the box and updates the nearest intersection distance.

Parameters

	ray	The ray to be checked for intersection.
[out]	nearest_t	The nearest intersection distance is stored here if an intersection occurs.

Returns

true If the ray intersects with the box.

false Otherwise.

Definition at line 105 of file box.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

radius()

template<Primitive T>

T mal_math::TBox< T >::radius ( ) const

inlineconstexpr

Returns the radius of a sphere that tightly encloses the box.

Definition at line 45 of file box.hpp.

Here is the call graph for this function:

reset()

template<Primitive T>

void mal_math::TBox< T >::reset ( )

inline

Resets the box to its default state.

Definition at line 50 of file box.hpp.

size()

template<Primitive T>

vector3 mal_math::TBox< T >::size ( ) const

inlineconstexpr

Returns the dimensions of the box.

Definition at line 43 of file box.hpp.

Here is the caller graph for this function:

unit()

template<Primitive T>

static constexpr TBox mal_math::TBox< T >::unit ( )

inlinestaticconstexpr

Returns a unit box.

Returns

TBox A box that spans from [-1, -1, -1] to [1, 1, 1].

Definition at line 41 of file box.hpp.

Member Data Documentation

Inf

template<Primitive T>

T mal_math::TBox< T >::Inf = std::numeric_limits<T>::infinity()

staticconstexpr

Infinity value for the primitive type used to define the box coordinates.

Definition at line 27 of file box.hpp.

max

template<Primitive T>

vector3 mal_math::TBox< T >::max

The maximum point of the box in 3D space.

Definition at line 24 of file box.hpp.

min

template<Primitive T>

vector3 mal_math::TBox< T >::min

The minimum point of the box in 3D space.

Definition at line 23 of file box.hpp.

---

The documentation for this struct was generated from the following file:

• include/math/box.hpp