![]() |
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
Structure used to define a box in a 3-D integer space. More...
#include <OgreCommon.h>
Inheritance diagram for Ogre::Box:Public Member Functions | |
| Box () | |
| Parameterless constructor for setting the members manually. | |
| template<typename T> | |
| Box (const TRect< T > &r) | |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| Box (const Vector3i &size) | |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| Box (uint32 l, uint32 t, uint32 ff, uint32 r, uint32 b, uint32 bb) | |
| Define a box from left, top, front, right, bottom and back coordinates. | |
| Box (uint32 l, uint32 t, uint32 r, uint32 b) | |
| Define a box from left, top, right and bottom coordinates This box will have depth one (front=0 and back=1). | |
| bool | contains (const Box &def) const |
| Return true if the other box is a part of this one. | |
| uint32 | getDepth () const |
| Get the depth of this box. | |
| uint32 | getHeight () const |
| Get the height of this box. | |
| Vector3i | getOrigin () const |
| origin (top, left, front) of the box | |
| Vector3i | getSize () const |
| size (width, height, depth) of the box | |
| uint32 | getWidth () const |
| Get the width of this box. | |
Public Attributes | |
| uint32 | back |
| uint32 | bottom |
| uint32 | front |
| uint32 | left |
| uint32 | right |
| uint32 | top |
Structure used to define a box in a 3-D integer space.
Note that the left, top, and front edges are included but the right, bottom and back ones are not.
|
inline |
Parameterless constructor for setting the members manually.
References back, bottom, front, left, right, and top.
Referenced by Box(), Ogre::PixelBox::PixelBox(), Ogre::PixelBox::PixelBox(), contains(), and Ogre::PixelBox::getSubVolume().
Define a box from left, top, right and bottom coordinates This box will have depth one (front=0 and back=1).
| l | x value of left edge |
| t | y value of top edge |
| r | x value of right edge |
| b | y value of bottom edge |
|
inlineexplicit |
Define a box from left, top, front, right, bottom and back coordinates.
| l | x value of left edge |
| t | y value of top edge |
| ff | z value of front edge |
| r | x value of right edge |
| b | y value of bottom edge |
| bb | z value of back edge |
|
inlineexplicit |
|
inline |
|
inline |
Get the width of this box.
Referenced by Ogre::PixelBox::getRowSkip(), getSize(), Ogre::PixelBox::isConsecutive(), and Ogre::PixelBox::setConsecutive().
|
inline |
Get the height of this box.
Referenced by getSize(), Ogre::PixelBox::getSliceSkip(), Ogre::PixelBox::isConsecutive(), and Ogre::PixelBox::setConsecutive().
|
inline |
|
inline |
|
inline |
size (width, height, depth) of the box
References getDepth(), getHeight(), and getWidth().
| uint32 Ogre::Box::left |
Referenced by Box(), Box(), Box(), Box(), Box(), contains(), getOrigin(), and getWidth().
| uint32 Ogre::Box::top |
Referenced by Box(), Box(), Box(), Box(), Box(), contains(), getHeight(), and getOrigin().
| uint32 Ogre::Box::right |
Referenced by Box(), Box(), Box(), Box(), Box(), contains(), and getWidth().
| uint32 Ogre::Box::bottom |
Referenced by Box(), Box(), Box(), Box(), Box(), contains(), and getHeight().
| uint32 Ogre::Box::front |
Referenced by Box(), Box(), Box(), Box(), contains(), getDepth(), and getOrigin().
| uint32 Ogre::Box::back |
Referenced by Box(), Box(), Box(), Box(), contains(), and getDepth().