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

Revision 657, 13.5 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::IndexData 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::IndexData Class Reference</h1>Summary class collecting together index data 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_1IndexData-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 Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDataa0">IndexData</a> ()</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDataa1">~IndexData</a> ()</td></tr>
21
22<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1IndexData.html">IndexData</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDataa2">clone</a> (bool copyData=true) const </td></tr>
23
24<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clones this index data, potentially including replicating the index buffer.  <a href="#Ogre_1_1IndexDataa2"></a><br><br></td></tr>
25<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1HardwareIndexBufferSharedPtr.html">HardwareIndexBufferSharedPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatao0">indexBuffer</a></td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to the <a class="el" href="classOgre_1_1HardwareIndexBuffer.html">HardwareIndexBuffer</a> to use, must be specified if useIndexes = true  <a href="#Ogre_1_1IndexDatao0"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatao1">indexStart</a></td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">index in the buffer to start from for this operation  <a href="#Ogre_1_1IndexDatao1"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatao2">indexCount</a></td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of indexes to use from the buffer.  <a href="#Ogre_1_1IndexDatao2"></a><br><br></td></tr>
35<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatab0">IndexData</a> (const <a class="el" href="classOgre_1_1IndexData.html">IndexData</a> &amp;rhs)</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected copy constructor, to prevent misuse.  <a href="#Ogre_1_1IndexDatab0"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1IndexData.html">IndexData</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatab1">operator=</a> (const <a class="el" href="classOgre_1_1IndexData.html">IndexData</a> &amp;rhs)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected operator=, to prevent misuse.  <a href="#Ogre_1_1IndexDatab1"></a><br><br></td></tr>
42</table>
43<hr><a name="_details"></a><h2>Detailed Description</h2>
44Summary class collecting together index data source information.
45<p>
46
47<p>
48Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00145">145</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
49<a class="anchor" name="Ogre_1_1IndexDatab0" doxytag="Ogre::IndexData::IndexData" ></a><p>
50<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
51  <tr>
52    <td class="mdRow">
53      <table cellpadding="0" cellspacing="0" border="0">
54        <tr>
55          <td class="md" nowrap valign="top"> Ogre::IndexData::IndexData </td>
56          <td class="md" valign="top">(&nbsp;</td>
57          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1IndexData.html">IndexData</a> &amp;&nbsp;</td>
58          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
59          <td class="md" valign="top">&nbsp;)&nbsp;</td>
60          <td class="md" nowrap><code> [protected]</code></td>
61        </tr>
62
63      </table>
64    </td>
65  </tr>
66</table>
67<table cellspacing=5 cellpadding=0 border=0>
68  <tr>
69    <td>
70      &nbsp;
71    </td>
72    <td>
73
74<p>
75Protected copy constructor, to prevent misuse.
76<p>
77    </td>
78  </tr>
79</table>
80<a class="anchor" name="Ogre_1_1IndexDataa0" doxytag="Ogre::IndexData::IndexData" ></a><p>
81<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
82  <tr>
83    <td class="mdRow">
84      <table cellpadding="0" cellspacing="0" border="0">
85        <tr>
86          <td class="md" nowrap valign="top"> Ogre::IndexData::IndexData </td>
87          <td class="md" valign="top">(&nbsp;</td>
88          <td class="mdname1" valign="top" nowrap>          </td>
89          <td class="md" valign="top">&nbsp;)&nbsp;</td>
90          <td class="md" nowrap></td>
91        </tr>
92
93      </table>
94    </td>
95  </tr>
96</table>
97<table cellspacing=5 cellpadding=0 border=0>
98  <tr>
99    <td>
100      &nbsp;
101    </td>
102    <td>
103
104<p>
105    </td>
106  </tr>
107</table>
108<a class="anchor" name="Ogre_1_1IndexDataa1" doxytag="Ogre::IndexData::~IndexData" ></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::IndexData::~<a class="el" href="classOgre_1_1IndexData.html">IndexData</a> </td>
115          <td class="md" valign="top">(&nbsp;</td>
116          <td class="mdname1" valign="top" nowrap>          </td>
117          <td class="md" valign="top">&nbsp;)&nbsp;</td>
118          <td class="md" nowrap></td>
119        </tr>
120
121      </table>
122    </td>
123  </tr>
124</table>
125<table cellspacing=5 cellpadding=0 border=0>
126  <tr>
127    <td>
128      &nbsp;
129    </td>
130    <td>
131
132<p>
133    </td>
134  </tr>
135</table>
136<hr><h2>Member Function Documentation</h2>
137<a class="anchor" name="Ogre_1_1IndexDataa2" doxytag="Ogre::IndexData::clone" ></a><p>
138<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
139  <tr>
140    <td class="mdRow">
141      <table cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1IndexData.html">IndexData</a>* Ogre::IndexData::clone </td>
144          <td class="md" valign="top">(&nbsp;</td>
145          <td class="md" nowrap valign="top">bool&nbsp;</td>
146          <td class="mdname1" valign="top" nowrap> <em>copyData</em> = true          </td>
147          <td class="md" valign="top">&nbsp;)&nbsp;</td>
148          <td class="md" nowrap> const</td>
149        </tr>
150
151      </table>
152    </td>
153  </tr>
154</table>
155<table cellspacing=5 cellpadding=0 border=0>
156  <tr>
157    <td>
158      &nbsp;
159    </td>
160    <td>
161
162<p>
163Clones this index data, potentially including replicating the index buffer.
164<p>
165<dl compact><dt><b>Remarks:</b></dt><dd>The caller is expected to delete the returned pointer when finished</dd></dl>
166    </td>
167  </tr>
168</table>
169<a class="anchor" name="Ogre_1_1IndexDatab1" doxytag="Ogre::IndexData::operator=" ></a><p>
170<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
171  <tr>
172    <td class="mdRow">
173      <table cellpadding="0" cellspacing="0" border="0">
174        <tr>
175          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1IndexData.html">IndexData</a>&amp; Ogre::IndexData::operator= </td>
176          <td class="md" valign="top">(&nbsp;</td>
177          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1IndexData.html">IndexData</a> &amp;&nbsp;</td>
178          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
179          <td class="md" valign="top">&nbsp;)&nbsp;</td>
180          <td class="md" nowrap><code> [protected]</code></td>
181        </tr>
182
183      </table>
184    </td>
185  </tr>
186</table>
187<table cellspacing=5 cellpadding=0 border=0>
188  <tr>
189    <td>
190      &nbsp;
191    </td>
192    <td>
193
194<p>
195Protected operator=, to prevent misuse.
196<p>
197    </td>
198  </tr>
199</table>
200<hr><h2>Member Data Documentation</h2>
201<a class="anchor" name="Ogre_1_1IndexDatao0" doxytag="Ogre::IndexData::indexBuffer" ></a><p>
202<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
203  <tr>
204    <td class="mdRow">
205      <table cellpadding="0" cellspacing="0" border="0">
206        <tr>
207          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1HardwareIndexBufferSharedPtr.html">HardwareIndexBufferSharedPtr</a> <a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatao0">Ogre::IndexData::indexBuffer</a>
208      </table>
209    </td>
210  </tr>
211</table>
212<table cellspacing=5 cellpadding=0 border=0>
213  <tr>
214    <td>
215      &nbsp;
216    </td>
217    <td>
218
219<p>
220pointer to the <a class="el" href="classOgre_1_1HardwareIndexBuffer.html">HardwareIndexBuffer</a> to use, must be specified if useIndexes = true
221<p>
222
223<p>
224Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00156">156</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
225  </tr>
226</table>
227<a class="anchor" name="Ogre_1_1IndexDatao2" doxytag="Ogre::IndexData::indexCount" ></a><p>
228<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
229  <tr>
230    <td class="mdRow">
231      <table cellpadding="0" cellspacing="0" border="0">
232        <tr>
233          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatao2">Ogre::IndexData::indexCount</a>
234      </table>
235    </td>
236  </tr>
237</table>
238<table cellspacing=5 cellpadding=0 border=0>
239  <tr>
240    <td>
241      &nbsp;
242    </td>
243    <td>
244
245<p>
246The number of indexes to use from the buffer.
247<p>
248
249<p>
250Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00162">162</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
251  </tr>
252</table>
253<a class="anchor" name="Ogre_1_1IndexDatao1" doxytag="Ogre::IndexData::indexStart" ></a><p>
254<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
255  <tr>
256    <td class="mdRow">
257      <table cellpadding="0" cellspacing="0" border="0">
258        <tr>
259          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1IndexData.html#Ogre_1_1IndexDatao1">Ogre::IndexData::indexStart</a>
260      </table>
261    </td>
262  </tr>
263</table>
264<table cellspacing=5 cellpadding=0 border=0>
265  <tr>
266    <td>
267      &nbsp;
268    </td>
269    <td>
270
271<p>
272index in the buffer to start from for this operation
273<p>
274
275<p>
276Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00159">159</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.    </td>
277  </tr>
278</table>
279<hr>The documentation for this class was generated from the following file:<ul>
280<li><a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a></ul>
281<hr>
282<p>
283Copyright &copy; 2000-2005 by The OGRE Team<br />
284<!--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/>
285This 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/>
286                <!--/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#">
287                <Work rdf:about="">
288                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
289        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
290                </Work>
291                <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> -->
292
293Last modified Sun Feb 12 13:04:57 2006
294</p>
295</body>
296</html>
Note: See TracBrowser for help on using the repository browser.