irr::core::aabbox3d< T > Class Template Reference

Axis aligned bounding box in 3d dimensional space. More...

#include <aabbox3d.h>

Public Member Functions
	aabbox3d ()
	Default Constructor. More...
	aabbox3d (const vector3d< T > &min, const vector3d< T > &max)
	Constructor with min edge and max edge. More...
	aabbox3d (const vector3d< T > &init)
	Constructor with only one point. More...
	aabbox3d (T minx, T miny, T minz, T maxx, T maxy, T maxz)
	Constructor with min edge and max edge as single values, not vectors. More...
bool	operator== (const aabbox3d< T > &other) const
	Equality operator. More...
bool	operator!= (const aabbox3d< T > &other) const
	Inequality operator. More...
void	reset (T x, T y, T z)
	Resets the bounding box to a one-point box. More...
void	reset (const aabbox3d< T > &initValue)
	Resets the bounding box. More...
void	reset (const vector3d< T > &initValue)
	Resets the bounding box to a one-point box. More...
void	addInternalPoint (const vector3d< T > &p)
	Adds a point to the bounding box. More...
void	addInternalBox (const aabbox3d< T > &b)
	Adds another bounding box. More...
void	addInternalPoint (T x, T y, T z)
	Adds a point to the bounding box. More...
vector3d< T >	getCenter () const
	Get center of the bounding box. More...
vector3d< T >	getExtent () const
	Get extent of the box (maximal distance of two points in the box) More...
T	getRadius () const
	Get radius of the bounding sphere. More...
bool	isEmpty () const
	Check if the box is empty. More...
T	getVolume () const
	Get the volume enclosed by the box in cubed units. More...
T	getArea () const
	Get the surface area of the box in squared units. More...
void	getEdges (vector3d< T > *edges) const
	Stores all 8 edges of the box into an array. More...
void	repair ()
	Repairs the box. More...
bool	isValid () const
aabbox3d< T >	getInterpolated (const aabbox3d< T > &other, f32 d) const
	Calculates a new interpolated bounding box. More...
bool	isPointInside (const vector3d< T > &p) const
	Determines if a point is within this box. More...
bool	isPointTotalInside (const vector3d< T > &p) const
	Determines if a point is within this box and not its borders. More...
bool	isFullInside (const aabbox3d< T > &other) const
	Check if this box is completely inside the 'other' box. More...
aabbox3d< T >	intersect (const aabbox3d< T > &other) const
	Returns the intersection of this box with another, if possible. More...
bool	intersectsWithBox (const aabbox3d< T > &other) const
	Determines if the axis-aligned box intersects with another axis-aligned box. More...
bool	intersectsWithLine (const line3d< T > &line) const
	Tests if the box intersects with a line. More...
bool	intersectsWithLine (const vector3d< T > &linemiddle, const vector3d< T > &linevect, T halflength) const
	Tests if the box intersects with a line. More...
EIntersectionRelation3D	classifyPlaneRelation (const plane3d< T > &plane) const
	Classifies a relation with a plane. More...

Public Attributes
vector3d< T >	MinEdge
	The near edge. More...
vector3d< T >	MaxEdge
	The far edge. More...

Detailed Description

template<class T>
class irr::core::aabbox3d< T >

Axis aligned bounding box in 3d dimensional space.

Has some useful methods used with occlusion culling or clipping.

Definition at line 21 of file aabbox3d.h.

Constructor & Destructor Documentation

aabbox3d() [1/4]

template<class T>

irr::core::aabbox3d< T >::aabbox3d ( )

inline

Default Constructor.

Definition at line 26 of file aabbox3d.h.

: MinEdge(-1,-1,-1), MaxEdge(1,1,1) {}

aabbox3d() [2/4]

template<class T>

irr::core::aabbox3d< T >::aabbox3d ( const vector3d< T > &  min, const vector3d< T > &  max  )

inline

Constructor with min edge and max edge.

Definition at line 28 of file aabbox3d.h.

: MinEdge(min), MaxEdge(max) {}

aabbox3d() [3/4]

template<class T>

irr::core::aabbox3d< T >::aabbox3d ( const vector3d< T > &  init )

inline

Constructor with only one point.

Definition at line 30 of file aabbox3d.h.

