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

Revision 964, 28.9 KB checked in by igarcia, 18 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FCDEffectParameterFloat2 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>FCDEffectParameterFloat2 Class Reference</h1><!-- doxytag: class="FCDEffectParameterFloat2" --><!-- doxytag: inherits="FCDEffectParameter" -->A COLLADA 2D vector of floats. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDEffectParameterFloat2:
30<p><center><img src="class_f_c_d_effect_parameter_float2.png" usemap="#FCDEffectParameterFloat2_map" border="0" alt=""></center>
31<map name="FCDEffectParameterFloat2_map">
32<area href="class_f_c_d_effect_parameter.html" alt="FCDEffectParameter" shape="rect" coords="0,112,164,136">
33<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,164,80">
34<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,164,24">
35</map>
36<a href="class_f_c_d_effect_parameter_float2-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
37<tr><td></td></tr>
38<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
39<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed5286041">FloatType</a> { <a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed52860419a9bc716e56752d047fee23fab4f2819">FLOAT</a>,
40<a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed52860418d39c7292c69594cbf290d0ad8a2a41c">HALF</a>
41 }</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The supported types of float-point values.  <a href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed5286041">More...</a><br></td></tr>
44<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
45<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_float2.html#b66aadb652406d6b5bcc651304be50ce">FCDEffectParameterFloat2</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#b66aadb652406d6b5bcc651304be50ce"></a><br></td></tr>
48<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_parameter_float2.html#5d90d02010869f7eba404efee1b97ff2">~FCDEffectParameterFloat2</a> ()</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#5d90d02010869f7eba404efee1b97ff2"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#ffc19911b3553e8a495004123b1df4aa">GetType</a> () const </td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type of effect parameter class.  <a href="#ffc19911b3553e8a495004123b1df4aa"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed5286041">FloatType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#96d127825bdb339605985bbc4038f084">GetFloatType</a> () const </td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type of floating-point value held by this effect parameter.  <a href="#96d127825bdb339605985bbc4038f084"></a><br></td></tr>
57<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_float2.html#2e78f91c6b7e9d163e24d1c35f6fac51">SetFloatType</a> (<a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed5286041">FloatType</a> type)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the type of floating-point value held by this effect parameter.  <a href="#2e78f91c6b7e9d163e24d1c35f6fac51"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#991fa2c00cfaa0fcd1ba896d95fcd685">GetValueX</a> ()</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the first floating-point value of the effect parameter.  <a href="#991fa2c00cfaa0fcd1ba896d95fcd685"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0921239eb33a8daa8a3c04e1e206072"></a><!-- doxytag: member="FCDEffectParameterFloat2::GetValueX" ref="e0921239eb33a8daa8a3c04e1e206072" args="() const " -->
64const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#e0921239eb33a8daa8a3c04e1e206072">GetValueX</a> () const </td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
67<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_float2.html#dc9db3c8ea7d2dbbcde7d81b8ce9f45e">SetValueX</a> (float value)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the first floating-point value of the effect parameter.  <a href="#dc9db3c8ea7d2dbbcde7d81b8ce9f45e"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#3c4661be7f1039cdbf98d2784d996a8b">GetValueY</a> ()</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the second floating-point value of the effect parameter.  <a href="#3c4661be7f1039cdbf98d2784d996a8b"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9431e6e2c0a11d8875c11123856b738"></a><!-- doxytag: member="FCDEffectParameterFloat2::GetValueY" ref="d9431e6e2c0a11d8875c11123856b738" args="() const " -->
74const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#d9431e6e2c0a11d8875c11123856b738">GetValueY</a> () 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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#037c036e879e5201f8f05b99b26f286f">SetValueY</a> (float value)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the second floating-point value of the effect parameter.  <a href="#037c036e879e5201f8f05b99b26f286f"></a><br></td></tr>
80<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_parameter_float2.html#f1bac59327d3094462b54e83969f24b7">Clone</a> ()</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the effect parameter.  <a href="#f1bac59327d3094462b54e83969f24b7"></a><br></td></tr>
83<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_parameter_float2.html#58a396a94b4c6e5a63894d044ef83c32">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter.  <a href="#58a396a94b4c6e5a63894d044ef83c32"></a><br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#ae5130f0993b455533fdbf0016663802">LoadFromXML</a> (xmlNode *parameterNode)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.  <a href="#ae5130f0993b455533fdbf0016663802"></a><br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float2.html#55d8ee98e2e41fada0e024f9bdae56a6">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.  <a href="#55d8ee98e2e41fada0e024f9bdae56a6"></a><br></td></tr>
92</table>
93<hr><a name="_details"></a><h2>Detailed Description</h2>
94A COLLADA 2D vector of floats.
95<p>
96Contains two, possibly animated, floating-point values. The type of the floating-point values may be HALF or FLOAT.
97<p>
98<hr><h2>Member Enumeration Documentation</h2>
99<a class="anchor" name="77e4ebdfcf0de9efb879c02ed5286041"></a><!-- doxytag: member="FCDEffectParameterFloat2::FloatType" ref="77e4ebdfcf0de9efb879c02ed5286041" args="" --><p>
100<table class="mdTable" cellpadding="2" cellspacing="0">
101  <tr>
102    <td class="mdRow">
103      <table cellpadding="0" cellspacing="0" border="0">
104        <tr>
105          <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed5286041">FCDEffectParameterFloat2::FloatType</a>          </td>
106        </tr>
107      </table>
108    </td>
109  </tr>
110</table>
111<table cellspacing="5" cellpadding="0" border="0">
112  <tr>
113    <td>
114      &nbsp;
115    </td>
116    <td>
117
118<p>
119The supported types of float-point values.
120<p>
121<dl compact><dt><b>Enumerator: </b></dt><dd>
122<table border="0" cellspacing="2" cellpadding="0">
123<tr><td valign="top"><em><a class="anchor" name="77e4ebdfcf0de9efb879c02ed52860419a9bc716e56752d047fee23fab4f2819"></a><!-- doxytag: member="FLOAT" ref="77e4ebdfcf0de9efb879c02ed52860419a9bc716e56752d047fee23fab4f2819" args="" -->FLOAT</em>&nbsp;</td><td>
124A single floating-pointer value effect parameter. </td></tr>
125<tr><td valign="top"><em><a class="anchor" name="77e4ebdfcf0de9efb879c02ed52860418d39c7292c69594cbf290d0ad8a2a41c"></a><!-- doxytag: member="HALF" ref="77e4ebdfcf0de9efb879c02ed52860418d39c7292c69594cbf290d0ad8a2a41c" args="" -->HALF</em>&nbsp;</td><td>
126Probably implies a 16-bit floating-point value. </td></tr>
127</table>
128</dl>
129    </td>
130  </tr>
131</table>
132<hr><h2>Constructor &amp; Destructor Documentation</h2>
133<a class="anchor" name="b66aadb652406d6b5bcc651304be50ce"></a><!-- doxytag: member="FCDEffectParameterFloat2::FCDEffectParameterFloat2" ref="b66aadb652406d6b5bcc651304be50ce" args="(FCDocument *document)" --><p>
134<table class="mdTable" cellpadding="2" cellspacing="0">
135  <tr>
136    <td class="mdRow">
137      <table cellpadding="0" cellspacing="0" border="0">
138        <tr>
139          <td class="md" nowrap valign="top">FCDEffectParameterFloat2::FCDEffectParameterFloat2           </td>
140          <td class="md" valign="top">(&nbsp;</td>
141          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
142          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
143          <td class="md" valign="top">&nbsp;)&nbsp;</td>
144          <td class="md" nowrap></td>
145        </tr>
146      </table>
147    </td>
148  </tr>
149</table>
150<table cellspacing="5" cellpadding="0" border="0">
151  <tr>
152    <td>
153      &nbsp;
154    </td>
155    <td>
156
157<p>
158Constructor: do not use directly.
159<p>
160Instead, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#da878b47cabf114c520fdf70bf252a2c">FCDEffectParameterList::AddParameter</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
161  <table border="0" cellspacing="2" cellpadding="0">
162    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the effect parameter. </td></tr>
163  </table>
164</dl>
165    </td>
166  </tr>
167</table>
168<a class="anchor" name="5d90d02010869f7eba404efee1b97ff2"></a><!-- doxytag: member="FCDEffectParameterFloat2::~FCDEffectParameterFloat2" ref="5d90d02010869f7eba404efee1b97ff2" args="()" --><p>
169<table class="mdTable" cellpadding="2" cellspacing="0">
170  <tr>
171    <td class="mdRow">
172      <table cellpadding="0" cellspacing="0" border="0">
173        <tr>
174          <td class="md" nowrap valign="top">virtual FCDEffectParameterFloat2::~FCDEffectParameterFloat2           </td>
175          <td class="md" valign="top">(&nbsp;</td>
176          <td class="mdname1" valign="top" nowrap>          </td>
177          <td class="md" valign="top">&nbsp;)&nbsp;</td>
178          <td class="md" nowrap><code> [virtual]</code></td>
179        </tr>
180      </table>
181    </td>
182  </tr>
183</table>
184<table cellspacing="5" cellpadding="0" border="0">
185  <tr>
186    <td>
187      &nbsp;
188    </td>
189    <td>
190
191<p>
192Destructor: do not use directly.
193<p>
194Instead, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#b5ef02e0d258871d25d75666e199a9f3">FCDEffectParameterList::ReleaseParameter</a> function. When released, the effect parameter list will also release all its parameters, if it owns them.     </td>
195  </tr>
196</table>
197<hr><h2>Member Function Documentation</h2>
198<a class="anchor" name="f1bac59327d3094462b54e83969f24b7"></a><!-- doxytag: member="FCDEffectParameterFloat2::Clone" ref="f1bac59327d3094462b54e83969f24b7" args="()" --><p>
199<table class="mdTable" cellpadding="2" cellspacing="0">
200  <tr>
201    <td class="mdRow">
202      <table cellpadding="0" cellspacing="0" border="0">
203        <tr>
204          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterFloat2::Clone           </td>
205          <td class="md" valign="top">(&nbsp;</td>
206          <td class="mdname1" valign="top" nowrap>          </td>
207          <td class="md" valign="top">&nbsp;)&nbsp;</td>
208          <td class="md" nowrap><code> [virtual]</code></td>
209        </tr>
210      </table>
211    </td>
212  </tr>
213</table>
214<table cellspacing="5" cellpadding="0" border="0">
215  <tr>
216    <td>
217      &nbsp;
218    </td>
219    <td>
220
221<p>
222Creates a full copy of the effect parameter.
223<p>
224<dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl>
225
226<p>
227Implements <a class="el" href="class_f_c_d_effect_parameter.html#760f178513367b602f7c3363a158b76e">FCDEffectParameter</a>.    </td>
228  </tr>
229</table>
230<a class="anchor" name="96d127825bdb339605985bbc4038f084"></a><!-- doxytag: member="FCDEffectParameterFloat2::GetFloatType" ref="96d127825bdb339605985bbc4038f084" args="() const " --><p>
231<table class="mdTable" cellpadding="2" cellspacing="0">
232  <tr>
233    <td class="mdRow">
234      <table cellpadding="0" cellspacing="0" border="0">
235        <tr>
236          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed5286041">FloatType</a> FCDEffectParameterFloat2::GetFloatType           </td>
237          <td class="md" valign="top">(&nbsp;</td>
238          <td class="mdname1" valign="top" nowrap>          </td>
239          <td class="md" valign="top">&nbsp;)&nbsp;</td>
240          <td class="md" nowrap> const<code> [inline]</code></td>
241        </tr>
242      </table>
243    </td>
244  </tr>
245</table>
246<table cellspacing="5" cellpadding="0" border="0">
247  <tr>
248    <td>
249      &nbsp;
250    </td>
251    <td>
252
253<p>
254Retrieves the type of floating-point value held by this effect parameter.
255<p>
256<dl compact><dt><b>Returns:</b></dt><dd>The type of floating-point value. </dd></dl>
257    </td>
258  </tr>
259</table>
260<a class="anchor" name="ffc19911b3553e8a495004123b1df4aa"></a><!-- doxytag: member="FCDEffectParameterFloat2::GetType" ref="ffc19911b3553e8a495004123b1df4aa" args="() const " --><p>
261<table class="mdTable" cellpadding="2" cellspacing="0">
262  <tr>
263    <td class="mdRow">
264      <table cellpadding="0" cellspacing="0" border="0">
265        <tr>
266          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> FCDEffectParameterFloat2::GetType           </td>
267          <td class="md" valign="top">(&nbsp;</td>
268          <td class="mdname1" valign="top" nowrap>          </td>
269          <td class="md" valign="top">&nbsp;)&nbsp;</td>
270          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
271        </tr>
272      </table>
273    </td>
274  </tr>
275</table>
276<table cellspacing="5" cellpadding="0" border="0">
277  <tr>
278    <td>
279      &nbsp;
280    </td>
281    <td>
282
283<p>
284Retrieves the type of effect parameter class.
285<p>
286<dl compact><dt><b>Returns:</b></dt><dd>The parameter class type: FLOAT2. </dd></dl>
287
288<p>
289Implements <a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">FCDEffectParameter</a>.    </td>
290  </tr>
291</table>
292<a class="anchor" name="991fa2c00cfaa0fcd1ba896d95fcd685"></a><!-- doxytag: member="FCDEffectParameterFloat2::GetValueX" ref="991fa2c00cfaa0fcd1ba896d95fcd685" args="()" --><p>
293<table class="mdTable" cellpadding="2" cellspacing="0">
294  <tr>
295    <td class="mdRow">
296      <table cellpadding="0" cellspacing="0" border="0">
297        <tr>
298          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterFloat2::GetValueX           </td>
299          <td class="md" valign="top">(&nbsp;</td>
300          <td class="mdname1" valign="top" nowrap>          </td>
301          <td class="md" valign="top">&nbsp;)&nbsp;</td>
302          <td class="md" nowrap><code> [inline]</code></td>
303        </tr>
304      </table>
305    </td>
306  </tr>
307</table>
308<table cellspacing="5" cellpadding="0" border="0">
309  <tr>
310    <td>
311      &nbsp;
312    </td>
313    <td>
314
315<p>
316Retrieves the first floating-point value of the effect parameter.
317<p>
318<dl compact><dt><b>Returns:</b></dt><dd>The first floating-point value. </dd></dl>
319    </td>
320  </tr>
321</table>
322<a class="anchor" name="3c4661be7f1039cdbf98d2784d996a8b"></a><!-- doxytag: member="FCDEffectParameterFloat2::GetValueY" ref="3c4661be7f1039cdbf98d2784d996a8b" args="()" --><p>
323<table class="mdTable" cellpadding="2" cellspacing="0">
324  <tr>
325    <td class="mdRow">
326      <table cellpadding="0" cellspacing="0" border="0">
327        <tr>
328          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterFloat2::GetValueY           </td>
329          <td class="md" valign="top">(&nbsp;</td>
330          <td class="mdname1" valign="top" nowrap>          </td>
331          <td class="md" valign="top">&nbsp;)&nbsp;</td>
332          <td class="md" nowrap><code> [inline]</code></td>
333        </tr>
334      </table>
335    </td>
336  </tr>
337</table>
338<table cellspacing="5" cellpadding="0" border="0">
339  <tr>
340    <td>
341      &nbsp;
342    </td>
343    <td>
344
345<p>
346Retrieves the second floating-point value of the effect parameter.
347<p>
348<dl compact><dt><b>Returns:</b></dt><dd>The second floating-point value. </dd></dl>
349    </td>
350  </tr>
351</table>
352<a class="anchor" name="ae5130f0993b455533fdbf0016663802"></a><!-- doxytag: member="FCDEffectParameterFloat2::LoadFromXML" ref="ae5130f0993b455533fdbf0016663802" args="(xmlNode *parameterNode)" --><p>
353<table class="mdTable" cellpadding="2" cellspacing="0">
354  <tr>
355    <td class="mdRow">
356      <table cellpadding="0" cellspacing="0" border="0">
357        <tr>
358          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameterFloat2::LoadFromXML           </td>
359          <td class="md" valign="top">(&nbsp;</td>
360          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
361          <td class="mdname1" valign="top" nowrap> <em>parameterNode</em>          </td>
362          <td class="md" valign="top">&nbsp;)&nbsp;</td>
363          <td class="md" nowrap><code> [virtual]</code></td>
364        </tr>
365      </table>
366    </td>
367  </tr>
368</table>
369<table cellspacing="5" cellpadding="0" border="0">
370  <tr>
371    <td>
372      &nbsp;
373    </td>
374    <td>
375
376<p>
377[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.
378<p>
379<dl compact><dt><b>Parameters:</b></dt><dd>
380  <table border="0" cellspacing="2" cellpadding="0">
381    <tr><td valign="top"></td><td valign="top"><em>parameterNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
382  </table>
383</dl>
384<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 parameter. </dd></dl>
385
386<p>
387Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">FCDEffectParameter</a>.    </td>
388  </tr>
389</table>
390<a class="anchor" name="58a396a94b4c6e5a63894d044ef83c32"></a><!-- doxytag: member="FCDEffectParameterFloat2::Overwrite" ref="58a396a94b4c6e5a63894d044ef83c32" args="(FCDEffectParameter *target)" --><p>
391<table class="mdTable" cellpadding="2" cellspacing="0">
392  <tr>
393    <td class="mdRow">
394      <table cellpadding="0" cellspacing="0" border="0">
395        <tr>
396          <td class="md" nowrap valign="top">virtual void FCDEffectParameterFloat2::Overwrite           </td>
397          <td class="md" valign="top">(&nbsp;</td>
398          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td>
399          <td class="mdname1" valign="top" nowrap> <em>target</em>          </td>
400          <td class="md" valign="top">&nbsp;)&nbsp;</td>
401          <td class="md" nowrap><code> [virtual]</code></td>
402        </tr>
403      </table>
404    </td>
405  </tr>
406</table>
407<table cellspacing="5" cellpadding="0" border="0">
408  <tr>
409    <td>
410      &nbsp;
411    </td>
412    <td>
413
414<p>
415[INTERNAL] Overwrites the target parameter with this parameter.
416<p>
417This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd>
418  <table border="0" cellspacing="2" cellpadding="0">
419    <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The target parameter to overwrite. </td></tr>
420  </table>
421</dl>
422
423<p>
424Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">FCDEffectParameter</a>.    </td>
425  </tr>
426</table>
427<a class="anchor" name="2e78f91c6b7e9d163e24d1c35f6fac51"></a><!-- doxytag: member="FCDEffectParameterFloat2::SetFloatType" ref="2e78f91c6b7e9d163e24d1c35f6fac51" args="(FloatType type)" --><p>
428<table class="mdTable" cellpadding="2" cellspacing="0">
429  <tr>
430    <td class="mdRow">
431      <table cellpadding="0" cellspacing="0" border="0">
432        <tr>
433          <td class="md" nowrap valign="top">void FCDEffectParameterFloat2::SetFloatType           </td>
434          <td class="md" valign="top">(&nbsp;</td>
435          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_float2.html#77e4ebdfcf0de9efb879c02ed5286041">FloatType</a>&nbsp;</td>
436          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
437          <td class="md" valign="top">&nbsp;)&nbsp;</td>
438          <td class="md" nowrap><code> [inline]</code></td>
439        </tr>
440      </table>
441    </td>
442  </tr>
443</table>
444<table cellspacing="5" cellpadding="0" border="0">
445  <tr>
446    <td>
447      &nbsp;
448    </td>
449    <td>
450
451<p>
452Sets the type of floating-point value held by this effect parameter.
453<p>
454<dl compact><dt><b>Parameters:</b></dt><dd>
455  <table border="0" cellspacing="2" cellpadding="0">
456    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The type of floating-point value. </td></tr>
457  </table>
458</dl>
459    </td>
460  </tr>
461</table>
462<a class="anchor" name="dc9db3c8ea7d2dbbcde7d81b8ce9f45e"></a><!-- doxytag: member="FCDEffectParameterFloat2::SetValueX" ref="dc9db3c8ea7d2dbbcde7d81b8ce9f45e" args="(float value)" --><p>
463<table class="mdTable" cellpadding="2" cellspacing="0">
464  <tr>
465    <td class="mdRow">
466      <table cellpadding="0" cellspacing="0" border="0">
467        <tr>
468          <td class="md" nowrap valign="top">void FCDEffectParameterFloat2::SetValueX           </td>
469          <td class="md" valign="top">(&nbsp;</td>
470          <td class="md" nowrap valign="top">float&nbsp;</td>
471          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
472          <td class="md" valign="top">&nbsp;)&nbsp;</td>
473          <td class="md" nowrap><code> [inline]</code></td>
474        </tr>
475      </table>
476    </td>
477  </tr>
478</table>
479<table cellspacing="5" cellpadding="0" border="0">
480  <tr>
481    <td>
482      &nbsp;
483    </td>
484    <td>
485
486<p>
487Sets the first floating-point value of the effect parameter.
488<p>
489<dl compact><dt><b>Parameters:</b></dt><dd>
490  <table border="0" cellspacing="2" cellpadding="0">
491    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The first floating-point value. </td></tr>
492  </table>
493</dl>
494    </td>
495  </tr>
496</table>
497<a class="anchor" name="037c036e879e5201f8f05b99b26f286f"></a><!-- doxytag: member="FCDEffectParameterFloat2::SetValueY" ref="037c036e879e5201f8f05b99b26f286f" args="(float value)" --><p>
498<table class="mdTable" cellpadding="2" cellspacing="0">
499  <tr>
500    <td class="mdRow">
501      <table cellpadding="0" cellspacing="0" border="0">
502        <tr>
503          <td class="md" nowrap valign="top">void FCDEffectParameterFloat2::SetValueY           </td>
504          <td class="md" valign="top">(&nbsp;</td>
505          <td class="md" nowrap valign="top">float&nbsp;</td>
506          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
507          <td class="md" valign="top">&nbsp;)&nbsp;</td>
508          <td class="md" nowrap><code> [inline]</code></td>
509        </tr>
510      </table>
511    </td>
512  </tr>
513</table>
514<table cellspacing="5" cellpadding="0" border="0">
515  <tr>
516    <td>
517      &nbsp;
518    </td>
519    <td>
520
521<p>
522Sets the second floating-point value of the effect parameter.
523<p>
524<dl compact><dt><b>Parameters:</b></dt><dd>
525  <table border="0" cellspacing="2" cellpadding="0">
526    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The second floating-point value. </td></tr>
527  </table>
528</dl>
529    </td>
530  </tr>
531</table>
532<a class="anchor" name="55d8ee98e2e41fada0e024f9bdae56a6"></a><!-- doxytag: member="FCDEffectParameterFloat2::WriteToXML" ref="55d8ee98e2e41fada0e024f9bdae56a6" args="(xmlNode *parentNode) const " --><p>
533<table class="mdTable" cellpadding="2" cellspacing="0">
534  <tr>
535    <td class="mdRow">
536      <table cellpadding="0" cellspacing="0" border="0">
537        <tr>
538          <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameterFloat2::WriteToXML           </td>
539          <td class="md" valign="top">(&nbsp;</td>
540          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
541          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
542          <td class="md" valign="top">&nbsp;)&nbsp;</td>
543          <td class="md" nowrap> const<code> [virtual]</code></td>
544        </tr>
545      </table>
546    </td>
547  </tr>
548</table>
549<table cellspacing="5" cellpadding="0" border="0">
550  <tr>
551    <td>
552      &nbsp;
553    </td>
554    <td>
555
556<p>
557[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.
558<p>
559<dl compact><dt><b>Parameters:</b></dt><dd>
560  <table border="0" cellspacing="2" cellpadding="0">
561    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the parameter. </td></tr>
562  </table>
563</dl>
564<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
565
566<p>
567Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">FCDEffectParameter</a>.    </td>
568  </tr>
569</table>
570<hr>The documentation for this class was generated from the following file:<ul>
571<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a></ul>
572<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
573<a href="http://www.doxygen.org/index.html">
574<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
575</body>
576</html>
Note: See TracBrowser for help on using the repository browser.