![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
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 (const Vector3 &min, const Vector3 &max) | |
AxisAlignedBox (Extent e) | |
AxisAlignedBox (Real mx, Real my, Real mz, Real Mx, Real My, Real Mz) | |
bool | contains (const AxisAlignedBox &other) const |
Tests whether another box contained by this box. | |
bool | contains (const Vector3 &v) const |
Tests whether the given point contained by this box. | |
Real | distance (const Vector3 &v) const |
Returns the minimum distance between a given point and any part of the box. | |
Corners | getAllCorners (void) const |
Returns a pointer to an array of 8 corner points, useful for collision vs. | |
Vector3 | getCenter (void) const |
Gets the centre of the box. | |
Vector3 | getCorner (CornerEnum cornerToGet) const |
Gets the position of one of the corners. | |
Vector3 | getHalfSize (void) const |
Gets the half-size of the box. | |
Vector3 & | getMaximum (void) |
Gets a modifiable version of the maximum corner of the box. | |
const Vector3 & | getMaximum (void) const |
Gets the maximum corner of the box. | |
Vector3 & | getMinimum (void) |
Gets a modifiable version of the minimum corner of the box. | |
const Vector3 & | getMinimum (void) const |
Gets the minimum corner of the box. | |
Vector3 | getSize (void) const |
Gets the size of the box. | |
AxisAlignedBox | intersection (const AxisAlignedBox &b2) const |
Calculate the area of intersection of this box and another. | |
bool | intersects (const AxisAlignedBox &b2) const |
Returns whether or not this box intersects another. | |
bool | intersects (const Plane &p) const |
Tests whether this box intersects a plane. | |
bool | intersects (const Sphere &s) const |
Tests whether this box intersects a sphere. | |
bool | intersects (const Vector3 &v) const |
Tests whether the vector point is within this box. | |
bool | isFinite (void) const |
Returns true if the box is finite. | |
bool | isInfinite (void) const |
Returns true if the box is infinite. | |
bool | isNull (void) const |
Returns true if the box is null i.e. | |
void | merge (const AxisAlignedBox &rhs) |
Merges the passed in box into the current box. | |
void | merge (const Vector3 &point) |
Extends the box to encompass the specified point (if needed). | |
bool | operator!= (const AxisAlignedBox &rhs) const |
Tests 2 boxes for inequality. | |
bool | operator== (const AxisAlignedBox &rhs) const |
Tests 2 boxes for equality. | |
void | scale (const Vector3 &s) |
Scales the AABB by the vector given. | |
void | setExtents (const Vector3 &min, const Vector3 &max) |
Sets both minimum and maximum extents at once. | |
void | setExtents (Real mx, Real my, Real mz, Real Mx, Real My, Real Mz) |
void | setInfinite () |
Sets the box to 'infinite'. | |
void | setMaximum (const Vector3 &vec) |
Sets the maximum corner of the box. | |
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. | |
void | setMaximumY (Real y) |
void | setMaximumZ (Real z) |
void | setMinimum (const Vector3 &vec) |
Sets the minimum corner of the box. | |
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. | |
void | setMinimumY (Real y) |
void | setMinimumZ (Real z) |
void | setNull () |
Sets the box to a 'null' value i.e. | |
Real | squaredDistance (const Vector3 &v) const |
Returns the squared minimum distance between a given point and any part of the box. | |
void | transform (const Affine3 &m) |
Transforms the box according to the affine matrix supplied. | |
void | transform (const Matrix4 &matrix) |
Transforms the box according to the matrix supplied. | |
Real | volume (void) const |
Calculate the volume of this box. | |
Static Public Attributes | |
static const AxisAlignedBox | BOX_INFINITE |
static const AxisAlignedBox | BOX_NULL |
A 3D box aligned with the x/y/z axes.
typedef std::array<Vector3, 8> Ogre::AxisAlignedBox::Corners |
|
inline |
|
inline |
|
inline |
Gets the minimum corner of the box.
Gets a modifiable version of the minimum corner of the box.
Gets the maximum corner of the box.
Gets a modifiable version of the maximum corner of the box.
Sets the minimum corner of the box.
Changes one of the components of the minimum corner of the box used to resize only one dimension of the box.
Sets the maximum corner of the box.
Changes one of the components of the maximum corner of the box used to resize only one dimension of the box.
Sets both minimum and maximum extents at once.
|
inline |
Returns a pointer to an array of 8 corner points, useful for collision vs.
non-aligned objects.
1-------2 /| /| / | / | 5-------4 | | 0----|--3 | / | / |/ |/ 6-------7
|
inline |
Gets the position of one of the corners.
|
inline |
Merges the passed in box into the current box.
The result is the box which encompasses both.
Extends the box to encompass the specified point (if needed).
References Ogre::Vector< dims, T >::makeCeil(), and Ogre::Vector< dims, T >::makeFloor().
Transforms the box according to the matrix supplied.
Transforms the box according to the affine matrix supplied.
References Ogre::Math::Abs().
|
inline |
Sets the box to a 'null' value i.e.
not a box.
|
inline |
Sets the box to 'infinite'.
Returns true if the box is infinite.
Referenced by contains().
|
inline |
Returns whether or not this box intersects another.
|
inline |
Calculate the area of intersection of this box and another.
Calculate the volume of this box.
References Ogre::Math::POS_INFINITY.
Tests whether this box intersects a sphere.
References Ogre::Math::intersects().
Tests whether this box intersects a plane.
References Ogre::Math::intersects().
Tests whether the vector point is within this box.
Gets the size of the box.
References Ogre::Math::POS_INFINITY.
Gets the half-size of the box.
References Ogre::Math::POS_INFINITY.
Tests whether the given point contained by this box.
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.
Returns the minimum distance between a given point and any part of the box.
References Ogre::Math::Sqrt().
|
inline |
Tests whether another box contained by this box.
References isInfinite(), and isNull().
|
inline |
Tests 2 boxes for equality.
|
inline |
Tests 2 boxes for inequality.
|
static |
Referenced by Ogre::MovablePlane::getBoundingBox().
|
static |