: MinEdge(init), MaxEdge(init) {}

aabbox3d() [4/4]

template<class T>

irr::core::aabbox3d< T >::aabbox3d ( T  minx, T  miny, T  minz, T  maxx, T  maxy, T  maxz  )

inline

Constructor with min edge and max edge as single values, not vectors.

Definition at line 32 of file aabbox3d.h.

: MinEdge(minx, miny, minz), MaxEdge(maxx, maxy, maxz) {}

Member Function Documentation

addInternalBox()

template<class T>

void irr::core::aabbox3d< T >::addInternalBox ( const aabbox3d< T > &  b )

inline

Adds another bounding box.

The box grows bigger, if the new box was outside of the box.

Parameters

b	Other bounding box to add into this box.

Definition at line 82 of file aabbox3d.h.

                {
                        addInternalPoint(b.MaxEdge);
                        addInternalPoint(b.MinEdge);
                }

addInternalPoint() [1/2]

template<class T>

void irr::core::aabbox3d< T >::addInternalPoint ( const vector3d< T > &  p )

inline

Adds a point to the bounding box.

The box grows bigger, if point was outside of the box.

Parameters

p	Point to add into the box.

Definition at line 74 of file aabbox3d.h.

                {
                        addInternalPoint(p.X, p.Y, p.Z);
                }

addInternalPoint() [2/2]

template<class T>

void irr::core::aabbox3d< T >::addInternalPoint ( T  x, T  y, T  z  )

inline

Adds a point to the bounding box.

The box grows bigger, if point is outside of the box.

Parameters

x	X coordinate of the point to add to this box.
y	Y coordinate of the point to add to this box.
z	Z coordinate of the point to add to this box.

Definition at line 93 of file aabbox3d.h.

                {
                        if (x>MaxEdge.X) MaxEdge.X = x;
                        if (y>MaxEdge.Y) MaxEdge.Y = y;
                        if (z>MaxEdge.Z) MaxEdge.Z = z;

                        if (x<MinEdge.X) MinEdge.X = x;
                        if (y<MinEdge.Y) MinEdge.Y = y;
                        if (z<MinEdge.Z) MinEdge.Z = z;
                }

classifyPlaneRelation()

template<class T>

EIntersectionRelation3D irr::core::aabbox3d< T >::classifyPlaneRelation ( const plane3d< T > &  plane ) const

inline

Classifies a relation with a plane.

Parameters

plane

Plane to classify relation to.

Returns

Returns ISREL3D_FRONT if the box is in front of the plane, ISREL3D_BACK if the box is behind the plane, and ISREL3D_CLIPPED if it is on both sides of the plane.

Definition at line 321 of file aabbox3d.h.

                {
                        vector3d<T> nearPoint(MaxEdge);
                        vector3d<T> farPoint(MinEdge);

                        if (plane.Normal.X > (T)0)
                        {
                                nearPoint.X = MinEdge.X;
                                farPoint.X = MaxEdge.X;
                        }

                        if (plane.Normal.Y > (T)0)
                        {
                                nearPoint.Y = MinEdge.Y;
                                farPoint.Y = MaxEdge.Y;
                        }

                        if (plane.Normal.Z > (T)0)
                        {
                                nearPoint.Z = MinEdge.Z;
                                farPoint.Z = MaxEdge.Z;
                        }

                        if (plane.Normal.dotProduct(nearPoint) + plane.D > (T)0)
                                return ISREL3D_FRONT;

                        if (plane.Normal.dotProduct(farPoint) + plane.D > (T)0)
                                return ISREL3D_CLIPPED;

                        return ISREL3D_BACK;
                }

getArea()

template<class T>

T irr::core::aabbox3d< T >::getArea ( ) const

inline

Get the surface area of the box in squared units.

Definition at line 142 of file aabbox3d.h.

                {
                        const vector3d<T> e = getExtent();
                        return 2*(e.X*e.Y + e.X*e.Z + e.Y*e.Z);
                }

getCenter()

template<class T>

vector3d<T> irr::core::aabbox3d< T >::getCenter ( ) const

inline

Get center of the bounding box.

Returns

Center of the bounding box.

