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: FCDEffectParameterFloat 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 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 Pages</span></a></li> |
---|
16 | </ul></div> |
---|
17 | <div class="tabs"> |
---|
18 | <ul> |
---|
19 | <li><a href="classes.html"><span>Alphabetical List</span></a></li> |
---|
20 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
21 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
22 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
23 | </ul></div> |
---|
24 | <h1>FCDEffectParameterFloat Class Reference</h1><!-- doxytag: class="FCDEffectParameterFloat" --><!-- doxytag: inherits="FCDEffectParameter" -->A COLLADA float effect parameter. |
---|
25 | <a href="#_details">More...</a> |
---|
26 | <p> |
---|
27 | <code>#include <<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a>></code> |
---|
28 | <p> |
---|
29 | <p>Inheritance diagram for FCDEffectParameterFloat: |
---|
30 | <p><center><img src="class_f_c_d_effect_parameter_float.png" usemap="#FCDEffectParameterFloat_map" border="0" alt=""></center> |
---|
31 | <map name="FCDEffectParameterFloat_map"> |
---|
32 | <area href="class_f_c_d_effect_parameter.html" alt="FCDEffectParameter" shape="rect" coords="0,112,157,136"> |
---|
33 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,157,80"> |
---|
34 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,157,24"> |
---|
35 | </map> |
---|
36 | <a href="class_f_c_d_effect_parameter_float-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d">FloatType</a> { <a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d3f35183c8d53aa09e41e8b1a87d0016e">FLOAT</a>, |
---|
40 | <a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d5146316b0d48e3b9fdefc55fdbd9df76">HALF</a> |
---|
41 | }</td></tr> |
---|
42 | |
---|
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The supported types of float-point values. <a href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#1301b7ed31db77e0a44bcb43fa8c06df">FCDEffectParameterFloat</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
46 | |
---|
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#1301b7ed31db77e0a44bcb43fa8c06df"></a><br></td></tr> |
---|
48 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#de2ae9086bb7b6f2f4aa5def83cf4ced">~FCDEffectParameterFloat</a> ()</td></tr> |
---|
49 | |
---|
50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#de2ae9086bb7b6f2f4aa5def83cf4ced"></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">FCDEffectParameter::Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#a5f935f8cce027dabe4f817c5fc9f79f">GetType</a> () const </td></tr> |
---|
52 | |
---|
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of effect parameter class. <a href="#a5f935f8cce027dabe4f817c5fc9f79f"></a><br></td></tr> |
---|
54 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d">FloatType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#871d4867364386afcde565e56e1234d5">GetFloatType</a> () const </td></tr> |
---|
55 | |
---|
56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of floating-point value held by this effect parameter. <a href="#871d4867364386afcde565e56e1234d5"></a><br></td></tr> |
---|
57 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#30b3d806cda498f5987262f1b4f7c33c">SetFloatType</a> (<a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d">FloatType</a> type)</td></tr> |
---|
58 | |
---|
59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the type of floating-point value held by this effect parameter. <a href="#30b3d806cda498f5987262f1b4f7c33c"></a><br></td></tr> |
---|
60 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#e0b4f034d06e8ae1609fb301b512874c">GetValue</a> ()</td></tr> |
---|
61 | |
---|
62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the floating-point value of the effect parameter. <a href="#e0b4f034d06e8ae1609fb301b512874c"></a><br></td></tr> |
---|
63 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9c77151f45e853d0e58401d863ee53d"></a><!-- doxytag: member="FCDEffectParameterFloat::GetValue" ref="e9c77151f45e853d0e58401d863ee53d" args="() const " --> |
---|
64 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#e9c77151f45e853d0e58401d863ee53d">GetValue</a> () const </td></tr> |
---|
65 | |
---|
66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
67 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#dd764ca3b7a2e494d385c9887d69d4d4">SetValue</a> (float _value)</td></tr> |
---|
68 | |
---|
69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the floating-point value of the effect parameter. <a href="#dd764ca3b7a2e494d385c9887d69d4d4"></a><br></td></tr> |
---|
70 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#ad913f2f0dbf18e84ca8a26b064dbf3e">GetMin</a> () const </td></tr> |
---|
71 | |
---|
72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the minimum value for the UI widget created for this effect parameter. <a href="#ad913f2f0dbf18e84ca8a26b064dbf3e"></a><br></td></tr> |
---|
73 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#81d4ec6ac94030236c333207b5ac56fd">SetMin</a> (float _min)</td></tr> |
---|
74 | |
---|
75 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum value for the UI widget created for this effect parameter. <a href="#81d4ec6ac94030236c333207b5ac56fd"></a><br></td></tr> |
---|
76 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#8cf89f4f716af201787bc75039b107fc">GetMax</a> () const </td></tr> |
---|
77 | |
---|
78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the maximum value for the UI widget created for this effect parameter. <a href="#8cf89f4f716af201787bc75039b107fc"></a><br></td></tr> |
---|
79 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#75d8d2de0402246672ba1cfe817cd85c">SetMax</a> (float _max)</td></tr> |
---|
80 | |
---|
81 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum value for the UI widget created for this effect parameter. <a href="#75d8d2de0402246672ba1cfe817cd85c"></a><br></td></tr> |
---|
82 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#cfc0102eb8b7250010b0bb7c416b4a0f">Clone</a> ()</td></tr> |
---|
83 | |
---|
84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a full copy of the effect parameter. <a href="#cfc0102eb8b7250010b0bb7c416b4a0f"></a><br></td></tr> |
---|
85 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#09d821f7e4230b64a4597679f9104aaa">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr> |
---|
86 | |
---|
87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter. <a href="#09d821f7e4230b64a4597679f9104aaa"></a><br></td></tr> |
---|
88 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#d96a98dbd64fd64a8cb1761d89181c3c">LoadFromXML</a> (xmlNode *parameterNode)</td></tr> |
---|
89 | |
---|
90 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. <a href="#d96a98dbd64fd64a8cb1761d89181c3c"></a><br></td></tr> |
---|
91 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_float.html#b43bf22832629ca71c264976ce7d3183">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
92 | |
---|
93 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. <a href="#b43bf22832629ca71c264976ce7d3183"></a><br></td></tr> |
---|
94 | </table> |
---|
95 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
96 | A COLLADA float effect parameter. |
---|
97 | <p> |
---|
98 | Contains a single, possibly animated, floating-point value. The type of the floating-point value may be HALF or FLOAT. |
---|
99 | <p> |
---|
100 | <hr><h2>Member Enumeration Documentation</h2> |
---|
101 | <a class="anchor" name="a28b191128c4dafc4d417347450b356d"></a><!-- doxytag: member="FCDEffectParameterFloat::FloatType" ref="a28b191128c4dafc4d417347450b356d" args="" --><p> |
---|
102 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
103 | <tr> |
---|
104 | <td class="mdRow"> |
---|
105 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
106 | <tr> |
---|
107 | <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d">FCDEffectParameterFloat::FloatType</a> </td> |
---|
108 | </tr> |
---|
109 | </table> |
---|
110 | </td> |
---|
111 | </tr> |
---|
112 | </table> |
---|
113 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
114 | <tr> |
---|
115 | <td> |
---|
116 | |
---|
117 | </td> |
---|
118 | <td> |
---|
119 | |
---|
120 | <p> |
---|
121 | The supported types of float-point values. |
---|
122 | <p> |
---|
123 | <dl compact><dt><b>Enumerator: </b></dt><dd> |
---|
124 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
125 | <tr><td valign="top"><em><a class="anchor" name="a28b191128c4dafc4d417347450b356d3f35183c8d53aa09e41e8b1a87d0016e"></a><!-- doxytag: member="FLOAT" ref="a28b191128c4dafc4d417347450b356d3f35183c8d53aa09e41e8b1a87d0016e" args="" -->FLOAT</em> </td><td> |
---|
126 | A single floating-pointer value effect parameter. </td></tr> |
---|
127 | <tr><td valign="top"><em><a class="anchor" name="a28b191128c4dafc4d417347450b356d5146316b0d48e3b9fdefc55fdbd9df76"></a><!-- doxytag: member="HALF" ref="a28b191128c4dafc4d417347450b356d5146316b0d48e3b9fdefc55fdbd9df76" args="" -->HALF</em> </td><td> |
---|
128 | Probably implies a 16-bit floating-point value. </td></tr> |
---|
129 | </table> |
---|
130 | </dl> |
---|
131 | </td> |
---|
132 | </tr> |
---|
133 | </table> |
---|
134 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
135 | <a class="anchor" name="1301b7ed31db77e0a44bcb43fa8c06df"></a><!-- doxytag: member="FCDEffectParameterFloat::FCDEffectParameterFloat" ref="1301b7ed31db77e0a44bcb43fa8c06df" args="(FCDocument *document)" --><p> |
---|
136 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
137 | <tr> |
---|
138 | <td class="mdRow"> |
---|
139 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
140 | <tr> |
---|
141 | <td class="md" nowrap valign="top">FCDEffectParameterFloat::FCDEffectParameterFloat </td> |
---|
142 | <td class="md" valign="top">( </td> |
---|
143 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
144 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
145 | <td class="md" valign="top"> ) </td> |
---|
146 | <td class="md" nowrap></td> |
---|
147 | </tr> |
---|
148 | </table> |
---|
149 | </td> |
---|
150 | </tr> |
---|
151 | </table> |
---|
152 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
153 | <tr> |
---|
154 | <td> |
---|
155 | |
---|
156 | </td> |
---|
157 | <td> |
---|
158 | |
---|
159 | <p> |
---|
160 | Constructor: do not use directly. |
---|
161 | <p> |
---|
162 | Instead, 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> |
---|
163 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
164 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the effect parameter. </td></tr> |
---|
165 | </table> |
---|
166 | </dl> |
---|
167 | </td> |
---|
168 | </tr> |
---|
169 | </table> |
---|
170 | <a class="anchor" name="de2ae9086bb7b6f2f4aa5def83cf4ced"></a><!-- doxytag: member="FCDEffectParameterFloat::~FCDEffectParameterFloat" ref="de2ae9086bb7b6f2f4aa5def83cf4ced" args="()" --><p> |
---|
171 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
172 | <tr> |
---|
173 | <td class="mdRow"> |
---|
174 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
175 | <tr> |
---|
176 | <td class="md" nowrap valign="top">virtual FCDEffectParameterFloat::~FCDEffectParameterFloat </td> |
---|
177 | <td class="md" valign="top">( </td> |
---|
178 | <td class="mdname1" valign="top" nowrap> </td> |
---|
179 | <td class="md" valign="top"> ) </td> |
---|
180 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
181 | </tr> |
---|
182 | </table> |
---|
183 | </td> |
---|
184 | </tr> |
---|
185 | </table> |
---|
186 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
187 | <tr> |
---|
188 | <td> |
---|
189 | |
---|
190 | </td> |
---|
191 | <td> |
---|
192 | |
---|
193 | <p> |
---|
194 | Destructor: do not use directly. |
---|
195 | <p> |
---|
196 | Instead, 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> |
---|
197 | </tr> |
---|
198 | </table> |
---|
199 | <hr><h2>Member Function Documentation</h2> |
---|
200 | <a class="anchor" name="cfc0102eb8b7250010b0bb7c416b4a0f"></a><!-- doxytag: member="FCDEffectParameterFloat::Clone" ref="cfc0102eb8b7250010b0bb7c416b4a0f" args="()" --><p> |
---|
201 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
202 | <tr> |
---|
203 | <td class="mdRow"> |
---|
204 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
205 | <tr> |
---|
206 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterFloat::Clone </td> |
---|
207 | <td class="md" valign="top">( </td> |
---|
208 | <td class="mdname1" valign="top" nowrap> </td> |
---|
209 | <td class="md" valign="top"> ) </td> |
---|
210 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
211 | </tr> |
---|
212 | </table> |
---|
213 | </td> |
---|
214 | </tr> |
---|
215 | </table> |
---|
216 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
217 | <tr> |
---|
218 | <td> |
---|
219 | |
---|
220 | </td> |
---|
221 | <td> |
---|
222 | |
---|
223 | <p> |
---|
224 | Creates a full copy of the effect parameter. |
---|
225 | <p> |
---|
226 | <dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl> |
---|
227 | |
---|
228 | <p> |
---|
229 | Implements <a class="el" href="class_f_c_d_effect_parameter.html#760f178513367b602f7c3363a158b76e">FCDEffectParameter</a>. </td> |
---|
230 | </tr> |
---|
231 | </table> |
---|
232 | <a class="anchor" name="871d4867364386afcde565e56e1234d5"></a><!-- doxytag: member="FCDEffectParameterFloat::GetFloatType" ref="871d4867364386afcde565e56e1234d5" args="() const " --><p> |
---|
233 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
234 | <tr> |
---|
235 | <td class="mdRow"> |
---|
236 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
237 | <tr> |
---|
238 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d">FloatType</a> FCDEffectParameterFloat::GetFloatType </td> |
---|
239 | <td class="md" valign="top">( </td> |
---|
240 | <td class="mdname1" valign="top" nowrap> </td> |
---|
241 | <td class="md" valign="top"> ) </td> |
---|
242 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
243 | </tr> |
---|
244 | </table> |
---|
245 | </td> |
---|
246 | </tr> |
---|
247 | </table> |
---|
248 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
249 | <tr> |
---|
250 | <td> |
---|
251 | |
---|
252 | </td> |
---|
253 | <td> |
---|
254 | |
---|
255 | <p> |
---|
256 | Retrieves the type of floating-point value held by this effect parameter. |
---|
257 | <p> |
---|
258 | <dl compact><dt><b>Returns:</b></dt><dd>The type of floating-point value. </dd></dl> |
---|
259 | </td> |
---|
260 | </tr> |
---|
261 | </table> |
---|
262 | <a class="anchor" name="8cf89f4f716af201787bc75039b107fc"></a><!-- doxytag: member="FCDEffectParameterFloat::GetMax" ref="8cf89f4f716af201787bc75039b107fc" args="() const " --><p> |
---|
263 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
264 | <tr> |
---|
265 | <td class="mdRow"> |
---|
266 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
267 | <tr> |
---|
268 | <td class="md" nowrap valign="top">float FCDEffectParameterFloat::GetMax </td> |
---|
269 | <td class="md" valign="top">( </td> |
---|
270 | <td class="mdname1" valign="top" nowrap> </td> |
---|
271 | <td class="md" valign="top"> ) </td> |
---|
272 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
273 | </tr> |
---|
274 | </table> |
---|
275 | </td> |
---|
276 | </tr> |
---|
277 | </table> |
---|
278 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
279 | <tr> |
---|
280 | <td> |
---|
281 | |
---|
282 | </td> |
---|
283 | <td> |
---|
284 | |
---|
285 | <p> |
---|
286 | Retrieves the maximum value for the UI widget created for this effect parameter. |
---|
287 | <p> |
---|
288 | This value is for UI purposes only and has no real impact on the value. <dl compact><dt><b>Returns:</b></dt><dd>The maximum value. </dd></dl> |
---|
289 | </td> |
---|
290 | </tr> |
---|
291 | </table> |
---|
292 | <a class="anchor" name="ad913f2f0dbf18e84ca8a26b064dbf3e"></a><!-- doxytag: member="FCDEffectParameterFloat::GetMin" ref="ad913f2f0dbf18e84ca8a26b064dbf3e" args="() const " --><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 FCDEffectParameterFloat::GetMin </td> |
---|
299 | <td class="md" valign="top">( </td> |
---|
300 | <td class="mdname1" valign="top" nowrap> </td> |
---|
301 | <td class="md" valign="top"> ) </td> |
---|
302 | <td class="md" nowrap> const<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 | |
---|
312 | </td> |
---|
313 | <td> |
---|
314 | |
---|
315 | <p> |
---|
316 | Retrieves the minimum value for the UI widget created for this effect parameter. |
---|
317 | <p> |
---|
318 | This value is for UI purposes only and has no real impact on the value. <dl compact><dt><b>Returns:</b></dt><dd>The minimum value. </dd></dl> |
---|
319 | </td> |
---|
320 | </tr> |
---|
321 | </table> |
---|
322 | <a class="anchor" name="a5f935f8cce027dabe4f817c5fc9f79f"></a><!-- doxytag: member="FCDEffectParameterFloat::GetType" ref="a5f935f8cce027dabe4f817c5fc9f79f" args="() const " --><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">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">FCDEffectParameter::Type</a> FCDEffectParameterFloat::GetType </td> |
---|
329 | <td class="md" valign="top">( </td> |
---|
330 | <td class="mdname1" valign="top" nowrap> </td> |
---|
331 | <td class="md" valign="top"> ) </td> |
---|
332 | <td class="md" nowrap> const<code> [inline, virtual]</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 | |
---|
342 | </td> |
---|
343 | <td> |
---|
344 | |
---|
345 | <p> |
---|
346 | Retrieves the type of effect parameter class. |
---|
347 | <p> |
---|
348 | <dl compact><dt><b>Returns:</b></dt><dd>The parameter class type: FLOAT. </dd></dl> |
---|
349 | |
---|
350 | <p> |
---|
351 | Implements <a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">FCDEffectParameter</a>. </td> |
---|
352 | </tr> |
---|
353 | </table> |
---|
354 | <a class="anchor" name="e0b4f034d06e8ae1609fb301b512874c"></a><!-- doxytag: member="FCDEffectParameterFloat::GetValue" ref="e0b4f034d06e8ae1609fb301b512874c" args="()" --><p> |
---|
355 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
356 | <tr> |
---|
357 | <td class="mdRow"> |
---|
358 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
359 | <tr> |
---|
360 | <td class="md" nowrap valign="top">float& FCDEffectParameterFloat::GetValue </td> |
---|
361 | <td class="md" valign="top">( </td> |
---|
362 | <td class="mdname1" valign="top" nowrap> </td> |
---|
363 | <td class="md" valign="top"> ) </td> |
---|
364 | <td class="md" nowrap><code> [inline]</code></td> |
---|
365 | </tr> |
---|
366 | </table> |
---|
367 | </td> |
---|
368 | </tr> |
---|
369 | </table> |
---|
370 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
371 | <tr> |
---|
372 | <td> |
---|
373 | |
---|
374 | </td> |
---|
375 | <td> |
---|
376 | |
---|
377 | <p> |
---|
378 | Retrieves the floating-point value of the effect parameter. |
---|
379 | <p> |
---|
380 | <dl compact><dt><b>Returns:</b></dt><dd>The floating-point value. </dd></dl> |
---|
381 | </td> |
---|
382 | </tr> |
---|
383 | </table> |
---|
384 | <a class="anchor" name="d96a98dbd64fd64a8cb1761d89181c3c"></a><!-- doxytag: member="FCDEffectParameterFloat::LoadFromXML" ref="d96a98dbd64fd64a8cb1761d89181c3c" args="(xmlNode *parameterNode)" --><p> |
---|
385 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
386 | <tr> |
---|
387 | <td class="mdRow"> |
---|
388 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
389 | <tr> |
---|
390 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameterFloat::LoadFromXML </td> |
---|
391 | <td class="md" valign="top">( </td> |
---|
392 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
393 | <td class="mdname1" valign="top" nowrap> <em>parameterNode</em> </td> |
---|
394 | <td class="md" valign="top"> ) </td> |
---|
395 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
396 | </tr> |
---|
397 | </table> |
---|
398 | </td> |
---|
399 | </tr> |
---|
400 | </table> |
---|
401 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
402 | <tr> |
---|
403 | <td> |
---|
404 | |
---|
405 | </td> |
---|
406 | <td> |
---|
407 | |
---|
408 | <p> |
---|
409 | [INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. |
---|
410 | <p> |
---|
411 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
412 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
413 | <tr><td valign="top"></td><td valign="top"><em>parameterNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
414 | </table> |
---|
415 | </dl> |
---|
416 | <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> |
---|
417 | |
---|
418 | <p> |
---|
419 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">FCDEffectParameter</a>. </td> |
---|
420 | </tr> |
---|
421 | </table> |
---|
422 | <a class="anchor" name="09d821f7e4230b64a4597679f9104aaa"></a><!-- doxytag: member="FCDEffectParameterFloat::Overwrite" ref="09d821f7e4230b64a4597679f9104aaa" args="(FCDEffectParameter *target)" --><p> |
---|
423 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
424 | <tr> |
---|
425 | <td class="mdRow"> |
---|
426 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
427 | <tr> |
---|
428 | <td class="md" nowrap valign="top">virtual void FCDEffectParameterFloat::Overwrite </td> |
---|
429 | <td class="md" valign="top">( </td> |
---|
430 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td> |
---|
431 | <td class="mdname1" valign="top" nowrap> <em>target</em> </td> |
---|
432 | <td class="md" valign="top"> ) </td> |
---|
433 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
434 | </tr> |
---|
435 | </table> |
---|
436 | </td> |
---|
437 | </tr> |
---|
438 | </table> |
---|
439 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
440 | <tr> |
---|
441 | <td> |
---|
442 | |
---|
443 | </td> |
---|
444 | <td> |
---|
445 | |
---|
446 | <p> |
---|
447 | [INTERNAL] Overwrites the target parameter with this parameter. |
---|
448 | <p> |
---|
449 | This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
450 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
451 | <tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>The target parameter to overwrite. </td></tr> |
---|
452 | </table> |
---|
453 | </dl> |
---|
454 | |
---|
455 | <p> |
---|
456 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">FCDEffectParameter</a>. </td> |
---|
457 | </tr> |
---|
458 | </table> |
---|
459 | <a class="anchor" name="30b3d806cda498f5987262f1b4f7c33c"></a><!-- doxytag: member="FCDEffectParameterFloat::SetFloatType" ref="30b3d806cda498f5987262f1b4f7c33c" args="(FloatType type)" --><p> |
---|
460 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
461 | <tr> |
---|
462 | <td class="mdRow"> |
---|
463 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
464 | <tr> |
---|
465 | <td class="md" nowrap valign="top">void FCDEffectParameterFloat::SetFloatType </td> |
---|
466 | <td class="md" valign="top">( </td> |
---|
467 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_float.html#a28b191128c4dafc4d417347450b356d">FloatType</a> </td> |
---|
468 | <td class="mdname1" valign="top" nowrap> <em>type</em> </td> |
---|
469 | <td class="md" valign="top"> ) </td> |
---|
470 | <td class="md" nowrap><code> [inline]</code></td> |
---|
471 | </tr> |
---|
472 | </table> |
---|
473 | </td> |
---|
474 | </tr> |
---|
475 | </table> |
---|
476 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
477 | <tr> |
---|
478 | <td> |
---|
479 | |
---|
480 | </td> |
---|
481 | <td> |
---|
482 | |
---|
483 | <p> |
---|
484 | Sets the type of floating-point value held by this effect parameter. |
---|
485 | <p> |
---|
486 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
487 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
488 | <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The type of floating-point value. </td></tr> |
---|
489 | </table> |
---|
490 | </dl> |
---|
491 | </td> |
---|
492 | </tr> |
---|
493 | </table> |
---|
494 | <a class="anchor" name="75d8d2de0402246672ba1cfe817cd85c"></a><!-- doxytag: member="FCDEffectParameterFloat::SetMax" ref="75d8d2de0402246672ba1cfe817cd85c" args="(float _max)" --><p> |
---|
495 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
496 | <tr> |
---|
497 | <td class="mdRow"> |
---|
498 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
499 | <tr> |
---|
500 | <td class="md" nowrap valign="top">void FCDEffectParameterFloat::SetMax </td> |
---|
501 | <td class="md" valign="top">( </td> |
---|
502 | <td class="md" nowrap valign="top">float </td> |
---|
503 | <td class="mdname1" valign="top" nowrap> <em>_max</em> </td> |
---|
504 | <td class="md" valign="top"> ) </td> |
---|
505 | <td class="md" nowrap><code> [inline]</code></td> |
---|
506 | </tr> |
---|
507 | </table> |
---|
508 | </td> |
---|
509 | </tr> |
---|
510 | </table> |
---|
511 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
512 | <tr> |
---|
513 | <td> |
---|
514 | |
---|
515 | </td> |
---|
516 | <td> |
---|
517 | |
---|
518 | <p> |
---|
519 | Sets the maximum value for the UI widget created for this effect parameter. |
---|
520 | <p> |
---|
521 | This value is for UI purposes only and has no real impact on the value. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
522 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
523 | <tr><td valign="top"></td><td valign="top"><em>_max</em> </td><td>The maximum value. </td></tr> |
---|
524 | </table> |
---|
525 | </dl> |
---|
526 | </td> |
---|
527 | </tr> |
---|
528 | </table> |
---|
529 | <a class="anchor" name="81d4ec6ac94030236c333207b5ac56fd"></a><!-- doxytag: member="FCDEffectParameterFloat::SetMin" ref="81d4ec6ac94030236c333207b5ac56fd" args="(float _min)" --><p> |
---|
530 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
531 | <tr> |
---|
532 | <td class="mdRow"> |
---|
533 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
534 | <tr> |
---|
535 | <td class="md" nowrap valign="top">void FCDEffectParameterFloat::SetMin </td> |
---|
536 | <td class="md" valign="top">( </td> |
---|
537 | <td class="md" nowrap valign="top">float </td> |
---|
538 | <td class="mdname1" valign="top" nowrap> <em>_min</em> </td> |
---|
539 | <td class="md" valign="top"> ) </td> |
---|
540 | <td class="md" nowrap><code> [inline]</code></td> |
---|
541 | </tr> |
---|
542 | </table> |
---|
543 | </td> |
---|
544 | </tr> |
---|
545 | </table> |
---|
546 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
547 | <tr> |
---|
548 | <td> |
---|
549 | |
---|
550 | </td> |
---|
551 | <td> |
---|
552 | |
---|
553 | <p> |
---|
554 | Sets the minimum value for the UI widget created for this effect parameter. |
---|
555 | <p> |
---|
556 | This value is for UI purposes only and has no real impact on the value. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
557 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
558 | <tr><td valign="top"></td><td valign="top"><em>_min</em> </td><td>The minimum value. </td></tr> |
---|
559 | </table> |
---|
560 | </dl> |
---|
561 | </td> |
---|
562 | </tr> |
---|
563 | </table> |
---|
564 | <a class="anchor" name="dd764ca3b7a2e494d385c9887d69d4d4"></a><!-- doxytag: member="FCDEffectParameterFloat::SetValue" ref="dd764ca3b7a2e494d385c9887d69d4d4" args="(float _value)" --><p> |
---|
565 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
566 | <tr> |
---|
567 | <td class="mdRow"> |
---|
568 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
569 | <tr> |
---|
570 | <td class="md" nowrap valign="top">void FCDEffectParameterFloat::SetValue </td> |
---|
571 | <td class="md" valign="top">( </td> |
---|
572 | <td class="md" nowrap valign="top">float </td> |
---|
573 | <td class="mdname1" valign="top" nowrap> <em>_value</em> </td> |
---|
574 | <td class="md" valign="top"> ) </td> |
---|
575 | <td class="md" nowrap><code> [inline]</code></td> |
---|
576 | </tr> |
---|
577 | </table> |
---|
578 | </td> |
---|
579 | </tr> |
---|
580 | </table> |
---|
581 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
582 | <tr> |
---|
583 | <td> |
---|
584 | |
---|
585 | </td> |
---|
586 | <td> |
---|
587 | |
---|
588 | <p> |
---|
589 | Sets the floating-point value of the effect parameter. |
---|
590 | <p> |
---|
591 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
592 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
593 | <tr><td valign="top"></td><td valign="top"><em>_value</em> </td><td>The floating-point value. </td></tr> |
---|
594 | </table> |
---|
595 | </dl> |
---|
596 | </td> |
---|
597 | </tr> |
---|
598 | </table> |
---|
599 | <a class="anchor" name="b43bf22832629ca71c264976ce7d3183"></a><!-- doxytag: member="FCDEffectParameterFloat::WriteToXML" ref="b43bf22832629ca71c264976ce7d3183" args="(xmlNode *parentNode) const " --><p> |
---|
600 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
601 | <tr> |
---|
602 | <td class="mdRow"> |
---|
603 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
604 | <tr> |
---|
605 | <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameterFloat::WriteToXML </td> |
---|
606 | <td class="md" valign="top">( </td> |
---|
607 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
608 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
609 | <td class="md" valign="top"> ) </td> |
---|
610 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
611 | </tr> |
---|
612 | </table> |
---|
613 | </td> |
---|
614 | </tr> |
---|
615 | </table> |
---|
616 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
617 | <tr> |
---|
618 | <td> |
---|
619 | |
---|
620 | </td> |
---|
621 | <td> |
---|
622 | |
---|
623 | <p> |
---|
624 | [INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. |
---|
625 | <p> |
---|
626 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
627 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
628 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the parameter. </td></tr> |
---|
629 | </table> |
---|
630 | </dl> |
---|
631 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
632 | |
---|
633 | <p> |
---|
634 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">FCDEffectParameter</a>. </td> |
---|
635 | </tr> |
---|
636 | </table> |
---|
637 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
638 | <li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a></ul> |
---|
639 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by |
---|
640 | <a href="http://www.doxygen.org/index.html"> |
---|
641 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
642 | </body> |
---|
643 | </html> |
---|