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

Revision 964, 46.1 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: FCDEffect 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>FCDEffect 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="FCDEffect" --><!-- doxytag: inherits="FCDEntity" -->A COLLADA effect. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_effect_8h-source.html">FCDEffect.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDEffect:
33<p><center><img src="class_f_c_d_effect.png" usemap="#FCDEffect_map" border="0" alt=""></center>
34<map name="FCDEffect_map">
35<area href="class_f_c_d_entity.html" alt="FCDEntity" shape="rect" coords="0,168,109,192">
36<area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="0,112,109,136">
37<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,109,80">
38<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,109,24">
39</map>
40<a href="class_f_c_d_effect-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.html#d2e620e6c041da706302e8541344a5e9">FCDEffect</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#d2e620e6c041da706302e8541344a5e9"></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.html#29f18ea13fa396de650641303f2db241">~FCDEffect</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#29f18ea13fa396de650641303f2db241"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#b6106f67f33a4cb049ea17a1970bbfbe">GetType</a> () const </td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type for this entity class.  <a href="#b6106f67f33a4cb049ea17a1970bbfbe"></a><br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#07ca7c378d3ecf158beefe5ba35143ae">GetProfileCount</a> () const </td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of profiles contained within the effect.  <a href="#07ca7c378d3ecf158beefe5ba35143ae"></a><br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><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.html#22c8dc9f098387eaa2ffb6a66aceb22d">GetProfile</a> (size_t index)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a profile contained within the effect.  <a href="#22c8dc9f098387eaa2ffb6a66aceb22d"></a><br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad9b921743685b02b847d30670dc1631"></a><!-- doxytag: member="FCDEffect::GetProfile" ref="ad9b921743685b02b847d30670dc1631" args="(size_t index) const " -->
59const <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.html#ad9b921743685b02b847d30670dc1631">GetProfile</a> (size_t index) const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDEffectProfileList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#c0747106831338b4d29c2218cdc4ea41">GetProfiles</a> ()</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of the profiles contained within the effect.  <a href="#c0747106831338b4d29c2218cdc4ea41"></a><br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce9cfa3581996cfee41b7bdba642bd09"></a><!-- doxytag: member="FCDEffect::GetProfiles" ref="ce9cfa3581996cfee41b7bdba642bd09" args="() const " -->
66const <a class="el" href="classvector.html">FCDEffectProfileList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#ce9cfa3581996cfee41b7bdba642bd09">GetProfiles</a> () const </td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><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.html#110a7d6488fc376b63e3f6ef7166e0c4">FindProfile</a> (<a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the profile for a specific profile type.  <a href="#110a7d6488fc376b63e3f6ef7166e0c4"></a><br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ffa2d8b19da2afd7e9ad5cbdb8e5b00"></a><!-- doxytag: member="FCDEffect::FindProfile" ref="9ffa2d8b19da2afd7e9ad5cbdb8e5b00" args="(FUDaeProfileType::Type type) const " -->
73const <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.html#9ffa2d8b19da2afd7e9ad5cbdb8e5b00">FindProfile</a> (<a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type) const </td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><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.html#18d1c23b4441fe07b5f9c795e18fe9cb">FindProfileByTypeAndPlatform</a> (<a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type, string platform)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the profile for a specific profile type and platform.  <a href="#18d1c23b4441fe07b5f9c795e18fe9cb"></a><br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dfc824c25f20084cbcb685fbc0cf489b"></a><!-- doxytag: member="FCDEffect::FindProfileByTypeAndPlatform" ref="dfc824c25f20084cbcb685fbc0cf489b" args="(FUDaeProfileType::Type type, string platform) const " -->
80const <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.html#dfc824c25f20084cbcb685fbc0cf489b">FindProfileByTypeAndPlatform</a> (<a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type, string platform) const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#0e210e70a9933fc89f314747edbb3bf5">HasProfile</a> (<a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type) const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether the effect contains a profile of the given type.  <a href="#0e210e70a9933fc89f314747edbb3bf5"></a><br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><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.html#96b936f744a0f3177f3b1e576d226d94">AddProfile</a> (<a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a profile of the given type.  <a href="#96b936f744a0f3177f3b1e576d226d94"></a><br></td></tr>
89<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.html#d9b1a857e799fffcb80bc62c9dc6f825">ReleaseProfile</a> (<a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a> *profile)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases the given effect profile.  <a href="#d9b1a857e799fffcb80bc62c9dc6f825"></a><br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#d2697612710ba73b740295bbfe9b0460">GetParameters</a> ()</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of common effect parameters declared at the effect level.  <a href="#d2697612710ba73b740295bbfe9b0460"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70eb725ca915b2db107adb655dcf6d2e"></a><!-- doxytag: member="FCDEffect::GetParameters" ref="70eb725ca915b2db107adb655dcf6d2e" args="() const " -->
96const <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#70eb725ca915b2db107adb655dcf6d2e">GetParameters</a> () const </td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
99<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.html#f90851c20ed3afa404292f6779a8713d">AddParameter</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *parameter)</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Inserts an existing parameter into the list of common effect parameters at this abstraction level.  <a href="#f90851c20ed3afa404292f6779a8713d"></a><br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><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.html#4684ab50812aa9173777f458f250e48f">FindParameterBySemantic</a> (const string &amp;semantic)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a common effect parameter.  <a href="#4684ab50812aa9173777f458f250e48f"></a><br></td></tr>
105<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.html#69e3460ba81f348c217b1561bb205dd7">FindParametersBySemantic</a> (const string &amp;semantic, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;parameters)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of the common effect parameter list.  <a href="#69e3460ba81f348c217b1561bb205dd7"></a><br></td></tr>
108<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.html#8dbc63d14bb38979919ed8a2583c6075">FindParametersByReference</a> (const string &amp;reference, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;parameters)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of the common effect parameter list.  <a href="#8dbc63d14bb38979919ed8a2583c6075"></a><br></td></tr>
111<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.html#43f75aa786cb33ab3410767afc0cbe8c">Clone</a> ()</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clones the effect object.  <a href="#43f75aa786cb33ab3410767afc0cbe8c"></a><br></td></tr>
114<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.html#3a7faf6a3a51e1dae2c66823d470a07d">Flatten</a> ()</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Flattens the effect, pushing all the common effect parameters into to the effect technique level of abstraction.  <a href="#3a7faf6a3a51e1dae2c66823d470a07d"></a><br></td></tr>
117<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.html#f7724b736d7d2fff3a3d94e16accf030">LoadFromXML</a> (xmlNode *effectNode)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the &lt;effect&gt; element from a given COLLADA XML tree node.  <a href="#f7724b736d7d2fff3a3d94e16accf030"></a><br></td></tr>
120<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.html#ac88481b0ad514d0a5ddeeedaef5aecb">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the &lt;effect&gt; element to the given COLLADA XML tree node.  <a href="#ac88481b0ad514d0a5ddeeedaef5aecb"></a><br></td></tr>
123<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDEffectImageList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#dbd68f8cc11b71dc5555f6cb2e32e612">GetImages</a> ()</td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of the images contained within the effect.  <a href="#dbd68f8cc11b71dc5555f6cb2e32e612"></a><br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f287708997fceaadeda671c1be783f04"></a><!-- doxytag: member="FCDEffect::GetImages" ref="f287708997fceaadeda671c1be783f04" args="() const " -->
127const <a class="el" href="classvector.html">FCDEffectImageList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect.html#f287708997fceaadeda671c1be783f04">GetImages</a> () const </td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
130</table>
131<hr><a name="_details"></a><h2>Detailed Description</h2>
132A COLLADA effect.
133<p>
134A COLLADA effect is one of many abstraction level that defines how to render mesh polygon sets. It contains one or more rendering profile that the application can choose to support. In theory, all the rendering profiles should reach the same render output, using different rendering technologies.<p>
135An effect may also declare new general purpose parameters that are common to all the profiles.
136<p>
137<hr><h2>Constructor &amp; Destructor Documentation</h2>
138<a class="anchor" name="d2e620e6c041da706302e8541344a5e9"></a><!-- doxytag: member="FCDEffect::FCDEffect" ref="d2e620e6c041da706302e8541344a5e9" args="(FCDocument *document)" --><p>
139<table class="mdTable" cellpadding="2" cellspacing="0">
140  <tr>
141    <td class="mdRow">
142      <table cellpadding="0" cellspacing="0" border="0">
143        <tr>
144          <td class="md" nowrap valign="top">FCDEffect::FCDEffect           </td>
145          <td class="md" valign="top">(&nbsp;</td>
146          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
147          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
148          <td class="md" valign="top">&nbsp;)&nbsp;</td>
149          <td class="md" nowrap></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>
163Constructor: do not use directly.
164<p>
165Instead use the <a class="el" href="class_f_c_d_material_library.html#186179dc841f965438e0da5b0971ab90">FCDMaterialLibrary::AddEffect</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
166  <table border="0" cellspacing="2" cellpadding="0">
167    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns this effect. </td></tr>
168  </table>
169</dl>
170    </td>
171  </tr>
172</table>
173<a class="anchor" name="29f18ea13fa396de650641303f2db241"></a><!-- doxytag: member="FCDEffect::~FCDEffect" ref="29f18ea13fa396de650641303f2db241" args="()" --><p>
174<table class="mdTable" cellpadding="2" cellspacing="0">
175  <tr>
176    <td class="mdRow">
177      <table cellpadding="0" cellspacing="0" border="0">
178        <tr>
179          <td class="md" nowrap valign="top">virtual FCDEffect::~FCDEffect           </td>
180          <td class="md" valign="top">(&nbsp;</td>
181          <td class="mdname1" valign="top" nowrap>          </td>
182          <td class="md" valign="top">&nbsp;)&nbsp;</td>
183          <td class="md" nowrap><code> [virtual]</code></td>
184        </tr>
185      </table>
186    </td>
187  </tr>
188</table>
189<table cellspacing="5" cellpadding="0" border="0">
190  <tr>
191    <td>
192      &nbsp;
193    </td>
194    <td>
195
196<p>
197Destructor: do not use directly.
198<p>
199Instead use the <a class="el" href="class_f_c_d_material_library.html#5ee1f0dcc0f4d05890e9609eb79bb6c7">FCDMaterialLibrary::ReleaseEffect</a> function.     </td>
200  </tr>
201</table>
202<hr><h2>Member Function Documentation</h2>
203<a class="anchor" name="f90851c20ed3afa404292f6779a8713d"></a><!-- doxytag: member="FCDEffect::AddParameter" ref="f90851c20ed3afa404292f6779a8713d" args="(FCDEffectParameter *parameter)" --><p>
204<table class="mdTable" cellpadding="2" cellspacing="0">
205  <tr>
206    <td class="mdRow">
207      <table cellpadding="0" cellspacing="0" border="0">
208        <tr>
209          <td class="md" nowrap valign="top">void FCDEffect::AddParameter           </td>
210          <td class="md" valign="top">(&nbsp;</td>
211          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td>
212          <td class="mdname1" valign="top" nowrap> <em>parameter</em>          </td>
213          <td class="md" valign="top">&nbsp;)&nbsp;</td>
214          <td class="md" nowrap></td>
215        </tr>
216      </table>
217    </td>
218  </tr>
219</table>
220<table cellspacing="5" cellpadding="0" border="0">
221  <tr>
222    <td>
223      &nbsp;
224    </td>
225    <td>
226
227<p>
228[INTERNAL] Inserts an existing parameter into the list of common effect parameters at this abstraction level.
229<p>
230This function is used during the flattening of a material. <dl compact><dt><b>Parameters:</b></dt><dd>
231  <table border="0" cellspacing="2" cellpadding="0">
232    <tr><td valign="top"></td><td valign="top"><em>parameter</em>&nbsp;</td><td>The effect parameter to insert. </td></tr>
233  </table>
234</dl>
235    </td>
236  </tr>
237</table>
238<a class="anchor" name="96b936f744a0f3177f3b1e576d226d94"></a><!-- doxytag: member="FCDEffect::AddProfile" ref="96b936f744a0f3177f3b1e576d226d94" args="(FUDaeProfileType::Type type)" --><p>
239<table class="mdTable" cellpadding="2" cellspacing="0">
240  <tr>
241    <td class="mdRow">
242      <table cellpadding="0" cellspacing="0" border="0">
243        <tr>
244          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FCDEffect::AddProfile           </td>
245          <td class="md" valign="top">(&nbsp;</td>
246          <td class="md" nowrap valign="top"><a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a>&nbsp;</td>
247          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
248          <td class="md" valign="top">&nbsp;)&nbsp;</td>
249          <td class="md" nowrap></td>
250        </tr>
251      </table>
252    </td>
253  </tr>
254</table>
255<table cellspacing="5" cellpadding="0" border="0">
256  <tr>
257    <td>
258      &nbsp;
259    </td>
260    <td>
261
262<p>
263Creates a profile of the given type.
264<p>
265If a profile of this type already exists, it will be released, as a COLLADA effect should only contain one profile of each type. <dl compact><dt><b>Parameters:</b></dt><dd>
266  <table border="0" cellspacing="2" cellpadding="0">
267    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The profile type. </td></tr>
268  </table>
269</dl>
270<dl compact><dt><b>Returns:</b></dt><dd>The new effect profile. </dd></dl>
271    </td>
272  </tr>
273</table>
274<a class="anchor" name="43f75aa786cb33ab3410767afc0cbe8c"></a><!-- doxytag: member="FCDEffect::Clone" ref="43f75aa786cb33ab3410767afc0cbe8c" args="()" --><p>
275<table class="mdTable" cellpadding="2" cellspacing="0">
276  <tr>
277    <td class="mdRow">
278      <table cellpadding="0" cellspacing="0" border="0">
279        <tr>
280          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a>* FCDEffect::Clone           </td>
281          <td class="md" valign="top">(&nbsp;</td>
282          <td class="mdname1" valign="top" nowrap>          </td>
283          <td class="md" valign="top">&nbsp;)&nbsp;</td>
284          <td class="md" nowrap></td>
285        </tr>
286      </table>
287    </td>
288  </tr>
289</table>
290<table cellspacing="5" cellpadding="0" border="0">
291  <tr>
292    <td>
293      &nbsp;
294    </td>
295    <td>
296
297<p>
298Clones the effect object.
299<p>
300Everything is cloned, including the effect parameter and their animations. You will need release the cloned effect directly, by deleting the pointer. <dl compact><dt><b>Returns:</b></dt><dd>The cloned effect object. You will must delete this pointer. </dd></dl>
301    </td>
302  </tr>
303</table>
304<a class="anchor" name="4684ab50812aa9173777f458f250e48f"></a><!-- doxytag: member="FCDEffect::FindParameterBySemantic" ref="4684ab50812aa9173777f458f250e48f" args="(const string &amp;semantic)" --><p>
305<table class="mdTable" cellpadding="2" cellspacing="0">
306  <tr>
307    <td class="mdRow">
308      <table cellpadding="0" cellspacing="0" border="0">
309        <tr>
310          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffect::FindParameterBySemantic           </td>
311          <td class="md" valign="top">(&nbsp;</td>
312          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
313          <td class="mdname1" valign="top" nowrap> <em>semantic</em>          </td>
314          <td class="md" valign="top">&nbsp;)&nbsp;</td>
315          <td class="md" nowrap></td>
316        </tr>
317      </table>
318    </td>
319  </tr>
320</table>
321<table cellspacing="5" cellpadding="0" border="0">
322  <tr>
323    <td>
324      &nbsp;
325    </td>
326    <td>
327
328<p>
329Retrieves a common effect parameter.
330<p>
331Looks for the common effect parameter with the correct semantic, in order to bind or override its value. This function searches through the effect and the level of abstractions below. <dl compact><dt><b>Parameters:</b></dt><dd>
332  <table border="0" cellspacing="2" cellpadding="0">
333    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>The effect parameter semantic to match. </td></tr>
334  </table>
335</dl>
336<dl compact><dt><b>Returns:</b></dt><dd>The first effect parameter that matches the semantic. This pointer will be NULL if no effect parameter matches the given semantic. </dd></dl>
337    </td>
338  </tr>
339</table>
340<a class="anchor" name="8dbc63d14bb38979919ed8a2583c6075"></a><!-- doxytag: member="FCDEffect::FindParametersByReference" ref="8dbc63d14bb38979919ed8a2583c6075" args="(const string &amp;reference, FCDEffectParameterList &amp;parameters)" --><p>
341<table class="mdTable" cellpadding="2" cellspacing="0">
342  <tr>
343    <td class="mdRow">
344      <table cellpadding="0" cellspacing="0" border="0">
345        <tr>
346          <td class="md" nowrap valign="top">void FCDEffect::FindParametersByReference           </td>
347          <td class="md" valign="top">(&nbsp;</td>
348          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
349          <td class="mdname" nowrap> <em>reference</em>, </td>
350        </tr>
351        <tr>
352          <td class="md" nowrap align="right"></td>
353          <td class="md"></td>
354          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
355          <td class="mdname" nowrap> <em>parameters</em></td>
356        </tr>
357        <tr>
358          <td class="md"></td>
359          <td class="md">)&nbsp;</td>
360          <td class="md" colspan="2"></td>
361        </tr>
362      </table>
363    </td>
364  </tr>
365</table>
366<table cellspacing="5" cellpadding="0" border="0">
367  <tr>
368    <td>
369      &nbsp;
370    </td>
371    <td>
372
373<p>
374Retrieves a subset of the common effect parameter list.
375<p>
376Look for the effect parameter generators with the correct reference. This function searches through the effect and the level of abstractions below. <dl compact><dt><b>Parameters:</b></dt><dd>
377  <table border="0" cellspacing="2" cellpadding="0">
378    <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>
379    <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>
380  </table>
381</dl>
382    </td>
383  </tr>
384</table>
385<a class="anchor" name="69e3460ba81f348c217b1561bb205dd7"></a><!-- doxytag: member="FCDEffect::FindParametersBySemantic" ref="69e3460ba81f348c217b1561bb205dd7" args="(const string &amp;semantic, FCDEffectParameterList &amp;parameters)" --><p>
386<table class="mdTable" cellpadding="2" cellspacing="0">
387  <tr>
388    <td class="mdRow">
389      <table cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td class="md" nowrap valign="top">void FCDEffect::FindParametersBySemantic           </td>
392          <td class="md" valign="top">(&nbsp;</td>
393          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
394          <td class="mdname" nowrap> <em>semantic</em>, </td>
395        </tr>
396        <tr>
397          <td class="md" nowrap align="right"></td>
398          <td class="md"></td>
399          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
400          <td class="mdname" nowrap> <em>parameters</em></td>
401        </tr>
402        <tr>
403          <td class="md"></td>
404          <td class="md">)&nbsp;</td>
405          <td class="md" colspan="2"></td>
406        </tr>
407      </table>
408    </td>
409  </tr>
410</table>
411<table cellspacing="5" cellpadding="0" border="0">
412  <tr>
413    <td>
414      &nbsp;
415    </td>
416    <td>
417
418<p>
419Retrieves a subset of the common effect parameter list.
420<p>
421Look for the effect parameter generators with the correct semantic. This function searches through the effect and the level of abstractions below. <dl compact><dt><b>Parameters:</b></dt><dd>
422  <table border="0" cellspacing="2" cellpadding="0">
423    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>The effect parameter semantic to match. </td></tr>
424    <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>
425  </table>
426</dl>
427    </td>
428  </tr>
429</table>
430<a class="anchor" name="110a7d6488fc376b63e3f6ef7166e0c4"></a><!-- doxytag: member="FCDEffect::FindProfile" ref="110a7d6488fc376b63e3f6ef7166e0c4" args="(FUDaeProfileType::Type type)" --><p>
431<table class="mdTable" cellpadding="2" cellspacing="0">
432  <tr>
433    <td class="mdRow">
434      <table cellpadding="0" cellspacing="0" border="0">
435        <tr>
436          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FCDEffect::FindProfile           </td>
437          <td class="md" valign="top">(&nbsp;</td>
438          <td class="md" nowrap valign="top"><a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a>&nbsp;</td>
439          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
440          <td class="md" valign="top">&nbsp;)&nbsp;</td>
441          <td class="md" nowrap></td>
442        </tr>
443      </table>
444    </td>
445  </tr>
446</table>
447<table cellspacing="5" cellpadding="0" border="0">
448  <tr>
449    <td>
450      &nbsp;
451    </td>
452    <td>
453
454<p>
455Retrieves the profile for a specific profile type.
456<p>
457There should only be one profile of each type within an effect. This function allows you to retrieve the profile for a given type. <dl compact><dt><b>Parameters:</b></dt><dd>
458  <table border="0" cellspacing="2" cellpadding="0">
459    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The profile type. </td></tr>
460  </table>
461</dl>
462<dl compact><dt><b>Returns:</b></dt><dd>The profile of this type. This pointer will be NULL if the effect does not have any profile of this type. </dd></dl>
463    </td>
464  </tr>
465</table>
466<a class="anchor" name="18d1c23b4441fe07b5f9c795e18fe9cb"></a><!-- doxytag: member="FCDEffect::FindProfileByTypeAndPlatform" ref="18d1c23b4441fe07b5f9c795e18fe9cb" args="(FUDaeProfileType::Type type, string platform)" --><p>
467<table class="mdTable" cellpadding="2" cellspacing="0">
468  <tr>
469    <td class="mdRow">
470      <table cellpadding="0" cellspacing="0" border="0">
471        <tr>
472          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FCDEffect::FindProfileByTypeAndPlatform           </td>
473          <td class="md" valign="top">(&nbsp;</td>
474          <td class="md" nowrap valign="top"><a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a>&nbsp;</td>
475          <td class="mdname" nowrap> <em>type</em>, </td>
476        </tr>
477        <tr>
478          <td class="md" nowrap align="right"></td>
479          <td class="md"></td>
480          <td class="md" nowrap>string&nbsp;</td>
481          <td class="mdname" nowrap> <em>platform</em></td>
482        </tr>
483        <tr>
484          <td class="md"></td>
485          <td class="md">)&nbsp;</td>
486          <td class="md" colspan="2"></td>
487        </tr>
488      </table>
489    </td>
490  </tr>
491</table>
492<table cellspacing="5" cellpadding="0" border="0">
493  <tr>
494    <td>
495      &nbsp;
496    </td>
497    <td>
498
499<p>
500Retrieves the profile for a specific profile type and platform.
501<p>
502There should only be one profile of each type within an effect. This function allows you to retrieve the profile for a given type. <dl compact><dt><b>Parameters:</b></dt><dd>
503  <table border="0" cellspacing="2" cellpadding="0">
504    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The profile type and platform. </td></tr>
505  </table>
506</dl>
507<dl compact><dt><b>Returns:</b></dt><dd>The profile of this type. This pointer will be NULL if the effect does not have any profile of this type. </dd></dl>
508    </td>
509  </tr>
510</table>
511<a class="anchor" name="3a7faf6a3a51e1dae2c66823d470a07d"></a><!-- doxytag: member="FCDEffect::Flatten" ref="3a7faf6a3a51e1dae2c66823d470a07d" args="()" --><p>
512<table class="mdTable" cellpadding="2" cellspacing="0">
513  <tr>
514    <td class="mdRow">
515      <table cellpadding="0" cellspacing="0" border="0">
516        <tr>
517          <td class="md" nowrap valign="top">void FCDEffect::Flatten           </td>
518          <td class="md" valign="top">(&nbsp;</td>
519          <td class="mdname1" valign="top" nowrap>          </td>
520          <td class="md" valign="top">&nbsp;)&nbsp;</td>
521          <td class="md" nowrap></td>
522        </tr>
523      </table>
524    </td>
525  </tr>
526</table>
527<table cellspacing="5" cellpadding="0" border="0">
528  <tr>
529    <td>
530      &nbsp;
531    </td>
532    <td>
533
534<p>
535[INTERNAL] Flattens the effect, pushing all the common effect parameters into to the effect technique level of abstraction.
536<p>
537To correctly flatten a material, use the <a class="el" href="class_f_c_d_material_instance.html#58182994223d2cbc81d90b1dab289239">FCDMaterialInstance::FlattenMaterial</a> function.     </td>
538  </tr>
539</table>
540<a class="anchor" name="dbd68f8cc11b71dc5555f6cb2e32e612"></a><!-- doxytag: member="FCDEffect::GetImages" ref="dbd68f8cc11b71dc5555f6cb2e32e612" args="()" --><p>
541<table class="mdTable" cellpadding="2" cellspacing="0">
542  <tr>
543    <td class="mdRow">
544      <table cellpadding="0" cellspacing="0" border="0">
545        <tr>
546          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDEffectImageList</a>&amp; FCDEffect::GetImages           </td>
547          <td class="md" valign="top">(&nbsp;</td>
548          <td class="mdname1" valign="top" nowrap>          </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>
564Retrieves the list of the images contained within the effect.
565<p>
566<dl compact><dt><b>Returns:</b></dt><dd>The list of effect images. </dd></dl>
567    </td>
568  </tr>
569</table>
570<a class="anchor" name="d2697612710ba73b740295bbfe9b0460"></a><!-- doxytag: member="FCDEffect::GetParameters" ref="d2697612710ba73b740295bbfe9b0460" args="()" --><p>
571<table class="mdTable" cellpadding="2" cellspacing="0">
572  <tr>
573    <td class="mdRow">
574      <table cellpadding="0" cellspacing="0" border="0">
575        <tr>
576          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* FCDEffect::GetParameters           </td>
577          <td class="md" valign="top">(&nbsp;</td>
578          <td class="mdname1" valign="top" nowrap>          </td>
579          <td class="md" valign="top">&nbsp;)&nbsp;</td>
580          <td class="md" nowrap><code> [inline]</code></td>
581        </tr>
582      </table>
583    </td>
584  </tr>
585</table>
586<table cellspacing="5" cellpadding="0" border="0">
587  <tr>
588    <td>
589      &nbsp;
590    </td>
591    <td>
592
593<p>
594Retrieves the list of common effect parameters declared at the effect level.
595<p>
596According to the COLLADA 1.4 schema, you should expect only parameter generators at this abstraction level. <dl compact><dt><b>Returns:</b></dt><dd>The list of effect parameters. </dd></dl>
597    </td>
598  </tr>
599</table>
600<a class="anchor" name="22c8dc9f098387eaa2ffb6a66aceb22d"></a><!-- doxytag: member="FCDEffect::GetProfile" ref="22c8dc9f098387eaa2ffb6a66aceb22d" args="(size_t index)" --><p>
601<table class="mdTable" cellpadding="2" cellspacing="0">
602  <tr>
603    <td class="mdRow">
604      <table cellpadding="0" cellspacing="0" border="0">
605        <tr>
606          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FCDEffect::GetProfile           </td>
607          <td class="md" valign="top">(&nbsp;</td>
608          <td class="md" nowrap valign="top">size_t&nbsp;</td>
609          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
610          <td class="md" valign="top">&nbsp;)&nbsp;</td>
611          <td class="md" nowrap><code> [inline]</code></td>
612        </tr>
613      </table>
614    </td>
615  </tr>
616</table>
617<table cellspacing="5" cellpadding="0" border="0">
618  <tr>
619    <td>
620      &nbsp;
621    </td>
622    <td>
623
624<p>
625Retrieves a profile contained within the effect.
626<p>
627<dl compact><dt><b>Parameters:</b></dt><dd>
628  <table border="0" cellspacing="2" cellpadding="0">
629    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the profile. </td></tr>
630  </table>
631</dl>
632<dl compact><dt><b>Returns:</b></dt><dd>The profile. This pointer will be NULL, if the given index is out-of-bounds. </dd></dl>
633    </td>
634  </tr>
635</table>
636<a class="anchor" name="07ca7c378d3ecf158beefe5ba35143ae"></a><!-- doxytag: member="FCDEffect::GetProfileCount" ref="07ca7c378d3ecf158beefe5ba35143ae" args="() const " --><p>
637<table class="mdTable" cellpadding="2" cellspacing="0">
638  <tr>
639    <td class="mdRow">
640      <table cellpadding="0" cellspacing="0" border="0">
641        <tr>
642          <td class="md" nowrap valign="top">size_t FCDEffect::GetProfileCount           </td>
643          <td class="md" valign="top">(&nbsp;</td>
644          <td class="mdname1" valign="top" nowrap>          </td>
645          <td class="md" valign="top">&nbsp;)&nbsp;</td>
646          <td class="md" nowrap> const<code> [inline]</code></td>
647        </tr>
648      </table>
649    </td>
650  </tr>
651</table>
652<table cellspacing="5" cellpadding="0" border="0">
653  <tr>
654    <td>
655      &nbsp;
656    </td>
657    <td>
658
659<p>
660Retrieves the number of profiles contained within the effect.
661<p>
662<dl compact><dt><b>Returns:</b></dt><dd>The number of profiles within the effect. </dd></dl>
663    </td>
664  </tr>
665</table>
666<a class="anchor" name="c0747106831338b4d29c2218cdc4ea41"></a><!-- doxytag: member="FCDEffect::GetProfiles" ref="c0747106831338b4d29c2218cdc4ea41" args="()" --><p>
667<table class="mdTable" cellpadding="2" cellspacing="0">
668  <tr>
669    <td class="mdRow">
670      <table cellpadding="0" cellspacing="0" border="0">
671        <tr>
672          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDEffectProfileList</a>&amp; FCDEffect::GetProfiles           </td>
673          <td class="md" valign="top">(&nbsp;</td>
674          <td class="mdname1" valign="top" nowrap>          </td>
675          <td class="md" valign="top">&nbsp;)&nbsp;</td>
676          <td class="md" nowrap><code> [inline]</code></td>
677        </tr>
678      </table>
679    </td>
680  </tr>
681</table>
682<table cellspacing="5" cellpadding="0" border="0">
683  <tr>
684    <td>
685      &nbsp;
686    </td>
687    <td>
688
689<p>
690Retrieves the list of the profiles contained within the effect.
691<p>
692<dl compact><dt><b>Returns:</b></dt><dd>The list of effect profiles. </dd></dl>
693    </td>
694  </tr>
695</table>
696<a class="anchor" name="b6106f67f33a4cb049ea17a1970bbfbe"></a><!-- doxytag: member="FCDEffect::GetType" ref="b6106f67f33a4cb049ea17a1970bbfbe" args="() const " --><p>
697<table class="mdTable" cellpadding="2" cellspacing="0">
698  <tr>
699    <td class="mdRow">
700      <table cellpadding="0" cellspacing="0" border="0">
701        <tr>
702          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> FCDEffect::GetType           </td>
703          <td class="md" valign="top">(&nbsp;</td>
704          <td class="mdname1" valign="top" nowrap>          </td>
705          <td class="md" valign="top">&nbsp;)&nbsp;</td>
706          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
707        </tr>
708      </table>
709    </td>
710  </tr>
711</table>
712<table cellspacing="5" cellpadding="0" border="0">
713  <tr>
714    <td>
715      &nbsp;
716    </td>
717    <td>
718
719<p>
720Retrieves the type for this entity class.
721<p>
722This function is a part of the <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> interface. <dl compact><dt><b>Returns:</b></dt><dd>The entity type: EFFECT. </dd></dl>
723
724<p>
725Reimplemented from <a class="el" href="class_f_c_d_entity.html#bfd4312a7124f92364c1e6517c7e60ba">FCDEntity</a>.    </td>
726  </tr>
727</table>
728<a class="anchor" name="0e210e70a9933fc89f314747edbb3bf5"></a><!-- doxytag: member="FCDEffect::HasProfile" ref="0e210e70a9933fc89f314747edbb3bf5" args="(FUDaeProfileType::Type type) const " --><p>
729<table class="mdTable" cellpadding="2" cellspacing="0">
730  <tr>
731    <td class="mdRow">
732      <table cellpadding="0" cellspacing="0" border="0">
733        <tr>
734          <td class="md" nowrap valign="top">bool FCDEffect::HasProfile           </td>
735          <td class="md" valign="top">(&nbsp;</td>
736          <td class="md" nowrap valign="top"><a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a>&nbsp;</td>
737          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
738          <td class="md" valign="top">&nbsp;)&nbsp;</td>
739          <td class="md" nowrap> const<code> [inline]</code></td>
740        </tr>
741      </table>
742    </td>
743  </tr>
744</table>
745<table cellspacing="5" cellpadding="0" border="0">
746  <tr>
747    <td>
748      &nbsp;
749    </td>
750    <td>
751
752<p>
753Retrieves whether the effect contains a profile of the given type.
754<p>
755<dl compact><dt><b>Parameters:</b></dt><dd>
756  <table border="0" cellspacing="2" cellpadding="0">
757    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The profile type. </td></tr>
758  </table>
759</dl>
760<dl compact><dt><b>Returns:</b></dt><dd>Whether the effect has a profile of this type. </dd></dl>
761    </td>
762  </tr>
763</table>
764<a class="anchor" name="f7724b736d7d2fff3a3d94e16accf030"></a><!-- doxytag: member="FCDEffect::LoadFromXML" ref="f7724b736d7d2fff3a3d94e16accf030" args="(xmlNode *effectNode)" --><p>
765<table class="mdTable" cellpadding="2" cellspacing="0">
766  <tr>
767    <td class="mdRow">
768      <table cellpadding="0" cellspacing="0" border="0">
769        <tr>
770          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffect::LoadFromXML           </td>
771          <td class="md" valign="top">(&nbsp;</td>
772          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
773          <td class="mdname1" valign="top" nowrap> <em>effectNode</em>          </td>
774          <td class="md" valign="top">&nbsp;)&nbsp;</td>
775          <td class="md" nowrap><code> [virtual]</code></td>
776        </tr>
777      </table>
778    </td>
779  </tr>
780</table>
781<table cellspacing="5" cellpadding="0" border="0">
782  <tr>
783    <td>
784      &nbsp;
785    </td>
786    <td>
787
788<p>
789[INTERNAL] Reads in the &lt;effect&gt; element from a given COLLADA XML tree node.
790<p>
791<dl compact><dt><b>Parameters:</b></dt><dd>
792  <table border="0" cellspacing="2" cellpadding="0">
793    <tr><td valign="top"></td><td valign="top"><em>effectNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
794  </table>
795</dl>
796<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. </dd></dl>
797
798<p>
799Reimplemented from <a class="el" href="class_f_c_d_entity.html#8e32fcc93de76acc4b606db7b5b83890">FCDEntity</a>.    </td>
800  </tr>
801</table>
802<a class="anchor" name="d9b1a857e799fffcb80bc62c9dc6f825"></a><!-- doxytag: member="FCDEffect::ReleaseProfile" ref="d9b1a857e799fffcb80bc62c9dc6f825" args="(FCDEffectProfile *profile)" --><p>
803<table class="mdTable" cellpadding="2" cellspacing="0">
804  <tr>
805    <td class="mdRow">
806      <table cellpadding="0" cellspacing="0" border="0">
807        <tr>
808          <td class="md" nowrap valign="top">void FCDEffect::ReleaseProfile           </td>
809          <td class="md" valign="top">(&nbsp;</td>
810          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a> *&nbsp;</td>
811          <td class="mdname1" valign="top" nowrap> <em>profile</em>          </td>
812          <td class="md" valign="top">&nbsp;)&nbsp;</td>
813          <td class="md" nowrap></td>
814        </tr>
815      </table>
816    </td>
817  </tr>
818</table>
819<table cellspacing="5" cellpadding="0" border="0">
820  <tr>
821    <td>
822      &nbsp;
823    </td>
824    <td>
825
826<p>
827Releases the given effect profile.
828<p>
829<dl compact><dt><b>Parameters:</b></dt><dd>
830  <table border="0" cellspacing="2" cellpadding="0">
831    <tr><td valign="top"></td><td valign="top"><em>profile</em>&nbsp;</td><td>The effect profile. </td></tr>
832  </table>
833</dl>
834    </td>
835  </tr>
836</table>
837<a class="anchor" name="ac88481b0ad514d0a5ddeeedaef5aecb"></a><!-- doxytag: member="FCDEffect::WriteToXML" ref="ac88481b0ad514d0a5ddeeedaef5aecb" args="(xmlNode *parentNode) const " --><p>
838<table class="mdTable" cellpadding="2" cellspacing="0">
839  <tr>
840    <td class="mdRow">
841      <table cellpadding="0" cellspacing="0" border="0">
842        <tr>
843          <td class="md" nowrap valign="top">virtual xmlNode* FCDEffect::WriteToXML           </td>
844          <td class="md" valign="top">(&nbsp;</td>
845          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
846          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
847          <td class="md" valign="top">&nbsp;)&nbsp;</td>
848          <td class="md" nowrap> const<code> [virtual]</code></td>
849        </tr>
850      </table>
851    </td>
852  </tr>
853</table>
854<table cellspacing="5" cellpadding="0" border="0">
855  <tr>
856    <td>
857      &nbsp;
858    </td>
859    <td>
860
861<p>
862[INTERNAL] Writes out the &lt;effect&gt; element to the given COLLADA XML tree node.
863<p>
864<dl compact><dt><b>Parameters:</b></dt><dd>
865  <table border="0" cellspacing="2" cellpadding="0">
866    <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. </td></tr>
867  </table>
868</dl>
869<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
870
871<p>
872Reimplemented from <a class="el" href="class_f_c_d_entity.html#b27f0c175c3f8fd7064cde48bcf1d7a0">FCDEntity</a>.    </td>
873  </tr>
874</table>
875<hr>The documentation for this class was generated from the following file:<ul>
876<li>FCDocument/<a class="el" href="_f_c_d_effect_8h-source.html">FCDEffect.h</a></ul>
877<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
878<a href="http://www.doxygen.org/index.html">
879<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
880</body>
881</html>
Note: See TracBrowser for help on using the repository browser.