Definition at line 106 of file aabbox3d.h.

                {
                        return (MinEdge + MaxEdge) / 2;
                }

getEdges()

template<class T>

void irr::core::aabbox3d< T >::getEdges ( vector3d< T > *  edges ) const

inline

Stores all 8 edges of the box into an array.

Parameters

edges

Pointer to array of 8 edges.

Definition at line 150 of file aabbox3d.h.

                {
                        const core::vector3d<T> middle = getCenter();
                        const core::vector3d<T> diag = middle - MaxEdge;

                        /*
                        Edges are stored in this way:
                        Hey, am I an ascii artist, or what? :) niko.
                   /3--------/7
                  / |       / |
                 /  |      /  |
                1---------5   |
                |  /2- - -|- -6
                | /       |  /
                |/        | /
                0---------4/
                        */

                        edges[0].set(middle.X + diag.X, middle.Y + diag.Y, middle.Z + diag.Z);
                        edges[1].set(middle.X + diag.X, middle.Y - diag.Y, middle.Z + diag.Z);
                        edges[2].set(middle.X + diag.X, middle.Y + diag.Y, middle.Z - diag.Z);
                        edges[3].set(middle.X + diag.X, middle.Y - diag.Y, middle.Z - diag.Z);
                        edges[4].set(middle.X - diag.X, middle.Y + diag.Y, middle.Z + diag.Z);
                        edges[5].set(middle.X - diag.X, middle.Y - diag.Y, middle.Z + diag.Z);
                        edges[6].set(middle.X - diag.X, middle.Y + diag.Y, middle.Z - diag.Z);
                        edges[7].set(middle.X - diag.X, middle.Y - diag.Y, middle.Z - diag.Z);
                }

getExtent()

template<class T>

vector3d<T> irr::core::aabbox3d< T >::getExtent ( ) const

inline

Get extent of the box (maximal distance of two points in the box)

Returns

Extent of the bounding box.

Definition at line 113 of file aabbox3d.h.

                {
                        return MaxEdge - MinEdge;
                }

getInterpolated()

template<class T>

aabbox3d<T> irr::core::aabbox3d< T >::getInterpolated ( const aabbox3d< T > &  other, f32  d  ) const

inline

Calculates a new interpolated bounding box.

d=0 returns other, d=1 returns this, all other values blend between the two boxes.

Parameters

other	Other box to interpolate between
d	Value between 0.0f and 1.0f.

Returns

Interpolated box.

Definition at line 208 of file aabbox3d.h.

                {
                        f32 inv = 1.0f - d;
                        return aabbox3d<T>((other.MinEdge*inv) + (MinEdge*d),
                                (other.MaxEdge*inv) + (MaxEdge*d));
                }

getRadius()

template<class T>

T irr::core::aabbox3d< T >::getRadius ( ) const

inline

Get radius of the bounding sphere.

Returns

Radius of the bounding sphere.

Definition at line 120 of file aabbox3d.h.

                {
                        const T radius = getExtent().getLength() / 2;
                        return radius;
                }

getVolume()

template<class T>

T irr::core::aabbox3d< T >::getVolume ( ) const

inline

Get the volume enclosed by the box in cubed units.

Definition at line 135 of file aabbox3d.h.

                {
                        const vector3d<T> e = getExtent();
                        return e.X * e.Y * e.Z;
                }

intersect()

template<class T>

aabbox3d<T> irr::core::aabbox3d< T >::intersect ( const aabbox3d< T > &  other ) const

inline

Returns the intersection of this box with another, if possible.

Definition at line 248 of file aabbox3d.h.

                {
                        aabbox3d<T> out;

                        if (!intersectsWithBox(other))
                                return out;

                        out.MaxEdge.X = min_(MaxEdge.X, other.MaxEdge.X);
                        out.MaxEdge.Y = min_(MaxEdge.Y, other.MaxEdge.Y);
                        out.MaxEdge.Z = min_(MaxEdge.Z, other.MaxEdge.Z);

                        out.MinEdge.X = max_(MinEdge.X, other.MinEdge.X);
                        out.MinEdge.Y = max_(MinEdge.Y, other.MinEdge.Y);
                        out.MinEdge.Z = max_(MinEdge.Z, other.MinEdge.Z);

                        return out;
                }

