\hypertarget{class_ogre_1_1_bsp_ray_scene_query}{}\section{Ogre\+:\+:Bsp\+Ray\+Scene\+Query Class Reference}
\label{class_ogre_1_1_bsp_ray_scene_query}\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}


B\+SP specialisation of \hyperlink{class_ogre_1_1_ray_scene_query}{Ray\+Scene\+Query}.  




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



Inheritance diagram for Ogre\+:\+:Bsp\+Ray\+Scene\+Query\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_bsp_ray_scene_query__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{World\+Fragment\+Type} \{ \newline
\hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa6ed287fab168d451beb369009f0fd03b}{W\+F\+T\+\_\+\+N\+O\+NE}, 
\hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa667bbec7031e58ab244f9efc32056f38}{W\+F\+T\+\_\+\+P\+L\+A\+N\+E\+\_\+\+B\+O\+U\+N\+D\+E\+D\+\_\+\+R\+E\+G\+I\+ON}, 
\hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa018493b6c87271e0c8ba014f058cffd3}{W\+F\+T\+\_\+\+S\+I\+N\+G\+L\+E\+\_\+\+I\+N\+T\+E\+R\+S\+E\+C\+T\+I\+ON}, 
\hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aadeefa0cc2dfd1ec783c2a266ea61f925}{W\+F\+T\+\_\+\+C\+U\+S\+T\+O\+M\+\_\+\+G\+E\+O\+M\+E\+T\+RY}, 
\newline
\hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aad498944c8c6b81d737c3ceee86881e8d}{W\+F\+T\+\_\+\+R\+E\+N\+D\+E\+R\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON}
 \}\begin{DoxyCompactList}\small\item\em This type can be used by collaborating applications \& Scene\+Managers to agree on the type of world geometry to be returned from queries. \end{DoxyCompactList}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_bsp_ray_scene_query_ae28099aef7f983a042efde7e298295b9}{Bsp\+Ray\+Scene\+Query} (\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} $\ast$creator)
