\hypertarget{class_ogre_1_1_bsp_node}{}\section{Ogre\+:\+:Bsp\+Node Class Reference}
\label{class_ogre_1_1_bsp_node}\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}


Encapsulates a node in a B\+SP tree.  




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



Inheritance diagram for Ogre\+:\+:Bsp\+Node\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=169pt]{class_ogre_1_1_bsp_node__inherit__graph}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{struct_ogre_1_1_bsp_node_1_1_brush}{Brush}
\end{DoxyCompactItemize}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef std\+::set$<$ const \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} $\ast$ $>$ \hyperlink{class_ogre_1_1_bsp_node_ab84d20216766664f21528d05874b85fd}{Intersecting\+Object\+Set}
\item 
typedef std\+::vector$<$ \hyperlink{struct_ogre_1_1_bsp_node_1_1_brush}{Brush} $\ast$ $>$ \hyperlink{class_ogre_1_1_bsp_node_ae3d22295df76fd693f56386db2ccaa15}{Node\+Brush\+List}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_bsp_node_a39b74504f7252462d27f69bbeef5dc99}{Bsp\+Node} (\hyperlink{class_ogre_1_1_bsp_level}{Bsp\+Level} $\ast$owner, bool \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf})
\begin{DoxyCompactList}\small\item\em Constructor, only to be used by \hyperlink{class_ogre_1_1_bsp_level}{Bsp\+Level}. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_bsp_node_a10395588ed29a1d34e3b028643dd2d77}{Bsp\+Node} ()
\item 
\hyperlink{class_ogre_1_1_bsp_node_a74871a4318ee6f0bfdf068a988bc2496}{$\sim$\+Bsp\+Node} ()
\item 
void \hyperlink{class_ogre_1_1_bsp_node_ac5702538be4c791af37cd73d2aa353a5}{\+\_\+add\+Movable} (const \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} $\ast$mov)
\begin{DoxyCompactList}\small\item\em Internal method for telling the node that a movable intersects it. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_bsp_node_aa10efd90b923c891eba69bad3b06d450}{\+\_\+remove\+Movable} (const \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} $\ast$mov)
\begin{DoxyCompactList}\small\item\em Internal method for telling the node that a movable no longer intersects it. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} $\ast$ \hyperlink{class_ogre_1_1_bsp_node_a943797f8b1e7d04f7593c3e732972460}{get\+Back} (void) const
\begin{DoxyCompactList}\small\item\em Returns a pointer to a \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} containing the subspace on the negative side of the splitting plane. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box} \& \hyperlink{class_ogre_1_1_bsp_node_a29d9e0048384c0a8895a79d75bfc8ec2}{get\+Bounding\+Box} (void) const
\begin{DoxyCompactList}\small\item\em Returns the axis-\/aligned box which contains this node if it is a leaf. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_bsp_node_adb496664856e47c5ac433dce45ec83f8}{get\+Distance} (const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&pos) const
\begin{DoxyCompactList}\small\item\em Gets the signed distance to the dividing plane. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_bsp_node_aec9a1bc496cd833f81869079741a122b}{get\+Face\+Group\+Start} (void) const
\begin{DoxyCompactList}\small\item\em Returns the index to the face group index list for this leaf node. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} $\ast$ \hyperlink{class_ogre_1_1_bsp_node_ae79ffff46af0c8df473e4cf16e4f3a43}{get\+Front} (void) const
\begin{DoxyCompactList}\small\item\em Returns a pointer to a \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} containing the subspace on the positive side of the splitting plane. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} $\ast$ \hyperlink{class_ogre_1_1_bsp_node_a9c549e6cac556e398aaccd83a9ace52c}{get\+Next\+Node} (const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&point) const
\begin{DoxyCompactList}\small\item\em Gets the next node down in the tree, with the intention of locating the leaf containing the given point. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_bsp_node_aaf0f3cd4f006d876302502182569ecee}{get\+Num\+Face\+Groups} (void) const
\begin{DoxyCompactList}\small\item\em Returns the number of faces contained in this leaf node. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_bsp_node_ab84d20216766664f21528d05874b85fd}{Intersecting\+Object\+Set} \& \hyperlink{class_ogre_1_1_bsp_node_ab13aab15a8670d2aac451da8b97251cc}{get\+Objects} (void) const
\item 
\hyperlink{class_ogre_1_1_plane_aa5d44b14d6f032f3e0a26e83589180bc}{Plane\+::\+Side} \hyperlink{class_ogre_1_1_bsp_node_ae4dd978cc8a7a6bcd35921d9ee37c5c7}{get\+Side} (const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&point) const
\begin{DoxyCompactList}\small\item\em Determines which side of the splitting plane a worldspace point is. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_bsp_node_ae3d22295df76fd693f56386db2ccaa15}{Node\+Brush\+List} \& \hyperlink{class_ogre_1_1_bsp_node_ac31674d044317b6e900efe52acb0439f}{get\+Solid\+Brushes} (void) const
\begin{DoxyCompactList}\small\item\em Main brush memory held on level. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_plane}{Plane} \& \hyperlink{class_ogre_1_1_bsp_node_aaf82d30b03b4819d3f4cd161ca53f3bf}{get\+Split\+Plane} (void) const
\begin{DoxyCompactList}\small\item\em Returns details of the plane which is used to subdivide the space of his node\textquotesingle{}s children. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if this node is a leaf (i.\+e. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_bsp_node_a89db45619ae315c31cd3880aad56b94c}{is\+Leaf\+Visible} (const \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} $\ast$leaf) const
\begin{DoxyCompactList}\small\item\em Determines if the passed in node (must also be a leaf) is visible from this leaf. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Friends}
\begin{DoxyCompactItemize}
\item 
class \hyperlink{class_ogre_1_1_bsp_node_a8c663a45872e4b89850c3ba482beaef5}{Bsp\+Level}
\item 
std\+::ostream \& \hyperlink{class_ogre_1_1_bsp_node_a1092a75e646a2cecdd62b54da97a09bc}{operator$<$$<$} (std\+::ostream \&o, \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} \&n)
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Encapsulates a node in a B\+SP tree. 