intersectsWithBox()

template<class T>

bool irr::core::aabbox3d< T >::intersectsWithBox ( const aabbox3d< T > &  other ) const

inline

Determines if the axis-aligned box intersects with another axis-aligned box.

Parameters

other

Other box to check a intersection with.

Returns

True if there is an intersection with the other box, otherwise false.

Definition at line 270 of file aabbox3d.h.

                {
                        return (MinEdge.X <= other.MaxEdge.X && MinEdge.Y <= other.MaxEdge.Y && MinEdge.Z <= other.MaxEdge.Z &&
                                MaxEdge.X >= other.MinEdge.X && MaxEdge.Y >= other.MinEdge.Y && MaxEdge.Z >= other.MinEdge.Z);
                }

intersectsWithLine() [1/2]

template<class T>

bool irr::core::aabbox3d< T >::intersectsWithLine ( const line3d< T > &  line ) const

inline

Tests if the box intersects with a line.

Parameters

line	Line to test intersection with.

Returns

True if there is an intersection , else false.

Definition at line 279 of file aabbox3d.h.

                {
                        return intersectsWithLine(line.getMiddle(), line.getVector().normalize(),
                                        (T)(line.getLength() * 0.5));
                }

intersectsWithLine() [2/2]

template<class T>

bool irr::core::aabbox3d< T >::intersectsWithLine ( const vector3d< T > &  linemiddle, const vector3d< T > &  linevect, T  halflength  ) const

inline

Tests if the box intersects with a line.

Parameters

linemiddle	Center of the line.
linevect	Vector of the line.
halflength	Half length of the line.

Returns

True if there is an intersection, else false.

Definition at line 290 of file aabbox3d.h.

                {
                        const vector3d<T> e = getExtent() * (T)0.5;
                        const vector3d<T> t = getCenter() - linemiddle;

                        if ((fabs(t.X) > e.X + halflength * fabs(linevect.X)) ||
                                (fabs(t.Y) > e.Y + halflength * fabs(linevect.Y)) ||
                                (fabs(t.Z) > e.Z + halflength * fabs(linevect.Z)) )
                                return false;

                        T r = e.Y * (T)fabs(linevect.Z) + e.Z * (T)fabs(linevect.Y);
                        if (fabs(t.Y*linevect.Z - t.Z*linevect.Y) > r )
                                return false;

                        r = e.X * (T)fabs(linevect.Z) + e.Z * (T)fabs(linevect.X);
                        if (fabs(t.Z*linevect.X - t.X*linevect.Z) > r )
                                return false;

                        r = e.X * (T)fabs(linevect.Y) + e.Y * (T)fabs(linevect.X);
                        if (fabs(t.X*linevect.Y - t.Y*linevect.X) > r)
                                return false;

                        return true;
                }

isEmpty()

template<class T>

bool irr::core::aabbox3d< T >::isEmpty ( ) const

inline

Check if the box is empty.

This means that there is no space between the min and max edge.

Returns

True if box is empty, else false.

Definition at line 129 of file aabbox3d.h.

                {
                        return MinEdge.equals ( MaxEdge );
                }

isFullInside()

template<class T>

bool irr::core::aabbox3d< T >::isFullInside ( const aabbox3d< T > &  other ) const

inline

Check if this box is completely inside the 'other' box.

Parameters

other

Other box to check against.

Returns

True if this box is completely inside the other box, otherwise false.

Definition at line 241 of file aabbox3d.h.

                {
                        return (MinEdge.X >= other.MinEdge.X && MinEdge.Y >= other.MinEdge.Y && MinEdge.Z >= other.MinEdge.Z &&
                                MaxEdge.X <= other.MaxEdge.X && MaxEdge.Y <= other.MaxEdge.Y && MaxEdge.Z <= other.MaxEdge.Z);
                }

isPointInside()

template<class T>

bool irr::core::aabbox3d< T >::isPointInside ( const vector3d< T > &  p ) const

inline

Determines if a point is within this box.

Border is included (IS part of the box)!

Parameters

p	Point to check.

Returns

True if the point is within the box and false if not

