source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1BspIntersectionSceneQuery.html @ 657

Revision 657, 35.6 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::BspIntersectionSceneQuery class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::BspIntersectionSceneQuery Class Reference</h1>BSP specialisation of <a class="el" href="classOgre_1_1IntersectionSceneQuery.html">IntersectionSceneQuery</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::BspIntersectionSceneQuery:
16<p><center><img src="classOgre_1_1BspIntersectionSceneQuery.png" usemap="#Ogre::BspIntersectionSceneQuery_map" border="0" alt=""></center>
17<map name="Ogre::BspIntersectionSceneQuery_map">
18<area href="classOgre_1_1DefaultIntersectionSceneQuery.html" alt="Ogre::DefaultIntersectionSceneQuery" shape="rect" coords="119,112,348,136">
19<area href="classOgre_1_1IntersectionSceneQuery.html" alt="Ogre::IntersectionSceneQuery" shape="rect" coords="119,56,348,80">
20<area href="classOgre_1_1SceneQuery.html" alt="Ogre::SceneQuery" shape="rect" coords="0,0,229,24">
21<area href="classOgre_1_1IntersectionSceneQueryListener.html" alt="Ogre::IntersectionSceneQueryListener" shape="rect" coords="239,0,468,24">
22</map>
23<a href="classOgre_1_1BspIntersectionSceneQuery-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
24<tr><td></td></tr>
25<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> { <br>
27&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0">WFT_NONE</a>,
28<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw1">WFT_PLANE_BOUNDED_REGION</a>,
29<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw2">WFT_SINGLE_INTERSECTION</a>,
30<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw3">WFT_CUSTOM_GEOMETRY</a>,
31<br>
32&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw4">WFT_RENDER_OPERATION</a>
33<br>
34 }</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This type can be used by collaborating applications &amp; SceneManagers to agree on the type of world geometry to be returned from queries.  <a href="#Ogre_1_1TerrainRaySceneQueryw5">More...</a><br><br></td></tr>
37<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspIntersectionSceneQuery.html#Ogre_1_1BspIntersectionSceneQuerya0">BspIntersectionSceneQuery</a> (<a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *creator)</td></tr>
39
40<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspIntersectionSceneQuery.html#Ogre_1_1BspIntersectionSceneQuerya1">execute</a> (<a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html">IntersectionSceneQueryListener</a> *listener)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classOgre_1_1IntersectionSceneQuery.html">IntersectionSceneQuery</a>.  <a href="#Ogre_1_1BspIntersectionSceneQuerya1"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya3">execute</a> (void)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Executes the query, returning the results back in one list.  <a href="#Ogre_1_1OctreeIntersectionSceneQuerya3"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya4">getLastResults</a> (void) const </td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">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.  <a href="#Ogre_1_1OctreeIntersectionSceneQuerya4"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya5">clearResults</a> (void)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the results of the last query execution.  <a href="#Ogre_1_1OctreeIntersectionSceneQuerya5"></a><br><br></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya6">queryResult</a> (<a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *first, <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *second)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Self-callback in order to deal with execute which returns collection.  <a href="#Ogre_1_1OctreeIntersectionSceneQuerya6"></a><br><br></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya7">queryResult</a> (<a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *movable, <a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *fragment)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Self-callback in order to deal with execute which returns collection.  <a href="#Ogre_1_1OctreeIntersectionSceneQuerya7"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya13">setQueryMask</a> (unsigned long mask)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the mask for results of this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya13"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya14">getQueryMask</a> (void) const </td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the current mask for this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya14"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya15">setWorldFragmentType</a> (enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> wft)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.  <a href="#Ogre_1_1TerrainRaySceneQuerya15"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya16">getWorldFragmentType</a> (void) const </td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current world fragment types to be returned from the query.  <a href="#Ogre_1_1TerrainRaySceneQuerya16"></a><br><br></td></tr>
70<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const std::set&lt; <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> &gt; *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya17">getSupportedWorldFragmentTypes</a> (void) const </td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the types of world fragments this query supports.  <a href="#Ogre_1_1TerrainRaySceneQuerya17"></a><br><br></td></tr>
73<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQueryp0">mLastResult</a></td></tr>
75
76<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp4">mParentSceneMgr</a></td></tr>
77
78<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp5">mQueryMask</a></td></tr>
79
80<tr><td class="memItemLeft" nowrap align=right valign=top>std::set&lt; <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp6">mSupportedWorldFragments</a></td></tr>
81
82<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp7">mWorldFragmentType</a></td></tr>
83
84</table>
85<hr><a name="_details"></a><h2>Detailed Description</h2>
86BSP specialisation of <a class="el" href="classOgre_1_1IntersectionSceneQuery.html">IntersectionSceneQuery</a>.
87<p>
88
89<p>
90Definition at line <a class="el" href="OgreBspSceneManager_8h-source.html#l00213">213</a> of file <a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a>.<hr><h2>Member Enumeration Documentation</h2>
91<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5" doxytag="Ogre::BspIntersectionSceneQuery::WorldFragmentType" ></a><p>
92<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
93  <tr>
94    <td class="mdRow">
95      <table cellpadding="0" cellspacing="0" border="0">
96        <tr>
97          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">Ogre::SceneQuery::WorldFragmentType</a><code> [inherited]</code>
98      </table>
99    </td>
100  </tr>
101</table>
102<table cellspacing=5 cellpadding=0 border=0>
103  <tr>
104    <td>
105      &nbsp;
106    </td>
107    <td>
108
109<p>
110This type can be used by collaborating applications &amp; SceneManagers to agree on the type of world geometry to be returned from queries.
111<p>
112Not all these types will be supported by all SceneManagers; once the application has decided which <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> specialisation to use, it is expected that it will know which type of world geometry abstraction is available to it. <dl compact><dt><b>Enumeration values: </b></dt><dd>
113<table border=0 cellspacing=2 cellpadding=0>
114<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0" doxytag="WFT_NONE" ></a>WFT_NONE</em>&nbsp;</td><td>
115Return no world geometry hits at all. </td></tr>
116<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw1" doxytag="WFT_PLANE_BOUNDED_REGION" ></a>WFT_PLANE_BOUNDED_REGION</em>&nbsp;</td><td>
117Return pointers to convex plane-bounded regions. </td></tr>
118<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw2" doxytag="WFT_SINGLE_INTERSECTION" ></a>WFT_SINGLE_INTERSECTION</em>&nbsp;</td><td>
119Return a single intersection point (typically <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a> only). </td></tr>
120<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw3" doxytag="WFT_CUSTOM_GEOMETRY" ></a>WFT_CUSTOM_GEOMETRY</em>&nbsp;</td><td>
121Custom geometry as defined by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>. </td></tr>
122<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw4" doxytag="WFT_RENDER_OPERATION" ></a>WFT_RENDER_OPERATION</em>&nbsp;</td><td>
123General <a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> structure. </td></tr>
124</table>
125</dl>
126
127<p>
128Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00073">73</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
129  </tr>
130</table>
131<hr><h2>Constructor &amp; Destructor Documentation</h2>
132<a class="anchor" name="Ogre_1_1BspIntersectionSceneQuerya0" doxytag="Ogre::BspIntersectionSceneQuery::BspIntersectionSceneQuery" ></a><p>
133<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
134  <tr>
135    <td class="mdRow">
136      <table cellpadding="0" cellspacing="0" border="0">
137        <tr>
138          <td class="md" nowrap valign="top"> Ogre::BspIntersectionSceneQuery::BspIntersectionSceneQuery </td>
139          <td class="md" valign="top">(&nbsp;</td>
140          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td>
141          <td class="mdname1" valign="top" nowrap> <em>creator</em>          </td>
142          <td class="md" valign="top">&nbsp;)&nbsp;</td>
143          <td class="md" nowrap></td>
144        </tr>
145
146      </table>
147    </td>
148  </tr>
149</table>
150<table cellspacing=5 cellpadding=0 border=0>
151  <tr>
152    <td>
153      &nbsp;
154    </td>
155    <td>
156
157<p>
158    </td>
159  </tr>
160</table>
161<hr><h2>Member Function Documentation</h2>
162<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya5" doxytag="Ogre::BspIntersectionSceneQuery::clearResults" ></a><p>
163<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
164  <tr>
165    <td class="mdRow">
166      <table cellpadding="0" cellspacing="0" border="0">
167        <tr>
168          <td class="md" nowrap valign="top"> virtual void Ogre::IntersectionSceneQuery::clearResults </td>
169          <td class="md" valign="top">(&nbsp;</td>
170          <td class="md" nowrap valign="top">void&nbsp;</td>
171          <td class="mdname1" valign="top" nowrap>          </td>
172          <td class="md" valign="top">&nbsp;)&nbsp;</td>
173          <td class="md" nowrap><code> [virtual, inherited]</code></td>
174        </tr>
175
176      </table>
177    </td>
178  </tr>
179</table>
180<table cellspacing=5 cellpadding=0 border=0>
181  <tr>
182    <td>
183      &nbsp;
184    </td>
185    <td>
186
187<p>
188Clears the results of the last query execution.
189<p>
190<dl compact><dt><b>Remarks:</b></dt><dd>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. </dd></dl>
191    </td>
192  </tr>
193</table>
194<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya3" doxytag="Ogre::BspIntersectionSceneQuery::execute" ></a><p>
195<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
196  <tr>
197    <td class="mdRow">
198      <table cellpadding="0" cellspacing="0" border="0">
199        <tr>
200          <td class="md" nowrap valign="top"> virtual <a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a>&amp; Ogre::IntersectionSceneQuery::execute </td>
201          <td class="md" valign="top">(&nbsp;</td>
202          <td class="md" nowrap valign="top">void&nbsp;</td>
203          <td class="mdname1" valign="top" nowrap>          </td>
204          <td class="md" valign="top">&nbsp;)&nbsp;</td>
205          <td class="md" nowrap><code> [virtual, inherited]</code></td>
206        </tr>
207
208      </table>
209    </td>
210  </tr>
211</table>
212<table cellspacing=5 cellpadding=0 border=0>
213  <tr>
214    <td>
215      &nbsp;
216    </td>
217    <td>
218
219<p>
220Executes the query, returning the results back in one list.
221<p>
222<dl compact><dt><b>Remarks:</b></dt><dd>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 <a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya5">clearResults()</a> is called. An more lightweight version of this method that returns results through a listener is also available. </dd></dl>
223    </td>
224  </tr>
225</table>
226<a class="anchor" name="Ogre_1_1BspIntersectionSceneQuerya1" doxytag="Ogre::BspIntersectionSceneQuery::execute" ></a><p>
227<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
228  <tr>
229    <td class="mdRow">
230      <table cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td class="md" nowrap valign="top"> void Ogre::BspIntersectionSceneQuery::execute </td>
233          <td class="md" valign="top">(&nbsp;</td>
234          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html">IntersectionSceneQueryListener</a> *&nbsp;</td>
235          <td class="mdname1" valign="top" nowrap> <em>listener</em>          </td>
236          <td class="md" valign="top">&nbsp;)&nbsp;</td>
237          <td class="md" nowrap><code> [virtual]</code></td>
238        </tr>
239
240      </table>
241    </td>
242  </tr>
243</table>
244<table cellspacing=5 cellpadding=0 border=0>
245  <tr>
246    <td>
247      &nbsp;
248    </td>
249    <td>
250
251<p>
252See <a class="el" href="classOgre_1_1IntersectionSceneQuery.html">IntersectionSceneQuery</a>.
253<p>
254
255<p>
256Reimplemented from <a class="el" href="classOgre_1_1DefaultIntersectionSceneQuery.html#Ogre_1_1DefaultIntersectionSceneQuerya2">Ogre::DefaultIntersectionSceneQuery</a>.    </td>
257  </tr>
258</table>
259<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya4" doxytag="Ogre::BspIntersectionSceneQuery::getLastResults" ></a><p>
260<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
261  <tr>
262    <td class="mdRow">
263      <table cellpadding="0" cellspacing="0" border="0">
264        <tr>
265          <td class="md" nowrap valign="top"> virtual <a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a>&amp; Ogre::IntersectionSceneQuery::getLastResults </td>
266          <td class="md" valign="top">(&nbsp;</td>
267          <td class="md" nowrap valign="top">void&nbsp;</td>
268          <td class="mdname1" valign="top" nowrap>          </td>
269          <td class="md" valign="top">&nbsp;)&nbsp;</td>
270          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
271        </tr>
272
273      </table>
274    </td>
275  </tr>
276</table>
277<table cellspacing=5 cellpadding=0 border=0>
278  <tr>
279    <td>
280      &nbsp;
281    </td>
282    <td>
283
284<p>
285Gets the results of the last query that was run using this object, provided the query was executed using the collection-returning version of execute.
286<p>
287    </td>
288  </tr>
289</table>
290<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya14" doxytag="Ogre::BspIntersectionSceneQuery::getQueryMask" ></a><p>
291<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
292  <tr>
293    <td class="mdRow">
294      <table cellpadding="0" cellspacing="0" border="0">
295        <tr>
296          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::SceneQuery::getQueryMask </td>
297          <td class="md" valign="top">(&nbsp;</td>
298          <td class="md" nowrap valign="top">void&nbsp;</td>
299          <td class="mdname1" valign="top" nowrap>          </td>
300          <td class="md" valign="top">&nbsp;)&nbsp;</td>
301          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
302        </tr>
303
304      </table>
305    </td>
306  </tr>
307</table>
308<table cellspacing=5 cellpadding=0 border=0>
309  <tr>
310    <td>
311      &nbsp;
312    </td>
313    <td>
314
315<p>
316Returns the current mask for this query.
317<p>
318    </td>
319  </tr>
320</table>
321<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya17" doxytag="Ogre::BspIntersectionSceneQuery::getSupportedWorldFragmentTypes" ></a><p>
322<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
323  <tr>
324    <td class="mdRow">
325      <table cellpadding="0" cellspacing="0" border="0">
326        <tr>
327          <td class="md" nowrap valign="top"> virtual const std::set&lt;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&gt;* Ogre::SceneQuery::getSupportedWorldFragmentTypes </td>
328          <td class="md" valign="top">(&nbsp;</td>
329          <td class="md" nowrap valign="top">void&nbsp;</td>
330          <td class="mdname1" valign="top" nowrap>          </td>
331          <td class="md" valign="top">&nbsp;)&nbsp;</td>
332          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
333        </tr>
334
335      </table>
336    </td>
337  </tr>
338</table>
339<table cellspacing=5 cellpadding=0 border=0>
340  <tr>
341    <td>
342      &nbsp;
343    </td>
344    <td>
345
346<p>
347Returns the types of world fragments this query supports.
348<p>
349
350<p>
351Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00152">152</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
352  </tr>
353</table>
354<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya16" doxytag="Ogre::BspIntersectionSceneQuery::getWorldFragmentType" ></a><p>
355<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
356  <tr>
357    <td class="mdRow">
358      <table cellpadding="0" cellspacing="0" border="0">
359        <tr>
360          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> Ogre::SceneQuery::getWorldFragmentType </td>
361          <td class="md" valign="top">(&nbsp;</td>
362          <td class="md" nowrap valign="top">void&nbsp;</td>
363          <td class="mdname1" valign="top" nowrap>          </td>
364          <td class="md" valign="top">&nbsp;)&nbsp;</td>
365          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
366        </tr>
367
368      </table>
369    </td>
370  </tr>
371</table>
372<table cellspacing=5 cellpadding=0 border=0>
373  <tr>
374    <td>
375      &nbsp;
376    </td>
377    <td>
378
379<p>
380Gets the current world fragment types to be returned from the query.
381<p>
382    </td>
383  </tr>
384</table>
385<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya7" doxytag="Ogre::BspIntersectionSceneQuery::queryResult" ></a><p>
386<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
387  <tr>
388    <td class="mdRow">
389      <table cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td class="md" nowrap valign="top"> bool Ogre::IntersectionSceneQuery::queryResult </td>
392          <td class="md" valign="top">(&nbsp;</td>
393          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
394          <td class="mdname" nowrap> <em>movable</em>, </td>
395        </tr>
396        <tr>
397          <td class="md" nowrap align="right"></td>
398          <td></td>
399          <td class="md" nowrap><a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *&nbsp;</td>
400          <td class="mdname" nowrap> <em>fragment</em></td>
401        </tr>
402        <tr>
403          <td></td>
404          <td class="md">)&nbsp;</td>
405          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
406        </tr>
407
408      </table>
409    </td>
410  </tr>
411</table>
412<table cellspacing=5 cellpadding=0 border=0>
413  <tr>
414    <td>
415      &nbsp;
416    </td>
417    <td>
418
419<p>
420Self-callback in order to deal with execute which returns collection.
421<p>
422
423<p>
424Implements <a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html#Ogre_1_1IntersectionSceneQueryListenera2">Ogre::IntersectionSceneQueryListener</a>.    </td>
425  </tr>
426</table>
427<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya6" doxytag="Ogre::BspIntersectionSceneQuery::queryResult" ></a><p>
428<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
429  <tr>
430    <td class="mdRow">
431      <table cellpadding="0" cellspacing="0" border="0">
432        <tr>
433          <td class="md" nowrap valign="top"> bool Ogre::IntersectionSceneQuery::queryResult </td>
434          <td class="md" valign="top">(&nbsp;</td>
435          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
436          <td class="mdname" nowrap> <em>first</em>, </td>
437        </tr>
438        <tr>
439          <td class="md" nowrap align="right"></td>
440          <td></td>
441          <td class="md" nowrap><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
442          <td class="mdname" nowrap> <em>second</em></td>
443        </tr>
444        <tr>
445          <td></td>
446          <td class="md">)&nbsp;</td>
447          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
448        </tr>
449
450      </table>
451    </td>
452  </tr>
453</table>
454<table cellspacing=5 cellpadding=0 border=0>
455  <tr>
456    <td>
457      &nbsp;
458    </td>
459    <td>
460
461<p>
462Self-callback in order to deal with execute which returns collection.
463<p>
464
465<p>
466Implements <a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html#Ogre_1_1IntersectionSceneQueryListenera1">Ogre::IntersectionSceneQueryListener</a>.    </td>
467  </tr>
468</table>
469<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya13" doxytag="Ogre::BspIntersectionSceneQuery::setQueryMask" ></a><p>
470<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
471  <tr>
472    <td class="mdRow">
473      <table cellpadding="0" cellspacing="0" border="0">
474        <tr>
475          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setQueryMask </td>
476          <td class="md" valign="top">(&nbsp;</td>
477          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
478          <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
479          <td class="md" valign="top">&nbsp;)&nbsp;</td>
480          <td class="md" nowrap><code> [virtual, inherited]</code></td>
481        </tr>
482
483      </table>
484    </td>
485  </tr>
486</table>
487<table cellspacing=5 cellpadding=0 border=0>
488  <tr>
489    <td>
490      &nbsp;
491    </td>
492    <td>
493
494<p>
495Sets the mask for results of this query.
496<p>
497<dl compact><dt><b>Remarks:</b></dt><dd>This method allows you to set a 'mask' to limit the results of this query to certain types of result. The actual meaning of this value is up to the application; basically <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> instances will only be returned from this query if a bitwise AND operation between this mask value and the <a class="el" href="classOgre_1_1MovableObject.html#Ogre_1_1WireBoundingBoxa34">MovableObject::getQueryFlags</a> value is non-zero. The application will have to decide what each of the bits means. </dd></dl>
498    </td>
499  </tr>
500</table>
501<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya15" doxytag="Ogre::BspIntersectionSceneQuery::setWorldFragmentType" ></a><p>
502<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
503  <tr>
504    <td class="mdRow">
505      <table cellpadding="0" cellspacing="0" border="0">
506        <tr>
507          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setWorldFragmentType </td>
508          <td class="md" valign="top">(&nbsp;</td>
509          <td class="md" nowrap valign="top">enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td>
510          <td class="mdname1" valign="top" nowrap> <em>wft</em>          </td>
511          <td class="md" valign="top">&nbsp;)&nbsp;</td>
512          <td class="md" nowrap><code> [virtual, inherited]</code></td>
513        </tr>
514
515      </table>
516    </td>
517  </tr>
518</table>
519<table cellspacing=5 cellpadding=0 border=0>
520  <tr>
521    <td>
522      &nbsp;
523    </td>
524    <td>
525
526<p>
527Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.
528<p>
529<dl compact><dt><b>Remarks:</b></dt><dd>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 <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>. </dd></dl>
530<dl compact><dt><b></b></dt><dd>The default setting is WFT_NONE. </dd></dl>
531    </td>
532  </tr>
533</table>
534<hr><h2>Member Data Documentation</h2>
535<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQueryp0" doxytag="Ogre::BspIntersectionSceneQuery::mLastResult" ></a><p>
536<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
537  <tr>
538    <td class="mdRow">
539      <table cellpadding="0" cellspacing="0" border="0">
540        <tr>
541          <td class="md" nowrap valign="top"> <a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a>* <a class="el" href="classOgre_1_1IntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQueryp0">Ogre::IntersectionSceneQuery::mLastResult</a><code> [protected, inherited]</code>
542      </table>
543    </td>
544  </tr>
545</table>
546<table cellspacing=5 cellpadding=0 border=0>
547  <tr>
548    <td>
549      &nbsp;
550    </td>
551    <td>
552
553<p>
554
555<p>
556Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00493">493</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
557  </tr>
558</table>
559<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp4" doxytag="Ogre::BspIntersectionSceneQuery::mParentSceneMgr" ></a><p>
560<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
561  <tr>
562    <td class="mdRow">
563      <table cellpadding="0" cellspacing="0" border="0">
564        <tr>
565          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>* <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp4">Ogre::SceneQuery::mParentSceneMgr</a><code> [protected, inherited]</code>
566      </table>
567    </td>
568  </tr>
569</table>
570<table cellspacing=5 cellpadding=0 border=0>
571  <tr>
572    <td>
573      &nbsp;
574    </td>
575    <td>
576
577<p>
578
579<p>
580Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00113">113</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
581  </tr>
582</table>
583<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp5" doxytag="Ogre::BspIntersectionSceneQuery::mQueryMask" ></a><p>
584<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
585  <tr>
586    <td class="mdRow">
587      <table cellpadding="0" cellspacing="0" border="0">
588        <tr>
589          <td class="md" nowrap valign="top"> unsigned long <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp5">Ogre::SceneQuery::mQueryMask</a><code> [protected, inherited]</code>
590      </table>
591    </td>
592  </tr>
593</table>
594<table cellspacing=5 cellpadding=0 border=0>
595  <tr>
596    <td>
597      &nbsp;
598    </td>
599    <td>
600
601<p>
602
603<p>
604Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00114">114</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
605  </tr>
606</table>
607<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp6" doxytag="Ogre::BspIntersectionSceneQuery::mSupportedWorldFragments" ></a><p>
608<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
609  <tr>
610    <td class="mdRow">
611      <table cellpadding="0" cellspacing="0" border="0">
612        <tr>
613          <td class="md" nowrap valign="top"> std::set&lt;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&gt; <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp6">Ogre::SceneQuery::mSupportedWorldFragments</a><code> [protected, inherited]</code>
614      </table>
615    </td>
616  </tr>
617</table>
618<table cellspacing=5 cellpadding=0 border=0>
619  <tr>
620    <td>
621      &nbsp;
622    </td>
623    <td>
624
625<p>
626
627<p>
628Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00115">115</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
629  </tr>
630</table>
631<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp7" doxytag="Ogre::BspIntersectionSceneQuery::mWorldFragmentType" ></a><p>
632<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
633  <tr>
634    <td class="mdRow">
635      <table cellpadding="0" cellspacing="0" border="0">
636        <tr>
637          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp7">Ogre::SceneQuery::mWorldFragmentType</a><code> [protected, inherited]</code>
638      </table>
639    </td>
640  </tr>
641</table>
642<table cellspacing=5 cellpadding=0 border=0>
643  <tr>
644    <td>
645      &nbsp;
646    </td>
647    <td>
648
649<p>
650
651<p>
652Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00116">116</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
653  </tr>
654</table>
655<hr>The documentation for this class was generated from the following file:<ul>
656<li><a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a></ul>
657<hr>
658<p>
659Copyright &copy; 2000-2005 by The OGRE Team<br />
660<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
661This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
662                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
663                <Work rdf:about="">
664                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
665        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
666                </Work>
667                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
668
669Last modified Sun Feb 12 13:05:31 2006
670</p>
671</body>
672</html>
Note: See TracBrowser for help on using the repository browser.