\hypertarget{struct_ogre_1_1_box}{}\doxysection{Ogre\+::Box Struct Reference}
\label{struct_ogre_1_1_box}\index{Ogre::Box@{Ogre::Box}}


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




{\ttfamily \#include $<$Ogre\+Common.\+h$>$}



Inheritance diagram for Ogre\+::Box\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=168pt]{struct_ogre_1_1_box__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{struct_ogre_1_1_box_aaae3f6efb19b7607eef11e8e70fa46a2}{Box}} ()
\begin{DoxyCompactList}\small\item\em Parameterless constructor for setting the members manually. \end{DoxyCompactList}\item 
\mbox{\hyperlink{struct_ogre_1_1_box_a299430570d30db49fa26940428891deb}{Box}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} l, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} t, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} ff, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} r, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} b, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} bb)
\begin{DoxyCompactList}\small\item\em Define a box from left, top, front, right, bottom and back coordinates. \end{DoxyCompactList}\item 
\mbox{\hyperlink{struct_ogre_1_1_box_a1d5ae3e6901d4a751a896ba7dbd380ea}{Box}} (\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} l, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} t, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} r, \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} b)
\begin{DoxyCompactList}\small\item\em Define a box from left, top, right and bottom coordinates This box will have depth one (front=0 and back=1). \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{struct_ogre_1_1_box_a7d29d3b112980c25bd0250dc41cf6ed2}{contains}} (const \mbox{\hyperlink{struct_ogre_1_1_box}{Box}} \&def) const
\begin{DoxyCompactList}\small\item\em Return true if the other box is a part of this one. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_ae820fd38f7b51e2a907ef601642c898c}{get\+Depth}} () const
\begin{DoxyCompactList}\small\item\em Get the depth of this box. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_a352d26dea0069f2e7f1414e8caa2328c}{get\+Height}} () const
\begin{DoxyCompactList}\small\item\em Get the height of this box. \end{DoxyCompactList}\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}{get\+Width}} () const
\begin{DoxyCompactList}\small\item\em Get the width of this box. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_a19a7351210e086309a74461d8b4c5cb1}{back}}
\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_ae46fa4954b4d29f4d051f947fe45c142}{bottom}}
\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_a5e545a9bd1bc4151a113267c6529d84f}{front}}
\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_a88fa61f841bc444d92075d8b6cb2b43b}{left}}
\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_ac2c94e2d364dfabe7e4406ff8f41ab9e}{right}}
\item 
\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{struct_ogre_1_1_box_a7c317f774697dbd65dd77e49a0448d2d}{top}}
\end{DoxyCompactItemize}