A B\+SP tree represents space partitioned by planes . The space which is partitioned is either the world (in the case of the root node) or the space derived from their parent node. Each node can have elements which are in front or behind it, which are it\textquotesingle{}s children and these elements can either be further subdivided by planes, or they can be undivided spaces or \textquotesingle{}leaf nodes\textquotesingle{} -\/ these are the nodes which actually contain objects and world geometry.\+The leaves of the tree are the stopping point of any tree walking algorithm, both for rendering and collision detection etc. \hyperlink{namespace_ogre}{Ogre} chooses not to represent splitting nodes and leaves as separate structures, but to merge the two for simplicity of the walking algorithm. If a node is a leaf, the \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf()} method returns true and both \hyperlink{class_ogre_1_1_bsp_node_ae79ffff46af0c8df473e4cf16e4f3a43}{get\+Front()} and \hyperlink{class_ogre_1_1_bsp_node_a943797f8b1e7d04f7593c3e732972460}{get\+Back()} return null pointers. If the node is a partitioning plane \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf()} returns false and \hyperlink{class_ogre_1_1_bsp_node_ae79ffff46af0c8df473e4cf16e4f3a43}{get\+Front()} and \hyperlink{class_ogre_1_1_bsp_node_a943797f8b1e7d04f7593c3e732972460}{get\+Back()} will return the corresponding \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} objects. 

\subsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_bsp_node_ab84d20216766664f21528d05874b85fd}\label{class_ogre_1_1_bsp_node_ab84d20216766664f21528d05874b85fd}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!Intersecting\+Object\+Set@{Intersecting\+Object\+Set}}
\index{Intersecting\+Object\+Set@{Intersecting\+Object\+Set}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{Intersecting\+Object\+Set}{IntersectingObjectSet}}
{\footnotesize\ttfamily typedef std\+::set$<$const \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object}$\ast$$>$ \hyperlink{class_ogre_1_1_bsp_node_ab84d20216766664f21528d05874b85fd}{Ogre\+::\+Bsp\+Node\+::\+Intersecting\+Object\+Set}}

\mbox{\Hypertarget{class_ogre_1_1_bsp_node_ae3d22295df76fd693f56386db2ccaa15}\label{class_ogre_1_1_bsp_node_ae3d22295df76fd693f56386db2ccaa15}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!Node\+Brush\+List@{Node\+Brush\+List}}
\index{Node\+Brush\+List@{Node\+Brush\+List}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{Node\+Brush\+List}{NodeBrushList}}
{\footnotesize\ttfamily typedef std\+::vector$<$\hyperlink{struct_ogre_1_1_bsp_node_1_1_brush}{Brush}$\ast$$>$ \hyperlink{class_ogre_1_1_bsp_node_ae3d22295df76fd693f56386db2ccaa15}{Ogre\+::\+Bsp\+Node\+::\+Node\+Brush\+List}}



