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

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