\item 
\hyperlink{class_ogre_1_1_bsp_ray_scene_query_af688336da3971472963b32e52b17d251}{$\sim$\+Bsp\+Ray\+Scene\+Query} ()
\item 
virtual void \hyperlink{class_ogre_1_1_ray_scene_query_ae93bb5dafd039eb08c44cd42215c34c4}{clear\+Results} (void)
\begin{DoxyCompactList}\small\item\em Clears the results of the last query execution. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_bsp_ray_scene_query_a0c98549a0b1e7db7d54c6bbfc4f46d8f}{execute} (\hyperlink{class_ogre_1_1_ray_scene_query_listener}{Ray\+Scene\+Query\+Listener} $\ast$listener)
\begin{DoxyCompactList}\small\item\em See \hyperlink{class_ogre_1_1_ray_scene_query}{Ray\+Scene\+Query}. \end{DoxyCompactList}\item 
virtual \hyperlink{group___scene_gad131001f847e434a637a4e217d61cf7d}{Ray\+Scene\+Query\+Result} \& \hyperlink{class_ogre_1_1_ray_scene_query_ad5087789b2926c64033a6bc61f78476c}{execute} (void)
\begin{DoxyCompactList}\small\item\em Executes the query, returning the results back in one list. \end{DoxyCompactList}\item 
virtual \hyperlink{group___scene_gad131001f847e434a637a4e217d61cf7d}{Ray\+Scene\+Query\+Result} \& \hyperlink{class_ogre_1_1_ray_scene_query_aef129845061d1bdfb9cb92a75c531a63}{get\+Last\+Results} (void)
\begin{DoxyCompactList}\small\item\em Gets the results of the last query that was run using this object, provided the query was executed using the collection-\/returning version of execute. \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} \hyperlink{class_ogre_1_1_ray_scene_query_ae36fdbcb7dd13085b245f7a565a3ef54}{get\+Max\+Results} (void) const
\begin{DoxyCompactList}\small\item\em Gets the maximum number of results returned from the query (only relevant if results are being sorted) \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{class_ogre_1_1_scene_query_aed7b296e80ea3acebc493842727e8db3}{get\+Query\+Mask} (void) const
\begin{DoxyCompactList}\small\item\em Returns the current mask for this query. \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{class_ogre_1_1_scene_query_a47fac5b11f62901c14b1bd757ea5c14b}{get\+Query\+Type\+Mask} (void) const
\begin{DoxyCompactList}\small\item\em Returns the current mask for this query. \end{DoxyCompactList}\item 
virtual const \hyperlink{class_ogre_1_1_ray}{Ray} \& \hyperlink{class_ogre_1_1_ray_scene_query_a8192b4ff0e26fe16647be6d0482fc51b}{get\+Ray} (void) const
\begin{DoxyCompactList}\small\item\em Gets the ray which is to be used for this query. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_ray_scene_query_a77a386c0c29bb49f1138c447d13489ea}{get\+Sort\+By\+Distance} (void) const
\begin{DoxyCompactList}\small\item\em Gets whether the results are sorted by distance. \end{DoxyCompactList}\item 
virtual const std\+::set$<$ \hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{World\+Fragment\+Type} $>$ $\ast$ \hyperlink{class_ogre_1_1_scene_query_acceb4087f3a6ed148ae92f7e39fd1179}{get\+Supported\+World\+Fragment\+Types} (void) const
\begin{DoxyCompactList}\small\item\em Returns the types of world fragments this query supports. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{World\+Fragment\+Type} \hyperlink{class_ogre_1_1_scene_query_acffb9330fc3de7109f8274822e362b00}{get\+World\+Fragment\+Type} (void) const
\begin{DoxyCompactList}\small\item\em Gets the current world fragment types to be returned from the query. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_ray_scene_query_a88c9810df53d94b893bc5aef885d14a1}{query\+Result} (\hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} $\ast$obj, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} distance)
\begin{DoxyCompactList}\small\item\em Self-\/callback in order to deal with execute which returns collection. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_ray_scene_query_abd5211784dd04e0e0705fe21d43cb900}{query\+Result} (\hyperlink{struct_ogre_1_1_scene_query_1_1_world_fragment}{Scene\+Query\+::\+World\+Fragment} $\ast$fragment, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} distance)
\begin{DoxyCompactList}\small\item\em Self-\/callback in order to deal with execute which returns collection. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_scene_query_ad392a7fc0b338e5507540d3183f82cfb}{set\+Query\+Mask} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} mask)
\begin{DoxyCompactList}\small\item\em Sets the mask for results of this query. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_scene_query_abaca8d4d9b59a571e2d8e9a2cac7ce42}{set\+Query\+Type\+Mask} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} mask)
\begin{DoxyCompactList}\small\item\em Sets the type mask for results of this query. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_ray_scene_query_a5a96085659aec2c0df9c271f4372a74a}{set\+Ray} (const \hyperlink{class_ogre_1_1_ray}{Ray} \&ray)
\begin{DoxyCompactList}\small\item\em Sets the ray which is to be used for this query. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_ray_scene_query_a32f960cc88fd644922bfc4c58643f993}{set\+Sort\+By\+Distance} (bool sort, \hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} maxresults=0)
\begin{DoxyCompactList}\small\item\em Sets whether the results of this query will be sorted by distance along the ray. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_scene_query_aec3aa0b8b16c41fae990ee78150f8d2a}{set\+World\+Fragment\+Type} (enum \hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{World\+Fragment\+Type} wft)
\begin{DoxyCompactList}\small\item\em Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
B\+SP specialisation of \hyperlink{class_ogre_1_1_ray_scene_query}{Ray\+Scene\+Query}. 

