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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::TerrainPageSourceListenerManager 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::TerrainPageSourceListenerManager Class Reference</h1>Simple manager class to hold onto a list of page source listeners across all sources. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreTerrainPageSource_8h-source.html">OgreTerrainPageSource.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::TerrainPageSourceListenerManager:
16<p><center><img src="classOgre_1_1TerrainPageSourceListenerManager.png" usemap="#Ogre::TerrainPageSourceListenerManager_map" border="0" alt=""></center>
17<map name="Ogre::TerrainPageSourceListenerManager_map">
18<area href="classOgre_1_1Singleton.html" alt="Ogre::Singleton< TerrainPageSourceListenerManager >" shape="rect" coords="0,0,330,24">
19</map>
20<a href="classOgre_1_1TerrainPageSourceListenerManager-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagera0">TerrainPageSourceListenerManager</a> ()</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagera1">~TerrainPageSourceListenerManager</a> ()</td></tr>
26
27<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagera2">addListener</a> (<a class="el" href="classOgre_1_1TerrainPageSourceListener.html">TerrainPageSourceListener</a> *pl)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register a class which will be called back whenever a new page is available.  <a href="#Ogre_1_1TerrainPageSourceListenerManagera2"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagera3">removeListener</a> (<a class="el" href="classOgre_1_1TerrainPageSourceListener.html">TerrainPageSourceListener</a> *pl)</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregister a class which will be called back whenever a new page is available.  <a href="#Ogre_1_1TerrainPageSourceListenerManagera3"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagera4">firePageConstructed</a> (size_t pagex, size_t pagez, <a class="el" href="namespaceOgre.html#a420">Real</a> *heightData)</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fire pageContructed events.  <a href="#Ogre_1_1TerrainPageSourceListenerManagera4"></a><br><br></td></tr>
36<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagere0">getSingleton</a> (void)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1TerrainPageSourceListenerManagere0"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagere1">getSingletonPtr</a> (void)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1TerrainPageSourceListenerManagere1"></a><br><br></td></tr>
43<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classOgre_1_1TerrainPageSourceListener.html">TerrainPageSourceListener</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagerx0">PageSourceListenerList</a></td></tr>
45
46<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagerx0">PageSourceListenerList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagerp0">mPageSourceListeners</a></td></tr>
48
49<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a></td></tr>
51
52</table>
53<hr><a name="_details"></a><h2>Detailed Description</h2>
54Simple manager class to hold onto a list of page source listeners across all sources.
55<p>
56
57<p>
58
59<p>
60Definition at line <a class="el" href="OgreTerrainPageSource_8h-source.html#l00055">55</a> of file <a class="el" href="OgreTerrainPageSource_8h-source.html">OgreTerrainPageSource.h</a>.<hr><h2>Member Typedef Documentation</h2>
61<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagerx0" doxytag="Ogre::TerrainPageSourceListenerManager::PageSourceListenerList" ></a><p>
62<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
63  <tr>
64    <td class="mdRow">
65      <table cellpadding="0" cellspacing="0" border="0">
66        <tr>
67          <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classOgre_1_1TerrainPageSourceListener.html">TerrainPageSourceListener</a>*&gt; <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagerx0">Ogre::TerrainPageSourceListenerManager::PageSourceListenerList</a><code> [protected]</code>
68      </table>
69    </td>
70  </tr>
71</table>
72<table cellspacing=5 cellpadding=0 border=0>
73  <tr>
74    <td>
75      &nbsp;
76    </td>
77    <td>
78
79<p>
80
81<p>
82Definition at line <a class="el" href="OgreTerrainPageSource_8h-source.html#l00059">59</a> of file <a class="el" href="OgreTerrainPageSource_8h-source.html">OgreTerrainPageSource.h</a>.    </td>
83  </tr>
84</table>
85<hr><h2>Constructor &amp; Destructor Documentation</h2>
86<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagera0" doxytag="Ogre::TerrainPageSourceListenerManager::TerrainPageSourceListenerManager" ></a><p>
87<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
88  <tr>
89    <td class="mdRow">
90      <table cellpadding="0" cellspacing="0" border="0">
91        <tr>
92          <td class="md" nowrap valign="top"> Ogre::TerrainPageSourceListenerManager::TerrainPageSourceListenerManager </td>
93          <td class="md" valign="top">(&nbsp;</td>
94          <td class="mdname1" valign="top" nowrap>          </td>
95          <td class="md" valign="top">&nbsp;)&nbsp;</td>
96          <td class="md" nowrap></td>
97        </tr>
98
99      </table>
100    </td>
101  </tr>
102</table>
103<table cellspacing=5 cellpadding=0 border=0>
104  <tr>
105    <td>
106      &nbsp;
107    </td>
108    <td>
109
110<p>
111
112<p>
113Definition at line <a class="el" href="OgreTerrainPageSource_8h-source.html#l00062">62</a> of file <a class="el" href="OgreTerrainPageSource_8h-source.html">OgreTerrainPageSource.h</a>.    </td>
114  </tr>
115</table>
116<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagera1" doxytag="Ogre::TerrainPageSourceListenerManager::~TerrainPageSourceListenerManager" ></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"> Ogre::TerrainPageSourceListenerManager::~<a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a> </td>
123          <td class="md" valign="top">(&nbsp;</td>
124          <td class="mdname1" valign="top" nowrap>          </td>
125          <td class="md" valign="top">&nbsp;)&nbsp;</td>
126          <td class="md" nowrap></td>
127        </tr>
128
129      </table>
130    </td>
131  </tr>
132</table>
133<table cellspacing=5 cellpadding=0 border=0>
134  <tr>
135    <td>
136      &nbsp;
137    </td>
138    <td>
139
140<p>
141
142<p>
143Definition at line <a class="el" href="OgreTerrainPageSource_8h-source.html#l00063">63</a> of file <a class="el" href="OgreTerrainPageSource_8h-source.html">OgreTerrainPageSource.h</a>.    </td>
144  </tr>
145</table>
146<hr><h2>Member Function Documentation</h2>
147<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagera2" doxytag="Ogre::TerrainPageSourceListenerManager::addListener" ></a><p>
148<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
149  <tr>
150    <td class="mdRow">
151      <table cellpadding="0" cellspacing="0" border="0">
152        <tr>
153          <td class="md" nowrap valign="top"> void Ogre::TerrainPageSourceListenerManager::addListener </td>
154          <td class="md" valign="top">(&nbsp;</td>
155          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1TerrainPageSourceListener.html">TerrainPageSourceListener</a> *&nbsp;</td>
156          <td class="mdname1" valign="top" nowrap> <em>pl</em>          </td>
157          <td class="md" valign="top">&nbsp;)&nbsp;</td>
158          <td class="md" nowrap></td>
159        </tr>
160
161      </table>
162    </td>
163  </tr>
164</table>
165<table cellspacing=5 cellpadding=0 border=0>
166  <tr>
167    <td>
168      &nbsp;
169    </td>
170    <td>
171
172<p>
173Register a class which will be called back whenever a new page is available.
174<p>
175<dl compact><dt><b>Remarks:</b></dt><dd>Since this method is static, it applies to any page source which is in active use; there is no need to register one per source. </dd></dl>
176    </td>
177  </tr>
178</table>
179<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagera4" doxytag="Ogre::TerrainPageSourceListenerManager::firePageConstructed" ></a><p>
180<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
181  <tr>
182    <td class="mdRow">
183      <table cellpadding="0" cellspacing="0" border="0">
184        <tr>
185          <td class="md" nowrap valign="top"> void Ogre::TerrainPageSourceListenerManager::firePageConstructed </td>
186          <td class="md" valign="top">(&nbsp;</td>
187          <td class="md" nowrap valign="top">size_t&nbsp;</td>
188          <td class="mdname" nowrap> <em>pagex</em>, </td>
189        </tr>
190        <tr>
191          <td class="md" nowrap align="right"></td>
192          <td></td>
193          <td class="md" nowrap>size_t&nbsp;</td>
194          <td class="mdname" nowrap> <em>pagez</em>, </td>
195        </tr>
196        <tr>
197          <td class="md" nowrap align="right"></td>
198          <td></td>
199          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> *&nbsp;</td>
200          <td class="mdname" nowrap> <em>heightData</em></td>
201        </tr>
202        <tr>
203          <td></td>
204          <td class="md">)&nbsp;</td>
205          <td class="md" colspan="2"></td>
206        </tr>
207
208      </table>
209    </td>
210  </tr>
211</table>
212<table cellspacing=5 cellpadding=0 border=0>
213  <tr>
214    <td>
215      &nbsp;
216    </td>
217    <td>
218
219<p>
220Fire pageContructed events.
221<p>
222    </td>
223  </tr>
224</table>
225<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagere0" doxytag="Ogre::TerrainPageSourceListenerManager::getSingleton" ></a><p>
226<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
227  <tr>
228    <td class="mdRow">
229      <table cellpadding="0" cellspacing="0" border="0">
230        <tr>
231          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a>&amp; Ogre::TerrainPageSourceListenerManager::getSingleton </td>
232          <td class="md" valign="top">(&nbsp;</td>
233          <td class="md" nowrap valign="top">void&nbsp;</td>
234          <td class="mdname1" valign="top" nowrap>          </td>
235          <td class="md" valign="top">&nbsp;)&nbsp;</td>
236          <td class="md" nowrap><code> [static]</code></td>
237        </tr>
238
239      </table>
240    </td>
241  </tr>
242</table>
243<table cellspacing=5 cellpadding=0 border=0>
244  <tr>
245    <td>
246      &nbsp;
247    </td>
248    <td>
249
250<p>
251Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
252<p>
253
254<p>
255Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone0">Ogre::Singleton&lt; TerrainPageSourceListenerManager &gt;</a>.    </td>
256  </tr>
257</table>
258<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagere1" doxytag="Ogre::TerrainPageSourceListenerManager::getSingletonPtr" ></a><p>
259<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
260  <tr>
261    <td class="mdRow">
262      <table cellpadding="0" cellspacing="0" border="0">
263        <tr>
264          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a>* Ogre::TerrainPageSourceListenerManager::getSingletonPtr </td>
265          <td class="md" valign="top">(&nbsp;</td>
266          <td class="md" nowrap valign="top">void&nbsp;</td>
267          <td class="mdname1" valign="top" nowrap>          </td>
268          <td class="md" valign="top">&nbsp;)&nbsp;</td>
269          <td class="md" nowrap><code> [static]</code></td>
270        </tr>
271
272      </table>
273    </td>
274  </tr>
275</table>
276<table cellspacing=5 cellpadding=0 border=0>
277  <tr>
278    <td>
279      &nbsp;
280    </td>
281    <td>
282
283<p>
284Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
285<p>
286
287<p>
288Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone1">Ogre::Singleton&lt; TerrainPageSourceListenerManager &gt;</a>.    </td>
289  </tr>
290</table>
291<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagera3" doxytag="Ogre::TerrainPageSourceListenerManager::removeListener" ></a><p>
292<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
293  <tr>
294    <td class="mdRow">
295      <table cellpadding="0" cellspacing="0" border="0">
296        <tr>
297          <td class="md" nowrap valign="top"> void Ogre::TerrainPageSourceListenerManager::removeListener </td>
298          <td class="md" valign="top">(&nbsp;</td>
299          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1TerrainPageSourceListener.html">TerrainPageSourceListener</a> *&nbsp;</td>
300          <td class="mdname1" valign="top" nowrap> <em>pl</em>          </td>
301          <td class="md" valign="top">&nbsp;)&nbsp;</td>
302          <td class="md" nowrap></td>
303        </tr>
304
305      </table>
306    </td>
307  </tr>
308</table>
309<table cellspacing=5 cellpadding=0 border=0>
310  <tr>
311    <td>
312      &nbsp;
313    </td>
314    <td>
315
316<p>
317Unregister a class which will be called back whenever a new page is available.
318<p>
319    </td>
320  </tr>
321</table>
322<hr><h2>Member Data Documentation</h2>
323<a class="anchor" name="Ogre_1_1TerrainPageSourceListenerManagerp0" doxytag="Ogre::TerrainPageSourceListenerManager::mPageSourceListeners" ></a><p>
324<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
325  <tr>
326    <td class="mdRow">
327      <table cellpadding="0" cellspacing="0" border="0">
328        <tr>
329          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagerx0">PageSourceListenerList</a> <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html#Ogre_1_1TerrainPageSourceListenerManagerp0">Ogre::TerrainPageSourceListenerManager::mPageSourceListeners</a><code> [protected]</code>
330      </table>
331    </td>
332  </tr>
333</table>
334<table cellspacing=5 cellpadding=0 border=0>
335  <tr>
336    <td>
337      &nbsp;
338    </td>
339    <td>
340
341<p>
342
343<p>
344Definition at line <a class="el" href="OgreTerrainPageSource_8h-source.html#l00060">60</a> of file <a class="el" href="OgreTerrainPageSource_8h-source.html">OgreTerrainPageSource.h</a>.    </td>
345  </tr>
346</table>
347<a class="anchor" name="Ogre_1_1Singletont0" doxytag="Ogre::TerrainPageSourceListenerManager::ms_Singleton" ></a><p>
348<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
349  <tr>
350    <td class="mdRow">
351      <table cellpadding="0" cellspacing="0" border="0">
352        <tr>
353          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a> * <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; <a class="el" href="classOgre_1_1TerrainPageSourceListenerManager.html">TerrainPageSourceListenerManager</a>  &gt;::<a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a><code> [static, protected, inherited]</code>
354      </table>
355    </td>
356  </tr>
357</table>
358<table cellspacing=5 cellpadding=0 border=0>
359  <tr>
360    <td>
361      &nbsp;
362    </td>
363    <td>
364
365<p>
366
367<p>
368Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00054">54</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
369  </tr>
370</table>
371<hr>The documentation for this class was generated from the following file:<ul>
372<li><a class="el" href="OgreTerrainPageSource_8h-source.html">OgreTerrainPageSource.h</a></ul>
373<hr>
374<p>
375Copyright &copy; 2000-2005 by The OGRE Team<br />
376<!--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/>
377This 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/>
378                <!--/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#">
379                <Work rdf:about="">
380                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
381        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
382                </Work>
383                <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> -->
384
385Last modified Sun Feb 12 13:06:26 2006
386</p>
387</body>
388</html>
Note: See TracBrowser for help on using the repository browser.