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

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

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