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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::VertexData 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::VertexData Class Reference</h1>Summary class collecting together vertex source information. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1VertexData-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="structOgre_1_1VertexData_1_1HardwareAnimationData.html">HardwareAnimationData</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataw0">HardwareAnimationDataList</a></td></tr>
19
20<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa0">VertexData</a> ()</td></tr>
22
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa1">~VertexData</a> ()</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1VertexData.html">VertexData</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa2">clone</a> (bool copyData=true) const </td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clones this vertex data, potentially including replicating any vertex buffers.  <a href="#Ogre_1_1VertexDataa2"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa3">prepareForShadowVolume</a> (void)</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modifies the vertex data to be suitable for use for rendering shadow geometry.  <a href="#Ogre_1_1VertexDataa3"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa4">reorganiseBuffers</a> (<a class="el" href="classOgre_1_1VertexDeclaration.html">VertexDeclaration</a> *newDeclaration, const <a class="el" href="namespaceOgre.html#a597">BufferUsageList</a> &amp;bufferUsage)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reorganises the data in the vertex buffers according to the new vertex declaration passed in.  <a href="#Ogre_1_1VertexDataa4"></a><br><br></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa5">reorganiseBuffers</a> (<a class="el" href="classOgre_1_1VertexDeclaration.html">VertexDeclaration</a> *newDeclaration)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reorganises the data in the vertex buffers according to the new vertex declaration passed in.  <a href="#Ogre_1_1VertexDataa5"></a><br><br></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa6">convertPackedColour</a> (<a class="el" href="namespaceOgre.html#a660">VertexElementType</a> srcType, <a class="el" href="namespaceOgre.html#a660">VertexElementType</a> destType)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert all packed colour values (VET_COLOUR_*) in buffers used to another type.  <a href="#Ogre_1_1VertexDataa6"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataa7">allocateHardwareAnimationElements</a> (<a class="el" href="namespaceOgre.html#a467">ushort</a> count)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allocate elements to serve a holder of morph / pose target data for hardware morphing / pose blending.  <a href="#Ogre_1_1VertexDataa7"></a><br><br></td></tr>
43<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1VertexDeclaration.html">VertexDeclaration</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao0">vertexDeclaration</a></td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Declaration of the vertex to be used in this operation.  <a href="#Ogre_1_1VertexDatao0"></a><br><br></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1VertexBufferBinding.html">VertexBufferBinding</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao1">vertexBufferBinding</a></td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The vertex buffer bindings to be used.  <a href="#Ogre_1_1VertexDatao1"></a><br><br></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao2">vertexStart</a></td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The base vertex index to start from.  <a href="#Ogre_1_1VertexDatao2"></a><br><br></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao3">vertexCount</a></td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of vertices used in this operation.  <a href="#Ogre_1_1VertexDatao3"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataw0">HardwareAnimationDataList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao4">hwAnimationDataList</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">VertexElements used for hardware morph / pose animation.  <a href="#Ogre_1_1VertexDatao4"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao5">hwAnimDataItemsUsed</a></td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of hardware animation data items used.  <a href="#Ogre_1_1VertexDatao5"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1HardwareVertexBufferSharedPtr.html">HardwareVertexBufferSharedPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao6">hardwareShadowVolWBuffer</a></td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Additional shadow volume vertex buffer storage.  <a href="#Ogre_1_1VertexDatao6"></a><br><br></td></tr>
65<tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr>
66<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatad0">VertexData</a> (const <a class="el" href="classOgre_1_1VertexData.html">VertexData</a> &amp;rhs)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected copy constructor, to prevent misuse.  <a href="#Ogre_1_1VertexDatad0"></a><br><br></td></tr>
69<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1VertexData.html">VertexData</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatad1">operator=</a> (const <a class="el" href="classOgre_1_1VertexData.html">VertexData</a> &amp;rhs)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected operator=, to prevent misuse.  <a href="#Ogre_1_1VertexDatad1"></a><br><br></td></tr>
72</table>
73<hr><a name="_details"></a><h2>Detailed Description</h2>
74Summary class collecting together vertex source information.
75<p>
76
77<p>
78Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00039">39</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.<hr><h2>Member Typedef Documentation</h2>
79<a class="anchor" name="Ogre_1_1VertexDataw0" doxytag="Ogre::VertexData::HardwareAnimationDataList" ></a><p>
80<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
81  <tr>
82    <td class="mdRow">
83      <table cellpadding="0" cellspacing="0" border="0">
84        <tr>
85          <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="structOgre_1_1VertexData_1_1HardwareAnimationData.html">HardwareAnimationData</a>&gt; <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataw0">Ogre::VertexData::HardwareAnimationDataList</a>
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing=5 cellpadding=0 border=0>
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98
99<p>
100Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00070">70</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
101  </tr>
102</table>
103<hr><h2>Constructor &amp; Destructor Documentation</h2>
104<a class="anchor" name="Ogre_1_1VertexDatad0" doxytag="Ogre::VertexData::VertexData" ></a><p>
105<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
106  <tr>
107    <td class="mdRow">
108      <table cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <td class="md" nowrap valign="top"> Ogre::VertexData::VertexData </td>
111          <td class="md" valign="top">(&nbsp;</td>
112          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1VertexData.html">VertexData</a> &amp;&nbsp;</td>
113          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
114          <td class="md" valign="top">&nbsp;)&nbsp;</td>
115          <td class="md" nowrap><code> [private]</code></td>
116        </tr>
117
118      </table>
119    </td>
120  </tr>
121</table>
122<table cellspacing=5 cellpadding=0 border=0>
123  <tr>
124    <td>
125      &nbsp;
126    </td>
127    <td>
128
129<p>
130Protected copy constructor, to prevent misuse.
131<p>
132    </td>
133  </tr>
134</table>
135<a class="anchor" name="Ogre_1_1VertexDataa0" doxytag="Ogre::VertexData::VertexData" ></a><p>
136<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
137  <tr>
138    <td class="mdRow">
139      <table cellpadding="0" cellspacing="0" border="0">
140        <tr>
141          <td class="md" nowrap valign="top"> Ogre::VertexData::VertexData </td>
142          <td class="md" valign="top">(&nbsp;</td>
143          <td class="mdname1" valign="top" nowrap>          </td>
144          <td class="md" valign="top">&nbsp;)&nbsp;</td>
145          <td class="md" nowrap></td>
146        </tr>
147
148      </table>
149    </td>
150  </tr>
151</table>
152<table cellspacing=5 cellpadding=0 border=0>
153  <tr>
154    <td>
155      &nbsp;
156    </td>
157    <td>
158
159<p>
160    </td>
161  </tr>
162</table>
163<a class="anchor" name="Ogre_1_1VertexDataa1" doxytag="Ogre::VertexData::~VertexData" ></a><p>
164<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
165  <tr>
166    <td class="mdRow">
167      <table cellpadding="0" cellspacing="0" border="0">
168        <tr>
169          <td class="md" nowrap valign="top"> Ogre::VertexData::~<a class="el" href="classOgre_1_1VertexData.html">VertexData</a> </td>
170          <td class="md" valign="top">(&nbsp;</td>
171          <td class="mdname1" valign="top" nowrap>          </td>
172          <td class="md" valign="top">&nbsp;)&nbsp;</td>
173          <td class="md" nowrap></td>
174        </tr>
175
176      </table>
177    </td>
178  </tr>
179</table>
180<table cellspacing=5 cellpadding=0 border=0>
181  <tr>
182    <td>
183      &nbsp;
184    </td>
185    <td>
186
187<p>
188    </td>
189  </tr>
190</table>
191<hr><h2>Member Function Documentation</h2>
192<a class="anchor" name="Ogre_1_1VertexDataa7" doxytag="Ogre::VertexData::allocateHardwareAnimationElements" ></a><p>
193<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
194  <tr>
195    <td class="mdRow">
196      <table cellpadding="0" cellspacing="0" border="0">
197        <tr>
198          <td class="md" nowrap valign="top"> void Ogre::VertexData::allocateHardwareAnimationElements </td>
199          <td class="md" valign="top">(&nbsp;</td>
200          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a467">ushort</a>&nbsp;</td>
201          <td class="mdname1" valign="top" nowrap> <em>count</em>          </td>
202          <td class="md" valign="top">&nbsp;)&nbsp;</td>
203          <td class="md" nowrap></td>
204        </tr>
205
206      </table>
207    </td>
208  </tr>
209</table>
210<table cellspacing=5 cellpadding=0 border=0>
211  <tr>
212    <td>
213      &nbsp;
214    </td>
215    <td>
216
217<p>
218Allocate elements to serve a holder of morph / pose target data for hardware morphing / pose blending.
219<p>
220<dl compact><dt><b>Remarks:</b></dt><dd>This method will allocate the given number of 3D texture coordinate sets for use as a morph target or target pose offset (3D position). These elements will be saved in hwAnimationDataList. It will also assume that the source of these new elements will be new buffers which are not bound at this time, so will start the sources to 1 higher than the current highest binding source. The caller is expected to bind these new buffers when appropriate. For morph animation the original position buffer will be the 'from' keyframe data, whilst for pose animation it will be the original vertex data.</dd></dl>
221    </td>
222  </tr>
223</table>
224<a class="anchor" name="Ogre_1_1VertexDataa2" doxytag="Ogre::VertexData::clone" ></a><p>
225<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
226  <tr>
227    <td class="mdRow">
228      <table cellpadding="0" cellspacing="0" border="0">
229        <tr>
230          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1VertexData.html">VertexData</a>* Ogre::VertexData::clone </td>
231          <td class="md" valign="top">(&nbsp;</td>
232          <td class="md" nowrap valign="top">bool&nbsp;</td>
233          <td class="mdname1" valign="top" nowrap> <em>copyData</em> = true          </td>
234          <td class="md" valign="top">&nbsp;)&nbsp;</td>
235          <td class="md" nowrap> const</td>
236        </tr>
237
238      </table>
239    </td>
240  </tr>
241</table>
242<table cellspacing=5 cellpadding=0 border=0>
243  <tr>
244    <td>
245      &nbsp;
246    </td>
247    <td>
248
249<p>
250Clones this vertex data, potentially including replicating any vertex buffers.
251<p>
252<dl compact><dt><b>Remarks:</b></dt><dd>The caller is expected to delete the returned pointer when ready</dd></dl>
253    </td>
254  </tr>
255</table>
256<a class="anchor" name="Ogre_1_1VertexDataa6" doxytag="Ogre::VertexData::convertPackedColour" ></a><p>
257<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
258  <tr>
259    <td class="mdRow">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"> void Ogre::VertexData::convertPackedColour </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a660">VertexElementType</a>&nbsp;</td>
265          <td class="mdname" nowrap> <em>srcType</em>, </td>
266        </tr>
267        <tr>
268          <td class="md" nowrap align="right"></td>
269          <td></td>
270          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a660">VertexElementType</a>&nbsp;</td>
271          <td class="mdname" nowrap> <em>destType</em></td>
272        </tr>
273        <tr>
274          <td></td>
275          <td class="md">)&nbsp;</td>
276          <td class="md" colspan="2"></td>
277        </tr>
278
279      </table>
280    </td>
281  </tr>
282</table>
283<table cellspacing=5 cellpadding=0 border=0>
284  <tr>
285    <td>
286      &nbsp;
287    </td>
288    <td>
289
290<p>
291Convert all packed colour values (VET_COLOUR_*) in buffers used to another type.
292<p>
293<dl compact><dt><b>Parameters:</b></dt><dd>
294  <table border="0" cellspacing="2" cellpadding="0">
295    <tr><td valign=top><em>srcType</em>&nbsp;</td><td>The source colour type to assume if the ambiguous VET_COLOUR is encountered. </td></tr>
296    <tr><td valign=top><em>destType</em>&nbsp;</td><td>The destination colour type, must be VET_COLOUR_ABGR or VET_COLOUR_ARGB.</td></tr>
297  </table>
298</dl>
299    </td>
300  </tr>
301</table>
302<a class="anchor" name="Ogre_1_1VertexDatad1" doxytag="Ogre::VertexData::operator=" ></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"> <a class="el" href="classOgre_1_1VertexData.html">VertexData</a>&amp; Ogre::VertexData::operator= </td>
309          <td class="md" valign="top">(&nbsp;</td>
310          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1VertexData.html">VertexData</a> &amp;&nbsp;</td>
311          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
312          <td class="md" valign="top">&nbsp;)&nbsp;</td>
313          <td class="md" nowrap><code> [private]</code></td>
314        </tr>
315
316      </table>
317    </td>
318  </tr>
319</table>
320<table cellspacing=5 cellpadding=0 border=0>
321  <tr>
322    <td>
323      &nbsp;
324    </td>
325    <td>
326
327<p>
328Protected operator=, to prevent misuse.
329<p>
330    </td>
331  </tr>
332</table>
333<a class="anchor" name="Ogre_1_1VertexDataa3" doxytag="Ogre::VertexData::prepareForShadowVolume" ></a><p>
334<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
335  <tr>
336    <td class="mdRow">
337      <table cellpadding="0" cellspacing="0" border="0">
338        <tr>
339          <td class="md" nowrap valign="top"> void Ogre::VertexData::prepareForShadowVolume </td>
340          <td class="md" valign="top">(&nbsp;</td>
341          <td class="md" nowrap valign="top">void&nbsp;</td>
342          <td class="mdname1" valign="top" nowrap>          </td>
343          <td class="md" valign="top">&nbsp;)&nbsp;</td>
344          <td class="md" nowrap></td>
345        </tr>
346
347      </table>
348    </td>
349  </tr>
350</table>
351<table cellspacing=5 cellpadding=0 border=0>
352  <tr>
353    <td>
354      &nbsp;
355    </td>
356    <td>
357
358<p>
359Modifies the vertex data to be suitable for use for rendering shadow geometry.
360<p>
361<dl compact><dt><b>Remarks:</b></dt><dd>Preparing vertex data to generate a shadow volume involves firstly ensuring that the vertex buffer containing the positions is a standalone vertex buffer, with no other components in it. This method will therefore break apart any existing vertex buffers if position is sharing a vertex buffer. Secondly, it will double the size of this vertex buffer so that there are 2 copies of the position data for the mesh. The first half is used for the original, and the second half is used for the 'extruded' version. The vertex count used to render will remain the same though, so as not to add any overhead to regular rendering of the object. Both copies of the position are required in one buffer because shadow volumes stretch from the original mesh to the extruded version. </dd></dl>
362<dl compact><dt><b></b></dt><dd>It's important to appreciate that this method can fundamentally change the structure of your vertex buffers, although in reality they will be new buffers. As it happens, if other objects are using the original buffers then they will be unaffected because the reference counting will keep them intact. However, if you have made any assumptions about the structure of the vertex data in the buffers of this object, you may have to rethink them. </dd></dl>
363    </td>
364  </tr>
365</table>
366<a class="anchor" name="Ogre_1_1VertexDataa5" doxytag="Ogre::VertexData::reorganiseBuffers" ></a><p>
367<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
368  <tr>
369    <td class="mdRow">
370      <table cellpadding="0" cellspacing="0" border="0">
371        <tr>
372          <td class="md" nowrap valign="top"> void Ogre::VertexData::reorganiseBuffers </td>
373          <td class="md" valign="top">(&nbsp;</td>
374          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1VertexDeclaration.html">VertexDeclaration</a> *&nbsp;</td>
375          <td class="mdname1" valign="top" nowrap> <em>newDeclaration</em>          </td>
376          <td class="md" valign="top">&nbsp;)&nbsp;</td>
377          <td class="md" nowrap></td>
378        </tr>
379
380      </table>
381    </td>
382  </tr>
383</table>
384<table cellspacing=5 cellpadding=0 border=0>
385  <tr>
386    <td>
387      &nbsp;
388    </td>
389    <td>
390
391<p>
392Reorganises the data in the vertex buffers according to the new vertex declaration passed in.
393<p>
394Note that new vertex buffers are created and written to, so if the buffers being referenced by this vertex data object are also used by others, then the original buffers will not be damaged by this operation. Once this operation has completed, the new declaration passed in will overwrite the current one. This version of the method derives the buffer usages from the existing buffers, by using the 'most flexible' usage from the equivalent sources. <dl compact><dt><b>Parameters:</b></dt><dd>
395  <table border="0" cellspacing="2" cellpadding="0">
396    <tr><td valign=top><em>newDeclaration</em>&nbsp;</td><td>The vertex declaration which will be used for the reorganised buffer state. Note that the new delcaration must not include any elements which do not already exist in the current declaration; you can drop elements by excluding them from the declaration if you wish, however.</td></tr>
397  </table>
398</dl>
399    </td>
400  </tr>
401</table>
402<a class="anchor" name="Ogre_1_1VertexDataa4" doxytag="Ogre::VertexData::reorganiseBuffers" ></a><p>
403<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
404  <tr>
405    <td class="mdRow">
406      <table cellpadding="0" cellspacing="0" border="0">
407        <tr>
408          <td class="md" nowrap valign="top"> void Ogre::VertexData::reorganiseBuffers </td>
409          <td class="md" valign="top">(&nbsp;</td>
410          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1VertexDeclaration.html">VertexDeclaration</a> *&nbsp;</td>
411          <td class="mdname" nowrap> <em>newDeclaration</em>, </td>
412        </tr>
413        <tr>
414          <td class="md" nowrap align="right"></td>
415          <td></td>
416          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a597">BufferUsageList</a> &amp;&nbsp;</td>
417          <td class="mdname" nowrap> <em>bufferUsage</em></td>
418        </tr>
419        <tr>
420          <td></td>
421          <td class="md">)&nbsp;</td>
422          <td class="md" colspan="2"></td>
423        </tr>
424
425      </table>
426    </td>
427  </tr>
428</table>
429<table cellspacing=5 cellpadding=0 border=0>
430  <tr>
431    <td>
432      &nbsp;
433    </td>
434    <td>
435
436<p>
437Reorganises the data in the vertex buffers according to the new vertex declaration passed in.
438<p>
439Note that new vertex buffers are created and written to, so if the buffers being referenced by this vertex data object are also used by others, then the original buffers will not be damaged by this operation. Once this operation has completed, the new declaration passed in will overwrite the current one. <dl compact><dt><b>Parameters:</b></dt><dd>
440  <table border="0" cellspacing="2" cellpadding="0">
441    <tr><td valign=top><em>newDeclaration</em>&nbsp;</td><td>The vertex declaration which will be used for the reorganised buffer state. Note that the new delcaration must not include any elements which do not already exist in the current declaration; you can drop elements by excluding them from the declaration if you wish, however. </td></tr>
442    <tr><td valign=top><em>bufferUsages</em>&nbsp;</td><td>Vector of usage flags which indicate the usage options for each new vertex buffer created. The indexes of the entries must correspond to the buffer binding values referenced in the declaration.</td></tr>
443  </table>
444</dl>
445    </td>
446  </tr>
447</table>
448<hr><h2>Member Data Documentation</h2>
449<a class="anchor" name="Ogre_1_1VertexDatao6" doxytag="Ogre::VertexData::hardwareShadowVolWBuffer" ></a><p>
450<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
451  <tr>
452    <td class="mdRow">
453      <table cellpadding="0" cellspacing="0" border="0">
454        <tr>
455          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1HardwareVertexBufferSharedPtr.html">HardwareVertexBufferSharedPtr</a> <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao6">Ogre::VertexData::hardwareShadowVolWBuffer</a>
456      </table>
457    </td>
458  </tr>
459</table>
460<table cellspacing=5 cellpadding=0 border=0>
461  <tr>
462    <td>
463      &nbsp;
464    </td>
465    <td>
466
467<p>
468Additional shadow volume vertex buffer storage.
469<p>
470<dl compact><dt><b>Remarks:</b></dt><dd>This additional buffer is only used where we have prepared this <a class="el" href="classOgre_1_1VertexData.html">VertexData</a> for use in shadow volume contruction, and where the current render system supports vertex programs. This buffer contains the 'w' vertex position component which will be used by that program to differentiate between extruded and non-extruded vertices. This 'w' component cannot be included in the original position buffer because DirectX does not allow 4-component positions in the fixed-function pipeline, and the original position buffer must still be usable for fixed-function rendering. </dd></dl>
471<dl compact><dt><b></b></dt><dd>Note that we don't store any vertex declaration or vertex buffer binding here becuase this can be reused in the shadow algorithm. </dd></dl>
472
473<p>
474Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00115">115</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
475  </tr>
476</table>
477<a class="anchor" name="Ogre_1_1VertexDatao4" doxytag="Ogre::VertexData::hwAnimationDataList" ></a><p>
478<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
479  <tr>
480    <td class="mdRow">
481      <table cellpadding="0" cellspacing="0" border="0">
482        <tr>
483          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDataw0">HardwareAnimationDataList</a> <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao4">Ogre::VertexData::hwAnimationDataList</a>
484      </table>
485    </td>
486  </tr>
487</table>
488<table cellspacing=5 cellpadding=0 border=0>
489  <tr>
490    <td>
491      &nbsp;
492    </td>
493    <td>
494
495<p>
496VertexElements used for hardware morph / pose animation.
497<p>
498
499<p>
500Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00072">72</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
501  </tr>
502</table>
503<a class="anchor" name="Ogre_1_1VertexDatao5" doxytag="Ogre::VertexData::hwAnimDataItemsUsed" ></a><p>
504<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
505  <tr>
506    <td class="mdRow">
507      <table cellpadding="0" cellspacing="0" border="0">
508        <tr>
509          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao5">Ogre::VertexData::hwAnimDataItemsUsed</a>
510      </table>
511    </td>
512  </tr>
513</table>
514<table cellspacing=5 cellpadding=0 border=0>
515  <tr>
516    <td>
517      &nbsp;
518    </td>
519    <td>
520
521<p>
522Number of hardware animation data items used.
523<p>
524
525<p>
526Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00074">74</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
527  </tr>
528</table>
529<a class="anchor" name="Ogre_1_1VertexDatao1" doxytag="Ogre::VertexData::vertexBufferBinding" ></a><p>
530<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
531  <tr>
532    <td class="mdRow">
533      <table cellpadding="0" cellspacing="0" border="0">
534        <tr>
535          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1VertexBufferBinding.html">VertexBufferBinding</a>* <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao1">Ogre::VertexData::vertexBufferBinding</a>
536      </table>
537    </td>
538  </tr>
539</table>
540<table cellspacing=5 cellpadding=0 border=0>
541  <tr>
542    <td>
543      &nbsp;
544    </td>
545    <td>
546
547<p>
548The vertex buffer bindings to be used.
549<p>
550<dl compact><dt><b>Remarks:</b></dt><dd>Note that this is created for you on construction.</dd></dl>
551
552<p>
553Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00057">57</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
554  </tr>
555</table>
556<a class="anchor" name="Ogre_1_1VertexDatao3" doxytag="Ogre::VertexData::vertexCount" ></a><p>
557<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
558  <tr>
559    <td class="mdRow">
560      <table cellpadding="0" cellspacing="0" border="0">
561        <tr>
562          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao3">Ogre::VertexData::vertexCount</a>
563      </table>
564    </td>
565  </tr>
566</table>
567<table cellspacing=5 cellpadding=0 border=0>
568  <tr>
569    <td>
570      &nbsp;
571    </td>
572    <td>
573
574<p>
575The number of vertices used in this operation.
576<p>
577
578<p>
579Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00061">61</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
580  </tr>
581</table>
582<a class="anchor" name="Ogre_1_1VertexDatao0" doxytag="Ogre::VertexData::vertexDeclaration" ></a><p>
583<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
584  <tr>
585    <td class="mdRow">
586      <table cellpadding="0" cellspacing="0" border="0">
587        <tr>
588          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1VertexDeclaration.html">VertexDeclaration</a>* <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao0">Ogre::VertexData::vertexDeclaration</a>
589      </table>
590    </td>
591  </tr>
592</table>
593<table cellspacing=5 cellpadding=0 border=0>
594  <tr>
595    <td>
596      &nbsp;
597    </td>
598    <td>
599
600<p>
601Declaration of the vertex to be used in this operation.
602<p>
603<dl compact><dt><b>Remarks:</b></dt><dd>Note that this is created for you on construction.</dd></dl>
604
605<p>
606Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00053">53</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
607  </tr>
608</table>
609<a class="anchor" name="Ogre_1_1VertexDatao2" doxytag="Ogre::VertexData::vertexStart" ></a><p>
610<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
611  <tr>
612    <td class="mdRow">
613      <table cellpadding="0" cellspacing="0" border="0">
614        <tr>
615          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1VertexData.html#Ogre_1_1VertexDatao2">Ogre::VertexData::vertexStart</a>
616      </table>
617    </td>
618  </tr>
619</table>
620<table cellspacing=5 cellpadding=0 border=0>
621  <tr>
622    <td>
623      &nbsp;
624    </td>
625    <td>
626
627<p>
628The base vertex index to start from.
629<p>
630
631<p>
632Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00059">59</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
633  </tr>
634</table>
635<hr>The documentation for this class was generated from the following file:<ul>
636<li><a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a></ul>
637<hr>
638<p>
639Copyright &copy; 2000-2005 by The OGRE Team<br />
640<!--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/>
641This 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/>
642                <!--/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#">
643                <Work rdf:about="">
644                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
645        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
646                </Work>
647                <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> -->
648
649Last modified Sun Mar 12 14:46:00 2006
650</p>
651</body>
652</html>
Note: See TracBrowser for help on using the repository browser.