Public Member Functions | Public Attributes | List of all members
Ogre::Box Struct Reference

Structure used to define a box in a 3-D integer space. More...

#include <OgreCommon.h>

Inheritance diagram for Ogre::Box:
Inheritance graph
[legend]

Public Member Functions

 Box ()
 Parameterless constructor for setting the members manually. More...
 
 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). More...
 
 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. More...
 
bool contains (const Box &def) const
 Return true if the other box is a part of this one. More...
 
uint32 getDepth () const
 Get the depth of this box. More...
 
uint32 getHeight () const
 Get the height of this box. More...
 
uint32 getWidth () const
 Get the width of this box. More...
 

Public Attributes

uint32 back
 
uint32 bottom
 
uint32 front
 
uint32 left
 
uint32 right
 
uint32 top
 

Detailed Description

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.

Definition at line 659 of file OgreCommon.h.

Constructor & Destructor Documentation

◆ Box() [1/3]

Ogre::Box::Box ( )

Parameterless constructor for setting the members manually.

Definition at line 663 of file OgreCommon.h.

◆ Box() [2/3]

Ogre::Box::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).

Parameters
lx value of left edge
ty value of top edge
rx value of right edge
by value of bottom edge
Note
Note that the left, top, and front edges are included but the right, bottom and back ones are not.

Definition at line 676 of file OgreCommon.h.

◆ Box() [3/3]

Ogre::Box::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.

Parameters
lx value of left edge
ty value of top edge
ffz value of front edge
rx value of right edge
by value of bottom edge
bbz value of back edge
Note
Note that the left, top, and front edges are included but the right, bottom and back ones are not.

Definition at line 697 of file OgreCommon.h.

Member Function Documentation

◆ contains()

bool Ogre::Box::contains ( const Box def) const

Return true if the other box is a part of this one.

Definition at line 709 of file OgreCommon.h.

References back, bottom, front, left, right, and top.

◆ getDepth()

uint32 Ogre::Box::getDepth ( ) const

◆ getHeight()

uint32 Ogre::Box::getHeight ( ) const

◆ getWidth()

uint32 Ogre::Box::getWidth ( ) const

Member Data Documentation

◆ back

uint32 Ogre::Box::back

◆ bottom

uint32 Ogre::Box::bottom

◆ front

uint32 Ogre::Box::front

◆ left

uint32 Ogre::Box::left

◆ right

uint32 Ogre::Box::right

◆ top

uint32 Ogre::Box::top

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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Oct 22 2017 04:04:15