\doxysubsection{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. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_box_aaae3f6efb19b7607eef11e8e70fa46a2}\label{struct_ogre_1_1_box_aaae3f6efb19b7607eef11e8e70fa46a2}} 
\index{Ogre::Box@{Ogre::Box}!Box@{Box}}
\index{Box@{Box}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{Box()}{Box()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily Ogre\+::\+Box\+::\+Box (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Parameterless constructor for setting the members manually. 

\mbox{\Hypertarget{struct_ogre_1_1_box_a1d5ae3e6901d4a751a896ba7dbd380ea}\label{struct_ogre_1_1_box_a1d5ae3e6901d4a751a896ba7dbd380ea}} 
\index{Ogre::Box@{Ogre::Box}!Box@{Box}}
\index{Box@{Box}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{Box()}{Box()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily Ogre\+::\+Box\+::\+Box (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{l,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{t,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{r,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{b }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Define a box from left, top, right and bottom coordinates This box will have depth one (front=0 and back=1). 


\begin{DoxyParams}{Parameters}
{\em l} & x value of left edge \\
\hline
{\em t} & y value of top edge \\
\hline
{\em r} & x value of right edge \\
\hline
{\em b} & y value of bottom edge \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
Note that the left, top, and front edges are included but the right, bottom and back ones are not. 
\end{DoxyNote}


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

\mbox{\Hypertarget{struct_ogre_1_1_box_a299430570d30db49fa26940428891deb}\label{struct_ogre_1_1_box_a299430570d30db49fa26940428891deb}} 
\index{Ogre::Box@{Ogre::Box}!Box@{Box}}
\index{Box@{Box}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{Box()}{Box()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily Ogre\+::\+Box\+::\+Box (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{l,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{t,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{ff,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{r,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{b,  }\item[{\mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}}]{bb }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Define a box from left, top, front, right, bottom and back coordinates. 


\begin{DoxyParams}{Parameters}
{\em l} & x value of left edge \\
\hline
{\em t} & y value of top edge \\
\hline
{\em ff} & z value of front edge \\
\hline
{\em r} & x value of right edge \\
\hline
{\em b} & y value of bottom edge \\
\hline
{\em bb} & z value of back edge \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
Note that the left, top, and front edges are included but the right, bottom and back ones are not. 
\end{DoxyNote}


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



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_box_a7d29d3b112980c25bd0250dc41cf6ed2}\label{struct_ogre_1_1_box_a7d29d3b112980c25bd0250dc41cf6ed2}} 
\index{Ogre::Box@{Ogre::Box}!contains@{contains}}
\index{contains@{contains}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{contains()}{contains()}}
{\footnotesize\ttfamily bool Ogre\+::\+Box\+::contains (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{struct_ogre_1_1_box}{Box}} \&}]{def }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



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



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

\mbox{\Hypertarget{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}\label{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}} 
\index{Ogre::Box@{Ogre::Box}!getWidth@{getWidth}}
\index{getWidth@{getWidth}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{getWidth()}{getWidth()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::get\+Width (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the width of this box. 



References left, and right.

\mbox{\Hypertarget{struct_ogre_1_1_box_a352d26dea0069f2e7f1414e8caa2328c}\label{struct_ogre_1_1_box_a352d26dea0069f2e7f1414e8caa2328c}} 
\index{Ogre::Box@{Ogre::Box}!getHeight@{getHeight}}
\index{getHeight@{getHeight}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{getHeight()}{getHeight()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::get\+Height (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the height of this box. 



References bottom, and top.

\mbox{\Hypertarget{struct_ogre_1_1_box_ae820fd38f7b51e2a907ef601642c898c}\label{struct_ogre_1_1_box_ae820fd38f7b51e2a907ef601642c898c}} 
\index{Ogre::Box@{Ogre::Box}!getDepth@{getDepth}}
\index{getDepth@{getDepth}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{getDepth()}{getDepth()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::get\+Depth (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the depth of this box. 



References back, and front.



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_box_a88fa61f841bc444d92075d8b6cb2b43b}\label{struct_ogre_1_1_box_a88fa61f841bc444d92075d8b6cb2b43b}} 
\index{Ogre::Box@{Ogre::Box}!left@{left}}
\index{left@{left}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{left}{left}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::left}



Referenced by Box(), contains(), and get\+Width().

\mbox{\Hypertarget{struct_ogre_1_1_box_a7c317f774697dbd65dd77e49a0448d2d}\label{struct_ogre_1_1_box_a7c317f774697dbd65dd77e49a0448d2d}} 
\index{Ogre::Box@{Ogre::Box}!top@{top}}
\index{top@{top}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{top}{top}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::top}



Referenced by Box(), contains(), and get\+Height().

\mbox{\Hypertarget{struct_ogre_1_1_box_ac2c94e2d364dfabe7e4406ff8f41ab9e}\label{struct_ogre_1_1_box_ac2c94e2d364dfabe7e4406ff8f41ab9e}} 
\index{Ogre::Box@{Ogre::Box}!right@{right}}
\index{right@{right}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{right}{right}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::right}



Referenced by Box(), contains(), and get\+Width().

\mbox{\Hypertarget{struct_ogre_1_1_box_ae46fa4954b4d29f4d051f947fe45c142}\label{struct_ogre_1_1_box_ae46fa4954b4d29f4d051f947fe45c142}} 
\index{Ogre::Box@{Ogre::Box}!bottom@{bottom}}
\index{bottom@{bottom}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{bottom}{bottom}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::bottom}



Referenced by Box(), contains(), and get\+Height().

\mbox{\Hypertarget{struct_ogre_1_1_box_a5e545a9bd1bc4151a113267c6529d84f}\label{struct_ogre_1_1_box_a5e545a9bd1bc4151a113267c6529d84f}} 
\index{Ogre::Box@{Ogre::Box}!front@{front}}
\index{front@{front}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{front}{front}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::front}



Referenced by Box(), contains(), and get\+Depth().

\mbox{\Hypertarget{struct_ogre_1_1_box_a19a7351210e086309a74461d8b4c5cb1}\label{struct_ogre_1_1_box_a19a7351210e086309a74461d8b4c5cb1}} 
\index{Ogre::Box@{Ogre::Box}!back@{back}}
\index{back@{back}!Ogre::Box@{Ogre::Box}}
\doxysubsubsection{\texorpdfstring{back}{back}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Box\+::back}



Referenced by Box(), contains(), and get\+Depth().



The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_common_8h}{Ogre\+Common.\+h}}\end{DoxyCompactItemize}