\subsection{Member Enumeration Documentation}
\mbox{\Hypertarget{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}\label{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!World\+Fragment\+Type@{World\+Fragment\+Type}}
\index{World\+Fragment\+Type@{World\+Fragment\+Type}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{World\+Fragment\+Type}{WorldFragmentType}}
{\footnotesize\ttfamily enum \hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{Ogre\+::\+Scene\+Query\+::\+World\+Fragment\+Type}\hspace{0.3cm}{\ttfamily [inherited]}}



This type can be used by collaborating applications \& Scene\+Managers to agree on the type of world geometry to be returned from queries. 

Not all these types will be supported by all Scene\+Managers; once the application has decided which \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} specialisation to use, it is expected that it will know which type of world geometry abstraction is available to it. \begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{W\+F\+T\+\_\+\+N\+O\+NE@{W\+F\+T\+\_\+\+N\+O\+NE}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!W\+F\+T\+\_\+\+N\+O\+NE@{W\+F\+T\+\_\+\+N\+O\+NE}}}\mbox{\Hypertarget{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa6ed287fab168d451beb369009f0fd03b}\label{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa6ed287fab168d451beb369009f0fd03b}} 
W\+F\+T\+\_\+\+N\+O\+NE&Return no world geometry hits at all. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{W\+F\+T\+\_\+\+P\+L\+A\+N\+E\+\_\+\+B\+O\+U\+N\+D\+E\+D\+\_\+\+R\+E\+G\+I\+ON@{W\+F\+T\+\_\+\+P\+L\+A\+N\+E\+\_\+\+B\+O\+U\+N\+D\+E\+D\+\_\+\+R\+E\+G\+I\+ON}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!W\+F\+T\+\_\+\+P\+L\+A\+N\+E\+\_\+\+B\+O\+U\+N\+D\+E\+D\+\_\+\+R\+E\+G\+I\+ON@{W\+F\+T\+\_\+\+P\+L\+A\+N\+E\+\_\+\+B\+O\+U\+N\+D\+E\+D\+\_\+\+R\+E\+G\+I\+ON}}}\mbox{\Hypertarget{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa667bbec7031e58ab244f9efc32056f38}\label{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa667bbec7031e58ab244f9efc32056f38}} 
W\+F\+T\+\_\+\+P\+L\+A\+N\+E\+\_\+\+B\+O\+U\+N\+D\+E\+D\+\_\+\+R\+E\+G\+I\+ON&Return pointers to convex plane-\/bounded regions. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{W\+F\+T\+\_\+\+S\+I\+N\+G\+L\+E\+\_\+\+I\+N\+T\+E\+R\+S\+E\+C\+T\+I\+ON@{W\+F\+T\+\_\+\+S\+I\+N\+G\+L\+E\+\_\+\+I\+N\+T\+E\+R\+S\+E\+C\+T\+I\+ON}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!W\+F\+T\+\_\+\+S\+I\+N\+G\+L\+E\+\_\+\+I\+N\+T\+E\+R\+S\+E\+C\+T\+I\+ON@{W\+F\+T\+\_\+\+S\+I\+N\+G\+L\+E\+\_\+\+I\+N\+T\+E\+R\+S\+E\+C\+T\+I\+ON}}}\mbox{\Hypertarget{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa018493b6c87271e0c8ba014f058cffd3}\label{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aa018493b6c87271e0c8ba014f058cffd3}} 
W\+F\+T\+\_\+\+S\+I\+N\+G\+L\+E\+\_\+\+I\+N\+T\+E\+R\+S\+E\+C\+T\+I\+ON&Return a single intersection point (typically \hyperlink{class_ogre_1_1_ray_scene_query}{Ray\+Scene\+Query} only) \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{W\+F\+T\+\_\+\+C\+U\+S\+T\+O\+M\+\_\+\+G\+E\+O\+M\+E\+T\+RY@{W\+F\+T\+\_\+\+C\+U\+S\+T\+O\+M\+\_\+\+G\+E\+O\+M\+E\+T\+RY}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!W\+F\+T\+\_\+\+C\+U\+S\+T\+O\+M\+\_\+\+G\+E\+O\+M\+E\+T\+RY@{W\+F\+T\+\_\+\+C\+U\+S\+T\+O\+M\+\_\+\+G\+E\+O\+M\+E\+T\+RY}}}\mbox{\Hypertarget{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aadeefa0cc2dfd1ec783c2a266ea61f925}\label{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aadeefa0cc2dfd1ec783c2a266ea61f925}} 
W\+F\+T\+\_\+\+C\+U\+S\+T\+O\+M\+\_\+\+G\+E\+O\+M\+E\+T\+RY&Custom geometry as defined by the \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{W\+F\+T\+\_\+\+R\+E\+N\+D\+E\+R\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON@{W\+F\+T\+\_\+\+R\+E\+N\+D\+E\+R\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!W\+F\+T\+\_\+\+R\+E\+N\+D\+E\+R\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON@{W\+F\+T\+\_\+\+R\+E\+N\+D\+E\+R\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON}}}\mbox{\Hypertarget{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aad498944c8c6b81d737c3ceee86881e8d}\label{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3aad498944c8c6b81d737c3ceee86881e8d}} 
W\+F\+T\+\_\+\+R\+E\+N\+D\+E\+R\+\_\+\+O\+P\+E\+R\+A\+T\+I\+ON&General \hyperlink{class_ogre_1_1_render_operation}{Render\+Operation} structure. \\
\hline

