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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::SceneQueryListener 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::SceneQueryListener Class Reference</h1>This optional class allows you to receive per-result callbacks from <a class="el" href="classOgre_1_1SceneQuery.html">SceneQuery</a> executions instead of a single set of consolidated results. 
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::SceneQueryListener:
16<p><center><img src="classOgre_1_1SceneQueryListener.png" usemap="#Ogre::SceneQueryListener_map" border="0" alt=""></center>
17<map name="Ogre::SceneQueryListener_map">
18<area href="classOgre_1_1RegionSceneQuery.html" alt="Ogre::RegionSceneQuery" shape="rect" coords="349,56,688,80">
19<area href="classOgre_1_1SceneManager_1_1ShadowCasterSceneQueryListener.html" alt="Ogre::SceneManager::ShadowCasterSceneQueryListener" shape="rect" coords="698,56,1037,80">
20<area href="classOgre_1_1AxisAlignedBoxSceneQuery.html" alt="Ogre::AxisAlignedBoxSceneQuery" shape="rect" coords="0,112,339,136">
21<area href="classOgre_1_1PlaneBoundedVolumeListSceneQuery.html" alt="Ogre::PlaneBoundedVolumeListSceneQuery" shape="rect" coords="349,112,688,136">
22<area href="classOgre_1_1SphereSceneQuery.html" alt="Ogre::SphereSceneQuery" shape="rect" coords="698,112,1037,136">
23<area href="classOgre_1_1DefaultAxisAlignedBoxSceneQuery.html" alt="Ogre::DefaultAxisAlignedBoxSceneQuery" shape="rect" coords="0,168,339,192">
24<area href="classOgre_1_1DefaultPlaneBoundedVolumeListSceneQuery.html" alt="Ogre::DefaultPlaneBoundedVolumeListSceneQuery" shape="rect" coords="349,168,688,192">
25<area href="classOgre_1_1DefaultSphereSceneQuery.html" alt="Ogre::DefaultSphereSceneQuery" shape="rect" coords="698,168,1037,192">
26<area href="classOgre_1_1OctreeAxisAlignedBoxSceneQuery.html" alt="Ogre::OctreeAxisAlignedBoxSceneQuery" shape="rect" coords="0,224,339,248">
27<area href="classOgre_1_1OctreePlaneBoundedVolumeListSceneQuery.html" alt="Ogre::OctreePlaneBoundedVolumeListSceneQuery" shape="rect" coords="349,224,688,248">
28<area href="classOgre_1_1OctreeSphereSceneQuery.html" alt="Ogre::OctreeSphereSceneQuery" shape="rect" coords="698,224,1037,248">
29</map>
30<a href="classOgre_1_1SceneQueryListener-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
31<tr><td></td></tr>
32<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQueryListener.html#Ogre_1_1SceneQueryListenera0">~SceneQueryListener</a> ()</td></tr>
34
35<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQueryListener.html#Ogre_1_1SceneQueryListenera1">queryResult</a> (<a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *object)=0</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> is returned by a query.  <a href="#Ogre_1_1SceneQueryListenera1"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneQueryListener.html#Ogre_1_1SceneQueryListenera2">queryResult</a> (<a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *fragment)=0</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a WorldFragment is returned by a query.  <a href="#Ogre_1_1SceneQueryListenera2"></a><br><br></td></tr>
41</table>
42<hr><a name="_details"></a><h2>Detailed Description</h2>
43This optional class allows you to receive per-result callbacks from <a class="el" href="classOgre_1_1SceneQuery.html">SceneQuery</a> executions instead of a single set of consolidated results.
44<p>
45<dl compact><dt><b>Remarks:</b></dt><dd>You should override this with your own subclass. Note that certain query classes may refine this listener interface. </dd></dl>
46
47<p>
48
49<p>
50Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00164">164</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
51<a class="anchor" name="Ogre_1_1SceneQueryListenera0" doxytag="Ogre::SceneQueryListener::~SceneQueryListener" ></a><p>
52<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
53  <tr>
54    <td class="mdRow">
55      <table cellpadding="0" cellspacing="0" border="0">
56        <tr>
57          <td class="md" nowrap valign="top"> virtual Ogre::SceneQueryListener::~<a class="el" href="classOgre_1_1SceneQueryListener.html">SceneQueryListener</a> </td>
58          <td class="md" valign="top">(&nbsp;</td>
59          <td class="mdname1" valign="top" nowrap>          </td>
60          <td class="md" valign="top">&nbsp;)&nbsp;</td>
61          <td class="md" nowrap><code> [virtual]</code></td>
62        </tr>
63
64      </table>
65    </td>
66  </tr>
67</table>
68<table cellspacing=5 cellpadding=0 border=0>
69  <tr>
70    <td>
71      &nbsp;
72    </td>
73    <td>
74
75<p>
76
77<p>
78Definition at line <a class="el" href="OgreSceneQuery_8h-source.html#l00167">167</a> of file <a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a>.    </td>
79  </tr>
80</table>
81<hr><h2>Member Function Documentation</h2>
82<a class="anchor" name="Ogre_1_1SceneQueryListenera2" doxytag="Ogre::SceneQueryListener::queryResult" ></a><p>
83<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
84  <tr>
85    <td class="mdRow">
86      <table cellpadding="0" cellspacing="0" border="0">
87        <tr>
88          <td class="md" nowrap valign="top"> virtual bool Ogre::SceneQueryListener::queryResult </td>
89          <td class="md" valign="top">(&nbsp;</td>
90          <td class="md" nowrap valign="top"><a class="el" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a> *&nbsp;</td>
91          <td class="mdname1" valign="top" nowrap> <em>fragment</em>          </td>
92          <td class="md" valign="top">&nbsp;)&nbsp;</td>
93          <td class="md" nowrap><code> [pure virtual]</code></td>
94        </tr>
95
96      </table>
97    </td>
98  </tr>
99</table>
100<table cellspacing=5 cellpadding=0 border=0>
101  <tr>
102    <td>
103      &nbsp;
104    </td>
105    <td>
106
107<p>
108Called when a WorldFragment is returned by a query.
109<p>
110<dl compact><dt><b>Remarks:</b></dt><dd>The implementor should return 'true' to continue returning objects, or 'false' to abandon any further results from this query. </dd></dl>
111
112<p>
113Implemented in <a class="el" href="classOgre_1_1SceneManager_1_1ShadowCasterSceneQueryListener.html#Ogre_1_1SceneManager_1_1ShadowCasterSceneQueryListenera3">Ogre::SceneManager::ShadowCasterSceneQueryListener</a>, and <a class="el" href="classOgre_1_1RegionSceneQuery.html#Ogre_1_1SphereSceneQuerya9">Ogre::RegionSceneQuery</a>.    </td>
114  </tr>
115</table>
116<a class="anchor" name="Ogre_1_1SceneQueryListenera1" doxytag="Ogre::SceneQueryListener::queryResult" ></a><p>
117<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
118  <tr>
119    <td class="mdRow">
120      <table cellpadding="0" cellspacing="0" border="0">
121        <tr>
122          <td class="md" nowrap valign="top"> virtual bool Ogre::SceneQueryListener::queryResult </td>
123          <td class="md" valign="top">(&nbsp;</td>
124          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> *&nbsp;</td>
125          <td class="mdname1" valign="top" nowrap> <em>object</em>          </td>
126          <td class="md" valign="top">&nbsp;)&nbsp;</td>
127          <td class="md" nowrap><code> [pure virtual]</code></td>
128        </tr>
129
130      </table>
131    </td>
132  </tr>
133</table>
134<table cellspacing=5 cellpadding=0 border=0>
135  <tr>
136    <td>
137      &nbsp;
138    </td>
139    <td>
140
141<p>
142Called when a <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> is returned by a query.
143<p>
144<dl compact><dt><b>Remarks:</b></dt><dd>The implementor should return 'true' to continue returning objects, or 'false' to abandon any further results from this query. </dd></dl>
145
146<p>
147Implemented in <a class="el" href="classOgre_1_1SceneManager_1_1ShadowCasterSceneQueryListener.html#Ogre_1_1SceneManager_1_1ShadowCasterSceneQueryListenera2">Ogre::SceneManager::ShadowCasterSceneQueryListener</a>, and <a class="el" href="classOgre_1_1RegionSceneQuery.html#Ogre_1_1SphereSceneQuerya8">Ogre::RegionSceneQuery</a>.    </td>
148  </tr>
149</table>
150<hr>The documentation for this class was generated from the following file:<ul>
151<li><a class="el" href="OgreSceneQuery_8h-source.html">OgreSceneQuery.h</a></ul>
152<hr>
153<p>
154Copyright &copy; 2000-2005 by The OGRE Team<br />
155<!--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/>
156This 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/>
157                <!--/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#">
158                <Work rdf:about="">
159                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
160        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
161                </Work>
162                <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> -->
163
164Last modified Sun Feb 12 13:03:22 2006
165</p>
166</body>
167</html>
Note: See TracBrowser for help on using the repository browser.