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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::OctreeIntersectionSceneQuery 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::OctreeIntersectionSceneQuery Class Reference</h1><a class="el" href="classOgre_1_1Octree.html">Octree</a> implementation 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="OgreOctreeSceneQuery_8h-source.html">OgreOctreeSceneQuery.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::OctreeIntersectionSceneQuery:
16<p><center><img src="classOgre_1_1OctreeIntersectionSceneQuery.png" usemap="#Ogre::OctreeIntersectionSceneQuery_map" border="0" alt=""></center>
17<map name="Ogre::OctreeIntersectionSceneQuery_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_1OctreeIntersectionSceneQuery-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_1OctreeIntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya0">OctreeIntersectionSceneQuery</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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1OctreeIntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya1">~OctreeIntersectionSceneQuery</a> ()</td></tr>
41
42<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1OctreeIntersectionSceneQuery.html#Ogre_1_1OctreeIntersectionSceneQuerya2">execute</a> (<a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html">IntersectionSceneQueryListener</a> *listener)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classOgre_1_1IntersectionSceneQuery.html">IntersectionSceneQuery</a>.  <a href="#Ogre_1_1OctreeIntersectionSceneQuerya2"></a><br><br></td></tr>
45<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>
46
47<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>
48<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>
49
50<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>
51<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>
52
53<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>
54<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>
55
56<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>
57<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>
58
59<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>
60<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>
61
62<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>
63<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>
64
65<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>
66<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>
67
68<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>
69<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>
70
71<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>
72<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>
73
74<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>
75<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
76<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>
77
78<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>
79
80<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>
81
82<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>
83
84<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>
85
86</table>
87<hr><a name="_details"></a><h2>Detailed Description</h2>
88<a class="el" href="classOgre_1_1Octree.html">Octree</a> implementation of <a class="el" href="classOgre_1_1IntersectionSceneQuery.html">IntersectionSceneQuery</a>.
89<p>
90
91<p>
92Definition at line <a class="el" href="OgreOctreeSceneQuery_8h-source.html#l00043">43</a> of file <a class="el" href="OgreOctreeSceneQuery_8h-source.html">OgreOctreeSceneQuery.h</a>.<hr><h2>Member Enumeration Documentation</h2>
93<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5" doxytag="Ogre::OctreeIntersectionSceneQuery::WorldFragmentType" ></a><p>
94<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
95  <tr>
96    <td class="mdRow">
97      <table cellpadding="0" cellspacing="0" border="0">
98        <tr>
99          <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>
100      </table>
101    </td>
102  </tr>
103</table>
104<table cellspacing=5 cellpadding=0 border=0>
105  <tr>
106    <td>
107      &nbsp;
108    </td>
109    <td>
110
111<p>
112This type can be used by collaborating applications &amp; SceneManagers to agree on the type of world geometry to be returned from queries.
113<p>
114Not 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>
115<table border=0 cellspacing=2 cellpadding=0>
116<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0" doxytag="WFT_NONE" ></a>WFT_NONE</em>&nbsp;</td><td>
117Return no world geometry hits at all. </td></tr>
118<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>
119Return pointers to convex plane-bounded regions. </td></tr>
120<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>
121Return a single intersection point (typically <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a> only). </td></tr>
122<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>
123Custom geometry as defined by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>. </td></tr>
124<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>
125General <a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> structure. </td></tr>
126</table>
127</dl>
128
129<p>
130Definition 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>
131  </tr>
132</table>
133<hr><h2>Constructor &amp; Destructor Documentation</h2>
134<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya0" doxytag="Ogre::OctreeIntersectionSceneQuery::OctreeIntersectionSceneQuery" ></a><p>
135<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
136  <tr>
137    <td class="mdRow">
138      <table cellpadding="0" cellspacing="0" border="0">
139        <tr>
140          <td class="md" nowrap valign="top"> Ogre::OctreeIntersectionSceneQuery::OctreeIntersectionSceneQuery </td>
141          <td class="md" valign="top">(&nbsp;</td>
142          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td>
143          <td class="mdname1" valign="top" nowrap> <em>creator</em>          </td>
144          <td class="md" valign="top">&nbsp;)&nbsp;</td>
145          <td class="md" nowrap></td>
146        </tr>
147
148      </table>
149    </td>
150  </tr>
151</table>
152<table cellspacing=5 cellpadding=0 border=0>
153  <tr>
154    <td>
155      &nbsp;
156    </td>
157    <td>
158
159<p>
160    </td>
161  </tr>
162</table>
163<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya1" doxytag="Ogre::OctreeIntersectionSceneQuery::~OctreeIntersectionSceneQuery" ></a><p>
164<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
165  <tr>
166    <td class="mdRow">
167      <table cellpadding="0" cellspacing="0" border="0">
168        <tr>
169          <td class="md" nowrap valign="top"> Ogre::OctreeIntersectionSceneQuery::~<a class="el" href="classOgre_1_1OctreeIntersectionSceneQuery.html">OctreeIntersectionSceneQuery</a> </td>
170          <td class="md" valign="top">(&nbsp;</td>
171          <td class="mdname1" valign="top" nowrap>          </td>
172          <td class="md" valign="top">&nbsp;)&nbsp;</td>
173          <td class="md" nowrap></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>
188    </td>
189  </tr>
190</table>
191<hr><h2>Member Function Documentation</h2>
192<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya5" doxytag="Ogre::OctreeIntersectionSceneQuery::clearResults" ></a><p>
193<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
194  <tr>
195    <td class="mdRow">
196      <table cellpadding="0" cellspacing="0" border="0">
197        <tr>
198          <td class="md" nowrap valign="top"> virtual void Ogre::IntersectionSceneQuery::clearResults </td>
199          <td class="md" valign="top">(&nbsp;</td>
200          <td class="md" nowrap valign="top">void&nbsp;</td>
201          <td class="mdname1" valign="top" nowrap>          </td>
202          <td class="md" valign="top">&nbsp;)&nbsp;</td>
203          <td class="md" nowrap><code> [virtual, inherited]</code></td>
204        </tr>
205
206      </table>
207    </td>
208  </tr>
209</table>
210<table cellspacing=5 cellpadding=0 border=0>
211  <tr>
212    <td>
213      &nbsp;
214    </td>
215    <td>
216
217<p>
218Clears the results of the last query execution.
219<p>
220<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>
221    </td>
222  </tr>
223</table>
224<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya3" doxytag="Ogre::OctreeIntersectionSceneQuery::execute" ></a><p>
225<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
226  <tr>
227    <td class="mdRow">
228      <table cellpadding="0" cellspacing="0" border="0">
229        <tr>
230          <td class="md" nowrap valign="top"> virtual <a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a>&amp; Ogre::IntersectionSceneQuery::execute </td>
231          <td class="md" valign="top">(&nbsp;</td>
232          <td class="md" nowrap valign="top">void&nbsp;</td>
233          <td class="mdname1" valign="top" nowrap>          </td>
234          <td class="md" valign="top">&nbsp;)&nbsp;</td>
235          <td class="md" nowrap><code> [virtual, inherited]</code></td>
236        </tr>
237
238      </table>
239    </td>
240  </tr>
241</table>
242<table cellspacing=5 cellpadding=0 border=0>
243  <tr>
244    <td>
245      &nbsp;
246    </td>
247    <td>
248
249<p>
250Executes the query, returning the results back in one list.
251<p>
252<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>
253    </td>
254  </tr>
255</table>
256<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya2" doxytag="Ogre::OctreeIntersectionSceneQuery::execute" ></a><p>
257<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
258  <tr>
259    <td class="mdRow">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"> void Ogre::OctreeIntersectionSceneQuery::execute </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html">IntersectionSceneQueryListener</a> *&nbsp;</td>
265          <td class="mdname1" valign="top" nowrap> <em>listener</em>          </td>
266          <td class="md" valign="top">&nbsp;)&nbsp;</td>
267          <td class="md" nowrap><code> [virtual]</code></td>
268        </tr>
269
270      </table>
271    </td>
272  </tr>
273</table>
274<table cellspacing=5 cellpadding=0 border=0>
275  <tr>
276    <td>
277      &nbsp;
278    </td>
279    <td>
280
281<p>
282See <a class="el" href="classOgre_1_1IntersectionSceneQuery.html">IntersectionSceneQuery</a>.
283<p>
284
285<p>
286Reimplemented from <a class="el" href="classOgre_1_1DefaultIntersectionSceneQuery.html#Ogre_1_1DefaultIntersectionSceneQuerya2">Ogre::DefaultIntersectionSceneQuery</a>.    </td>
287  </tr>
288</table>
289<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya4" doxytag="Ogre::OctreeIntersectionSceneQuery::getLastResults" ></a><p>
290<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
291  <tr>
292    <td class="mdRow">
293      <table cellpadding="0" cellspacing="0" border="0">
294        <tr>
295          <td class="md" nowrap valign="top"> virtual <a class="el" href="structOgre_1_1IntersectionSceneQueryResult.html">IntersectionSceneQueryResult</a>&amp; Ogre::IntersectionSceneQuery::getLastResults </td>
296          <td class="md" valign="top">(&nbsp;</td>
297          <td class="md" nowrap valign="top">void&nbsp;</td>
298          <td class="mdname1" valign="top" nowrap>          </td>
299          <td class="md" valign="top">&nbsp;)&nbsp;</td>
300          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
301        </tr>
302
303      </table>
304    </td>
305  </tr>
306</table>
307<table cellspacing=5 cellpadding=0 border=0>
308  <tr>
309    <td>
310      &nbsp;
311    </td>
312    <td>
313
314<p>
315Gets the results of the last query that was run using this object, provided the query was executed using the collection-returning version of execute.
316<p>
317    </td>
318  </tr>
319</table>
320<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya14" doxytag="Ogre::OctreeIntersectionSceneQuery::getQueryMask" ></a><p>
321<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
322  <tr>
323    <td class="mdRow">
324      <table cellpadding="0" cellspacing="0" border="0">
325        <tr>
326          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::SceneQuery::getQueryMask </td>
327          <td class="md" valign="top">(&nbsp;</td>
328          <td class="md" nowrap valign="top">void&nbsp;</td>
329          <td class="mdname1" valign="top" nowrap>          </td>
330          <td class="md" valign="top">&nbsp;)&nbsp;</td>
331          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
332        </tr>
333
334      </table>
335    </td>
336  </tr>
337</table>
338<table cellspacing=5 cellpadding=0 border=0>
339  <tr>
340    <td>
341      &nbsp;
342    </td>
343    <td>
344
345<p>
346Returns the current mask for this query.
347<p>
348    </td>
349  </tr>
350</table>
351<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya17" doxytag="Ogre::OctreeIntersectionSceneQuery::getSupportedWorldFragmentTypes" ></a><p>
352<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
353  <tr>
354    <td class="mdRow">
355      <table cellpadding="0" cellspacing="0" border="0">
356        <tr>
357          <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>
358          <td class="md" valign="top">(&nbsp;</td>
359          <td class="md" nowrap valign="top">void&nbsp;</td>
360          <td class="mdname1" valign="top" nowrap>          </td>
361          <td class="md" valign="top">&nbsp;)&nbsp;</td>
362          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
363        </tr>
364
365      </table>
366    </td>
367  </tr>
368</table>
369<table cellspacing=5 cellpadding=0 border=0>
370  <tr>
371    <td>
372      &nbsp;
373    </td>
374    <td>
375
376<p>
377Returns the types of world fragments this query supports.
378<p>
379
380<p>
381Definition 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>
382  </tr>
383</table>
384<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya16" doxytag="Ogre::OctreeIntersectionSceneQuery::getWorldFragmentType" ></a><p>
385<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
386  <tr>
387    <td class="mdRow">
388      <table cellpadding="0" cellspacing="0" border="0">
389        <tr>
390          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> Ogre::SceneQuery::getWorldFragmentType </td>
391          <td class="md" valign="top">(&nbsp;</td>
392          <td class="md" nowrap valign="top">void&nbsp;</td>
393          <td class="mdname1" valign="top" nowrap>          </td>
394          <td class="md" valign="top">&nbsp;)&nbsp;</td>
395          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
396        </tr>
397
398      </table>
399    </td>
400  </tr>
401</table>
402<table cellspacing=5 cellpadding=0 border=0>
403  <tr>
404    <td>
405      &nbsp;
406    </td>
407    <td>
408
409<p>
410Gets the current world fragment types to be returned from the query.
411<p>
412    </td>
413  </tr>
414</table>
415<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya7" doxytag="Ogre::OctreeIntersectionSceneQuery::queryResult" ></a><p>
416<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
417  <tr>
418    <td class="mdRow">
419      <table cellpadding="0" cellspacing="0" border="0">
420        <tr>
421          <td class="md" nowrap valign="top"> bool Ogre::IntersectionSceneQuery::queryResult </td>
422          <td class="md" valign="top">(&nbsp;</td>
423          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
424          <td class="mdname" nowrap> <em>movable</em>, </td>
425        </tr>
426        <tr>
427          <td class="md" nowrap align="right"></td>
428          <td></td>
429          <td class="md" nowrap><a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *&nbsp;</td>
430          <td class="mdname" nowrap> <em>fragment</em></td>
431        </tr>
432        <tr>
433          <td></td>
434          <td class="md">)&nbsp;</td>
435          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
436        </tr>
437
438      </table>
439    </td>
440  </tr>
441</table>
442<table cellspacing=5 cellpadding=0 border=0>
443  <tr>
444    <td>
445      &nbsp;
446    </td>
447    <td>
448
449<p>
450Self-callback in order to deal with execute which returns collection.
451<p>
452
453<p>
454Implements <a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html#Ogre_1_1IntersectionSceneQueryListenera2">Ogre::IntersectionSceneQueryListener</a>.    </td>
455  </tr>
456</table>
457<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQuerya6" doxytag="Ogre::OctreeIntersectionSceneQuery::queryResult" ></a><p>
458<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
459  <tr>
460    <td class="mdRow">
461      <table cellpadding="0" cellspacing="0" border="0">
462        <tr>
463          <td class="md" nowrap valign="top"> bool Ogre::IntersectionSceneQuery::queryResult </td>
464          <td class="md" valign="top">(&nbsp;</td>
465          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
466          <td class="mdname" nowrap> <em>first</em>, </td>
467        </tr>
468        <tr>
469          <td class="md" nowrap align="right"></td>
470          <td></td>
471          <td class="md" nowrap><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
472          <td class="mdname" nowrap> <em>second</em></td>
473        </tr>
474        <tr>
475          <td></td>
476          <td class="md">)&nbsp;</td>
477          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
478        </tr>
479
480      </table>
481    </td>
482  </tr>
483</table>
484<table cellspacing=5 cellpadding=0 border=0>
485  <tr>
486    <td>
487      &nbsp;
488    </td>
489    <td>
490
491<p>
492Self-callback in order to deal with execute which returns collection.
493<p>
494
495<p>
496Implements <a class="el" href="classOgre_1_1IntersectionSceneQueryListener.html#Ogre_1_1IntersectionSceneQueryListenera1">Ogre::IntersectionSceneQueryListener</a>.    </td>
497  </tr>
498</table>
499<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya13" doxytag="Ogre::OctreeIntersectionSceneQuery::setQueryMask" ></a><p>
500<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
501  <tr>
502    <td class="mdRow">
503      <table cellpadding="0" cellspacing="0" border="0">
504        <tr>
505          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setQueryMask </td>
506          <td class="md" valign="top">(&nbsp;</td>
507          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
508          <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
509          <td class="md" valign="top">&nbsp;)&nbsp;</td>
510          <td class="md" nowrap><code> [virtual, inherited]</code></td>
511        </tr>
512
513      </table>
514    </td>
515  </tr>
516</table>
517<table cellspacing=5 cellpadding=0 border=0>
518  <tr>
519    <td>
520      &nbsp;
521    </td>
522    <td>
523
524<p>
525Sets the mask for results of this query.
526<p>
527<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>
528    </td>
529  </tr>
530</table>
531<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya15" doxytag="Ogre::OctreeIntersectionSceneQuery::setWorldFragmentType" ></a><p>
532<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
533  <tr>
534    <td class="mdRow">
535      <table cellpadding="0" cellspacing="0" border="0">
536        <tr>
537          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setWorldFragmentType </td>
538          <td class="md" valign="top">(&nbsp;</td>
539          <td class="md" nowrap valign="top">enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td>
540          <td class="mdname1" valign="top" nowrap> <em>wft</em>          </td>
541          <td class="md" valign="top">&nbsp;)&nbsp;</td>
542          <td class="md" nowrap><code> [virtual, inherited]</code></td>
543        </tr>
544
545      </table>
546    </td>
547  </tr>
548</table>
549<table cellspacing=5 cellpadding=0 border=0>
550  <tr>
551    <td>
552      &nbsp;
553    </td>
554    <td>
555
556<p>
557Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.
558<p>
559<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>
560<dl compact><dt><b></b></dt><dd>The default setting is WFT_NONE. </dd></dl>
561    </td>
562  </tr>
563</table>
564<hr><h2>Member Data Documentation</h2>
565<a class="anchor" name="Ogre_1_1OctreeIntersectionSceneQueryp0" doxytag="Ogre::OctreeIntersectionSceneQuery::mLastResult" ></a><p>
566<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
567  <tr>
568    <td class="mdRow">
569      <table cellpadding="0" cellspacing="0" border="0">
570        <tr>
571          <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>
572      </table>
573    </td>
574  </tr>
575</table>
576<table cellspacing=5 cellpadding=0 border=0>
577  <tr>
578    <td>
579      &nbsp;
580    </td>
581    <td>
582
583<p>
584
585<p>
586Definition 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>
587  </tr>
588</table>
589<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp4" doxytag="Ogre::OctreeIntersectionSceneQuery::mParentSceneMgr" ></a><p>
590<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
591  <tr>
592    <td class="mdRow">
593      <table cellpadding="0" cellspacing="0" border="0">
594        <tr>
595          <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>
596      </table>
597    </td>
598  </tr>
599</table>
600<table cellspacing=5 cellpadding=0 border=0>
601  <tr>
602    <td>
603      &nbsp;
604    </td>
605    <td>
606
607<p>
608
609<p>
610Definition 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>
611  </tr>
612</table>
613<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp5" doxytag="Ogre::OctreeIntersectionSceneQuery::mQueryMask" ></a><p>
614<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
615  <tr>
616    <td class="mdRow">
617      <table cellpadding="0" cellspacing="0" border="0">
618        <tr>
619          <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>
620      </table>
621    </td>
622  </tr>
623</table>
624<table cellspacing=5 cellpadding=0 border=0>
625  <tr>
626    <td>
627      &nbsp;
628    </td>
629    <td>
630
631<p>
632
633<p>
634Definition 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>
635  </tr>
636</table>
637<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp6" doxytag="Ogre::OctreeIntersectionSceneQuery::mSupportedWorldFragments" ></a><p>
638<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
639  <tr>
640    <td class="mdRow">
641      <table cellpadding="0" cellspacing="0" border="0">
642        <tr>
643          <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>
644      </table>
645    </td>
646  </tr>
647</table>
648<table cellspacing=5 cellpadding=0 border=0>
649  <tr>
650    <td>
651      &nbsp;
652    </td>
653    <td>
654
655<p>
656
657<p>
658Definition 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>
659  </tr>
660</table>
661<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp7" doxytag="Ogre::OctreeIntersectionSceneQuery::mWorldFragmentType" ></a><p>
662<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
663  <tr>
664    <td class="mdRow">
665      <table cellpadding="0" cellspacing="0" border="0">
666        <tr>
667          <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>
668      </table>
669    </td>
670  </tr>
671</table>
672<table cellspacing=5 cellpadding=0 border=0>
673  <tr>
674    <td>
675      &nbsp;
676    </td>
677    <td>
678
679<p>
680
681<p>
682Definition 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>
683  </tr>
684</table>
685<hr>The documentation for this class was generated from the following file:<ul>
686<li><a class="el" href="OgreOctreeSceneQuery_8h-source.html">OgreOctreeSceneQuery.h</a></ul>
687<hr>
688<p>
689Copyright &copy; 2000-2005 by The OGRE Team<br />
690<!--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/>
691This 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/>
692                <!--/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#">
693                <Work rdf:about="">
694                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
695        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
696                </Work>
697                <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> -->
698
699Last modified Sun Feb 12 13:06:19 2006
700</p>
701</body>
702</html>
Note: See TracBrowser for help on using the repository browser.