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

Revision 964, 26.0 KB checked in by igarcia, 18 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: FCDEffectCode 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>FCDEffectCode Class Reference</h1><!-- doxytag: class="FCDEffectCode" --><!-- doxytag: inherits="FCDObject" -->A COLLADA code inclusion. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_effect_code_8h-source.html">FCDEffectCode.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDEffectCode:
30<p><center><img src="class_f_c_d_effect_code.png" usemap="#FCDEffectCode_map" border="0" alt=""></center>
31<map name="FCDEffectCode_map">
32<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,101,80">
33<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,101,24">
34</map>
35<a href="class_f_c_d_effect_code-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
36<tr><td></td></tr>
37<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424">Type</a> { <b>INCLUDE</b>,
39<a class="el" href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424bd1a77e0d6fd232b43bd48113315b248">CODE</a>
40 }</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list of support code inclusion types.  <a href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424">More...</a><br></td></tr>
43<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_code.html#5ba927db410adba1b34e73bd9a3cabe1">FCDEffectCode</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#5ba927db410adba1b34e73bd9a3cabe1"></a><br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_code.html#74f636708ade039da19ef82aea0a14bd">~FCDEffectCode</a> ()</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#74f636708ade039da19ef82aea0a14bd"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_code.html#9e00aa62fc3e509f8aedb04443026871">GetType</a> () const </td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the form of the code inclusion.  <a href="#9e00aa62fc3e509f8aedb04443026871"></a><br></td></tr>
53<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_effect_code.html#ee0f522cea26f2b8414c6c023f15702b">SetType</a> (<a class="el" href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424">Type</a> _type)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the form of the code inclusion.  <a href="#ee0f522cea26f2b8414c6c023f15702b"></a><br></td></tr>
56<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_effect_code.html#1560a802bc8e7302a2ef30d37be3e055">GetSid</a> () const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the sub-id of the code inclusion.  <a href="#1560a802bc8e7302a2ef30d37be3e055"></a><br></td></tr>
59<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_effect_code.html#587da12147838aad6f030e50324c1ec9">SetSid</a> (const string &amp;_sid)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the sub-id of the code inclusion.  <a href="#587da12147838aad6f030e50324c1ec9"></a><br></td></tr>
62<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_effect_code.html#eb303dd3b3ce37a77955fe4a2fa1986f">GetCode</a> () const </td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the inlined code.  <a href="#eb303dd3b3ce37a77955fe4a2fa1986f"></a><br></td></tr>
65<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_effect_code.html#10347e9dc00a809f0203cadd55e9ab64">SetCode</a> (const fstring &amp;_code)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the inlined code.  <a href="#10347e9dc00a809f0203cadd55e9ab64"></a><br></td></tr>
68<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_effect_code.html#201251ceb6b7774c33b4cdd64e78b136">GetFilename</a> () const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the filename of the code file to open.  <a href="#201251ceb6b7774c33b4cdd64e78b136"></a><br></td></tr>
71<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_effect_code.html#24505787b2431902f598c6454105b737">SetFilename</a> (const fstring &amp;_filename)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the filename of the code file.  <a href="#24505787b2431902f598c6454105b737"></a><br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_code.html#3640488eb67d30fc52f3bbbc6e72674c">Clone</a> () const </td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Clones the code inclusion.  <a href="#3640488eb67d30fc52f3bbbc6e72674c"></a><br></td></tr>
77<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_effect_code.html#6f5768891e2bb8ac07e7dc7ff1ae8af3">LoadFromXML</a> (xmlNode *codeNode)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the code inclusion from a given COLLADA XML tree node.  <a href="#6f5768891e2bb8ac07e7dc7ff1ae8af3"></a><br></td></tr>
80<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_effect_code.html#fce8f5727c9b55b930057c1ef0d1251b">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the code inclusion to the given COLLADA XML tree node.  <a href="#fce8f5727c9b55b930057c1ef0d1251b"></a><br></td></tr>
83</table>
84<hr><a name="_details"></a><h2>Detailed Description</h2>
85A COLLADA code inclusion.
86<p>
87Code inclusions come in two forms: file includes and inline code. For file includes, you will want to grab the filename of the file using the GetFilename function and for inline code, you can get the code directly through the GetCode function.<p>
88Code inclusions are referenced through sub-ids by the effect pass shaders. Regardless of the extension of the filename of file includes, the code inclusions' language is solely determined by the effect profile they belong to.
89<p>
90<hr><h2>Member Enumeration Documentation</h2>
91<a class="anchor" name="0e492088a72daaf6e6e14c50d17c9424"></a><!-- doxytag: member="FCDEffectCode::Type" ref="0e492088a72daaf6e6e14c50d17c9424" args="" --><p>
92<table class="mdTable" cellpadding="2" cellspacing="0">
93  <tr>
94    <td class="mdRow">
95      <table cellpadding="0" cellspacing="0" border="0">
96        <tr>
97          <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424">FCDEffectCode::Type</a>          </td>
98        </tr>
99      </table>
100    </td>
101  </tr>
102</table>
103<table cellspacing="5" cellpadding="0" border="0">
104  <tr>
105    <td>
106      &nbsp;
107    </td>
108    <td>
109
110<p>
111The list of support code inclusion types.
112<p>
113<dl compact><dt><b>Enumerator: </b></dt><dd>
114<table border="0" cellspacing="2" cellpadding="0">
115<tr><td valign="top"><em><a class="anchor" name="0e492088a72daaf6e6e14c50d17c9424bd1a77e0d6fd232b43bd48113315b248"></a><!-- doxytag: member="CODE" ref="0e492088a72daaf6e6e14c50d17c9424bd1a77e0d6fd232b43bd48113315b248" args="" -->CODE</em>&nbsp;</td><td>
116Inlined code.
117<p>
118<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_effect_code.html#eb303dd3b3ce37a77955fe4a2fa1986f">GetCode</a> </dd></dl>
119</td></tr>
120</table>
121</dl>
122    </td>
123  </tr>
124</table>
125<hr><h2>Constructor &amp; Destructor Documentation</h2>
126<a class="anchor" name="5ba927db410adba1b34e73bd9a3cabe1"></a><!-- doxytag: member="FCDEffectCode::FCDEffectCode" ref="5ba927db410adba1b34e73bd9a3cabe1" args="(FCDocument *document)" --><p>
127<table class="mdTable" cellpadding="2" cellspacing="0">
128  <tr>
129    <td class="mdRow">
130      <table cellpadding="0" cellspacing="0" border="0">
131        <tr>
132          <td class="md" nowrap valign="top">FCDEffectCode::FCDEffectCode           </td>
133          <td class="md" valign="top">(&nbsp;</td>
134          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
135          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
136          <td class="md" valign="top">&nbsp;)&nbsp;</td>
137          <td class="md" nowrap></td>
138        </tr>
139      </table>
140    </td>
141  </tr>
142</table>
143<table cellspacing="5" cellpadding="0" border="0">
144  <tr>
145    <td>
146      &nbsp;
147    </td>
148    <td>
149
150<p>
151Constructor: do not use directly.
152<p>
153Instead, use the FCDEffectProfile::AddCode or the <a class="el" href="class_f_c_d_effect_technique.html#6302bc2f9b6d75fc624998369cb83eb1">FCDEffectTechnique::AddCode</a> functions. <dl compact><dt><b>Parameters:</b></dt><dd>
154  <table border="0" cellspacing="2" cellpadding="0">
155    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns this code inclusion. </td></tr>
156  </table>
157</dl>
158    </td>
159  </tr>
160</table>
161<a class="anchor" name="74f636708ade039da19ef82aea0a14bd"></a><!-- doxytag: member="FCDEffectCode::~FCDEffectCode" ref="74f636708ade039da19ef82aea0a14bd" args="()" --><p>
162<table class="mdTable" cellpadding="2" cellspacing="0">
163  <tr>
164    <td class="mdRow">
165      <table cellpadding="0" cellspacing="0" border="0">
166        <tr>
167          <td class="md" nowrap valign="top">FCDEffectCode::~FCDEffectCode           </td>
168          <td class="md" valign="top">(&nbsp;</td>
169          <td class="mdname1" valign="top" nowrap>          </td>
170          <td class="md" valign="top">&nbsp;)&nbsp;</td>
171          <td class="md" nowrap></td>
172        </tr>
173      </table>
174    </td>
175  </tr>
176</table>
177<table cellspacing="5" cellpadding="0" border="0">
178  <tr>
179    <td>
180      &nbsp;
181    </td>
182    <td>
183
184<p>
185Destructor: do not use directly.
186<p>
187Instead, use the FCDEffectProfile::ReleaseCode or the <a class="el" href="class_f_c_d_effect_technique.html#b99a4894d517093cf9e6e9af64ae7cbd">FCDEffectTechnique::ReleaseCode</a> functions.     </td>
188  </tr>
189</table>
190<hr><h2>Member Function Documentation</h2>
191<a class="anchor" name="3640488eb67d30fc52f3bbbc6e72674c"></a><!-- doxytag: member="FCDEffectCode::Clone" ref="3640488eb67d30fc52f3bbbc6e72674c" args="() const " --><p>
192<table class="mdTable" cellpadding="2" cellspacing="0">
193  <tr>
194    <td class="mdRow">
195      <table cellpadding="0" cellspacing="0" border="0">
196        <tr>
197          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* FCDEffectCode::Clone           </td>
198          <td class="md" valign="top">(&nbsp;</td>
199          <td class="mdname1" valign="top" nowrap>          </td>
200          <td class="md" valign="top">&nbsp;)&nbsp;</td>
201          <td class="md" nowrap> const</td>
202        </tr>
203      </table>
204    </td>
205  </tr>
206</table>
207<table cellspacing="5" cellpadding="0" border="0">
208  <tr>
209    <td>
210      &nbsp;
211    </td>
212    <td>
213
214<p>
215[INTERNAL] Clones the code inclusion.
216<p>
217<dl compact><dt><b>Returns:</b></dt><dd>The cloned effect object. You will must delete this pointer. </dd></dl>
218    </td>
219  </tr>
220</table>
221<a class="anchor" name="eb303dd3b3ce37a77955fe4a2fa1986f"></a><!-- doxytag: member="FCDEffectCode::GetCode" ref="eb303dd3b3ce37a77955fe4a2fa1986f" args="() const " --><p>
222<table class="mdTable" cellpadding="2" cellspacing="0">
223  <tr>
224    <td class="mdRow">
225      <table cellpadding="0" cellspacing="0" border="0">
226        <tr>
227          <td class="md" nowrap valign="top">const fstring&amp; FCDEffectCode::GetCode           </td>
228          <td class="md" valign="top">(&nbsp;</td>
229          <td class="mdname1" valign="top" nowrap>          </td>
230          <td class="md" valign="top">&nbsp;)&nbsp;</td>
231          <td class="md" nowrap> const<code> [inline]</code></td>
232        </tr>
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>
245Retrieves the inlined code.
246<p>
247First verify that this code inclusion contains inlined code using the GetType function. <dl compact><dt><b>Returns:</b></dt><dd>The inlined code. </dd></dl>
248    </td>
249  </tr>
250</table>
251<a class="anchor" name="201251ceb6b7774c33b4cdd64e78b136"></a><!-- doxytag: member="FCDEffectCode::GetFilename" ref="201251ceb6b7774c33b4cdd64e78b136" args="() const " --><p>
252<table class="mdTable" cellpadding="2" cellspacing="0">
253  <tr>
254    <td class="mdRow">
255      <table cellpadding="0" cellspacing="0" border="0">
256        <tr>
257          <td class="md" nowrap valign="top">const fstring&amp; FCDEffectCode::GetFilename           </td>
258          <td class="md" valign="top">(&nbsp;</td>
259          <td class="mdname1" valign="top" nowrap>          </td>
260          <td class="md" valign="top">&nbsp;)&nbsp;</td>
261          <td class="md" nowrap> const<code> [inline]</code></td>
262        </tr>
263      </table>
264    </td>
265  </tr>
266</table>
267<table cellspacing="5" cellpadding="0" border="0">
268  <tr>
269    <td>
270      &nbsp;
271    </td>
272    <td>
273
274<p>
275Retrieves the filename of the code file to open.
276<p>
277First verify that this code inclusion contains a filename using the GetType function. <dl compact><dt><b>Returns:</b></dt><dd>The code filename. </dd></dl>
278    </td>
279  </tr>
280</table>
281<a class="anchor" name="1560a802bc8e7302a2ef30d37be3e055"></a><!-- doxytag: member="FCDEffectCode::GetSid" ref="1560a802bc8e7302a2ef30d37be3e055" args="() const " --><p>
282<table class="mdTable" cellpadding="2" cellspacing="0">
283  <tr>
284    <td class="mdRow">
285      <table cellpadding="0" cellspacing="0" border="0">
286        <tr>
287          <td class="md" nowrap valign="top">const string&amp; FCDEffectCode::GetSid           </td>
288          <td class="md" valign="top">(&nbsp;</td>
289          <td class="mdname1" valign="top" nowrap>          </td>
290          <td class="md" valign="top">&nbsp;)&nbsp;</td>
291          <td class="md" nowrap> const<code> [inline]</code></td>
292        </tr>
293      </table>
294    </td>
295  </tr>
296</table>
297<table cellspacing="5" cellpadding="0" border="0">
298  <tr>
299    <td>
300      &nbsp;
301    </td>
302    <td>
303
304<p>
305Retrieves the sub-id of the code inclusion.
306<p>
307Used to match the code inclusion within the effect pass shaders. <dl compact><dt><b>Returns:</b></dt><dd>The sub-id. </dd></dl>
308    </td>
309  </tr>
310</table>
311<a class="anchor" name="9e00aa62fc3e509f8aedb04443026871"></a><!-- doxytag: member="FCDEffectCode::GetType" ref="9e00aa62fc3e509f8aedb04443026871" args="() const " --><p>
312<table class="mdTable" cellpadding="2" cellspacing="0">
313  <tr>
314    <td class="mdRow">
315      <table cellpadding="0" cellspacing="0" border="0">
316        <tr>
317          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424">Type</a> FCDEffectCode::GetType           </td>
318          <td class="md" valign="top">(&nbsp;</td>
319          <td class="mdname1" valign="top" nowrap>          </td>
320          <td class="md" valign="top">&nbsp;)&nbsp;</td>
321          <td class="md" nowrap> const<code> [inline]</code></td>
322        </tr>
323      </table>
324    </td>
325  </tr>
326</table>
327<table cellspacing="5" cellpadding="0" border="0">
328  <tr>
329    <td>
330      &nbsp;
331    </td>
332    <td>
333
334<p>
335Retrieves the form of the code inclusion.
336<p>
337<dl compact><dt><b>Returns:</b></dt><dd>The form. </dd></dl>
338    </td>
339  </tr>
340</table>
341<a class="anchor" name="6f5768891e2bb8ac07e7dc7ff1ae8af3"></a><!-- doxytag: member="FCDEffectCode::LoadFromXML" ref="6f5768891e2bb8ac07e7dc7ff1ae8af3" args="(xmlNode *codeNode)" --><p>
342<table class="mdTable" cellpadding="2" cellspacing="0">
343  <tr>
344    <td class="mdRow">
345      <table cellpadding="0" cellspacing="0" border="0">
346        <tr>
347          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectCode::LoadFromXML           </td>
348          <td class="md" valign="top">(&nbsp;</td>
349          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
350          <td class="mdname1" valign="top" nowrap> <em>codeNode</em>          </td>
351          <td class="md" valign="top">&nbsp;)&nbsp;</td>
352          <td class="md" nowrap></td>
353        </tr>
354      </table>
355    </td>
356  </tr>
357</table>
358<table cellspacing="5" cellpadding="0" border="0">
359  <tr>
360    <td>
361      &nbsp;
362    </td>
363    <td>
364
365<p>
366[INTERNAL] Reads in the code inclusion from a given COLLADA XML tree node.
367<p>
368Code inclusions cover the &lt;code&gt; element and the &lt;include&gt; element. <dl compact><dt><b>Parameters:</b></dt><dd>
369  <table border="0" cellspacing="2" cellpadding="0">
370    <tr><td valign="top"></td><td valign="top"><em>codeNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
371  </table>
372</dl>
373<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 code inclusion. </dd></dl>
374    </td>
375  </tr>
376</table>
377<a class="anchor" name="10347e9dc00a809f0203cadd55e9ab64"></a><!-- doxytag: member="FCDEffectCode::SetCode" ref="10347e9dc00a809f0203cadd55e9ab64" args="(const fstring &amp;_code)" --><p>
378<table class="mdTable" cellpadding="2" cellspacing="0">
379  <tr>
380    <td class="mdRow">
381      <table cellpadding="0" cellspacing="0" border="0">
382        <tr>
383          <td class="md" nowrap valign="top">void FCDEffectCode::SetCode           </td>
384          <td class="md" valign="top">(&nbsp;</td>
385          <td class="md" nowrap valign="top">const fstring &amp;&nbsp;</td>
386          <td class="mdname1" valign="top" nowrap> <em>_code</em>          </td>
387          <td class="md" valign="top">&nbsp;)&nbsp;</td>
388          <td class="md" nowrap><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>
402Sets the inlined code.
403<p>
404As a side-effect, calling this function forces the type of the code inclusion. <dl compact><dt><b>Parameters:</b></dt><dd>
405  <table border="0" cellspacing="2" cellpadding="0">
406    <tr><td valign="top"></td><td valign="top"><em>_code</em>&nbsp;</td><td>The inlined code. </td></tr>
407  </table>
408</dl>
409    </td>
410  </tr>
411</table>
412<a class="anchor" name="24505787b2431902f598c6454105b737"></a><!-- doxytag: member="FCDEffectCode::SetFilename" ref="24505787b2431902f598c6454105b737" args="(const fstring &amp;_filename)" --><p>
413<table class="mdTable" cellpadding="2" cellspacing="0">
414  <tr>
415    <td class="mdRow">
416      <table cellpadding="0" cellspacing="0" border="0">
417        <tr>
418          <td class="md" nowrap valign="top">void FCDEffectCode::SetFilename           </td>
419          <td class="md" valign="top">(&nbsp;</td>
420          <td class="md" nowrap valign="top">const fstring &amp;&nbsp;</td>
421          <td class="mdname1" valign="top" nowrap> <em>_filename</em>          </td>
422          <td class="md" valign="top">&nbsp;)&nbsp;</td>
423          <td class="md" nowrap><code> [inline]</code></td>
424        </tr>
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>
437Sets the filename of the code file.
438<p>
439As a side-effect, calling this function forces the type of the code inclusion. <dl compact><dt><b>Parameters:</b></dt><dd>
440  <table border="0" cellspacing="2" cellpadding="0">
441    <tr><td valign="top"></td><td valign="top"><em>_filename</em>&nbsp;</td><td>The code filename. </td></tr>
442  </table>
443</dl>
444    </td>
445  </tr>
446</table>
447<a class="anchor" name="587da12147838aad6f030e50324c1ec9"></a><!-- doxytag: member="FCDEffectCode::SetSid" ref="587da12147838aad6f030e50324c1ec9" args="(const string &amp;_sid)" --><p>
448<table class="mdTable" cellpadding="2" cellspacing="0">
449  <tr>
450    <td class="mdRow">
451      <table cellpadding="0" cellspacing="0" border="0">
452        <tr>
453          <td class="md" nowrap valign="top">void FCDEffectCode::SetSid           </td>
454          <td class="md" valign="top">(&nbsp;</td>
455          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
456          <td class="mdname1" valign="top" nowrap> <em>_sid</em>          </td>
457          <td class="md" valign="top">&nbsp;)&nbsp;</td>
458          <td class="md" nowrap><code> [inline]</code></td>
459        </tr>
460      </table>
461    </td>
462  </tr>
463</table>
464<table cellspacing="5" cellpadding="0" border="0">
465  <tr>
466    <td>
467      &nbsp;
468    </td>
469    <td>
470
471<p>
472Sets the sub-id of the code inclusion.
473<p>
474This value may change on export, as the sub-id must be unique within its scope. <dl compact><dt><b>Parameters:</b></dt><dd>
475  <table border="0" cellspacing="2" cellpadding="0">
476    <tr><td valign="top"></td><td valign="top"><em>_sid</em>&nbsp;</td><td>The sub-id. </td></tr>
477  </table>
478</dl>
479    </td>
480  </tr>
481</table>
482<a class="anchor" name="ee0f522cea26f2b8414c6c023f15702b"></a><!-- doxytag: member="FCDEffectCode::SetType" ref="ee0f522cea26f2b8414c6c023f15702b" args="(Type _type)" --><p>
483<table class="mdTable" cellpadding="2" cellspacing="0">
484  <tr>
485    <td class="mdRow">
486      <table cellpadding="0" cellspacing="0" border="0">
487        <tr>
488          <td class="md" nowrap valign="top">void FCDEffectCode::SetType           </td>
489          <td class="md" valign="top">(&nbsp;</td>
490          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_code.html#0e492088a72daaf6e6e14c50d17c9424">Type</a>&nbsp;</td>
491          <td class="mdname1" valign="top" nowrap> <em>_type</em>          </td>
492          <td class="md" valign="top">&nbsp;)&nbsp;</td>
493          <td class="md" nowrap><code> [inline]</code></td>
494        </tr>
495      </table>
496    </td>
497  </tr>
498</table>
499<table cellspacing="5" cellpadding="0" border="0">
500  <tr>
501    <td>
502      &nbsp;
503    </td>
504    <td>
505
506<p>
507Sets the form of the code inclusion.
508<p>
509Changing the form of the code inclusion will not remove the inline code or the filename. <dl compact><dt><b>Parameters:</b></dt><dd>
510  <table border="0" cellspacing="2" cellpadding="0">
511    <tr><td valign="top"></td><td valign="top"><em>_type</em>&nbsp;</td><td>The form. </td></tr>
512  </table>
513</dl>
514    </td>
515  </tr>
516</table>
517<a class="anchor" name="fce8f5727c9b55b930057c1ef0d1251b"></a><!-- doxytag: member="FCDEffectCode::WriteToXML" ref="fce8f5727c9b55b930057c1ef0d1251b" args="(xmlNode *parentNode) const " --><p>
518<table class="mdTable" cellpadding="2" cellspacing="0">
519  <tr>
520    <td class="mdRow">
521      <table cellpadding="0" cellspacing="0" border="0">
522        <tr>
523          <td class="md" nowrap valign="top">xmlNode* FCDEffectCode::WriteToXML           </td>
524          <td class="md" valign="top">(&nbsp;</td>
525          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
526          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
527          <td class="md" valign="top">&nbsp;)&nbsp;</td>
528          <td class="md" nowrap> const</td>
529        </tr>
530      </table>
531    </td>
532  </tr>
533</table>
534<table cellspacing="5" cellpadding="0" border="0">
535  <tr>
536    <td>
537      &nbsp;
538    </td>
539    <td>
540
541<p>
542[INTERNAL] Writes out the code inclusion to the given COLLADA XML tree node.
543<p>
544<dl compact><dt><b>Parameters:</b></dt><dd>
545  <table border="0" cellspacing="2" cellpadding="0">
546    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the code inclusion. </td></tr>
547  </table>
548</dl>
549<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
550    </td>
551  </tr>
552</table>
553<hr>The documentation for this class was generated from the following file:<ul>
554<li>FCDocument/<a class="el" href="_f_c_d_effect_code_8h-source.html">FCDEffectCode.h</a></ul>
555<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
556<a href="http://www.doxygen.org/index.html">
557<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
558</body>
559</html>
Note: See TracBrowser for help on using the repository browser.