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

Revision 964, 32.7 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: FCDTRotation 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>FCDTRotation Class Reference<br>
25<small>
26[<a class="el" href="group___f_c_document.html">COLLADA Document Object Model.</a>]</small>
27</h1><!-- doxytag: class="FCDTRotation" --><!-- doxytag: inherits="FCDTransform" -->A COLLADA angle-axis rotation. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_transform_8h-source.html">FCDTransform.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDTRotation:
33<p><center><img src="class_f_c_d_t_rotation.png" usemap="#FCDTRotation_map" border="0" alt=""></center>
34<map name="FCDTRotation_map">
35<area href="class_f_c_d_transform.html" alt="FCDTransform" shape="rect" coords="0,112,95,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,95,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,95,24">
38</map>
39<a href="class_f_c_d_t_rotation-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></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_c_d_t_rotation.html#e92f4d8903836a1bf832a2c1ca42eb90">FCDTRotation</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *parent)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#e92f4d8903836a1bf832a2c1ca42eb90"></a><br></td></tr>
45<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_t_rotation.html#d152a5e5c06ea5dff5520ff8510f4cd1">~FCDTRotation</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#d152a5e5c06ea5dff5520ff8510f4cd1"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#f5ddd1b7b673eaa1d57f36b4e685a3c8">GetType</a> () const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the transformation class type for the rotation.  <a href="#f5ddd1b7b673eaa1d57f36b4e685a3c8"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_m_vector3.html">FMVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#2c5629790e8172222f1095be97728e6f">GetAxis</a> ()</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the rotation axis.  <a href="#2c5629790e8172222f1095be97728e6f"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2049a1603120ef757614c31110a18a4d"></a><!-- doxytag: member="FCDTRotation::GetAxis" ref="2049a1603120ef757614c31110a18a4d" args="() const " -->
55const <a class="el" href="class_f_m_vector3.html">FMVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#2049a1603120ef757614c31110a18a4d">GetAxis</a> () const </td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
58<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_t_rotation.html#38a9fb0447523cb9c6735508b0cf939a">SetAxis</a> (const <a class="el" href="class_f_m_vector3.html">FMVector3</a> &amp;_axis)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the rotation axis.  <a href="#38a9fb0447523cb9c6735508b0cf939a"></a><br></td></tr>
61<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_t_rotation.html#550e50cede877e255589506c9fbc2e34">SetAxis</a> (float x, float y, float z)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the rotation axis.  <a href="#550e50cede877e255589506c9fbc2e34"></a><br></td></tr>
64<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_t_rotation.html#521fd665dca9d5a92450467a5680a156">GetAngle</a> ()</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the rotation angle.  <a href="#521fd665dca9d5a92450467a5680a156"></a><br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6b9d98eac74729fc5c0c55a13bac478"></a><!-- doxytag: member="FCDTRotation::GetAngle" ref="b6b9d98eac74729fc5c0c55a13bac478" args="() const " -->
68const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#b6b9d98eac74729fc5c0c55a13bac478">GetAngle</a> () const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
71<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_t_rotation.html#097be8d6e0d8f52e9a2da884d3d397ae">SetAngle</a> (float a)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the rotation angle.  <a href="#097be8d6e0d8f52e9a2da884d3d397ae"></a><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_t_rotation.html#233cbce5006d0978ee7dcbd4bf9a5bc4">SetRotation</a> (const <a class="el" href="class_f_m_vector3.html">FMVector3</a> &amp;_axis, float a)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the rotation components.  <a href="#233cbce5006d0978ee7dcbd4bf9a5bc4"></a><br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_m_matrix44.html">FMMatrix44</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#9e2794e2d15d330d604a42668002fe75">ToMatrix</a> () const </td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts the rotation into a matrix.  <a href="#9e2794e2d15d330d604a42668002fe75"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#00cc4223dff938a18c8639629959dc89">IsAnimated</a> () const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether the axis or the angle of the rotation are animated.  <a href="#00cc4223dff938a18c8639629959dc89"></a><br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#e9e58e553b821c9d0ef7663b44fb7898">GetAnimated</a> ()</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the animated element for the angle-axis rotation.  <a href="#e9e58e553b821c9d0ef7663b44fb7898"></a><br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#dd625d4bc7fe5a6d34eebb4f71739d45">IsInverse</a> (const <a class="el" href="class_f_c_d_transform.html">FCDTransform</a> *transform) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether a given transform is the exact opposite of this rotation.  <a href="#dd625d4bc7fe5a6d34eebb4f71739d45"></a><br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_transform.html">FCDTransform</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_t_rotation.html#0aa8efd428677a14d6889edb8bb1b68a">Clone</a> (<a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *newParent)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a copy of the angle-axis rotation.  <a href="#0aa8efd428677a14d6889edb8bb1b68a"></a><br></td></tr>
92<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_t_rotation.html#29ffda23c49e1751c72b5c03d7014daa">LoadFromXML</a> (xmlNode *rotationNode)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the rotation from a given COLLADA XML tree node.  <a href="#29ffda23c49e1751c72b5c03d7014daa"></a><br></td></tr>
95<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_t_rotation.html#9e5499431cf04c8db9eda0d41d50274c">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the rotation to the given COLLADA XML tree node.  <a href="#9e5499431cf04c8db9eda0d41d50274c"></a><br></td></tr>
98</table>
99<hr><a name="_details"></a><h2>Detailed Description</h2>
100A COLLADA angle-axis rotation.
101<p>
102This rotation defines an axis around which the 3D points are rotated by a given angle. <dl compact><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>(clock-wise/counter-clock-wise?)</dd></dl>
103
104<p>
105<hr><h2>Constructor &amp; Destructor Documentation</h2>
106<a class="anchor" name="e92f4d8903836a1bf832a2c1ca42eb90"></a><!-- doxytag: member="FCDTRotation::FCDTRotation" ref="e92f4d8903836a1bf832a2c1ca42eb90" args="(FCDocument *document, FCDSceneNode *parent)" --><p>
107<table class="mdTable" cellpadding="2" cellspacing="0">
108  <tr>
109    <td class="mdRow">
110      <table cellpadding="0" cellspacing="0" border="0">
111        <tr>
112          <td class="md" nowrap valign="top">FCDTRotation::FCDTRotation           </td>
113          <td class="md" valign="top">(&nbsp;</td>
114          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
115          <td class="mdname" nowrap> <em>document</em>, </td>
116        </tr>
117        <tr>
118          <td class="md" nowrap align="right"></td>
119          <td class="md"></td>
120          <td class="md" nowrap><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td>
121          <td class="mdname" nowrap> <em>parent</em></td>
122        </tr>
123        <tr>
124          <td class="md"></td>
125          <td class="md">)&nbsp;</td>
126          <td class="md" colspan="2"></td>
127        </tr>
128      </table>
129    </td>
130  </tr>
131</table>
132<table cellspacing="5" cellpadding="0" border="0">
133  <tr>
134    <td>
135      &nbsp;
136    </td>
137    <td>
138
139<p>
140Constructor: do not use directly.
141<p>
142Instead, use the <a class="el" href="class_f_c_d_scene_node.html#822ee50114c3607ab632a4dd0b405aa1">FCDSceneNode::AddTransform</a> function with the transformation type: ROTATION. <dl compact><dt><b>Parameters:</b></dt><dd>
143  <table border="0" cellspacing="2" cellpadding="0">
144    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the rotation. </td></tr>
145    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The visual scene node that contains the rotation. Set this pointer to NULL if the rotation is not owned by a visual scene node. </td></tr>
146  </table>
147</dl>
148    </td>
149  </tr>
150</table>
151<a class="anchor" name="d152a5e5c06ea5dff5520ff8510f4cd1"></a><!-- doxytag: member="FCDTRotation::~FCDTRotation" ref="d152a5e5c06ea5dff5520ff8510f4cd1" args="()" --><p>
152<table class="mdTable" cellpadding="2" cellspacing="0">
153  <tr>
154    <td class="mdRow">
155      <table cellpadding="0" cellspacing="0" border="0">
156        <tr>
157          <td class="md" nowrap valign="top">virtual FCDTRotation::~FCDTRotation           </td>
158          <td class="md" valign="top">(&nbsp;</td>
159          <td class="mdname1" valign="top" nowrap>          </td>
160          <td class="md" valign="top">&nbsp;)&nbsp;</td>
161          <td class="md" nowrap><code> [virtual]</code></td>
162        </tr>
163      </table>
164    </td>
165  </tr>
166</table>
167<table cellspacing="5" cellpadding="0" border="0">
168  <tr>
169    <td>
170      &nbsp;
171    </td>
172    <td>
173
174<p>
175Destructor: do not use directly.
176<p>
177Instead, use the <a class="el" href="class_f_c_d_scene_node.html#c679529b68c59acb808ff8a14f4d9a33">FCDSceneNode::ReleaseTransform</a> function.     </td>
178  </tr>
179</table>
180<hr><h2>Member Function Documentation</h2>
181<a class="anchor" name="0aa8efd428677a14d6889edb8bb1b68a"></a><!-- doxytag: member="FCDTRotation::Clone" ref="0aa8efd428677a14d6889edb8bb1b68a" args="(FCDSceneNode *newParent)" --><p>
182<table class="mdTable" cellpadding="2" cellspacing="0">
183  <tr>
184    <td class="mdRow">
185      <table cellpadding="0" cellspacing="0" border="0">
186        <tr>
187          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_transform.html">FCDTransform</a>* FCDTRotation::Clone           </td>
188          <td class="md" valign="top">(&nbsp;</td>
189          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td>
190          <td class="mdname1" valign="top" nowrap> <em>newParent</em>          </td>
191          <td class="md" valign="top">&nbsp;)&nbsp;</td>
192          <td class="md" nowrap><code> [virtual]</code></td>
193        </tr>
194      </table>
195    </td>
196  </tr>
197</table>
198<table cellspacing="5" cellpadding="0" border="0">
199  <tr>
200    <td>
201      &nbsp;
202    </td>
203    <td>
204
205<p>
206Creates a copy of the angle-axis rotation.
207<p>
208<dl compact><dt><b>Parameters:</b></dt><dd>
209  <table border="0" cellspacing="2" cellpadding="0">
210    <tr><td valign="top"></td><td valign="top"><em>newParent</em>&nbsp;</td><td>The visual scene node that will contain the clone. </td></tr>
211  </table>
212</dl>
213<dl compact><dt><b>Returns:</b></dt><dd>The cloned angle-axis rotation. </dd></dl>
214
215<p>
216Implements <a class="el" href="class_f_c_d_transform.html#036030bd68c7bf2ba7886b79aeb531f6">FCDTransform</a>.    </td>
217  </tr>
218</table>
219<a class="anchor" name="521fd665dca9d5a92450467a5680a156"></a><!-- doxytag: member="FCDTRotation::GetAngle" ref="521fd665dca9d5a92450467a5680a156" args="()" --><p>
220<table class="mdTable" cellpadding="2" cellspacing="0">
221  <tr>
222    <td class="mdRow">
223      <table cellpadding="0" cellspacing="0" border="0">
224        <tr>
225          <td class="md" nowrap valign="top">float&amp; FCDTRotation::GetAngle           </td>
226          <td class="md" valign="top">(&nbsp;</td>
227          <td class="mdname1" valign="top" nowrap>          </td>
228          <td class="md" valign="top">&nbsp;)&nbsp;</td>
229          <td class="md" nowrap><code> [inline]</code></td>
230        </tr>
231      </table>
232    </td>
233  </tr>
234</table>
235<table cellspacing="5" cellpadding="0" border="0">
236  <tr>
237    <td>
238      &nbsp;
239    </td>
240    <td>
241
242<p>
243Retrieves the rotation angle.
244<p>
245This angle may be animated. <dl compact><dt><b>Returns:</b></dt><dd>The rotation angle, in degrees. </dd></dl>
246    </td>
247  </tr>
248</table>
249<a class="anchor" name="e9e58e553b821c9d0ef7663b44fb7898"></a><!-- doxytag: member="FCDTRotation::GetAnimated" ref="e9e58e553b821c9d0ef7663b44fb7898" args="()" --><p>
250<table class="mdTable" cellpadding="2" cellspacing="0">
251  <tr>
252    <td class="mdRow">
253      <table cellpadding="0" cellspacing="0" border="0">
254        <tr>
255          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_animated.html">FCDAnimated</a>* FCDTRotation::GetAnimated           </td>
256          <td class="md" valign="top">(&nbsp;</td>
257          <td class="mdname1" valign="top" nowrap>          </td>
258          <td class="md" valign="top">&nbsp;)&nbsp;</td>
259          <td class="md" nowrap><code> [virtual]</code></td>
260        </tr>
261      </table>
262    </td>
263  </tr>
264</table>
265<table cellspacing="5" cellpadding="0" border="0">
266  <tr>
267    <td>
268      &nbsp;
269    </td>
270    <td>
271
272<p>
273Retrieves the animated element for the angle-axis rotation.
274<p>
275<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_animated_angle_axis.html">FCDAnimatedAngleAxis</a> </dd></dl>
276<dl compact><dt><b>Returns:</b></dt><dd>The animated element. This pointer will be NULL if the rotation is not animated. </dd></dl>
277
278<p>
279Implements <a class="el" href="class_f_c_d_transform.html#827134177675c23e823dcffdc1c1cdae">FCDTransform</a>.    </td>
280  </tr>
281</table>
282<a class="anchor" name="2c5629790e8172222f1095be97728e6f"></a><!-- doxytag: member="FCDTRotation::GetAxis" ref="2c5629790e8172222f1095be97728e6f" args="()" --><p>
283<table class="mdTable" cellpadding="2" cellspacing="0">
284  <tr>
285    <td class="mdRow">
286      <table cellpadding="0" cellspacing="0" border="0">
287        <tr>
288          <td class="md" nowrap valign="top"><a class="el" href="class_f_m_vector3.html">FMVector3</a>&amp; FCDTRotation::GetAxis           </td>
289          <td class="md" valign="top">(&nbsp;</td>
290          <td class="mdname1" valign="top" nowrap>          </td>
291          <td class="md" valign="top">&nbsp;)&nbsp;</td>
292          <td class="md" nowrap><code> [inline]</code></td>
293        </tr>
294      </table>
295    </td>
296  </tr>
297</table>
298<table cellspacing="5" cellpadding="0" border="0">
299  <tr>
300    <td>
301      &nbsp;
302    </td>
303    <td>
304
305<p>
306Retrieves the rotation axis.
307<p>
308This 3D vector may be animated. <dl compact><dt><b>Returns:</b></dt><dd>The rotation axis. </dd></dl>
309    </td>
310  </tr>
311</table>
312<a class="anchor" name="f5ddd1b7b673eaa1d57f36b4e685a3c8"></a><!-- doxytag: member="FCDTRotation::GetType" ref="f5ddd1b7b673eaa1d57f36b4e685a3c8" args="() const " --><p>
313<table class="mdTable" cellpadding="2" cellspacing="0">
314  <tr>
315    <td class="mdRow">
316      <table cellpadding="0" cellspacing="0" border="0">
317        <tr>
318          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921">Type</a> FCDTRotation::GetType           </td>
319          <td class="md" valign="top">(&nbsp;</td>
320          <td class="mdname1" valign="top" nowrap>          </td>
321          <td class="md" valign="top">&nbsp;)&nbsp;</td>
322          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
323        </tr>
324      </table>
325    </td>
326  </tr>
327</table>
328<table cellspacing="5" cellpadding="0" border="0">
329  <tr>
330    <td>
331      &nbsp;
332    </td>
333    <td>
334
335<p>
336Retrieves the transformation class type for the rotation.
337<p>
338<dl compact><dt><b>Returns:</b></dt><dd>The class type: ROTATION. </dd></dl>
339
340<p>
341Implements <a class="el" href="class_f_c_d_transform.html#f406aebcba6215ebc1358a3cf87ab29d">FCDTransform</a>.    </td>
342  </tr>
343</table>
344<a class="anchor" name="00cc4223dff938a18c8639629959dc89"></a><!-- doxytag: member="FCDTRotation::IsAnimated" ref="00cc4223dff938a18c8639629959dc89" args="() const " --><p>
345<table class="mdTable" cellpadding="2" cellspacing="0">
346  <tr>
347    <td class="mdRow">
348      <table cellpadding="0" cellspacing="0" border="0">
349        <tr>
350          <td class="md" nowrap valign="top">virtual bool FCDTRotation::IsAnimated           </td>
351          <td class="md" valign="top">(&nbsp;</td>
352          <td class="mdname1" valign="top" nowrap>          </td>
353          <td class="md" valign="top">&nbsp;)&nbsp;</td>
354          <td class="md" nowrap> const<code> [virtual]</code></td>
355        </tr>
356      </table>
357    </td>
358  </tr>
359</table>
360<table cellspacing="5" cellpadding="0" border="0">
361  <tr>
362    <td>
363      &nbsp;
364    </td>
365    <td>
366
367<p>
368Retrieves whether the axis or the angle of the rotation are animated.
369<p>
370<dl compact><dt><b>Returns:</b></dt><dd>Whether the rotation is animated. </dd></dl>
371
372<p>
373Implements <a class="el" href="class_f_c_d_transform.html#b12ac63fa2d46fbcf8c025971635cda4">FCDTransform</a>.    </td>
374  </tr>
375</table>
376<a class="anchor" name="dd625d4bc7fe5a6d34eebb4f71739d45"></a><!-- doxytag: member="FCDTRotation::IsInverse" ref="dd625d4bc7fe5a6d34eebb4f71739d45" args="(const FCDTransform *transform) const " --><p>
377<table class="mdTable" cellpadding="2" cellspacing="0">
378  <tr>
379    <td class="mdRow">
380      <table cellpadding="0" cellspacing="0" border="0">
381        <tr>
382          <td class="md" nowrap valign="top">virtual bool FCDTRotation::IsInverse           </td>
383          <td class="md" valign="top">(&nbsp;</td>
384          <td class="md" nowrap valign="top">const <a class="el" href="class_f_c_d_transform.html">FCDTransform</a> *&nbsp;</td>
385          <td class="mdname1" valign="top" nowrap> <em>transform</em>          </td>
386          <td class="md" valign="top">&nbsp;)&nbsp;</td>
387          <td class="md" nowrap> const<code> [virtual]</code></td>
388        </tr>
389      </table>
390    </td>
391  </tr>
392</table>
393<table cellspacing="5" cellpadding="0" border="0">
394  <tr>
395    <td>
396      &nbsp;
397    </td>
398    <td>
399
400<p>
401Retrieves whether a given transform is the exact opposite of this rotation.
402<p>
403The opposite of an angle-axis rotation has the same axis as this rotation but the angle is multiplied by -1. <dl compact><dt><b>Parameters:</b></dt><dd>
404  <table border="0" cellspacing="2" cellpadding="0">
405    <tr><td valign="top"></td><td valign="top"><em>transform</em>&nbsp;</td><td>A second transformation. </td></tr>
406  </table>
407</dl>
408<dl compact><dt><b>Returns:</b></dt><dd>Whether the two rotation are opposites. </dd></dl>
409
410<p>
411Reimplemented from <a class="el" href="class_f_c_d_transform.html#9fa1a02a51f833f819248c2ff020507c">FCDTransform</a>.    </td>
412  </tr>
413</table>
414<a class="anchor" name="29ffda23c49e1751c72b5c03d7014daa"></a><!-- doxytag: member="FCDTRotation::LoadFromXML" ref="29ffda23c49e1751c72b5c03d7014daa" args="(xmlNode *rotationNode)" --><p>
415<table class="mdTable" cellpadding="2" cellspacing="0">
416  <tr>
417    <td class="mdRow">
418      <table cellpadding="0" cellspacing="0" border="0">
419        <tr>
420          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDTRotation::LoadFromXML           </td>
421          <td class="md" valign="top">(&nbsp;</td>
422          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
423          <td class="mdname1" valign="top" nowrap> <em>rotationNode</em>          </td>
424          <td class="md" valign="top">&nbsp;)&nbsp;</td>
425          <td class="md" nowrap><code> [virtual]</code></td>
426        </tr>
427      </table>
428    </td>
429  </tr>
430</table>
431<table cellspacing="5" cellpadding="0" border="0">
432  <tr>
433    <td>
434      &nbsp;
435    </td>
436    <td>
437
438<p>
439[INTERNAL] Reads in the rotation from a given COLLADA XML tree node.
440<p>
441<dl compact><dt><b>Parameters:</b></dt><dd>
442  <table border="0" cellspacing="2" cellpadding="0">
443    <tr><td valign="top"></td><td valign="top"><em>rotationNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
444  </table>
445</dl>
446<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 rotation. </dd></dl>
447
448<p>
449Implements <a class="el" href="class_f_c_d_transform.html#b6ec75fc9ed1c6d4e03a781c251682fc">FCDTransform</a>.    </td>
450  </tr>
451</table>
452<a class="anchor" name="097be8d6e0d8f52e9a2da884d3d397ae"></a><!-- doxytag: member="FCDTRotation::SetAngle" ref="097be8d6e0d8f52e9a2da884d3d397ae" args="(float a)" --><p>
453<table class="mdTable" cellpadding="2" cellspacing="0">
454  <tr>
455    <td class="mdRow">
456      <table cellpadding="0" cellspacing="0" border="0">
457        <tr>
458          <td class="md" nowrap valign="top">void FCDTRotation::SetAngle           </td>
459          <td class="md" valign="top">(&nbsp;</td>
460          <td class="md" nowrap valign="top">float&nbsp;</td>
461          <td class="mdname1" valign="top" nowrap> <em>a</em>          </td>
462          <td class="md" valign="top">&nbsp;)&nbsp;</td>
463          <td class="md" nowrap><code> [inline]</code></td>
464        </tr>
465      </table>
466    </td>
467  </tr>
468</table>
469<table cellspacing="5" cellpadding="0" border="0">
470  <tr>
471    <td>
472      &nbsp;
473    </td>
474    <td>
475
476<p>
477Sets the rotation angle.
478<p>
479<dl compact><dt><b>Parameters:</b></dt><dd>
480  <table border="0" cellspacing="2" cellpadding="0">
481    <tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>The rotation angle, in degrees. </td></tr>
482  </table>
483</dl>
484    </td>
485  </tr>
486</table>
487<a class="anchor" name="550e50cede877e255589506c9fbc2e34"></a><!-- doxytag: member="FCDTRotation::SetAxis" ref="550e50cede877e255589506c9fbc2e34" args="(float x, float y, float z)" --><p>
488<table class="mdTable" cellpadding="2" cellspacing="0">
489  <tr>
490    <td class="mdRow">
491      <table cellpadding="0" cellspacing="0" border="0">
492        <tr>
493          <td class="md" nowrap valign="top">void FCDTRotation::SetAxis           </td>
494          <td class="md" valign="top">(&nbsp;</td>
495          <td class="md" nowrap valign="top">float&nbsp;</td>
496          <td class="mdname" nowrap> <em>x</em>, </td>
497        </tr>
498        <tr>
499          <td class="md" nowrap align="right"></td>
500          <td class="md"></td>
501          <td class="md" nowrap>float&nbsp;</td>
502          <td class="mdname" nowrap> <em>y</em>, </td>
503        </tr>
504        <tr>
505          <td class="md" nowrap align="right"></td>
506          <td class="md"></td>
507          <td class="md" nowrap>float&nbsp;</td>
508          <td class="mdname" nowrap> <em>z</em></td>
509        </tr>
510        <tr>
511          <td class="md"></td>
512          <td class="md">)&nbsp;</td>
513          <td class="md" colspan="2"><code> [inline]</code></td>
514        </tr>
515      </table>
516    </td>
517  </tr>
518</table>
519<table cellspacing="5" cellpadding="0" border="0">
520  <tr>
521    <td>
522      &nbsp;
523    </td>
524    <td>
525
526<p>
527Sets the rotation axis.
528<p>
529<dl compact><dt><b>Parameters:</b></dt><dd>
530  <table border="0" cellspacing="2" cellpadding="0">
531    <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>The x-component of the rotation axis. </td></tr>
532    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>The y-component of the rotation axis. </td></tr>
533    <tr><td valign="top"></td><td valign="top"><em>z</em>&nbsp;</td><td>The z-component of the rotation axis. </td></tr>
534  </table>
535</dl>
536    </td>
537  </tr>
538</table>
539<a class="anchor" name="38a9fb0447523cb9c6735508b0cf939a"></a><!-- doxytag: member="FCDTRotation::SetAxis" ref="38a9fb0447523cb9c6735508b0cf939a" args="(const FMVector3 &amp;_axis)" --><p>
540<table class="mdTable" cellpadding="2" cellspacing="0">
541  <tr>
542    <td class="mdRow">
543      <table cellpadding="0" cellspacing="0" border="0">
544        <tr>
545          <td class="md" nowrap valign="top">void FCDTRotation::SetAxis           </td>
546          <td class="md" valign="top">(&nbsp;</td>
547          <td class="md" nowrap valign="top">const <a class="el" href="class_f_m_vector3.html">FMVector3</a> &amp;&nbsp;</td>
548          <td class="mdname1" valign="top" nowrap> <em>_axis</em>          </td>
549          <td class="md" valign="top">&nbsp;)&nbsp;</td>
550          <td class="md" nowrap><code> [inline]</code></td>
551        </tr>
552      </table>
553    </td>
554  </tr>
555</table>
556<table cellspacing="5" cellpadding="0" border="0">
557  <tr>
558    <td>
559      &nbsp;
560    </td>
561    <td>
562
563<p>
564Sets the rotation axis.
565<p>
566<dl compact><dt><b>Parameters:</b></dt><dd>
567  <table border="0" cellspacing="2" cellpadding="0">
568    <tr><td valign="top"></td><td valign="top"><em>_axis</em>&nbsp;</td><td>The rotation axis. </td></tr>
569  </table>
570</dl>
571    </td>
572  </tr>
573</table>
574<a class="anchor" name="233cbce5006d0978ee7dcbd4bf9a5bc4"></a><!-- doxytag: member="FCDTRotation::SetRotation" ref="233cbce5006d0978ee7dcbd4bf9a5bc4" args="(const FMVector3 &amp;_axis, float a)" --><p>
575<table class="mdTable" cellpadding="2" cellspacing="0">
576  <tr>
577    <td class="mdRow">
578      <table cellpadding="0" cellspacing="0" border="0">
579        <tr>
580          <td class="md" nowrap valign="top">void FCDTRotation::SetRotation           </td>
581          <td class="md" valign="top">(&nbsp;</td>
582          <td class="md" nowrap valign="top">const <a class="el" href="class_f_m_vector3.html">FMVector3</a> &amp;&nbsp;</td>
583          <td class="mdname" nowrap> <em>_axis</em>, </td>
584        </tr>
585        <tr>
586          <td class="md" nowrap align="right"></td>
587          <td class="md"></td>
588          <td class="md" nowrap>float&nbsp;</td>
589          <td class="mdname" nowrap> <em>a</em></td>
590        </tr>
591        <tr>
592          <td class="md"></td>
593          <td class="md">)&nbsp;</td>
594          <td class="md" colspan="2"><code> [inline]</code></td>
595        </tr>
596      </table>
597    </td>
598  </tr>
599</table>
600<table cellspacing="5" cellpadding="0" border="0">
601  <tr>
602    <td>
603      &nbsp;
604    </td>
605    <td>
606
607<p>
608Sets the rotation components.
609<p>
610<dl compact><dt><b>Parameters:</b></dt><dd>
611  <table border="0" cellspacing="2" cellpadding="0">
612    <tr><td valign="top"></td><td valign="top"><em>_axis</em>&nbsp;</td><td>The rotation axis. </td></tr>
613    <tr><td valign="top"></td><td valign="top"><em>a</em>&nbsp;</td><td>The rotation angle, in degrees. </td></tr>
614  </table>
615</dl>
616    </td>
617  </tr>
618</table>
619<a class="anchor" name="9e2794e2d15d330d604a42668002fe75"></a><!-- doxytag: member="FCDTRotation::ToMatrix" ref="9e2794e2d15d330d604a42668002fe75" args="() const " --><p>
620<table class="mdTable" cellpadding="2" cellspacing="0">
621  <tr>
622    <td class="mdRow">
623      <table cellpadding="0" cellspacing="0" border="0">
624        <tr>
625          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_m_matrix44.html">FMMatrix44</a> FCDTRotation::ToMatrix           </td>
626          <td class="md" valign="top">(&nbsp;</td>
627          <td class="mdname1" valign="top" nowrap>          </td>
628          <td class="md" valign="top">&nbsp;)&nbsp;</td>
629          <td class="md" nowrap> const<code> [virtual]</code></td>
630        </tr>
631      </table>
632    </td>
633  </tr>
634</table>
635<table cellspacing="5" cellpadding="0" border="0">
636  <tr>
637    <td>
638      &nbsp;
639    </td>
640    <td>
641
642<p>
643Converts the rotation into a matrix.
644<p>
645<dl compact><dt><b>Returns:</b></dt><dd>A matrix equivalent of the rotation. </dd></dl>
646
647<p>
648Implements <a class="el" href="class_f_c_d_transform.html#fd7fc3c7dc012782ebb2886c5bc13d01">FCDTransform</a>.    </td>
649  </tr>
650</table>
651<a class="anchor" name="9e5499431cf04c8db9eda0d41d50274c"></a><!-- doxytag: member="FCDTRotation::WriteToXML" ref="9e5499431cf04c8db9eda0d41d50274c" args="(xmlNode *parentNode) const " --><p>
652<table class="mdTable" cellpadding="2" cellspacing="0">
653  <tr>
654    <td class="mdRow">
655      <table cellpadding="0" cellspacing="0" border="0">
656        <tr>
657          <td class="md" nowrap valign="top">virtual xmlNode* FCDTRotation::WriteToXML           </td>
658          <td class="md" valign="top">(&nbsp;</td>
659          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
660          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
661          <td class="md" valign="top">&nbsp;)&nbsp;</td>
662          <td class="md" nowrap> const<code> [virtual]</code></td>
663        </tr>
664      </table>
665    </td>
666  </tr>
667</table>
668<table cellspacing="5" cellpadding="0" border="0">
669  <tr>
670    <td>
671      &nbsp;
672    </td>
673    <td>
674
675<p>
676[INTERNAL] Writes out the rotation to the given COLLADA XML tree node.
677<p>
678<dl compact><dt><b>Parameters:</b></dt><dd>
679  <table border="0" cellspacing="2" cellpadding="0">
680    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the rotation. </td></tr>
681  </table>
682</dl>
683<dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl>
684
685<p>
686Implements <a class="el" href="class_f_c_d_transform.html#cd254f154a32d1e313001ee4d693162a">FCDTransform</a>.    </td>
687  </tr>
688</table>
689<hr>The documentation for this class was generated from the following file:<ul>
690<li>FCDocument/<a class="el" href="_f_c_d_transform_8h-source.html">FCDTransform.h</a></ul>
691<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by&nbsp;
692<a href="http://www.doxygen.org/index.html">
693<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
694</body>
695</html>
Note: See TracBrowser for help on using the repository browser.