\hypertarget{class_ogre_1_1_plane_bounded_volume}{}\doxysection{Ogre\+::Plane\+Bounded\+Volume Class Reference}
\label{class_ogre_1_1_plane_bounded_volume}\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}


Represents a convex volume bounded by planes.  




{\ttfamily \#include $<$Ogre\+Plane\+Bounded\+Volume.\+h$>$}

\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef std\+::vector$<$ \mbox{\hyperlink{class_ogre_1_1_plane}{Plane}} $>$ \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_adffb808d81baf5b8342fc8959e8123bf}{Plane\+List}}
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_a9f3907950c9fd279e01ac1d4a03d9871}{Plane\+Bounded\+Volume}} ()
\item 
\mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_a1f07490e0ddb2809e1e2b71a89c23856}{Plane\+Bounded\+Volume}} (\mbox{\hyperlink{class_ogre_1_1_plane_aa5d44b14d6f032f3e0a26e83589180bc}{Plane\+::\+Side}} the\+Outside)
\begin{DoxyCompactList}\small\item\em Constructor, determines which side is deemed to be \textquotesingle{}outside\textquotesingle{}. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_ac92a3d627da4cadbc9ebe7331b368e6e}{intersects}} (const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} \&box) const
\begin{DoxyCompactList}\small\item\em Intersection test with A\+A\+BB. \end{DoxyCompactList}\item 
std\+::pair$<$ bool, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} $>$ \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_ae4528e95f68402ad6fea0ff6414dbeb7}{intersects}} (const \mbox{\hyperlink{class_ogre_1_1_ray}{Ray}} \&ray)
\begin{DoxyCompactList}\small\item\em Intersection test with a \mbox{\hyperlink{class_ogre_1_1_ray}{Ray}}. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_a2381ee685a1657cb601f1859ed8bc9b0}{intersects}} (const \mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}} \&sphere) const
\begin{DoxyCompactList}\small\item\em Intersection test with \mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_plane_aa5d44b14d6f032f3e0a26e83589180bc}{Plane\+::\+Side}} \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_a4d323aac2569fdb268dd6dda2801896e}{outside}}
\item 
\mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_adffb808d81baf5b8342fc8959e8123bf}{Plane\+List}} \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_a20b9a9b8d76a970c5f6cbac4cb438054}{planes}}
\begin{DoxyCompactList}\small\item\em Publicly accessible plane list, you can modify this direct. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Represents a convex volume bounded by planes. 

\doxysubsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_adffb808d81baf5b8342fc8959e8123bf}\label{class_ogre_1_1_plane_bounded_volume_adffb808d81baf5b8342fc8959e8123bf}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!PlaneList@{PlaneList}}
\index{PlaneList@{PlaneList}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{PlaneList}{PlaneList}}
{\footnotesize\ttfamily typedef std\+::vector$<$\mbox{\hyperlink{class_ogre_1_1_plane}{Plane}}$>$ \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_adffb808d81baf5b8342fc8959e8123bf}{Ogre\+::\+Plane\+Bounded\+Volume\+::\+Plane\+List}}}



\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_a9f3907950c9fd279e01ac1d4a03d9871}\label{class_ogre_1_1_plane_bounded_volume_a9f3907950c9fd279e01ac1d4a03d9871}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!PlaneBoundedVolume@{PlaneBoundedVolume}}
\index{PlaneBoundedVolume@{PlaneBoundedVolume}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{PlaneBoundedVolume()}{PlaneBoundedVolume()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Ogre\+::\+Plane\+Bounded\+Volume\+::\+Plane\+Bounded\+Volume (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_a1f07490e0ddb2809e1e2b71a89c23856}\label{class_ogre_1_1_plane_bounded_volume_a1f07490e0ddb2809e1e2b71a89c23856}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!PlaneBoundedVolume@{PlaneBoundedVolume}}
\index{PlaneBoundedVolume@{PlaneBoundedVolume}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{PlaneBoundedVolume()}{PlaneBoundedVolume()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Ogre\+::\+Plane\+Bounded\+Volume\+::\+Plane\+Bounded\+Volume (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_plane_aa5d44b14d6f032f3e0a26e83589180bc}{Plane\+::\+Side}}}]{the\+Outside }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Constructor, determines which side is deemed to be \textquotesingle{}outside\textquotesingle{}. 



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_ac92a3d627da4cadbc9ebe7331b368e6e}\label{class_ogre_1_1_plane_bounded_volume_ac92a3d627da4cadbc9ebe7331b368e6e}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!intersects@{intersects}}
\index{intersects@{intersects}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{intersects()}{intersects()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily bool Ogre\+::\+Plane\+Bounded\+Volume\+::intersects (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} \&}]{box }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Intersection test with A\+A\+BB. 

