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

Revision 657, 57.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::BspRaySceneQuery 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::BspRaySceneQuery Class Reference</h1>BSP specialisation of <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::BspRaySceneQuery:
16<p><center><img src="classOgre_1_1BspRaySceneQuery.png" usemap="#Ogre::BspRaySceneQuery_map" border="0" alt=""></center>
17<map name="Ogre::BspRaySceneQuery_map">
18<area href="classOgre_1_1DefaultRaySceneQuery.html" alt="Ogre::DefaultRaySceneQuery" shape="rect" coords="98,112,284,136">
19<area href="classOgre_1_1RaySceneQuery.html" alt="Ogre::RaySceneQuery" shape="rect" coords="98,56,284,80">
20<area href="classOgre_1_1SceneQuery.html" alt="Ogre::SceneQuery" shape="rect" coords="0,0,186,24">
21<area href="classOgre_1_1RaySceneQueryListener.html" alt="Ogre::RaySceneQueryListener" shape="rect" coords="196,0,382,24">
22</map>
23<a href="classOgre_1_1BspRaySceneQuery-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
24<tr><td></td></tr>
25<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> { <br>
27&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0">WFT_NONE</a>,
28<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw1">WFT_PLANE_BOUNDED_REGION</a>,
29<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw2">WFT_SINGLE_INTERSECTION</a>,
30<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw3">WFT_CUSTOM_GEOMETRY</a>,
31<br>
32&nbsp;&nbsp;<a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw4">WFT_RENDER_OPERATION</a>
33<br>
34 }</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This type can be used by collaborating applications &amp; SceneManagers to agree on the type of world geometry to be returned from queries.  <a href="#Ogre_1_1TerrainRaySceneQueryw5">More...</a><br><br></td></tr>
37<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQuerya0">BspRaySceneQuery</a> (<a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *creator)</td></tr>
39
40<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQuerya1">~BspRaySceneQuery</a> ()</td></tr>
41
42<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQuerya2">execute</a> (<a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *listener)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a>.  <a href="#Ogre_1_1BspRaySceneQuerya2"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a496">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>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Executes the query, returning the results back in one list.  <a href="#Ogre_1_1TerrainRaySceneQuerya3"></a><br><br></td></tr>
48<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>
49
50<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>
51<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>
52
53<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>
54<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#a422">ushort</a> maxresults=0)</td></tr>
55
56<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>
57<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>
58
59<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>
60<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a422">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>
61
62<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>
63<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a496">RaySceneQueryResult</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya9">getLastResults</a> (void) const </td></tr>
64
65<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>
66<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQuerya10">clearResults</a> (void)</td></tr>
67
68<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>
69<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#a420">Real</a> distance)</td></tr>
70
71<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>
72<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#a420">Real</a> distance)</td></tr>
73
74<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>
75<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>
76
77<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>
78<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>
79
80<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>
81<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>
82
83<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>
84<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>
85
86<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>
87<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>
88
89<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>
90<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
91<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQueryb0">clearTemporaries</a> (void)</td></tr>
92
93<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQueryb1">processNode</a> (const <a class="el" href="classOgre_1_1BspNode.html">BspNode</a> *node, const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;tracingRay, <a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *listener, <a class="el" href="namespaceOgre.html#a420">Real</a> maxDistance=<a class="el" href="classOgre_1_1Math.html#Ogre_1_1Maths0">Math::POS_INFINITY</a>, <a class="el" href="namespaceOgre.html#a420">Real</a> traceDistance=0.0f)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal processing of a single node.  <a href="#Ogre_1_1BspRaySceneQueryb1"></a><br><br></td></tr>
96<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQueryb2">processLeaf</a> (const <a class="el" href="classOgre_1_1BspNode.html">BspNode</a> *node, const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;tracingRay, <a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *listener, <a class="el" href="namespaceOgre.html#a420">Real</a> maxDistance=<a class="el" href="classOgre_1_1Math.html#Ogre_1_1Maths0">Math::POS_INFINITY</a>, <a class="el" href="namespaceOgre.html#a420">Real</a> traceDistance=0.0f)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal processing of a single leaf.  <a href="#Ogre_1_1BspRaySceneQueryb2"></a><br><br></td></tr>
99<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
100<tr><td class="memItemLeft" nowrap align=right valign=top>std::set&lt; <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQueryp0">mObjsThisQuery</a></td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set for eliminating duplicates since objects can be in &gt; 1 node.  <a href="#Ogre_1_1BspRaySceneQueryp0"></a><br><br></td></tr>
103<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector&lt; <a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQueryp1">mSingleIntersections</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">list of the last single intersection world fragments (derived)  <a href="#Ogre_1_1BspRaySceneQueryp1"></a><br><br></td></tr>
106<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_1TerrainRaySceneQueryp0">mRay</a></td></tr>
107
108<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_1TerrainRaySceneQueryp1">mSortByDistance</a></td></tr>
109
110<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a422">ushort</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp2">mMaxResults</a></td></tr>
111
112<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a496">RaySceneQueryResult</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp3">mLastResult</a></td></tr>
113
114<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>
115
116<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>
117
118<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>
119
120<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>
121
122</table>
123<hr><a name="_details"></a><h2>Detailed Description</h2>
124BSP specialisation of <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a>.
125<p>
126
127<p>
128Definition at line <a class="el" href="OgreBspSceneManager_8h-source.html#l00224">224</a> of file <a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a>.<hr><h2>Member Enumeration Documentation</h2>
129<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5" doxytag="Ogre::BspRaySceneQuery::WorldFragmentType" ></a><p>
130<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
131  <tr>
132    <td class="mdRow">
133      <table cellpadding="0" cellspacing="0" border="0">
134        <tr>
135          <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>
136      </table>
137    </td>
138  </tr>
139</table>
140<table cellspacing=5 cellpadding=0 border=0>
141  <tr>
142    <td>
143      &nbsp;
144    </td>
145    <td>
146
147<p>
148This type can be used by collaborating applications &amp; SceneManagers to agree on the type of world geometry to be returned from queries.
149<p>
150Not 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>
151<table border=0 cellspacing=2 cellpadding=0>
152<tr><td valign=top><em><a class="anchor" name="Ogre_1_1TerrainRaySceneQueryw5Ogre_1_1TerrainRaySceneQueryw0" doxytag="WFT_NONE" ></a>WFT_NONE</em>&nbsp;</td><td>
153Return no world geometry hits at all. </td></tr>
154<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>
155Return pointers to convex plane-bounded regions. </td></tr>
156<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>
157Return a single intersection point (typically <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a> only). </td></tr>
158<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>
159Custom geometry as defined by the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>. </td></tr>
160<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>
161General <a class="el" href="classOgre_1_1RenderOperation.html">RenderOperation</a> structure. </td></tr>
162</table>
163</dl>
164
165<p>
166Definition 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>
167  </tr>
168</table>
169<hr><h2>Constructor &amp; Destructor Documentation</h2>
170<a class="anchor" name="Ogre_1_1BspRaySceneQuerya0" doxytag="Ogre::BspRaySceneQuery::BspRaySceneQuery" ></a><p>
171<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
172  <tr>
173    <td class="mdRow">
174      <table cellpadding="0" cellspacing="0" border="0">
175        <tr>
176          <td class="md" nowrap valign="top"> Ogre::BspRaySceneQuery::BspRaySceneQuery </td>
177          <td class="md" valign="top">(&nbsp;</td>
178          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td>
179          <td class="mdname1" valign="top" nowrap> <em>creator</em>          </td>
180          <td class="md" valign="top">&nbsp;)&nbsp;</td>
181          <td class="md" nowrap></td>
182        </tr>
183
184      </table>
185    </td>
186  </tr>
187</table>
188<table cellspacing=5 cellpadding=0 border=0>
189  <tr>
190    <td>
191      &nbsp;
192    </td>
193    <td>
194
195<p>
196    </td>
197  </tr>
198</table>
199<a class="anchor" name="Ogre_1_1BspRaySceneQuerya1" doxytag="Ogre::BspRaySceneQuery::~BspRaySceneQuery" ></a><p>
200<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
201  <tr>
202    <td class="mdRow">
203      <table cellpadding="0" cellspacing="0" border="0">
204        <tr>
205          <td class="md" nowrap valign="top"> Ogre::BspRaySceneQuery::~<a class="el" href="classOgre_1_1BspRaySceneQuery.html">BspRaySceneQuery</a> </td>
206          <td class="md" valign="top">(&nbsp;</td>
207          <td class="mdname1" valign="top" nowrap>          </td>
208          <td class="md" valign="top">&nbsp;)&nbsp;</td>
209          <td class="md" nowrap></td>
210        </tr>
211
212      </table>
213    </td>
214  </tr>
215</table>
216<table cellspacing=5 cellpadding=0 border=0>
217  <tr>
218    <td>
219      &nbsp;
220    </td>
221    <td>
222
223<p>
224    </td>
225  </tr>
226</table>
227<hr><h2>Member Function Documentation</h2>
228<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya10" doxytag="Ogre::BspRaySceneQuery::clearResults" ></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::RaySceneQuery::clearResults </td>
235          <td class="md" valign="top">(&nbsp;</td>
236          <td class="md" nowrap valign="top">void&nbsp;</td>
237          <td class="mdname1" valign="top" nowrap>          </td>
238          <td class="md" valign="top">&nbsp;)&nbsp;</td>
239          <td class="md" nowrap><code> [virtual, inherited]</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>
254Clears the results of the last query execution.
255<p>
256<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>
257    </td>
258  </tr>
259</table>
260<a class="anchor" name="Ogre_1_1BspRaySceneQueryb0" doxytag="Ogre::BspRaySceneQuery::clearTemporaries" ></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"> void Ogre::BspRaySceneQuery::clearTemporaries </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><code> [protected]</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>
286    </td>
287  </tr>
288</table>
289<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya3" doxytag="Ogre::BspRaySceneQuery::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#a496">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, inherited]</code></td>
301        </tr>
302
303      </table>
304    </td>
305  </tr>
306</table>
307<table cellspacing=5 cellpadding=0 border=0>
308  <tr>
309    <td>
310      &nbsp;
311    </td>
312    <td>
313
314<p>
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_1BspRaySceneQuerya2" doxytag="Ogre::BspRaySceneQuery::execute" ></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"> void Ogre::BspRaySceneQuery::execute </td>
328          <td class="md" valign="top">(&nbsp;</td>
329          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *&nbsp;</td>
330          <td class="mdname1" valign="top" nowrap> <em>listener</em>          </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>
347See <a class="el" href="classOgre_1_1RaySceneQuery.html">RaySceneQuery</a>.
348<p>
349
350<p>
351Reimplemented from <a class="el" href="classOgre_1_1DefaultRaySceneQuery.html#Ogre_1_1DefaultRaySceneQuerya2">Ogre::DefaultRaySceneQuery</a>.    </td>
352  </tr>
353</table>
354<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya9" doxytag="Ogre::BspRaySceneQuery::getLastResults" ></a><p>
355<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
356  <tr>
357    <td class="mdRow">
358      <table cellpadding="0" cellspacing="0" border="0">
359        <tr>
360          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a496">RaySceneQueryResult</a>&amp; Ogre::RaySceneQuery::getLastResults </td>
361          <td class="md" valign="top">(&nbsp;</td>
362          <td class="md" nowrap valign="top">void&nbsp;</td>
363          <td class="mdname1" valign="top" nowrap>          </td>
364          <td class="md" valign="top">&nbsp;)&nbsp;</td>
365          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
366        </tr>
367
368      </table>
369    </td>
370  </tr>
371</table>
372<table cellspacing=5 cellpadding=0 border=0>
373  <tr>
374    <td>
375      &nbsp;
376    </td>
377    <td>
378
379<p>
380Gets the results of the last query that was run using this object, provided the query was executed using the collection-returning version of execute.
381<p>
382    </td>
383  </tr>
384</table>
385<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya8" doxytag="Ogre::BspRaySceneQuery::getMaxResults" ></a><p>
386<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
387  <tr>
388    <td class="mdRow">
389      <table cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a422">ushort</a> Ogre::RaySceneQuery::getMaxResults </td>
392          <td class="md" valign="top">(&nbsp;</td>
393          <td class="md" nowrap valign="top">void&nbsp;</td>
394          <td class="mdname1" valign="top" nowrap>          </td>
395          <td class="md" valign="top">&nbsp;)&nbsp;</td>
396          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
397        </tr>
398
399      </table>
400    </td>
401  </tr>
402</table>
403<table cellspacing=5 cellpadding=0 border=0>
404  <tr>
405    <td>
406      &nbsp;
407    </td>
408    <td>
409
410<p>
411Gets the maximum number of results returned from the query (only relevant if results are being sorted).
412<p>
413    </td>
414  </tr>
415</table>
416<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya14" doxytag="Ogre::BspRaySceneQuery::getQueryMask" ></a><p>
417<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
418  <tr>
419    <td class="mdRow">
420      <table cellpadding="0" cellspacing="0" border="0">
421        <tr>
422          <td class="md" nowrap valign="top"> virtual unsigned long Ogre::SceneQuery::getQueryMask </td>
423          <td class="md" valign="top">(&nbsp;</td>
424          <td class="md" nowrap valign="top">void&nbsp;</td>
425          <td class="mdname1" valign="top" nowrap>          </td>
426          <td class="md" valign="top">&nbsp;)&nbsp;</td>
427          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
428        </tr>
429
430      </table>
431    </td>
432  </tr>
433</table>
434<table cellspacing=5 cellpadding=0 border=0>
435  <tr>
436    <td>
437      &nbsp;
438    </td>
439    <td>
440
441<p>
442Returns the current mask for this query.
443<p>
444    </td>
445  </tr>
446</table>
447<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya5" doxytag="Ogre::BspRaySceneQuery::getRay" ></a><p>
448<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
449  <tr>
450    <td class="mdRow">
451      <table cellpadding="0" cellspacing="0" border="0">
452        <tr>
453          <td class="md" nowrap valign="top"> virtual const <a class="el" href="classOgre_1_1Ray.html">Ray</a>&amp; Ogre::RaySceneQuery::getRay </td>
454          <td class="md" valign="top">(&nbsp;</td>
455          <td class="md" nowrap valign="top">void&nbsp;</td>
456          <td class="mdname1" valign="top" nowrap>          </td>
457          <td class="md" valign="top">&nbsp;)&nbsp;</td>
458          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
459        </tr>
460
461      </table>
462    </td>
463  </tr>
464</table>
465<table cellspacing=5 cellpadding=0 border=0>
466  <tr>
467    <td>
468      &nbsp;
469    </td>
470    <td>
471
472<p>
473Gets the ray which is to be used for this query.
474<p>
475    </td>
476  </tr>
477</table>
478<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya7" doxytag="Ogre::BspRaySceneQuery::getSortByDistance" ></a><p>
479<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
480  <tr>
481    <td class="mdRow">
482      <table cellpadding="0" cellspacing="0" border="0">
483        <tr>
484          <td class="md" nowrap valign="top"> virtual bool Ogre::RaySceneQuery::getSortByDistance </td>
485          <td class="md" valign="top">(&nbsp;</td>
486          <td class="md" nowrap valign="top">void&nbsp;</td>
487          <td class="mdname1" valign="top" nowrap>          </td>
488          <td class="md" valign="top">&nbsp;)&nbsp;</td>
489          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
490        </tr>
491
492      </table>
493    </td>
494  </tr>
495</table>
496<table cellspacing=5 cellpadding=0 border=0>
497  <tr>
498    <td>
499      &nbsp;
500    </td>
501    <td>
502
503<p>
504Gets whether the results are sorted by distance.
505<p>
506    </td>
507  </tr>
508</table>
509<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya17" doxytag="Ogre::BspRaySceneQuery::getSupportedWorldFragmentTypes" ></a><p>
510<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
511  <tr>
512    <td class="mdRow">
513      <table cellpadding="0" cellspacing="0" border="0">
514        <tr>
515          <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>
516          <td class="md" valign="top">(&nbsp;</td>
517          <td class="md" nowrap valign="top">void&nbsp;</td>
518          <td class="mdname1" valign="top" nowrap>          </td>
519          <td class="md" valign="top">&nbsp;)&nbsp;</td>
520          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
521        </tr>
522
523      </table>
524    </td>
525  </tr>
526</table>
527<table cellspacing=5 cellpadding=0 border=0>
528  <tr>
529    <td>
530      &nbsp;
531    </td>
532    <td>
533
534<p>
535Returns the types of world fragments this query supports.
536<p>
537
538<p>
539Definition 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>
540  </tr>
541</table>
542<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya16" doxytag="Ogre::BspRaySceneQuery::getWorldFragmentType" ></a><p>
543<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
544  <tr>
545    <td class="mdRow">
546      <table cellpadding="0" cellspacing="0" border="0">
547        <tr>
548          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a> Ogre::SceneQuery::getWorldFragmentType </td>
549          <td class="md" valign="top">(&nbsp;</td>
550          <td class="md" nowrap valign="top">void&nbsp;</td>
551          <td class="mdname1" valign="top" nowrap>          </td>
552          <td class="md" valign="top">&nbsp;)&nbsp;</td>
553          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
554        </tr>
555
556      </table>
557    </td>
558  </tr>
559</table>
560<table cellspacing=5 cellpadding=0 border=0>
561  <tr>
562    <td>
563      &nbsp;
564    </td>
565    <td>
566
567<p>
568Gets the current world fragment types to be returned from the query.
569<p>
570    </td>
571  </tr>
572</table>
573<a class="anchor" name="Ogre_1_1BspRaySceneQueryb2" doxytag="Ogre::BspRaySceneQuery::processLeaf" ></a><p>
574<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
575  <tr>
576    <td class="mdRow">
577      <table cellpadding="0" cellspacing="0" border="0">
578        <tr>
579          <td class="md" nowrap valign="top"> bool Ogre::BspRaySceneQuery::processLeaf </td>
580          <td class="md" valign="top">(&nbsp;</td>
581          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1BspNode.html">BspNode</a> *&nbsp;</td>
582          <td class="mdname" nowrap> <em>node</em>, </td>
583        </tr>
584        <tr>
585          <td class="md" nowrap align="right"></td>
586          <td></td>
587          <td class="md" nowrap>const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;&nbsp;</td>
588          <td class="mdname" nowrap> <em>tracingRay</em>, </td>
589        </tr>
590        <tr>
591          <td class="md" nowrap align="right"></td>
592          <td></td>
593          <td class="md" nowrap><a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *&nbsp;</td>
594          <td class="mdname" nowrap> <em>listener</em>, </td>
595        </tr>
596        <tr>
597          <td class="md" nowrap align="right"></td>
598          <td></td>
599          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
600          <td class="mdname" nowrap> <em>maxDistance</em> = <a class="el" href="classOgre_1_1Math.html#Ogre_1_1Maths0">Math::POS_INFINITY</a>, </td>
601        </tr>
602        <tr>
603          <td class="md" nowrap align="right"></td>
604          <td></td>
605          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
606          <td class="mdname" nowrap> <em>traceDistance</em> = 0.0f</td>
607        </tr>
608        <tr>
609          <td></td>
610          <td class="md">)&nbsp;</td>
611          <td class="md" colspan="2"><code> [protected]</code></td>
612        </tr>
613
614      </table>
615    </td>
616  </tr>
617</table>
618<table cellspacing=5 cellpadding=0 border=0>
619  <tr>
620    <td>
621      &nbsp;
622    </td>
623    <td>
624
625<p>
626Internal processing of a single leaf.
627<p>
628<dl compact><dt><b>Returns:</b></dt><dd>true if we should continue tracing, false otherwise </dd></dl>
629    </td>
630  </tr>
631</table>
632<a class="anchor" name="Ogre_1_1BspRaySceneQueryb1" doxytag="Ogre::BspRaySceneQuery::processNode" ></a><p>
633<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
634  <tr>
635    <td class="mdRow">
636      <table cellpadding="0" cellspacing="0" border="0">
637        <tr>
638          <td class="md" nowrap valign="top"> bool Ogre::BspRaySceneQuery::processNode </td>
639          <td class="md" valign="top">(&nbsp;</td>
640          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1BspNode.html">BspNode</a> *&nbsp;</td>
641          <td class="mdname" nowrap> <em>node</em>, </td>
642        </tr>
643        <tr>
644          <td class="md" nowrap align="right"></td>
645          <td></td>
646          <td class="md" nowrap>const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;&nbsp;</td>
647          <td class="mdname" nowrap> <em>tracingRay</em>, </td>
648        </tr>
649        <tr>
650          <td class="md" nowrap align="right"></td>
651          <td></td>
652          <td class="md" nowrap><a class="el" href="classOgre_1_1RaySceneQueryListener.html">RaySceneQueryListener</a> *&nbsp;</td>
653          <td class="mdname" nowrap> <em>listener</em>, </td>
654        </tr>
655        <tr>
656          <td class="md" nowrap align="right"></td>
657          <td></td>
658          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
659          <td class="mdname" nowrap> <em>maxDistance</em> = <a class="el" href="classOgre_1_1Math.html#Ogre_1_1Maths0">Math::POS_INFINITY</a>, </td>
660        </tr>
661        <tr>
662          <td class="md" nowrap align="right"></td>
663          <td></td>
664          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
665          <td class="mdname" nowrap> <em>traceDistance</em> = 0.0f</td>
666        </tr>
667        <tr>
668          <td></td>
669          <td class="md">)&nbsp;</td>
670          <td class="md" colspan="2"><code> [protected]</code></td>
671        </tr>
672
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>
685Internal processing of a single node.
686<p>
687<dl compact><dt><b>Returns:</b></dt><dd>true if we should continue tracing, false otherwise </dd></dl>
688    </td>
689  </tr>
690</table>
691<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya12" doxytag="Ogre::BspRaySceneQuery::queryResult" ></a><p>
692<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
693  <tr>
694    <td class="mdRow">
695      <table cellpadding="0" cellspacing="0" border="0">
696        <tr>
697          <td class="md" nowrap valign="top"> bool Ogre::RaySceneQuery::queryResult </td>
698          <td class="md" valign="top">(&nbsp;</td>
699          <td class="md" nowrap valign="top"><a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *&nbsp;</td>
700          <td class="mdname" nowrap> <em>fragment</em>, </td>
701        </tr>
702        <tr>
703          <td class="md" nowrap align="right"></td>
704          <td></td>
705          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
706          <td class="mdname" nowrap> <em>distance</em></td>
707        </tr>
708        <tr>
709          <td></td>
710          <td class="md">)&nbsp;</td>
711          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
712        </tr>
713
714      </table>
715    </td>
716  </tr>
717</table>
718<table cellspacing=5 cellpadding=0 border=0>
719  <tr>
720    <td>
721      &nbsp;
722    </td>
723    <td>
724
725<p>
726Self-callback in order to deal with execute which returns collection.
727<p>
728
729<p>
730Implements <a class="el" href="classOgre_1_1RaySceneQueryListener.html#Ogre_1_1RaySceneQueryListenera2">Ogre::RaySceneQueryListener</a>.    </td>
731  </tr>
732</table>
733<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya11" doxytag="Ogre::BspRaySceneQuery::queryResult" ></a><p>
734<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
735  <tr>
736    <td class="mdRow">
737      <table cellpadding="0" cellspacing="0" border="0">
738        <tr>
739          <td class="md" nowrap valign="top"> bool Ogre::RaySceneQuery::queryResult </td>
740          <td class="md" valign="top">(&nbsp;</td>
741          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
742          <td class="mdname" nowrap> <em>obj</em>, </td>
743        </tr>
744        <tr>
745          <td class="md" nowrap align="right"></td>
746          <td></td>
747          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
748          <td class="mdname" nowrap> <em>distance</em></td>
749        </tr>
750        <tr>
751          <td></td>
752          <td class="md">)&nbsp;</td>
753          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
754        </tr>
755
756      </table>
757    </td>
758  </tr>
759</table>
760<table cellspacing=5 cellpadding=0 border=0>
761  <tr>
762    <td>
763      &nbsp;
764    </td>
765    <td>
766
767<p>
768Self-callback in order to deal with execute which returns collection.
769<p>
770
771<p>
772Implements <a class="el" href="classOgre_1_1RaySceneQueryListener.html#Ogre_1_1RaySceneQueryListenera1">Ogre::RaySceneQueryListener</a>.    </td>
773  </tr>
774</table>
775<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya13" doxytag="Ogre::BspRaySceneQuery::setQueryMask" ></a><p>
776<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
777  <tr>
778    <td class="mdRow">
779      <table cellpadding="0" cellspacing="0" border="0">
780        <tr>
781          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setQueryMask </td>
782          <td class="md" valign="top">(&nbsp;</td>
783          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
784          <td class="mdname1" valign="top" nowrap> <em>mask</em>          </td>
785          <td class="md" valign="top">&nbsp;)&nbsp;</td>
786          <td class="md" nowrap><code> [virtual, inherited]</code></td>
787        </tr>
788
789      </table>
790    </td>
791  </tr>
792</table>
793<table cellspacing=5 cellpadding=0 border=0>
794  <tr>
795    <td>
796      &nbsp;
797    </td>
798    <td>
799
800<p>
801Sets the mask for results of this query.
802<p>
803<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>
804    </td>
805  </tr>
806</table>
807<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya4" doxytag="Ogre::BspRaySceneQuery::setRay" ></a><p>
808<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
809  <tr>
810    <td class="mdRow">
811      <table cellpadding="0" cellspacing="0" border="0">
812        <tr>
813          <td class="md" nowrap valign="top"> virtual void Ogre::RaySceneQuery::setRay </td>
814          <td class="md" valign="top">(&nbsp;</td>
815          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;&nbsp;</td>
816          <td class="mdname1" valign="top" nowrap> <em>ray</em>          </td>
817          <td class="md" valign="top">&nbsp;)&nbsp;</td>
818          <td class="md" nowrap><code> [virtual, inherited]</code></td>
819        </tr>
820
821      </table>
822    </td>
823  </tr>
824</table>
825<table cellspacing=5 cellpadding=0 border=0>
826  <tr>
827    <td>
828      &nbsp;
829    </td>
830    <td>
831
832<p>
833Sets the ray which is to be used for this query.
834<p>
835    </td>
836  </tr>
837</table>
838<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya6" doxytag="Ogre::BspRaySceneQuery::setSortByDistance" ></a><p>
839<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
840  <tr>
841    <td class="mdRow">
842      <table cellpadding="0" cellspacing="0" border="0">
843        <tr>
844          <td class="md" nowrap valign="top"> virtual void Ogre::RaySceneQuery::setSortByDistance </td>
845          <td class="md" valign="top">(&nbsp;</td>
846          <td class="md" nowrap valign="top">bool&nbsp;</td>
847          <td class="mdname" nowrap> <em>sort</em>, </td>
848        </tr>
849        <tr>
850          <td class="md" nowrap align="right"></td>
851          <td></td>
852          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a422">ushort</a>&nbsp;</td>
853          <td class="mdname" nowrap> <em>maxresults</em> = 0</td>
854        </tr>
855        <tr>
856          <td></td>
857          <td class="md">)&nbsp;</td>
858          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
859        </tr>
860
861      </table>
862    </td>
863  </tr>
864</table>
865<table cellspacing=5 cellpadding=0 border=0>
866  <tr>
867    <td>
868      &nbsp;
869    </td>
870    <td>
871
872<p>
873Sets whether the results of this query will be sorted by distance along the ray.
874<p>
875<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>
876<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>
877<dl compact><dt><b>Parameters:</b></dt><dd>
878  <table border="0" cellspacing="2" cellpadding="0">
879    <tr><td valign=top><em>sort</em>&nbsp;</td><td>If true, results will be sorted. </td></tr>
880    <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>
881  </table>
882</dl>
883    </td>
884  </tr>
885</table>
886<a class="anchor" name="Ogre_1_1TerrainRaySceneQuerya15" doxytag="Ogre::BspRaySceneQuery::setWorldFragmentType" ></a><p>
887<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
888  <tr>
889    <td class="mdRow">
890      <table cellpadding="0" cellspacing="0" border="0">
891        <tr>
892          <td class="md" nowrap valign="top"> virtual void Ogre::SceneQuery::setWorldFragmentType </td>
893          <td class="md" valign="top">(&nbsp;</td>
894          <td class="md" nowrap valign="top">enum <a class="el" href="classOgre_1_1SceneQuery.html#Ogre_1_1TerrainRaySceneQueryw5">WorldFragmentType</a>&nbsp;</td>
895          <td class="mdname1" valign="top" nowrap> <em>wft</em>          </td>
896          <td class="md" valign="top">&nbsp;)&nbsp;</td>
897          <td class="md" nowrap><code> [virtual, inherited]</code></td>
898        </tr>
899
900      </table>
901    </td>
902  </tr>
903</table>
904<table cellspacing=5 cellpadding=0 border=0>
905  <tr>
906    <td>
907      &nbsp;
908    </td>
909    <td>
910
911<p>
912Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.
913<p>
914<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>
915<dl compact><dt><b></b></dt><dd>The default setting is WFT_NONE. </dd></dl>
916    </td>
917  </tr>
918</table>
919<hr><h2>Member Data Documentation</h2>
920<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp3" doxytag="Ogre::BspRaySceneQuery::mLastResult" ></a><p>
921<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
922  <tr>
923    <td class="mdRow">
924      <table cellpadding="0" cellspacing="0" border="0">
925        <tr>
926          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a496">RaySceneQueryResult</a>* <a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp3">Ogre::RaySceneQuery::mLastResult</a><code> [protected, inherited]</code>
927      </table>
928    </td>
929  </tr>
930</table>
931<table cellspacing=5 cellpadding=0 border=0>
932  <tr>
933    <td>
934      &nbsp;
935    </td>
936    <td>
937
938<p>
939
940<p>
941Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00359">359</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
942  </tr>
943</table>
944<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp2" doxytag="Ogre::BspRaySceneQuery::mMaxResults" ></a><p>
945<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
946  <tr>
947    <td class="mdRow">
948      <table cellpadding="0" cellspacing="0" border="0">
949        <tr>
950          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a422">ushort</a> <a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp2">Ogre::RaySceneQuery::mMaxResults</a><code> [protected, inherited]</code>
951      </table>
952    </td>
953  </tr>
954</table>
955<table cellspacing=5 cellpadding=0 border=0>
956  <tr>
957    <td>
958      &nbsp;
959    </td>
960    <td>
961
962<p>
963
964<p>
965Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00358">358</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
966  </tr>
967</table>
968<a class="anchor" name="Ogre_1_1BspRaySceneQueryp0" doxytag="Ogre::BspRaySceneQuery::mObjsThisQuery" ></a><p>
969<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
970  <tr>
971    <td class="mdRow">
972      <table cellpadding="0" cellspacing="0" border="0">
973        <tr>
974          <td class="md" nowrap valign="top"> std::set&lt;<a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a>*&gt; <a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQueryp0">Ogre::BspRaySceneQuery::mObjsThisQuery</a><code> [protected]</code>
975      </table>
976    </td>
977  </tr>
978</table>
979<table cellspacing=5 cellpadding=0 border=0>
980  <tr>
981    <td>
982      &nbsp;
983    </td>
984    <td>
985
986<p>
987Set for eliminating duplicates since objects can be in &gt; 1 node.
988<p>
989
990<p>
991Definition at line <a class="el" href="OgreBspSceneManager_8h-source.html#l00234">234</a> of file <a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a>.    </td>
992  </tr>
993</table>
994<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp4" doxytag="Ogre::BspRaySceneQuery::mParentSceneMgr" ></a><p>
995<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
996  <tr>
997    <td class="mdRow">
998      <table cellpadding="0" cellspacing="0" border="0">
999        <tr>
1000          <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>
1001      </table>
1002    </td>
1003  </tr>
1004</table>
1005<table cellspacing=5 cellpadding=0 border=0>
1006  <tr>
1007    <td>
1008      &nbsp;
1009    </td>
1010    <td>
1011
1012<p>
1013
1014<p>
1015Definition 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>
1016  </tr>
1017</table>
1018<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp5" doxytag="Ogre::BspRaySceneQuery::mQueryMask" ></a><p>
1019<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1020  <tr>
1021    <td class="mdRow">
1022      <table cellpadding="0" cellspacing="0" border="0">
1023        <tr>
1024          <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>
1025      </table>
1026    </td>
1027  </tr>
1028</table>
1029<table cellspacing=5 cellpadding=0 border=0>
1030  <tr>
1031    <td>
1032      &nbsp;
1033    </td>
1034    <td>
1035
1036<p>
1037
1038<p>
1039Definition 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>
1040  </tr>
1041</table>
1042<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp0" doxytag="Ogre::BspRaySceneQuery::mRay" ></a><p>
1043<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1044  <tr>
1045    <td class="mdRow">
1046      <table cellpadding="0" cellspacing="0" border="0">
1047        <tr>
1048          <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_1TerrainRaySceneQueryp0">Ogre::RaySceneQuery::mRay</a><code> [protected, inherited]</code>
1049      </table>
1050    </td>
1051  </tr>
1052</table>
1053<table cellspacing=5 cellpadding=0 border=0>
1054  <tr>
1055    <td>
1056      &nbsp;
1057    </td>
1058    <td>
1059
1060<p>
1061
1062<p>
1063Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00356">356</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
1064  </tr>
1065</table>
1066<a class="anchor" name="Ogre_1_1BspRaySceneQueryp1" doxytag="Ogre::BspRaySceneQuery::mSingleIntersections" ></a><p>
1067<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1068  <tr>
1069    <td class="mdRow">
1070      <table cellpadding="0" cellspacing="0" border="0">
1071        <tr>
1072          <td class="md" nowrap valign="top"> std::vector&lt;<a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a>*&gt; <a class="el" href="classOgre_1_1BspRaySceneQuery.html#Ogre_1_1BspRaySceneQueryp1">Ogre::BspRaySceneQuery::mSingleIntersections</a><code> [protected]</code>
1073      </table>
1074    </td>
1075  </tr>
1076</table>
1077<table cellspacing=5 cellpadding=0 border=0>
1078  <tr>
1079    <td>
1080      &nbsp;
1081    </td>
1082    <td>
1083
1084<p>
1085list of the last single intersection world fragments (derived)
1086<p>
1087
1088<p>
1089Definition at line <a class="el" href="OgreBspSceneManager_8h-source.html#l00236">236</a> of file <a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a>.    </td>
1090  </tr>
1091</table>
1092<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp1" doxytag="Ogre::BspRaySceneQuery::mSortByDistance" ></a><p>
1093<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1094  <tr>
1095    <td class="mdRow">
1096      <table cellpadding="0" cellspacing="0" border="0">
1097        <tr>
1098          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1RaySceneQuery.html#Ogre_1_1TerrainRaySceneQueryp1">Ogre::RaySceneQuery::mSortByDistance</a><code> [protected, inherited]</code>
1099      </table>
1100    </td>
1101  </tr>
1102</table>
1103<table cellspacing=5 cellpadding=0 border=0>
1104  <tr>
1105    <td>
1106      &nbsp;
1107    </td>
1108    <td>
1109
1110<p>
1111
1112<p>
1113Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00357">357</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
1114  </tr>
1115</table>
1116<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp6" doxytag="Ogre::BspRaySceneQuery::mSupportedWorldFragments" ></a><p>
1117<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1118  <tr>
1119    <td class="mdRow">
1120      <table cellpadding="0" cellspacing="0" border="0">
1121        <tr>
1122          <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>
1123      </table>
1124    </td>
1125  </tr>
1126</table>
1127<table cellspacing=5 cellpadding=0 border=0>
1128  <tr>
1129    <td>
1130      &nbsp;
1131    </td>
1132    <td>
1133
1134<p>
1135
1136<p>
1137Definition 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>
1138  </tr>
1139</table>
1140<a class="anchor" name="Ogre_1_1TerrainRaySceneQueryp7" doxytag="Ogre::BspRaySceneQuery::mWorldFragmentType" ></a><p>
1141<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1142  <tr>
1143    <td class="mdRow">
1144      <table cellpadding="0" cellspacing="0" border="0">
1145        <tr>
1146          <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>
1147      </table>
1148    </td>
1149  </tr>
1150</table>
1151<table cellspacing=5 cellpadding=0 border=0>
1152  <tr>
1153    <td>
1154      &nbsp;
1155    </td>
1156    <td>
1157
1158<p>
1159
1160<p>
1161Definition 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>
1162  </tr>
1163</table>
1164<hr>The documentation for this class was generated from the following file:<ul>
1165<li><a class="el" href="OgreBspSceneManager_8h-source.html">OgreBspSceneManager.h</a></ul>
1166<hr>
1167<p>
1168Copyright &copy; 2000-2005 by The OGRE Team<br />
1169<!--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/>
1170This 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/>
1171                <!--/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#">
1172                <Work rdf:about="">
1173                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1174        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1175                </Work>
1176                <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> -->
1177
1178Last modified Sun Feb 12 13:05:32 2006
1179</p>
1180</body>
1181</html>
Note: See TracBrowser for help on using the repository browser.