OGRE  1.12.0
Object-Oriented Graphics Rendering Engine
Ogre::AxisAlignedBox Class Reference

A 3D box aligned with the x/y/z axes. More...

#include <OgreAxisAlignedBox.h>

Public Types

enum  CornerEnum {
  FAR_LEFT_BOTTOM = 0, FAR_LEFT_TOP = 1, FAR_RIGHT_TOP = 2, FAR_RIGHT_BOTTOM = 3,
  NEAR_RIGHT_BOTTOM = 7, NEAR_LEFT_BOTTOM = 6, NEAR_LEFT_TOP = 5, NEAR_RIGHT_TOP = 4
}
 
typedef std::array< Vector3, 8 > Corners
 
enum  Extent { EXTENT_NULL, EXTENT_FINITE, EXTENT_INFINITE }
 

Public Member Functions

 AxisAlignedBox ()
 
 AxisAlignedBox (Extent e)
 
 AxisAlignedBox (const Vector3 &min, const Vector3 &max)
 
 AxisAlignedBox (Real mx, Real my, Real mz, Real Mx, Real My, Real Mz)
 
bool contains (const Vector3 &v) const
 Tests whether the given point contained by this box. More...
 
bool contains (const AxisAlignedBox &other) const
 Tests whether another box contained by this box. More...
 
Real distance (const Vector3 &v) const
 Returns the minimum distance between a given point and any part of the box. More...
 
Corners getAllCorners (void) const
 Returns a pointer to an array of 8 corner points, useful for collision vs. More...
 
Vector3 getCenter (void) const
 Gets the centre of the box. More...
 
Vector3 getCorner (CornerEnum cornerToGet) const
 Gets the position of one of the corners. More...
 
Vector3 getHalfSize (void) const
 Gets the half-size of the box. More...
 
const Vector3getMaximum (void) const
 Gets the maximum corner of the box. More...
 
Vector3getMaximum (void)
 Gets a modifiable version of the maximum corner of the box. More...
 
const Vector3getMinimum (void) const
 Gets the minimum corner of the box. More...
 
Vector3getMinimum (void)
 Gets a modifiable version of the minimum corner of the box. More...
 
Vector3 getSize (void) const
 Gets the size of the box. More...
 
AxisAlignedBox intersection (const AxisAlignedBox &b2) const
 Calculate the area of intersection of this box and another. More...
 
bool intersects (const AxisAlignedBox &b2) const
 Returns whether or not this box intersects another. More...
 
bool intersects (const Sphere &s) const
 Tests whether this box intersects a sphere. More...
 
bool intersects (const Plane &p) const
 Tests whether this box intersects a plane. More...
 
bool intersects (const Vector3 &v) const
 Tests whether the vector point is within this box. More...
 
bool isFinite (void) const
 Returns true if the box is finite. More...
 
bool isInfinite (void) const
 Returns true if the box is infinite. More...
 
bool isNull (void) const
 Returns true if the box is null i.e. More...
 
void merge (const AxisAlignedBox &rhs)
 Merges the passed in box into the current box. More...
 
void merge (const Vector3 &point)
 Extends the box to encompass the specified point (if needed). More...
 
bool operator!= (const AxisAlignedBox &rhs) const
 Tests 2 boxes for inequality. More...
 
bool operator== (const AxisAlignedBox &rhs) const
 Tests 2 boxes for equality. More...
 
void scale (const Vector3 &s)
 Scales the AABB by the vector given. More...
 
void setExtents (const Vector3 &min, const Vector3 &max)
 Sets both minimum and maximum extents at once. More...
 
void setExtents (Real mx, Real my, Real mz, Real Mx, Real My, Real Mz)
 
void setInfinite ()
 Sets the box to 'infinite'. More...
 
void setMaximum (const Vector3 &vec)
 Sets the maximum corner of the box. More...
 
void setMaximum (Real x, Real y, Real z)
 
void setMaximumX (Real x)
 Changes one of the components of the maximum corner of the box used to resize only one dimension of the box. More...
 
void setMaximumY (Real y)
 
void setMaximumZ (Real z)
 
