source: NonGTP/FCollada/Documentation/_f_c_d_effect_profile_f_x_8h-source.html @ 964

Revision 964, 15.9 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: FCDocument/FCDEffectProfileFX.h Source File</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><a href="classes.html"><span>Classes</span></a></li>
14    <li id="current"><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="files.html"><span>File&nbsp;List</span></a></li>
20    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
21  </ul></div>
22<h1>FCDocument/FCDEffectProfileFX.h</h1><a href="_f_c_d_effect_profile_f_x_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
23<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2005-2006 Feeling Software Inc.</span>
24<a name="l00003"></a>00003 <span class="comment">    MIT License: http://www.opensource.org/licenses/mit-license.php</span>
25<a name="l00004"></a>00004 <span class="comment">*/</span>
26<a name="l00005"></a>00005 <span class="comment">/*</span>
27<a name="l00006"></a>00006 <span class="comment">    Based on the FS Import classes:</span>
28<a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2005-2006 Feeling Software Inc</span>
29<a name="l00008"></a>00008 <span class="comment">    Copyright (C) 2005-2006 Autodesk Media Entertainment</span>
30<a name="l00009"></a>00009 <span class="comment">    MIT License: http://www.opensource.org/licenses/mit-license.php</span>
31<a name="l00010"></a>00010 <span class="comment">*/</span>
32<a name="l00011"></a>00011
33<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _FCD_EFFECT_PROFILE_FX_H_</span>
34<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _FCD_EFFECT_PROFILE_FX_H_</span>
35<a name="l00019"></a>00019 <span class="preprocessor"></span>
36<a name="l00020"></a>00020 <span class="preprocessor">#include "FUtils/FUDaeEnum.h"</span>
37<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="_f_c_d_effect_profile_8h.html">FCDocument/FCDEffectProfile.h</a>"</span>
38<a name="l00022"></a>00022
39<a name="l00023"></a>00023 <span class="keyword">class </span><a class="code" href="class_f_c_document.html">FCDocument</a>;
40<a name="l00024"></a>00024 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect.html">FCDEffect</a>;
41<a name="l00025"></a>00025 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_code.html">FCDEffectCode</a>;
42<a name="l00026"></a>00026 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>;
43<a name="l00027"></a>00027 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_parameter_surface.html">FCDEffectParameterSurface</a>;
44<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a>;
45<a name="l00029"></a><a class="code" href="_f_c_d_effect_profile_f_x_8h.html#34e3608f842317e742f29059b1afb8b1">00029</a> <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>;
46<a name="l00030"></a>00030
47<a name="l00031"></a>00031 <span class="keyword">typedef</span> <a class="code" href="classvector.html">vector&lt;FCDEffectTechnique*&gt;</a> <a class="code" href="classvector.html">FCDEffectTechniqueList</a>;
48<a name="l00032"></a><a class="code" href="_f_c_d_effect_profile_f_x_8h.html#c8e0b00483a39f4fe429a6427566fa21">00032</a> <span class="keyword">typedef</span> <a class="code" href="classvector.html">vector&lt;FCDEffectCode*&gt;</a> <a class="code" href="classvector.html">FCDEffectCodeList</a>;
49<a name="l00052"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html">00052</a> <span class="keyword">class </span>FCOLLADA_EXPORT <a class="code" href="class_f_c_d_effect_profile_f_x.html">FCDEffectProfileFX</a> : <span class="keyword">public</span> <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>
50<a name="l00053"></a>00053 {
51<a name="l00054"></a>00054 <span class="keyword">private</span>:
52<a name="l00055"></a>00055     <a class="code" href="_f_u_object_type_8h.html#8124b8a8706cd10260f8cd5a7bd8e691">DeclareObjectType</a>;
53<a name="l00056"></a>00056 <a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type;
54<a name="l00057"></a>00057     string includeFilename;
55<a name="l00058"></a>00058     fstring platform;
56<a name="l00059"></a>00059
57<a name="l00060"></a>00060 <a class="code" href="classvector.html">FCDEffectCodeList</a> codes;
58<a name="l00061"></a>00061 <a class="code" href="classvector.html">FCDEffectTechniqueList</a> techniques;
59<a name="l00062"></a>00062     <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* parameters;
60<a name="l00063"></a>00063
61<a name="l00064"></a>00064 <span class="keyword">public</span>:
62<a name="l00069"></a>00069 <a class="code" href="class_f_c_d_effect_profile_f_x.html">FCDEffectProfileFX</a>(<a class="code" href="class_f_c_document.html">FCDocument</a>* document, <a class="code" href="class_f_c_d_effect.html">FCDEffect</a>* parent, <a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type);
63<a name="l00070"></a>00070
64<a name="l00072"></a>00072 <span class="keyword">virtual</span> ~<a class="code" href="class_f_c_d_effect_profile_f_x.html">FCDEffectProfileFX</a>();
65<a name="l00073"></a>00073
66<a name="l00079"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#711f7094d3d2ae864f336a4db558c3c5">00079</a>     <span class="keyword">virtual</span> <a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> <a class="code" href="class_f_c_d_effect_profile.html#48ae9db50d8cce2509d6a3d557a1b0a6">GetType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> type; }
67<a name="l00080"></a>00080
68<a name="l00085"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#db48f79f4679a717b4034213127f3911">00085</a>     <span class="keyword">const</span> string&amp; GetIncludeFilename()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> includeFilename; }
69<a name="l00086"></a>00086
70<a name="l00090"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#0d4d03330cc23e49a83f7dcb22df0b06">00090</a>     <span class="keyword">const</span> fstring&amp; GetPlatform()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> platform; }
71<a name="l00091"></a>00091
72<a name="l00095"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#f62ebb93567297cd54efa2d215bf9089">00095</a>     <span class="keywordtype">void</span> SetPlatform(fstring&amp; _platform) { platform = _platform; }
73<a name="l00096"></a>00096
74<a name="l00101"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#80a54d76c0a3c80907235cf17ae960c2">00101</a>     <a class="code" href="classvector.html">FCDEffectTechniqueList</a>&amp; GetTechniqueList() { <span class="keywordflow">return</span> techniques; }
75<a name="l00102"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#c0d90e0afd455105d37353e0255d4583">00102</a>     <span class="keyword">const</span> <a class="code" href="classvector.html">FCDEffectTechniqueList</a>&amp; GetTechniqueList()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> techniques; }
76<a name="l00106"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#f1fac9bef78005e8a0936cc4f4cf5b63">00106</a>     size_t GetTechniqueCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> techniques.size(); }
77<a name="l00107"></a>00107
78<a name="l00113"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#3cfd88fb24777d0cd909834bf15ab99a">00113</a>     <a class="code" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a>* GetTechnique(size_t index) { <a class="code" href="_f_u_assert_8h.html#72b8444eb608787f1db6bf1d53e0310f">FUAssert</a>(index &lt; GetTechniqueCount(), <span class="keywordflow">return</span> NULL); <span class="keywordflow">return</span> techniques.at(index); }
79<a name="l00114"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#a1f90851b8c0527d30017ecf8f247ea6">00114</a>     <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a>* GetTechnique(size_t index)<span class="keyword"> const </span>{ <a class="code" href="_f_u_assert_8h.html#72b8444eb608787f1db6bf1d53e0310f">FUAssert</a>(index &lt; GetTechniqueCount(), <span class="keywordflow">return</span> NULL); <span class="keywordflow">return</span> techniques.at(index); }
80<a name="l00118"></a>00118     <a class="code" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a>* AddTechnique();
81<a name="l00119"></a>00119
82<a name="l00122"></a>00122 <span class="keywordtype">void</span> ReleaseTechnique(<a class="code" href="class_f_c_d_effect_technique.html">FCDEffectTechnique</a>* technique);
83<a name="l00123"></a>00123
84<a name="l00126"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#f24b263c5c78d4112ec60450fcc939e6">00126</a>     <a class="code" href="classvector.html">FCDEffectCodeList</a>&amp; GetCodeList() { <span class="keywordflow">return</span> codes; }
85<a name="l00127"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#cc5da1376537533e92cc8fdaa808d50c">00127</a>     <span class="keyword">const</span> <a class="code" href="classvector.html">FCDEffectCodeList</a>&amp; GetCodeList()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> codes; }
86<a name="l00131"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#4014013862a3bbda5a93162279dc2698">00131</a>     size_t GetCodeCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> codes.size(); }
87<a name="l00132"></a>00132
88<a name="l00136"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#df8d6b95a3a98efd8c3df44cdf301347">00136</a>     <a class="code" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* GetCode(size_t index) { <a class="code" href="_f_u_assert_8h.html#72b8444eb608787f1db6bf1d53e0310f">FUAssert</a>(index &lt; GetCodeCount(), <span class="keywordflow">return</span> NULL); <span class="keywordflow">return</span> codes.at(index); }
89<a name="l00137"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#ab857859ae788ec5d8da9641ce4ca6cb">00137</a>     <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* GetCode(size_t index)<span class="keyword"> const </span>{ <a class="code" href="_f_u_assert_8h.html#72b8444eb608787f1db6bf1d53e0310f">FUAssert</a>(index &lt; GetCodeCount(), <span class="keywordflow">return</span> NULL); <span class="keywordflow">return</span> codes.at(index); }
90<a name="l00143"></a>00143 <a class="code" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* FindCode(<span class="keyword">const</span> string&amp; sid);
91<a name="l00144"></a>00144 <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* FindCode(<span class="keyword">const</span> string&amp; sid) <span class="keyword">const</span>;
92<a name="l00148"></a>00148     <a class="code" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* AddCode();
93<a name="l00149"></a>00149
94<a name="l00152"></a>00152 <span class="keywordtype">void</span> ReleaseCode(<a class="code" href="class_f_c_d_effect_code.html">FCDEffectCode</a>* code);
95<a name="l00153"></a>00153
96<a name="l00157"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#42a9d3a86abf99a2604206b6a441cb87">00157</a>     <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* GetParameters() { <span class="keywordflow">return</span> parameters; }
97<a name="l00158"></a><a class="code" href="class_f_c_d_effect_profile_f_x.html#99e8a22a7372cc0c33a2468b80c51177">00158</a>     <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* GetParameters()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> parameters; }
98<a name="l00163"></a>00163 <span class="keywordtype">void</span> <a class="code" href="namespace_f_u_dae_writer.html#d0eeb471f60953186f1b18ad665c7ea5">AddParameter</a>(<a class="code" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* parameter);
99<a name="l00164"></a>00164
100<a name="l00172"></a>00172 <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FindParameter(<span class="keyword">const</span> <span class="keywordtype">char</span>* reference) <span class="keyword">const</span>;
101<a name="l00173"></a>00173
102<a name="l00180"></a>00180 <span class="keyword">virtual</span> <a class="code" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* <a class="code" href="class_f_c_d_effect_profile.html#80060db98664b45c675c8b3ed4ddefa6">FindParameterBySemantic</a>(<span class="keyword">const</span> string&amp; semantic);
103<a name="l00181"></a>00181
104<a name="l00187"></a>00187 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_c_d_effect_profile.html#40c1df098809fcee13ae8d690bb94be5">FindParametersBySemantic</a>(<span class="keyword">const</span> string&amp; semantic, <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>&amp; parameters);
105<a name="l00188"></a>00188
106<a name="l00195"></a>00195 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_c_d_effect_profile.html#5460c340e4babf1d4adcd40f25267c85">FindParametersByReference</a>(<span class="keyword">const</span> string&amp; reference, <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>&amp; parameters);
107<a name="l00196"></a>00196
108<a name="l00200"></a>00200 <span class="keyword">virtual</span> <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* <a class="code" href="class_f_c_d_effect_profile.html#4f67ad9c31e8a1200100f5bb3b8b16c5">Clone</a>(<a class="code" href="class_f_c_d_effect.html">FCDEffect</a>* newParent);
109<a name="l00201"></a>00201
110<a name="l00206"></a>00206 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_f_c_d_effect_profile.html#e471a749ca530845863c47b353a8d592">Flatten</a>();
111<a name="l00207"></a>00207
112<a name="l00212"></a>00212 <span class="keyword">virtual</span> <a class="code" href="class_f_u_status.html">FUStatus</a> <a class="code" href="class_f_c_d_effect_profile.html#d61377cf739a43c111cf205317c4d64b">LoadFromXML</a>(xmlNode* profileNode);
113<a name="l00213"></a>00213
114<a name="l00217"></a>00217 <span class="keyword">virtual</span> xmlNode* <a class="code" href="class_f_c_d_effect_profile.html#8195790d32e7dd4c430e05d7de1d6bed">WriteToXML</a>(xmlNode* parentNode)  <span class="keyword">const</span>;
115<a name="l00218"></a>00218 };
116<a name="l00219"></a>00219
117<a name="l00220"></a>00220 <span class="preprocessor">#endif // _FCD_EFFECT_PROFILE_H_</span>
118</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:38 2006 for FCollada by&nbsp;
119<a href="http://www.doxygen.org/index.html">
120<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
121</body>
122</html>
Note: See TracBrowser for help on using the repository browser.