Definition at line 219 of file aabbox3d.h.

                {
                        return (p.X >= MinEdge.X && p.X <= MaxEdge.X &&
                                p.Y >= MinEdge.Y && p.Y <= MaxEdge.Y &&
                                p.Z >= MinEdge.Z && p.Z <= MaxEdge.Z);
                }

isPointTotalInside()

template<class T>

bool irr::core::aabbox3d< T >::isPointTotalInside ( const vector3d< T > &  p ) const

inline

Determines if a point is within this box and not its borders.

Border is excluded (NOT part of the box)!

Parameters

p	Point to check.

Returns

True if the point is within the box and false if not.

Definition at line 230 of file aabbox3d.h.

                {
                        return (p.X > MinEdge.X && p.X < MaxEdge.X &&
                                p.Y > MinEdge.Y && p.Y < MaxEdge.Y &&
                                p.Z > MinEdge.Z && p.Z < MaxEdge.Z);
                }

isValid()

template<class T>

bool irr::core::aabbox3d< T >::isValid ( ) const

inline

Definition at line 193 of file aabbox3d.h.

                {
                        if (MinEdge.X > MaxEdge.X) return false;
                        if (MinEdge.Y > MaxEdge.Y) return false;
                        if (MinEdge.Z > MaxEdge.Z) return false;

                        return true;
                }

operator!=()

template<class T>

bool irr::core::aabbox3d< T >::operator!= ( const aabbox3d< T > &  other ) const

inline

Inequality operator.

Parameters

other

box to compare with.

Returns

True if both boxes are different, else false.

Definition at line 42 of file aabbox3d.h.

{ return !(MinEdge == other.MinEdge && other.MaxEdge == MaxEdge);}

operator==()

template<class T>

bool irr::core::aabbox3d< T >::operator== ( const aabbox3d< T > &  other ) const

inline

Equality operator.

Parameters

other

box to compare with.

Returns

True if both boxes are equal, else false.

Definition at line 38 of file aabbox3d.h.

{ return (MinEdge == other.MinEdge && other.MaxEdge == MaxEdge);}

repair()

template<class T>

void irr::core::aabbox3d< T >::repair ( )

inline

Repairs the box.

Necessary if for example MinEdge and MaxEdge are swapped.

Definition at line 180 of file aabbox3d.h.

                {
                        T t;

                        if (MinEdge.X > MaxEdge.X)
                                { t=MinEdge.X; MinEdge.X = MaxEdge.X; MaxEdge.X=t; }
                        if (MinEdge.Y > MaxEdge.Y)
                                { t=MinEdge.Y; MinEdge.Y = MaxEdge.Y; MaxEdge.Y=t; }
                        if (MinEdge.Z > MaxEdge.Z)
                                { t=MinEdge.Z; MinEdge.Z = MaxEdge.Z; MaxEdge.Z=t; }
                }

reset() [1/3]

template<class T>

void irr::core::aabbox3d< T >::reset ( T  x, T  y, T  z  )

inline

Resets the bounding box to a one-point box.

Parameters

x	X coord of the point.
y	Y coord of the point.
z	Z coord of the point.

Definition at line 50 of file aabbox3d.h.

                {
                        MaxEdge.set(x,y,z);
                        MinEdge = MaxEdge;
                }

reset() [2/3]

template<class T>

void irr::core::aabbox3d< T >::reset ( const aabbox3d< T > &  initValue )

inline

Resets the bounding box.

Parameters

initValue

New box to set this one to.

Definition at line 58 of file aabbox3d.h.

                {
                        *this = initValue;
                }

reset() [3/3]

template<class T>

void irr::core::aabbox3d< T >::reset ( const vector3d< T > &  initValue )

inline

Resets the bounding box to a one-point box.

Parameters

initValue

New point.

Definition at line 65 of file aabbox3d.h.

                {
                        MaxEdge = initValue;
                        MinEdge = initValue;
                }

Member Data Documentation

MaxEdge

template<class T>

vector3d<T> irr::core::aabbox3d< T >::MaxEdge

The far edge.

Definition at line 357 of file aabbox3d.h.

MinEdge

template<class T>

vector3d<T> irr::core::aabbox3d< T >::MinEdge

The near edge.

Definition at line 354 of file aabbox3d.h.

---

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

• include/irrlicht/aabbox3d.h