source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1RaySceneQuery.html @ 692

Revision 692, 52.6 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::RaySceneQuery 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::RaySceneQuery Class Reference</h1>Specialises the <a class="el" href="classOgre_1_1SceneQuery.html">SceneQuery</a> class for querying along a ray. 
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::RaySceneQuery:
16<p><center><img src="classOgre_1_1RaySceneQuery.png" usemap="#Ogre::RaySceneQuery_map" border="0" alt=""></center>
17<map name="Ogre::RaySceneQuery_map">
18<area href="classOgre_1_1SceneQuery.html" alt="Ogre::SceneQuery" shape="rect" coords="0,0,186,24">
19<area href="classOgre_1_1RaySceneQueryListener.html" alt="Ogre::RaySceneQueryListener" shape="rect" coords="196,0,382,24">
20<area href="classOgre_1_1DefaultRaySceneQuery.html" alt="Ogre::DefaultRaySceneQuery" shape="rect" coords="98,112,284,136">
21<area href="classOgre_1_1BspRaySceneQuery.html" alt="Ogre::BspRaySceneQuery" shape="rect" coords="0,168,186,192">
22<area href="classOgre_1_1OctreeRaySceneQuery.html" alt="Ogre::OctreeRaySceneQuery" shape="rect" coords="196,168,382,192">
23<area href="classOgre_1_1TerrainRaySceneQuery.html" alt="Ogre::TerrainRaySceneQuery" shape="rect" coords="196,224,382,248">
24</map>
25<a href="classOgre_1_1RaySceneQuery-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
26<tr><td></td></tr>
27<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
28<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>
29&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0">WFT_NONE</a>,
30<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw1">WFT_PLANE_BOUNDED_REGION</a>,
31<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw2">WFT_SINGLE_INTERSECTION</a>,
32<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw3">WFT_CUSTOM_GEOMETRY</a>,
33<br>
34&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw4">WFT_RENDER_OPERATION</a>
35<br>
36 }</td></tr>
37
38<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>
39<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1RaySceneQuerya0">RaySceneQuery</a> (<a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *mgr)</td></tr>
41
42<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1RaySceneQuerya1">~RaySceneQuery</a> ()</td></tr>
43
44<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya4">setRay</a> (const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;ray)</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the ray which is to be used for this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya4"></a><br><br></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya5">getRay</a> (void) const </td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the ray which is to be used for this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya5"></a><br><br></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya6">setSortByDistance</a> (bool sort, <a class="el" href="namespaceOgre.html#a467">ushort</a> maxresults=0)</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether the results of this query will be sorted by distance along the ray.  <a href="#Ogre_1_1TerrainRaySceneQuerya6"></a><br><br></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya7">getSortByDistance</a> (void) const </td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets whether the results are sorted by distance.  <a href="#Ogre_1_1TerrainRaySceneQuerya7"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya8">getMaxResults</a> (void) const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the maximum number of results returned from the query (only relevant if results are being sorted).  <a href="#Ogre_1_1TerrainRaySceneQuerya8"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a541">RaySceneQueryResult</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya3">execute</a> (void)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Executes the query, returning the results back in one list.  <a href="#Ogre_1_1TerrainRaySceneQuerya3"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1RaySceneQuerya8">execute</a> (<a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *listener)=0</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Executes the query and returns each match through a listener interface.  <a href="#Ogre_1_1RaySceneQuerya8"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a541">RaySceneQueryResult</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya9">getLastResults</a> (void)</td></tr>
66
67<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_1TerrainRaySceneQuerya9"></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_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya10">clearResults</a> (void)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the results of the last query execution.  <a href="#Ogre_1_1TerrainRaySceneQuerya10"></a><br><br></td></tr>
71<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya11">queryResult</a> (<a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *obj, <a class="el" href="namespaceOgre.html#a465">Real</a> distance)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Self-callback in order to deal with execute which returns collection.  <a href="#Ogre_1_1TerrainRaySceneQuerya11"></a><br><br></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya12">queryResult</a> (<a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *fragment, <a class="el" href="namespaceOgre.html#a465">Real</a> distance)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Self-callback in order to deal with execute which returns collection.  <a href="#Ogre_1_1TerrainRaySceneQuerya12"></a><br><br></td></tr>
77<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> (<a class="el" href="namespaceOgre.html#a455">uint32</a> mask)</td></tr>
78
79<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>
80<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a455">uint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya14">getQueryMask</a> (void) const </td></tr>
81
82<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>
83<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">setQueryTypeMask</a> (<a class="el" href="namespaceOgre.html#a455">uint32</a> mask)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the type mask for results of this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya15"></a><br><br></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a455">uint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQuerya16">getQueryTypeMask</a> (void) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the current mask for this query.  <a href="#Ogre_1_1TerrainRaySceneQuerya16"></a><br><br></td></tr>
89<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_1TerrainRaySceneQuerya17">setWorldFragmentType</a> (enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> wft)</td></tr>
90
91<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_1TerrainRaySceneQuerya17"></a><br><br></td></tr>
92<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_1TerrainRaySceneQuerya18">getWorldFragmentType</a> (void) const </td></tr>
93
94<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_1TerrainRaySceneQuerya18"></a><br><br></td></tr>
95<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_1TerrainRaySceneQuerya19">getSupportedWorldFragmentTypes</a> (void) const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the types of world fragments this query supports.  <a href="#Ogre_1_1TerrainRaySceneQuerya19"></a><br><br></td></tr>
98<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
99<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Ray.html">Ray</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp1">mRay</a></td></tr>
100
101<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp2">mSortByDistance</a></td></tr>
102
103<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp3">mMaxResults</a></td></tr>
104
105<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a541">RaySceneQueryResult</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp4">mResult</a></td></tr>
106
107<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_1TerrainRaySceneQueryp5">mParentSceneMgr</a></td></tr>
108
109<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a455">uint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp6">mQueryMask</a></td></tr>
110
111<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a455">uint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp7">mQueryTypeMask</a></td></tr>
112
113<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_1TerrainRaySceneQueryp8">mSupportedWorldFragments</a></td></tr>
114
115<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_1TerrainRaySceneQueryp9">mWorldFragmentType</a></td></tr>
116
117</table>
118<hr><a name="_details"></a><h2>Detailed Description</h2>
119Specialises the <a class="el" href="classOgre_1_1SceneQuery.html">SceneQuery</a> class for querying along a ray.
120<p>
121
122<p>
123Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00366">366</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.<hr><h2>Member Enumeration Documentation</h2>
124<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5" doxytag="Ogre::RaySceneQuery::WorldFragmentType" ></a><p>
125<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
126  <tr>
127    <td class="mdRow">
128      <table cellpadding="0" cellspacing="0" border="0">
129        <tr>
130          <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>
131      </table>
132    </td>
133  </tr>
134</table>
135<table cellspacing=5 cellpadding=0 border=0>
136  <tr>
137    <td>
138      &nbsp;
139    </td>
140    <td>
141
142<p>
143This type can be used by collaborating applications &amp; SceneManagers to agree on the type of world geometry to be returned from queries.
144<p>
145Not 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>
146<table border=0 cellspacing=2 cellpadding=0>
147<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0" doxytag="WFT_NONE" ></a>WFT_NONE</em>&nbsp;</td><td>
148Return no world geometry hits at all. </td></tr>
149<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>
150Return pointers to convex plane-bounded regions. </td></tr>
151<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>
152Return a single intersection point (typically <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a> only). </td></tr>
153<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>
154Custom geometry as defined by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>. </td></tr>
155<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>
156General <a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> structure. </td></tr>
157</table>
158</dl>
159
160<p>
161Definition 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>
162  </tr>
163</table>
164<hr><h2>Constructor &amp; Destructor Documentation</h2>
165<a class="anchor" name="Ogre_1_1RaySceneQuerya0" doxytag="Ogre::RaySceneQuery::RaySceneQuery" ></a><p>
166<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
167  <tr>
168    <td class="mdRow">
169      <table cellpadding="0" cellspacing="0" border="0">
170        <tr>
171          <td class="md" nowrap valign="top"> Ogre::RaySceneQuery::RaySceneQuery </td>
172          <td class="md" valign="top">(&nbsp;</td>
173          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td>
174          <td class="mdname1" valign="top" nowrap> <em>mgr</em>          </td>
175          <td class="md" valign="top">&nbsp;)&nbsp;</td>
176          <td class="md" nowrap></td>
177        </tr>
178
179      </table>
180    </td>
181  </tr>
182</table>
183<table cellspacing=5 cellpadding=0 border=0>
184  <tr>
185    <td>
186      &nbsp;
187    </td>
188    <td>
189
190<p>
191    </td>
192  </tr>
193</table>
194<a class="anchor" name="Ogre_1_1RaySceneQuerya1" doxytag="Ogre::RaySceneQuery::~RaySceneQuery" ></a><p>
195<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
196  <tr>
197    <td class="mdRow">
198      <table cellpadding="0" cellspacing="0" border="0">
199        <tr>
200          <td class="md" nowrap valign="top"> virtual Ogre::RaySceneQuery::~<a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a> </td>
201          <td class="md" valign="top">(&nbsp;</td>
202          <td class="mdname1" valign="top" nowrap>          </td>
203          <td class="md" valign="top">&nbsp;)&nbsp;</td>
204          <td class="md" nowrap><code> [virtual]</code></td>
205        </tr>
206
207      </table>
208    </td>
209  </tr>
210</table>
211<table cellspacing=5 cellpadding=0 border=0>
212  <tr>
213    <td>
214      &nbsp;
215    </td>
216    <td>
217
218<p>
219    </td>
220  </tr>
221</table>
222<hr><h2>Member Function Documentation</h2>
223<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya10" doxytag="Ogre::RaySceneQuery::clearResults" ></a><p>
224<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
225  <tr>
226    <td class="mdRow">
227      <table cellpadding="0" cellspacing="0" border="0">
228        <tr>
229          <td class="md" nowrap valign="top"> virtual void Ogre::RaySceneQuery::clearResults </td>
230          <td class="md" valign="top">(&nbsp;</td>
231          <td class="md" nowrap valign="top">void&nbsp;</td>
232          <td class="mdname1" valign="top" nowrap>          </td>
233          <td class="md" valign="top">&nbsp;)&nbsp;</td>
234          <td class="md" nowrap><code> [virtual]</code></td>
235        </tr>
236
237      </table>
238    </td>
239  </tr>
240</table>
241<table cellspacing=5 cellpadding=0 border=0>
242  <tr>
243    <td>
244      &nbsp;
245    </td>
246    <td>
247
248<p>
249Clears the results of the last query execution.
250<p>
251<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>
252    </td>
253  </tr>
254</table>
255<a class="anchor" name="Ogre_1_1RaySceneQuerya8" doxytag="Ogre::RaySceneQuery::execute" ></a><p>
256<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
257  <tr>
258    <td class="mdRow">
259      <table cellpadding="0" cellspacing="0" border="0">
260        <tr>
261          <td class="md" nowrap valign="top"> virtual void Ogre::RaySceneQuery::execute </td>
262          <td class="md" valign="top">(&nbsp;</td>
263          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *&nbsp;</td>
264          <td class="mdname1" valign="top" nowrap> <em>listener</em>          </td>
265          <td class="md" valign="top">&nbsp;)&nbsp;</td>
266          <td class="md" nowrap><code> [pure virtual]</code></td>
267        </tr>
268
269      </table>
270    </td>
271  </tr>
272</table>
273<table cellspacing=5 cellpadding=0 border=0>
274  <tr>
275    <td>
276      &nbsp;
277    </td>
278    <td>
279
280<p>
281Executes the query and returns each match through a listener interface.
282<p>
283<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>
284
285<p>
286Implemented in <a class="el" href="classOgre_1_1DefaultRaySceneQuery.html#Ogre_1_1DefaultRaySceneQuerya2">Ogre::DefaultRaySceneQuery</a>, <a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQuerya2">Ogre::BspRaySceneQuery</a>, <a class="el" href="classOgre_1_1OctreeRaySceneQuery.html#Ogre_1_1OctreeRaySceneQuerya2">Ogre::OctreeRaySceneQuery</a>, and <a class="el" href="classOgre_1_1TerrainRaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya2">Ogre::TerrainRaySceneQuery</a>.    </td>
287  </tr>
288</table>
289<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya3" doxytag="Ogre::RaySceneQuery::execute" ></a><p>
290<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
291  <tr>
292    <td class="mdRow">
293      <table cellpadding="0" cellspacing="0" border="0">
294        <tr>
295          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a541">RaySceneQueryResult</a>&amp; Ogre::RaySceneQuery::execute </td>
296          <td class="md" valign="top">(&nbsp;</td>
297          <td class="md" nowrap valign="top">void&nbsp;</td>
298          <td class="mdname1" valign="top" nowrap>          </td>
299          <td class="md" valign="top">&nbsp;)&nbsp;</td>
300          <td class="md" nowrap><code> [virtual]</code></td>
301        </tr>
302
303      </table>
304    </td>
305  </tr>
306</table>
307<table cellspacing=5 cellpadding=0 border=0>
308  <tr>
309    <td>
310      &nbsp;
311    </td>
312    <td>
313
314<p>
315Executes the query, returning the results back in one list.
316<p>
317<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_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya10">clearResults()</a> is called. An more lightweight version of this method that returns results through a listener is also available. </dd></dl>
318    </td>
319  </tr>
320</table>
321<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya9" doxytag="Ogre::RaySceneQuery::getLastResults" ></a><p>
322<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
323  <tr>
324    <td class="mdRow">
325      <table cellpadding="0" cellspacing="0" border="0">
326        <tr>
327          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a541">RaySceneQueryResult</a>&amp; Ogre::RaySceneQuery::getLastResults </td>
328          <td class="md" valign="top">(&nbsp;</td>
329          <td class="md" nowrap valign="top">void&nbsp;</td>
330          <td class="mdname1" valign="top" nowrap>          </td>
331          <td class="md" valign="top">&nbsp;)&nbsp;</td>
332          <td class="md" nowrap><code> [virtual]</code></td>
333        </tr>
334
335      </table>
336    </td>
337  </tr>
338</table>
339<table cellspacing=5 cellpadding=0 border=0>
340  <tr>
341    <td>
342      &nbsp;
343    </td>
344    <td>
345
346<p>
347Gets the results of the last query that was run using this object, provided the query was executed using the collection-returning version of execute.
348<p>
349    </td>
350  </tr>
351</table>
352<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya8" doxytag="Ogre::RaySceneQuery::getMaxResults" ></a><p>
353<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
354  <tr>
355    <td class="mdRow">
356      <table cellpadding="0" cellspacing="0" border="0">
357        <tr>
358          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a467">ushort</a> Ogre::RaySceneQuery::getMaxResults </td>
359          <td class="md" valign="top">(&nbsp;</td>
360          <td class="md" nowrap valign="top">void&nbsp;</td>
361          <td class="mdname1" valign="top" nowrap>          </td>
362          <td class="md" valign="top">&nbsp;)&nbsp;</td>
363          <td class="md" nowrap> const<code> [virtual]</code></td>
364        </tr>
365
366      </table>
367    </td>
368  </tr>
369</table>
370<table cellspacing=5 cellpadding=0 border=0>
371  <tr>
372    <td>
373      &nbsp;
374    </td>
375    <td>
376
377<p>
378Gets the maximum number of results returned from the query (only relevant if results are being sorted).
379<p>
380    </td>
381  </tr>
382</table>
383<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya14" doxytag="Ogre::RaySceneQuery::getQueryMask" ></a><p>
384<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
385  <tr>
386    <td class="mdRow">
387      <table cellpadding="0" cellspacing="0" border="0">
388        <tr>
389          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a455">uint32</a> Ogre::SceneQuery::getQueryMask </td>
390          <td class="md" valign="top">(&nbsp;</td>
391          <td class="md" nowrap valign="top">void&nbsp;</td>
392          <td class="mdname1" valign="top" nowrap>          </td>
393          <td class="md" valign="top">&nbsp;)&nbsp;</td>
394          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
395        </tr>
396
397      </table>
398    </td>
399  </tr>
400</table>
401<table cellspacing=5 cellpadding=0 border=0>
402  <tr>
403    <td>
404      &nbsp;
405    </td>
406    <td>
407
408<p>
409Returns the current mask for this query.
410<p>
411    </td>
412  </tr>
413</table>
414<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya16" doxytag="Ogre::RaySceneQuery::getQueryTypeMask" ></a><p>
415<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
416  <tr>
417    <td class="mdRow">
418      <table cellpadding="0" cellspacing="0" border="0">
419        <tr>
420          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a455">uint32</a> Ogre::SceneQuery::getQueryTypeMask </td>
421          <td class="md" valign="top">(&nbsp;</td>
422          <td class="md" nowrap valign="top">void&nbsp;</td>
423          <td class="mdname1" valign="top" nowrap>          </td>
424          <td class="md" valign="top">&nbsp;)&nbsp;</td>
425          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
426        </tr>
427
428      </table>
429    </td>
430  </tr>
431</table>
432<table cellspacing=5 cellpadding=0 border=0>
433  <tr>
434    <td>
435      &nbsp;
436    </td>
437    <td>
438
439<p>
440Returns the current mask for this query.
441<p>
442    </td>
443  </tr>
444</table>
445<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya5" doxytag="Ogre::RaySceneQuery::getRay" ></a><p>
446<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
447  <tr>
448    <td class="mdRow">
449      <table cellpadding="0" cellspacing="0" border="0">
450        <tr>
451          <td class="md" nowrap valign="top"> virtual const <a class="el" href="classOgre_1_1Ray.html">Ray</a>&amp; Ogre::RaySceneQuery::getRay </td>
452          <td class="md" valign="top">(&nbsp;</td>
453          <td class="md" nowrap valign="top">void&nbsp;</td>
454          <td class="mdname1" valign="top" nowrap>          </td>
455          <td class="md" valign="top">&nbsp;)&nbsp;</td>
456          <td class="md" nowrap> const<code> [virtual]</code></td>
457        </tr>
458
459      </table>
460    </td>
461  </tr>
462</table>
463<table cellspacing=5 cellpadding=0 border=0>
464  <tr>
465    <td>
466      &nbsp;
467    </td>
468    <td>
469
470<p>
471Gets the ray which is to be used for this query.
472<p>
473    </td>
474  </tr>
475</table>
476<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya7" doxytag="Ogre::RaySceneQuery::getSortByDistance" ></a><p>
477<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
478  <tr>
479    <td class="mdRow">
480      <table cellpadding="0" cellspacing="0" border="0">
481        <tr>
482          <td class="md" nowrap valign="top"> virtual bool Ogre::RaySceneQuery::getSortByDistance </td>
483          <td class="md" valign="top">(&nbsp;</td>
484          <td class="md" nowrap valign="top">void&nbsp;</td>
485          <td class="mdname1" valign="top" nowrap>          </td>
486          <td class="md" valign="top">&nbsp;)&nbsp;</td>
487          <td class="md" nowrap> const<code> [virtual]</code></td>
488        </tr>
489
490      </table>
491    </td>
492  </tr>
493</table>
494<table cellspacing=5 cellpadding=0 border=0>
495  <tr>
496    <td>
497      &nbsp;
498    </td>
499    <td>
500
501<p>
502Gets whether the results are sorted by distance.
503<p>
504    </td>
505  </tr>
506</table>
507<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya19" doxytag="Ogre::RaySceneQuery::getSupportedWorldFragmentTypes" ></a><p>
508<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
509  <tr>
510    <td class="mdRow">
511      <table cellpadding="0" cellspacing="0" border="0">
512        <tr>
513          <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>
514          <td class="md" valign="top">(&nbsp;</td>
515          <td class="md" nowrap valign="top">void&nbsp;</td>
516          <td class="mdname1" valign="top" nowrap>          </td>
517          <td class="md" valign="top">&nbsp;)&nbsp;</td>
518          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
519        </tr>
520
521      </table>
522    </td>
523  </tr>
524</table>
525<table cellspacing=5 cellpadding=0 border=0>
526  <tr>
527    <td>
528      &nbsp;
529    </td>
530    <td>
531
532<p>
533Returns the types of world fragments this query supports.
534<p>
535
536<p>
537Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00165">165</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
538  </tr>
539</table>
540<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya18" doxytag="Ogre::RaySceneQuery::getWorldFragmentType" ></a><p>
541<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
542  <tr>
543    <td class="mdRow">
544      <table cellpadding="0" cellspacing="0" border="0">
545        <tr>
546          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> Ogre::SceneQuery::getWorldFragmentType </td>
547          <td class="md" valign="top">(&nbsp;</td>
548          <td class="md" nowrap valign="top">void&nbsp;</td>
549          <td class="mdname1" valign="top" nowrap>          </td>
550          <td class="md" valign="top">&nbsp;)&nbsp;</td>
551          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
552        </tr>
553
554      </table>
555    </td>
556  </tr>
557</table>
558<table cellspacing=5 cellpadding=0 border=0>
559  <tr>
560    <td>
561      &nbsp;
562    </td>
563    <td>
564
565<p>
566Gets the current world fragment types to be returned from the query.
567<p>
568    </td>
569  </tr>
570</table>
571<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya12" doxytag="Ogre::RaySceneQuery::queryResult" ></a><p>
572<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
573  <tr>
574    <td class="mdRow">
575      <table cellpadding="0" cellspacing="0" border="0">
576        <tr>
577          <td class="md" nowrap valign="top"> bool Ogre::RaySceneQuery::queryResult </td>
578          <td class="md" valign="top">(&nbsp;</td>
579          <td class="md" nowrap valign="top"><a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *&nbsp;</td>
580          <td class="mdname" nowrap> <em>fragment</em>, </td>
581        </tr>
582        <tr>
583          <td class="md" nowrap align="right"></td>
584          <td></td>
585          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
586          <td class="mdname" nowrap> <em>distance</em></td>
587        </tr>
588        <tr>
589          <td></td>
590          <td class="md">)&nbsp;</td>
591          <td class="md" colspan="2"><code> [virtual]</code></td>
592        </tr>
593
594      </table>
595    </td>
596  </tr>
597</table>
598<table cellspacing=5 cellpadding=0 border=0>
599  <tr>
600    <td>
601      &nbsp;
602    </td>
603    <td>
604
605<p>
606Self-callback in order to deal with execute which returns collection.
607<p>
608
609<p>
610Implements <a class="el" href="classOgre_1_1RaySceneQueryListener.html#Ogre_1_1RaySceneQueryListenera2">Ogre::RaySceneQueryListener</a>.    </td>
611  </tr>
612</table>
613<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya11" doxytag="Ogre::RaySceneQuery::queryResult" ></a><p>
614<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
615  <tr>
616    <td class="mdRow">
617      <table cellpadding="0" cellspacing="0" border="0">
618        <tr>
619          <td class="md" nowrap valign="top"> bool Ogre::RaySceneQuery::queryResult </td>
620          <td class="md" valign="top">(&nbsp;</td>
621          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
622          <td class="mdname" nowrap> <em>obj</em>, </td>
623        </tr>
624        <tr>
625          <td class="md" nowrap align="right"></td>
626          <td></td>
627          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
628          <td class="mdname" nowrap> <em>distance</em></td>
629        </tr>
630        <tr>
631          <td></td>
632          <td class="md">)&nbsp;</td>
633          <td class="md" colspan="2"><code> [virtual]</code></td>
634        </tr>
635
636      </table>
637    </td>
638  </tr>
639</table>
640<table cellspacing=5 cellpadding=0 border=0>
641  <tr>
642    <td>
643      &nbsp;
644    </td>
645    <td>
646
647<p>
648Self-callback in order to deal with execute which returns collection.
649<p>
650
651<p>
652Implements <a class="el" href="classOgre_1_1RaySceneQueryListener.html#Ogre_1_1RaySceneQueryListenera1">Ogre::RaySceneQueryListener</a>.    </td>
653  </tr>
654</table>
655<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya13" doxytag="Ogre::RaySceneQuery::setQueryMask" ></a><p>
656<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
657  <tr>
658    <td class="mdRow">
659      <table cellpadding="0" cellspacing="0" border="0">
660        <tr>
661          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setQueryMask </td>
662          <td class="md" valign="top">(&nbsp;</td>
663          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a455">uint32</a>&nbsp;</td>
664          <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
665          <td class="md" valign="top">&nbsp;)&nbsp;</td>
666          <td class="md" nowrap><code> [virtual, inherited]</code></td>
667        </tr>
668
669      </table>
670    </td>
671  </tr>
672</table>
673<table cellspacing=5 cellpadding=0 border=0>
674  <tr>
675    <td>
676      &nbsp;
677    </td>
678    <td>
679
680<p>
681Sets the mask for results of this query.
682<p>
683<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_1WireBoundingBoxa41">MovableObject::getQueryFlags</a> value is non-zero. The application will have to decide what each of the bits means. </dd></dl>
684    </td>
685  </tr>
686</table>
687<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya15" doxytag="Ogre::RaySceneQuery::setQueryTypeMask" ></a><p>
688<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
689  <tr>
690    <td class="mdRow">
691      <table cellpadding="0" cellspacing="0" border="0">
692        <tr>
693          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setQueryTypeMask </td>
694          <td class="md" valign="top">(&nbsp;</td>
695          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a455">uint32</a>&nbsp;</td>
696          <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
697          <td class="md" valign="top">&nbsp;)&nbsp;</td>
698          <td class="md" nowrap><code> [virtual, inherited]</code></td>
699        </tr>
700
701      </table>
702    </td>
703  </tr>
704</table>
705<table cellspacing=5 cellpadding=0 border=0>
706  <tr>
707    <td>
708      &nbsp;
709    </td>
710    <td>
711
712<p>
713Sets the type mask for results of this query.
714<p>
715<dl compact><dt><b>Remarks:</b></dt><dd>This method allows you to set a 'type mask' to limit the results of this query to certain types of objects. Whilst setQueryMask deals with flags set per instance of object, this method deals with setting a mask on flags set per type of object. Both may exclude an object from query results. </dd></dl>
716    </td>
717  </tr>
718</table>
719<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya4" doxytag="Ogre::RaySceneQuery::setRay" ></a><p>
720<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
721  <tr>
722    <td class="mdRow">
723      <table cellpadding="0" cellspacing="0" border="0">
724        <tr>
725          <td class="md" nowrap valign="top"> virtual void Ogre::RaySceneQuery::setRay </td>
726          <td class="md" valign="top">(&nbsp;</td>
727          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;&nbsp;</td>
728          <td class="mdname1" valign="top" nowrap> <em>ray</em>          </td>
729          <td class="md" valign="top">&nbsp;)&nbsp;</td>
730          <td class="md" nowrap><code> [virtual]</code></td>
731        </tr>
732
733      </table>
734    </td>
735  </tr>
736</table>
737<table cellspacing=5 cellpadding=0 border=0>
738  <tr>
739    <td>
740      &nbsp;
741    </td>
742    <td>
743
744<p>
745Sets the ray which is to be used for this query.
746<p>
747    </td>
748  </tr>
749</table>
750<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya6" doxytag="Ogre::RaySceneQuery::setSortByDistance" ></a><p>
751<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
752  <tr>
753    <td class="mdRow">
754      <table cellpadding="0" cellspacing="0" border="0">
755        <tr>
756          <td class="md" nowrap valign="top"> virtual void Ogre::RaySceneQuery::setSortByDistance </td>
757          <td class="md" valign="top">(&nbsp;</td>
758          <td class="md" nowrap valign="top">bool&nbsp;</td>
759          <td class="mdname" nowrap> <em>sort</em>, </td>
760        </tr>
761        <tr>
762          <td class="md" nowrap align="right"></td>
763          <td></td>
764          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td>
765          <td class="mdname" nowrap> <em>maxresults</em> = 0</td>
766        </tr>
767        <tr>
768          <td></td>
769          <td class="md">)&nbsp;</td>
770          <td class="md" colspan="2"><code> [virtual]</code></td>
771        </tr>
772
773      </table>
774    </td>
775  </tr>
776</table>
777<table cellspacing=5 cellpadding=0 border=0>
778  <tr>
779    <td>
780      &nbsp;
781    </td>
782    <td>
783
784<p>
785Sets whether the results of this query will be sorted by distance along the ray.
786<p>
787<dl compact><dt><b>Remarks:</b></dt><dd>Often you want to know what was the first object a ray intersected with, and this method allows you to ask the query to sort the results so that the nearest results are listed first. </dd></dl>
788<dl compact><dt><b></b></dt><dd>Note that because the query returns results based on bounding volumes, the ray may not actually intersect the detail of the objects returned from the query, just their bounding volumes. For this reason the caller is advised to use more detailed intersection tests on the results if a more accurate result is required; OGRE uses bounds checking in order to give the most speedy results since not all applications need extreme accuracy. </dd></dl>
789<dl compact><dt><b>Parameters:</b></dt><dd>
790  <table border="0" cellspacing="2" cellpadding="0">
791    <tr><td valign=top><em>sort</em>&nbsp;</td><td>If true, results will be sorted. </td></tr>
792    <tr><td valign=top><em>maxresults</em>&nbsp;</td><td>If sorting is enabled, this value can be used to constrain the maximum number of results that are returned. Please note (as above) that the use of bounding volumes mean that accuracy is not guaranteed; if in doubt, allow more results and filter them in more detail. 0 means unlimited results. </td></tr>
793  </table>
794</dl>
795    </td>
796  </tr>
797</table>
798<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya17" doxytag="Ogre::RaySceneQuery::setWorldFragmentType" ></a><p>
799<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
800  <tr>
801    <td class="mdRow">
802      <table cellpadding="0" cellspacing="0" border="0">
803        <tr>
804          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setWorldFragmentType </td>
805          <td class="md" valign="top">(&nbsp;</td>
806          <td class="md" nowrap valign="top">enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td>
807          <td class="mdname1" valign="top" nowrap> <em>wft</em>          </td>
808          <td class="md" valign="top">&nbsp;)&nbsp;</td>
809          <td class="md" nowrap><code> [virtual, inherited]</code></td>
810        </tr>
811
812      </table>
813    </td>
814  </tr>
815</table>
816<table cellspacing=5 cellpadding=0 border=0>
817  <tr>
818    <td>
819      &nbsp;
820    </td>
821    <td>
822
823<p>
824Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.
825<p>
826<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>
827<dl compact><dt><b></b></dt><dd>The default setting is WFT_NONE. </dd></dl>
828    </td>
829  </tr>
830</table>
831<hr><h2>Member Data Documentation</h2>
832<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp3" doxytag="Ogre::RaySceneQuery::mMaxResults" ></a><p>
833<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
834  <tr>
835    <td class="mdRow">
836      <table cellpadding="0" cellspacing="0" border="0">
837        <tr>
838          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a467">ushort</a> <a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp3">Ogre::RaySceneQuery::mMaxResults</a><code> [protected]</code>
839      </table>
840    </td>
841  </tr>
842</table>
843<table cellspacing=5 cellpadding=0 border=0>
844  <tr>
845    <td>
846      &nbsp;
847    </td>
848    <td>
849
850<p>
851
852<p>
853Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00371">371</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
854  </tr>
855</table>
856<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp5" doxytag="Ogre::RaySceneQuery::mParentSceneMgr" ></a><p>
857<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
858  <tr>
859    <td class="mdRow">
860      <table cellpadding="0" cellspacing="0" border="0">
861        <tr>
862          <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_1TerrainRaySceneQueryp5">Ogre::SceneQuery::mParentSceneMgr</a><code> [protected, inherited]</code>
863      </table>
864    </td>
865  </tr>
866</table>
867<table cellspacing=5 cellpadding=0 border=0>
868  <tr>
869    <td>
870      &nbsp;
871    </td>
872    <td>
873
874<p>
875
876<p>
877Definition 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>
878  </tr>
879</table>
880<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp6" doxytag="Ogre::RaySceneQuery::mQueryMask" ></a><p>
881<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
882  <tr>
883    <td class="mdRow">
884      <table cellpadding="0" cellspacing="0" border="0">
885        <tr>
886          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a455">uint32</a> <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp6">Ogre::SceneQuery::mQueryMask</a><code> [protected, inherited]</code>
887      </table>
888    </td>
889  </tr>
890</table>
891<table cellspacing=5 cellpadding=0 border=0>
892  <tr>
893    <td>
894      &nbsp;
895    </td>
896    <td>
897
898<p>
899
900<p>
901Definition 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>
902  </tr>
903</table>
904<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp7" doxytag="Ogre::RaySceneQuery::mQueryTypeMask" ></a><p>
905<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
906  <tr>
907    <td class="mdRow">
908      <table cellpadding="0" cellspacing="0" border="0">
909        <tr>
910          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a455">uint32</a> <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryp7">Ogre::SceneQuery::mQueryTypeMask</a><code> [protected, inherited]</code>
911      </table>
912    </td>
913  </tr>
914</table>
915<table cellspacing=5 cellpadding=0 border=0>
916  <tr>
917    <td>
918      &nbsp;
919    </td>
920    <td>
921
922<p>
923
924<p>
925Definition 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>
926  </tr>
927</table>
928<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp1" doxytag="Ogre::RaySceneQuery::mRay" ></a><p>
929<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
930  <tr>
931    <td class="mdRow">
932      <table cellpadding="0" cellspacing="0" border="0">
933        <tr>
934          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Ray.html">Ray</a> <a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp1">Ogre::RaySceneQuery::mRay</a><code> [protected]</code>
935      </table>
936    </td>
937  </tr>
938</table>
939<table cellspacing=5 cellpadding=0 border=0>
940  <tr>
941    <td>
942      &nbsp;
943    </td>
944    <td>
945
946<p>
947
948<p>
949Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00369">369</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
950  </tr>
951</table>
952<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp4" doxytag="Ogre::RaySceneQuery::mResult" ></a><p>
953<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
954  <tr>
955    <td class="mdRow">
956      <table cellpadding="0" cellspacing="0" border="0">
957        <tr>
958          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a541">RaySceneQueryResult</a> <a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp4">Ogre::RaySceneQuery::mResult</a><code> [protected]</code>
959      </table>
960    </td>
961  </tr>
962</table>
963<table cellspacing=5 cellpadding=0 border=0>
964  <tr>
965    <td>
966      &nbsp;
967    </td>
968    <td>
969
970<p>
971
972<p>
973Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00372">372</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
974  </tr>
975</table>
976<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp2" doxytag="Ogre::RaySceneQuery::mSortByDistance" ></a><p>
977<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
978  <tr>
979    <td class="mdRow">
980      <table cellpadding="0" cellspacing="0" border="0">
981        <tr>
982          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp2">Ogre::RaySceneQuery::mSortByDistance</a><code> [protected]</code>
983      </table>
984    </td>
985  </tr>
986</table>
987<table cellspacing=5 cellpadding=0 border=0>
988  <tr>
989    <td>
990      &nbsp;
991    </td>
992    <td>
993
994<p>
995
996<p>
997Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00370">370</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
998  </tr>
999</table>
1000<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp8" doxytag="Ogre::RaySceneQuery::mSupportedWorldFragments" ></a><p>
1001<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1002  <tr>
1003    <td class="mdRow">
1004      <table cellpadding="0" cellspacing="0" border="0">
1005        <tr>
1006          <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_1TerrainRaySceneQueryp8">Ogre::SceneQuery::mSupportedWorldFragments</a><code> [protected, inherited]</code>
1007      </table>
1008    </td>
1009  </tr>
1010</table>
1011<table cellspacing=5 cellpadding=0 border=0>
1012  <tr>
1013    <td>
1014      &nbsp;
1015    </td>
1016    <td>
1017
1018<p>
1019
1020<p>
1021Definition 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>
1022  </tr>
1023</table>
1024<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp9" doxytag="Ogre::RaySceneQuery::mWorldFragmentType" ></a><p>
1025<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1026  <tr>
1027    <td class="mdRow">
1028      <table cellpadding="0" cellspacing="0" border="0">
1029        <tr>
1030          <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_1TerrainRaySceneQueryp9">Ogre::SceneQuery::mWorldFragmentType</a><code> [protected, inherited]</code>
1031      </table>
1032    </td>
1033  </tr>
1034</table>
1035<table cellspacing=5 cellpadding=0 border=0>
1036  <tr>
1037    <td>
1038      &nbsp;
1039    </td>
1040    <td>
1041
1042<p>
1043
1044<p>
1045Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00117">117</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
1046  </tr>
1047</table>
1048<hr>The documentation for this class was generated from the following file:<ul>
1049<li><a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a></ul>
1050<hr>
1051<p>
1052Copyright &copy; 2000-2005 by The OGRE Team<br />
1053<!--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/>
1054This 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/>
1055                <!--/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#">
1056                <Work rdf:about="">
1057                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1058        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1059                </Work>
1060                <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> -->
1061
1062Last modified Sun Mar 12 14:44:00 2006
1063</p>
1064</body>
1065</html>
Note: See TracBrowser for help on using the repository browser.