Irrlicht 3D Engine
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...
 
void addInternalBox (const aabbox3d< T > &b)
 Adds another bounding box. More...
 
void addInternalPoint (const vector3d< T > &p)
 Adds a point to the bounding box. More...
 
void addInternalPoint (T x, T y, T z)
 Adds a point to the bounding box. More...
 
EIntersectionRelation3D classifyPlaneRelation (const plane3d< T > &plane) const
 Classifies a relation with a plane. More...
 
getArea () const
 Get the surface area of the box in squared units. More...
 
vector3d< T > getCenter () const
 Get center of the bounding box. More...
 
void getEdges (vector3d< T > *edges) const
 Stores all 8 edges of the box into an array. More...
 
vector3d< T > getExtent () const
 Get extent of the box (maximal distance of two points in the box) More...
 
aabbox3d< T > getInterpolated (const aabbox3d< T > &other, f32 d) const
 Calculates a new interpolated bounding box. More...
 
getRadius () const
 Get radius of the bounding sphere. More...
 
getVolume () const
 Get the volume enclosed by the box in cubed units. 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...
 
bool isEmpty () const
 Check if the box is empty. More...
 
bool isFullInside (const aabbox3d< T > &other) const
 Check if this box is completely inside the 'other' 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 isValid () const
 
bool operator!= (const aabbox3d< T > &other) const
 Inequality operator. More...
 
bool operator== (const aabbox3d< T > &other) const
 Equality operator. More...
 
void repair ()
 Repairs the box. 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...
 

Public Attributes

vector3d< T > MaxEdge
 The far edge. More...
 
vector3d< T > MinEdge
 The near 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.

◆ 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.

◆ 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.

◆ aabbox3d() [4/4]

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

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

Definition at line 32 of file aabbox3d.h.

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
bOther bounding box to add into this box.

Definition at line 82 of file aabbox3d.h.

Referenced by irr::scene::IMeshManipulator::apply(), irr::scene::SMesh::recalculateBoundingBox(), and irr::scene::SAnimatedMesh::recalculateBoundingBox().

◆ addInternalPoint() [1/2]

◆ addInternalPoint() [2/2]

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

Adds a point to the bounding box.

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

Parameters
xX coordinate of the point to add to this box.
yY coordinate of the point to add to this box.
zZ coordinate of the point to add to this box.

Definition at line 93 of file aabbox3d.h.

◆ classifyPlaneRelation()

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

Classifies a relation with a plane.

Parameters
planePlane 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.

◆ 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.

◆ 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.

Referenced by irr::core::aabbox3d< f32 >::getEdges(), and irr::core::aabbox3d< f32 >::intersectsWithLine().

◆ 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
edgesPointer to array of 8 edges.

Definition at line 150 of file aabbox3d.h.

Referenced by irr::scene::ISceneNode::getTransformedBoundingBoxEdges().

◆ 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.

Referenced by irr::core::aabbox3d< f32 >::getArea(), irr::core::aabbox3d< f32 >::getRadius(), irr::core::aabbox3d< f32 >::getVolume(), and irr::core::aabbox3d< f32 >::intersectsWithLine().

◆ 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
otherOther box to interpolate between
dValue between 0.0f and 1.0f.
Returns
Interpolated box.

Definition at line 208 of file aabbox3d.h.

◆ 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.

◆ 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.

◆ 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.

◆ 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
otherOther 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.

Referenced by irr::core::aabbox3d< f32 >::intersect().

◆ 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
lineLine to test intersection with.
Returns
True if there is an intersection , else false.

Definition at line 279 of file aabbox3d.h.

Referenced by irr::core::aabbox3d< f32 >::intersectsWithLine().

◆ intersectsWithLine() [2/2]

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

Tests if the box intersects with a line.

Parameters
linemiddleCenter of the line.
linevectVector of the line.
halflengthHalf length of the line.
Returns
True if there is an intersection, else false.

Definition at line 290 of file aabbox3d.h.

◆ 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.

Referenced by irr::scene::SMesh::recalculateBoundingBox().

◆ 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
otherOther 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.

◆ 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
pPoint to check.
Returns
True if the point is within the box and false if not

Definition at line 219 of file aabbox3d.h.

Referenced by irr::core::triangle3d< T >::isTotalInsideBox().

◆ 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
pPoint to check.
Returns
True if the point is within the box and false if not.

Definition at line 230 of file aabbox3d.h.

◆ isValid()

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

Definition at line 193 of file aabbox3d.h.

◆ operator!=()

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

Inequality operator.

Parameters
otherbox to compare with.
Returns
True if both boxes are different, else false.

Definition at line 42 of file aabbox3d.h.

◆ operator==()

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

Equality operator.

Parameters
otherbox to compare with.
Returns
True if both boxes are equal, else false.

Definition at line 38 of file aabbox3d.h.

◆ 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.

Referenced by irr::core::CMatrix4< T >::transformBox().

◆ reset() [1/3]

◆ reset() [2/3]

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

Resets the bounding box.

Parameters
initValueNew box to set this one to.

Definition at line 58 of file aabbox3d.h.

◆ 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
initValueNew point.

Definition at line 65 of file aabbox3d.h.

Member Data Documentation

◆ MaxEdge

◆ MinEdge


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