<html>
<head>
<title>Ogre::StaticFaceGroup struct 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.2.16 -->
<center>
<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">Compound 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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::StaticFaceGroup Struct Reference</h1>Collectes a group of static ie immovable faces together which have common properties like the material they use, the plane they lie on.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>></code>
<p>
Collaboration diagram for Ogre::StaticFaceGroup:<p><center><img src="structOgre_1_1StaticFaceGroup__coll__graph.png" border="0" usemap="#Ogre_1_1StaticFaceGroup__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1StaticFaceGroup__coll__map">
<area href="classOgre_1_1PatchSurface.html" shape="rect" coords="19,35,144,16" alt="">
<area href="classOgre_1_1Plane.html" shape="rect" coords="41,103,121,84" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="structOgre_1_1StaticFaceGroup-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a645">FaceGroupType</a> </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm0">fType</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm1">isSky</a></td></tr>
<tr><td> </td><td><font size=-1><em>Is this a sky surface?</em> <a href="#Ogre_1_1StaticFaceGroupm1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm2">vertexStart</a></td></tr>
<tr><td> </td><td><font size=-1><em>Index into a buffer containing vertex definitions.</em> <a href="#Ogre_1_1StaticFaceGroupm2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm3">numVertices</a></td></tr>
<tr><td> </td><td><font size=-1><em>The range of vertices in the buffer this facegroup references.</em> <a href="#Ogre_1_1StaticFaceGroupm3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm4">elementStart</a></td></tr>
<tr><td> </td><td><font size=-1><em>Index into a buffer containing vertex indices.</em> <a href="#Ogre_1_1StaticFaceGroupm4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm5">numElements</a></td></tr>
<tr><td> </td><td><font size=-1><em>The number of vertex indices.</em> <a href="#Ogre_1_1StaticFaceGroupm5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm6">materialHandle</a></td></tr>
<tr><td> </td><td><font size=-1><em>Handle to material used by this group.</em> <a href="#Ogre_1_1StaticFaceGroupm6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Plane.html">Plane</a> </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm7">plane</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1PatchSurface.html">PatchSurface</a> * </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupm8">patchSurf</a></td></tr>
<tr><td> </td><td><font size=-1><em>Patch surface (only applicable when fType = FGT_PATCH).</em> <a href="#Ogre_1_1StaticFaceGroupm8"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td nowrap align=right valign=top>std::ostream & </td><td valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupl0">operator<<</a> (std::ostream &o, StaticFaceGroup &s)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Collectes a group of static ie immovable faces together which have common properties like the material they use, the plane they lie on.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Whilst for discrete geometry (i.e. movable objects) groups of faces are held in the <a class="el" href="classOgre_1_1SubMesh.html">SubMesh</a> class, for immovable objects like scenery there needs to ba little more flexibility in the grouping since the group is likely to be a small part of a huge set of geometry. In addition, because the faces are unmoving certain optimisations can be performed, e.g. precalculating a world-coordinate bounding box and normal.
<p>
Exactly how this class is used depends on the format of the large static geometry used in the level. An example would be the use of this class in the <a class="el" href="classOgre_1_1BspNode.html">BspNode</a> class for indoor levels. For flexibility and efficiency, it is not assumed that this class holds details of the vertices itself, or in fact that it holds the vertex indices itself. Everything is manipulated via pointers so if you want this class to point into a block of geometry data it can. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00060">60</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.<hr><h2>Friends And Related Function Documentation</h2>
<a name="Ogre_1_1StaticFaceGroupl0" doxytag="Ogre::StaticFaceGroup::operator<<"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::ostream& operator<< </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::ostream & </td>
<td class="mdname" nowrap> <em>o</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>StaticFaceGroup & </td>
<td class="mdname" nowrap> <em>s</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00104">104</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1StaticFaceGroupm4" doxytag="Ogre::StaticFaceGroup::elementStart"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::StaticFaceGroup::elementStart
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Index into a buffer containing vertex indices.
<p>
This buffer may be individual to this group or shared for memory allocation efficiency.The vertex indexes are relative the the mVertexStart pointer, not to the start of the large-level buffer, allowing simple reindexing when copying data into rendering buffers. This is only applicable to FGT_FACE_LIST face group types.
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00085">85</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00349">Ogre::BspSceneManager::cacheGeometry</a>(), and <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm0" doxytag="Ogre::StaticFaceGroup::fType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a645">FaceGroupType</a> Ogre::StaticFaceGroup::fType
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00062">62</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00349">Ogre::BspSceneManager::cacheGeometry</a>(), and <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm1" doxytag="Ogre::StaticFaceGroup::isSky"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::StaticFaceGroup::isSky
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Is this a sky surface?
<p>
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00065">65</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00349">Ogre::BspSceneManager::cacheGeometry</a>(), and <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm6" doxytag="Ogre::StaticFaceGroup::materialHandle"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::StaticFaceGroup::materialHandle
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Handle to material used by this group.
<p>
Note the use of the material handle rather than the material name - this is for efficiency since there will be many of these.
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00096">96</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(), and <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00278">Ogre::BspSceneManager::processVisibleLeaf</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm5" doxytag="Ogre::StaticFaceGroup::numElements"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::StaticFaceGroup::numElements
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The number of vertex indices.
<p>
This is only applicable to FGT_FACE_LIST face group types.
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00090">90</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00349">Ogre::BspSceneManager::cacheGeometry</a>(), and <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm3" doxytag="Ogre::StaticFaceGroup::numVertices"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::StaticFaceGroup::numVertices
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The range of vertices in the buffer this facegroup references.
<p>
This is really for copying purposes only, so that we know which subset of vertices to copy from our large-level buffer into the rendering buffer.
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00076">76</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm8" doxytag="Ogre::StaticFaceGroup::patchSurf"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1PatchSurface.html">PatchSurface</a>* Ogre::StaticFaceGroup::patchSurf
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Patch surface (only applicable when fType = FGT_PATCH).
<p>
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00101">101</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00349">Ogre::BspSceneManager::cacheGeometry</a>(), and <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm7" doxytag="Ogre::StaticFaceGroup::plane"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Plane.html">Plane</a> Ogre::StaticFaceGroup::plane
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00098">98</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(), and <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00278">Ogre::BspSceneManager::processVisibleLeaf</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1StaticFaceGroupm2" doxytag="Ogre::StaticFaceGroup::vertexStart"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::StaticFaceGroup::vertexStart
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Index into a buffer containing vertex definitions.
<p>
Because we're dealing with subsets of large levels this is likely to be part-way through a huge vertex buffer.
<p>
Definition at line <a class="el" href="OgreStaticFaceGroup_8h-source.html#l00070">70</a> of file <a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>.
<p>
Referenced by <a class="el" href="OgreBspSceneManager_8cpp-source.html#l00349">Ogre::BspSceneManager::cacheGeometry</a>(), and <a class="el" href="OgreBspLevel_8cpp-source.html#l00113">Ogre::BspLevel::loadQuake3Level</a>(). </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:20:46 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
3546