\begin{DoxyRemark}{Remarks}
May return false positives but will never miss an intersection. 
\end{DoxyRemark}


References Ogre\+::\+Axis\+Aligned\+Box\+::get\+Center(), Ogre\+::\+Axis\+Aligned\+Box\+::get\+Half\+Size(), Ogre\+::\+Plane\+::get\+Side(), Ogre\+::\+Axis\+Aligned\+Box\+::is\+Infinite(), and Ogre\+::\+Axis\+Aligned\+Box\+::is\+Null().

\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_a2381ee685a1657cb601f1859ed8bc9b0}\label{class_ogre_1_1_plane_bounded_volume_a2381ee685a1657cb601f1859ed8bc9b0}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!intersects@{intersects}}
\index{intersects@{intersects}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{intersects()}{intersects()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily bool Ogre\+::\+Plane\+Bounded\+Volume\+::intersects (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}} \&}]{sphere }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Intersection test with \mbox{\hyperlink{class_ogre_1_1_sphere}{Sphere}}. 

\begin{DoxyRemark}{Remarks}
May return false positives but will never miss an intersection. 
\end{DoxyRemark}


References Ogre\+::\+Sphere\+::get\+Center(), Ogre\+::\+Plane\+::get\+Distance(), Ogre\+::\+Sphere\+::get\+Radius(), and Ogre\+::\+Plane\+::\+N\+E\+G\+A\+T\+I\+V\+E\+\_\+\+S\+I\+DE.

\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_ae4528e95f68402ad6fea0ff6414dbeb7}\label{class_ogre_1_1_plane_bounded_volume_ae4528e95f68402ad6fea0ff6414dbeb7}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!intersects@{intersects}}
\index{intersects@{intersects}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{intersects()}{intersects()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily std\+::pair$<$bool, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}$>$ Ogre\+::\+Plane\+Bounded\+Volume\+::intersects (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_ray}{Ray}} \&}]{ray }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Intersection test with a \mbox{\hyperlink{class_ogre_1_1_ray}{Ray}}. 

\begin{DoxyReturn}{Returns}
std\+::pair of hit (bool) and distance 
\end{DoxyReturn}
\begin{DoxyRemark}{Remarks}
May return false positives but will never miss an intersection. 
\end{DoxyRemark}


References Ogre\+::\+Math\+::intersects(), and Ogre\+::\+Plane\+::\+P\+O\+S\+I\+T\+I\+V\+E\+\_\+\+S\+I\+DE.



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_a20b9a9b8d76a970c5f6cbac4cb438054}\label{class_ogre_1_1_plane_bounded_volume_a20b9a9b8d76a970c5f6cbac4cb438054}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!planes@{planes}}
\index{planes@{planes}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{planes}{planes}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_plane_bounded_volume_adffb808d81baf5b8342fc8959e8123bf}{Plane\+List}} Ogre\+::\+Plane\+Bounded\+Volume\+::planes}



Publicly accessible plane list, you can modify this direct. 



Referenced by Ogre\+::\+Ray\+::intersects().

\mbox{\Hypertarget{class_ogre_1_1_plane_bounded_volume_a4d323aac2569fdb268dd6dda2801896e}\label{class_ogre_1_1_plane_bounded_volume_a4d323aac2569fdb268dd6dda2801896e}} 
\index{Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}!outside@{outside}}
\index{outside@{outside}!Ogre::PlaneBoundedVolume@{Ogre::PlaneBoundedVolume}}
\doxysubsubsection{\texorpdfstring{outside}{outside}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_plane_aa5d44b14d6f032f3e0a26e83589180bc}{Plane\+::\+Side}} Ogre\+::\+Plane\+Bounded\+Volume\+::outside}



Referenced by Ogre\+::\+Ray\+::intersects().



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_plane_bounded_volume_8h}{Ogre\+Plane\+Bounded\+Volume.\+h}}\end{DoxyCompactItemize}
