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

Revision 657, 17.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::TerrainPage 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::TerrainPage Class Reference</h1>Groups a number of TerrainRenderables (tiles) into a page, which is the unit of loading / unloading. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1TerrainPage-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">TerrainRow</a></td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">TerrainRow</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew1">Terrain2D</a></td></tr>
21
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_1TerrainPage.html#Ogre_1_1TerrainPagea0">TerrainPage</a> (unsigned short numTiles)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The main constructor.  <a href="#Ogre_1_1TerrainPagea0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagea1">~TerrainPage</a> ()</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor, will organise the deletion of pages.  <a href="#Ogre_1_1TerrainPagea1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagea2">linkNeighbours</a> (void)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After TerrainRenderables have been populated, this method adds the neighbour links.  <a href="#Ogre_1_1TerrainPagea2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagea3">getTerrainTile</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &amp;pt)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> that contains the given pt.  <a href="#Ogre_1_1TerrainPagea3"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagea4">setRenderQueue</a> (<a class="el" href="namespaceOgre.html#a669">RenderQueueGroupID</a> qid)</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the render queue group which the tiles should be rendered in.  <a href="#Ogre_1_1TerrainPagea4"></a><br><br></td></tr>
38<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew1">Terrain2D</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo0">tiles</a></td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">2-dimensional vector of tiles, pre-allocated to the correct size  <a href="#Ogre_1_1TerrainPageo0"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned short&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo1">tilesPerPage</a></td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of tiles across a page.  <a href="#Ogre_1_1TerrainPageo1"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo2">pageSceneNode</a></td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The scene node to which all the tiles for this page are attached.  <a href="#Ogre_1_1TerrainPageo2"></a><br><br></td></tr>
48</table>
49<hr><a name="_details"></a><h2>Detailed Description</h2>
50Groups a number of TerrainRenderables (tiles) into a page, which is the unit of loading / unloading.
51<p>
52<dl compact><dt><b>Remarks:</b></dt><dd>Note that this class, whilst holding onto <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> instances, does not actually process or initialise them itself - this is intentional so the <a class="el" href="classOgre_1_1TerrainPageSource.html">TerrainPageSource</a> which is providing the tiles is able to load and prepare each renderable incrementally if required, thus avoiding any 'single hit' load methods for the page. </dd></dl>
53<dl compact><dt><b></b></dt><dd>All this class does do is pre-create a 2D vector of 'slots' in which to place the <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> pointers, which it does on construction. Note that this structure is public to allow completely free access to users of this class. </dd></dl>
54
55<p>
56
57<p>
58Definition at line <a class="el" href="OgreTerrainPage_8h-source.html#l00047">47</a> of file <a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>.<hr><h2>Member Typedef Documentation</h2>
59<a class="anchor" name="Ogre_1_1TerrainPagew1" doxytag="Ogre::TerrainPage::Terrain2D" ></a><p>
60<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
61  <tr>
62    <td class="mdRow">
63      <table cellpadding="0" cellspacing="0" border="0">
64        <tr>
65          <td class="md" nowrap valign="top"> typedef std::vector&lt; <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">TerrainRow</a> &gt; <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew1">Ogre::TerrainPage::Terrain2D</a>
66      </table>
67    </td>
68  </tr>
69</table>
70<table cellspacing=5 cellpadding=0 border=0>
71  <tr>
72    <td>
73      &nbsp;
74    </td>
75    <td>
76
77<p>
78
79<p>
80Definition at line <a class="el" href="OgreTerrainPage_8h-source.html#l00051">51</a> of file <a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>.    </td>
81  </tr>
82</table>
83<a class="anchor" name="Ogre_1_1TerrainPagew0" doxytag="Ogre::TerrainPage::TerrainRow" ></a><p>
84<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
85  <tr>
86    <td class="mdRow">
87      <table cellpadding="0" cellspacing="0" border="0">
88        <tr>
89          <td class="md" nowrap valign="top"> typedef std::vector&lt; <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> * &gt; <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">Ogre::TerrainPage::TerrainRow</a>
90      </table>
91    </td>
92  </tr>
93</table>
94<table cellspacing=5 cellpadding=0 border=0>
95  <tr>
96    <td>
97      &nbsp;
98    </td>
99    <td>
100
101<p>
102
103<p>
104Definition at line <a class="el" href="OgreTerrainPage_8h-source.html#l00050">50</a> of file <a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>.    </td>
105  </tr>
106</table>
107<hr><h2>Constructor &amp; Destructor Documentation</h2>
108<a class="anchor" name="Ogre_1_1TerrainPagea0" doxytag="Ogre::TerrainPage::TerrainPage" ></a><p>
109<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
110  <tr>
111    <td class="mdRow">
112      <table cellpadding="0" cellspacing="0" border="0">
113        <tr>
114          <td class="md" nowrap valign="top"> Ogre::TerrainPage::TerrainPage </td>
115          <td class="md" valign="top">(&nbsp;</td>
116          <td class="md" nowrap valign="top">unsigned short&nbsp;</td>
117          <td class="mdname1" valign="top" nowrap> <em>numTiles</em>          </td>
118          <td class="md" valign="top">&nbsp;)&nbsp;</td>
119          <td class="md" nowrap></td>
120        </tr>
121
122      </table>
123    </td>
124  </tr>
125</table>
126<table cellspacing=5 cellpadding=0 border=0>
127  <tr>
128    <td>
129      &nbsp;
130    </td>
131    <td>
132
133<p>
134The main constructor.
135<p>
136<dl compact><dt><b>Parameters:</b></dt><dd>
137  <table border="0" cellspacing="2" cellpadding="0">
138    <tr><td valign=top><em>numTiles</em>&nbsp;</td><td>The number of terrain tiles (<a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a>) across (and down) a page </td></tr>
139  </table>
140</dl>
141    </td>
142  </tr>
143</table>
144<a class="anchor" name="Ogre_1_1TerrainPagea1" doxytag="Ogre::TerrainPage::~TerrainPage" ></a><p>
145<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
146  <tr>
147    <td class="mdRow">
148      <table cellpadding="0" cellspacing="0" border="0">
149        <tr>
150          <td class="md" nowrap valign="top"> virtual Ogre::TerrainPage::~<a class="el" href="classOgre_1_1TerrainPage.html">TerrainPage</a> </td>
151          <td class="md" valign="top">(&nbsp;</td>
152          <td class="mdname1" valign="top" nowrap>          </td>
153          <td class="md" valign="top">&nbsp;)&nbsp;</td>
154          <td class="md" nowrap><code> [virtual]</code></td>
155        </tr>
156
157      </table>
158    </td>
159  </tr>
160</table>
161<table cellspacing=5 cellpadding=0 border=0>
162  <tr>
163    <td>
164      &nbsp;
165    </td>
166    <td>
167
168<p>
169Destructor, will organise the deletion of pages.
170<p>
171    </td>
172  </tr>
173</table>
174<hr><h2>Member Function Documentation</h2>
175<a class="anchor" name="Ogre_1_1TerrainPagea3" doxytag="Ogre::TerrainPage::getTerrainTile" ></a><p>
176<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
177  <tr>
178    <td class="mdRow">
179      <table cellpadding="0" cellspacing="0" border="0">
180        <tr>
181          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a>* Ogre::TerrainPage::getTerrainTile </td>
182          <td class="md" valign="top">(&nbsp;</td>
183          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &amp;&nbsp;</td>
184          <td class="mdname1" valign="top" nowrap> <em>pt</em>          </td>
185          <td class="md" valign="top">&nbsp;)&nbsp;</td>
186          <td class="md" nowrap></td>
187        </tr>
188
189      </table>
190    </td>
191  </tr>
192</table>
193<table cellspacing=5 cellpadding=0 border=0>
194  <tr>
195    <td>
196      &nbsp;
197    </td>
198    <td>
199
200<p>
201Returns the <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> that contains the given pt.
202<p>
203If no tile exists at the point, it returns 0;     </td>
204  </tr>
205</table>
206<a class="anchor" name="Ogre_1_1TerrainPagea2" doxytag="Ogre::TerrainPage::linkNeighbours" ></a><p>
207<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
208  <tr>
209    <td class="mdRow">
210      <table cellpadding="0" cellspacing="0" border="0">
211        <tr>
212          <td class="md" nowrap valign="top"> void Ogre::TerrainPage::linkNeighbours </td>
213          <td class="md" valign="top">(&nbsp;</td>
214          <td class="md" nowrap valign="top">void&nbsp;</td>
215          <td class="mdname1" valign="top" nowrap>          </td>
216          <td class="md" valign="top">&nbsp;)&nbsp;</td>
217          <td class="md" nowrap></td>
218        </tr>
219
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing=5 cellpadding=0 border=0>
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232After TerrainRenderables have been populated, this method adds the neighbour links.
233<p>
234<dl compact><dt><b>Remarks:</b></dt><dd>Should be called before adding the page to the scene manager. </dd></dl>
235    </td>
236  </tr>
237</table>
238<a class="anchor" name="Ogre_1_1TerrainPagea4" doxytag="Ogre::TerrainPage::setRenderQueue" ></a><p>
239<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
240  <tr>
241    <td class="mdRow">
242      <table cellpadding="0" cellspacing="0" border="0">
243        <tr>
244          <td class="md" nowrap valign="top"> void Ogre::TerrainPage::setRenderQueue </td>
245          <td class="md" valign="top">(&nbsp;</td>
246          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a669">RenderQueueGroupID</a>&nbsp;</td>
247          <td class="mdname1" valign="top" nowrap> <em>qid</em>          </td>
248          <td class="md" valign="top">&nbsp;)&nbsp;</td>
249          <td class="md" nowrap></td>
250        </tr>
251
252      </table>
253    </td>
254  </tr>
255</table>
256<table cellspacing=5 cellpadding=0 border=0>
257  <tr>
258    <td>
259      &nbsp;
260    </td>
261    <td>
262
263<p>
264Sets the render queue group which the tiles should be rendered in.
265<p>
266    </td>
267  </tr>
268</table>
269<hr><h2>Member Data Documentation</h2>
270<a class="anchor" name="Ogre_1_1TerrainPageo2" doxytag="Ogre::TerrainPage::pageSceneNode" ></a><p>
271<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
272  <tr>
273    <td class="mdRow">
274      <table cellpadding="0" cellspacing="0" border="0">
275        <tr>
276          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a>* <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo2">Ogre::TerrainPage::pageSceneNode</a>
277      </table>
278    </td>
279  </tr>
280</table>
281<table cellspacing=5 cellpadding=0 border=0>
282  <tr>
283    <td>
284      &nbsp;
285    </td>
286    <td>
287
288<p>
289The scene node to which all the tiles for this page are attached.
290<p>
291
292<p>
293Definition at line <a class="el" href="OgreTerrainPage_8h-source.html#l00058">58</a> of file <a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>.    </td>
294  </tr>
295</table>
296<a class="anchor" name="Ogre_1_1TerrainPageo0" doxytag="Ogre::TerrainPage::tiles" ></a><p>
297<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
298  <tr>
299    <td class="mdRow">
300      <table cellpadding="0" cellspacing="0" border="0">
301        <tr>
302          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew1">Terrain2D</a> <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo0">Ogre::TerrainPage::tiles</a>
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>
3152-dimensional vector of tiles, pre-allocated to the correct size
316<p>
317
318<p>
319Definition at line <a class="el" href="OgreTerrainPage_8h-source.html#l00054">54</a> of file <a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>.    </td>
320  </tr>
321</table>
322<a class="anchor" name="Ogre_1_1TerrainPageo1" doxytag="Ogre::TerrainPage::tilesPerPage" ></a><p>
323<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
324  <tr>
325    <td class="mdRow">
326      <table cellpadding="0" cellspacing="0" border="0">
327        <tr>
328          <td class="md" nowrap valign="top"> unsigned short <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo1">Ogre::TerrainPage::tilesPerPage</a>
329      </table>
330    </td>
331  </tr>
332</table>
333<table cellspacing=5 cellpadding=0 border=0>
334  <tr>
335    <td>
336      &nbsp;
337    </td>
338    <td>
339
340<p>
341The number of tiles across a page.
342<p>
343
344<p>
345Definition at line <a class="el" href="OgreTerrainPage_8h-source.html#l00056">56</a> of file <a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>.    </td>
346  </tr>
347</table>
348<hr>The documentation for this class was generated from the following file:<ul>
349<li><a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a></ul>
350<hr>
351<p>
352Copyright &copy; 2000-2005 by The OGRE Team<br />
353<!--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/>
354This 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/>
355                <!--/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#">
356                <Work rdf:about="">
357                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
358        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
359                </Work>
360                <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> -->
361
362Last modified Sun Feb 12 13:06:25 2006
363</p>
364</body>
365</html>
Note: See TracBrowser for help on using the repository browser.