\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_bsp_node_a39b74504f7252462d27f69bbeef5dc99}\label{class_ogre_1_1_bsp_node_a39b74504f7252462d27f69bbeef5dc99}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!Bsp\+Node@{Bsp\+Node}}
\index{Bsp\+Node@{Bsp\+Node}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{Bsp\+Node()}{BspNode()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Ogre\+::\+Bsp\+Node\+::\+Bsp\+Node (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_bsp_level}{Bsp\+Level} $\ast$}]{owner,  }\item[{bool}]{is\+Leaf }\end{DoxyParamCaption})}



Constructor, only to be used by \hyperlink{class_ogre_1_1_bsp_level}{Bsp\+Level}. 

\mbox{\Hypertarget{class_ogre_1_1_bsp_node_a10395588ed29a1d34e3b028643dd2d77}\label{class_ogre_1_1_bsp_node_a10395588ed29a1d34e3b028643dd2d77}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!Bsp\+Node@{Bsp\+Node}}
\index{Bsp\+Node@{Bsp\+Node}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{Bsp\+Node()}{BspNode()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Ogre\+::\+Bsp\+Node\+::\+Bsp\+Node (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_bsp_node_a74871a4318ee6f0bfdf068a988bc2496}\label{class_ogre_1_1_bsp_node_a74871a4318ee6f0bfdf068a988bc2496}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!````~Bsp\+Node@{$\sim$\+Bsp\+Node}}
\index{````~Bsp\+Node@{$\sim$\+Bsp\+Node}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{$\sim$\+Bsp\+Node()}{~BspNode()}}
{\footnotesize\ttfamily Ogre\+::\+Bsp\+Node\+::$\sim$\+Bsp\+Node (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}\label{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!is\+Leaf@{is\+Leaf}}
\index{is\+Leaf@{is\+Leaf}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{is\+Leaf()}{isLeaf()}}
{\footnotesize\ttfamily bool Ogre\+::\+Bsp\+Node\+::is\+Leaf (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns true if this node is a leaf (i.\+e. 

contains geometry) or false if it is a splitting plane. A \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} can either be a splitting plane (the typical representation of a B\+SP node) or an undivided region contining geometry (a leaf node). \hyperlink{namespace_ogre}{Ogre} represents both using the same class for simplicity of tree walking. However it is important that you use this method to determine which type you are dealing with, since certain methods are only supported with one of the subtypes. Details are given in the individual methods. Note that I could have represented splitting / leaf nodes as a class hierarchy but the virtual methods / run-\/time type identification would have a performance hit, and it would not make the code much (any?) simpler anyway. I think this is a fair trade-\/off in this case. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_ae79ffff46af0c8df473e4cf16e4f3a43}\label{class_ogre_1_1_bsp_node_ae79ffff46af0c8df473e4cf16e4f3a43}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Front@{get\+Front}}
\index{get\+Front@{get\+Front}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Front()}{getFront()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node}$\ast$ Ogre\+::\+Bsp\+Node\+::get\+Front (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns a pointer to a \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} containing the subspace on the positive side of the splitting plane. 

This method should only be called on a splitting node, i.\+e. where \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf()} returns false. Calling this method on a leaf node will throw an exception. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_a943797f8b1e7d04f7593c3e732972460}\label{class_ogre_1_1_bsp_node_a943797f8b1e7d04f7593c3e732972460}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Back@{get\+Back}}
\index{get\+Back@{get\+Back}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Back()}{getBack()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node}$\ast$ Ogre\+::\+Bsp\+Node\+::get\+Back (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns a pointer to a \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} containing the subspace on the negative side of the splitting plane. 

This method should only be called on a splitting node, i.\+e. where \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf()} returns false. Calling this method on a leaf node will throw an exception. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_ae4dd978cc8a7a6bcd35921d9ee37c5c7}\label{class_ogre_1_1_bsp_node_ae4dd978cc8a7a6bcd35921d9ee37c5c7}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Side@{get\+Side}}
\index{get\+Side@{get\+Side}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Side()}{getSide()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_plane_aa5d44b14d6f032f3e0a26e83589180bc}{Plane\+::\+Side} Ogre\+::\+Bsp\+Node\+::get\+Side (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&}]{point }\end{DoxyParamCaption}) const}



Determines which side of the splitting plane a worldspace point is. 

