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

Revision 964, 37.9 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: FCDEffectParameterVector 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>FCDEffectParameterVector Class Reference</h1><!-- doxytag: class="FCDEffectParameterVector" --><!-- doxytag: inherits="FCDEffectParameter" -->A COLLADA 4D 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 FCDEffectParameterVector:
30<p><center><img src="class_f_c_d_effect_parameter_vector.png" usemap="#FCDEffectParameterVector_map" border="0" alt=""></center>
31<map name="FCDEffectParameterVector_map">
32<area href="class_f_c_d_effect_parameter.html" alt="FCDEffectParameter" shape="rect" coords="0,112,167,136">
33<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,167,80">
34<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,167,24">
35</map>
36<a href="class_f_c_d_effect_parameter_vector-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_vector.html#035e2c3691618620389142cc66328409">FloatType</a> { <a class="el" href="class_f_c_d_effect_parameter_vector.html#035e2c3691618620389142cc663284098c064e226445861202d8eda2d7b618ee">FLOAT</a>,
40<a class="el" href="class_f_c_d_effect_parameter_vector.html#035e2c3691618620389142cc6632840998baf12de74b0d8cba8766706cb84516">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_vector.html#035e2c3691618620389142cc66328409">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_vector.html#79ab285b3f7284f4dd4f9914ac10a57d">FCDEffectParameterVector</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="#79ab285b3f7284f4dd4f9914ac10a57d"></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_vector.html#73ce11d964bcb0aaef54b4e1cd8781e0">~FCDEffectParameterVector</a> ()</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#73ce11d964bcb0aaef54b4e1cd8781e0"></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_vector.html#9390bbea2590e2d49ad2341925b069f9">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="#9390bbea2590e2d49ad2341925b069f9"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter_vector.html#035e2c3691618620389142cc66328409">FloatType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#ce40e7aebb51aaefae2ca9d89e9d7d42">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="#ce40e7aebb51aaefae2ca9d89e9d7d42"></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_vector.html#25f61f4cf97d47b4125fd6e81b385e3f">SetFloatType</a> (<a class="el" href="class_f_c_d_effect_parameter_vector.html#035e2c3691618620389142cc66328409">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="#25f61f4cf97d47b4125fd6e81b385e3f"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">float *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#f69c51702c7788718f61cfef5cb8f9fb">GetVector</a> ()</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the vector value of the effect parameter.  <a href="#f69c51702c7788718f61cfef5cb8f9fb"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f20dd0549e79c4b7103f247028a6b676"></a><!-- doxytag: member="FCDEffectParameterVector::GetVector" ref="f20dd0549e79c4b7103f247028a6b676" args="() const " -->
64const float *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#f20dd0549e79c4b7103f247028a6b676">GetVector</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">float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#e01dcf5ad6b0320798658344d08a5bba">GetValueX</a> ()</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the first floating-point value of the effect parameter.  <a href="#e01dcf5ad6b0320798658344d08a5bba"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c669d4a8c411d591ccfd920f73428ae9"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueX" ref="c669d4a8c411d591ccfd920f73428ae9" args="() const " -->
71const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#c669d4a8c411d591ccfd920f73428ae9">GetValueX</a> () const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
74<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_vector.html#c94e798b117bd9719b694682a4af9b5a">SetValueX</a> (float _value)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the first floating-point value of the effect parameter.  <a href="#c94e798b117bd9719b694682a4af9b5a"></a><br></td></tr>
77<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_vector.html#af82e40c02e70bfb866fd840e2a592ac">GetValueY</a> ()</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the second floating-point value of the effect parameter.  <a href="#af82e40c02e70bfb866fd840e2a592ac"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02608c94122d2664ea4490952101368b"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueY" ref="02608c94122d2664ea4490952101368b" args="() const " -->
81const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#02608c94122d2664ea4490952101368b">GetValueY</a> () const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
84<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_vector.html#17fcff544e0d24166f0ab4c4056fd0cc">SetValueY</a> (float _value)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the second floating-point value of the effect parameter.  <a href="#17fcff544e0d24166f0ab4c4056fd0cc"></a><br></td></tr>
87<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_vector.html#3389e45d04f514d9b35e078cac50027a">GetValueZ</a> ()</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the third floating-point value of the effect parameter.  <a href="#3389e45d04f514d9b35e078cac50027a"></a><br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed673a069ecdda76fd13ac83afb7cc32"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueZ" ref="ed673a069ecdda76fd13ac83afb7cc32" args="() const " -->
91const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#ed673a069ecdda76fd13ac83afb7cc32">GetValueZ</a> () const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
94<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_vector.html#24d41da4d2c00e6815b2021174148ad0">SetValueZ</a> (float _value)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the third floating-point value of the effect parameter.  <a href="#24d41da4d2c00e6815b2021174148ad0"></a><br></td></tr>
97<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_vector.html#061736a2057f662a29e541a26109e6cc">GetValueW</a> ()</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the fourth floating-point value of the effect parameter.  <a href="#061736a2057f662a29e541a26109e6cc"></a><br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6dab0b3e7d24af8a014621d2af91eca6"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueW" ref="6dab0b3e7d24af8a014621d2af91eca6" args="() const " -->
101const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_vector.html#6dab0b3e7d24af8a014621d2af91eca6">GetValueW</a> () const </td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
104<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_vector.html#56673929a4f3cae4510fd65230bd3692">SetValueW</a> (float _value)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the fourth floating-point value of the effect parameter.  <a href="#56673929a4f3cae4510fd65230bd3692"></a><br></td></tr>
107<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_vector.html#6efb851221ef887ef061fcd52b97c2eb">Clone</a> ()</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the effect parameter.  <a href="#6efb851221ef887ef061fcd52b97c2eb"></a><br></td></tr>
110<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_vector.html#24b7d03b869596955d673b6630fb348f">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter.  <a href="#24b7d03b869596955d673b6630fb348f"></a><br></td></tr>
113<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_vector.html#e186731839ff9857efc9b5241234f220">LoadFromXML</a> (xmlNode *parameterNode)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.  <a href="#e186731839ff9857efc9b5241234f220"></a><br></td></tr>
116<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_vector.html#86e7d049cf09fd981961e85ffe510c91">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.  <a href="#86e7d049cf09fd981961e85ffe510c91"></a><br></td></tr>
119</table>
120<hr><a name="_details"></a><h2>Detailed Description</h2>
121A COLLADA 4D vector of floats.
122<p>
123Contains four, possibly animated, floating-point values. The type of the floating-point values may be HALF or FLOAT.
124<p>
125<hr><h2>Member Enumeration Documentation</h2>
126<a class="anchor" name="035e2c3691618620389142cc66328409"></a><!-- doxytag: member="FCDEffectParameterVector::FloatType" ref="035e2c3691618620389142cc66328409" args="" --><p>
127<table class="mdTable" cellpadding="2" cellspacing="0">
128  <tr>
129    <td class="mdRow">
130      <table cellpadding="0" cellspacing="0" border="0">
131        <tr>
132          <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter_vector.html#035e2c3691618620389142cc66328409">FCDEffectParameterVector::FloatType</a>          </td>
133        </tr>
134      </table>
135    </td>
136  </tr>
137</table>
138<table cellspacing="5" cellpadding="0" border="0">
139  <tr>
140    <td>
141      &nbsp;
142    </td>
143    <td>
144
145<p>
146The supported types of float-point values.
147<p>
148<dl compact><dt><b>Enumerator: </b></dt><dd>
149<table border="0" cellspacing="2" cellpadding="0">
150<tr><td valign="top"><em><a class="anchor" name="035e2c3691618620389142cc663284098c064e226445861202d8eda2d7b618ee"></a><!-- doxytag: member="FLOAT" ref="035e2c3691618620389142cc663284098c064e226445861202d8eda2d7b618ee" args="" -->FLOAT</em>&nbsp;</td><td>
151A single floating-pointer value effect parameter. </td></tr>
152<tr><td valign="top"><em><a class="anchor" name="035e2c3691618620389142cc6632840998baf12de74b0d8cba8766706cb84516"></a><!-- doxytag: member="HALF" ref="035e2c3691618620389142cc6632840998baf12de74b0d8cba8766706cb84516" args="" -->HALF</em>&nbsp;</td><td>
153Probably implies a 16-bit floating-point value. </td></tr>
154</table>
155</dl>
156    </td>
157  </tr>
158</table>
159<hr><h2>Constructor &amp; Destructor Documentation</h2>
160<a class="anchor" name="79ab285b3f7284f4dd4f9914ac10a57d"></a><!-- doxytag: member="FCDEffectParameterVector::FCDEffectParameterVector" ref="79ab285b3f7284f4dd4f9914ac10a57d" args="(FCDocument *document)" --><p>
161<table class="mdTable" cellpadding="2" cellspacing="0">
162  <tr>
163    <td class="mdRow">
164      <table cellpadding="0" cellspacing="0" border="0">
165        <tr>
166          <td class="md" nowrap valign="top">FCDEffectParameterVector::FCDEffectParameterVector           </td>
167          <td class="md" valign="top">(&nbsp;</td>
168          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
169          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
170          <td class="md" valign="top">&nbsp;)&nbsp;</td>
171          <td class="md" nowrap></td>
172        </tr>
173      </table>
174    </td>
175  </tr>
176</table>
177<table cellspacing="5" cellpadding="0" border="0">
178  <tr>
179    <td>
180      &nbsp;
181    </td>
182    <td>
183
184<p>
185Constructor: do not use directly.
186<p>
187Instead, 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>
188  <table border="0" cellspacing="2" cellpadding="0">
189    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the effect parameter. </td></tr>
190  </table>
191</dl>
192    </td>
193  </tr>
194</table>
195<a class="anchor" name="73ce11d964bcb0aaef54b4e1cd8781e0"></a><!-- doxytag: member="FCDEffectParameterVector::~FCDEffectParameterVector" ref="73ce11d964bcb0aaef54b4e1cd8781e0" args="()" --><p>
196<table class="mdTable" cellpadding="2" cellspacing="0">
197  <tr>
198    <td class="mdRow">
199      <table cellpadding="0" cellspacing="0" border="0">
200        <tr>
201          <td class="md" nowrap valign="top">virtual FCDEffectParameterVector::~FCDEffectParameterVector           </td>
202          <td class="md" valign="top">(&nbsp;</td>
203          <td class="mdname1" valign="top" nowrap>          </td>
204          <td class="md" valign="top">&nbsp;)&nbsp;</td>
205          <td class="md" nowrap><code> [virtual]</code></td>
206        </tr>
207      </table>
208    </td>
209  </tr>
210</table>
211<table cellspacing="5" cellpadding="0" border="0">
212  <tr>
213    <td>
214      &nbsp;
215    </td>
216    <td>
217
218<p>
219Destructor: do not use directly.
220<p>
221Instead, 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>
222  </tr>
223</table>
224<hr><h2>Member Function Documentation</h2>
225<a class="anchor" name="6efb851221ef887ef061fcd52b97c2eb"></a><!-- doxytag: member="FCDEffectParameterVector::Clone" ref="6efb851221ef887ef061fcd52b97c2eb" args="()" --><p>
226<table class="mdTable" cellpadding="2" cellspacing="0">
227  <tr>
228    <td class="mdRow">
229      <table cellpadding="0" cellspacing="0" border="0">
230        <tr>
231          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterVector::Clone           </td>
232          <td class="md" valign="top">(&nbsp;</td>
233          <td class="mdname1" valign="top" nowrap>          </td>
234          <td class="md" valign="top">&nbsp;)&nbsp;</td>
235          <td class="md" nowrap><code> [virtual]</code></td>
236        </tr>
237      </table>
238    </td>
239  </tr>
240</table>
241<table cellspacing="5" cellpadding="0" border="0">
242  <tr>
243    <td>
244      &nbsp;
245    </td>
246    <td>
247
248<p>
249Creates a full copy of the effect parameter.
250<p>
251<dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl>
252
253<p>
254Implements <a class="el" href="class_f_c_d_effect_parameter.html#760f178513367b602f7c3363a158b76e">FCDEffectParameter</a>.    </td>
255  </tr>
256</table>
257<a class="anchor" name="ce40e7aebb51aaefae2ca9d89e9d7d42"></a><!-- doxytag: member="FCDEffectParameterVector::GetFloatType" ref="ce40e7aebb51aaefae2ca9d89e9d7d42" args="() const " --><p>
258<table class="mdTable" cellpadding="2" cellspacing="0">
259  <tr>
260    <td class="mdRow">
261      <table cellpadding="0" cellspacing="0" border="0">
262        <tr>
263          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_vector.html#035e2c3691618620389142cc66328409">FloatType</a> FCDEffectParameterVector::GetFloatType           </td>
264          <td class="md" valign="top">(&nbsp;</td>
265          <td class="mdname1" valign="top" nowrap>          </td>
266          <td class="md" valign="top">&nbsp;)&nbsp;</td>
267          <td class="md" nowrap> const<code> [inline]</code></td>
268        </tr>
269      </table>
270    </td>
271  </tr>
272</table>
273<table cellspacing="5" cellpadding="0" border="0">
274  <tr>
275    <td>
276      &nbsp;
277    </td>
278    <td>
279
280<p>
281Retrieves the type of floating-point value held by this effect parameter.
282<p>
283<dl compact><dt><b>Returns:</b></dt><dd>The type of floating-point value. </dd></dl>
284    </td>
285  </tr>
286</table>
287<a class="anchor" name="9390bbea2590e2d49ad2341925b069f9"></a><!-- doxytag: member="FCDEffectParameterVector::GetType" ref="9390bbea2590e2d49ad2341925b069f9" args="() const " --><p>
288<table class="mdTable" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> FCDEffectParameterVector::GetType           </td>
294          <td class="md" valign="top">(&nbsp;</td>
295          <td class="mdname1" valign="top" nowrap>          </td>
296          <td class="md" valign="top">&nbsp;)&nbsp;</td>
297          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
298        </tr>
299      </table>
300    </td>
301  </tr>
302</table>
303<table cellspacing="5" cellpadding="0" border="0">
304  <tr>
305    <td>
306      &nbsp;
307    </td>
308    <td>
309
310<p>
311Retrieves the type of effect parameter class.
312<p>
313<dl compact><dt><b>Returns:</b></dt><dd>The parameter class type: VECTOR. </dd></dl>
314
315<p>
316Implements <a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">FCDEffectParameter</a>.    </td>
317  </tr>
318</table>
319<a class="anchor" name="061736a2057f662a29e541a26109e6cc"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueW" ref="061736a2057f662a29e541a26109e6cc" args="()" --><p>
320<table class="mdTable" cellpadding="2" cellspacing="0">
321  <tr>
322    <td class="mdRow">
323      <table cellpadding="0" cellspacing="0" border="0">
324        <tr>
325          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterVector::GetValueW           </td>
326          <td class="md" valign="top">(&nbsp;</td>
327          <td class="mdname1" valign="top" nowrap>          </td>
328          <td class="md" valign="top">&nbsp;)&nbsp;</td>
329          <td class="md" nowrap><code> [inline]</code></td>
330        </tr>
331      </table>
332    </td>
333  </tr>
334</table>
335<table cellspacing="5" cellpadding="0" border="0">
336  <tr>
337    <td>
338      &nbsp;
339    </td>
340    <td>
341
342<p>
343Retrieves the fourth floating-point value of the effect parameter.
344<p>
345<dl compact><dt><b>Returns:</b></dt><dd>The fourth floating-point value. </dd></dl>
346    </td>
347  </tr>
348</table>
349<a class="anchor" name="e01dcf5ad6b0320798658344d08a5bba"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueX" ref="e01dcf5ad6b0320798658344d08a5bba" args="()" --><p>
350<table class="mdTable" cellpadding="2" cellspacing="0">
351  <tr>
352    <td class="mdRow">
353      <table cellpadding="0" cellspacing="0" border="0">
354        <tr>
355          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterVector::GetValueX           </td>
356          <td class="md" valign="top">(&nbsp;</td>
357          <td class="mdname1" valign="top" nowrap>          </td>
358          <td class="md" valign="top">&nbsp;)&nbsp;</td>
359          <td class="md" nowrap><code> [inline]</code></td>
360        </tr>
361      </table>
362    </td>
363  </tr>
364</table>
365<table cellspacing="5" cellpadding="0" border="0">
366  <tr>
367    <td>
368      &nbsp;
369    </td>
370    <td>
371
372<p>
373Retrieves the first floating-point value of the effect parameter.
374<p>
375<dl compact><dt><b>Returns:</b></dt><dd>The first floating-point value. </dd></dl>
376    </td>
377  </tr>
378</table>
379<a class="anchor" name="af82e40c02e70bfb866fd840e2a592ac"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueY" ref="af82e40c02e70bfb866fd840e2a592ac" args="()" --><p>
380<table class="mdTable" cellpadding="2" cellspacing="0">
381  <tr>
382    <td class="mdRow">
383      <table cellpadding="0" cellspacing="0" border="0">
384        <tr>
385          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterVector::GetValueY           </td>
386          <td class="md" valign="top">(&nbsp;</td>
387          <td class="mdname1" valign="top" nowrap>          </td>
388          <td class="md" valign="top">&nbsp;)&nbsp;</td>
389          <td class="md" nowrap><code> [inline]</code></td>
390        </tr>
391      </table>
392    </td>
393  </tr>
394</table>
395<table cellspacing="5" cellpadding="0" border="0">
396  <tr>
397    <td>
398      &nbsp;
399    </td>
400    <td>
401
402<p>
403Retrieves the second floating-point value of the effect parameter.
404<p>
405<dl compact><dt><b>Returns:</b></dt><dd>The second floating-point value. </dd></dl>
406    </td>
407  </tr>
408</table>
409<a class="anchor" name="3389e45d04f514d9b35e078cac50027a"></a><!-- doxytag: member="FCDEffectParameterVector::GetValueZ" ref="3389e45d04f514d9b35e078cac50027a" args="()" --><p>
410<table class="mdTable" cellpadding="2" cellspacing="0">
411  <tr>
412    <td class="mdRow">
413      <table cellpadding="0" cellspacing="0" border="0">
414        <tr>
415          <td class="md" nowrap valign="top">float&amp; FCDEffectParameterVector::GetValueZ           </td>
416          <td class="md" valign="top">(&nbsp;</td>
417          <td class="mdname1" valign="top" nowrap>          </td>
418          <td class="md" valign="top">&nbsp;)&nbsp;</td>
419          <td class="md" nowrap><code> [inline]</code></td>
420        </tr>
421      </table>
422    </td>
423  </tr>
424</table>
425<table cellspacing="5" cellpadding="0" border="0">
426  <tr>
427    <td>
428      &nbsp;
429    </td>
430    <td>
431
432<p>
433Retrieves the third floating-point value of the effect parameter.
434<p>
435<dl compact><dt><b>Returns:</b></dt><dd>The third floating-point value. </dd></dl>
436    </td>
437  </tr>
438</table>
439<a class="anchor" name="f69c51702c7788718f61cfef5cb8f9fb"></a><!-- doxytag: member="FCDEffectParameterVector::GetVector" ref="f69c51702c7788718f61cfef5cb8f9fb" args="()" --><p>
440<table class="mdTable" cellpadding="2" cellspacing="0">
441  <tr>
442    <td class="mdRow">
443      <table cellpadding="0" cellspacing="0" border="0">
444        <tr>
445          <td class="md" nowrap valign="top">float* FCDEffectParameterVector::GetVector           </td>
446          <td class="md" valign="top">(&nbsp;</td>
447          <td class="mdname1" valign="top" nowrap>          </td>
448          <td class="md" valign="top">&nbsp;)&nbsp;</td>
449          <td class="md" nowrap><code> [inline]</code></td>
450        </tr>
451      </table>
452    </td>
453  </tr>
454</table>
455<table cellspacing="5" cellpadding="0" border="0">
456  <tr>
457    <td>
458      &nbsp;
459    </td>
460    <td>
461
462<p>
463Sets the vector value of the effect parameter.
464<p>
465<dl compact><dt><b>Returns:</b></dt><dd>The vector value. </dd></dl>
466    </td>
467  </tr>
468</table>
469<a class="anchor" name="e186731839ff9857efc9b5241234f220"></a><!-- doxytag: member="FCDEffectParameterVector::LoadFromXML" ref="e186731839ff9857efc9b5241234f220" args="(xmlNode *parameterNode)" --><p>
470<table class="mdTable" cellpadding="2" cellspacing="0">
471  <tr>
472    <td class="mdRow">
473      <table cellpadding="0" cellspacing="0" border="0">
474        <tr>
475          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameterVector::LoadFromXML           </td>
476          <td class="md" valign="top">(&nbsp;</td>
477          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
478          <td class="mdname1" valign="top" nowrap> <em>parameterNode</em>          </td>
479          <td class="md" valign="top">&nbsp;)&nbsp;</td>
480          <td class="md" nowrap><code> [virtual]</code></td>
481        </tr>
482      </table>
483    </td>
484  </tr>
485</table>
486<table cellspacing="5" cellpadding="0" border="0">
487  <tr>
488    <td>
489      &nbsp;
490    </td>
491    <td>
492
493<p>
494[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.
495<p>
496<dl compact><dt><b>Parameters:</b></dt><dd>
497  <table border="0" cellspacing="2" cellpadding="0">
498    <tr><td valign="top"></td><td valign="top"><em>parameterNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
499  </table>
500</dl>
501<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>
502
503<p>
504Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">FCDEffectParameter</a>.    </td>
505  </tr>
506</table>
507<a class="anchor" name="24b7d03b869596955d673b6630fb348f"></a><!-- doxytag: member="FCDEffectParameterVector::Overwrite" ref="24b7d03b869596955d673b6630fb348f" args="(FCDEffectParameter *target)" --><p>
508<table class="mdTable" cellpadding="2" cellspacing="0">
509  <tr>
510    <td class="mdRow">
511      <table cellpadding="0" cellspacing="0" border="0">
512        <tr>
513          <td class="md" nowrap valign="top">virtual void FCDEffectParameterVector::Overwrite           </td>
514          <td class="md" valign="top">(&nbsp;</td>
515          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td>
516          <td class="mdname1" valign="top" nowrap> <em>target</em>          </td>
517          <td class="md" valign="top">&nbsp;)&nbsp;</td>
518          <td class="md" nowrap><code> [virtual]</code></td>
519        </tr>
520      </table>
521    </td>
522  </tr>
523</table>
524<table cellspacing="5" cellpadding="0" border="0">
525  <tr>
526    <td>
527      &nbsp;
528    </td>
529    <td>
530
531<p>
532[INTERNAL] Overwrites the target parameter with this parameter.
533<p>
534This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd>
535  <table border="0" cellspacing="2" cellpadding="0">
536    <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The target parameter to overwrite. </td></tr>
537  </table>
538</dl>
539
540<p>
541Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">FCDEffectParameter</a>.    </td>
542  </tr>
543</table>
544<a class="anchor" name="25f61f4cf97d47b4125fd6e81b385e3f"></a><!-- doxytag: member="FCDEffectParameterVector::SetFloatType" ref="25f61f4cf97d47b4125fd6e81b385e3f" args="(FloatType type)" --><p>
545<table class="mdTable" cellpadding="2" cellspacing="0">
546  <tr>
547    <td class="mdRow">
548      <table cellpadding="0" cellspacing="0" border="0">
549        <tr>
550          <td class="md" nowrap valign="top">void FCDEffectParameterVector::SetFloatType           </td>
551          <td class="md" valign="top">(&nbsp;</td>
552          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_vector.html#035e2c3691618620389142cc66328409">FloatType</a>&nbsp;</td>
553          <td class="mdname1" valign="top" nowrap> <em>type</em>          </td>
554          <td class="md" valign="top">&nbsp;)&nbsp;</td>
555          <td class="md" nowrap><code> [inline]</code></td>
556        </tr>
557      </table>
558    </td>
559  </tr>
560</table>
561<table cellspacing="5" cellpadding="0" border="0">
562  <tr>
563    <td>
564      &nbsp;
565    </td>
566    <td>
567
568<p>
569Sets the type of floating-point value held by this effect parameter.
570<p>
571<dl compact><dt><b>Parameters:</b></dt><dd>
572  <table border="0" cellspacing="2" cellpadding="0">
573    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>The type of floating-point value. </td></tr>
574  </table>
575</dl>
576    </td>
577  </tr>
578</table>
579<a class="anchor" name="56673929a4f3cae4510fd65230bd3692"></a><!-- doxytag: member="FCDEffectParameterVector::SetValueW" ref="56673929a4f3cae4510fd65230bd3692" args="(float _value)" --><p>
580<table class="mdTable" cellpadding="2" cellspacing="0">
581  <tr>
582    <td class="mdRow">
583      <table cellpadding="0" cellspacing="0" border="0">
584        <tr>
585          <td class="md" nowrap valign="top">void FCDEffectParameterVector::SetValueW           </td>
586          <td class="md" valign="top">(&nbsp;</td>
587          <td class="md" nowrap valign="top">float&nbsp;</td>
588          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
589          <td class="md" valign="top">&nbsp;)&nbsp;</td>
590          <td class="md" nowrap><code> [inline]</code></td>
591        </tr>
592      </table>
593    </td>
594  </tr>
595</table>
596<table cellspacing="5" cellpadding="0" border="0">
597  <tr>
598    <td>
599      &nbsp;
600    </td>
601    <td>
602
603<p>
604Sets the fourth floating-point value of the effect parameter.
605<p>
606<dl compact><dt><b>Parameters:</b></dt><dd>
607  <table border="0" cellspacing="2" cellpadding="0">
608    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The fourth floating-point value. </td></tr>
609  </table>
610</dl>
611    </td>
612  </tr>
613</table>
614<a class="anchor" name="c94e798b117bd9719b694682a4af9b5a"></a><!-- doxytag: member="FCDEffectParameterVector::SetValueX" ref="c94e798b117bd9719b694682a4af9b5a" args="(float _value)" --><p>
615<table class="mdTable" cellpadding="2" cellspacing="0">
616  <tr>
617    <td class="mdRow">
618      <table cellpadding="0" cellspacing="0" border="0">
619        <tr>
620          <td class="md" nowrap valign="top">void FCDEffectParameterVector::SetValueX           </td>
621          <td class="md" valign="top">(&nbsp;</td>
622          <td class="md" nowrap valign="top">float&nbsp;</td>
623          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
624          <td class="md" valign="top">&nbsp;)&nbsp;</td>
625          <td class="md" nowrap><code> [inline]</code></td>
626        </tr>
627      </table>
628    </td>
629  </tr>
630</table>
631<table cellspacing="5" cellpadding="0" border="0">
632  <tr>
633    <td>
634      &nbsp;
635    </td>
636    <td>
637
638<p>
639Sets the first floating-point value of the effect parameter.
640<p>
641<dl compact><dt><b>Parameters:</b></dt><dd>
642  <table border="0" cellspacing="2" cellpadding="0">
643    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The first floating-point value. </td></tr>
644  </table>
645</dl>
646    </td>
647  </tr>
648</table>
649<a class="anchor" name="17fcff544e0d24166f0ab4c4056fd0cc"></a><!-- doxytag: member="FCDEffectParameterVector::SetValueY" ref="17fcff544e0d24166f0ab4c4056fd0cc" args="(float _value)" --><p>
650<table class="mdTable" cellpadding="2" cellspacing="0">
651  <tr>
652    <td class="mdRow">
653      <table cellpadding="0" cellspacing="0" border="0">
654        <tr>
655          <td class="md" nowrap valign="top">void FCDEffectParameterVector::SetValueY           </td>
656          <td class="md" valign="top">(&nbsp;</td>
657          <td class="md" nowrap valign="top">float&nbsp;</td>
658          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
659          <td class="md" valign="top">&nbsp;)&nbsp;</td>
660          <td class="md" nowrap><code> [inline]</code></td>
661        </tr>
662      </table>
663    </td>
664  </tr>
665</table>
666<table cellspacing="5" cellpadding="0" border="0">
667  <tr>
668    <td>
669      &nbsp;
670    </td>
671    <td>
672
673<p>
674Sets the second floating-point value of the effect parameter.
675<p>
676<dl compact><dt><b>Parameters:</b></dt><dd>
677  <table border="0" cellspacing="2" cellpadding="0">
678    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The second floating-point value. </td></tr>
679  </table>
680</dl>
681    </td>
682  </tr>
683</table>
684<a class="anchor" name="24d41da4d2c00e6815b2021174148ad0"></a><!-- doxytag: member="FCDEffectParameterVector::SetValueZ" ref="24d41da4d2c00e6815b2021174148ad0" args="(float _value)" --><p>
685<table class="mdTable" cellpadding="2" cellspacing="0">
686  <tr>
687    <td class="mdRow">
688      <table cellpadding="0" cellspacing="0" border="0">
689        <tr>
690          <td class="md" nowrap valign="top">void FCDEffectParameterVector::SetValueZ           </td>
691          <td class="md" valign="top">(&nbsp;</td>
692          <td class="md" nowrap valign="top">float&nbsp;</td>
693          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
694          <td class="md" valign="top">&nbsp;)&nbsp;</td>
695          <td class="md" nowrap><code> [inline]</code></td>
696        </tr>
697      </table>
698    </td>
699  </tr>
700</table>
701<table cellspacing="5" cellpadding="0" border="0">
702  <tr>
703    <td>
704      &nbsp;
705    </td>
706    <td>
707
708<p>
709Sets the third floating-point value of the effect parameter.
710<p>
711<dl compact><dt><b>Parameters:</b></dt><dd>
712  <table border="0" cellspacing="2" cellpadding="0">
713    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The third floating-point value. </td></tr>
714  </table>
715</dl>
716    </td>
717  </tr>
718</table>
719<a class="anchor" name="86e7d049cf09fd981961e85ffe510c91"></a><!-- doxytag: member="FCDEffectParameterVector::WriteToXML" ref="86e7d049cf09fd981961e85ffe510c91" args="(xmlNode *parentNode) const " --><p>
720<table class="mdTable" cellpadding="2" cellspacing="0">
721  <tr>
722    <td class="mdRow">
723      <table cellpadding="0" cellspacing="0" border="0">
724        <tr>
725          <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameterVector::WriteToXML           </td>
726          <td class="md" valign="top">(&nbsp;</td>
727          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
728          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
729          <td class="md" valign="top">&nbsp;)&nbsp;</td>
730          <td class="md" nowrap> const<code> [virtual]</code></td>
731        </tr>
732      </table>
733    </td>
734  </tr>
735</table>
736<table cellspacing="5" cellpadding="0" border="0">
737  <tr>
738    <td>
739      &nbsp;
740    </td>
741    <td>
742
743<p>
744[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.
745<p>
746<dl compact><dt><b>Parameters:</b></dt><dd>
747  <table border="0" cellspacing="2" cellpadding="0">
748    <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>
749  </table>
750</dl>
751<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
752
753<p>
754Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">FCDEffectParameter</a>.    </td>
755  </tr>
756</table>
757<hr>The documentation for this class was generated from the following file:<ul>
758<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a></ul>
759<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
760<a href="http://www.doxygen.org/index.html">
761<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
762</body>
763</html>
Note: See TracBrowser for help on using the repository browser.