void setMinimum (const Vector3 &vec)
 Sets the minimum corner of the box. More...
 
void setMinimum (Real x, Real y, Real z)
 
void setMinimumX (Real x)
 Changes one of the components of the minimum corner of the box used to resize only one dimension of the box. More...
 
void setMinimumY (Real y)
 
void setMinimumZ (Real z)
 
void setNull ()
 Sets the box to a 'null' value i.e. More...
 
Real squaredDistance (const Vector3 &v) const
 Returns the squared minimum distance between a given point and any part of the box. More...
 
void transform (const Matrix4 &matrix)
 Transforms the box according to the matrix supplied. More...
 
void transform (const Affine3 &m)
 Transforms the box according to the affine matrix supplied. More...
 
Real volume (void) const
 Calculate the volume of this box. More...
 

Static Public Attributes

static const AxisAlignedBox BOX_INFINITE
 
static const AxisAlignedBox BOX_NULL
 

Friends

std::ostream & operator<< (std::ostream &o, const AxisAlignedBox &aab)
 

Detailed Description

A 3D box aligned with the x/y/z axes.

Remarks
This class represents a simple box which is aligned with the axes. Internally it only stores 2 points as the extremeties of the box, one which is the minima of all 3 axes, and the other which is the maxima of all 3 axes. This class is typically used for an axis-aligned bounding box (AABB) for collision and visibility determination.

Member Typedef Documentation

◆ Corners

typedef std::array<Vector3, 8> Ogre::AxisAlignedBox::Corners

Member Enumeration Documentation

◆ Extent

Enumerator
EXTENT_NULL 
EXTENT_FINITE 
EXTENT_INFINITE 

◆ CornerEnum

Enumerator
FAR_LEFT_BOTTOM 
FAR_LEFT_TOP 
FAR_RIGHT_TOP 
FAR_RIGHT_BOTTOM 
NEAR_RIGHT_BOTTOM 
NEAR_LEFT_BOTTOM 
NEAR_LEFT_TOP 
NEAR_RIGHT_TOP 

Constructor & Destructor Documentation

◆ AxisAlignedBox() [1/4]

Ogre::AxisAlignedBox::AxisAlignedBox ( )
inline

◆ AxisAlignedBox() [2/4]

Ogre::AxisAlignedBox::AxisAlignedBox ( Extent  e)
inline

◆ AxisAlignedBox() [3/4]

Ogre::AxisAlignedBox::AxisAlignedBox ( const Vector3 min,
const Vector3 max 
)
inline

◆ AxisAlignedBox() [4/4]

Ogre::AxisAlignedBox::AxisAlignedBox ( Real  mx,
Real  my,
Real  mz,
Real  Mx,
Real  My,
Real  Mz 
)
inline

Member Function Documentation

◆ getMinimum() [1/2]

const Vector3& Ogre::AxisAlignedBox::getMinimum ( void  ) const
inline

Gets the minimum corner of the box.

Referenced by intersection().

◆ getMinimum() [2/2]

Vector3& Ogre::AxisAlignedBox::getMinimum ( void  )
inline

Gets a modifiable version of the minimum corner of the box.

◆ getMaximum() [1/2]

const Vector3& Ogre::AxisAlignedBox::getMaximum ( void  ) const
inline

Gets the maximum corner of the box.

Referenced by intersection().

◆ getMaximum() [2/2]

Vector3& Ogre::AxisAlignedBox::getMaximum ( void  )
inline

Gets a modifiable version of the maximum corner of the box.

◆ setMinimum() [1/2]

void Ogre::AxisAlignedBox::setMinimum ( const Vector3 vec)
inline

Sets the minimum corner of the box.

◆ setMinimum() [2/2]

void Ogre::AxisAlignedBox::setMinimum ( Real  x,
Real  y,
Real  z 
)
inline

◆ setMinimumX()

void Ogre::AxisAlignedBox::setMinimumX ( Real  x)
inline

Changes one of the components of the minimum corner of the box used to resize only one dimension of the box.

◆ setMinimumY()

void Ogre::AxisAlignedBox::setMinimumY ( Real  y)
inline

