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

Revision 964, 17.6 KB checked in by igarcia, 18 years ago (diff)
RevLine 
[964]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: FMath Namespace 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 id="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li><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="namespaces.html"><span>Namespace List</span></a></li>
20    <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
21  </ul></div>
22<h1>FMath Namespace Reference<br>
23<small>
24[<a class="el" href="group___f_math.html">Mathematics Classes.</a>]</small>
25</h1>A namespace for common math functions. 
26<a href="#_details">More...</a>
27<p>
28<table border="0" cellpadding="0" cellspacing="0">
29<tr><td></td></tr>
30<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#3f3ff4d162ca9b81672ab8d5ce1a04ed">RadToDeg</a> (double val)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert radians to degrees.  <a href="#3f3ff4d162ca9b81672ab8d5ce1a04ed"></a><br></td></tr>
34<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#126a39f30047703acd42ac277e688959">RadToDeg</a> (float val)</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert radians to degrees.  <a href="#126a39f30047703acd42ac277e688959"></a><br></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#85780db77107aa93459019cd8cb8e89b">DegToRad</a> (double val)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert degrees to radians.  <a href="#85780db77107aa93459019cd8cb8e89b"></a><br></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#0d5dc4a5370d82235d4e62cdd510c31c">DegToRad</a> (float val)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert degrees to radians.  <a href="#0d5dc4a5370d82235d4e62cdd510c31c"></a><br></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#f07527201a796f5c30c8bc10db7a8178">IsNotANumber</a> (float f)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines if given float is encoding for not a number (NAN).  <a href="#f07527201a796f5c30c8bc10db7a8178"></a><br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#1190dc2de051037cbb426f9c9aee8046">Sign</a> (double val)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the sign of a number.  <a href="#1190dc2de051037cbb426f9c9aee8046"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#48ee0aea01eb950825b923755f4576d2">Sign</a> (float val)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the sign of a number.  <a href="#48ee0aea01eb950825b923755f4576d2"></a><br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top">int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#eeb82e7ca4d7ea1d2fe9483f8aae575c">Sign</a> (int32 val)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine the sign of a number.  <a href="#eeb82e7ca4d7ea1d2fe9483f8aae575c"></a><br></td></tr>
55<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T&gt; </td></tr>
56<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">T&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#2bc2e21ab0bc13dbf6b669eb1d9b253c">Clamp</a> (T val, T mn, T mx)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clamp the specified object within a range specified by two other objects of the same class.  <a href="#2bc2e21ab0bc13dbf6b669eb1d9b253c"></a><br></td></tr>
59<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c8e25df39e90e06ce866c1b509b9bec"></a><!-- doxytag: member="FMath::Pi" ref="4c8e25df39e90e06ce866c1b509b9bec" args="" -->
61const double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_f_math.html#4c8e25df39e90e06ce866c1b509b9bec">Pi</a> = 3.14159</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mathematical value of pi to 5 decimals. <br></td></tr>
64</table>
65<hr><a name="_details"></a><h2>Detailed Description</h2>
66A namespace for common math functions. <hr><h2>Function Documentation</h2>
67<a class="anchor" name="2bc2e21ab0bc13dbf6b669eb1d9b253c"></a><!-- doxytag: member="FMath::Clamp" ref="2bc2e21ab0bc13dbf6b669eb1d9b253c" args="(T val, T mn, T mx)" --><p>
68<table class="mdTable" cellpadding="2" cellspacing="0">
69  <tr>
70    <td class="mdRow">
71      <table cellpadding="0" cellspacing="0" border="0">
72        <tr>
73          <td class="mdPrefix" colspan="4">
74template&lt;class T&gt; </td>
75        </tr>
76        <tr>
77          <td class="md" nowrap valign="top">T FMath::Clamp           </td>
78          <td class="md" valign="top">(&nbsp;</td>
79          <td class="md" nowrap valign="top">T&nbsp;</td>
80          <td class="mdname" nowrap> <em>val</em>, </td>
81        </tr>
82        <tr>
83          <td class="md" nowrap align="right"></td>
84          <td class="md"></td>
85          <td class="md" nowrap>T&nbsp;</td>
86          <td class="mdname" nowrap> <em>mn</em>, </td>
87        </tr>
88        <tr>
89          <td class="md" nowrap align="right"></td>
90          <td class="md"></td>
91          <td class="md" nowrap>T&nbsp;</td>
92          <td class="mdname" nowrap> <em>mx</em></td>
93        </tr>
94        <tr>
95          <td class="md"></td>
96          <td class="md">)&nbsp;</td>
97          <td class="md" colspan="2"><code> [inline]</code></td>
98        </tr>
99      </table>
100    </td>
101  </tr>
102</table>
103<table cellspacing="5" cellpadding="0" border="0">
104  <tr>
105    <td>
106      &nbsp;
107    </td>
108    <td>
109
110<p>
111Clamp the specified object within a range specified by two other objects of the same class.
112<p>
113Clamp refers to setting a value within a given range. If the value is lower than the minimum of the range, it is set to the minimum; same for the maximum.<p>
114<dl compact><dt><b>Parameters:</b></dt><dd>
115  <table border="0" cellspacing="2" cellpadding="0">
116    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The object to clamp. </td></tr>
117    <tr><td valign="top"></td><td valign="top"><em>mx</em>&nbsp;</td><td>The highest object of the range. </td></tr>
118    <tr><td valign="top"></td><td valign="top"><em>mn</em>&nbsp;</td><td>The lowest object of the range. </td></tr>
119  </table>
120</dl>
121<dl compact><dt><b>Returns:</b></dt><dd>The clamped value. </dd></dl>
122    </td>
123  </tr>
124</table>
125<a class="anchor" name="0d5dc4a5370d82235d4e62cdd510c31c"></a><!-- doxytag: member="FMath::DegToRad" ref="0d5dc4a5370d82235d4e62cdd510c31c" args="(float val)" --><p>
126<table class="mdTable" cellpadding="2" cellspacing="0">
127  <tr>
128    <td class="mdRow">
129      <table cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td class="md" nowrap valign="top">float FMath::DegToRad           </td>
132          <td class="md" valign="top">(&nbsp;</td>
133          <td class="md" nowrap valign="top">float&nbsp;</td>
134          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
135          <td class="md" valign="top">&nbsp;)&nbsp;</td>
136          <td class="md" nowrap><code> [inline]</code></td>
137        </tr>
138      </table>
139    </td>
140  </tr>
141</table>
142<table cellspacing="5" cellpadding="0" border="0">
143  <tr>
144    <td>
145      &nbsp;
146    </td>
147    <td>
148
149<p>
150Convert degrees to radians.
151<p>
152<dl compact><dt><b>Parameters:</b></dt><dd>
153  <table border="0" cellspacing="2" cellpadding="0">
154    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The value in degrees. </td></tr>
155  </table>
156</dl>
157<dl compact><dt><b>Returns:</b></dt><dd>The value in radians. </dd></dl>
158    </td>
159  </tr>
160</table>
161<a class="anchor" name="85780db77107aa93459019cd8cb8e89b"></a><!-- doxytag: member="FMath::DegToRad" ref="85780db77107aa93459019cd8cb8e89b" args="(double val)" --><p>
162<table class="mdTable" cellpadding="2" cellspacing="0">
163  <tr>
164    <td class="mdRow">
165      <table cellpadding="0" cellspacing="0" border="0">
166        <tr>
167          <td class="md" nowrap valign="top">double FMath::DegToRad           </td>
168          <td class="md" valign="top">(&nbsp;</td>
169          <td class="md" nowrap valign="top">double&nbsp;</td>
170          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
171          <td class="md" valign="top">&nbsp;)&nbsp;</td>
172          <td class="md" nowrap><code> [inline]</code></td>
173        </tr>
174      </table>
175    </td>
176  </tr>
177</table>
178<table cellspacing="5" cellpadding="0" border="0">
179  <tr>
180    <td>
181      &nbsp;
182    </td>
183    <td>
184
185<p>
186Convert degrees to radians.
187<p>
188<dl compact><dt><b>Parameters:</b></dt><dd>
189  <table border="0" cellspacing="2" cellpadding="0">
190    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The value in degrees. </td></tr>
191  </table>
192</dl>
193<dl compact><dt><b>Returns:</b></dt><dd>The value in radians. </dd></dl>
194    </td>
195  </tr>
196</table>
197<a class="anchor" name="f07527201a796f5c30c8bc10db7a8178"></a><!-- doxytag: member="FMath::IsNotANumber" ref="f07527201a796f5c30c8bc10db7a8178" args="(float f)" --><p>
198<table class="mdTable" cellpadding="2" cellspacing="0">
199  <tr>
200    <td class="mdRow">
201      <table cellpadding="0" cellspacing="0" border="0">
202        <tr>
203          <td class="md" nowrap valign="top">int FMath::IsNotANumber           </td>
204          <td class="md" valign="top">(&nbsp;</td>
205          <td class="md" nowrap valign="top">float&nbsp;</td>
206          <td class="mdname1" valign="top" nowrap> <em>f</em>          </td>
207          <td class="md" valign="top">&nbsp;)&nbsp;</td>
208          <td class="md" nowrap><code> [inline]</code></td>
209        </tr>
210      </table>
211    </td>
212  </tr>
213</table>
214<table cellspacing="5" cellpadding="0" border="0">
215  <tr>
216    <td>
217      &nbsp;
218    </td>
219    <td>
220
221<p>
222Determines if given float is encoding for not a number (NAN).
223<p>
224<dl compact><dt><b>Parameters:</b></dt><dd>
225  <table border="0" cellspacing="2" cellpadding="0">
226    <tr><td valign="top"></td><td valign="top"><em>f</em>&nbsp;</td><td>The float to check. </td></tr>
227  </table>
228</dl>
229<dl compact><dt><b>Returns:</b></dt><dd>0 if it is a number, something else if is NAN. </dd></dl>
230    </td>
231  </tr>
232</table>
233<a class="anchor" name="126a39f30047703acd42ac277e688959"></a><!-- doxytag: member="FMath::RadToDeg" ref="126a39f30047703acd42ac277e688959" args="(float val)" --><p>
234<table class="mdTable" cellpadding="2" cellspacing="0">
235  <tr>
236    <td class="mdRow">
237      <table cellpadding="0" cellspacing="0" border="0">
238        <tr>
239          <td class="md" nowrap valign="top">float FMath::RadToDeg           </td>
240          <td class="md" valign="top">(&nbsp;</td>
241          <td class="md" nowrap valign="top">float&nbsp;</td>
242          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
243          <td class="md" valign="top">&nbsp;)&nbsp;</td>
244          <td class="md" nowrap><code> [inline]</code></td>
245        </tr>
246      </table>
247    </td>
248  </tr>
249</table>
250<table cellspacing="5" cellpadding="0" border="0">
251  <tr>
252    <td>
253      &nbsp;
254    </td>
255    <td>
256
257<p>
258Convert radians to degrees.
259<p>
260<dl compact><dt><b>Parameters:</b></dt><dd>
261  <table border="0" cellspacing="2" cellpadding="0">
262    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The value in radians. </td></tr>
263  </table>
264</dl>
265<dl compact><dt><b>Returns:</b></dt><dd>The value in degrees. </dd></dl>
266    </td>
267  </tr>
268</table>
269<a class="anchor" name="3f3ff4d162ca9b81672ab8d5ce1a04ed"></a><!-- doxytag: member="FMath::RadToDeg" ref="3f3ff4d162ca9b81672ab8d5ce1a04ed" args="(double val)" --><p>
270<table class="mdTable" cellpadding="2" cellspacing="0">
271  <tr>
272    <td class="mdRow">
273      <table cellpadding="0" cellspacing="0" border="0">
274        <tr>
275          <td class="md" nowrap valign="top">double FMath::RadToDeg           </td>
276          <td class="md" valign="top">(&nbsp;</td>
277          <td class="md" nowrap valign="top">double&nbsp;</td>
278          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
279          <td class="md" valign="top">&nbsp;)&nbsp;</td>
280          <td class="md" nowrap><code> [inline]</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>
294Convert radians to degrees.
295<p>
296<dl compact><dt><b>Parameters:</b></dt><dd>
297  <table border="0" cellspacing="2" cellpadding="0">
298    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The value in radians. </td></tr>
299  </table>
300</dl>
301<dl compact><dt><b>Returns:</b></dt><dd>The value in degrees. </dd></dl>
302    </td>
303  </tr>
304</table>
305<a class="anchor" name="eeb82e7ca4d7ea1d2fe9483f8aae575c"></a><!-- doxytag: member="FMath::Sign" ref="eeb82e7ca4d7ea1d2fe9483f8aae575c" args="(int32 val)" --><p>
306<table class="mdTable" cellpadding="2" cellspacing="0">
307  <tr>
308    <td class="mdRow">
309      <table cellpadding="0" cellspacing="0" border="0">
310        <tr>
311          <td class="md" nowrap valign="top">int32 FMath::Sign           </td>
312          <td class="md" valign="top">(&nbsp;</td>
313          <td class="md" nowrap valign="top">int32&nbsp;</td>
314          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
315          <td class="md" valign="top">&nbsp;)&nbsp;</td>
316          <td class="md" nowrap><code> [inline]</code></td>
317        </tr>
318      </table>
319    </td>
320  </tr>
321</table>
322<table cellspacing="5" cellpadding="0" border="0">
323  <tr>
324    <td>
325      &nbsp;
326    </td>
327    <td>
328
329<p>
330Determine the sign of a number.
331<p>
332<dl compact><dt><b>Parameters:</b></dt><dd>
333  <table border="0" cellspacing="2" cellpadding="0">
334    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The number to check. </td></tr>
335  </table>
336</dl>
337<dl compact><dt><b>Returns:</b></dt><dd>1 if positive, -1 if negative. </dd></dl>
338    </td>
339  </tr>
340</table>
341<a class="anchor" name="48ee0aea01eb950825b923755f4576d2"></a><!-- doxytag: member="FMath::Sign" ref="48ee0aea01eb950825b923755f4576d2" args="(float val)" --><p>
342<table class="mdTable" cellpadding="2" cellspacing="0">
343  <tr>
344    <td class="mdRow">
345      <table cellpadding="0" cellspacing="0" border="0">
346        <tr>
347          <td class="md" nowrap valign="top">float FMath::Sign           </td>
348          <td class="md" valign="top">(&nbsp;</td>
349          <td class="md" nowrap valign="top">float&nbsp;</td>
350          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
351          <td class="md" valign="top">&nbsp;)&nbsp;</td>
352          <td class="md" nowrap><code> [inline]</code></td>
353        </tr>
354      </table>
355    </td>
356  </tr>
357</table>
358<table cellspacing="5" cellpadding="0" border="0">
359  <tr>
360    <td>
361      &nbsp;
362    </td>
363    <td>
364
365<p>
366Determine the sign of a number.
367<p>
368<dl compact><dt><b>Parameters:</b></dt><dd>
369  <table border="0" cellspacing="2" cellpadding="0">
370    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The number to check. </td></tr>
371  </table>
372</dl>
373<dl compact><dt><b>Returns:</b></dt><dd>1.0f if positive, -1.0f if negative. </dd></dl>
374    </td>
375  </tr>
376</table>
377<a class="anchor" name="1190dc2de051037cbb426f9c9aee8046"></a><!-- doxytag: member="FMath::Sign" ref="1190dc2de051037cbb426f9c9aee8046" args="(double val)" --><p>
378<table class="mdTable" cellpadding="2" cellspacing="0">
379  <tr>
380    <td class="mdRow">
381      <table cellpadding="0" cellspacing="0" border="0">
382        <tr>
383          <td class="md" nowrap valign="top">double FMath::Sign           </td>
384          <td class="md" valign="top">(&nbsp;</td>
385          <td class="md" nowrap valign="top">double&nbsp;</td>
386          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
387          <td class="md" valign="top">&nbsp;)&nbsp;</td>
388          <td class="md" nowrap><code> [inline]</code></td>
389        </tr>
390      </table>
391    </td>
392  </tr>
393</table>
394<table cellspacing="5" cellpadding="0" border="0">
395  <tr>
396    <td>
397      &nbsp;
398    </td>
399    <td>
400
401<p>
402Determine the sign of a number.
403<p>
404<dl compact><dt><b>Parameters:</b></dt><dd>
405  <table border="0" cellspacing="2" cellpadding="0">
406    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>The number to check. </td></tr>
407  </table>
408</dl>
409<dl compact><dt><b>Returns:</b></dt><dd>1.0 if positive, -1.0 if negative. </dd></dl>
410    </td>
411  </tr>
412</table>
413<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by&nbsp;
414<a href="http://www.doxygen.org/index.html">
415<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
416</body>
417</html>
Note: See TracBrowser for help on using the repository browser.