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

Revision 964, 58.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: FCDEffectProfileFX 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>FCDEffectProfileFX 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="FCDEffectProfileFX" --><!-- doxytag: inherits="FCDEffectProfile" -->A general effect profile description. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_effect_profile_f_x_8h-source.html">FCDEffectProfileFX.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDEffectProfileFX:
33<p><center><img src="class_f_c_d_effect_profile_f_x.png" usemap="#FCDEffectProfileFX_map" border="0" alt=""></center>
34<map name="FCDEffectProfileFX_map">
35<area href="class_f_c_d_effect_profile.html" alt="FCDEffectProfile" shape="rect" coords="0,112,125,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,125,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,125,24">
38</map>
39<a href="class_f_c_d_effect_profile_f_x-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#b1cde1ccb8e268931e3a0ccd43936622">FCDEffectProfileFX</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, <a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#b1cde1ccb8e268931e3a0ccd43936622"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#1a17d7cfb46e3c0c774b04ebe438d895">~FCDEffectProfileFX</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#1a17d7cfb46e3c0c774b04ebe438d895"></a><br></td></tr>
48<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_f_x.html#711f7094d3d2ae864f336a4db558c3c5">GetType</a> () const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the profile type for this effect.  <a href="#711f7094d3d2ae864f336a4db558c3c5"></a><br></td></tr>
51<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_f_x.html#db48f79f4679a717b4034213127f3911">GetIncludeFilename</a> () const </td></tr>
52
53<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_profile_f_x.html#0d4d03330cc23e49a83f7dcb22df0b06">GetPlatform</a> () const </td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the name of the platform in which to use the effect profile.  <a href="#0d4d03330cc23e49a83f7dcb22df0b06"></a><br></td></tr>
56<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_profile_f_x.html#f62ebb93567297cd54efa2d215bf9089">SetPlatform</a> (fstring &amp;_platform)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the name of the platform in which to use the effect profile.  <a href="#f62ebb93567297cd54efa2d215bf9089"></a><br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDEffectTechniqueList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#80a54d76c0a3c80907235cf17ae960c2">GetTechniqueList</a> ()</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of techniques contained within this effect profile.  <a href="#80a54d76c0a3c80907235cf17ae960c2"></a><br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0d90e0afd455105d37353e0255d4583"></a><!-- doxytag: member="FCDEffectProfileFX::GetTechniqueList" ref="c0d90e0afd455105d37353e0255d4583" args="() const " -->
63const <a class="el" href="classvector.html">FCDEffectTechniqueList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#c0d90e0afd455105d37353e0255d4583">GetTechniqueList</a> () const </td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
66<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_profile_f_x.html#f1fac9bef78005e8a0936cc4f4cf5b63">GetTechniqueCount</a> () const </td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of techniques contained within this effect profile.  <a href="#f1fac9bef78005e8a0936cc4f4cf5b63"></a><br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#3cfd88fb24777d0cd909834bf15ab99a">GetTechnique</a> (size_t index)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a technique contained within this effect profile.  <a href="#3cfd88fb24777d0cd909834bf15ab99a"></a><br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1f90851b8c0527d30017ecf8f247ea6"></a><!-- doxytag: member="FCDEffectProfileFX::GetTechnique" ref="a1f90851b8c0527d30017ecf8f247ea6" args="(size_t index) const " -->
73const <a class="el" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#a1f90851b8c0527d30017ecf8f247ea6">GetTechnique</a> (size_t index) 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_technique.html">FCDEffectTechnique</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#2091d369181f262ed4ede6bbd2791135">AddTechnique</a> ()</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new technique to this effect profile.  <a href="#2091d369181f262ed4ede6bbd2791135"></a><br></td></tr>
79<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_profile_f_x.html#376aa74e5033595ebe9efcc8fd654932">ReleaseTechnique</a> (<a class="el" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a> *technique)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases a technique contained within this effect profile.  <a href="#376aa74e5033595ebe9efcc8fd654932"></a><br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDEffectCodeList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#f24b263c5c78d4112ec60450fcc939e6">GetCodeList</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of code inclusions.  <a href="#f24b263c5c78d4112ec60450fcc939e6"></a><br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc5da1376537533e92cc8fdaa808d50c"></a><!-- doxytag: member="FCDEffectProfileFX::GetCodeList" ref="cc5da1376537533e92cc8fdaa808d50c" args="() const " -->
86const <a class="el" href="classvector.html">FCDEffectCodeList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_profile_f_x.html#cc5da1376537533e92cc8fdaa808d50c">GetCodeList</a> () const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
89<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_profile_f_x.html#4014013862a3bbda5a93162279dc2698">GetCodeCount</a> () const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of code inclusions contained within the effect profile.  <a href="#4014013862a3bbda5a93162279dc2698"></a><br></td></tr>
92<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_profile_f_x.html#df8d6b95a3a98efd8c3df44cdf301347">GetCode</a> (size_t index)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a code inclusion contained within the effect profile.  <a href="#df8d6b95a3a98efd8c3df44cdf301347"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab857859ae788ec5d8da9641ce4ca6cb"></a><!-- doxytag: member="FCDEffectProfileFX::GetCode" ref="ab857859ae788ec5d8da9641ce4ca6cb" args="(size_t index) const " -->
96const <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_profile_f_x.html#ab857859ae788ec5d8da9641ce4ca6cb">GetCode</a> (size_t index) 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"><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_profile_f_x.html#b976d11075fa34e86f4583eb1eb02795">FindCode</a> (const string &amp;sid)</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the code inclusion with the given sub-id.  <a href="#b976d11075fa34e86f4583eb1eb02795"></a><br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7369ff12e7bb781bbff64ff678ec8304"></a><!-- doxytag: member="FCDEffectProfileFX::FindCode" ref="7369ff12e7bb781bbff64ff678ec8304" args="(const string &amp;sid) const " -->
103const <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_profile_f_x.html#7369ff12e7bb781bbff64ff678ec8304">FindCode</a> (const string &amp;sid) const </td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
106<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_profile_f_x.html#9a21038c26a18dca6d4cca3cf06ceda5">AddCode</a> ()</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new code inclusion to this effect profile.  <a href="#9a21038c26a18dca6d4cca3cf06ceda5"></a><br></td></tr>
109<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_profile_f_x.html#b32b7f33ed686a5fe8976d6aa08a04bf">ReleaseCode</a> (<a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a> *code)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases a code inclusion contained within this effect profile.  <a href="#b32b7f33ed686a5fe8976d6aa08a04bf"></a><br></td></tr>
112<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_profile_f_x.html#42a9d3a86abf99a2604206b6a441cb87">GetParameters</a> ()</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of effect parameters contained within the effect profile.  <a href="#42a9d3a86abf99a2604206b6a441cb87"></a><br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99e8a22a7372cc0c33a2468b80c51177"></a><!-- doxytag: member="FCDEffectProfileFX::GetParameters" ref="99e8a22a7372cc0c33a2468b80c51177" args="() const " -->
116const <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_profile_f_x.html#99e8a22a7372cc0c33a2468b80c51177">GetParameters</a> () const </td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
119<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_profile_f_x.html#d1251f5f80e3d1ee7d094707cdb1f005">AddParameter</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *parameter)</td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Inserts an existing parameter into the list of effect parameters at this abstraction level.  <a href="#d1251f5f80e3d1ee7d094707cdb1f005"></a><br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top">const <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_f_x.html#f0050c46e0090a82e09448e4c1b934a0">FindParameter</a> (const char *reference) const </td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an effect parameter.  <a href="#f0050c46e0090a82e09448e4c1b934a0"></a><br></td></tr>
125<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_f_x.html#ce1250c256d851099997dc733854a05a">FindParameterBySemantic</a> (const string &amp;semantic)</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an effect parameter.  <a href="#ce1250c256d851099997dc733854a05a"></a><br></td></tr>
128<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_f_x.html#90c0176724324af054e86948469a1c51">FindParametersBySemantic</a> (const string &amp;semantic, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;parameters)</td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of the effect parameter list.  <a href="#90c0176724324af054e86948469a1c51"></a><br></td></tr>
131<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_f_x.html#5fcde2c4a91c069ff4195203536cc8d3">FindParametersByReference</a> (const string &amp;reference, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;parameters)</td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of the effect parameter list.  <a href="#5fcde2c4a91c069ff4195203536cc8d3"></a><br></td></tr>
134<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_f_x.html#83296d2af4fa645cf0e0a64a6bdfb6fb">Clone</a> (<a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *newParent)</td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Clones the full effect profile.  <a href="#83296d2af4fa645cf0e0a64a6bdfb6fb"></a><br></td></tr>
137<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_f_x.html#285fe885ced798748c664b710d78e777">Flatten</a> ()</td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Flattens this effect profile.  <a href="#285fe885ced798748c664b710d78e777"></a><br></td></tr>
140<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_f_x.html#4397461d46443ad2ee95a9467c93a309">LoadFromXML</a> (xmlNode *profileNode)</td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the effect profile from a given COLLADA XML tree node.  <a href="#4397461d46443ad2ee95a9467c93a309"></a><br></td></tr>
143<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_f_x.html#eaa144326bb7ee626f62ebcf50f7f734">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the effect profile to the given COLLADA XML tree node.  <a href="#eaa144326bb7ee626f62ebcf50f7f734"></a><br></td></tr>
146</table>
147<hr><a name="_details"></a><h2>Detailed Description</h2>
148A general effect profile description.
149<p>
150The general effect profile contains all the information necessary to implement the advanced effect profiles, such as CG, HLSL, GLSL and GLES. Since these effect profiles contains extremely similar information, they use the same description structure. For the COMMON profile, see the <a class="el" href="class_f_c_d_effect_standard.html">FCDEffectStandard</a> class.<p>
151You should use the GetType function to figure out which profile this structure addresses. You can then retrieve one or many of the <a class="el" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a> objects that describe how to render for this profile. You may want to check the FCDEffectMaterialTechniqueHint objects at the <a class="el" href="class_f_c_d_material.html">FCDMaterial</a> level, in order to determine which technique(s) to use for your platform. At the profile level of abstraction, parameters may be generated within the FCDEffectParamterList.
152<p>
153<hr><h2>Constructor &amp; Destructor Documentation</h2>
154<a class="anchor" name="b1cde1ccb8e268931e3a0ccd43936622"></a><!-- doxytag: member="FCDEffectProfileFX::FCDEffectProfileFX" ref="b1cde1ccb8e268931e3a0ccd43936622" args="(FCDocument *document, FCDEffect *parent, FUDaeProfileType::Type type)" --><p>
155<table class="mdTable" cellpadding="2" cellspacing="0">
156  <tr>
157    <td class="mdRow">
158      <table cellpadding="0" cellspacing="0" border="0">
159        <tr>
160          <td class="md" nowrap valign="top">FCDEffectProfileFX::FCDEffectProfileFX           </td>
161          <td class="md" valign="top">(&nbsp;</td>
162          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
163          <td class="mdname" nowrap> <em>document</em>, </td>
164        </tr>
165        <tr>
166          <td class="md" nowrap align="right"></td>
167          <td class="md"></td>
168          <td class="md" nowrap><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td>
169          <td class="mdname" nowrap> <em>parent</em>, </td>
170        </tr>
171        <tr>
172          <td class="md" nowrap align="right"></td>
173          <td class="md"></td>
174          <td class="md" nowrap><a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a>&nbsp;</td>
175          <td class="mdname" nowrap> <em>type</em></td>
176        </tr>
177        <tr>
178          <td class="md"></td>
179          <td class="md">)&nbsp;</td>
180          <td class="md" colspan="2"></td>
181        </tr>
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing="5" cellpadding="0" border="0">
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194Constructor: do not use directly.
195<p>
196Instead, 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>
197  <table border="0" cellspacing="2" cellpadding="0">
198    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document which owns the effect profile. </td></tr>
199    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The effect which contains this profile. </td></tr>
200    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The type of profile. </td></tr>
201  </table>
202</dl>
203    </td>
204  </tr>
205</table>
206<a class="anchor" name="1a17d7cfb46e3c0c774b04ebe438d895"></a><!-- doxytag: member="FCDEffectProfileFX::~FCDEffectProfileFX" ref="1a17d7cfb46e3c0c774b04ebe438d895" args="()" --><p>
207<table class="mdTable" cellpadding="2" cellspacing="0">
208  <tr>
209    <td class="mdRow">
210      <table cellpadding="0" cellspacing="0" border="0">
211        <tr>
212          <td class="md" nowrap valign="top">virtual FCDEffectProfileFX::~FCDEffectProfileFX           </td>
213          <td class="md" valign="top">(&nbsp;</td>
214          <td class="mdname1" valign="top" nowrap>          </td>
215          <td class="md" valign="top">&nbsp;)&nbsp;</td>
216          <td class="md" nowrap><code> [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>
230Destructor: do not use directly.
231<p>
232Instead, use the <a class="el" href="class_f_c_d_effect.html">FCDEffect</a>:RemoveProfile function.     </td>
233  </tr>
234</table>
235<hr><h2>Member Function Documentation</h2>
236<a class="anchor" name="9a21038c26a18dca6d4cca3cf06ceda5"></a><!-- doxytag: member="FCDEffectProfileFX::AddCode" ref="9a21038c26a18dca6d4cca3cf06ceda5" args="()" --><p>
237<table class="mdTable" cellpadding="2" cellspacing="0">
238  <tr>
239    <td class="mdRow">
240      <table cellpadding="0" cellspacing="0" border="0">
241        <tr>
242          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* FCDEffectProfileFX::AddCode           </td>
243          <td class="md" valign="top">(&nbsp;</td>
244          <td class="mdname1" valign="top" nowrap>          </td>
245          <td class="md" valign="top">&nbsp;)&nbsp;</td>
246          <td class="md" nowrap></td>
247        </tr>
248      </table>
249    </td>
250  </tr>
251</table>
252<table cellspacing="5" cellpadding="0" border="0">
253  <tr>
254    <td>
255      &nbsp;
256    </td>
257    <td>
258
259<p>
260Adds a new code inclusion to this effect profile.
261<p>
262<dl compact><dt><b>Returns:</b></dt><dd>The new code inclusion. </dd></dl>
263    </td>
264  </tr>
265</table>
266<a class="anchor" name="d1251f5f80e3d1ee7d094707cdb1f005"></a><!-- doxytag: member="FCDEffectProfileFX::AddParameter" ref="d1251f5f80e3d1ee7d094707cdb1f005" args="(FCDEffectParameter *parameter)" --><p>
267<table class="mdTable" cellpadding="2" cellspacing="0">
268  <tr>
269    <td class="mdRow">
270      <table cellpadding="0" cellspacing="0" border="0">
271        <tr>
272          <td class="md" nowrap valign="top">void FCDEffectProfileFX::AddParameter           </td>
273          <td class="md" valign="top">(&nbsp;</td>
274          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td>
275          <td class="mdname1" valign="top" nowrap> <em>parameter</em>          </td>
276          <td class="md" valign="top">&nbsp;)&nbsp;</td>
277          <td class="md" nowrap></td>
278        </tr>
279      </table>
280    </td>
281  </tr>
282</table>
283<table cellspacing="5" cellpadding="0" border="0">
284  <tr>
285    <td>
286      &nbsp;
287    </td>
288    <td>
289
290<p>
291[INTERNAL] Inserts an existing parameter into the list of effect parameters at this abstraction level.
292<p>
293This function is used during the flattening of a material. <dl compact><dt><b>Parameters:</b></dt><dd>
294  <table border="0" cellspacing="2" cellpadding="0">
295    <tr><td valign="top"></td><td valign="top"><em>parameter</em>&nbsp;</td><td>The effect parameter to insert. </td></tr>
296  </table>
297</dl>
298    </td>
299  </tr>
300</table>
301<a class="anchor" name="2091d369181f262ed4ede6bbd2791135"></a><!-- doxytag: member="FCDEffectProfileFX::AddTechnique" ref="2091d369181f262ed4ede6bbd2791135" args="()" --><p>
302<table class="mdTable" cellpadding="2" cellspacing="0">
303  <tr>
304    <td class="mdRow">
305      <table cellpadding="0" cellspacing="0" border="0">
306        <tr>
307          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a>* FCDEffectProfileFX::AddTechnique           </td>
308          <td class="md" valign="top">(&nbsp;</td>
309          <td class="mdname1" valign="top" nowrap>          </td>
310          <td class="md" valign="top">&nbsp;)&nbsp;</td>
311          <td class="md" nowrap></td>
312        </tr>
313      </table>
314    </td>
315  </tr>
316</table>
317<table cellspacing="5" cellpadding="0" border="0">
318  <tr>
319    <td>
320      &nbsp;
321    </td>
322    <td>
323
324<p>
325Adds a new technique to this effect profile.
326<p>
327<dl compact><dt><b>Returns:</b></dt><dd>The new technique object. </dd></dl>
328    </td>
329  </tr>
330</table>
331<a class="anchor" name="83296d2af4fa645cf0e0a64a6bdfb6fb"></a><!-- doxytag: member="FCDEffectProfileFX::Clone" ref="83296d2af4fa645cf0e0a64a6bdfb6fb" args="(FCDEffect *newParent)" --><p>
332<table class="mdTable" cellpadding="2" cellspacing="0">
333  <tr>
334    <td class="mdRow">
335      <table cellpadding="0" cellspacing="0" border="0">
336        <tr>
337          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FCDEffectProfileFX::Clone           </td>
338          <td class="md" valign="top">(&nbsp;</td>
339          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td>
340          <td class="mdname1" valign="top" nowrap> <em>newParent</em>          </td>
341          <td class="md" valign="top">&nbsp;)&nbsp;</td>
342          <td class="md" nowrap><code> [virtual]</code></td>
343        </tr>
344      </table>
345    </td>
346  </tr>
347</table>
348<table cellspacing="5" cellpadding="0" border="0">
349  <tr>
350    <td>
351      &nbsp;
352    </td>
353    <td>
354
355<p>
356[INTERNAL] Clones the full effect profile.
357<p>
358<dl compact><dt><b>Parameters:</b></dt><dd>
359  <table border="0" cellspacing="2" cellpadding="0">
360    <tr><td valign="top"></td><td valign="top"><em>newParent</em>&nbsp;</td><td>The effect that will contain the cloned profile. </td></tr>
361  </table>
362</dl>
363<dl compact><dt><b>Returns:</b></dt><dd>The cloned profile. This pointer will never be NULL. </dd></dl>
364
365<p>
366Implements <a class="el" href="class_f_c_d_effect_profile.html#4f67ad9c31e8a1200100f5bb3b8b16c5">FCDEffectProfile</a>.    </td>
367  </tr>
368</table>
369<a class="anchor" name="b976d11075fa34e86f4583eb1eb02795"></a><!-- doxytag: member="FCDEffectProfileFX::FindCode" ref="b976d11075fa34e86f4583eb1eb02795" args="(const string &amp;sid)" --><p>
370<table class="mdTable" cellpadding="2" cellspacing="0">
371  <tr>
372    <td class="mdRow">
373      <table cellpadding="0" cellspacing="0" border="0">
374        <tr>
375          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* FCDEffectProfileFX::FindCode           </td>
376          <td class="md" valign="top">(&nbsp;</td>
377          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
378          <td class="mdname1" valign="top" nowrap> <em>sid</em>          </td>
379          <td class="md" valign="top">&nbsp;)&nbsp;</td>
380          <td class="md" nowrap></td>
381        </tr>
382      </table>
383    </td>
384  </tr>
385</table>
386<table cellspacing="5" cellpadding="0" border="0">
387  <tr>
388    <td>
389      &nbsp;
390    </td>
391    <td>
392
393<p>
394Retrieves the code inclusion with the given sub-id.
395<p>
396<dl compact><dt><b>Parameters:</b></dt><dd>
397  <table border="0" cellspacing="2" cellpadding="0">
398    <tr><td valign="top"></td><td valign="top"><em>sid</em>&nbsp;</td><td>A COLLADA sub-id. </td></tr>
399  </table>
400</dl>
401<dl compact><dt><b>Returns:</b></dt><dd>The code inclusion with the given sub-id. This pointer will be NULL, if there are no code inclusions that match the given sub-id. </dd></dl>
402    </td>
403  </tr>
404</table>
405<a class="anchor" name="f0050c46e0090a82e09448e4c1b934a0"></a><!-- doxytag: member="FCDEffectProfileFX::FindParameter" ref="f0050c46e0090a82e09448e4c1b934a0" args="(const char *reference) const " --><p>
406<table class="mdTable" cellpadding="2" cellspacing="0">
407  <tr>
408    <td class="mdRow">
409      <table cellpadding="0" cellspacing="0" border="0">
410        <tr>
411          <td class="md" nowrap valign="top">const <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectProfileFX::FindParameter           </td>
412          <td class="md" valign="top">(&nbsp;</td>
413          <td class="md" nowrap valign="top">const char *&nbsp;</td>
414          <td class="mdname1" valign="top" nowrap> <em>reference</em>          </td>
415          <td class="md" valign="top">&nbsp;)&nbsp;</td>
416          <td class="md" nowrap> const</td>
417        </tr>
418      </table>
419    </td>
420  </tr>
421</table>
422<table cellspacing="5" cellpadding="0" border="0">
423  <tr>
424    <td>
425      &nbsp;
426    </td>
427    <td>
428
429<p>
430Retrieves an effect parameter.
431<p>
432Looks for the effect parameter with the correct reference, 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>
433  <table border="0" cellspacing="2" cellpadding="0">
434    <tr><td valign="top"></td><td valign="top"><em>reference</em>&nbsp;</td><td>The reference to match. In the case of effect parameter generators, the sub-id is used to match. </td></tr>
435  </table>
436</dl>
437<dl compact><dt><b>Returns:</b></dt><dd>The first effect parameter that matches the reference. This pointer will be NULL if no effect parameter matches the given semantic. </dd></dl>
438    </td>
439  </tr>
440</table>
441<a class="anchor" name="ce1250c256d851099997dc733854a05a"></a><!-- doxytag: member="FCDEffectProfileFX::FindParameterBySemantic" ref="ce1250c256d851099997dc733854a05a" args="(const string &amp;semantic)" --><p>
442<table class="mdTable" cellpadding="2" cellspacing="0">
443  <tr>
444    <td class="mdRow">
445      <table cellpadding="0" cellspacing="0" border="0">
446        <tr>
447          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectProfileFX::FindParameterBySemantic           </td>
448          <td class="md" valign="top">(&nbsp;</td>
449          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
450          <td class="mdname1" valign="top" nowrap> <em>semantic</em>          </td>
451          <td class="md" valign="top">&nbsp;)&nbsp;</td>
452          <td class="md" nowrap><code> [virtual]</code></td>
453        </tr>
454      </table>
455    </td>
456  </tr>
457</table>
458<table cellspacing="5" cellpadding="0" border="0">
459  <tr>
460    <td>
461      &nbsp;
462    </td>
463    <td>
464
465<p>
466Retrieves an effect parameter.
467<p>
468Looks 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>
469  <table border="0" cellspacing="2" cellpadding="0">
470    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>The effect parameter semantic to match. </td></tr>
471  </table>
472</dl>
473<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>
474
475<p>
476Implements <a class="el" href="class_f_c_d_effect_profile.html#80060db98664b45c675c8b3ed4ddefa6">FCDEffectProfile</a>.    </td>
477  </tr>
478</table>
479<a class="anchor" name="5fcde2c4a91c069ff4195203536cc8d3"></a><!-- doxytag: member="FCDEffectProfileFX::FindParametersByReference" ref="5fcde2c4a91c069ff4195203536cc8d3" args="(const string &amp;reference, FCDEffectParameterList &amp;parameters)" --><p>
480<table class="mdTable" cellpadding="2" cellspacing="0">
481  <tr>
482    <td class="mdRow">
483      <table cellpadding="0" cellspacing="0" border="0">
484        <tr>
485          <td class="md" nowrap valign="top">virtual void FCDEffectProfileFX::FindParametersByReference           </td>
486          <td class="md" valign="top">(&nbsp;</td>
487          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
488          <td class="mdname" nowrap> <em>reference</em>, </td>
489        </tr>
490        <tr>
491          <td class="md" nowrap align="right"></td>
492          <td class="md"></td>
493          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
494          <td class="mdname" nowrap> <em>parameters</em></td>
495        </tr>
496        <tr>
497          <td class="md"></td>
498          <td class="md">)&nbsp;</td>
499          <td class="md" colspan="2"><code> [virtual]</code></td>
500        </tr>
501      </table>
502    </td>
503  </tr>
504</table>
505<table cellspacing="5" cellpadding="0" border="0">
506  <tr>
507    <td>
508      &nbsp;
509    </td>
510    <td>
511
512<p>
513Retrieves a subset of the effect parameter list.
514<p>
515Look for the effect parameter generators 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>
516  <table border="0" cellspacing="2" cellpadding="0">
517    <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>
518    <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>
519  </table>
520</dl>
521
522<p>
523Implements <a class="el" href="class_f_c_d_effect_profile.html#5460c340e4babf1d4adcd40f25267c85">FCDEffectProfile</a>.    </td>
524  </tr>
525</table>
526<a class="anchor" name="90c0176724324af054e86948469a1c51"></a><!-- doxytag: member="FCDEffectProfileFX::FindParametersBySemantic" ref="90c0176724324af054e86948469a1c51" args="(const string &amp;semantic, FCDEffectParameterList &amp;parameters)" --><p>
527<table class="mdTable" cellpadding="2" cellspacing="0">
528  <tr>
529    <td class="mdRow">
530      <table cellpadding="0" cellspacing="0" border="0">
531        <tr>
532          <td class="md" nowrap valign="top">virtual void FCDEffectProfileFX::FindParametersBySemantic           </td>
533          <td class="md" valign="top">(&nbsp;</td>
534          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
535          <td class="mdname" nowrap> <em>semantic</em>, </td>
536        </tr>
537        <tr>
538          <td class="md" nowrap align="right"></td>
539          <td class="md"></td>
540          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
541          <td class="mdname" nowrap> <em>parameters</em></td>
542        </tr>
543        <tr>
544          <td class="md"></td>
545          <td class="md">)&nbsp;</td>
546          <td class="md" colspan="2"><code> [virtual]</code></td>
547        </tr>
548      </table>
549    </td>
550  </tr>
551</table>
552<table cellspacing="5" cellpadding="0" border="0">
553  <tr>
554    <td>
555      &nbsp;
556    </td>
557    <td>
558
559<p>
560Retrieves a subset of the effect parameter list.
561<p>
562Look for the effect parameter generators 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>
563  <table border="0" cellspacing="2" cellpadding="0">
564    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>The effect parameter semantic to match. </td></tr>
565    <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>
566  </table>
567</dl>
568
569<p>
570Implements <a class="el" href="class_f_c_d_effect_profile.html#40c1df098809fcee13ae8d690bb94be5">FCDEffectProfile</a>.    </td>
571  </tr>
572</table>
573<a class="anchor" name="285fe885ced798748c664b710d78e777"></a><!-- doxytag: member="FCDEffectProfileFX::Flatten" ref="285fe885ced798748c664b710d78e777" args="()" --><p>
574<table class="mdTable" cellpadding="2" cellspacing="0">
575  <tr>
576    <td class="mdRow">
577      <table cellpadding="0" cellspacing="0" border="0">
578        <tr>
579          <td class="md" nowrap valign="top">virtual void FCDEffectProfileFX::Flatten           </td>
580          <td class="md" valign="top">(&nbsp;</td>
581          <td class="mdname1" valign="top" nowrap>          </td>
582          <td class="md" valign="top">&nbsp;)&nbsp;</td>
583          <td class="md" nowrap><code> [virtual]</code></td>
584        </tr>
585      </table>
586    </td>
587  </tr>
588</table>
589<table cellspacing="5" cellpadding="0" border="0">
590  <tr>
591    <td>
592      &nbsp;
593    </td>
594    <td>
595
596<p>
597[INTERNAL] Flattens this effect profile.
598<p>
599Pushes all the effect parameter overrides into the effect parameter generators and moves all the parameters to the effect technique level of abstraction. To flatten the material, use the <a class="el" href="class_f_c_d_material_instance.html#58182994223d2cbc81d90b1dab289239">FCDMaterialInstance::FlattenMaterial</a> function.
600<p>
601Implements <a class="el" href="class_f_c_d_effect_profile.html#e471a749ca530845863c47b353a8d592">FCDEffectProfile</a>.    </td>
602  </tr>
603</table>
604<a class="anchor" name="df8d6b95a3a98efd8c3df44cdf301347"></a><!-- doxytag: member="FCDEffectProfileFX::GetCode" ref="df8d6b95a3a98efd8c3df44cdf301347" args="(size_t index)" --><p>
605<table class="mdTable" cellpadding="2" cellspacing="0">
606  <tr>
607    <td class="mdRow">
608      <table cellpadding="0" cellspacing="0" border="0">
609        <tr>
610          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* FCDEffectProfileFX::GetCode           </td>
611          <td class="md" valign="top">(&nbsp;</td>
612          <td class="md" nowrap valign="top">size_t&nbsp;</td>
613          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
614          <td class="md" valign="top">&nbsp;)&nbsp;</td>
615          <td class="md" nowrap><code> [inline]</code></td>
616        </tr>
617      </table>
618    </td>
619  </tr>
620</table>
621<table cellspacing="5" cellpadding="0" border="0">
622  <tr>
623    <td>
624      &nbsp;
625    </td>
626    <td>
627
628<p>
629Retrieves a code inclusion contained within the effect profile.
630<p>
631<dl compact><dt><b>Parameters:</b></dt><dd>
632  <table border="0" cellspacing="2" cellpadding="0">
633    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the code inclusion. </td></tr>
634  </table>
635</dl>
636<dl compact><dt><b>Returns:</b></dt><dd>The code inclusion. This pointer will be NULL if the index is out-of-bounds. </dd></dl>
637    </td>
638  </tr>
639</table>
640<a class="anchor" name="4014013862a3bbda5a93162279dc2698"></a><!-- doxytag: member="FCDEffectProfileFX::GetCodeCount" ref="4014013862a3bbda5a93162279dc2698" args="() const " --><p>
641<table class="mdTable" cellpadding="2" cellspacing="0">
642  <tr>
643    <td class="mdRow">
644      <table cellpadding="0" cellspacing="0" border="0">
645        <tr>
646          <td class="md" nowrap valign="top">size_t FCDEffectProfileFX::GetCodeCount           </td>
647          <td class="md" valign="top">(&nbsp;</td>
648          <td class="mdname1" valign="top" nowrap>          </td>
649          <td class="md" valign="top">&nbsp;)&nbsp;</td>
650          <td class="md" nowrap> const<code> [inline]</code></td>
651        </tr>
652      </table>
653    </td>
654  </tr>
655</table>
656<table cellspacing="5" cellpadding="0" border="0">
657  <tr>
658    <td>
659      &nbsp;
660    </td>
661    <td>
662
663<p>
664Retrieves the number of code inclusions contained within the effect profile.
665<p>
666<dl compact><dt><b>Returns:</b></dt><dd>The number of code inclusions. </dd></dl>
667    </td>
668  </tr>
669</table>
670<a class="anchor" name="f24b263c5c78d4112ec60450fcc939e6"></a><!-- doxytag: member="FCDEffectProfileFX::GetCodeList" ref="f24b263c5c78d4112ec60450fcc939e6" args="()" --><p>
671<table class="mdTable" cellpadding="2" cellspacing="0">
672  <tr>
673    <td class="mdRow">
674      <table cellpadding="0" cellspacing="0" border="0">
675        <tr>
676          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDEffectCodeList</a>&amp; FCDEffectProfileFX::GetCodeList           </td>
677          <td class="md" valign="top">(&nbsp;</td>
678          <td class="mdname1" valign="top" nowrap>          </td>
679          <td class="md" valign="top">&nbsp;)&nbsp;</td>
680          <td class="md" nowrap><code> [inline]</code></td>
681        </tr>
682      </table>
683    </td>
684  </tr>
685</table>
686<table cellspacing="5" cellpadding="0" border="0">
687  <tr>
688    <td>
689      &nbsp;
690    </td>
691    <td>
692
693<p>
694Retrieves the list of code inclusions.
695<p>
696<dl compact><dt><b>Returns:</b></dt><dd>The list of code inclusions. </dd></dl>
697    </td>
698  </tr>
699</table>
700<a class="anchor" name="db48f79f4679a717b4034213127f3911"></a><!-- doxytag: member="FCDEffectProfileFX::GetIncludeFilename" ref="db48f79f4679a717b4034213127f3911" args="() const " --><p>
701<table class="mdTable" cellpadding="2" cellspacing="0">
702  <tr>
703    <td class="mdRow">
704      <table cellpadding="0" cellspacing="0" border="0">
705        <tr>
706          <td class="md" nowrap valign="top">const string&amp; FCDEffectProfileFX::GetIncludeFilename           </td>
707          <td class="md" valign="top">(&nbsp;</td>
708          <td class="mdname1" valign="top" nowrap>          </td>
709          <td class="md" valign="top">&nbsp;)&nbsp;</td>
710          <td class="md" nowrap> const<code> [inline]</code></td>
711        </tr>
712      </table>
713    </td>
714  </tr>
715</table>
716<table cellspacing="5" cellpadding="0" border="0">
717  <tr>
718    <td>
719      &nbsp;
720    </td>
721    <td>
722
723<p>
724<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Retrieves the filename of the file that contains the code for this effect profile. Instead, look through the <a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a> object, using the GetCodeList function and retrieve the correct object and its filename string. </dd></dl>
725<dl compact><dt><b>Returns:</b></dt><dd>The filename of the file to import. </dd></dl>
726    </td>
727  </tr>
728</table>
729<a class="anchor" name="42a9d3a86abf99a2604206b6a441cb87"></a><!-- doxytag: member="FCDEffectProfileFX::GetParameters" ref="42a9d3a86abf99a2604206b6a441cb87" args="()" --><p>
730<table class="mdTable" cellpadding="2" cellspacing="0">
731  <tr>
732    <td class="mdRow">
733      <table cellpadding="0" cellspacing="0" border="0">
734        <tr>
735          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* FCDEffectProfileFX::GetParameters           </td>
736          <td class="md" valign="top">(&nbsp;</td>
737          <td class="mdname1" valign="top" nowrap>          </td>
738          <td class="md" valign="top">&nbsp;)&nbsp;</td>
739          <td class="md" nowrap><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 the list of effect parameters contained within the effect profile.
754<p>
755At this level of abstraction, there should be only effect parameter generators. <dl compact><dt><b>Returns:</b></dt><dd>The list of effect parameters. </dd></dl>
756    </td>
757  </tr>
758</table>
759<a class="anchor" name="0d4d03330cc23e49a83f7dcb22df0b06"></a><!-- doxytag: member="FCDEffectProfileFX::GetPlatform" ref="0d4d03330cc23e49a83f7dcb22df0b06" args="() const " --><p>
760<table class="mdTable" cellpadding="2" cellspacing="0">
761  <tr>
762    <td class="mdRow">
763      <table cellpadding="0" cellspacing="0" border="0">
764        <tr>
765          <td class="md" nowrap valign="top">const fstring&amp; FCDEffectProfileFX::GetPlatform           </td>
766          <td class="md" valign="top">(&nbsp;</td>
767          <td class="mdname1" valign="top" nowrap>          </td>
768          <td class="md" valign="top">&nbsp;)&nbsp;</td>
769          <td class="md" nowrap> const<code> [inline]</code></td>
770        </tr>
771      </table>
772    </td>
773  </tr>
774</table>
775<table cellspacing="5" cellpadding="0" border="0">
776  <tr>
777    <td>
778      &nbsp;
779    </td>
780    <td>
781
782<p>
783Retrieves the name of the platform in which to use the effect profile.
784<p>
785This parameter is very optional. <dl compact><dt><b>Returns:</b></dt><dd>The platform name. </dd></dl>
786    </td>
787  </tr>
788</table>
789<a class="anchor" name="3cfd88fb24777d0cd909834bf15ab99a"></a><!-- doxytag: member="FCDEffectProfileFX::GetTechnique" ref="3cfd88fb24777d0cd909834bf15ab99a" args="(size_t index)" --><p>
790<table class="mdTable" cellpadding="2" cellspacing="0">
791  <tr>
792    <td class="mdRow">
793      <table cellpadding="0" cellspacing="0" border="0">
794        <tr>
795          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a>* FCDEffectProfileFX::GetTechnique           </td>
796          <td class="md" valign="top">(&nbsp;</td>
797          <td class="md" nowrap valign="top">size_t&nbsp;</td>
798          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
799          <td class="md" valign="top">&nbsp;)&nbsp;</td>
800          <td class="md" nowrap><code> [inline]</code></td>
801        </tr>
802      </table>
803    </td>
804  </tr>
805</table>
806<table cellspacing="5" cellpadding="0" border="0">
807  <tr>
808    <td>
809      &nbsp;
810    </td>
811    <td>
812
813<p>
814Retrieves a technique contained within this effect profile.
815<p>
816You may want to check the FCDEffectMaterialTechniqueHint objects at the <a class="el" href="class_f_c_d_material.html">FCDMaterial</a> level, in order to determine which technique(s) to use for your platform. <dl compact><dt><b>Parameters:</b></dt><dd>
817  <table border="0" cellspacing="2" cellpadding="0">
818    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the technique. </td></tr>
819  </table>
820</dl>
821<dl compact><dt><b>Returns:</b></dt><dd>The inner technique. This pointer will be NULL if the index is out-of-bounds. </dd></dl>
822    </td>
823  </tr>
824</table>
825<a class="anchor" name="f1fac9bef78005e8a0936cc4f4cf5b63"></a><!-- doxytag: member="FCDEffectProfileFX::GetTechniqueCount" ref="f1fac9bef78005e8a0936cc4f4cf5b63" args="() const " --><p>
826<table class="mdTable" cellpadding="2" cellspacing="0">
827  <tr>
828    <td class="mdRow">
829      <table cellpadding="0" cellspacing="0" border="0">
830        <tr>
831          <td class="md" nowrap valign="top">size_t FCDEffectProfileFX::GetTechniqueCount           </td>
832          <td class="md" valign="top">(&nbsp;</td>
833          <td class="mdname1" valign="top" nowrap>          </td>
834          <td class="md" valign="top">&nbsp;)&nbsp;</td>
835          <td class="md" nowrap> const<code> [inline]</code></td>
836        </tr>
837      </table>
838    </td>
839  </tr>
840</table>
841<table cellspacing="5" cellpadding="0" border="0">
842  <tr>
843    <td>
844      &nbsp;
845    </td>
846    <td>
847
848<p>
849Retrieves the number of techniques contained within this effect profile.
850<p>
851<dl compact><dt><b>Returns:</b></dt><dd>The number of inner techniques. </dd></dl>
852    </td>
853  </tr>
854</table>
855<a class="anchor" name="80a54d76c0a3c80907235cf17ae960c2"></a><!-- doxytag: member="FCDEffectProfileFX::GetTechniqueList" ref="80a54d76c0a3c80907235cf17ae960c2" args="()" --><p>
856<table class="mdTable" cellpadding="2" cellspacing="0">
857  <tr>
858    <td class="mdRow">
859      <table cellpadding="0" cellspacing="0" border="0">
860        <tr>
861          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDEffectTechniqueList</a>&amp; FCDEffectProfileFX::GetTechniqueList           </td>
862          <td class="md" valign="top">(&nbsp;</td>
863          <td class="mdname1" valign="top" nowrap>          </td>
864          <td class="md" valign="top">&nbsp;)&nbsp;</td>
865          <td class="md" nowrap><code> [inline]</code></td>
866        </tr>
867      </table>
868    </td>
869  </tr>
870</table>
871<table cellspacing="5" cellpadding="0" border="0">
872  <tr>
873    <td>
874      &nbsp;
875    </td>
876    <td>
877
878<p>
879Retrieves the list of techniques contained within this effect profile.
880<p>
881You may want to check the FCDEffectMaterialTechniqueHint objects at the <a class="el" href="class_f_c_d_material.html">FCDMaterial</a> level, in order to determine which technique(s) to use for your platform. <dl compact><dt><b>Returns:</b></dt><dd>The list of inner techniques. </dd></dl>
882    </td>
883  </tr>
884</table>
885<a class="anchor" name="711f7094d3d2ae864f336a4db558c3c5"></a><!-- doxytag: member="FCDEffectProfileFX::GetType" ref="711f7094d3d2ae864f336a4db558c3c5" args="() const " --><p>
886<table class="mdTable" cellpadding="2" cellspacing="0">
887  <tr>
888    <td class="mdRow">
889      <table cellpadding="0" cellspacing="0" border="0">
890        <tr>
891          <td class="md" nowrap valign="top">virtual <a class="el" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> FCDEffectProfileFX::GetType           </td>
892          <td class="md" valign="top">(&nbsp;</td>
893          <td class="mdname1" valign="top" nowrap>          </td>
894          <td class="md" valign="top">&nbsp;)&nbsp;</td>
895          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
896        </tr>
897      </table>
898    </td>
899  </tr>
900</table>
901<table cellspacing="5" cellpadding="0" border="0">
902  <tr>
903    <td>
904      &nbsp;
905    </td>
906    <td>
907
908<p>
909Retrieves the profile type for this effect.
910<p>
911This function is a part of the <a class="el" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a> interface and allows you to up-cast an effect profile pointer safely to this class. <dl compact><dt><b>Returns:</b></dt><dd>The profile type. This should never be the value: 'COMMON', but all other profiles currently derive from this class. </dd></dl>
912
913<p>
914Implements <a class="el" href="class_f_c_d_effect_profile.html#48ae9db50d8cce2509d6a3d557a1b0a6">FCDEffectProfile</a>.    </td>
915  </tr>
916</table>
917<a class="anchor" name="4397461d46443ad2ee95a9467c93a309"></a><!-- doxytag: member="FCDEffectProfileFX::LoadFromXML" ref="4397461d46443ad2ee95a9467c93a309" args="(xmlNode *profileNode)" --><p>
918<table class="mdTable" cellpadding="2" cellspacing="0">
919  <tr>
920    <td class="mdRow">
921      <table cellpadding="0" cellspacing="0" border="0">
922        <tr>
923          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectProfileFX::LoadFromXML           </td>
924          <td class="md" valign="top">(&nbsp;</td>
925          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
926          <td class="mdname1" valign="top" nowrap> <em>profileNode</em>          </td>
927          <td class="md" valign="top">&nbsp;)&nbsp;</td>
928          <td class="md" nowrap><code> [virtual]</code></td>
929        </tr>
930      </table>
931    </td>
932  </tr>
933</table>
934<table cellspacing="5" cellpadding="0" border="0">
935  <tr>
936    <td>
937      &nbsp;
938    </td>
939    <td>
940
941<p>
942[INTERNAL] Reads in the effect profile from a given COLLADA XML tree node.
943<p>
944<dl compact><dt><b>Parameters:</b></dt><dd>
945  <table border="0" cellspacing="2" cellpadding="0">
946    <tr><td valign="top"></td><td valign="top"><em>profileNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
947  </table>
948</dl>
949<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>
950
951<p>
952Implements <a class="el" href="class_f_c_d_effect_profile.html#d61377cf739a43c111cf205317c4d64b">FCDEffectProfile</a>.    </td>
953  </tr>
954</table>
955<a class="anchor" name="b32b7f33ed686a5fe8976d6aa08a04bf"></a><!-- doxytag: member="FCDEffectProfileFX::ReleaseCode" ref="b32b7f33ed686a5fe8976d6aa08a04bf" args="(FCDEffectCode *code)" --><p>
956<table class="mdTable" cellpadding="2" cellspacing="0">
957  <tr>
958    <td class="mdRow">
959      <table cellpadding="0" cellspacing="0" border="0">
960        <tr>
961          <td class="md" nowrap valign="top">void FCDEffectProfileFX::ReleaseCode           </td>
962          <td class="md" valign="top">(&nbsp;</td>
963          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_code.html">FCDEffectCode</a> *&nbsp;</td>
964          <td class="mdname1" valign="top" nowrap> <em>code</em>          </td>
965          <td class="md" valign="top">&nbsp;)&nbsp;</td>
966          <td class="md" nowrap></td>
967        </tr>
968      </table>
969    </td>
970  </tr>
971</table>
972<table cellspacing="5" cellpadding="0" border="0">
973  <tr>
974    <td>
975      &nbsp;
976    </td>
977    <td>
978
979<p>
980Releases a code inclusion contained within this effect profile.
981<p>
982<dl compact><dt><b>Parameters:</b></dt><dd>
983  <table border="0" cellspacing="2" cellpadding="0">
984    <tr><td valign="top"></td><td valign="top"><em>code</em>&nbsp;</td><td>The code inclusion to release. </td></tr>
985  </table>
986</dl>
987    </td>
988  </tr>
989</table>
990<a class="anchor" name="376aa74e5033595ebe9efcc8fd654932"></a><!-- doxytag: member="FCDEffectProfileFX::ReleaseTechnique" ref="376aa74e5033595ebe9efcc8fd654932" args="(FCDEffectTechnique *technique)" --><p>
991<table class="mdTable" cellpadding="2" cellspacing="0">
992  <tr>
993    <td class="mdRow">
994      <table cellpadding="0" cellspacing="0" border="0">
995        <tr>
996          <td class="md" nowrap valign="top">void FCDEffectProfileFX::ReleaseTechnique           </td>
997          <td class="md" valign="top">(&nbsp;</td>
998          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a> *&nbsp;</td>
999          <td class="mdname1" valign="top" nowrap> <em>technique</em>          </td>
1000          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1001          <td class="md" nowrap></td>
1002        </tr>
1003      </table>
1004    </td>
1005  </tr>
1006</table>
1007<table cellspacing="5" cellpadding="0" border="0">
1008  <tr>
1009    <td>
1010      &nbsp;
1011    </td>
1012    <td>
1013
1014<p>
1015Releases a technique contained within this effect profile.
1016<p>
1017<dl compact><dt><b>Parameters:</b></dt><dd>
1018  <table border="0" cellspacing="2" cellpadding="0">
1019    <tr><td valign="top"></td><td valign="top"><em>technique</em>&nbsp;</td><td>The technique to release. </td></tr>
1020  </table>
1021</dl>
1022    </td>
1023  </tr>
1024</table>
1025<a class="anchor" name="f62ebb93567297cd54efa2d215bf9089"></a><!-- doxytag: member="FCDEffectProfileFX::SetPlatform" ref="f62ebb93567297cd54efa2d215bf9089" args="(fstring &amp;_platform)" --><p>
1026<table class="mdTable" cellpadding="2" cellspacing="0">
1027  <tr>
1028    <td class="mdRow">
1029      <table cellpadding="0" cellspacing="0" border="0">
1030        <tr>
1031          <td class="md" nowrap valign="top">void FCDEffectProfileFX::SetPlatform           </td>
1032          <td class="md" valign="top">(&nbsp;</td>
1033          <td class="md" nowrap valign="top">fstring &amp;&nbsp;</td>
1034          <td class="mdname1" valign="top" nowrap> <em>_platform</em>          </td>
1035          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1036          <td class="md" nowrap><code> [inline]</code></td>
1037        </tr>
1038      </table>
1039    </td>
1040  </tr>
1041</table>
1042<table cellspacing="5" cellpadding="0" border="0">
1043  <tr>
1044    <td>
1045      &nbsp;
1046    </td>
1047    <td>
1048
1049<p>
1050Sets the name of the platform in which to use the effect profile.
1051<p>
1052This parameter is very optional. <dl compact><dt><b>Parameters:</b></dt><dd>
1053  <table border="0" cellspacing="2" cellpadding="0">
1054    <tr><td valign="top"></td><td valign="top"><em>_platform</em>&nbsp;</td><td>The platform name. </td></tr>
1055  </table>
1056</dl>
1057    </td>
1058  </tr>
1059</table>
1060<a class="anchor" name="eaa144326bb7ee626f62ebcf50f7f734"></a><!-- doxytag: member="FCDEffectProfileFX::WriteToXML" ref="eaa144326bb7ee626f62ebcf50f7f734" args="(xmlNode *parentNode) const " --><p>
1061<table class="mdTable" cellpadding="2" cellspacing="0">
1062  <tr>
1063    <td class="mdRow">
1064      <table cellpadding="0" cellspacing="0" border="0">
1065        <tr>
1066          <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectProfileFX::WriteToXML           </td>
1067          <td class="md" valign="top">(&nbsp;</td>
1068          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
1069          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
1070          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1071          <td class="md" nowrap> const<code> [virtual]</code></td>
1072        </tr>
1073      </table>
1074    </td>
1075  </tr>
1076</table>
1077<table cellspacing="5" cellpadding="0" border="0">
1078  <tr>
1079    <td>
1080      &nbsp;
1081    </td>
1082    <td>
1083
1084<p>
1085[INTERNAL] Writes out the effect profile to the given COLLADA XML tree node.
1086<p>
1087<dl compact><dt><b>Parameters:</b></dt><dd>
1088  <table border="0" cellspacing="2" cellpadding="0">
1089    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the material declaration. </td></tr>
1090  </table>
1091</dl>
1092<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
1093
1094<p>
1095Implements <a class="el" href="class_f_c_d_effect_profile.html#8195790d32e7dd4c430e05d7de1d6bed">FCDEffectProfile</a>.    </td>
1096  </tr>
1097</table>
1098<hr>The documentation for this class was generated from the following file:<ul>
1099<li>FCDocument/<a class="el" href="_f_c_d_effect_profile_f_x_8h-source.html">FCDEffectProfileFX.h</a></ul>
1100<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
1101<a href="http://www.doxygen.org/index.html">
1102<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
1103</body>
1104</html>
Note: See TracBrowser for help on using the repository browser.