◆ setMinimumZ()

void Ogre::AxisAlignedBox::setMinimumZ ( Real  z)
inline

◆ setMaximum() [1/2]

void Ogre::AxisAlignedBox::setMaximum ( const Vector3 vec)
inline

Sets the maximum corner of the box.

◆ setMaximum() [2/2]

void Ogre::AxisAlignedBox::setMaximum ( Real  x,
Real  y,
Real  z 
)
inline

◆ setMaximumX()

void Ogre::AxisAlignedBox::setMaximumX ( Real  x)
inline

Changes one of the components of the maximum corner of the box used to resize only one dimension of the box.

◆ setMaximumY()

void Ogre::AxisAlignedBox::setMaximumY ( Real  y)
inline

◆ setMaximumZ()

void Ogre::AxisAlignedBox::setMaximumZ ( Real  z)
inline

◆ setExtents() [1/2]

void Ogre::AxisAlignedBox::setExtents ( const Vector3 min,
const Vector3 max 
)
inline

Sets both minimum and maximum extents at once.

◆ setExtents() [2/2]

void Ogre::AxisAlignedBox::setExtents ( Real  mx,
Real  my,
Real  mz,
Real  Mx,
Real  My,
Real  Mz 
)
inline

◆ getAllCorners()

Corners Ogre::AxisAlignedBox::getAllCorners ( void  ) const
inline

Returns a pointer to an array of 8 corner points, useful for collision vs.

non-aligned objects.

Remarks
If the order of these corners is important, they are as follows: The 4 points of the minimum Z face (note that because Ogre uses right-handed coordinates, the minimum Z is at the 'back' of the box) starting with the minimum point of all, then anticlockwise around this face (if you are looking onto the face from outside the box). Then the 4 points of the maximum Z face, starting with maximum point of all, then anticlockwise around this face (looking onto the face from outside the box). Like this:
   1----—2
  /|      /|
 / |     / |
5----—4  |
|  0-—|–3
| /     | /
|/      |/
6----—7

◆ getCorner()

Vector3 Ogre::AxisAlignedBox::getCorner ( CornerEnum  cornerToGet) const
inline

Gets the position of one of the corners.

◆ merge() [1/2]

void Ogre::AxisAlignedBox::merge ( const AxisAlignedBox rhs)
inline

Merges the passed in box into the current box.

The result is the box which encompasses both.

References Ogre::Vector< dims, T >::makeCeil(), and Ogre::Vector< dims, T >::makeFloor().

◆ merge() [2/2]

void Ogre::AxisAlignedBox::merge ( const Vector3 point)
inline

Extends the box to encompass the specified point (if needed).

References Ogre::Vector< dims, T >::makeCeil(), and Ogre::Vector< dims, T >::makeFloor().

◆ transform() [1/2]

void Ogre::AxisAlignedBox::transform ( const Matrix4 matrix)
inline

Transforms the box according to the matrix supplied.

Remarks
By calling this method you get the axis-aligned box which surrounds the transformed version of this box. Therefore each corner of the box is transformed by the matrix, then the extents are mapped back onto the axes to produce another AABB. Useful when you have a local AABB for an object which is then transformed.

◆ transform() [2/2]

void Ogre::AxisAlignedBox::transform ( const Affine3 m)
inline

Transforms the box according to the affine matrix supplied.

Remarks
By calling this method you get the axis-aligned box which surrounds the transformed version of this box. Therefore each corner of the box is transformed by the matrix, then the extents are mapped back onto the axes to produce another AABB. Useful when you have a local AABB for an object which is then transformed.

References Ogre::Math::Abs().

◆ setNull()

void Ogre::AxisAlignedBox::setNull ( )
inline

Sets the box to a 'null' value i.e.

not a box.

◆ isNull()

bool Ogre::AxisAlignedBox::isNull ( void  ) const
inline

Returns true if the box is null i.e.

empty.

Referenced by contains(), Ogre::Plane::getSide(), intersection(), Ogre::PlaneBoundedVolume::intersects(), and intersects().

◆ isFinite()

bool Ogre::AxisAlignedBox::isFinite ( void  ) const
inline

