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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::SceneQuery 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::SceneQuery Class Reference</h1>A class for performing queries on a scene. 
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::SceneQuery:
16<p><center><img src="classOgre_1_1SceneQuery.png" usemap="#Ogre::SceneQuery_map" border="0" alt=""></center>
17<map name="Ogre::SceneQuery_map">
18<area href="classOgre_1_1IntersectionSceneQuery.html" alt="Ogre::IntersectionSceneQuery" shape="rect" coords="156,56,458,80">
19<area href="classOgre_1_1RaySceneQuery.html" alt="Ogre::RaySceneQuery" shape="rect" coords="780,56,1082,80">
20<area href="classOgre_1_1RegionSceneQuery.html" alt="Ogre::RegionSceneQuery" shape="rect" coords="1560,56,1862,80">
21<area href="classOgre_1_1DefaultIntersectionSceneQuery.html" alt="Ogre::DefaultIntersectionSceneQuery" shape="rect" coords="156,112,458,136">
22<area href="classOgre_1_1DefaultRaySceneQuery.html" alt="Ogre::DefaultRaySceneQuery" shape="rect" coords="780,112,1082,136">
23<area href="classOgre_1_1AxisAlignedBoxSceneQuery.html" alt="Ogre::AxisAlignedBoxSceneQuery" shape="rect" coords="1248,112,1550,136">
24<area href="classOgre_1_1PlaneBoundedVolumeListSceneQuery.html" alt="Ogre::PlaneBoundedVolumeListSceneQuery" shape="rect" coords="1560,112,1862,136">
25<area href="classOgre_1_1SphereSceneQuery.html" alt="Ogre::SphereSceneQuery" shape="rect" coords="1872,112,2174,136">
26<area href="classOgre_1_1BspIntersectionSceneQuery.html" alt="Ogre::BspIntersectionSceneQuery" shape="rect" coords="0,168,302,192">
27<area href="classOgre_1_1OctreeIntersectionSceneQuery.html" alt="Ogre::OctreeIntersectionSceneQuery" shape="rect" coords="312,168,614,192">
28<area href="classOgre_1_1BspRaySceneQuery.html" alt="Ogre::BspRaySceneQuery" shape="rect" coords="624,168,926,192">
29<area href="classOgre_1_1OctreeRaySceneQuery.html" alt="Ogre::OctreeRaySceneQuery" shape="rect" coords="936,168,1238,192">
30<area href="classOgre_1_1DefaultAxisAlignedBoxSceneQuery.html" alt="Ogre::DefaultAxisAlignedBoxSceneQuery" shape="rect" coords="1248,168,1550,192">
31<area href="classOgre_1_1DefaultPlaneBoundedVolumeListSceneQuery.html" alt="Ogre::DefaultPlaneBoundedVolumeListSceneQuery" shape="rect" coords="1560,168,1862,192">
32<area href="classOgre_1_1DefaultSphereSceneQuery.html" alt="Ogre::DefaultSphereSceneQuery" shape="rect" coords="1872,168,2174,192">
33<area href="classOgre_1_1TerrainRaySceneQuery.html" alt="Ogre::TerrainRaySceneQuery" shape="rect" coords="936,224,1238,248">
34<area href="classOgre_1_1OctreeAxisAlignedBoxSceneQuery.html" alt="Ogre::OctreeAxisAlignedBoxSceneQuery" shape="rect" coords="1248,224,1550,248">
35<area href="classOgre_1_1OctreePlaneBoundedVolumeListSceneQuery.html" alt="Ogre::OctreePlaneBoundedVolumeListSceneQuery" shape="rect" coords="1560,224,1862,248">
36<area href="classOgre_1_1OctreeSphereSceneQuery.html" alt="Ogre::OctreeSphereSceneQuery" shape="rect" coords="1872,224,2174,248">
37</map>
38<a href="classOgre_1_1SceneQuery-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
39<tr><td></td></tr>
40<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
41<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>
42&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0">WFT_NONE</a>,
43<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw1">WFT_PLANE_BOUNDED_REGION</a>,
44<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw2">WFT_SINGLE_INTERSECTION</a>,
45<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw3">WFT_CUSTOM_GEOMETRY</a>,
46<br>
47&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw4">WFT_RENDER_OPERATION</a>
48<br>
49 }</td></tr>
50
51<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>
52<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1SceneQuerya0">SceneQuery</a> (<a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *mgr)</td></tr>
54
55<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_1SceneQuerya0"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1SceneQuerya1">~SceneQuery</a> ()</td></tr>
57
58<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya13">setQueryMask</a> (unsigned long mask)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the mask for results of this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya13"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya14">getQueryMask</a> (void) const </td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the current mask for this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya14"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya15">setWorldFragmentType</a> (enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> wft)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.  <a href="#Ogre_1_1TerrainRaySceneQuerya15"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya16">getWorldFragmentType</a> (void) const </td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current world fragment types to be returned from the query.  <a href="#Ogre_1_1TerrainRaySceneQuerya16"></a><br><br></td></tr>
70<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const std::set&lt; <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> &gt; *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya17">getSupportedWorldFragmentTypes</a> (void) const </td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the types of world fragments this query supports.  <a href="#Ogre_1_1TerrainRaySceneQuerya17"></a><br><br></td></tr>
73<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="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>
75
76<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>
77
78<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>
79
80<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>
81
82</table>
83<hr><a name="_details"></a><h2>Detailed Description</h2>
84A class for performing queries on a scene.
85<p>
86<dl compact><dt><b>Remarks:</b></dt><dd>This is an abstract class for performing a query on a scene, i.e. to retrieve a list of objects and/or world geometry sections which are potentially intersecting a given region. Note the use of the word 'potentially': the results of a scene query are generated based on bounding volumes, and as such are not correct at a triangle level; the user of the <a class="el" href="classOgre_1_1SceneQuery.html">SceneQuery</a> is expected to filter the results further if greater accuracy is required. </dd></dl>
87<dl compact><dt><b></b></dt><dd>Different SceneManagers will implement these queries in different ways to exploit their particular scene organisation, and thus will provide their own concrete subclasses. In fact, these subclasses will be derived from subclasses of this class rather than directly because there will be region-type classes in between. </dd></dl>
88<dl compact><dt><b></b></dt><dd>These queries could have just been implemented as methods on the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>, however, they are wrapped up as objects to allow 'compilation' of queries if deemed appropriate by the implementation; i.e. each concrete subclass may precalculate information (such as fixed scene partitions involved in the query) to speed up the repeated use of the query. </dd></dl>
89<dl compact><dt><b></b></dt><dd>You should never try to create a <a class="el" href="classOgre_1_1SceneQuery.html">SceneQuery</a> object yourself, they should be created using the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> interfaces for the type of query required, e.g. SceneManager::createSphereSceneQuery. </dd></dl>
90
91<p>
92
93<p>
94Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00064">64</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.<hr><h2>Member Enumeration Documentation</h2>
95<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5" doxytag="Ogre::SceneQuery::WorldFragmentType" ></a><p>
96<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
97  <tr>
98    <td class="mdRow">
99      <table cellpadding="0" cellspacing="0" border="0">
100        <tr>
101          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">Ogre::SceneQuery::WorldFragmentType</a>
102      </table>
103    </td>
104  </tr>
105</table>
106<table cellspacing=5 cellpadding=0 border=0>
107  <tr>
108    <td>
109      &nbsp;
110    </td>
111    <td>
112
113<p>
114This type can be used by collaborating applications &amp; SceneManagers to agree on the type of world geometry to be returned from queries.
115<p>
116Not 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>
117<table border=0 cellspacing=2 cellpadding=0>
118<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0" doxytag="WFT_NONE" ></a>WFT_NONE</em>&nbsp;</td><td>
119Return no world geometry hits at all. </td></tr>
120<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>
121Return pointers to convex plane-bounded regions. </td></tr>
122<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>
123Return a single intersection point (typically <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a> only). </td></tr>
124<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>
125Custom geometry as defined by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>. </td></tr>
126<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>
127General <a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> structure. </td></tr>
128</table>
129</dl>
130
131<p>
132Definition 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>
133  </tr>
134</table>
135<hr><h2>Constructor &amp; Destructor Documentation</h2>
136<a class="anchor" name="Ogre_1_1SceneQuerya0" doxytag="Ogre::SceneQuery::SceneQuery" ></a><p>
137<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
138  <tr>
139    <td class="mdRow">
140      <table cellpadding="0" cellspacing="0" border="0">
141        <tr>
142          <td class="md" nowrap valign="top"> Ogre::SceneQuery::SceneQuery </td>
143          <td class="md" valign="top">(&nbsp;</td>
144          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td>
145          <td class="mdname1" valign="top" nowrap> <em>mgr</em>          </td>
146          <td class="md" valign="top">&nbsp;)&nbsp;</td>
147          <td class="md" nowrap></td>
148        </tr>
149
150      </table>
151    </td>
152  </tr>
153</table>
154<table cellspacing=5 cellpadding=0 border=0>
155  <tr>
156    <td>
157      &nbsp;
158    </td>
159    <td>
160
161<p>
162Standard constructor, should be called by <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>.
163<p>
164    </td>
165  </tr>
166</table>
167<a class="anchor" name="Ogre_1_1SceneQuerya1" doxytag="Ogre::SceneQuery::~SceneQuery" ></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::SceneQuery::~<a class="el" href="classOgre_1_1SceneQuery.html">SceneQuery</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_1TerrainRaySceneQuerya14" doxytag="Ogre::SceneQuery::getQueryMask" ></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 unsigned long Ogre::SceneQuery::getQueryMask </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> const<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>
222Returns the current mask for this query.
223<p>
224    </td>
225  </tr>
226</table>
227<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya17" doxytag="Ogre::SceneQuery::getSupportedWorldFragmentTypes" ></a><p>
228<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
229  <tr>
230    <td class="mdRow">
231      <table cellpadding="0" cellspacing="0" border="0">
232        <tr>
233          <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>
234          <td class="md" valign="top">(&nbsp;</td>
235          <td class="md" nowrap valign="top">void&nbsp;</td>
236          <td class="mdname1" valign="top" nowrap>          </td>
237          <td class="md" valign="top">&nbsp;)&nbsp;</td>
238          <td class="md" nowrap> const<code> [virtual]</code></td>
239        </tr>
240
241      </table>
242    </td>
243  </tr>
244</table>
245<table cellspacing=5 cellpadding=0 border=0>
246  <tr>
247    <td>
248      &nbsp;
249    </td>
250    <td>
251
252<p>
253Returns the types of world fragments this query supports.
254<p>
255
256<p>
257Definition 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>
258  </tr>
259</table>
260<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya16" doxytag="Ogre::SceneQuery::getWorldFragmentType" ></a><p>
261<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
262  <tr>
263    <td class="mdRow">
264      <table cellpadding="0" cellspacing="0" border="0">
265        <tr>
266          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> Ogre::SceneQuery::getWorldFragmentType </td>
267          <td class="md" valign="top">(&nbsp;</td>
268          <td class="md" nowrap valign="top">void&nbsp;</td>
269          <td class="mdname1" valign="top" nowrap>          </td>
270          <td class="md" valign="top">&nbsp;)&nbsp;</td>
271          <td class="md" nowrap> const<code> [virtual]</code></td>
272        </tr>
273
274      </table>
275    </td>
276  </tr>
277</table>
278<table cellspacing=5 cellpadding=0 border=0>
279  <tr>
280    <td>
281      &nbsp;
282    </td>
283    <td>
284
285<p>
286Gets the current world fragment types to be returned from the query.
287<p>
288    </td>
289  </tr>
290</table>
291<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya13" doxytag="Ogre::SceneQuery::setQueryMask" ></a><p>
292<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
293  <tr>
294    <td class="mdRow">
295      <table cellpadding="0" cellspacing="0" border="0">
296        <tr>
297          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setQueryMask </td>
298          <td class="md" valign="top">(&nbsp;</td>
299          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
300          <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
301          <td class="md" valign="top">&nbsp;)&nbsp;</td>
302          <td class="md" nowrap><code> [virtual]</code></td>
303        </tr>
304
305      </table>
306    </td>
307  </tr>
308</table>
309<table cellspacing=5 cellpadding=0 border=0>
310  <tr>
311    <td>
312      &nbsp;
313    </td>
314    <td>
315
316<p>
317Sets the mask for results of this query.
318<p>
319<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>
320    </td>
321  </tr>
322</table>
323<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya15" doxytag="Ogre::SceneQuery::setWorldFragmentType" ></a><p>
324<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
325  <tr>
326    <td class="mdRow">
327      <table cellpadding="0" cellspacing="0" border="0">
328        <tr>
329          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setWorldFragmentType </td>
330          <td class="md" valign="top">(&nbsp;</td>
331          <td class="md" nowrap valign="top">enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td>
332          <td class="mdname1" valign="top" nowrap> <em>wft</em>          </td>
333          <td class="md" valign="top">&nbsp;)&nbsp;</td>
334          <td class="md" nowrap><code> [virtual]</code></td>
335        </tr>
336
337      </table>
338    </td>
339  </tr>
340</table>
341<table cellspacing=5 cellpadding=0 border=0>
342  <tr>
343    <td>
344      &nbsp;
345    </td>
346    <td>
347
348<p>
349Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.
350<p>
351<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>
352<dl compact><dt><b></b></dt><dd>The default setting is WFT_NONE. </dd></dl>
353    </td>
354  </tr>
355</table>
356<hr><h2>Member Data Documentation</h2>
357<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp4" doxytag="Ogre::SceneQuery::mParentSceneMgr" ></a><p>
358<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
359  <tr>
360    <td class="mdRow">
361      <table cellpadding="0" cellspacing="0" border="0">
362        <tr>
363          <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]</code>
364      </table>
365    </td>
366  </tr>
367</table>
368<table cellspacing=5 cellpadding=0 border=0>
369  <tr>
370    <td>
371      &nbsp;
372    </td>
373    <td>
374
375<p>
376
377<p>
378Definition 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>
379  </tr>
380</table>
381<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp5" doxytag="Ogre::SceneQuery::mQueryMask" ></a><p>
382<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
383  <tr>
384    <td class="mdRow">
385      <table cellpadding="0" cellspacing="0" border="0">
386        <tr>
387          <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]</code>
388      </table>
389    </td>
390  </tr>
391</table>
392<table cellspacing=5 cellpadding=0 border=0>
393  <tr>
394    <td>
395      &nbsp;
396    </td>
397    <td>
398
399<p>
400
401<p>
402Definition 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>
403  </tr>
404</table>
405<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp6" doxytag="Ogre::SceneQuery::mSupportedWorldFragments" ></a><p>
406<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
407  <tr>
408    <td class="mdRow">
409      <table cellpadding="0" cellspacing="0" border="0">
410        <tr>
411          <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]</code>
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>
424
425<p>
426Definition 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>
427  </tr>
428</table>
429<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp7" doxytag="Ogre::SceneQuery::mWorldFragmentType" ></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"> <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]</code>
436      </table>
437    </td>
438  </tr>
439</table>
440<table cellspacing=5 cellpadding=0 border=0>
441  <tr>
442    <td>
443      &nbsp;
444    </td>
445    <td>
446
447<p>
448
449<p>
450Definition 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>
451  </tr>
452</table>
453<hr>The documentation for this class was generated from the following file:<ul>
454<li><a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a></ul>
455<hr>
456<p>
457Copyright &copy; 2000-2005 by The OGRE Team<br />
458<!--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/>
459This 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/>
460                <!--/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#">
461                <Work rdf:about="">
462                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
463        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
464                </Work>
465                <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> -->
466
467Last modified Sun Feb 12 13:03:22 2006
468</p>
469</body>
470</html>
Note: See TracBrowser for help on using the repository browser.