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

Revision 964, 25.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: FCDEffectParameterList 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>FCDEffectParameterList 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="FCDEffectParameterList" --><!-- doxytag: inherits="vector&lt; FCDEffectParameter * &gt;,FCDObject" -->A searchable list of COLLADA effect parameters. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_effect_parameter_list_8h-source.html">FCDEffectParameterList.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDEffectParameterList:
33<p><center><img src="class_f_c_d_effect_parameter_list.png" usemap="#FCDEffectParameterList_map" border="0" alt=""></center>
34<map name="FCDEffectParameterList_map">
35<area href="classvector.html" alt="vector< FCDEffectParameter * >" shape="rect" coords="0,56,201,80">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="211,56,412,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="211,0,412,24">
38</map>
39<a href="class_f_c_d_effect_parameter_list-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_parameter_list.html#2bd56d5397103522645ef4119143bde6">FCDEffectParameterList</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document=NULL, bool ownParameters=false)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#2bd56d5397103522645ef4119143bde6"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f159ce775e961884978018133008713"></a><!-- doxytag: member="FCDEffectParameterList::~FCDEffectParameterList" ref="9f159ce775e961884978018133008713" args="()" -->
46virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_list.html#9f159ce775e961884978018133008713">~FCDEffectParameterList</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_list.html#da878b47cabf114c520fdf70bf252a2c">AddParameter</a> (uint32 type)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new parameters within this list.  <a href="#da878b47cabf114c520fdf70bf252a2c"></a><br></td></tr>
52<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_parameter_list.html#b5ef02e0d258871d25d75666e199a9f3">ReleaseParameter</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *parameter)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases a parameter contained within this list.  <a href="#b5ef02e0d258871d25d75666e199a9f3"></a><br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_list.html#eb6d1137e909f4daa3874754cc143cf4">FindReference</a> (const char *reference)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the first effect parameter with the given reference.  <a href="#eb6d1137e909f4daa3874754cc143cf4"></a><br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4a5d313e85d0d63e740e82adc87748d"></a><!-- doxytag: member="FCDEffectParameterList::FindReference" ref="c4a5d313e85d0d63e740e82adc87748d" args="(const char *reference) const " -->
59const <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_parameter_list.html#c4a5d313e85d0d63e740e82adc87748d">FindReference</a> (const char *reference) const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d065c4ff34a84c8b051f2830b4e52649"></a><!-- doxytag: member="FCDEffectParameterList::FindReference" ref="d065c4ff34a84c8b051f2830b4e52649" args="(const string &amp;reference)" -->
63<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_parameter_list.html#d065c4ff34a84c8b051f2830b4e52649">FindReference</a> (const string &amp;reference)</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"><a class="anchor" name="e120e358ddbbf44d8e0a22efec1be9b2"></a><!-- doxytag: member="FCDEffectParameterList::FindReference" ref="e120e358ddbbf44d8e0a22efec1be9b2" args="(const string &amp;reference) const " -->
67const <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_parameter_list.html#e120e358ddbbf44d8e0a22efec1be9b2">FindReference</a> (const string &amp;reference) 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"><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_parameter_list.html#e968bb73bc401d388414e89a8d0b90cf">FindSemantic</a> (const char *semantic)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the first effect parameter with the given semantic.  <a href="#e968bb73bc401d388414e89a8d0b90cf"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f74cdaa65fddde58bcbb0a4c906c9f9"></a><!-- doxytag: member="FCDEffectParameterList::FindSemantic" ref="1f74cdaa65fddde58bcbb0a4c906c9f9" args="(const char *semantic) const " -->
74const <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_parameter_list.html#1f74cdaa65fddde58bcbb0a4c906c9f9">FindSemantic</a> (const char *semantic) const </td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49cea675ac85846dacbeac3fccbe6236"></a><!-- doxytag: member="FCDEffectParameterList::FindSemantic" ref="49cea675ac85846dacbeac3fccbe6236" args="(const string &amp;semantic)" -->
78<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_parameter_list.html#49cea675ac85846dacbeac3fccbe6236">FindSemantic</a> (const string &amp;semantic)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ff36165a002fba4badd3e8acd462682"></a><!-- doxytag: member="FCDEffectParameterList::FindSemantic" ref="9ff36165a002fba4badd3e8acd462682" args="(const string &amp;semantic) const " -->
82const <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_parameter_list.html#9ff36165a002fba4badd3e8acd462682">FindSemantic</a> (const string &amp;semantic) const </td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
85<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_parameter_list.html#51ff1eb3d466e5a97ef7e980991c4764">FindReference</a> (const char *reference, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;list)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of this parameter list.  <a href="#51ff1eb3d466e5a97ef7e980991c4764"></a><br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40a7cf727c90ebda0b78684a07654b72"></a><!-- doxytag: member="FCDEffectParameterList::FindReference" ref="40a7cf727c90ebda0b78684a07654b72" args="(const string &amp;reference, FCDEffectParameterList &amp;list)" -->
89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_list.html#40a7cf727c90ebda0b78684a07654b72">FindReference</a> (const string &amp;reference, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;list)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
92<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_parameter_list.html#42cec4544f01918f9e5bcb3c1e5a25f4">FindSemantic</a> (const char *semantic, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;list)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a subset of this parameter list.  <a href="#42cec4544f01918f9e5bcb3c1e5a25f4"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68fa2e7d2f12c9faa2b70e08e2a61d78"></a><!-- doxytag: member="FCDEffectParameterList::FindSemantic" ref="68fa2e7d2f12c9faa2b70e08e2a61d78" args="(const string &amp;semantic, FCDEffectParameterList &amp;list)" -->
96void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_list.html#68fa2e7d2f12c9faa2b70e08e2a61d78">FindSemantic</a> (const string &amp;semantic, <a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;list)</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_parameter_list.html">FCDEffectParameterList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_list.html#af25dd4f94b73060788659d093c97453">Clone</a> () const </td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the list of parameters and its content.  <a href="#af25dd4f94b73060788659d093c97453"></a><br></td></tr>
102</table>
103<hr><a name="_details"></a><h2>Detailed Description</h2>
104A searchable list of COLLADA effect parameters.
105<p>
106This class is based on the STL vector class and adds some useful search methods: by reference and by semantic.
107<p>
108<hr><h2>Constructor &amp; Destructor Documentation</h2>
109<a class="anchor" name="2bd56d5397103522645ef4119143bde6"></a><!-- doxytag: member="FCDEffectParameterList::FCDEffectParameterList" ref="2bd56d5397103522645ef4119143bde6" args="(FCDocument *document=NULL, bool ownParameters=false)" --><p>
110<table class="mdTable" cellpadding="2" cellspacing="0">
111  <tr>
112    <td class="mdRow">
113      <table cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td class="md" nowrap valign="top">FCDEffectParameterList::FCDEffectParameterList           </td>
116          <td class="md" valign="top">(&nbsp;</td>
117          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
118          <td class="mdname" nowrap> <em>document</em> = <code>NULL</code>, </td>
119        </tr>
120        <tr>
121          <td class="md" nowrap align="right"></td>
122          <td class="md"></td>
123          <td class="md" nowrap>bool&nbsp;</td>
124          <td class="mdname" nowrap> <em>ownParameters</em> = <code>false</code></td>
125        </tr>
126        <tr>
127          <td class="md"></td>
128          <td class="md">)&nbsp;</td>
129          <td class="md" colspan="2"></td>
130        </tr>
131      </table>
132    </td>
133  </tr>
134</table>
135<table cellspacing="5" cellpadding="0" border="0">
136  <tr>
137    <td>
138      &nbsp;
139    </td>
140    <td>
141
142<p>
143Constructor.
144<p>
145All the objects that need a parameter list will create it when necessary. You may also create new lists for the retrieval of parameters during a search. <dl compact><dt><b>Parameters:</b></dt><dd>
146  <table border="0" cellspacing="2" cellpadding="0">
147    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns this parameter list. This pointer can remain NULL unless you expect to create new parameters within this list. </td></tr>
148    <tr><td valign="top"></td><td valign="top"><em>ownParameters</em>&nbsp;</td><td>Whether this list should release the contained parameters during its destruction. </td></tr>
149  </table>
150</dl>
151    </td>
152  </tr>
153</table>
154<hr><h2>Member Function Documentation</h2>
155<a class="anchor" name="da878b47cabf114c520fdf70bf252a2c"></a><!-- doxytag: member="FCDEffectParameterList::AddParameter" ref="da878b47cabf114c520fdf70bf252a2c" args="(uint32 type)" --><p>
156<table class="mdTable" cellpadding="2" cellspacing="0">
157  <tr>
158    <td class="mdRow">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterList::AddParameter           </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="md" nowrap valign="top">uint32&nbsp;</td>
164          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
165          <td class="md" valign="top">&nbsp;)&nbsp;</td>
166          <td class="md" nowrap></td>
167        </tr>
168      </table>
169    </td>
170  </tr>
171</table>
172<table cellspacing="5" cellpadding="0" border="0">
173  <tr>
174    <td>
175      &nbsp;
176    </td>
177    <td>
178
179<p>
180Creates a new parameters within this list.
181<p>
182<dl compact><dt><b>Parameters:</b></dt><dd>
183  <table border="0" cellspacing="2" cellpadding="0">
184    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The effect parameter type. </td></tr>
185  </table>
186</dl>
187<dl compact><dt><b>Returns:</b></dt><dd>The new effect parameter. This pointer will be NULL if this list does not own its parameters. </dd></dl>
188    </td>
189  </tr>
190</table>
191<a class="anchor" name="af25dd4f94b73060788659d093c97453"></a><!-- doxytag: member="FCDEffectParameterList::Clone" ref="af25dd4f94b73060788659d093c97453" args="() const " --><p>
192<table class="mdTable" cellpadding="2" cellspacing="0">
193  <tr>
194    <td class="mdRow">
195      <table cellpadding="0" cellspacing="0" border="0">
196        <tr>
197          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a>* FCDEffectParameterList::Clone           </td>
198          <td class="md" valign="top">(&nbsp;</td>
199          <td class="mdname1" valign="top" nowrap>          </td>
200          <td class="md" valign="top">&nbsp;)&nbsp;</td>
201          <td class="md" nowrap> const</td>
202        </tr>
203      </table>
204    </td>
205  </tr>
206</table>
207<table cellspacing="5" cellpadding="0" border="0">
208  <tr>
209    <td>
210      &nbsp;
211    </td>
212    <td>
213
214<p>
215Creates a full copy of the list of parameters and its content.
216<p>
217<dl compact><dt><b>Returns:</b></dt><dd>The cloned list. You will need to delete this pointer. </dd></dl>
218    </td>
219  </tr>
220</table>
221<a class="anchor" name="51ff1eb3d466e5a97ef7e980991c4764"></a><!-- doxytag: member="FCDEffectParameterList::FindReference" ref="51ff1eb3d466e5a97ef7e980991c4764" args="(const char *reference, FCDEffectParameterList &amp;list)" --><p>
222<table class="mdTable" cellpadding="2" cellspacing="0">
223  <tr>
224    <td class="mdRow">
225      <table cellpadding="0" cellspacing="0" border="0">
226        <tr>
227          <td class="md" nowrap valign="top">void FCDEffectParameterList::FindReference           </td>
228          <td class="md" valign="top">(&nbsp;</td>
229          <td class="md" nowrap valign="top">const char *&nbsp;</td>
230          <td class="mdname" nowrap> <em>reference</em>, </td>
231        </tr>
232        <tr>
233          <td class="md" nowrap align="right"></td>
234          <td class="md"></td>
235          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
236          <td class="mdname" nowrap> <em>list</em></td>
237        </tr>
238        <tr>
239          <td class="md"></td>
240          <td class="md">)&nbsp;</td>
241          <td class="md" colspan="2"></td>
242        </tr>
243      </table>
244    </td>
245  </tr>
246</table>
247<table cellspacing="5" cellpadding="0" border="0">
248  <tr>
249    <td>
250      &nbsp;
251    </td>
252    <td>
253
254<p>
255Retrieves a subset of this parameter list.
256<p>
257All the effects that match the given reference will be added to the given list. For effect parameter generators, the sub-id is used instead of the reference. <dl compact><dt><b>Parameters:</b></dt><dd>
258  <table border="0" cellspacing="2" cellpadding="0">
259    <tr><td valign="top"></td><td valign="top"><em>reference</em>&nbsp;</td><td>A reference to match. </td></tr>
260    <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>The effect parameter list to fill in with the matched parameters. This list is not clear. </td></tr>
261  </table>
262</dl>
263    </td>
264  </tr>
265</table>
266<a class="anchor" name="eb6d1137e909f4daa3874754cc143cf4"></a><!-- doxytag: member="FCDEffectParameterList::FindReference" ref="eb6d1137e909f4daa3874754cc143cf4" args="(const char *reference)" --><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"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterList::FindReference           </td>
273          <td class="md" valign="top">(&nbsp;</td>
274          <td class="md" nowrap valign="top">const char *&nbsp;</td>
275          <td class="mdname1" valign="top" nowrap> <em>reference</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>
291Retrieves the first effect parameter with the given reference.
292<p>
293For effect parameter generators, the sub-id is used instead of the reference. <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>reference</em>&nbsp;</td><td>A reference to match. </td></tr>
296  </table>
297</dl>
298<dl compact><dt><b>Returns:</b></dt><dd>The effect parameter that matches the reference. This pointer will be NULL, if no parameter matches the reference. </dd></dl>
299    </td>
300  </tr>
301</table>
302<a class="anchor" name="42cec4544f01918f9e5bcb3c1e5a25f4"></a><!-- doxytag: member="FCDEffectParameterList::FindSemantic" ref="42cec4544f01918f9e5bcb3c1e5a25f4" args="(const char *semantic, FCDEffectParameterList &amp;list)" --><p>
303<table class="mdTable" cellpadding="2" cellspacing="0">
304  <tr>
305    <td class="mdRow">
306      <table cellpadding="0" cellspacing="0" border="0">
307        <tr>
308          <td class="md" nowrap valign="top">void FCDEffectParameterList::FindSemantic           </td>
309          <td class="md" valign="top">(&nbsp;</td>
310          <td class="md" nowrap valign="top">const char *&nbsp;</td>
311          <td class="mdname" nowrap> <em>semantic</em>, </td>
312        </tr>
313        <tr>
314          <td class="md" nowrap align="right"></td>
315          <td class="md"></td>
316          <td class="md" nowrap><a class="el" href="class_f_c_d_effect_parameter_list.html">FCDEffectParameterList</a> &amp;&nbsp;</td>
317          <td class="mdname" nowrap> <em>list</em></td>
318        </tr>
319        <tr>
320          <td class="md"></td>
321          <td class="md">)&nbsp;</td>
322          <td class="md" colspan="2"></td>
323        </tr>
324      </table>
325    </td>
326  </tr>
327</table>
328<table cellspacing="5" cellpadding="0" border="0">
329  <tr>
330    <td>
331      &nbsp;
332    </td>
333    <td>
334
335<p>
336Retrieves a subset of this parameter list.
337<p>
338All the effects that match the given semantic will be added to the given list. <dl compact><dt><b>Parameters:</b></dt><dd>
339  <table border="0" cellspacing="2" cellpadding="0">
340    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>A semantic to match. </td></tr>
341    <tr><td valign="top"></td><td valign="top"><em>list</em>&nbsp;</td><td>The effect parameter list to fill in with the matched parameters. This list is not clear. </td></tr>
342  </table>
343</dl>
344    </td>
345  </tr>
346</table>
347<a class="anchor" name="e968bb73bc401d388414e89a8d0b90cf"></a><!-- doxytag: member="FCDEffectParameterList::FindSemantic" ref="e968bb73bc401d388414e89a8d0b90cf" args="(const char *semantic)" --><p>
348<table class="mdTable" cellpadding="2" cellspacing="0">
349  <tr>
350    <td class="mdRow">
351      <table cellpadding="0" cellspacing="0" border="0">
352        <tr>
353          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterList::FindSemantic           </td>
354          <td class="md" valign="top">(&nbsp;</td>
355          <td class="md" nowrap valign="top">const char *&nbsp;</td>
356          <td class="mdname1" valign="top" nowrap> <em>semantic</em>          </td>
357          <td class="md" valign="top">&nbsp;)&nbsp;</td>
358          <td class="md" nowrap></td>
359        </tr>
360      </table>
361    </td>
362  </tr>
363</table>
364<table cellspacing="5" cellpadding="0" border="0">
365  <tr>
366    <td>
367      &nbsp;
368    </td>
369    <td>
370
371<p>
372Retrieves the first effect parameter with the given semantic.
373<p>
374<dl compact><dt><b>Parameters:</b></dt><dd>
375  <table border="0" cellspacing="2" cellpadding="0">
376    <tr><td valign="top"></td><td valign="top"><em>semantic</em>&nbsp;</td><td>A semantic to match. </td></tr>
377  </table>
378</dl>
379<dl compact><dt><b>Returns:</b></dt><dd>The effect parameter that matches the semantic. This pointer will be NULL if no parameter matches the semantic. </dd></dl>
380    </td>
381  </tr>
382</table>
383<a class="anchor" name="b5ef02e0d258871d25d75666e199a9f3"></a><!-- doxytag: member="FCDEffectParameterList::ReleaseParameter" ref="b5ef02e0d258871d25d75666e199a9f3" args="(FCDEffectParameter *parameter)" --><p>
384<table class="mdTable" cellpadding="2" cellspacing="0">
385  <tr>
386    <td class="mdRow">
387      <table cellpadding="0" cellspacing="0" border="0">
388        <tr>
389          <td class="md" nowrap valign="top">void FCDEffectParameterList::ReleaseParameter           </td>
390          <td class="md" valign="top">(&nbsp;</td>
391          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td>
392          <td class="mdname1" valign="top" nowrap> <em>parameter</em>          </td>
393          <td class="md" valign="top">&nbsp;)&nbsp;</td>
394          <td class="md" nowrap></td>
395        </tr>
396      </table>
397    </td>
398  </tr>
399</table>
400<table cellspacing="5" cellpadding="0" border="0">
401  <tr>
402    <td>
403      &nbsp;
404    </td>
405    <td>
406
407<p>
408Releases a parameter contained within this list.
409<p>
410The memory used by this parameter will be released only if this list owns the parameters. <dl compact><dt><b>Parameters:</b></dt><dd>
411  <table border="0" cellspacing="2" cellpadding="0">
412    <tr><td valign="top"></td><td valign="top"><em>parameter</em>&nbsp;</td><td>The effect parameter to release. </td></tr>
413  </table>
414</dl>
415    </td>
416  </tr>
417</table>
418<hr>The documentation for this class was generated from the following file:<ul>
419<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_list_8h-source.html">FCDEffectParameterList.h</a></ul>
420<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
421<a href="http://www.doxygen.org/index.html">
422<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
423</body>
424</html>
Note: See TracBrowser for help on using the repository browser.