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

Revision 964, 13.2 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: FCDocument/FCDEffect.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/FCDEffect.h</h1><a href="_f_c_d_effect_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_H_</span>
34<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _FCD_EFFECT_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_entity_8h.html">FCDocument/FCDEntity.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_standard.html">FCDEffectStandard</a>;
41<a name="l00025"></a>00025 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>;
42<a name="l00026"></a>00026 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>;
43<a name="l00027"></a>00027 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>;
44<a name="l00028"></a>00028
45<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>;
46<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>;
47<a name="l00035"></a><a class="code" href="_f_c_d_effect_8h.html#2b1e5744b88b3dba2c5ec9912262c1a8">00035</a> <span class="keyword">class </span><a class="code" href="class_f_c_d_image.html">FCDImage</a>;
48<a name="l00036"></a>00036
49<a name="l00038"></a>00038 <span class="keyword">typedef</span> <a class="code" href="classvector.html">vector&lt;FCDEffectProfile*&gt;</a> <a class="code" href="classvector.html">FCDEffectProfileList</a>;
50<a name="l00039"></a>00039 <span class="keyword">typedef</span> <a class="code" href="classvector.html">vector&lt;FCDImage*&gt;</a> <a class="code" href="classvector.html">FCDEffectImageList</a>;
51<a name="l00040"></a>00040
52<a name="l00055"></a><a class="code" href="class_f_c_d_effect.html">00055</a> <span class="keyword">class </span>FCOLLADA_EXPORT <a class="code" href="class_f_c_d_effect.html">FCDEffect</a> : <span class="keyword">public</span> <a class="code" href="class_f_c_d_entity.html">FCDEntity</a>
53<a name="l00056"></a>00056 {
54<a name="l00057"></a>00057 <span class="keyword">private</span>:
55<a name="l00058"></a>00058     <a class="code" href="_f_u_object_type_8h.html#8124b8a8706cd10260f8cd5a7bd8e691">DeclareObjectType</a>;
56<a name="l00059"></a>00059 <a class="code" href="classvector.html">FCDEffectProfileList</a> profiles;
57<a name="l00060"></a>00060     <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* parameters;
58<a name="l00061"></a>00061 <a class="code" href="classvector.html">FCDEffectImageList</a> images;
59<a name="l00062"></a>00062
60<a name="l00063"></a>00063 <span class="keyword">public</span>:
61<a name="l00067"></a>00067     <a class="code" href="class_f_c_d_effect.html">FCDEffect</a>(<a class="code" href="class_f_c_document.html">FCDocument</a>* document);
62<a name="l00068"></a>00068
63<a name="l00071"></a>00071 <span class="keyword">virtual</span> ~<a class="code" href="class_f_c_d_effect.html">FCDEffect</a>();
64<a name="l00072"></a>00072
65<a name="l00076"></a><a class="code" href="class_f_c_d_effect.html#b6106f67f33a4cb049ea17a1970bbfbe">00076</a>     <span class="keyword">virtual</span> Type <a class="code" href="class_f_c_d_entity.html#bfd4312a7124f92364c1e6517c7e60ba">GetType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd725776f0c3122d297fd3b6026618d50af">FCDEntity::EFFECT</a>; }
66<a name="l00077"></a>00077
67<a name="l00080"></a><a class="code" href="class_f_c_d_effect.html#07ca7c378d3ecf158beefe5ba35143ae">00080</a>     size_t GetProfileCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> profiles.size(); }
68<a name="l00081"></a>00081
69<a name="l00085"></a><a class="code" href="class_f_c_d_effect.html#22c8dc9f098387eaa2ffb6a66aceb22d">00085</a>     <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* GetProfile(size_t index) { <a class="code" href="_f_u_assert_8h.html#72b8444eb608787f1db6bf1d53e0310f">FUAssert</a>(index &lt; GetProfileCount(), <span class="keywordflow">return</span> NULL); <span class="keywordflow">return</span> profiles.at(index); }
70<a name="l00086"></a><a class="code" href="class_f_c_d_effect.html#ad9b921743685b02b847d30670dc1631">00086</a>     <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* GetProfile(size_t index)<span class="keyword"> const </span>{ <a class="code" href="_f_u_assert_8h.html#72b8444eb608787f1db6bf1d53e0310f">FUAssert</a>(index &lt; GetProfileCount(), <span class="keywordflow">return</span> NULL); <span class="keywordflow">return</span> profiles.at(index); }
71<a name="l00090"></a><a class="code" href="class_f_c_d_effect.html#c0747106831338b4d29c2218cdc4ea41">00090</a>     <a class="code" href="classvector.html">FCDEffectProfileList</a>&amp; GetProfiles() { <span class="keywordflow">return</span> profiles; }
72<a name="l00091"></a><a class="code" href="class_f_c_d_effect.html#ce9cfa3581996cfee41b7bdba642bd09">00091</a>     <span class="keyword">const</span> <a class="code" href="classvector.html">FCDEffectProfileList</a>&amp; GetProfiles()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> profiles; }
73<a name="l00099"></a>00099 <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FindProfile(<a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type);
74<a name="l00100"></a>00100 <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FindProfile(<a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type) <span class="keyword">const</span>;
75<a name="l00108"></a>00108 <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FindProfileByTypeAndPlatform(<a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type, string platform);
76<a name="l00109"></a>00109 <span class="keyword">const</span> <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* FindProfileByTypeAndPlatform(<a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type, string platform) <span class="keyword">const</span>;
77<a name="l00114"></a><a class="code" href="class_f_c_d_effect.html#0e210e70a9933fc89f314747edbb3bf5">00114</a>     <span class="keyword">inline</span> <span class="keywordtype">bool</span> HasProfile(<a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> FindProfile(type) != NULL; }
78<a name="l00115"></a>00115
79<a name="l00121"></a>00121 <a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* AddProfile(<a class="code" href="namespace_f_u_dae_profile_type.html#c10ea253a7a141708de2324a929f8a79">FUDaeProfileType::Type</a> type);
80<a name="l00122"></a>00122
81<a name="l00125"></a>00125 <span class="keywordtype">void</span> ReleaseProfile(<a class="code" href="class_f_c_d_effect_profile.html">FCDEffectProfile</a>* profile);
82<a name="l00126"></a>00126
83<a name="l00131"></a><a class="code" href="class_f_c_d_effect.html#d2697612710ba73b740295bbfe9b0460">00131</a>     <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* GetParameters() { <span class="keywordflow">return</span> parameters; }
84<a name="l00132"></a><a class="code" href="class_f_c_d_effect.html#70eb725ca915b2db107adb655dcf6d2e">00132</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; }
85<a name="l00137"></a>00137 <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);
86<a name="l00138"></a>00138
87<a name="l00145"></a>00145 <a class="code" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FindParameterBySemantic(<span class="keyword">const</span> string&amp; semantic);
88<a name="l00146"></a>00146
89<a name="l00152"></a>00152 <span class="keywordtype">void</span> FindParametersBySemantic(<span class="keyword">const</span> string&amp; semantic, <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>&amp; parameters);
90<a name="l00153"></a>00153
91<a name="l00160"></a>00160 <span class="keywordtype">void</span> FindParametersByReference(<span class="keyword">const</span> string&amp; reference, <a class="code" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>&amp; parameters);
92<a name="l00161"></a>00161
93<a name="l00165"></a>00165     <a class="code" href="class_f_c_d_effect.html">FCDEffect</a>* <a class="code" href="class_f_c_d_entity.html#c1d7dc557e79f42de2b9f951ff3cffcc">Clone</a>();
94<a name="l00166"></a>00166
95<a name="l00170"></a>00170 <span class="keywordtype">void</span> Flatten();
96<a name="l00171"></a>00171
97<a name="l00176"></a>00176 <span class="keyword">virtual</span> <a class="code" href="class_f_u_status.html">FUStatus</a> <a class="code" href="class_f_c_d_entity.html#8e32fcc93de76acc4b606db7b5b83890">LoadFromXML</a>(xmlNode* effectNode);
98<a name="l00177"></a>00177
99<a name="l00181"></a>00181 <span class="keyword">virtual</span> xmlNode* <a class="code" href="class_f_c_d_entity.html#b27f0c175c3f8fd7064cde48bcf1d7a0">WriteToXML</a>(xmlNode* parentNode) <span class="keyword">const</span>;
100<a name="l00182"></a>00182     
101<a name="l00185"></a><a class="code" href="class_f_c_d_effect.html#dbd68f8cc11b71dc5555f6cb2e32e612">00185</a>     <a class="code" href="classvector.html">FCDEffectImageList</a>&amp; GetImages() { <span class="keywordflow">return</span> images; }
102<a name="l00186"></a><a class="code" href="class_f_c_d_effect.html#f287708997fceaadeda671c1be783f04">00186</a>     <span class="keyword">const</span> <a class="code" href="classvector.html">FCDEffectImageList</a>&amp; GetImages()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> images; }
103<a name="l00187"></a>00187 };
104<a name="l00188"></a>00188
105<a name="l00189"></a>00189 <span class="preprocessor">#endif // _FCD_MATERIAL_H_</span>
106</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:38 2006 for FCollada by&nbsp;
107<a href="http://www.doxygen.org/index.html">
108<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
109</body>
110</html>
Note: See TracBrowser for help on using the repository browser.