\end{DoxyEnumFields}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_bsp_ray_scene_query_ae28099aef7f983a042efde7e298295b9}\label{class_ogre_1_1_bsp_ray_scene_query_ae28099aef7f983a042efde7e298295b9}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!Bsp\+Ray\+Scene\+Query@{Bsp\+Ray\+Scene\+Query}}
\index{Bsp\+Ray\+Scene\+Query@{Bsp\+Ray\+Scene\+Query}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{Bsp\+Ray\+Scene\+Query()}{BspRaySceneQuery()}}
{\footnotesize\ttfamily Ogre\+::\+Bsp\+Ray\+Scene\+Query\+::\+Bsp\+Ray\+Scene\+Query (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager} $\ast$}]{creator }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_bsp_ray_scene_query_af688336da3971472963b32e52b17d251}\label{class_ogre_1_1_bsp_ray_scene_query_af688336da3971472963b32e52b17d251}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!````~Bsp\+Ray\+Scene\+Query@{$\sim$\+Bsp\+Ray\+Scene\+Query}}
\index{````~Bsp\+Ray\+Scene\+Query@{$\sim$\+Bsp\+Ray\+Scene\+Query}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{$\sim$\+Bsp\+Ray\+Scene\+Query()}{~BspRaySceneQuery()}}
{\footnotesize\ttfamily Ogre\+::\+Bsp\+Ray\+Scene\+Query\+::$\sim$\+Bsp\+Ray\+Scene\+Query (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_bsp_ray_scene_query_a0c98549a0b1e7db7d54c6bbfc4f46d8f}\label{class_ogre_1_1_bsp_ray_scene_query_a0c98549a0b1e7db7d54c6bbfc4f46d8f}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!execute@{execute}}
\index{execute@{execute}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{execute()}{execute()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Bsp\+Ray\+Scene\+Query\+::execute (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_ray_scene_query_listener}{Ray\+Scene\+Query\+Listener} $\ast$}]{listener }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



See \hyperlink{class_ogre_1_1_ray_scene_query}{Ray\+Scene\+Query}. 



Reimplemented from \hyperlink{class_ogre_1_1_default_ray_scene_query_af653e97b901d83ccc38446fedf5f9885}{Ogre\+::\+Default\+Ray\+Scene\+Query}.

