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

Revision 964, 32.5 KB checked in by igarcia, 19 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FCDEffectParameterFloat3 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>FCDEffectParameterFloat3 Class Reference</h1><!-- doxytag: class="FCDEffectParameterFloat3" --><!-- doxytag: inherits="FCDEffectParameter" -->A COLLADA 3D 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 FCDEffectParameterFloat3:
30<p><center><img src="class_f_c_d_effect_parameter_float3.png" usemap="#FCDEffectParameterFloat3_map" border="0" alt=""></center>
31<map name="FCDEffectParameterFloat3_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_float3-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_float3.html#7e8ea846f43dd9dfdcd68de45e3add58">FloatType</a> { <a class="el" href="class_f_c_d_effect_parameter_float3.html#7e8ea846f43dd9dfdcd68de45e3add5864c35574b9aa06d041e822021c4b922d">FLOAT</a>,
40<a class="el" href="class_f_c_d_effect_parameter_float3.html#7e8ea846f43dd9dfdcd68de45e3add58fa18c1e15e843af0f7486c9f423191c6">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_float3.html#7e8ea846f43dd9dfdcd68de45e3add58">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_float3.html#bdf966e06d45d6ec3b76c55b713278ff">FCDEffectParameterFloat3</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="#bdf966e06d45d6ec3b76c55b713278ff"></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_float3.html#77a918de4a0378152f05ee083e371861">~FCDEffectParameterFloat3</a> ()</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#77a918de4a0378152f05ee083e371861"></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_float3.html#6c9681855b3fd4c4a7677bee899bbcbe">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="#6c9681855b3fd4c4a7677bee899bbcbe"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter_float3.html#7e8ea846f43dd9dfdcd68de45e3add58">FloatType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float3.html#37e642ef42a608b3ab4a24fa6fdef1ee">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="#37e642ef42a608b3ab4a24fa6fdef1ee"></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_float3.html#50bac58e8dba487ae4ed0e5b21e8907a">SetFloatType</a> (<a class="el" href="class_f_c_d_effect_parameter_float3.html#7e8ea846f43dd9dfdcd68de45e3add58">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="#50bac58e8dba487ae4ed0e5b21e8907a"></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_float3.html#73027172d6d08c91dcb2d2c24d3ea942">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="#73027172d6d08c91dcb2d2c24d3ea942"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="087e079035c16f5cbd9c75651838c0df"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetValueX" ref="087e079035c16f5cbd9c75651838c0df" args="() const " -->
64const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float3.html#087e079035c16f5cbd9c75651838c0df">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_float3.html#6e858e18e5979ccb42708de361f3b36a">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="#6e858e18e5979ccb42708de361f3b36a"></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_float3.html#4a1aac0da0e01d4fb2a43175245232b8">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="#4a1aac0da0e01d4fb2a43175245232b8"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2e2cdd3dee4c7429d0ba7fef771b1e4"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetValueY" ref="f2e2cdd3dee4c7429d0ba7fef771b1e4" args="() const " -->
74const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float3.html#f2e2cdd3dee4c7429d0ba7fef771b1e4">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_float3.html#0c1a7ec1e8634e5ae9e7d317c898d8f4">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="#0c1a7ec1e8634e5ae9e7d317c898d8f4"></a><br></td></tr>
80<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_float3.html#067ae2377443973bb5dca94d2768198e">GetValueZ</a> ()</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the third floating-point value of the effect parameter.  <a href="#067ae2377443973bb5dca94d2768198e"></a><br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de3cb32aaa4b3ef6974fcfa45a88cdb5"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetValueZ" ref="de3cb32aaa4b3ef6974fcfa45a88cdb5" args="() const " -->
84const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float3.html#de3cb32aaa4b3ef6974fcfa45a88cdb5">GetValueZ</a> () const </td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
87<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_float3.html#28c3a1cda5c269229cff87f1edac6acd">SetValueZ</a> (float _value)</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the third floating-point value of the effect parameter.  <a href="#28c3a1cda5c269229cff87f1edac6acd"></a><br></td></tr>
90<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_float3.html#745c67bd0348bb429f3840e244fbcd02">Clone</a> ()</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the effect parameter.  <a href="#745c67bd0348bb429f3840e244fbcd02"></a><br></td></tr>
93<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_float3.html#77bc6753cc4e7867be361b087a8631f9">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter.  <a href="#77bc6753cc4e7867be361b087a8631f9"></a><br></td></tr>
96<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_float3.html#7b1c21d3b681b30fa5af323585704f55">LoadFromXML</a> (xmlNode *parameterNode)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.  <a href="#7b1c21d3b681b30fa5af323585704f55"></a><br></td></tr>
99<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_float3.html#4a9415f61033a439fa26ba1cd009fc0b">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.  <a href="#4a9415f61033a439fa26ba1cd009fc0b"></a><br></td></tr>
102</table>
103<hr><a name="_details"></a><h2>Detailed Description</h2>
104A COLLADA 3D vector of floats.
105<p>
106Contains three, possibly animated, floating-point values. The type of the floating-point values may be HALF or FLOAT.
107<p>
108<hr><h2>Member Enumeration Documentation</h2>
109<a class="anchor" name="7e8ea846f43dd9dfdcd68de45e3add58"></a><!-- doxytag: member="FCDEffectParameterFloat3::FloatType" ref="7e8ea846f43dd9dfdcd68de45e3add58" args="" --><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">enum <a class="el" href="class_f_c_d_effect_parameter_float3.html#7e8ea846f43dd9dfdcd68de45e3add58">FCDEffectParameterFloat3::FloatType</a>          </td>
116        </tr>
117      </table>
118    </td>
119  </tr>
120</table>
121<table cellspacing="5" cellpadding="0" border="0">
122  <tr>
123    <td>
124      &nbsp;
125    </td>
126    <td>
127
128<p>
129The supported types of float-point values.
130<p>
131<dl compact><dt><b>Enumerator: </b></dt><dd>
132<table border="0" cellspacing="2" cellpadding="0">
133<tr><td valign="top"><em><a class="anchor" name="7e8ea846f43dd9dfdcd68de45e3add5864c35574b9aa06d041e822021c4b922d"></a><!-- doxytag: member="FLOAT" ref="7e8ea846f43dd9dfdcd68de45e3add5864c35574b9aa06d041e822021c4b922d" args="" -->FLOAT</em>&nbsp;</td><td>
134A single floating-pointer value effect parameter. </td></tr>
135<tr><td valign="top"><em><a class="anchor" name="7e8ea846f43dd9dfdcd68de45e3add58fa18c1e15e843af0f7486c9f423191c6"></a><!-- doxytag: member="HALF" ref="7e8ea846f43dd9dfdcd68de45e3add58fa18c1e15e843af0f7486c9f423191c6" args="" -->HALF</em>&nbsp;</td><td>
136Probably implies a 16-bit floating-point value. </td></tr>
137</table>
138</dl>
139    </td>
140  </tr>
141</table>
142<hr><h2>Constructor &amp; Destructor Documentation</h2>
143<a class="anchor" name="bdf966e06d45d6ec3b76c55b713278ff"></a><!-- doxytag: member="FCDEffectParameterFloat3::FCDEffectParameterFloat3" ref="bdf966e06d45d6ec3b76c55b713278ff" args="(FCDocument *document)" --><p>
144<table class="mdTable" cellpadding="2" cellspacing="0">
145  <tr>
146    <td class="mdRow">
147      <table cellpadding="0" cellspacing="0" border="0">
148        <tr>
149          <td class="md" nowrap valign="top">FCDEffectParameterFloat3::FCDEffectParameterFloat3           </td>
150          <td class="md" valign="top">(&nbsp;</td>
151          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
152          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
153          <td class="md" valign="top">&nbsp;)&nbsp;</td>
154          <td class="md" nowrap></td>
155        </tr>
156      </table>
157    </td>
158  </tr>
159</table>
160<table cellspacing="5" cellpadding="0" border="0">
161  <tr>
162    <td>
163      &nbsp;
164    </td>
165    <td>
166
167<p>
168Constructor: do not use directly.
169<p>
170Instead, 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>
171  <table border="0" cellspacing="2" cellpadding="0">
172    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the effect parameter. </td></tr>
173  </table>
174</dl>
175    </td>
176  </tr>
177</table>
178<a class="anchor" name="77a918de4a0378152f05ee083e371861"></a><!-- doxytag: member="FCDEffectParameterFloat3::~FCDEffectParameterFloat3" ref="77a918de4a0378152f05ee083e371861" args="()" --><p>
179<table class="mdTable" cellpadding="2" cellspacing="0">
180  <tr>
181    <td class="mdRow">
182      <table cellpadding="0" cellspacing="0" border="0">
183        <tr>
184          <td class="md" nowrap valign="top">virtual FCDEffectParameterFloat3::~FCDEffectParameterFloat3           </td>
185          <td class="md" valign="top">(&nbsp;</td>
186          <td class="mdname1" valign="top" nowrap>          </td>
187          <td class="md" valign="top">&nbsp;)&nbsp;</td>
188          <td class="md" nowrap><code> [virtual]</code></td>
189        </tr>
190      </table>
191    </td>
192  </tr>
193</table>
194<table cellspacing="5" cellpadding="0" border="0">
195  <tr>
196    <td>
197      &nbsp;
198    </td>
199    <td>
200
201<p>
202Destructor: do not use directly.
203<p>
204Instead, 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>
205  </tr>
206</table>
207<hr><h2>Member Function Documentation</h2>
208<a class="anchor" name="745c67bd0348bb429f3840e244fbcd02"></a><!-- doxytag: member="FCDEffectParameterFloat3::Clone" ref="745c67bd0348bb429f3840e244fbcd02" args="()" --><p>
209<table class="mdTable" cellpadding="2" cellspacing="0">
210  <tr>
211    <td class="mdRow">
212      <table cellpadding="0" cellspacing="0" border="0">
213        <tr>
214          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterFloat3::Clone           </td>
215          <td class="md" valign="top">(&nbsp;</td>
216          <td class="mdname1" valign="top" nowrap>          </td>
217          <td class="md" valign="top">&nbsp;)&nbsp;</td>
218          <td class="md" nowrap><code> [virtual]</code></td>
219        </tr>
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing="5" cellpadding="0" border="0">
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232Creates a full copy of the effect parameter.
233<p>
234<dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl>
235
236<p>
237Implements <a class="el" href="class_f_c_d_effect_parameter.html#760f178513367b602f7c3363a158b76e">FCDEffectParameter</a>.    </td>
238  </tr>
239</table>
240<a class="anchor" name="37e642ef42a608b3ab4a24fa6fdef1ee"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetFloatType" ref="37e642ef42a608b3ab4a24fa6fdef1ee" args="() const " --><p>
241<table class="mdTable" cellpadding="2" cellspacing="0">
242  <tr>
243    <td class="mdRow">
244      <table cellpadding="0" cellspacing="0" border="0">
245        <tr>
246          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_float3.html#7e8ea846f43dd9dfdcd68de45e3add58">FloatType</a> FCDEffectParameterFloat3::GetFloatType           </td>
247          <td class="md" valign="top">(&nbsp;</td>
248          <td class="mdname1" valign="top" nowrap>          </td>
249          <td class="md" valign="top">&nbsp;)&nbsp;</td>
250          <td class="md" nowrap> const<code> [inline]</code></td>
251        </tr>
252      </table>
253    </td>
254  </tr>
255</table>
256<table cellspacing="5" cellpadding="0" border="0">
257  <tr>
258    <td>
259      &nbsp;
260    </td>
261    <td>
262
263<p>
264Retrieves the type of floating-point value held by this effect parameter.
265<p>
266<dl compact><dt><b>Returns:</b></dt><dd>The type of floating-point value. </dd></dl>
267    </td>
268  </tr>
269</table>
270<a class="anchor" name="6c9681855b3fd4c4a7677bee899bbcbe"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetType" ref="6c9681855b3fd4c4a7677bee899bbcbe" args="() const " --><p>
271<table class="mdTable" cellpadding="2" cellspacing="0">
272  <tr>
273    <td class="mdRow">
274      <table cellpadding="0" cellspacing="0" border="0">
275        <tr>
276          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> FCDEffectParameterFloat3::GetType           </td>
277          <td class="md" valign="top">(&nbsp;</td>
278          <td class="mdname1" valign="top" nowrap>          </td>
279          <td class="md" valign="top">&nbsp;)&nbsp;</td>
280          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
281        </tr>
282      </table>
283    </td>
284  </tr>
285</table>
286<table cellspacing="5" cellpadding="0" border="0">
287  <tr>
288    <td>
289      &nbsp;
290    </td>
291    <td>
292
293<p>
294Retrieves the type of effect parameter class.
295<p>
296<dl compact><dt><b>Returns:</b></dt><dd>The parameter class type: FLOAT3. </dd></dl>
297
298<p>
299Implements <a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">FCDEffectParameter</a>.    </td>
300  </tr>
301</table>
302<a class="anchor" name="73027172d6d08c91dcb2d2c24d3ea942"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetValueX" ref="73027172d6d08c91dcb2d2c24d3ea942" args="()" --><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">float&amp; FCDEffectParameterFloat3::GetValueX           </td>
309          <td class="md" valign="top">(&nbsp;</td>
310          <td class="mdname1" valign="top" nowrap>          </td>
311          <td class="md" valign="top">&nbsp;)&nbsp;</td>
312          <td class="md" nowrap><code> [inline]</code></td>
313        </tr>
314      </table>
315    </td>
316  </tr>
317</table>
318<table cellspacing="5" cellpadding="0" border="0">
319  <tr>
320    <td>
321      &nbsp;
322    </td>
323    <td>
324
325<p>
326Retrieves the first floating-point value of the effect parameter.
327<p>
328<dl compact><dt><b>Returns:</b></dt><dd>The first floating-point value. </dd></dl>
329    </td>
330  </tr>
331</table>
332<a class="anchor" name="4a1aac0da0e01d4fb2a43175245232b8"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetValueY" ref="4a1aac0da0e01d4fb2a43175245232b8" args="()" --><p>
333<table class="mdTable" cellpadding="2" cellspacing="0">
334  <tr>
335    <td class="mdRow">
336      <table cellpadding="0" cellspacing="0" border="0">
337        <tr>
338          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterFloat3::GetValueY           </td>
339          <td class="md" valign="top">(&nbsp;</td>
340          <td class="mdname1" valign="top" nowrap>          </td>
341          <td class="md" valign="top">&nbsp;)&nbsp;</td>
342          <td class="md" nowrap><code> [inline]</code></td>
343        </tr>
344      </table>
345    </td>
346  </tr>
347</table>
348<table cellspacing="5" cellpadding="0" border="0">
349  <tr>
350    <td>
351      &nbsp;
352    </td>
353    <td>
354
355<p>
356Retrieves the second floating-point value of the effect parameter.
357<p>
358<dl compact><dt><b>Returns:</b></dt><dd>The second floating-point value. </dd></dl>
359    </td>
360  </tr>
361</table>
362<a class="anchor" name="067ae2377443973bb5dca94d2768198e"></a><!-- doxytag: member="FCDEffectParameterFloat3::GetValueZ" ref="067ae2377443973bb5dca94d2768198e" args="()" --><p>
363<table class="mdTable" cellpadding="2" cellspacing="0">
364  <tr>
365    <td class="mdRow">
366      <table cellpadding="0" cellspacing="0" border="0">
367        <tr>
368          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterFloat3::GetValueZ           </td>
369          <td class="md" valign="top">(&nbsp;</td>
370          <td class="mdname1" valign="top" nowrap>          </td>
371          <td class="md" valign="top">&nbsp;)&nbsp;</td>
372          <td class="md" nowrap><code> [inline]</code></td>
373        </tr>
374      </table>
375    </td>
376  </tr>
377</table>
378<table cellspacing="5" cellpadding="0" border="0">
379  <tr>
380    <td>
381      &nbsp;
382    </td>
383    <td>
384
385<p>
386Retrieves the third floating-point value of the effect parameter.
387<p>
388<dl compact><dt><b>Returns:</b></dt><dd>The third floating-point value. </dd></dl>
389    </td>
390  </tr>
391</table>
392<a class="anchor" name="7b1c21d3b681b30fa5af323585704f55"></a><!-- doxytag: member="FCDEffectParameterFloat3::LoadFromXML" ref="7b1c21d3b681b30fa5af323585704f55" args="(xmlNode *parameterNode)" --><p>
393<table class="mdTable" cellpadding="2" cellspacing="0">
394  <tr>
395    <td class="mdRow">
396      <table cellpadding="0" cellspacing="0" border="0">
397        <tr>
398          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameterFloat3::LoadFromXML           </td>
399          <td class="md" valign="top">(&nbsp;</td>
400          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
401          <td class="mdname1" valign="top" nowrap> <em>parameterNode</em>          </td>
402          <td class="md" valign="top">&nbsp;)&nbsp;</td>
403          <td class="md" nowrap><code> [virtual]</code></td>
404        </tr>
405      </table>
406    </td>
407  </tr>
408</table>
409<table cellspacing="5" cellpadding="0" border="0">
410  <tr>
411    <td>
412      &nbsp;
413    </td>
414    <td>
415
416<p>
417[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.
418<p>
419<dl compact><dt><b>Parameters:</b></dt><dd>
420  <table border="0" cellspacing="2" cellpadding="0">
421    <tr><td valign="top"></td><td valign="top"><em>parameterNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
422  </table>
423</dl>
424<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>
425
426<p>
427Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">FCDEffectParameter</a>.    </td>
428  </tr>
429</table>
430<a class="anchor" name="77bc6753cc4e7867be361b087a8631f9"></a><!-- doxytag: member="FCDEffectParameterFloat3::Overwrite" ref="77bc6753cc4e7867be361b087a8631f9" args="(FCDEffectParameter *target)" --><p>
431<table class="mdTable" cellpadding="2" cellspacing="0">
432  <tr>
433    <td class="mdRow">
434      <table cellpadding="0" cellspacing="0" border="0">
435        <tr>
436          <td class="md" nowrap valign="top">virtual void FCDEffectParameterFloat3::Overwrite           </td>
437          <td class="md" valign="top">(&nbsp;</td>
438          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td>
439          <td class="mdname1" valign="top" nowrap> <em>target</em>          </td>
440          <td class="md" valign="top">&nbsp;)&nbsp;</td>
441          <td class="md" nowrap><code> [virtual]</code></td>
442        </tr>
443      </table>
444    </td>
445  </tr>
446</table>
447<table cellspacing="5" cellpadding="0" border="0">
448  <tr>
449    <td>
450      &nbsp;
451    </td>
452    <td>
453
454<p>
455[INTERNAL] Overwrites the target parameter with this parameter.
456<p>
457This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd>
458  <table border="0" cellspacing="2" cellpadding="0">
459    <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The target parameter to overwrite. </td></tr>
460  </table>
461</dl>
462
463<p>
464Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">FCDEffectParameter</a>.    </td>
465  </tr>
466</table>
467<a class="anchor" name="50bac58e8dba487ae4ed0e5b21e8907a"></a><!-- doxytag: member="FCDEffectParameterFloat3::SetFloatType" ref="50bac58e8dba487ae4ed0e5b21e8907a" args="(FloatType type)" --><p>
468<table class="mdTable" cellpadding="2" cellspacing="0">
469  <tr>
470    <td class="mdRow">
471      <table cellpadding="0" cellspacing="0" border="0">
472        <tr>
473          <td class="md" nowrap valign="top">void FCDEffectParameterFloat3::SetFloatType           </td>
474          <td class="md" valign="top">(&nbsp;</td>
475          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_float3.html#7e8ea846f43dd9dfdcd68de45e3add58">FloatType</a>&nbsp;</td>
476          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
477          <td class="md" valign="top">&nbsp;)&nbsp;</td>
478          <td class="md" nowrap><code> [inline]</code></td>
479        </tr>
480      </table>
481    </td>
482  </tr>
483</table>
484<table cellspacing="5" cellpadding="0" border="0">
485  <tr>
486    <td>
487      &nbsp;
488    </td>
489    <td>
490
491<p>
492Sets the type of floating-point value held by this effect parameter.
493<p>
494<dl compact><dt><b>Parameters:</b></dt><dd>
495  <table border="0" cellspacing="2" cellpadding="0">
496    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The type of floating-point value. </td></tr>
497  </table>
498</dl>
499    </td>
500  </tr>
501</table>
502<a class="anchor" name="6e858e18e5979ccb42708de361f3b36a"></a><!-- doxytag: member="FCDEffectParameterFloat3::SetValueX" ref="6e858e18e5979ccb42708de361f3b36a" args="(float _value)" --><p>
503<table class="mdTable" cellpadding="2" cellspacing="0">
504  <tr>
505    <td class="mdRow">
506      <table cellpadding="0" cellspacing="0" border="0">
507        <tr>
508          <td class="md" nowrap valign="top">void FCDEffectParameterFloat3::SetValueX           </td>
509          <td class="md" valign="top">(&nbsp;</td>
510          <td class="md" nowrap valign="top">float&nbsp;</td>
511          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
512          <td class="md" valign="top">&nbsp;)&nbsp;</td>
513          <td class="md" nowrap><code> [inline]</code></td>
514        </tr>
515      </table>
516    </td>
517  </tr>
518</table>
519<table cellspacing="5" cellpadding="0" border="0">
520  <tr>
521    <td>
522      &nbsp;
523    </td>
524    <td>
525
526<p>
527Sets the first floating-point value of the effect parameter.
528<p>
529<dl compact><dt><b>Parameters:</b></dt><dd>
530  <table border="0" cellspacing="2" cellpadding="0">
531    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The first floating-point value. </td></tr>
532  </table>
533</dl>
534    </td>
535  </tr>
536</table>
537<a class="anchor" name="0c1a7ec1e8634e5ae9e7d317c898d8f4"></a><!-- doxytag: member="FCDEffectParameterFloat3::SetValueY" ref="0c1a7ec1e8634e5ae9e7d317c898d8f4" args="(float _value)" --><p>
538<table class="mdTable" cellpadding="2" cellspacing="0">
539  <tr>
540    <td class="mdRow">
541      <table cellpadding="0" cellspacing="0" border="0">
542        <tr>
543          <td class="md" nowrap valign="top">void FCDEffectParameterFloat3::SetValueY           </td>
544          <td class="md" valign="top">(&nbsp;</td>
545          <td class="md" nowrap valign="top">float&nbsp;</td>
546          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
547          <td class="md" valign="top">&nbsp;)&nbsp;</td>
548          <td class="md" nowrap><code> [inline]</code></td>
549        </tr>
550      </table>
551    </td>
552  </tr>
553</table>
554<table cellspacing="5" cellpadding="0" border="0">
555  <tr>
556    <td>
557      &nbsp;
558    </td>
559    <td>
560
561<p>
562Sets the second floating-point value of the effect parameter.
563<p>
564<dl compact><dt><b>Parameters:</b></dt><dd>
565  <table border="0" cellspacing="2" cellpadding="0">
566    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The second floating-point value. </td></tr>
567  </table>
568</dl>
569    </td>
570  </tr>
571</table>
572<a class="anchor" name="28c3a1cda5c269229cff87f1edac6acd"></a><!-- doxytag: member="FCDEffectParameterFloat3::SetValueZ" ref="28c3a1cda5c269229cff87f1edac6acd" args="(float _value)" --><p>
573<table class="mdTable" cellpadding="2" cellspacing="0">
574  <tr>
575    <td class="mdRow">
576      <table cellpadding="0" cellspacing="0" border="0">
577        <tr>
578          <td class="md" nowrap valign="top">void FCDEffectParameterFloat3::SetValueZ           </td>
579          <td class="md" valign="top">(&nbsp;</td>
580          <td class="md" nowrap valign="top">float&nbsp;</td>
581          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
582          <td class="md" valign="top">&nbsp;)&nbsp;</td>
583          <td class="md" nowrap><code> [inline]</code></td>
584        </tr>
585      </table>
586    </td>
587  </tr>
588</table>
589<table cellspacing="5" cellpadding="0" border="0">
590  <tr>
591    <td>
592      &nbsp;
593    </td>
594    <td>
595
596<p>
597Sets the third floating-point value of the effect parameter.
598<p>
599<dl compact><dt><b>Parameters:</b></dt><dd>
600  <table border="0" cellspacing="2" cellpadding="0">
601    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The third floating-point value. </td></tr>
602  </table>
603</dl>
604    </td>
605  </tr>
606</table>
607<a class="anchor" name="4a9415f61033a439fa26ba1cd009fc0b"></a><!-- doxytag: member="FCDEffectParameterFloat3::WriteToXML" ref="4a9415f61033a439fa26ba1cd009fc0b" args="(xmlNode *parentNode) const " --><p>
608<table class="mdTable" cellpadding="2" cellspacing="0">
609  <tr>
610    <td class="mdRow">
611      <table cellpadding="0" cellspacing="0" border="0">
612        <tr>
613          <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameterFloat3::WriteToXML           </td>
614          <td class="md" valign="top">(&nbsp;</td>
615          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
616          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
617          <td class="md" valign="top">&nbsp;)&nbsp;</td>
618          <td class="md" nowrap> const<code> [virtual]</code></td>
619        </tr>
620      </table>
621    </td>
622  </tr>
623</table>
624<table cellspacing="5" cellpadding="0" border="0">
625  <tr>
626    <td>
627      &nbsp;
628    </td>
629    <td>
630
631<p>
632[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.
633<p>
634<dl compact><dt><b>Parameters:</b></dt><dd>
635  <table border="0" cellspacing="2" cellpadding="0">
636    <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>
637  </table>
638</dl>
639<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
640
641<p>
642Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">FCDEffectParameter</a>.    </td>
643  </tr>
644</table>
645<hr>The documentation for this class was generated from the following file:<ul>
646<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a></ul>
647<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
648<a href="http://www.doxygen.org/index.html">
649<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
650</body>
651</html>
Note: See TracBrowser for help on using the repository browser.