This method should only be called on a splitting node, i.\+e. where \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf()} returns false. Calling this method on a leaf node will throw an exception. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_a9c549e6cac556e398aaccd83a9ace52c}\label{class_ogre_1_1_bsp_node_a9c549e6cac556e398aaccd83a9ace52c}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Next\+Node@{get\+Next\+Node}}
\index{get\+Next\+Node@{get\+Next\+Node}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Next\+Node()}{getNextNode()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node}$\ast$ Ogre\+::\+Bsp\+Node\+::get\+Next\+Node (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&}]{point }\end{DoxyParamCaption}) const}



Gets the next node down in the tree, with the intention of locating the leaf containing the given point. 

This method should only be called on a splitting node, i.\+e. where \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf()} returns false. Calling this method on a leaf node will throw an exception. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_aaf82d30b03b4819d3f4cd161ca53f3bf}\label{class_ogre_1_1_bsp_node_aaf82d30b03b4819d3f4cd161ca53f3bf}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Split\+Plane@{get\+Split\+Plane}}
\index{get\+Split\+Plane@{get\+Split\+Plane}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Split\+Plane()}{getSplitPlane()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_plane}{Plane}\& Ogre\+::\+Bsp\+Node\+::get\+Split\+Plane (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns details of the plane which is used to subdivide the space of his node\textquotesingle{}s children. 

This method should only be called on a splitting node, i.\+e. where \hyperlink{class_ogre_1_1_bsp_node_aaeb2ac6a36ce7bbfb351f272ff724cf8}{is\+Leaf()} returns false. Calling this method on a leaf node will throw an exception. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_a29d9e0048384c0a8895a79d75bfc8ec2}\label{class_ogre_1_1_bsp_node_a29d9e0048384c0a8895a79d75bfc8ec2}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Bounding\+Box@{get\+Bounding\+Box}}
\index{get\+Bounding\+Box@{get\+Bounding\+Box}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Bounding\+Box()}{getBoundingBox()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}\& Ogre\+::\+Bsp\+Node\+::get\+Bounding\+Box (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns the axis-\/aligned box which contains this node if it is a leaf. 

This method should only be called on a leaf node. It returns a box which can be used in calls like \hyperlink{class_ogre_1_1_camera_a71fff8dac8cbf9bd3911e49a484fa61c}{Camera\+::is\+Visible} to determine if the leaf node is visible in the view. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_aaf0f3cd4f006d876302502182569ecee}\label{class_ogre_1_1_bsp_node_aaf0f3cd4f006d876302502182569ecee}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Num\+Face\+Groups@{get\+Num\+Face\+Groups}}
\index{get\+Num\+Face\+Groups@{get\+Num\+Face\+Groups}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Num\+Face\+Groups()}{getNumFaceGroups()}}
{\footnotesize\ttfamily int Ogre\+::\+Bsp\+Node\+::get\+Num\+Face\+Groups (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns the number of faces contained in this leaf node. 

Should only be called on a leaf node. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_aec9a1bc496cd833f81869079741a122b}\label{class_ogre_1_1_bsp_node_aec9a1bc496cd833f81869079741a122b}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Face\+Group\+Start@{get\+Face\+Group\+Start}}
\index{get\+Face\+Group\+Start@{get\+Face\+Group\+Start}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Face\+Group\+Start()}{getFaceGroupStart()}}
{\footnotesize\ttfamily int Ogre\+::\+Bsp\+Node\+::get\+Face\+Group\+Start (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns the index to the face group index list for this leaf node. 

The contents of this buffer is a list of indexes which point to the actual face groups held in a central buffer in the \hyperlink{class_ogre_1_1_bsp_level}{Bsp\+Level} class (in actual fact for efficiency the indexes themselves are also held in a single buffer in \hyperlink{class_ogre_1_1_bsp_level}{Bsp\+Level} too). The reason for this indirection is that the buffer of indexes to face groups is organised in chunks relative to nodes, whilst the main buffer of face groups may not be. Should only be called on a leaf node. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_a89db45619ae315c31cd3880aad56b94c}\label{class_ogre_1_1_bsp_node_a89db45619ae315c31cd3880aad56b94c}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!is\+Leaf\+Visible@{is\+Leaf\+Visible}}
\index{is\+Leaf\+Visible@{is\+Leaf\+Visible}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{is\+Leaf\+Visible()}{isLeafVisible()}}
{\footnotesize\ttfamily bool Ogre\+::\+Bsp\+Node\+::is\+Leaf\+Visible (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} $\ast$}]{leaf }\end{DoxyParamCaption}) const}



Determines if the passed in node (must also be a leaf) is visible from this leaf. 