Returns true if the box is finite.

◆ setInfinite()

void Ogre::AxisAlignedBox::setInfinite ( )
inline

Sets the box to 'infinite'.

◆ isInfinite()

bool Ogre::AxisAlignedBox::isInfinite ( void  ) const
inline

Returns true if the box is infinite.

Referenced by contains(), Ogre::Plane::getSide(), intersection(), Ogre::PlaneBoundedVolume::intersects(), and intersects().

◆ intersects() [1/4]

bool Ogre::AxisAlignedBox::intersects ( const AxisAlignedBox b2) const
inline

Returns whether or not this box intersects another.

References isInfinite(), and isNull().

◆ intersection()

AxisAlignedBox Ogre::AxisAlignedBox::intersection ( const AxisAlignedBox b2) const
inline

Calculate the area of intersection of this box and another.

References getMaximum(), getMinimum(), isInfinite(), isNull(), Ogre::Vector< dims, T >::makeCeil(), and Ogre::Vector< dims, T >::makeFloor().

◆ volume()

Real Ogre::AxisAlignedBox::volume ( void  ) const
inline

Calculate the volume of this box.

References Ogre::Math::POS_INFINITY.

◆ scale()

void Ogre::AxisAlignedBox::scale ( const Vector3 s)
inline

Scales the AABB by the vector given.

◆ intersects() [2/4]

bool Ogre::AxisAlignedBox::intersects ( const Sphere s) const
inline

Tests whether this box intersects a sphere.

References Ogre::Math::intersects().

◆ intersects() [3/4]

bool Ogre::AxisAlignedBox::intersects ( const Plane p) const
inline

Tests whether this box intersects a plane.

References Ogre::Math::intersects().

◆ intersects() [4/4]

bool Ogre::AxisAlignedBox::intersects ( const Vector3 v) const
inline

Tests whether the vector point is within this box.

◆ getCenter()

Vector3 Ogre::AxisAlignedBox::getCenter ( void  ) const
inline

Gets the centre of the box.

Referenced by Ogre::Plane::getSide(), and Ogre::PlaneBoundedVolume::intersects().

◆ getSize()

Vector3 Ogre::AxisAlignedBox::getSize ( void  ) const
inline

Gets the size of the box.

References Ogre::Math::POS_INFINITY.

◆ getHalfSize()

Vector3 Ogre::AxisAlignedBox::getHalfSize ( void  ) const
inline

Gets the half-size of the box.

References Ogre::Math::POS_INFINITY.

Referenced by Ogre::Plane::getSide(), and Ogre::PlaneBoundedVolume::intersects().

◆ contains() [1/2]

bool Ogre::AxisAlignedBox::contains ( const Vector3 v) const
inline

Tests whether the given point contained by this box.

◆ squaredDistance()

Real Ogre::AxisAlignedBox::squaredDistance ( const Vector3 v) const
inline

Returns the squared minimum distance between a given point and any part of the box.

This is faster than distance since avoiding a squareroot, so use if you can.

References Ogre::Vector< dims, T >::squaredLength().

◆ distance()

Real Ogre::AxisAlignedBox::distance ( const Vector3 v) const
inline

Returns the minimum distance between a given point and any part of the box.

References Ogre::Math::Sqrt().

◆ contains() [2/2]

bool Ogre::AxisAlignedBox::contains ( const AxisAlignedBox other) const
inline

Tests whether another box contained by this box.

References isInfinite(), and isNull().

◆ operator==()

bool Ogre::AxisAlignedBox::operator== ( const AxisAlignedBox rhs) const
inline

Tests 2 boxes for equality.

◆ operator!=()

bool Ogre::AxisAlignedBox::operator!= ( const AxisAlignedBox rhs) const
inline

Tests 2 boxes for inequality.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  o,
const AxisAlignedBox aab 
)
friend

Member Data Documentation

◆ BOX_NULL

const AxisAlignedBox Ogre::AxisAlignedBox::BOX_NULL
static

◆ BOX_INFINITE

const AxisAlignedBox Ogre::AxisAlignedBox::BOX_INFINITE
static

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