\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_ad5087789b2926c64033a6bc61f78476c}\label{class_ogre_1_1_ray_scene_query_ad5087789b2926c64033a6bc61f78476c}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!execute@{execute}}
\index{execute@{execute}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{execute()}{execute()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual \hyperlink{group___scene_gad131001f847e434a637a4e217d61cf7d}{Ray\+Scene\+Query\+Result}\& Ogre\+::\+Ray\+Scene\+Query\+::execute (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Executes the query, returning the results back in one list. 

\begin{DoxyRemark}{Remarks}
This method executes the scene query as configured, gathers the results into one structure and returns a reference to that structure. These results will also persist in this query object until the next query is executed, or \hyperlink{class_ogre_1_1_ray_scene_query_ae93bb5dafd039eb08c44cd42215c34c4}{clear\+Results()} is called. An more lightweight version of this method that returns results through a listener is also available. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_a5a96085659aec2c0df9c271f4372a74a}\label{class_ogre_1_1_ray_scene_query_a5a96085659aec2c0df9c271f4372a74a}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!set\+Ray@{set\+Ray}}
\index{set\+Ray@{set\+Ray}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{set\+Ray()}{setRay()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Ray\+Scene\+Query\+::set\+Ray (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_ray}{Ray} \&}]{ray }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets the ray which is to be used for this query. 

\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_a8192b4ff0e26fe16647be6d0482fc51b}\label{class_ogre_1_1_ray_scene_query_a8192b4ff0e26fe16647be6d0482fc51b}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+Ray@{get\+Ray}}
\index{get\+Ray@{get\+Ray}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+Ray()}{getRay()}}
{\footnotesize\ttfamily virtual const \hyperlink{class_ogre_1_1_ray}{Ray}\& Ogre\+::\+Ray\+Scene\+Query\+::get\+Ray (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the ray which is to be used for this query. 

\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_a32f960cc88fd644922bfc4c58643f993}\label{class_ogre_1_1_ray_scene_query_a32f960cc88fd644922bfc4c58643f993}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!set\+Sort\+By\+Distance@{set\+Sort\+By\+Distance}}
\index{set\+Sort\+By\+Distance@{set\+Sort\+By\+Distance}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{set\+Sort\+By\+Distance()}{setSortByDistance()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Ray\+Scene\+Query\+::set\+Sort\+By\+Distance (\begin{DoxyParamCaption}\item[{bool}]{sort,  }\item[{\hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort}}]{maxresults = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets whether the results of this query will be sorted by distance along the ray. 

\begin{DoxyRemark}{Remarks}
Often you want to know what was the first object a ray intersected with, and this method allows you to ask the query to sort the results so that the nearest results are listed first. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
Note that because the query returns results based on bounding volumes, the ray may not actually intersect the detail of the objects returned from the query, just their bounding volumes. For this reason the caller is advised to use more detailed intersection tests on the results if a more accurate result is required; O\+G\+RE uses bounds checking in order to give the most speedy results since not all applications need extreme accuracy. 
\end{DoxyParagraph}

\begin{DoxyParams}{Parameters}
{\em sort} & If true, results will be sorted. \\
\hline
{\em maxresults} & If sorting is enabled, this value can be used to constrain the maximum number of results that are returned. Please note (as above) that the use of bounding volumes mean that accuracy is not guaranteed; if in doubt, allow more results and filter them in more detail. 0 means unlimited results. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_a77a386c0c29bb49f1138c447d13489ea}\label{class_ogre_1_1_ray_scene_query_a77a386c0c29bb49f1138c447d13489ea}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+Sort\+By\+Distance@{get\+Sort\+By\+Distance}}
\index{get\+Sort\+By\+Distance@{get\+Sort\+By\+Distance}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+Sort\+By\+Distance()}{getSortByDistance()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Ray\+Scene\+Query\+::get\+Sort\+By\+Distance (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets whether the results are sorted by distance. 

\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_ae36fdbcb7dd13085b245f7a565a3ef54}\label{class_ogre_1_1_ray_scene_query_ae36fdbcb7dd13085b245f7a565a3ef54}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+Max\+Results@{get\+Max\+Results}}
\index{get\+Max\+Results@{get\+Max\+Results}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+Max\+Results()}{getMaxResults()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_af851e71354d841df7138f9877c6f5931}{ushort} Ogre\+::\+Ray\+Scene\+Query\+::get\+Max\+Results (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the maximum number of results returned from the query (only relevant if results are being sorted) 

\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_aef129845061d1bdfb9cb92a75c531a63}\label{class_ogre_1_1_ray_scene_query_aef129845061d1bdfb9cb92a75c531a63}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+Last\+Results@{get\+Last\+Results}}
\index{get\+Last\+Results@{get\+Last\+Results}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+Last\+Results()}{getLastResults()}}
{\footnotesize\ttfamily virtual \hyperlink{group___scene_gad131001f847e434a637a4e217d61cf7d}{Ray\+Scene\+Query\+Result}\& Ogre\+::\+Ray\+Scene\+Query\+::get\+Last\+Results (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the results of the last query that was run using this object, provided the query was executed using the collection-\/returning version of execute. 

\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_ae93bb5dafd039eb08c44cd42215c34c4}\label{class_ogre_1_1_ray_scene_query_ae93bb5dafd039eb08c44cd42215c34c4}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!clear\+Results@{clear\+Results}}
\index{clear\+Results@{clear\+Results}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{clear\+Results()}{clearResults()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Ray\+Scene\+Query\+::clear\+Results (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Clears the results of the last query execution. 

\begin{DoxyRemark}{Remarks}
You only need to call this if you specifically want to free up the memory used by this object to hold the last query results. This object clears the results itself when executing and when destroying itself. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_a88c9810df53d94b893bc5aef885d14a1}\label{class_ogre_1_1_ray_scene_query_a88c9810df53d94b893bc5aef885d14a1}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!query\+Result@{query\+Result}}
\index{query\+Result@{query\+Result}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{query\+Result()}{queryResult()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily bool Ogre\+::\+Ray\+Scene\+Query\+::query\+Result (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} $\ast$}]{obj,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{distance }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Self-\/callback in order to deal with execute which returns collection. 



Implements \hyperlink{class_ogre_1_1_ray_scene_query_listener_ac3c09aba6b71ca28d721be30ed8f06ed}{Ogre\+::\+Ray\+Scene\+Query\+Listener}.

\mbox{\Hypertarget{class_ogre_1_1_ray_scene_query_abd5211784dd04e0e0705fe21d43cb900}\label{class_ogre_1_1_ray_scene_query_abd5211784dd04e0e0705fe21d43cb900}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!query\+Result@{query\+Result}}
\index{query\+Result@{query\+Result}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{query\+Result()}{queryResult()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily bool Ogre\+::\+Ray\+Scene\+Query\+::query\+Result (\begin{DoxyParamCaption}\item[{\hyperlink{struct_ogre_1_1_scene_query_1_1_world_fragment}{Scene\+Query\+::\+World\+Fragment} $\ast$}]{fragment,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{distance }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Self-\/callback in order to deal with execute which returns collection. 



Implements \hyperlink{class_ogre_1_1_ray_scene_query_listener_a7c390bfdec4a3e7eaf0491d8cc7b6d3c}{Ogre\+::\+Ray\+Scene\+Query\+Listener}.

\mbox{\Hypertarget{class_ogre_1_1_scene_query_ad392a7fc0b338e5507540d3183f82cfb}\label{class_ogre_1_1_scene_query_ad392a7fc0b338e5507540d3183f82cfb}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!set\+Query\+Mask@{set\+Query\+Mask}}
\index{set\+Query\+Mask@{set\+Query\+Mask}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{set\+Query\+Mask()}{setQueryMask()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Scene\+Query\+::set\+Query\+Mask (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{mask }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets the mask for results of this query. 

\begin{DoxyRemark}{Remarks}
This method allows you to set a \textquotesingle{}mask\textquotesingle{} to limit the results of this query to certain types of result. The actual meaning of this value is up to the application; basically \hyperlink{class_ogre_1_1_movable_object}{Movable\+Object} instances will only be returned from this query if a bitwise A\+ND operation between this mask value and the \hyperlink{class_ogre_1_1_movable_object_ad66149b7a6f5ba1cd5c58fbd69f0446a}{Movable\+Object\+::get\+Query\+Flags} value is non-\/zero. The application will have to decide what each of the bits means. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_scene_query_aed7b296e80ea3acebc493842727e8db3}\label{class_ogre_1_1_scene_query_aed7b296e80ea3acebc493842727e8db3}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+Query\+Mask@{get\+Query\+Mask}}
\index{get\+Query\+Mask@{get\+Query\+Mask}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+Query\+Mask()}{getQueryMask()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Scene\+Query\+::get\+Query\+Mask (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns the current mask for this query. 

\mbox{\Hypertarget{class_ogre_1_1_scene_query_abaca8d4d9b59a571e2d8e9a2cac7ce42}\label{class_ogre_1_1_scene_query_abaca8d4d9b59a571e2d8e9a2cac7ce42}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!set\+Query\+Type\+Mask@{set\+Query\+Type\+Mask}}
\index{set\+Query\+Type\+Mask@{set\+Query\+Type\+Mask}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{set\+Query\+Type\+Mask()}{setQueryTypeMask()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Scene\+Query\+::set\+Query\+Type\+Mask (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{mask }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Sets the type mask for results of this query. 

\begin{DoxyRemark}{Remarks}
This method allows you to set a \textquotesingle{}type mask\textquotesingle{} to limit the results of this query to certain types of objects. Whilst set\+Query\+Mask deals with flags set per instance of object, this method deals with setting a mask on flags set per type of object. Both may exclude an object from query results. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_scene_query_a47fac5b11f62901c14b1bd757ea5c14b}\label{class_ogre_1_1_scene_query_a47fac5b11f62901c14b1bd757ea5c14b}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+Query\+Type\+Mask@{get\+Query\+Type\+Mask}}
\index{get\+Query\+Type\+Mask@{get\+Query\+Type\+Mask}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+Query\+Type\+Mask()}{getQueryTypeMask()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Scene\+Query\+::get\+Query\+Type\+Mask (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns the current mask for this query. 

\mbox{\Hypertarget{class_ogre_1_1_scene_query_aec3aa0b8b16c41fae990ee78150f8d2a}\label{class_ogre_1_1_scene_query_aec3aa0b8b16c41fae990ee78150f8d2a}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!set\+World\+Fragment\+Type@{set\+World\+Fragment\+Type}}
\index{set\+World\+Fragment\+Type@{set\+World\+Fragment\+Type}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{set\+World\+Fragment\+Type()}{setWorldFragmentType()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Scene\+Query\+::set\+World\+Fragment\+Type (\begin{DoxyParamCaption}\item[{enum \hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{World\+Fragment\+Type}}]{wft }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed. 

\begin{DoxyRemark}{Remarks}
The application receiving the world geometry is expected to know what to do with it; inevitably this means that the application must have knowledge of at least some of the structures used by the custom \hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
The default setting is W\+F\+T\+\_\+\+N\+O\+NE. 
\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_scene_query_acffb9330fc3de7109f8274822e362b00}\label{class_ogre_1_1_scene_query_acffb9330fc3de7109f8274822e362b00}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+World\+Fragment\+Type@{get\+World\+Fragment\+Type}}
\index{get\+World\+Fragment\+Type@{get\+World\+Fragment\+Type}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+World\+Fragment\+Type()}{getWorldFragmentType()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{World\+Fragment\+Type} Ogre\+::\+Scene\+Query\+::get\+World\+Fragment\+Type (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the current world fragment types to be returned from the query. 

\mbox{\Hypertarget{class_ogre_1_1_scene_query_acceb4087f3a6ed148ae92f7e39fd1179}\label{class_ogre_1_1_scene_query_acceb4087f3a6ed148ae92f7e39fd1179}} 
\index{Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}!get\+Supported\+World\+Fragment\+Types@{get\+Supported\+World\+Fragment\+Types}}
\index{get\+Supported\+World\+Fragment\+Types@{get\+Supported\+World\+Fragment\+Types}!Ogre\+::\+Bsp\+Ray\+Scene\+Query@{Ogre\+::\+Bsp\+Ray\+Scene\+Query}}
\subsubsection{\texorpdfstring{get\+Supported\+World\+Fragment\+Types()}{getSupportedWorldFragmentTypes()}}
{\footnotesize\ttfamily virtual const std\+::set$<$\hyperlink{class_ogre_1_1_scene_query_a0a75b5ed976da2f9023382f4c4514b3a}{World\+Fragment\+Type}$>$$\ast$ Ogre\+::\+Scene\+Query\+::get\+Supported\+World\+Fragment\+Types (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns the types of world fragments this query supports. 



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