source: OGRE/trunk/ogrenew/Docs/api/html/structOgre_1_1StaticFaceGroup.html @ 692

Revision 692, 17.6 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::StaticFaceGroup struct 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::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. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a>&gt;</code>
14<p>
15<a href="structOgre_1_1StaticFaceGroup-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 Attributes</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a682">FaceGroupType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo0">fType</a></td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo1">isSky</a></td></tr>
21
22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is this a sky surface?  <a href="#Ogre_1_1StaticFaceGroupo1"></a><br><br></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo2">vertexStart</a></td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Index into a buffer containing vertex definitions.  <a href="#Ogre_1_1StaticFaceGroupo2"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo3">numVertices</a></td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The range of vertices in the buffer this facegroup references.  <a href="#Ogre_1_1StaticFaceGroupo3"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo4">elementStart</a></td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Index into a buffer containing vertex indices.  <a href="#Ogre_1_1StaticFaceGroupo4"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo5">numElements</a></td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of vertex indices.  <a href="#Ogre_1_1StaticFaceGroupo5"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo6">materialHandle</a></td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handle to material used by this group.  <a href="#Ogre_1_1StaticFaceGroupo6"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Plane.html">Plane</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo7">plane</a></td></tr>
39
40<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1PatchSurface.html">PatchSurface</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo8">patchSurf</a></td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Patch surface (only applicable when fType = FGT_PATCH).  <a href="#Ogre_1_1StaticFaceGroupo8"></a><br><br></td></tr>
43<tr><td colspan=2><br><h2>Friends</h2></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>std::ostream &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupn0">operator&lt;&lt;</a> (std::ostream &amp;o, <a class="el" href="structOgre_1_1StaticFaceGroup.html">StaticFaceGroup</a> &amp;s)</td></tr>
45
46</table>
47<hr><a name="_details"></a><h2>Detailed Description</h2>
48Collectes a group of static ie immovable faces together which have common properties like the material they use, the plane they lie on.
49<p>
50<dl compact><dt><b>Remarks:</b></dt><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. </dd></dl>
51<dl compact><dt><b></b></dt><dd>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. </dd></dl>
52
53<p>
54
55<p>
56Definition 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>
57<a class="anchor" name="Ogre_1_1StaticFaceGroupn0" doxytag="Ogre::StaticFaceGroup::operator<<" ></a><p>
58<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
59  <tr>
60    <td class="mdRow">
61      <table cellpadding="0" cellspacing="0" border="0">
62        <tr>
63          <td class="md" nowrap valign="top"> std::ostream&amp; operator&lt;&lt; </td>
64          <td class="md" valign="top">(&nbsp;</td>
65          <td class="md" nowrap valign="top">std::ostream &amp;&nbsp;</td>
66          <td class="mdname" nowrap> <em>o</em>, </td>
67        </tr>
68        <tr>
69          <td class="md" nowrap align="right"></td>
70          <td></td>
71          <td class="md" nowrap><a class="el" href="structOgre_1_1StaticFaceGroup.html">StaticFaceGroup</a> &amp;&nbsp;</td>
72          <td class="mdname" nowrap> <em>s</em></td>
73        </tr>
74        <tr>
75          <td></td>
76          <td class="md">)&nbsp;</td>
77          <td class="md" colspan="2"><code> [friend]</code></td>
78        </tr>
79
80      </table>
81    </td>
82  </tr>
83</table>
84<table cellspacing=5 cellpadding=0 border=0>
85  <tr>
86    <td>
87      &nbsp;
88    </td>
89    <td>
90
91<p>
92
93<p>
94Definition 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>
95  </tr>
96</table>
97<hr><h2>Member Data Documentation</h2>
98<a class="anchor" name="Ogre_1_1StaticFaceGroupo4" doxytag="Ogre::StaticFaceGroup::elementStart" ></a><p>
99<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
100  <tr>
101    <td class="mdRow">
102      <table cellpadding="0" cellspacing="0" border="0">
103        <tr>
104          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo4">Ogre::StaticFaceGroup::elementStart</a>
105      </table>
106    </td>
107  </tr>
108</table>
109<table cellspacing=5 cellpadding=0 border=0>
110  <tr>
111    <td>
112      &nbsp;
113    </td>
114    <td>
115
116<p>
117Index into a buffer containing vertex indices.
118<p>
119This 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.
120<p>
121Definition 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>.    </td>
122  </tr>
123</table>
124<a class="anchor" name="Ogre_1_1StaticFaceGroupo0" doxytag="Ogre::StaticFaceGroup::fType" ></a><p>
125<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
126  <tr>
127    <td class="mdRow">
128      <table cellpadding="0" cellspacing="0" border="0">
129        <tr>
130          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a682">FaceGroupType</a> <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo0">Ogre::StaticFaceGroup::fType</a>
131      </table>
132    </td>
133  </tr>
134</table>
135<table cellspacing=5 cellpadding=0 border=0>
136  <tr>
137    <td>
138      &nbsp;
139    </td>
140    <td>
141
142<p>
143
144<p>
145Definition 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>.    </td>
146  </tr>
147</table>
148<a class="anchor" name="Ogre_1_1StaticFaceGroupo1" doxytag="Ogre::StaticFaceGroup::isSky" ></a><p>
149<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
150  <tr>
151    <td class="mdRow">
152      <table cellpadding="0" cellspacing="0" border="0">
153        <tr>
154          <td class="md" nowrap valign="top"> bool <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo1">Ogre::StaticFaceGroup::isSky</a>
155      </table>
156    </td>
157  </tr>
158</table>
159<table cellspacing=5 cellpadding=0 border=0>
160  <tr>
161    <td>
162      &nbsp;
163    </td>
164    <td>
165
166<p>
167Is this a sky surface?
168<p>
169
170<p>
171Definition 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>.    </td>
172  </tr>
173</table>
174<a class="anchor" name="Ogre_1_1StaticFaceGroupo6" doxytag="Ogre::StaticFaceGroup::materialHandle" ></a><p>
175<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
176  <tr>
177    <td class="mdRow">
178      <table cellpadding="0" cellspacing="0" border="0">
179        <tr>
180          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo6">Ogre::StaticFaceGroup::materialHandle</a>
181      </table>
182    </td>
183  </tr>
184</table>
185<table cellspacing=5 cellpadding=0 border=0>
186  <tr>
187    <td>
188      &nbsp;
189    </td>
190    <td>
191
192<p>
193Handle to material used by this group.
194<p>
195Note the use of the material handle rather than the material name - this is for efficiency since there will be many of these.
196<p>
197Definition 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>.    </td>
198  </tr>
199</table>
200<a class="anchor" name="Ogre_1_1StaticFaceGroupo5" doxytag="Ogre::StaticFaceGroup::numElements" ></a><p>
201<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
202  <tr>
203    <td class="mdRow">
204      <table cellpadding="0" cellspacing="0" border="0">
205        <tr>
206          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo5">Ogre::StaticFaceGroup::numElements</a>
207      </table>
208    </td>
209  </tr>
210</table>
211<table cellspacing=5 cellpadding=0 border=0>
212  <tr>
213    <td>
214      &nbsp;
215    </td>
216    <td>
217
218<p>
219The number of vertex indices.
220<p>
221This is only applicable to FGT_FACE_LIST face group types.
222<p>
223Definition 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>.    </td>
224  </tr>
225</table>
226<a class="anchor" name="Ogre_1_1StaticFaceGroupo3" doxytag="Ogre::StaticFaceGroup::numVertices" ></a><p>
227<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
228  <tr>
229    <td class="mdRow">
230      <table cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo3">Ogre::StaticFaceGroup::numVertices</a>
233      </table>
234    </td>
235  </tr>
236</table>
237<table cellspacing=5 cellpadding=0 border=0>
238  <tr>
239    <td>
240      &nbsp;
241    </td>
242    <td>
243
244<p>
245The range of vertices in the buffer this facegroup references.
246<p>
247This 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.
248<p>
249Definition 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>.    </td>
250  </tr>
251</table>
252<a class="anchor" name="Ogre_1_1StaticFaceGroupo8" doxytag="Ogre::StaticFaceGroup::patchSurf" ></a><p>
253<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
254  <tr>
255    <td class="mdRow">
256      <table cellpadding="0" cellspacing="0" border="0">
257        <tr>
258          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1PatchSurface.html">PatchSurface</a>* <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo8">Ogre::StaticFaceGroup::patchSurf</a>
259      </table>
260    </td>
261  </tr>
262</table>
263<table cellspacing=5 cellpadding=0 border=0>
264  <tr>
265    <td>
266      &nbsp;
267    </td>
268    <td>
269
270<p>
271Patch surface (only applicable when fType = FGT_PATCH).
272<p>
273
274<p>
275Definition 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>.    </td>
276  </tr>
277</table>
278<a class="anchor" name="Ogre_1_1StaticFaceGroupo7" doxytag="Ogre::StaticFaceGroup::plane" ></a><p>
279<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
280  <tr>
281    <td class="mdRow">
282      <table cellpadding="0" cellspacing="0" border="0">
283        <tr>
284          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Plane.html">Plane</a> <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo7">Ogre::StaticFaceGroup::plane</a>
285      </table>
286    </td>
287  </tr>
288</table>
289<table cellspacing=5 cellpadding=0 border=0>
290  <tr>
291    <td>
292      &nbsp;
293    </td>
294    <td>
295
296<p>
297
298<p>
299Definition 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>.    </td>
300  </tr>
301</table>
302<a class="anchor" name="Ogre_1_1StaticFaceGroupo2" doxytag="Ogre::StaticFaceGroup::vertexStart" ></a><p>
303<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
304  <tr>
305    <td class="mdRow">
306      <table cellpadding="0" cellspacing="0" border="0">
307        <tr>
308          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1StaticFaceGroup.html#Ogre_1_1StaticFaceGroupo2">Ogre::StaticFaceGroup::vertexStart</a>
309      </table>
310    </td>
311  </tr>
312</table>
313<table cellspacing=5 cellpadding=0 border=0>
314  <tr>
315    <td>
316      &nbsp;
317    </td>
318    <td>
319
320<p>
321Index into a buffer containing vertex definitions.
322<p>
323Because we're dealing with subsets of large levels this is likely to be part-way through a huge vertex buffer.
324<p>
325Definition 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>.    </td>
326  </tr>
327</table>
328<hr>The documentation for this struct was generated from the following file:<ul>
329<li><a class="el" href="OgreStaticFaceGroup_8h-source.html">OgreStaticFaceGroup.h</a></ul>
330<hr>
331<p>
332Copyright &copy; 2000-2005 by The OGRE Team<br />
333<!--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/>
334This 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/>
335                <!--/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#">
336                <Work rdf:about="">
337                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
338        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
339                </Work>
340                <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> -->
341
342Last modified Sun Mar 12 14:44:36 2006
343</p>
344</body>
345</html>
Note: See TracBrowser for help on using the repository browser.