source: NonGTP/FCollada/Documentation/class_f_c_d_geometry_source.html @ 964

Revision 964, 32.4 KB checked in by igarcia, 19 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FCDGeometrySource Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
14    <li><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
20    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23  </ul></div>
24<h1>FCDGeometrySource Class Reference<br>
25<small>
26[<a class="el" href="group___f_c_d_geometry.html">COLLADA Document Geometry Entity</a>]</small>
27</h1><!-- doxytag: class="FCDGeometrySource" --><!-- doxytag: inherits="FCDObjectWithId" -->A COLLADA data source for geometric meshes. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_geometry_source_8h-source.html">FCDGeometrySource.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDGeometrySource:
33<p><center><img src="class_f_c_d_geometry_source.png" usemap="#FCDGeometrySource_map" border="0" alt=""></center>
34<map name="FCDGeometrySource_map">
35<area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="0,112,133,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,133,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,133,24">
38</map>
39<a href="class_f_c_d_geometry_source-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#02597e76122f43117f30b0c89739e819">FCDGeometrySource</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#02597e76122f43117f30b0c89739e819"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#6d0bb3954d79d4231207b5f6f8571ca3">~FCDGeometrySource</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#6d0bb3954d79d4231207b5f6f8571ca3"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">const fstring &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#50fbd22bd142ca689a7b5fb42d9e47eb">GetName</a> () const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the name of the data source.  <a href="#50fbd22bd142ca689a7b5fb42d9e47eb"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FloatList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#5eb5af6983280bfc1743600055e885b2">GetSourceData</a> ()</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the pure data of the data source.  <a href="#5eb5af6983280bfc1743600055e885b2"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80e1e318d9ba5d0b8bba0d48910179ee"></a><!-- doxytag: member="FCDGeometrySource::GetSourceData" ref="80e1e318d9ba5d0b8bba0d48910179ee" args="() const " -->
55const <a class="el" href="classvector.html">FloatList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#80e1e318d9ba5d0b8bba0d48910179ee">GetSourceData</a> () const </td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#a69cb2d256791238b01b3d1ea4c79bb1">GetSourceStride</a> () const </td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the stride of the data within the source.  <a href="#a69cb2d256791238b01b3d1ea4c79bb1"></a><br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top">const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#fd948c1ce1f36c3e983788bd3b9cd757">GetSourceId</a> () const </td></tr>
62
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDAnimatedList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#57f5c66c83f517242912b6e29d3ceacb">GetAnimatedValues</a> ()</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of animated values for the data of the source.  <a href="#57f5c66c83f517242912b6e29d3ceacb"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5631b3fbab8d37ce5ac2f8f6f489f621"></a><!-- doxytag: member="FCDGeometrySource::GetAnimatedValues" ref="5631b3fbab8d37ce5ac2f8f6f489f621" args="() const " -->
67const <a class="el" href="classvector.html">FCDAnimatedList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#5631b3fbab8d37ce5ac2f8f6f489f621">GetAnimatedValues</a> () const </td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#cd53803c06d2d58962eb2ca5bd37c9ae">GetSourceNode</a> ()</td></tr>
71
72<tr><td class="memItemLeft" nowrap align="right" valign="top">FUDaeGeometryInput::Semantic&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#3993056896eea62dab1554f1ddceada6">GetSourceType</a> () const </td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type of data contained within the source.  <a href="#3993056896eea62dab1554f1ddceada6"></a><br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#8e9469c35a0e45c15407b63387fc1aa6">SetName</a> (const fstring &amp;_name)</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the user-friendly name of the data source.  <a href="#8e9469c35a0e45c15407b63387fc1aa6"></a><br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#ed22779d072298c36ca60e74b5a82328">SetSourceData</a> (const <a class="el" href="classvector.html">FloatList</a> &amp;_sourceData, uint32 _sourceStride, size_t offset=0, size_t count=0)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overwrites the data contained within the data source.  <a href="#ed22779d072298c36ca60e74b5a82328"></a><br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#901e159b1e71b9baee547beacf0c6ea3">SetSourceNode</a> (xmlNode *_sourceNode)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Sets the XML tree node associated with the data source.  <a href="#901e159b1e71b9baee547beacf0c6ea3"></a><br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#da666b2bf53d7c96c8116da04d06ae6f">SetSourceType</a> (FUDaeGeometryInput::Semantic type)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the type of data contained within this data source.  <a href="#da666b2bf53d7c96c8116da04d06ae6f"></a><br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_geometry_source.html">FCDGeometrySource</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#c06f878ba71c0d70e36b0f8dee2370b1">Clone</a> () const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Clones this data source.  <a href="#c06f878ba71c0d70e36b0f8dee2370b1"></a><br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#e01c7702b398a3b8ad6b6febdc45ffc9">LoadFromXML</a> (xmlNode *sourceNode)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the &lt;source&gt; element from a given COLLADA XML tree node.  <a href="#e01c7702b398a3b8ad6b6febdc45ffc9"></a><br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top">xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_source.html#9cae47628e7c539900745bdb2f9ddf4d">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the &lt;source&gt; element to the given COLLADA XML tree node.  <a href="#9cae47628e7c539900745bdb2f9ddf4d"></a><br></td></tr>
96</table>
97<hr><a name="_details"></a><h2>Detailed Description</h2>
98A COLLADA data source for geometric meshes.
99<p>
100A COLLADA data source for geometric meshes contains a list of floating-point values and the information to parse these floating-point values into meaningful content: the stride of the list and the type of data that the floating-point values represent. When the floating-point values are split according to the stride, you get multiple elemental values of the given type. A data source may also have a user-generated name to identify the data within. The name is optional and is used to keep around the user-friendly name for texture coordinate sets or color sets.<p>
101The values of the COLLADA data source may be animated individually, or together: as an element.
102<p>
103<hr><h2>Constructor &amp; Destructor Documentation</h2>
104<a class="anchor" name="02597e76122f43117f30b0c89739e819"></a><!-- doxytag: member="FCDGeometrySource::FCDGeometrySource" ref="02597e76122f43117f30b0c89739e819" args="(FCDocument *document)" --><p>
105<table class="mdTable" 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">FCDGeometrySource::FCDGeometrySource           </td>
111          <td class="md" valign="top">(&nbsp;</td>
112          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
113          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
114          <td class="md" valign="top">&nbsp;)&nbsp;</td>
115          <td class="md" nowrap></td>
116        </tr>
117      </table>
118    </td>
119  </tr>
120</table>
121<table cellspacing="5" cellpadding="0" border="0">
122  <tr>
123    <td>
124      &nbsp;
125    </td>
126    <td>
127
128<p>
129Constructor: do not use directly.
130<p>
131Use <a class="el" href="class_f_c_d_geometry_mesh.html#2c366584e4a4434fa5bd1e78f0e7f150">FCDGeometryMesh::AddSource</a> or FCDGeometryMesh::AddValueSource instead. <dl compact><dt><b>Parameters:</b></dt><dd>
132  <table border="0" cellspacing="2" cellpadding="0">
133    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document which owns the data source. </td></tr>
134  </table>
135</dl>
136    </td>
137  </tr>
138</table>
139<a class="anchor" name="6d0bb3954d79d4231207b5f6f8571ca3"></a><!-- doxytag: member="FCDGeometrySource::~FCDGeometrySource" ref="6d0bb3954d79d4231207b5f6f8571ca3" args="()" --><p>
140<table class="mdTable" cellpadding="2" cellspacing="0">
141  <tr>
142    <td class="mdRow">
143      <table cellpadding="0" cellspacing="0" border="0">
144        <tr>
145          <td class="md" nowrap valign="top">virtual FCDGeometrySource::~FCDGeometrySource           </td>
146          <td class="md" valign="top">(&nbsp;</td>
147          <td class="mdname1" valign="top" nowrap>          </td>
148          <td class="md" valign="top">&nbsp;)&nbsp;</td>
149          <td class="md" nowrap><code> [virtual]</code></td>
150        </tr>
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>
163Destructor: do not use directly.
164<p>
165The geometric mesh which contains the data source will release it.     </td>
166  </tr>
167</table>
168<hr><h2>Member Function Documentation</h2>
169<a class="anchor" name="c06f878ba71c0d70e36b0f8dee2370b1"></a><!-- doxytag: member="FCDGeometrySource::Clone" ref="c06f878ba71c0d70e36b0f8dee2370b1" args="() const " --><p>
170<table class="mdTable" 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="class_f_c_d_geometry_source.html">FCDGeometrySource</a>* FCDGeometrySource::Clone           </td>
176          <td class="md" valign="top">(&nbsp;</td>
177          <td class="mdname1" valign="top" nowrap>          </td>
178          <td class="md" valign="top">&nbsp;)&nbsp;</td>
179          <td class="md" nowrap> const</td>
180        </tr>
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>
193[INTERNAL] Clones this data source.
194<p>
195You will need to release this pointer manually. <dl compact><dt><b>Returns:</b></dt><dd>An identical copy of the data source. </dd></dl>
196    </td>
197  </tr>
198</table>
199<a class="anchor" name="57f5c66c83f517242912b6e29d3ceacb"></a><!-- doxytag: member="FCDGeometrySource::GetAnimatedValues" ref="57f5c66c83f517242912b6e29d3ceacb" args="()" --><p>
200<table class="mdTable" cellpadding="2" cellspacing="0">
201  <tr>
202    <td class="mdRow">
203      <table cellpadding="0" cellspacing="0" border="0">
204        <tr>
205          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDAnimatedList</a>&amp; FCDGeometrySource::GetAnimatedValues           </td>
206          <td class="md" valign="top">(&nbsp;</td>
207          <td class="mdname1" valign="top" nowrap>          </td>
208          <td class="md" valign="top">&nbsp;)&nbsp;</td>
209          <td class="md" nowrap><code> [inline]</code></td>
210        </tr>
211      </table>
212    </td>
213  </tr>
214</table>
215<table cellspacing="5" cellpadding="0" border="0">
216  <tr>
217    <td>
218      &nbsp;
219    </td>
220    <td>
221
222<p>
223Retrieves the list of animated values for the data of the source.
224<p>
225<dl compact><dt><b>Returns:</b></dt><dd>The list of animated values. </dd></dl>
226    </td>
227  </tr>
228</table>
229<a class="anchor" name="50fbd22bd142ca689a7b5fb42d9e47eb"></a><!-- doxytag: member="FCDGeometrySource::GetName" ref="50fbd22bd142ca689a7b5fb42d9e47eb" args="() const " --><p>
230<table class="mdTable" cellpadding="2" cellspacing="0">
231  <tr>
232    <td class="mdRow">
233      <table cellpadding="0" cellspacing="0" border="0">
234        <tr>
235          <td class="md" nowrap valign="top">const fstring&amp; FCDGeometrySource::GetName           </td>
236          <td class="md" valign="top">(&nbsp;</td>
237          <td class="mdname1" valign="top" nowrap>          </td>
238          <td class="md" valign="top">&nbsp;)&nbsp;</td>
239          <td class="md" nowrap> const<code> [inline]</code></td>
240        </tr>
241      </table>
242    </td>
243  </tr>
244</table>
245<table cellspacing="5" cellpadding="0" border="0">
246  <tr>
247    <td>
248      &nbsp;
249    </td>
250    <td>
251
252<p>
253Retrieves the name of the data source.
254<p>
255The name is optional and is used to keep around a user-friendly name for texture coordinate sets or color sets. <dl compact><dt><b>Returns:</b></dt><dd>The name of the data source. </dd></dl>
256    </td>
257  </tr>
258</table>
259<a class="anchor" name="5eb5af6983280bfc1743600055e885b2"></a><!-- doxytag: member="FCDGeometrySource::GetSourceData" ref="5eb5af6983280bfc1743600055e885b2" args="()" --><p>
260<table class="mdTable" cellpadding="2" cellspacing="0">
261  <tr>
262    <td class="mdRow">
263      <table cellpadding="0" cellspacing="0" border="0">
264        <tr>
265          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FloatList</a>&amp; FCDGeometrySource::GetSourceData           </td>
266          <td class="md" valign="top">(&nbsp;</td>
267          <td class="mdname1" valign="top" nowrap>          </td>
268          <td class="md" valign="top">&nbsp;)&nbsp;</td>
269          <td class="md" nowrap><code> [inline]</code></td>
270        </tr>
271      </table>
272    </td>
273  </tr>
274</table>
275<table cellspacing="5" cellpadding="0" border="0">
276  <tr>
277    <td>
278      &nbsp;
279    </td>
280    <td>
281
282<p>
283Retrieves the pure data of the data source.
284<p>
285This is a dynamically-sized array of floating-point values that contains all the data of the source. <dl compact><dt><b>Returns:</b></dt><dd>The pure data of the data source. </dd></dl>
286    </td>
287  </tr>
288</table>
289<a class="anchor" name="fd948c1ce1f36c3e983788bd3b9cd757"></a><!-- doxytag: member="FCDGeometrySource::GetSourceId" ref="fd948c1ce1f36c3e983788bd3b9cd757" args="() const " --><p>
290<table class="mdTable" cellpadding="2" cellspacing="0">
291  <tr>
292    <td class="mdRow">
293      <table cellpadding="0" cellspacing="0" border="0">
294        <tr>
295          <td class="md" nowrap valign="top">const string&amp; FCDGeometrySource::GetSourceId           </td>
296          <td class="md" valign="top">(&nbsp;</td>
297          <td class="mdname1" valign="top" nowrap>          </td>
298          <td class="md" valign="top">&nbsp;)&nbsp;</td>
299          <td class="md" nowrap> const<code> [inline]</code></td>
300        </tr>
301      </table>
302    </td>
303  </tr>
304</table>
305<table cellspacing="5" cellpadding="0" border="0">
306  <tr>
307    <td>
308      &nbsp;
309    </td>
310    <td>
311
312<p>
313<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>Retrieves the COLLADA id for the source. Use the class parent's GetDaeId function instead. </dd></dl>
314<dl compact><dt><b>Returns:</b></dt><dd>The COLLADA id. </dd></dl>
315    </td>
316  </tr>
317</table>
318<a class="anchor" name="cd53803c06d2d58962eb2ca5bd37c9ae"></a><!-- doxytag: member="FCDGeometrySource::GetSourceNode" ref="cd53803c06d2d58962eb2ca5bd37c9ae" args="()" --><p>
319<table class="mdTable" cellpadding="2" cellspacing="0">
320  <tr>
321    <td class="mdRow">
322      <table cellpadding="0" cellspacing="0" border="0">
323        <tr>
324          <td class="md" nowrap valign="top">xmlNode* FCDGeometrySource::GetSourceNode           </td>
325          <td class="md" valign="top">(&nbsp;</td>
326          <td class="mdname1" valign="top" nowrap>          </td>
327          <td class="md" valign="top">&nbsp;)&nbsp;</td>
328          <td class="md" nowrap><code> [inline]</code></td>
329        </tr>
330      </table>
331    </td>
332  </tr>
333</table>
334<table cellspacing="5" cellpadding="0" border="0">
335  <tr>
336    <td>
337      &nbsp;
338    </td>
339    <td>
340
341<p>
342<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>[INTERNAL] Retrieves the XML tree node that represent this source. This is used when computing the list of animated values. </dd></dl>
343<dl compact><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>Take the XML tree node out of this class. </dd></dl>
344<dl compact><dt><b>Returns:</b></dt><dd>The XML tree node. This pointer is invalid if accessed after the document is fully parsed. </dd></dl>
345    </td>
346  </tr>
347</table>
348<a class="anchor" name="a69cb2d256791238b01b3d1ea4c79bb1"></a><!-- doxytag: member="FCDGeometrySource::GetSourceStride" ref="a69cb2d256791238b01b3d1ea4c79bb1" args="() const " --><p>
349<table class="mdTable" cellpadding="2" cellspacing="0">
350  <tr>
351    <td class="mdRow">
352      <table cellpadding="0" cellspacing="0" border="0">
353        <tr>
354          <td class="md" nowrap valign="top">uint32 FCDGeometrySource::GetSourceStride           </td>
355          <td class="md" valign="top">(&nbsp;</td>
356          <td class="mdname1" valign="top" nowrap>          </td>
357          <td class="md" valign="top">&nbsp;)&nbsp;</td>
358          <td class="md" nowrap> const<code> [inline]</code></td>
359        </tr>
360      </table>
361    </td>
362  </tr>
363</table>
364<table cellspacing="5" cellpadding="0" border="0">
365  <tr>
366    <td>
367      &nbsp;
368    </td>
369    <td>
370
371<p>
372Retrieves the stride of the data within the source.
373<p>
374There is no guarantee that the number of data values within the source is a multiple of the stride, yet you should always verify that the stride is at least the wanted dimension. For example, there is no guarantee that your vertex position data source has a stride of 3. 3dsMax is known to always export 3D texture coordinate positions. <dl compact><dt><b>Returns:</b></dt><dd>The stride of the data. </dd></dl>
375    </td>
376  </tr>
377</table>
378<a class="anchor" name="3993056896eea62dab1554f1ddceada6"></a><!-- doxytag: member="FCDGeometrySource::GetSourceType" ref="3993056896eea62dab1554f1ddceada6" args="() const " --><p>
379<table class="mdTable" cellpadding="2" cellspacing="0">
380  <tr>
381    <td class="mdRow">
382      <table cellpadding="0" cellspacing="0" border="0">
383        <tr>
384          <td class="md" nowrap valign="top">FUDaeGeometryInput::Semantic FCDGeometrySource::GetSourceType           </td>
385          <td class="md" valign="top">(&nbsp;</td>
386          <td class="mdname1" valign="top" nowrap>          </td>
387          <td class="md" valign="top">&nbsp;)&nbsp;</td>
388          <td class="md" nowrap> const<code> [inline]</code></td>
389        </tr>
390      </table>
391    </td>
392  </tr>
393</table>
394<table cellspacing="5" cellpadding="0" border="0">
395  <tr>
396    <td>
397      &nbsp;
398    </td>
399    <td>
400
401<p>
402Retrieves the type of data contained within the source.
403<p>
404Common values for the type of data are POSITION, NORMAL, COLOR and TEXCOORD. Please see FUDaeGeometryInput for more information. <dl compact><dt><b>See also:</b></dt><dd>FUDaeGeometryInput. </dd></dl>
405<dl compact><dt><b>Returns:</b></dt><dd>The type of data contained within the source. </dd></dl>
406    </td>
407  </tr>
408</table>
409<a class="anchor" name="e01c7702b398a3b8ad6b6febdc45ffc9"></a><!-- doxytag: member="FCDGeometrySource::LoadFromXML" ref="e01c7702b398a3b8ad6b6febdc45ffc9" args="(xmlNode *sourceNode)" --><p>
410<table class="mdTable" cellpadding="2" cellspacing="0">
411  <tr>
412    <td class="mdRow">
413      <table cellpadding="0" cellspacing="0" border="0">
414        <tr>
415          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDGeometrySource::LoadFromXML           </td>
416          <td class="md" valign="top">(&nbsp;</td>
417          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
418          <td class="mdname1" valign="top" nowrap> <em>sourceNode</em>          </td>
419          <td class="md" valign="top">&nbsp;)&nbsp;</td>
420          <td class="md" nowrap></td>
421        </tr>
422      </table>
423    </td>
424  </tr>
425</table>
426<table cellspacing="5" cellpadding="0" border="0">
427  <tr>
428    <td>
429      &nbsp;
430    </td>
431    <td>
432
433<p>
434[INTERNAL] Reads in the &lt;source&gt; element from a given COLLADA XML tree node.
435<p>
436<dl compact><dt><b>Parameters:</b></dt><dd>
437  <table border="0" cellspacing="2" cellpadding="0">
438    <tr><td valign="top"></td><td valign="top"><em>sourceNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
439  </table>
440</dl>
441<dl compact><dt><b>Returns:</b></dt><dd>The status of the import. If the status is not successful, it may be dangerous to extract information from the data source. </dd></dl>
442    </td>
443  </tr>
444</table>
445<a class="anchor" name="8e9469c35a0e45c15407b63387fc1aa6"></a><!-- doxytag: member="FCDGeometrySource::SetName" ref="8e9469c35a0e45c15407b63387fc1aa6" args="(const fstring &amp;_name)" --><p>
446<table class="mdTable" cellpadding="2" cellspacing="0">
447  <tr>
448    <td class="mdRow">
449      <table cellpadding="0" cellspacing="0" border="0">
450        <tr>
451          <td class="md" nowrap valign="top">void FCDGeometrySource::SetName           </td>
452          <td class="md" valign="top">(&nbsp;</td>
453          <td class="md" nowrap valign="top">const fstring &amp;&nbsp;</td>
454          <td class="mdname1" valign="top" nowrap> <em>_name</em>          </td>
455          <td class="md" valign="top">&nbsp;)&nbsp;</td>
456          <td class="md" nowrap><code> [inline]</code></td>
457        </tr>
458      </table>
459    </td>
460  </tr>
461</table>
462<table cellspacing="5" cellpadding="0" border="0">
463  <tr>
464    <td>
465      &nbsp;
466    </td>
467    <td>
468
469<p>
470Sets the user-friendly name of the data source.
471<p>
472The name is optional and is used to keep around a user-friendly name for texture coordinate sets or color sets. <dl compact><dt><b>Parameters:</b></dt><dd>
473  <table border="0" cellspacing="2" cellpadding="0">
474    <tr><td valign="top"></td><td valign="top"><em>_name</em>&nbsp;</td><td>The user-friendly name of the data source. </td></tr>
475  </table>
476</dl>
477    </td>
478  </tr>
479</table>
480<a class="anchor" name="ed22779d072298c36ca60e74b5a82328"></a><!-- doxytag: member="FCDGeometrySource::SetSourceData" ref="ed22779d072298c36ca60e74b5a82328" args="(const FloatList &amp;_sourceData, uint32 _sourceStride, size_t offset=0, size_t count=0)" --><p>
481<table class="mdTable" cellpadding="2" cellspacing="0">
482  <tr>
483    <td class="mdRow">
484      <table cellpadding="0" cellspacing="0" border="0">
485        <tr>
486          <td class="md" nowrap valign="top">void FCDGeometrySource::SetSourceData           </td>
487          <td class="md" valign="top">(&nbsp;</td>
488          <td class="md" nowrap valign="top">const <a class="el" href="classvector.html">FloatList</a> &amp;&nbsp;</td>
489          <td class="mdname" nowrap> <em>_sourceData</em>, </td>
490        </tr>
491        <tr>
492          <td class="md" nowrap align="right"></td>
493          <td class="md"></td>
494          <td class="md" nowrap>uint32&nbsp;</td>
495          <td class="mdname" nowrap> <em>_sourceStride</em>, </td>
496        </tr>
497        <tr>
498          <td class="md" nowrap align="right"></td>
499          <td class="md"></td>
500          <td class="md" nowrap>size_t&nbsp;</td>
501          <td class="mdname" nowrap> <em>offset</em> = <code>0</code>, </td>
502        </tr>
503        <tr>
504          <td class="md" nowrap align="right"></td>
505          <td class="md"></td>
506          <td class="md" nowrap>size_t&nbsp;</td>
507          <td class="mdname" nowrap> <em>count</em> = <code>0</code></td>
508        </tr>
509        <tr>
510          <td class="md"></td>
511          <td class="md">)&nbsp;</td>
512          <td class="md" colspan="2"></td>
513        </tr>
514      </table>
515    </td>
516  </tr>
517</table>
518<table cellspacing="5" cellpadding="0" border="0">
519  <tr>
520    <td>
521      &nbsp;
522    </td>
523    <td>
524
525<p>
526Overwrites the data contained within the data source.
527<p>
528<dl compact><dt><b>Parameters:</b></dt><dd>
529  <table border="0" cellspacing="2" cellpadding="0">
530    <tr><td valign="top"></td><td valign="top"><em>_sourceData</em>&nbsp;</td><td>The new data for this source. </td></tr>
531    <tr><td valign="top"></td><td valign="top"><em>_sourceStride</em>&nbsp;</td><td>The stride for the new data. </td></tr>
532    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>The offset at which to start retrieving the new data. This argument defaults at 0 to indicate that the data copy should start from the beginning. </td></tr>
533    <tr><td valign="top"></td><td valign="top"><em>count</em>&nbsp;</td><td>The number of data entries to copy into the data source. This argument defaults at 0 to indicate that the data copy should include everything. </td></tr>
534  </table>
535</dl>
536    </td>
537  </tr>
538</table>
539<a class="anchor" name="901e159b1e71b9baee547beacf0c6ea3"></a><!-- doxytag: member="FCDGeometrySource::SetSourceNode" ref="901e159b1e71b9baee547beacf0c6ea3" args="(xmlNode *_sourceNode)" --><p>
540<table class="mdTable" cellpadding="2" cellspacing="0">
541  <tr>
542    <td class="mdRow">
543      <table cellpadding="0" cellspacing="0" border="0">
544        <tr>
545          <td class="md" nowrap valign="top">void FCDGeometrySource::SetSourceNode           </td>
546          <td class="md" valign="top">(&nbsp;</td>
547          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
548          <td class="mdname1" valign="top" nowrap> <em>_sourceNode</em>          </td>
549          <td class="md" valign="top">&nbsp;)&nbsp;</td>
550          <td class="md" nowrap><code> [inline]</code></td>
551        </tr>
552      </table>
553    </td>
554  </tr>
555</table>
556<table cellspacing="5" cellpadding="0" border="0">
557  <tr>
558    <td>
559      &nbsp;
560    </td>
561    <td>
562
563<p>
564[INTERNAL] Sets the XML tree node associated with the data source.
565<p>
566<dl compact><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>Take the XML tree node out of this class. </dd></dl>
567<dl compact><dt><b>Parameters:</b></dt><dd>
568  <table border="0" cellspacing="2" cellpadding="0">
569    <tr><td valign="top"></td><td valign="top"><em>_sourceNode</em>&nbsp;</td><td>A XML tree node. </td></tr>
570  </table>
571</dl>
572    </td>
573  </tr>
574</table>
575<a class="anchor" name="da666b2bf53d7c96c8116da04d06ae6f"></a><!-- doxytag: member="FCDGeometrySource::SetSourceType" ref="da666b2bf53d7c96c8116da04d06ae6f" args="(FUDaeGeometryInput::Semantic type)" --><p>
576<table class="mdTable" cellpadding="2" cellspacing="0">
577  <tr>
578    <td class="mdRow">
579      <table cellpadding="0" cellspacing="0" border="0">
580        <tr>
581          <td class="md" nowrap valign="top">void FCDGeometrySource::SetSourceType           </td>
582          <td class="md" valign="top">(&nbsp;</td>
583          <td class="md" nowrap valign="top">FUDaeGeometryInput::Semantic&nbsp;</td>
584          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
585          <td class="md" valign="top">&nbsp;)&nbsp;</td>
586          <td class="md" nowrap></td>
587        </tr>
588      </table>
589    </td>
590  </tr>
591</table>
592<table cellspacing="5" cellpadding="0" border="0">
593  <tr>
594    <td>
595      &nbsp;
596    </td>
597    <td>
598
599<p>
600Sets the type of data contained within this data source.
601<p>
602<dl compact><dt><b>Parameters:</b></dt><dd>
603  <table border="0" cellspacing="2" cellpadding="0">
604    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The new type of data for this data source. </td></tr>
605  </table>
606</dl>
607    </td>
608  </tr>
609</table>
610<a class="anchor" name="9cae47628e7c539900745bdb2f9ddf4d"></a><!-- doxytag: member="FCDGeometrySource::WriteToXML" ref="9cae47628e7c539900745bdb2f9ddf4d" args="(xmlNode *parentNode) const " --><p>
611<table class="mdTable" cellpadding="2" cellspacing="0">
612  <tr>
613    <td class="mdRow">
614      <table cellpadding="0" cellspacing="0" border="0">
615        <tr>
616          <td class="md" nowrap valign="top">xmlNode* FCDGeometrySource::WriteToXML           </td>
617          <td class="md" valign="top">(&nbsp;</td>
618          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
619          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
620          <td class="md" valign="top">&nbsp;)&nbsp;</td>
621          <td class="md" nowrap> const</td>
622        </tr>
623      </table>
624    </td>
625  </tr>
626</table>
627<table cellspacing="5" cellpadding="0" border="0">
628  <tr>
629    <td>
630      &nbsp;
631    </td>
632    <td>
633
634<p>
635[INTERNAL] Writes out the &lt;source&gt; element to the given COLLADA XML tree node.
636<p>
637<dl compact><dt><b>Parameters:</b></dt><dd>
638  <table border="0" cellspacing="2" cellpadding="0">
639    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the data source. </td></tr>
640  </table>
641</dl>
642<dl compact><dt><b>Returns:</b></dt><dd>The created &lt;source&gt; element XML tree node. </dd></dl>
643    </td>
644  </tr>
645</table>
646<hr>The documentation for this class was generated from the following file:<ul>
647<li>FCDocument/<a class="el" href="_f_c_d_geometry_source_8h-source.html">FCDGeometrySource.h</a></ul>
648<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by&nbsp;
649<a href="http://www.doxygen.org/index.html">
650<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
651</body>
652</html>
Note: See TracBrowser for help on using the repository browser.