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

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