OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::AxisAlignedBox Class Reference

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

#include <OgreAxisAlignedBox.h>

+ Collaboration diagram for Ogre::AxisAlignedBox:

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
}
 
enum  Extent { EXTENT_NULL, EXTENT_FINITE, EXTENT_INFINITE }
 

Public Member Functions

 AxisAlignedBox ()
 
 AxisAlignedBox (Extent e)
 
 AxisAlignedBox (const AxisAlignedBox &rkBox)
 
 AxisAlignedBox (const Vector3 &min, const Vector3 &max)
 
 AxisAlignedBox (Real mx, Real my, Real mz, Real Mx, Real My, Real Mz)
 
 ~AxisAlignedBox ()
 
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...
 
const Vector3getAllCorners (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...
 
AxisAlignedBoxoperator= (const AxisAlignedBox &rhs)
 
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 transformAffine (const Matrix4 &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
 

Protected Attributes

Vector3mCorners
 
Extent mExtent
 
Vector3 mMaximum
 
Vector3 mMinimum
 

Friends

_OgreExport friend 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.

Definition at line 53 of file OgreAxisAlignedBox.h.

Member Enumeration Documentation

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 

Definition at line 80 of file OgreAxisAlignedBox.h.

Enumerator
EXTENT_NULL 
EXTENT_FINITE 
EXTENT_INFINITE 

Definition at line 56 of file OgreAxisAlignedBox.h.

Constructor & Destructor Documentation

Ogre::AxisAlignedBox::AxisAlignedBox ( )
inline

Definition at line 90 of file OgreAxisAlignedBox.h.

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

Definition at line 97 of file OgreAxisAlignedBox.h.

Ogre::AxisAlignedBox::AxisAlignedBox ( const AxisAlignedBox rkBox)
inline

Definition at line 104 of file OgreAxisAlignedBox.h.

References isInfinite(), isNull(), mMaximum, and mMinimum.

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

Definition at line 115 of file OgreAxisAlignedBox.h.

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

Definition at line 120 of file OgreAxisAlignedBox.h.

Ogre::AxisAlignedBox::~AxisAlignedBox ( )
inline

Definition at line 140 of file OgreAxisAlignedBox.h.

References Ogre::MEMCATEGORY_SCENE_CONTROL, and OGRE_FREE.

Member Function Documentation

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

Tests whether the given point contained by this box.

Definition at line 749 of file OgreAxisAlignedBox.h.

References Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Tests whether another box contained by this box.

Definition at line 799 of file OgreAxisAlignedBox.h.

References isInfinite(), isNull(), mMaximum, mMinimum, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

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

Definition at line 792 of file OgreAxisAlignedBox.h.

References Ogre::Math::Sqrt().

const Vector3* 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

Definition at line 300 of file OgreAxisAlignedBox.h.

References Ogre::MEMCATEGORY_SCENE_CONTROL, and OGRE_ALLOC_T.

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

Gets the centre of the box.

Definition at line 693 of file OgreAxisAlignedBox.h.

Referenced by Ogre::PlaneBoundedVolume::intersects().

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

Gets the position of one of the corners.

Definition at line 328 of file OgreAxisAlignedBox.h.

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

Gets the half-size of the box.

Definition at line 725 of file OgreAxisAlignedBox.h.

References Ogre::Math::POS_INFINITY, and Ogre::Vector3::ZERO.

Referenced by Ogre::PlaneBoundedVolume::intersects().

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

Gets the maximum corner of the box.

Definition at line 164 of file OgreAxisAlignedBox.h.

Referenced by intersection().

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

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

Definition at line 172 of file OgreAxisAlignedBox.h.

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

Gets the minimum corner of the box.

Definition at line 149 of file OgreAxisAlignedBox.h.

Referenced by intersection().

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

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

Definition at line 157 of file OgreAxisAlignedBox.h.

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

Gets the size of the box.

Definition at line 703 of file OgreAxisAlignedBox.h.

References Ogre::Math::POS_INFINITY, and Ogre::Vector3::ZERO.

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

Calculate the area of intersection of this box and another.

Definition at line 593 of file OgreAxisAlignedBox.h.

References getMaximum(), getMinimum(), isInfinite(), isNull(), Ogre::Vector3::makeCeil(), Ogre::Vector3::makeFloor(), Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Returns whether or not this box intersects another.

Definition at line 562 of file OgreAxisAlignedBox.h.

References isInfinite(), isNull(), mMaximum, mMinimum, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Tests whether this box intersects a sphere.

Definition at line 662 of file OgreAxisAlignedBox.h.

References Ogre::Math::intersects().

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

Tests whether this box intersects a plane.

Definition at line 667 of file OgreAxisAlignedBox.h.

References Ogre::Math::intersects().

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

Tests whether the vector point is within this box.

Definition at line 672 of file OgreAxisAlignedBox.h.

References Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Returns true if the box is finite.

Definition at line 542 of file OgreAxisAlignedBox.h.

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

Returns true if the box is infinite.

Definition at line 556 of file OgreAxisAlignedBox.h.

Referenced by AxisAlignedBox(), contains(), intersection(), Ogre::PlaneBoundedVolume::intersects(), intersects(), and operator=().

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

Returns true if the box is null i.e.

empty.

Definition at line 535 of file OgreAxisAlignedBox.h.

Referenced by AxisAlignedBox(), contains(), intersection(), Ogre::PlaneBoundedVolume::intersects(), intersects(), and operator=().

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.

Definition at line 378 of file OgreAxisAlignedBox.h.

References Ogre::Vector3::makeCeil(), Ogre::Vector3::makeFloor(), Ogre::max(), mExtent, Ogre::min(), mMaximum, and mMinimum.

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

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

Definition at line 410 of file OgreAxisAlignedBox.h.

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

Tests 2 boxes for inequality.

Definition at line 831 of file OgreAxisAlignedBox.h.

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

Definition at line 127 of file OgreAxisAlignedBox.h.

References isInfinite(), isNull(), mMaximum, and mMinimum.

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

Tests 2 boxes for equality.

Definition at line 817 of file OgreAxisAlignedBox.h.

References mExtent, mMaximum, and mMinimum.

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

Scales the AABB by the vector given.

Definition at line 649 of file OgreAxisAlignedBox.h.

References Ogre::max(), and Ogre::min().

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

Sets both minimum and maximum extents at once.

Definition at line 248 of file OgreAxisAlignedBox.h.

References Ogre::max(), Ogre::min(), Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Definition at line 258 of file OgreAxisAlignedBox.h.

void Ogre::AxisAlignedBox::setInfinite ( )
inline

Sets the box to 'infinite'.

Definition at line 549 of file OgreAxisAlignedBox.h.

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

Sets the maximum corner of the box.

Definition at line 214 of file OgreAxisAlignedBox.h.

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

Definition at line 220 of file OgreAxisAlignedBox.h.

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.

Definition at line 231 of file OgreAxisAlignedBox.h.

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

Definition at line 236 of file OgreAxisAlignedBox.h.

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

Definition at line 241 of file OgreAxisAlignedBox.h.

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

Sets the minimum corner of the box.

Definition at line 180 of file OgreAxisAlignedBox.h.

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

Definition at line 186 of file OgreAxisAlignedBox.h.

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.

Definition at line 197 of file OgreAxisAlignedBox.h.

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

Definition at line 202 of file OgreAxisAlignedBox.h.

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

Definition at line 207 of file OgreAxisAlignedBox.h.

void Ogre::AxisAlignedBox::setNull ( )
inline

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

not a box.

Definition at line 528 of file OgreAxisAlignedBox.h.

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.

Definition at line 763 of file OgreAxisAlignedBox.h.

References Ogre::Vector3::squaredLength(), Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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.

Definition at line 439 of file OgreAxisAlignedBox.h.

References Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

void Ogre::AxisAlignedBox::transformAffine ( const Matrix4 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.
Note
The matrix must be an affine matrix.
See also
Matrix4::isAffine.

Definition at line 506 of file OgreAxisAlignedBox.h.

References Ogre::Math::Abs(), Ogre::Matrix4::isAffine(), Ogre::Matrix4::transformAffine(), Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Calculate the volume of this box.

Definition at line 626 of file OgreAxisAlignedBox.h.

References Ogre::Math::POS_INFINITY, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

Friends And Related Function Documentation

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

Definition at line 353 of file OgreAxisAlignedBox.h.

Member Data Documentation

const AxisAlignedBox Ogre::AxisAlignedBox::BOX_INFINITE
static

Definition at line 838 of file OgreAxisAlignedBox.h.

const AxisAlignedBox Ogre::AxisAlignedBox::BOX_NULL
static

Definition at line 837 of file OgreAxisAlignedBox.h.

Vector3* Ogre::AxisAlignedBox::mCorners
mutableprotected

Definition at line 67 of file OgreAxisAlignedBox.h.

Extent Ogre::AxisAlignedBox::mExtent
protected

Definition at line 66 of file OgreAxisAlignedBox.h.

Referenced by merge(), and operator==().

Vector3 Ogre::AxisAlignedBox::mMaximum
protected

Definition at line 65 of file OgreAxisAlignedBox.h.

Referenced by AxisAlignedBox(), contains(), intersects(), merge(), operator=(), and operator==().

Vector3 Ogre::AxisAlignedBox::mMinimum
protected

Definition at line 64 of file OgreAxisAlignedBox.h.

Referenced by AxisAlignedBox(), contains(), intersects(), merge(), operator=(), and operator==().


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