<html>
<head>
<title>Ogre::TerrainPage class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>Ogre::TerrainPage Class Reference</h1>Groups a number of TerrainRenderables (tiles) into a page, which is the unit of loading / unloading.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a>></code>
<p>
<a href="classOgre_1_1TerrainPage-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector< <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> * > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">TerrainRow</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector< <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">TerrainRow</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew1">Terrain2D</a></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagea0">TerrainPage</a> (unsigned short numTiles)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The main constructor. <a href="#Ogre_1_1TerrainPagea0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagea1">~TerrainPage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor, will organise the deletion of pages. <a href="#Ogre_1_1TerrainPagea1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagea2">linkNeighbours</a> (void)</td></tr>
<tr><td class="mdescLeft"> </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>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> * </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> &pt)</td></tr>
<tr><td class="mdescLeft"> </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>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </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#a668">RenderQueueGroupID</a> qid)</td></tr>
<tr><td class="mdescLeft"> </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>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew1">Terrain2D</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo0">tiles</a></td></tr>
<tr><td class="mdescLeft"> </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>
<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned short </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo1">tilesPerPage</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of tiles across a page. <a href="#Ogre_1_1TerrainPageo1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SceneNode.html">SceneNode</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo2">pageSceneNode</a></td></tr>
<tr><td class="mdescLeft"> </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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Groups a number of TerrainRenderables (tiles) into a page, which is the unit of loading / unloading.
<p>
<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>
<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>
<p>
<p>
Definition 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>
<a class="anchor" name="Ogre_1_1TerrainPagew1" doxytag="Ogre::TerrainPage::Terrain2D" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef std::vector< <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">TerrainRow</a> > <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew1">Ogre::TerrainPage::Terrain2D</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>
</tr>
</table>
<a class="anchor" name="Ogre_1_1TerrainPagew0" doxytag="Ogre::TerrainPage::TerrainRow" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef std::vector< <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> * > <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPagew0">Ogre::TerrainPage::TerrainRow</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="Ogre_1_1TerrainPagea0" doxytag="Ogre::TerrainPage::TerrainPage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::TerrainPage::TerrainPage </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned short </td>
<td class="mdname1" valign="top" nowrap> <em>numTiles</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The main constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>numTiles</em> </td><td>The number of terrain tiles (<a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a>) across (and down) a page </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1TerrainPagea1" doxytag="Ogre::TerrainPage::~TerrainPage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual Ogre::TerrainPage::~<a class="el" href="classOgre_1_1TerrainPage.html">TerrainPage</a> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor, will organise the deletion of pages.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="Ogre_1_1TerrainPagea3" doxytag="Ogre::TerrainPage::getTerrainTile" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a>* Ogre::TerrainPage::getTerrainTile </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>pt</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the <a class="el" href="classOgre_1_1TerrainRenderable.html">TerrainRenderable</a> that contains the given pt.
<p>
If no tile exists at the point, it returns 0; </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1TerrainPagea2" doxytag="Ogre::TerrainPage::linkNeighbours" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::TerrainPage::linkNeighbours </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
After TerrainRenderables have been populated, this method adds the neighbour links.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Should be called before adding the page to the scene manager. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1TerrainPagea4" doxytag="Ogre::TerrainPage::setRenderQueue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::TerrainPage::setRenderQueue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a668">RenderQueueGroupID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>qid</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the render queue group which the tiles should be rendered in.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="Ogre_1_1TerrainPageo2" doxytag="Ogre::TerrainPage::pageSceneNode" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The scene node to which all the tiles for this page are attached.
<p>
<p>
Definition 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>
</tr>
</table>
<a class="anchor" name="Ogre_1_1TerrainPageo0" doxytag="Ogre::TerrainPage::tiles" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
2-dimensional vector of tiles, pre-allocated to the correct size
<p>
<p>
Definition 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>
</tr>
</table>
<a class="anchor" name="Ogre_1_1TerrainPageo1" doxytag="Ogre::TerrainPage::tilesPerPage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned short <a class="el" href="classOgre_1_1TerrainPage.html#Ogre_1_1TerrainPageo1">Ogre::TerrainPage::tilesPerPage</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The number of tiles across a page.
<p>
<p>
Definition 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>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreTerrainPage_8h-source.html">OgreTerrainPage.h</a></ul>
<p>
Copyright © 2000-2005 by The OGRE Team<br />
Last modified Wed Feb 23 00:26:22 2005
</p>
</body>
</html>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
04e5d8c10ae76748689b4e7f48e0fa33
>
files
>
3083
