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

Revision 964, 13.6 KB checked in by igarcia, 18 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FMVector2 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>FMVector2 Class Reference<br>
25<small>
26[<a class="el" href="group___f_math.html">Mathematics Classes.</a>]</small>
27</h1><!-- doxytag: class="FMVector2" -->A 2 dimensional vector. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_m_vector2_8h-source.html">FMVector2.h</a>&gt;</code>
31<p>
32<a href="class_f_m_vector2-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
33<tr><td></td></tr>
34<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
35<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a96a0629fd333f71e455fcc2069b3193"></a><!-- doxytag: member="FMVector2::FMVector2" ref="a96a0629fd333f71e455fcc2069b3193" args="()" -->
36&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#a96a0629fd333f71e455fcc2069b3193">FMVector2</a> ()</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates an empty <a class="el" href="class_f_m_vector2.html">FMVector2</a>. <br></td></tr>
39<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#29aeec6ea2cf4feb0375af535f8e7490">FMVector2</a> (float _u, float _v)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates the <a class="el" href="class_f_m_vector2.html">FMVector2</a> with the coordinates given.  <a href="#29aeec6ea2cf4feb0375af535f8e7490"></a><br></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#c7b603a55230c6f7d50a5706f5266c91">operator float *</a> ()</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get this <a class="el" href="class_f_m_vector2.html">FMVector2</a> as an array of <code>floats</code>.  <a href="#c7b603a55230c6f7d50a5706f5266c91"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_m_vector2.html">FMVector2</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#10996ad35ebbe593238dd505232cbad9">operator+=</a> (const <a class="el" href="class_f_m_vector2.html">FMVector2</a> &amp;a)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds two <a class="el" href="class_f_m_vector2.html">FMVector2</a>.  <a href="#10996ad35ebbe593238dd505232cbad9"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_m_vector2.html">FMVector2</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#bdfa0a7c8b6ae45995d14a3f133e88a0">operator *=</a> (float a)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Multiplies this <a class="el" href="class_f_m_vector2.html">FMVector2</a> by a scaler.  <a href="#bdfa0a7c8b6ae45995d14a3f133e88a0"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_m_vector2.html">FMVector2</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#a4138ab608dde492d0f7fa5cb61b225c">operator=</a> (const float *f)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assign this <a class="el" href="class_f_m_vector2.html">FMVector2</a> to the given float array.  <a href="#a4138ab608dde492d0f7fa5cb61b225c"></a><br></td></tr>
54<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9271c21509c9a23fdeaacb30e3ec49f"></a><!-- doxytag: member="FMVector2::u" ref="e9271c21509c9a23fdeaacb30e3ec49f" args="" -->
56float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#e9271c21509c9a23fdeaacb30e3ec49f">u</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The first coordinate. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d336a3412e6070c3419df8a82ccdfeac"></a><!-- doxytag: member="FMVector2::v" ref="d336a3412e6070c3419df8a82ccdfeac" args="" -->
60float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_m_vector2.html#d336a3412e6070c3419df8a82ccdfeac">v</a></td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The second coordinate. <br></td></tr>
63</table>
64<hr><a name="_details"></a><h2>Detailed Description</h2>
65A 2 dimensional vector.
66<p>
67Not used within <a class="el" href="namespace_f_collada.html">FCollada</a>.
68<p>
69<hr><h2>Constructor &amp; Destructor Documentation</h2>
70<a class="anchor" name="29aeec6ea2cf4feb0375af535f8e7490"></a><!-- doxytag: member="FMVector2::FMVector2" ref="29aeec6ea2cf4feb0375af535f8e7490" args="(float _u, float _v)" --><p>
71<table class="mdTable" cellpadding="2" cellspacing="0">
72  <tr>
73    <td class="mdRow">
74      <table cellpadding="0" cellspacing="0" border="0">
75        <tr>
76          <td class="md" nowrap valign="top">FMVector2::FMVector2           </td>
77          <td class="md" valign="top">(&nbsp;</td>
78          <td class="md" nowrap valign="top">float&nbsp;</td>
79          <td class="mdname" nowrap> <em>_u</em>, </td>
80        </tr>
81        <tr>
82          <td class="md" nowrap align="right"></td>
83          <td class="md"></td>
84          <td class="md" nowrap>float&nbsp;</td>
85          <td class="mdname" nowrap> <em>_v</em></td>
86        </tr>
87        <tr>
88          <td class="md"></td>
89          <td class="md">)&nbsp;</td>
90          <td class="md" colspan="2"><code> [inline]</code></td>
91        </tr>
92      </table>
93    </td>
94  </tr>
95</table>
96<table cellspacing="5" cellpadding="0" border="0">
97  <tr>
98    <td>
99      &nbsp;
100    </td>
101    <td>
102
103<p>
104Creates the <a class="el" href="class_f_m_vector2.html">FMVector2</a> with the coordinates given.
105<p>
106<dl compact><dt><b>Parameters:</b></dt><dd>
107  <table border="0" cellspacing="2" cellpadding="0">
108    <tr><td valign="top"></td><td valign="top"><em>_u</em>&nbsp;</td><td>The first coordinate. </td></tr>
109    <tr><td valign="top"></td><td valign="top"><em>_v</em>&nbsp;</td><td>The second coordinate. </td></tr>
110  </table>
111</dl>
112    </td>
113  </tr>
114</table>
115<hr><h2>Member Function Documentation</h2>
116<a class="anchor" name="bdfa0a7c8b6ae45995d14a3f133e88a0"></a><!-- doxytag: member="FMVector2::operator *=" ref="bdfa0a7c8b6ae45995d14a3f133e88a0" args="(float a)" --><p>
117<table class="mdTable" cellpadding="2" cellspacing="0">
118  <tr>
119    <td class="mdRow">
120      <table cellpadding="0" cellspacing="0" border="0">
121        <tr>
122          <td class="md" nowrap valign="top"><a class="el" href="class_f_m_vector2.html">FMVector2</a>&amp; FMVector2::operator *=           </td>
123          <td class="md" valign="top">(&nbsp;</td>
124          <td class="md" nowrap valign="top">float&nbsp;</td>
125          <td class="mdname1" valign="top" nowrap> <em>a</em>          </td>
126          <td class="md" valign="top">&nbsp;)&nbsp;</td>
127          <td class="md" nowrap><code> [inline]</code></td>
128        </tr>
129      </table>
130    </td>
131  </tr>
132</table>
133<table cellspacing="5" cellpadding="0" border="0">
134  <tr>
135    <td>
136      &nbsp;
137    </td>
138    <td>
139
140<p>
141Multiplies this <a class="el" href="class_f_m_vector2.html">FMVector2</a> by a scaler.
142<p>
143Multiplies each of this FMVector2's coordinates with the scaler and returns this <a class="el" href="class_f_m_vector2.html">FMVector2</a>.<p>
144<dl compact><dt><b>Parameters:</b></dt><dd>
145  <table border="0" cellspacing="2" cellpadding="0">
146    <tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>The scalar to multiply with. </td></tr>
147  </table>
148</dl>
149<dl compact><dt><b>Returns:</b></dt><dd>This <a class="el" href="class_f_m_vector2.html">FMVector2</a>. </dd></dl>
150    </td>
151  </tr>
152</table>
153<a class="anchor" name="c7b603a55230c6f7d50a5706f5266c91"></a><!-- doxytag: member="FMVector2::operator float *" ref="c7b603a55230c6f7d50a5706f5266c91" args="()" --><p>
154<table class="mdTable" cellpadding="2" cellspacing="0">
155  <tr>
156    <td class="mdRow">
157      <table cellpadding="0" cellspacing="0" border="0">
158        <tr>
159          <td class="md" nowrap valign="top">FMVector2::operator float *           </td>
160          <td class="md" valign="top">(&nbsp;</td>
161          <td class="mdname1" valign="top" nowrap>          </td>
162          <td class="md" valign="top">&nbsp;)&nbsp;</td>
163          <td class="md" nowrap><code> [inline]</code></td>
164        </tr>
165      </table>
166    </td>
167  </tr>
168</table>
169<table cellspacing="5" cellpadding="0" border="0">
170  <tr>
171    <td>
172      &nbsp;
173    </td>
174    <td>
175
176<p>
177Get this <a class="el" href="class_f_m_vector2.html">FMVector2</a> as an array of <code>floats</code>.
178<p>
179<dl compact><dt><b>Returns:</b></dt><dd>The <code>float</code> array. </dd></dl>
180    </td>
181  </tr>
182</table>
183<a class="anchor" name="10996ad35ebbe593238dd505232cbad9"></a><!-- doxytag: member="FMVector2::operator+=" ref="10996ad35ebbe593238dd505232cbad9" args="(const FMVector2 &amp;a)" --><p>
184<table class="mdTable" cellpadding="2" cellspacing="0">
185  <tr>
186    <td class="mdRow">
187      <table cellpadding="0" cellspacing="0" border="0">
188        <tr>
189          <td class="md" nowrap valign="top"><a class="el" href="class_f_m_vector2.html">FMVector2</a>&amp; FMVector2::operator+=           </td>
190          <td class="md" valign="top">(&nbsp;</td>
191          <td class="md" nowrap valign="top">const <a class="el" href="class_f_m_vector2.html">FMVector2</a> &amp;&nbsp;</td>
192          <td class="mdname1" valign="top" nowrap> <em>a</em>          </td>
193          <td class="md" valign="top">&nbsp;)&nbsp;</td>
194          <td class="md" nowrap><code> [inline]</code></td>
195        </tr>
196      </table>
197    </td>
198  </tr>
199</table>
200<table cellspacing="5" cellpadding="0" border="0">
201  <tr>
202    <td>
203      &nbsp;
204    </td>
205    <td>
206
207<p>
208Adds two <a class="el" href="class_f_m_vector2.html">FMVector2</a>.
209<p>
210Adds to this FMVector2's coordinates the individual components of the given <a class="el" href="class_f_m_vector2.html">FMVector2</a> and returns this <a class="el" href="class_f_m_vector2.html">FMVector2</a>.<p>
211<dl compact><dt><b>Parameters:</b></dt><dd>
212  <table border="0" cellspacing="2" cellpadding="0">
213    <tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>The <a class="el" href="class_f_m_vector2.html">FMVector2</a> to add with this one. </td></tr>
214  </table>
215</dl>
216<dl compact><dt><b>Returns:</b></dt><dd>This <a class="el" href="class_f_m_vector2.html">FMVector2</a>. </dd></dl>
217    </td>
218  </tr>
219</table>
220<a class="anchor" name="a4138ab608dde492d0f7fa5cb61b225c"></a><!-- doxytag: member="FMVector2::operator=" ref="a4138ab608dde492d0f7fa5cb61b225c" args="(const float *f)" --><p>
221<table class="mdTable" cellpadding="2" cellspacing="0">
222  <tr>
223    <td class="mdRow">
224      <table cellpadding="0" cellspacing="0" border="0">
225        <tr>
226          <td class="md" nowrap valign="top"><a class="el" href="class_f_m_vector2.html">FMVector2</a>&amp; FMVector2::operator=           </td>
227          <td class="md" valign="top">(&nbsp;</td>
228          <td class="md" nowrap valign="top">const float *&nbsp;</td>
229          <td class="mdname1" valign="top" nowrap> <em>f</em>          </td>
230          <td class="md" valign="top">&nbsp;)&nbsp;</td>
231          <td class="md" nowrap><code> [inline]</code></td>
232        </tr>
233      </table>
234    </td>
235  </tr>
236</table>
237<table cellspacing="5" cellpadding="0" border="0">
238  <tr>
239    <td>
240      &nbsp;
241    </td>
242    <td>
243
244<p>
245Assign this <a class="el" href="class_f_m_vector2.html">FMVector2</a> to the given float array.
246<p>
247Assigns each coordinate of this <a class="el" href="class_f_m_vector2.html">FMVector2</a> to the elements in the <code>float</code> array. The first element to the first coordinate and the second to the second. It returns this <a class="el" href="class_f_m_vector2.html">FMVector2</a>.<p>
248<dl compact><dt><b>Parameters:</b></dt><dd>
249  <table border="0" cellspacing="2" cellpadding="0">
250    <tr><td valign="top"></td><td valign="top"><em>f</em>&nbsp;</td><td>The <code>float</code> array to assign with. </td></tr>
251  </table>
252</dl>
253<dl compact><dt><b>Returns:</b></dt><dd>This <a class="el" href="class_f_m_vector2.html">FMVector2</a>. </dd></dl>
254    </td>
255  </tr>
256</table>
257<hr>The documentation for this class was generated from the following file:<ul>
258<li>FMath/<a class="el" href="_f_m_vector2_8h-source.html">FMVector2.h</a></ul>
259<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by&nbsp;
260<a href="http://www.doxygen.org/index.html">
261<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
262</body>
263</html>
Note: See TracBrowser for help on using the repository browser.