Must only be called on a leaf node, and the parameter must also be a leaf node. If this method returns true, then the leaf passed in is visible from this leaf. Note that internally this uses the Potentially Visible Set (P\+VS) which is precalculated and stored with the B\+SP level. \mbox{\Hypertarget{class_ogre_1_1_bsp_node_ac5702538be4c791af37cd73d2aa353a5}\label{class_ogre_1_1_bsp_node_ac5702538be4c791af37cd73d2aa353a5}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!\+\_\+add\+Movable@{\+\_\+add\+Movable}}
\index{\+\_\+add\+Movable@{\+\_\+add\+Movable}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{\+\_\+add\+Movable()}{\_addMovable()}}
{\footnotesize\ttfamily void Ogre\+::\+Bsp\+Node\+::\+\_\+add\+Movable (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} $\ast$}]{mov }\end{DoxyParamCaption})}



Internal method for telling the node that a movable intersects it. 

\mbox{\Hypertarget{class_ogre_1_1_bsp_node_aa10efd90b923c891eba69bad3b06d450}\label{class_ogre_1_1_bsp_node_aa10efd90b923c891eba69bad3b06d450}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!\+\_\+remove\+Movable@{\+\_\+remove\+Movable}}
\index{\+\_\+remove\+Movable@{\+\_\+remove\+Movable}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{\+\_\+remove\+Movable()}{\_removeMovable()}}
{\footnotesize\ttfamily void Ogre\+::\+Bsp\+Node\+::\+\_\+remove\+Movable (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} $\ast$}]{mov }\end{DoxyParamCaption})}



Internal method for telling the node that a movable no longer intersects it. 

\mbox{\Hypertarget{class_ogre_1_1_bsp_node_adb496664856e47c5ac433dce45ec83f8}\label{class_ogre_1_1_bsp_node_adb496664856e47c5ac433dce45ec83f8}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Distance@{get\+Distance}}
\index{get\+Distance@{get\+Distance}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Distance()}{getDistance()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Bsp\+Node\+::get\+Distance (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&}]{pos }\end{DoxyParamCaption}) const}



Gets the signed distance to the dividing plane. 

\mbox{\Hypertarget{class_ogre_1_1_bsp_node_ac31674d044317b6e900efe52acb0439f}\label{class_ogre_1_1_bsp_node_ac31674d044317b6e900efe52acb0439f}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Solid\+Brushes@{get\+Solid\+Brushes}}
\index{get\+Solid\+Brushes@{get\+Solid\+Brushes}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Solid\+Brushes()}{getSolidBrushes()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_bsp_node_ae3d22295df76fd693f56386db2ccaa15}{Node\+Brush\+List}\& Ogre\+::\+Bsp\+Node\+::get\+Solid\+Brushes (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Main brush memory held on level. 

Get the list of solid Brushes for this node. \begin{DoxyRemark}{Remarks}
Only applicable for leaf nodes. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_bsp_node_ab13aab15a8670d2aac451da8b97251cc}\label{class_ogre_1_1_bsp_node_ab13aab15a8670d2aac451da8b97251cc}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!get\+Objects@{get\+Objects}}
\index{get\+Objects@{get\+Objects}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{get\+Objects()}{getObjects()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_bsp_node_ab84d20216766664f21528d05874b85fd}{Intersecting\+Object\+Set}\& Ogre\+::\+Bsp\+Node\+::get\+Objects (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



\subsection{Friends And Related Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_bsp_node_a8c663a45872e4b89850c3ba482beaef5}\label{class_ogre_1_1_bsp_node_a8c663a45872e4b89850c3ba482beaef5}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!Bsp\+Level@{Bsp\+Level}}
\index{Bsp\+Level@{Bsp\+Level}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{Bsp\+Level}{BspLevel}}
{\footnotesize\ttfamily friend class \hyperlink{class_ogre_1_1_bsp_level}{Bsp\+Level}\hspace{0.3cm}{\ttfamily [friend]}}

\mbox{\Hypertarget{class_ogre_1_1_bsp_node_a1092a75e646a2cecdd62b54da97a09bc}\label{class_ogre_1_1_bsp_node_a1092a75e646a2cecdd62b54da97a09bc}} 
\index{Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}!operator$<$$<$@{operator$<$$<$}}
\index{operator$<$$<$@{operator$<$$<$}!Ogre\+::\+Bsp\+Node@{Ogre\+::\+Bsp\+Node}}
\subsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
{\footnotesize\ttfamily std\+::ostream\& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{o,  }\item[{\hyperlink{class_ogre_1_1_bsp_node}{Bsp\+Node} \&}]{n }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_bsp_node_8h}{Ogre\+Bsp\+Node.\+h}\end{DoxyCompactItemize}
