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

Revision 964, 29.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: FCDEffectProfile 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>FCDEffectProfile Class Reference<br>
25<small>
26[<a class="el" href="group___f_c_d_effect.html">COLLADA Effect Classes [ColladaFX]</a>]</small>
27</h1><!-- doxytag: class="FCDEffectProfile" --><!-- doxytag: inherits="FCDObject" -->The base for a COLLADA effect profile. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_effect_profile_8h-source.html">FCDEffectProfile.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDEffectProfile:
33<p><center><img src="class_f_c_d_effect_profile.png" usemap="#FCDEffectProfile_map" border="0" alt=""></center>
34<map name="FCDEffectProfile_map">
35<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="67,56,192,80">
36<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="67,0,192,24">
37<area href="class_f_c_d_effect_profile_f_x.html" alt="FCDEffectProfileFX" shape="rect" coords="0,168,125,192">
38<area href="class_f_c_d_effect_standard.html" alt="FCDEffectStandard" shape="rect" coords="135,168,260,192">
39</map>
40<a href="class_f_c_d_effect_profile-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
41<tr><td></td></tr>
42<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43<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_profile.html#9556428303b69f40a009c72de9b22cc9">FCDEffectProfile</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *parent)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#9556428303b69f40a009c72de9b22cc9"></a><br></td></tr>
46<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_effect_profile.html#6c49b0e35f802b3f48dcc1bba8ed3b86">~FCDEffectProfile</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#6c49b0e35f802b3f48dcc1bba8ed3b86"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#48ae9db50d8cce2509d6a3d557a1b0a6">GetType</a> () const =0</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the profile type for this effect.  <a href="#48ae9db50d8cce2509d6a3d557a1b0a6"></a><br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#806741463f02e52835fcb6be20865513">GetParent</a> ()</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parent effect.  <a href="#806741463f02e52835fcb6be20865513"></a><br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b25cac5a4ca182eb96cac13b0044a77d"></a><!-- doxytag: member="FCDEffectProfile::GetParent" ref="b25cac5a4ca182eb96cac13b0044a77d" args="() const " -->
56const <a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#b25cac5a4ca182eb96cac13b0044a77d">GetParent</a> () const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
59<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_profile.html#b352c367eb32aef4db78a18cbedf5431">GetDaeId</a> () const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves the COLLADA id of the parent effect.  <a href="#b352c367eb32aef4db78a18cbedf5431"></a><br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#80060db98664b45c675c8b3ed4ddefa6">FindParameterBySemantic</a> (const string &amp;semantic)=0</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an effect parameter.  <a href="#80060db98664b45c675c8b3ed4ddefa6"></a><br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#40c1df098809fcee13ae8d690bb94be5">FindParametersBySemantic</a> (const string &amp;semantic, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;parameters)=0</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of the effect parameter list.  <a href="#40c1df098809fcee13ae8d690bb94be5"></a><br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#5460c340e4babf1d4adcd40f25267c85">FindParametersByReference</a> (const string &amp;reference, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;parameters)=0</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of the effect parameter list.  <a href="#5460c340e4babf1d4adcd40f25267c85"></a><br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#4f67ad9c31e8a1200100f5bb3b8b16c5">Clone</a> (<a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *newParent)=0</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Clones the profile effect and its parameters.  <a href="#4f67ad9c31e8a1200100f5bb3b8b16c5"></a><br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#e471a749ca530845863c47b353a8d592">Flatten</a> ()=0</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Flattens this effect profile, pushing all the effect parameter overrides into the effect parameter generators and moving all the parameters to the effect technique level of abstraction.  <a href="#e471a749ca530845863c47b353a8d592"></a><br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <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_profile.html#d61377cf739a43c111cf205317c4d64b">LoadFromXML</a> (xmlNode *profileNode)=0</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the effect profile from a given COLLADA XML tree node.  <a href="#d61377cf739a43c111cf205317c4d64b"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile.html#8195790d32e7dd4c430e05d7de1d6bed">WriteToXML</a> (xmlNode *parentNode) const =0</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the effect profile to the given COLLADA XML tree node.  <a href="#8195790d32e7dd4c430e05d7de1d6bed"></a><br></td></tr>
83</table>
84<hr><a name="_details"></a><h2>Detailed Description</h2>
85The base for a COLLADA effect profile.
86<p>
87COLLADA has multiple effect profiles: CG, HLSL, GLSL, GLES and the COMMON profile. For each profile, there is a class which implements this abstract class. This abstract class solely holds the parent effect and allows access to the profile type.<p>
88<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_effect_profile_f_x.html">FCDEffectProfileFX</a> <a class="el" href="class_f_c_d_effect_standard.html">FCDEffectStandard</a> </dd></dl>
89
90<p>
91<hr><h2>Constructor &amp; Destructor Documentation</h2>
92<a class="anchor" name="9556428303b69f40a009c72de9b22cc9"></a><!-- doxytag: member="FCDEffectProfile::FCDEffectProfile" ref="9556428303b69f40a009c72de9b22cc9" args="(FCDocument *document, FCDEffect *parent)" --><p>
93<table class="mdTable" cellpadding="2" cellspacing="0">
94  <tr>
95    <td class="mdRow">
96      <table cellpadding="0" cellspacing="0" border="0">
97        <tr>
98          <td class="md" nowrap valign="top">FCDEffectProfile::FCDEffectProfile           </td>
99          <td class="md" valign="top">(&nbsp;</td>
100          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
101          <td class="mdname" nowrap> <em>document</em>, </td>
102        </tr>
103        <tr>
104          <td class="md" nowrap align="right"></td>
105          <td class="md"></td>
106          <td class="md" nowrap><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td>
107          <td class="mdname" nowrap> <em>parent</em></td>
108        </tr>
109        <tr>
110          <td class="md"></td>
111          <td class="md">)&nbsp;</td>
112          <td class="md" colspan="2"></td>
113        </tr>
114      </table>
115    </td>
116  </tr>
117</table>
118<table cellspacing="5" cellpadding="0" border="0">
119  <tr>
120    <td>
121      &nbsp;
122    </td>
123    <td>
124
125<p>
126Constructor: do not use directly.
127<p>
128Instead, use the <a class="el" href="class_f_c_d_effect.html#96b936f744a0f3177f3b1e576d226d94">FCDEffect::AddProfile</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
129  <table border="0" cellspacing="2" cellpadding="0">
130    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns this effect profile. </td></tr>
131    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The effect which contains this profile. </td></tr>
132  </table>
133</dl>
134    </td>
135  </tr>
136</table>
137<a class="anchor" name="6c49b0e35f802b3f48dcc1bba8ed3b86"></a><!-- doxytag: member="FCDEffectProfile::~FCDEffectProfile" ref="6c49b0e35f802b3f48dcc1bba8ed3b86" args="()" --><p>
138<table class="mdTable" 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">virtual FCDEffectProfile::~FCDEffectProfile           </td>
144          <td class="md" valign="top">(&nbsp;</td>
145          <td class="mdname1" valign="top" nowrap>          </td>
146          <td class="md" valign="top">&nbsp;)&nbsp;</td>
147          <td class="md" nowrap><code> [virtual]</code></td>
148        </tr>
149      </table>
150    </td>
151  </tr>
152</table>
153<table cellspacing="5" cellpadding="0" border="0">
154  <tr>
155    <td>
156      &nbsp;
157    </td>
158    <td>
159
160<p>
161Destructor: do not use directly.
162<p>
163Instead, use the <a class="el" href="class_f_c_d_effect.html#d9b1a857e799fffcb80bc62c9dc6f825">FCDEffect::ReleaseProfile</a> function.     </td>
164  </tr>
165</table>
166<hr><h2>Member Function Documentation</h2>
167<a class="anchor" name="4f67ad9c31e8a1200100f5bb3b8b16c5"></a><!-- doxytag: member="FCDEffectProfile::Clone" ref="4f67ad9c31e8a1200100f5bb3b8b16c5" args="(FCDEffect *newParent)=0" --><p>
168<table class="mdTable" cellpadding="2" cellspacing="0">
169  <tr>
170    <td class="mdRow">
171      <table cellpadding="0" cellspacing="0" border="0">
172        <tr>
173          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FCDEffectProfile::Clone           </td>
174          <td class="md" valign="top">(&nbsp;</td>
175          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td>
176          <td class="mdname1" valign="top" nowrap> <em>newParent</em>          </td>
177          <td class="md" valign="top">&nbsp;)&nbsp;</td>
178          <td class="md" nowrap><code> [pure virtual]</code></td>
179        </tr>
180      </table>
181    </td>
182  </tr>
183</table>
184<table cellspacing="5" cellpadding="0" border="0">
185  <tr>
186    <td>
187      &nbsp;
188    </td>
189    <td>
190
191<p>
192[INTERNAL] Clones the profile effect and its parameters.
193<p>
194<dl compact><dt><b>Parameters:</b></dt><dd>
195  <table border="0" cellspacing="2" cellpadding="0">
196    <tr><td valign="top"></td><td valign="top"><em>newParent</em>&nbsp;</td><td>The effect that will contain the cloned profile. </td></tr>
197  </table>
198</dl>
199<dl compact><dt><b>Returns:</b></dt><dd>The cloned profile. This pointer will never be NULL. </dd></dl>
200
201<p>
202Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#83296d2af4fa645cf0e0a64a6bdfb6fb">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#198590df0bf184ba4b736b61c4742751">FCDEffectStandard</a>.    </td>
203  </tr>
204</table>
205<a class="anchor" name="80060db98664b45c675c8b3ed4ddefa6"></a><!-- doxytag: member="FCDEffectProfile::FindParameterBySemantic" ref="80060db98664b45c675c8b3ed4ddefa6" args="(const string &amp;semantic)=0" --><p>
206<table class="mdTable" cellpadding="2" cellspacing="0">
207  <tr>
208    <td class="mdRow">
209      <table cellpadding="0" cellspacing="0" border="0">
210        <tr>
211          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectProfile::FindParameterBySemantic           </td>
212          <td class="md" valign="top">(&nbsp;</td>
213          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
214          <td class="mdname1" valign="top" nowrap> <em>semantic</em>          </td>
215          <td class="md" valign="top">&nbsp;)&nbsp;</td>
216          <td class="md" nowrap><code> [pure virtual]</code></td>
217        </tr>
218      </table>
219    </td>
220  </tr>
221</table>
222<table cellspacing="5" cellpadding="0" border="0">
223  <tr>
224    <td>
225      &nbsp;
226    </td>
227    <td>
228
229<p>
230Retrieves an effect parameter.
231<p>
232Looks for the effect parameter with the correct semantic, in order to bind or override its value. This function searches through the effect profile and the level of abstractions below. <dl compact><dt><b>Parameters:</b></dt><dd>
233  <table border="0" cellspacing="2" cellpadding="0">
234    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>The effect parameter semantic to match. </td></tr>
235  </table>
236</dl>
237<dl compact><dt><b>Returns:</b></dt><dd>The effect parameter that matches the semantic. This pointer will be NULL if no effect parameter matches the given semantic. </dd></dl>
238
239<p>
240Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#ce1250c256d851099997dc733854a05a">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#32c8cc5e278e3a261f67bf4e90faaf6c">FCDEffectStandard</a>.    </td>
241  </tr>
242</table>
243<a class="anchor" name="5460c340e4babf1d4adcd40f25267c85"></a><!-- doxytag: member="FCDEffectProfile::FindParametersByReference" ref="5460c340e4babf1d4adcd40f25267c85" args="(const string &amp;reference, FCDEffectParameterList &amp;parameters)=0" --><p>
244<table class="mdTable" cellpadding="2" cellspacing="0">
245  <tr>
246    <td class="mdRow">
247      <table cellpadding="0" cellspacing="0" border="0">
248        <tr>
249          <td class="md" nowrap valign="top">virtual void FCDEffectProfile::FindParametersByReference           </td>
250          <td class="md" valign="top">(&nbsp;</td>
251          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
252          <td class="mdname" nowrap> <em>reference</em>, </td>
253        </tr>
254        <tr>
255          <td class="md" nowrap align="right"></td>
256          <td class="md"></td>
257          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
258          <td class="mdname" nowrap> <em>parameters</em></td>
259        </tr>
260        <tr>
261          <td class="md"></td>
262          <td class="md">)&nbsp;</td>
263          <td class="md" colspan="2"><code> [pure virtual]</code></td>
264        </tr>
265      </table>
266    </td>
267  </tr>
268</table>
269<table cellspacing="5" cellpadding="0" border="0">
270  <tr>
271    <td>
272      &nbsp;
273    </td>
274    <td>
275
276<p>
277Retrieves a subset of the effect parameter list.
278<p>
279Look for effect parameters with the correct reference. This function searches through the effect profile and the level of abstractions below. <dl compact><dt><b>Parameters:</b></dt><dd>
280  <table border="0" cellspacing="2" cellpadding="0">
281    <tr><td valign="top"></td><td valign="top"><em>reference</em>&nbsp;</td><td>The effect parameter reference to match. In the case of effect parameter generators, the reference is replaced by the sub-id. </td></tr>
282    <tr><td valign="top"></td><td valign="top"><em>parameters</em>&nbsp;</td><td>The list of parameters to fill in. This list is not cleared. </td></tr>
283  </table>
284</dl>
285
286<p>
287Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#5fcde2c4a91c069ff4195203536cc8d3">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#8b53d4810dece9fb20daefa5fc2b94db">FCDEffectStandard</a>.    </td>
288  </tr>
289</table>
290<a class="anchor" name="40c1df098809fcee13ae8d690bb94be5"></a><!-- doxytag: member="FCDEffectProfile::FindParametersBySemantic" ref="40c1df098809fcee13ae8d690bb94be5" args="(const string &amp;semantic, FCDEffectParameterList &amp;parameters)=0" --><p>
291<table class="mdTable" cellpadding="2" cellspacing="0">
292  <tr>
293    <td class="mdRow">
294      <table cellpadding="0" cellspacing="0" border="0">
295        <tr>
296          <td class="md" nowrap valign="top">virtual void FCDEffectProfile::FindParametersBySemantic           </td>
297          <td class="md" valign="top">(&nbsp;</td>
298          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
299          <td class="mdname" nowrap> <em>semantic</em>, </td>
300        </tr>
301        <tr>
302          <td class="md" nowrap align="right"></td>
303          <td class="md"></td>
304          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
305          <td class="mdname" nowrap> <em>parameters</em></td>
306        </tr>
307        <tr>
308          <td class="md"></td>
309          <td class="md">)&nbsp;</td>
310          <td class="md" colspan="2"><code> [pure virtual]</code></td>
311        </tr>
312      </table>
313    </td>
314  </tr>
315</table>
316<table cellspacing="5" cellpadding="0" border="0">
317  <tr>
318    <td>
319      &nbsp;
320    </td>
321    <td>
322
323<p>
324Retrieves a subset of the effect parameter list.
325<p>
326Look for effect parameters with the correct semantic. This function searches through the effect profile and the level of abstractions below. <dl compact><dt><b>Parameters:</b></dt><dd>
327  <table border="0" cellspacing="2" cellpadding="0">
328    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>The effect parameter semantic to match. </td></tr>
329    <tr><td valign="top"></td><td valign="top"><em>parameters</em>&nbsp;</td><td>The list of parameters to fill in. This list is not cleared. </td></tr>
330  </table>
331</dl>
332
333<p>
334Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#90c0176724324af054e86948469a1c51">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#3d28e3c2809ff3fce3addbaf73cdb7c8">FCDEffectStandard</a>.    </td>
335  </tr>
336</table>
337<a class="anchor" name="e471a749ca530845863c47b353a8d592"></a><!-- doxytag: member="FCDEffectProfile::Flatten" ref="e471a749ca530845863c47b353a8d592" args="()=0" --><p>
338<table class="mdTable" cellpadding="2" cellspacing="0">
339  <tr>
340    <td class="mdRow">
341      <table cellpadding="0" cellspacing="0" border="0">
342        <tr>
343          <td class="md" nowrap valign="top">virtual void FCDEffectProfile::Flatten           </td>
344          <td class="md" valign="top">(&nbsp;</td>
345          <td class="mdname1" valign="top" nowrap>          </td>
346          <td class="md" valign="top">&nbsp;)&nbsp;</td>
347          <td class="md" nowrap><code> [pure virtual]</code></td>
348        </tr>
349      </table>
350    </td>
351  </tr>
352</table>
353<table cellspacing="5" cellpadding="0" border="0">
354  <tr>
355    <td>
356      &nbsp;
357    </td>
358    <td>
359
360<p>
361[INTERNAL] Flattens this effect profile, pushing all the effect parameter overrides into the effect parameter generators and moving all the parameters to the effect technique level of abstraction.
362<p>
363To flatten the material, use the <a class="el" href="class_f_c_d_material_instance.html#58182994223d2cbc81d90b1dab289239">FCDMaterialInstance::FlattenMaterial</a> function.
364<p>
365Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#285fe885ced798748c664b710d78e777">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#f33e1c4c74c76ecd84292316a2de1365">FCDEffectStandard</a>.    </td>
366  </tr>
367</table>
368<a class="anchor" name="b352c367eb32aef4db78a18cbedf5431"></a><!-- doxytag: member="FCDEffectProfile::GetDaeId" ref="b352c367eb32aef4db78a18cbedf5431" args="() const " --><p>
369<table class="mdTable" cellpadding="2" cellspacing="0">
370  <tr>
371    <td class="mdRow">
372      <table cellpadding="0" cellspacing="0" border="0">
373        <tr>
374          <td class="md" nowrap valign="top">const string&amp; FCDEffectProfile::GetDaeId           </td>
375          <td class="md" valign="top">(&nbsp;</td>
376          <td class="mdname1" valign="top" nowrap>          </td>
377          <td class="md" valign="top">&nbsp;)&nbsp;</td>
378          <td class="md" nowrap> const</td>
379        </tr>
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>
392[INTERNAL] Retrieves the COLLADA id of the parent effect.
393<p>
394This function is useful when reporting errors and warnings. <dl compact><dt><b>Returns:</b></dt><dd>The COLLADA id of the parent effect. </dd></dl>
395    </td>
396  </tr>
397</table>
398<a class="anchor" name="806741463f02e52835fcb6be20865513"></a><!-- doxytag: member="FCDEffectProfile::GetParent" ref="806741463f02e52835fcb6be20865513" args="()" --><p>
399<table class="mdTable" cellpadding="2" cellspacing="0">
400  <tr>
401    <td class="mdRow">
402      <table cellpadding="0" cellspacing="0" border="0">
403        <tr>
404          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a>* FCDEffectProfile::GetParent           </td>
405          <td class="md" valign="top">(&nbsp;</td>
406          <td class="mdname1" valign="top" nowrap>          </td>
407          <td class="md" valign="top">&nbsp;)&nbsp;</td>
408          <td class="md" nowrap><code> [inline]</code></td>
409        </tr>
410      </table>
411    </td>
412  </tr>
413</table>
414<table cellspacing="5" cellpadding="0" border="0">
415  <tr>
416    <td>
417      &nbsp;
418    </td>
419    <td>
420
421<p>
422Retrieves the parent effect.
423<p>
424This is the effect which contains this profile. <dl compact><dt><b>Returns:</b></dt><dd>The parent effect. This pointer will never be NULL. </dd></dl>
425    </td>
426  </tr>
427</table>
428<a class="anchor" name="48ae9db50d8cce2509d6a3d557a1b0a6"></a><!-- doxytag: member="FCDEffectProfile::GetType" ref="48ae9db50d8cce2509d6a3d557a1b0a6" args="() const =0" --><p>
429<table class="mdTable" cellpadding="2" cellspacing="0">
430  <tr>
431    <td class="mdRow">
432      <table cellpadding="0" cellspacing="0" border="0">
433        <tr>
434          <td class="md" nowrap valign="top">virtual <a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> FCDEffectProfile::GetType           </td>
435          <td class="md" valign="top">(&nbsp;</td>
436          <td class="mdname1" valign="top" nowrap>          </td>
437          <td class="md" valign="top">&nbsp;)&nbsp;</td>
438          <td class="md" nowrap> const<code> [pure virtual]</code></td>
439        </tr>
440      </table>
441    </td>
442  </tr>
443</table>
444<table cellspacing="5" cellpadding="0" border="0">
445  <tr>
446    <td>
447      &nbsp;
448    </td>
449    <td>
450
451<p>
452Retrieves the profile type for this effect.
453<p>
454This function allows you to up-cast the pointer safely to a more specific effect profile class. <dl compact><dt><b>Returns:</b></dt><dd>The profile type. </dd></dl>
455
456<p>
457Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#711f7094d3d2ae864f336a4db558c3c5">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#5870dbcf350bd3f15781cf9ccf1095f9">FCDEffectStandard</a>.    </td>
458  </tr>
459</table>
460<a class="anchor" name="d61377cf739a43c111cf205317c4d64b"></a><!-- doxytag: member="FCDEffectProfile::LoadFromXML" ref="d61377cf739a43c111cf205317c4d64b" args="(xmlNode *profileNode)=0" --><p>
461<table class="mdTable" cellpadding="2" cellspacing="0">
462  <tr>
463    <td class="mdRow">
464      <table cellpadding="0" cellspacing="0" border="0">
465        <tr>
466          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectProfile::LoadFromXML           </td>
467          <td class="md" valign="top">(&nbsp;</td>
468          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
469          <td class="mdname1" valign="top" nowrap> <em>profileNode</em>          </td>
470          <td class="md" valign="top">&nbsp;)&nbsp;</td>
471          <td class="md" nowrap><code> [pure virtual]</code></td>
472        </tr>
473      </table>
474    </td>
475  </tr>
476</table>
477<table cellspacing="5" cellpadding="0" border="0">
478  <tr>
479    <td>
480      &nbsp;
481    </td>
482    <td>
483
484<p>
485[INTERNAL] Reads in the effect profile from a given COLLADA XML tree node.
486<p>
487<dl compact><dt><b>Parameters:</b></dt><dd>
488  <table border="0" cellspacing="2" cellpadding="0">
489    <tr><td valign="top"></td><td valign="top"><em>profileNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
490  </table>
491</dl>
492<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 effect profile. </dd></dl>
493
494<p>
495Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#4397461d46443ad2ee95a9467c93a309">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#4ef5e9fe9a4b97357573b5ba3e04b33f">FCDEffectStandard</a>.    </td>
496  </tr>
497</table>
498<a class="anchor" name="8195790d32e7dd4c430e05d7de1d6bed"></a><!-- doxytag: member="FCDEffectProfile::WriteToXML" ref="8195790d32e7dd4c430e05d7de1d6bed" args="(xmlNode *parentNode) const =0" --><p>
499<table class="mdTable" cellpadding="2" cellspacing="0">
500  <tr>
501    <td class="mdRow">
502      <table cellpadding="0" cellspacing="0" border="0">
503        <tr>
504          <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectProfile::WriteToXML           </td>
505          <td class="md" valign="top">(&nbsp;</td>
506          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
507          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
508          <td class="md" valign="top">&nbsp;)&nbsp;</td>
509          <td class="md" nowrap> const<code> [pure virtual]</code></td>
510        </tr>
511      </table>
512    </td>
513  </tr>
514</table>
515<table cellspacing="5" cellpadding="0" border="0">
516  <tr>
517    <td>
518      &nbsp;
519    </td>
520    <td>
521
522<p>
523[INTERNAL] Writes out the effect profile to the given COLLADA XML tree node.
524<p>
525<dl compact><dt><b>Parameters:</b></dt><dd>
526  <table border="0" cellspacing="2" cellpadding="0">
527    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the effect profile. </td></tr>
528  </table>
529</dl>
530<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
531
532<p>
533Implemented in <a class="el" href="class_f_c_d_effect_profile_f_x.html#eaa144326bb7ee626f62ebcf50f7f734">FCDEffectProfileFX</a>, and <a class="el" href="class_f_c_d_effect_standard.html#3b05e89e457865decbaea33be444de63">FCDEffectStandard</a>.    </td>
534  </tr>
535</table>
536<hr>The documentation for this class was generated from the following file:<ul>
537<li>FCDocument/<a class="el" href="_f_c_d_effect_profile_8h-source.html">FCDEffectProfile.h</a></ul>
538<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
539<a href="http://www.doxygen.org/index.html">
540<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
541</body>
542</html>
Note: See TracBrowser for help on using the repository browser.