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

Revision 964, 31.5 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: FCDTransform 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>FCDTransform 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="FCDTransform" --><!-- doxytag: inherits="FCDObject" -->A COLLADA transform. 
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 FCDTransform:
33<p><center><img src="class_f_c_d_transform.png" usemap="#FCDTransform_map" border="0" alt=""></center>
34<map name="FCDTransform_map">
35<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="292,56,399,80">
36<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="292,0,399,24">
37<area href="class_f_c_d_t_look_at.html" alt="FCDTLookAt" shape="rect" coords="0,168,107,192">
38<area href="class_f_c_d_t_matrix.html" alt="FCDTMatrix" shape="rect" coords="117,168,224,192">
39<area href="class_f_c_d_t_rotation.html" alt="FCDTRotation" shape="rect" coords="234,168,341,192">
40<area href="class_f_c_d_t_scale.html" alt="FCDTScale" shape="rect" coords="351,168,458,192">
41<area href="class_f_c_d_t_skew.html" alt="FCDTSkew" shape="rect" coords="468,168,575,192">
42<area href="class_f_c_d_t_translation.html" alt="FCDTTranslation" shape="rect" coords="585,168,692,192">
43</map>
44<a href="class_f_c_d_transform-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
45<tr><td></td></tr>
46<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921">Type</a> { <br>
48&nbsp;&nbsp;<a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc89217e6c276586b7bbb02f2b4a93a9581873">TRANSLATION</a>,
49<a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921f978abed37815c8a60a1c76745767eb6">ROTATION</a>,
50<a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921ca207c4221523864b49deac186a4bd05">SCALE</a>,
51<a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc892179c19319d29f4eb2afa8ab313fe2792d">MATRIX</a>,
52<br>
53&nbsp;&nbsp;<a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921381eafef1b7eb3501ae84f5e19071a35">LOOKAT</a>,
54<a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc892164a79e08a191d674915594b9bdbeb6ad">SKEW</a>
55<br>
56 }</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The COLLADA transform types.  <a href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921">More...</a><br></td></tr>
59<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_transform.html#18daaaf8c64578eeebdaa5e5e09c6b66">FCDTransform</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>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#18daaaf8c64578eeebdaa5e5e09c6b66"></a><br></td></tr>
63<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_transform.html#359b876a9da98cc1f7dc9eaf51759f32">~FCDTransform</a> ()</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#359b876a9da98cc1f7dc9eaf51759f32"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_transform.html#3da9bedb5a4ff62df3ffe10672a34e0a">GetParent</a> ()</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the visual scene node that contains this transformation.  <a href="#3da9bedb5a4ff62df3ffe10672a34e0a"></a><br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75778e4996553320c274a21cc120014b"></a><!-- doxytag: member="FCDTransform::GetParent" ref="75778e4996553320c274a21cc120014b" args="() const " -->
70const <a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_transform.html#75778e4996553320c274a21cc120014b">GetParent</a> () const </td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
73<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_transform.html#036030bd68c7bf2ba7886b79aeb531f6">Clone</a> (<a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *newParent)=0</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a copy of a transformation.  <a href="#036030bd68c7bf2ba7886b79aeb531f6"></a><br></td></tr>
76<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_transform.html#f406aebcba6215ebc1358a3cf87ab29d">GetType</a> () const =0</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the class type of the transformation.  <a href="#f406aebcba6215ebc1358a3cf87ab29d"></a><br></td></tr>
79<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_transform.html#fd7fc3c7dc012782ebb2886c5bc13d01">ToMatrix</a> () const =0</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Converts the transformation into a matrix.  <a href="#fd7fc3c7dc012782ebb2886c5bc13d01"></a><br></td></tr>
82<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_transform.html#b12ac63fa2d46fbcf8c025971635cda4">IsAnimated</a> () const =0</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether this transformation has an animation tied to its values.  <a href="#b12ac63fa2d46fbcf8c025971635cda4"></a><br></td></tr>
85<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_transform.html#827134177675c23e823dcffdc1c1cdae">GetAnimated</a> ()=0</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the animated element for the transformation.  <a href="#827134177675c23e823dcffdc1c1cdae"></a><br></td></tr>
88<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_transform.html#9fa1a02a51f833f819248c2ff020507c">IsInverse</a> (const <a class="el" href="class_f_c_d_transform.html">FCDTransform</a> *transform) const </td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether a given transformation is the exact opposite of this transformation.  <a href="#9fa1a02a51f833f819248c2ff020507c"></a><br></td></tr>
91<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_transform.html#b6ec75fc9ed1c6d4e03a781c251682fc">LoadFromXML</a> (xmlNode *transformNode)=0</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the transformation from a given COLLADA XML tree node.  <a href="#b6ec75fc9ed1c6d4e03a781c251682fc"></a><br></td></tr>
94<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_transform.html#cd254f154a32d1e313001ee4d693162a">WriteToXML</a> (xmlNode *parentNode) const =0</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the transformation to the given COLLADA XML tree node.  <a href="#cd254f154a32d1e313001ee4d693162a"></a><br></td></tr>
97</table>
98<hr><a name="_details"></a><h2>Detailed Description</h2>
99A COLLADA transform.
100<p>
101COLLADA supports six transformation types: translations(FCDTTranslation), rotations(FCDTRotation), scales(FCDTScale), matrices(FCDTMatrix), skews(FCDTSkew) and the 'look-at' transform(FCDTLookAt).
102<p>
103<hr><h2>Member Enumeration Documentation</h2>
104<a class="anchor" name="13e561c5e53aeaf84dedf4661cdc8921"></a><!-- doxytag: member="FCDTransform::Type" ref="13e561c5e53aeaf84dedf4661cdc8921" args="" --><p>
105<table class="mdTable" cellpadding="2" cellspacing="0">
106  <tr>
107    <td class="mdRow">
108      <table cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921">FCDTransform::Type</a>          </td>
111        </tr>
112      </table>
113    </td>
114  </tr>
115</table>
116<table cellspacing="5" cellpadding="0" border="0">
117  <tr>
118    <td>
119      &nbsp;
120    </td>
121    <td>
122
123<p>
124The COLLADA transform types.
125<p>
126<dl compact><dt><b>Enumerator: </b></dt><dd>
127<table border="0" cellspacing="2" cellpadding="0">
128<tr><td valign="top"><em><a class="anchor" name="13e561c5e53aeaf84dedf4661cdc89217e6c276586b7bbb02f2b4a93a9581873"></a><!-- doxytag: member="TRANSLATION" ref="13e561c5e53aeaf84dedf4661cdc89217e6c276586b7bbb02f2b4a93a9581873" args="" -->TRANSLATION</em>&nbsp;</td><td>
129A translation(FCDTTranslation). </td></tr>
130<tr><td valign="top"><em><a class="anchor" name="13e561c5e53aeaf84dedf4661cdc8921f978abed37815c8a60a1c76745767eb6"></a><!-- doxytag: member="ROTATION" ref="13e561c5e53aeaf84dedf4661cdc8921f978abed37815c8a60a1c76745767eb6" args="" -->ROTATION</em>&nbsp;</td><td>
131A rotation(FCDTRotation). </td></tr>
132<tr><td valign="top"><em><a class="anchor" name="13e561c5e53aeaf84dedf4661cdc8921ca207c4221523864b49deac186a4bd05"></a><!-- doxytag: member="SCALE" ref="13e561c5e53aeaf84dedf4661cdc8921ca207c4221523864b49deac186a4bd05" args="" -->SCALE</em>&nbsp;</td><td>
133A non-uniform scale(FCDTScale). </td></tr>
134<tr><td valign="top"><em><a class="anchor" name="13e561c5e53aeaf84dedf4661cdc892179c19319d29f4eb2afa8ab313fe2792d"></a><!-- doxytag: member="MATRIX" ref="13e561c5e53aeaf84dedf4661cdc892179c19319d29f4eb2afa8ab313fe2792d" args="" -->MATRIX</em>&nbsp;</td><td>
135A matrix multiplication(FCDTMatrix). </td></tr>
136<tr><td valign="top"><em><a class="anchor" name="13e561c5e53aeaf84dedf4661cdc8921381eafef1b7eb3501ae84f5e19071a35"></a><!-- doxytag: member="LOOKAT" ref="13e561c5e53aeaf84dedf4661cdc8921381eafef1b7eb3501ae84f5e19071a35" args="" -->LOOKAT</em>&nbsp;</td><td>
137A targeted, 'look-at' transformation(FCDTLookAt). </td></tr>
138<tr><td valign="top"><em><a class="anchor" name="13e561c5e53aeaf84dedf4661cdc892164a79e08a191d674915594b9bdbeb6ad"></a><!-- doxytag: member="SKEW" ref="13e561c5e53aeaf84dedf4661cdc892164a79e08a191d674915594b9bdbeb6ad" args="" -->SKEW</em>&nbsp;</td><td>
139A skew(FCDTSkew). </td></tr>
140</table>
141</dl>
142    </td>
143  </tr>
144</table>
145<hr><h2>Constructor &amp; Destructor Documentation</h2>
146<a class="anchor" name="18daaaf8c64578eeebdaa5e5e09c6b66"></a><!-- doxytag: member="FCDTransform::FCDTransform" ref="18daaaf8c64578eeebdaa5e5e09c6b66" args="(FCDocument *document, FCDSceneNode *parent)" --><p>
147<table class="mdTable" cellpadding="2" cellspacing="0">
148  <tr>
149    <td class="mdRow">
150      <table cellpadding="0" cellspacing="0" border="0">
151        <tr>
152          <td class="md" nowrap valign="top">FCDTransform::FCDTransform           </td>
153          <td class="md" valign="top">(&nbsp;</td>
154          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
155          <td class="mdname" nowrap> <em>document</em>, </td>
156        </tr>
157        <tr>
158          <td class="md" nowrap align="right"></td>
159          <td class="md"></td>
160          <td class="md" nowrap><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td>
161          <td class="mdname" nowrap> <em>parent</em></td>
162        </tr>
163        <tr>
164          <td class="md"></td>
165          <td class="md">)&nbsp;</td>
166          <td class="md" colspan="2"></td>
167        </tr>
168      </table>
169    </td>
170  </tr>
171</table>
172<table cellspacing="5" cellpadding="0" border="0">
173  <tr>
174    <td>
175      &nbsp;
176    </td>
177    <td>
178
179<p>
180Constructor: do not use directly.
181<p>
182Instead, use the <a class="el" href="class_f_c_d_scene_node.html#822ee50114c3607ab632a4dd0b405aa1">FCDSceneNode::AddTransform</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
183  <table border="0" cellspacing="2" cellpadding="0">
184    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the transform. </td></tr>
185    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The visual scene node that contains the transform. Set this pointer to NULL if this transform is not owned by a visual scene node. </td></tr>
186  </table>
187</dl>
188    </td>
189  </tr>
190</table>
191<a class="anchor" name="359b876a9da98cc1f7dc9eaf51759f32"></a><!-- doxytag: member="FCDTransform::~FCDTransform" ref="359b876a9da98cc1f7dc9eaf51759f32" args="()" --><p>
192<table class="mdTable" cellpadding="2" cellspacing="0">
193  <tr>
194    <td class="mdRow">
195      <table cellpadding="0" cellspacing="0" border="0">
196        <tr>
197          <td class="md" nowrap valign="top">virtual FCDTransform::~FCDTransform           </td>
198          <td class="md" valign="top">(&nbsp;</td>
199          <td class="mdname1" valign="top" nowrap>          </td>
200          <td class="md" valign="top">&nbsp;)&nbsp;</td>
201          <td class="md" nowrap><code> [virtual]</code></td>
202        </tr>
203      </table>
204    </td>
205  </tr>
206</table>
207<table cellspacing="5" cellpadding="0" border="0">
208  <tr>
209    <td>
210      &nbsp;
211    </td>
212    <td>
213
214<p>
215Destructor: do not use directly.
216<p>
217Instead, use the <a class="el" href="class_f_c_d_scene_node.html#c679529b68c59acb808ff8a14f4d9a33">FCDSceneNode::ReleaseTransform</a> function.     </td>
218  </tr>
219</table>
220<hr><h2>Member Function Documentation</h2>
221<a class="anchor" name="036030bd68c7bf2ba7886b79aeb531f6"></a><!-- doxytag: member="FCDTransform::Clone" ref="036030bd68c7bf2ba7886b79aeb531f6" args="(FCDSceneNode *newParent)=0" --><p>
222<table class="mdTable" cellpadding="2" cellspacing="0">
223  <tr>
224    <td class="mdRow">
225      <table cellpadding="0" cellspacing="0" border="0">
226        <tr>
227          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_transform.html">FCDTransform</a>* FCDTransform::Clone           </td>
228          <td class="md" valign="top">(&nbsp;</td>
229          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td>
230          <td class="mdname1" valign="top" nowrap> <em>newParent</em>          </td>
231          <td class="md" valign="top">&nbsp;)&nbsp;</td>
232          <td class="md" nowrap><code> [pure virtual]</code></td>
233        </tr>
234      </table>
235    </td>
236  </tr>
237</table>
238<table cellspacing="5" cellpadding="0" border="0">
239  <tr>
240    <td>
241      &nbsp;
242    </td>
243    <td>
244
245<p>
246Creates a copy of a transformation.
247<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>newParent</em>&nbsp;</td><td>The visual scene node that will contain the clone. </td></tr>
251  </table>
252</dl>
253<dl compact><dt><b>Returns:</b></dt><dd>The cloned transformation. </dd></dl>
254
255<p>
256Implemented in <a class="el" href="class_f_c_d_t_translation.html#10f9c7407139aafb5fb5c454032a120c">FCDTTranslation</a>, <a class="el" href="class_f_c_d_t_scale.html#7773ef71964474d39c9150febe6a2806">FCDTScale</a>, <a class="el" href="class_f_c_d_t_rotation.html#0aa8efd428677a14d6889edb8bb1b68a">FCDTRotation</a>, <a class="el" href="class_f_c_d_t_matrix.html#7ec7e8d49b538394f0b25ff148c9c02b">FCDTMatrix</a>, <a class="el" href="class_f_c_d_t_look_at.html#d9b733ad179b469cd4975353ca755f0f">FCDTLookAt</a>, and <a class="el" href="class_f_c_d_t_skew.html#597bc7465a9406479a450cfff937bd2f">FCDTSkew</a>.    </td>
257  </tr>
258</table>
259<a class="anchor" name="827134177675c23e823dcffdc1c1cdae"></a><!-- doxytag: member="FCDTransform::GetAnimated" ref="827134177675c23e823dcffdc1c1cdae" args="()=0" --><p>
260<table class="mdTable" cellpadding="2" cellspacing="0">
261  <tr>
262    <td class="mdRow">
263      <table cellpadding="0" cellspacing="0" border="0">
264        <tr>
265          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_animated.html">FCDAnimated</a>* FCDTransform::GetAnimated           </td>
266          <td class="md" valign="top">(&nbsp;</td>
267          <td class="mdname1" valign="top" nowrap>          </td>
268          <td class="md" valign="top">&nbsp;)&nbsp;</td>
269          <td class="md" nowrap><code> [pure virtual]</code></td>
270        </tr>
271      </table>
272    </td>
273  </tr>
274</table>
275<table cellspacing="5" cellpadding="0" border="0">
276  <tr>
277    <td>
278      &nbsp;
279    </td>
280    <td>
281
282<p>
283Retrieves the animated element for the transformation.
284<p>
285<dl compact><dt><b>Returns:</b></dt><dd>The animated element. This pointer will be NULL if the transformation is not animated. </dd></dl>
286
287<p>
288Implemented in <a class="el" href="class_f_c_d_t_translation.html#cc27524dabcbeba7e488485bdd728d1a">FCDTTranslation</a>, <a class="el" href="class_f_c_d_t_scale.html#e230e09ce7ce4fc0f68c61434ac91ce4">FCDTScale</a>, <a class="el" href="class_f_c_d_t_rotation.html#e9e58e553b821c9d0ef7663b44fb7898">FCDTRotation</a>, <a class="el" href="class_f_c_d_t_matrix.html#cfe06a43e2a34428c0d1319767a55391">FCDTMatrix</a>, <a class="el" href="class_f_c_d_t_look_at.html#f85c59844f759ff36a4aba5b1ad14aaa">FCDTLookAt</a>, and <a class="el" href="class_f_c_d_t_skew.html#0d8291f7d824ffa01883e9da3b90b5e5">FCDTSkew</a>.    </td>
289  </tr>
290</table>
291<a class="anchor" name="3da9bedb5a4ff62df3ffe10672a34e0a"></a><!-- doxytag: member="FCDTransform::GetParent" ref="3da9bedb5a4ff62df3ffe10672a34e0a" args="()" --><p>
292<table class="mdTable" cellpadding="2" cellspacing="0">
293  <tr>
294    <td class="mdRow">
295      <table cellpadding="0" cellspacing="0" border="0">
296        <tr>
297          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a>* FCDTransform::GetParent           </td>
298          <td class="md" valign="top">(&nbsp;</td>
299          <td class="mdname1" valign="top" nowrap>          </td>
300          <td class="md" valign="top">&nbsp;)&nbsp;</td>
301          <td class="md" nowrap><code> [inline]</code></td>
302        </tr>
303      </table>
304    </td>
305  </tr>
306</table>
307<table cellspacing="5" cellpadding="0" border="0">
308  <tr>
309    <td>
310      &nbsp;
311    </td>
312    <td>
313
314<p>
315Retrieves the visual scene node that contains this transformation.
316<p>
317<dl compact><dt><b>Returns:</b></dt><dd>The parent visual scene node. This pointer will be NULL if the transformation is not contained by a visual scene node. </dd></dl>
318    </td>
319  </tr>
320</table>
321<a class="anchor" name="f406aebcba6215ebc1358a3cf87ab29d"></a><!-- doxytag: member="FCDTransform::GetType" ref="f406aebcba6215ebc1358a3cf87ab29d" args="() const =0" --><p>
322<table class="mdTable" cellpadding="2" cellspacing="0">
323  <tr>
324    <td class="mdRow">
325      <table cellpadding="0" cellspacing="0" border="0">
326        <tr>
327          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_transform.html#13e561c5e53aeaf84dedf4661cdc8921">Type</a> FCDTransform::GetType           </td>
328          <td class="md" valign="top">(&nbsp;</td>
329          <td class="mdname1" valign="top" nowrap>          </td>
330          <td class="md" valign="top">&nbsp;)&nbsp;</td>
331          <td class="md" nowrap> const<code> [pure virtual]</code></td>
332        </tr>
333      </table>
334    </td>
335  </tr>
336</table>
337<table cellspacing="5" cellpadding="0" border="0">
338  <tr>
339    <td>
340      &nbsp;
341    </td>
342    <td>
343
344<p>
345Retrieves the class type of the transformation.
346<p>
347The class type should be used to up-case the transformation pointer. <dl compact><dt><b>Returns:</b></dt><dd>The class type. </dd></dl>
348
349<p>
350Implemented in <a class="el" href="class_f_c_d_t_translation.html#d72589137729bcf5ea8b88f0ad2b2208">FCDTTranslation</a>, <a class="el" href="class_f_c_d_t_scale.html#69a9e36fcc1a3ba516a3a0f47c37db61">FCDTScale</a>, <a class="el" href="class_f_c_d_t_rotation.html#f5ddd1b7b673eaa1d57f36b4e685a3c8">FCDTRotation</a>, <a class="el" href="class_f_c_d_t_matrix.html#73abaf07dc65e188ceb14d49e27355ee">FCDTMatrix</a>, <a class="el" href="class_f_c_d_t_look_at.html#1f3fc1c2e95176026628276ddf6f30a0">FCDTLookAt</a>, and <a class="el" href="class_f_c_d_t_skew.html#069afb12195014737cc891cf4edd0946">FCDTSkew</a>.    </td>
351  </tr>
352</table>
353<a class="anchor" name="b12ac63fa2d46fbcf8c025971635cda4"></a><!-- doxytag: member="FCDTransform::IsAnimated" ref="b12ac63fa2d46fbcf8c025971635cda4" args="() const =0" --><p>
354<table class="mdTable" cellpadding="2" cellspacing="0">
355  <tr>
356    <td class="mdRow">
357      <table cellpadding="0" cellspacing="0" border="0">
358        <tr>
359          <td class="md" nowrap valign="top">virtual bool FCDTransform::IsAnimated           </td>
360          <td class="md" valign="top">(&nbsp;</td>
361          <td class="mdname1" valign="top" nowrap>          </td>
362          <td class="md" valign="top">&nbsp;)&nbsp;</td>
363          <td class="md" nowrap> const<code> [pure virtual]</code></td>
364        </tr>
365      </table>
366    </td>
367  </tr>
368</table>
369<table cellspacing="5" cellpadding="0" border="0">
370  <tr>
371    <td>
372      &nbsp;
373    </td>
374    <td>
375
376<p>
377Retrieves whether this transformation has an animation tied to its values.
378<p>
379<dl compact><dt><b>Returns:</b></dt><dd>Whether the transformation is animated. </dd></dl>
380
381<p>
382Implemented in <a class="el" href="class_f_c_d_t_translation.html#365aa6006b7f2b130580cae2cdbedd18">FCDTTranslation</a>, <a class="el" href="class_f_c_d_t_scale.html#db6b8a74970cd14e0cdeb9785cbd41d2">FCDTScale</a>, <a class="el" href="class_f_c_d_t_rotation.html#00cc4223dff938a18c8639629959dc89">FCDTRotation</a>, <a class="el" href="class_f_c_d_t_matrix.html#83615248752085427055cc40803fdf86">FCDTMatrix</a>, <a class="el" href="class_f_c_d_t_look_at.html#c980f02adba06c17bd6a172eda230589">FCDTLookAt</a>, and <a class="el" href="class_f_c_d_t_skew.html#3c8bd56b133da3293e5ca71dffb8efcd">FCDTSkew</a>.    </td>
383  </tr>
384</table>
385<a class="anchor" name="9fa1a02a51f833f819248c2ff020507c"></a><!-- doxytag: member="FCDTransform::IsInverse" ref="9fa1a02a51f833f819248c2ff020507c" args="(const FCDTransform *transform) const " --><p>
386<table class="mdTable" cellpadding="2" cellspacing="0">
387  <tr>
388    <td class="mdRow">
389      <table cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td class="md" nowrap valign="top">virtual bool FCDTransform::IsInverse           </td>
392          <td class="md" valign="top">(&nbsp;</td>
393          <td class="md" nowrap valign="top">const <a class="el" href="class_f_c_d_transform.html">FCDTransform</a> *&nbsp;</td>
394          <td class="mdname1" valign="top" nowrap> <em>transform</em>          </td>
395          <td class="md" valign="top">&nbsp;)&nbsp;</td>
396          <td class="md" nowrap> const<code> [virtual]</code></td>
397        </tr>
398      </table>
399    </td>
400  </tr>
401</table>
402<table cellspacing="5" cellpadding="0" border="0">
403  <tr>
404    <td>
405      &nbsp;
406    </td>
407    <td>
408
409<p>
410Retrieves whether a given transformation is the exact opposite of this transformation.
411<p>
412Executing two opposite transformations, one after the other will not give any resulting transformation. This function is useful to detect pivots within the transform stack. <dl compact><dt><b>Parameters:</b></dt><dd>
413  <table border="0" cellspacing="2" cellpadding="0">
414    <tr><td valign="top"></td><td valign="top"><em>transform</em>&nbsp;</td><td>A second transformation. </td></tr>
415  </table>
416</dl>
417<dl compact><dt><b>Returns:</b></dt><dd>Whether the two transformations are opposites. </dd></dl>
418
419<p>
420Reimplemented in <a class="el" href="class_f_c_d_t_translation.html#2b3ed004d0a35a4e786b38caa00421a0">FCDTTranslation</a>, and <a class="el" href="class_f_c_d_t_rotation.html#dd625d4bc7fe5a6d34eebb4f71739d45">FCDTRotation</a>.    </td>
421  </tr>
422</table>
423<a class="anchor" name="b6ec75fc9ed1c6d4e03a781c251682fc"></a><!-- doxytag: member="FCDTransform::LoadFromXML" ref="b6ec75fc9ed1c6d4e03a781c251682fc" args="(xmlNode *transformNode)=0" --><p>
424<table class="mdTable" cellpadding="2" cellspacing="0">
425  <tr>
426    <td class="mdRow">
427      <table cellpadding="0" cellspacing="0" border="0">
428        <tr>
429          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDTransform::LoadFromXML           </td>
430          <td class="md" valign="top">(&nbsp;</td>
431          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
432          <td class="mdname1" valign="top" nowrap> <em>transformNode</em>          </td>
433          <td class="md" valign="top">&nbsp;)&nbsp;</td>
434          <td class="md" nowrap><code> [pure virtual]</code></td>
435        </tr>
436      </table>
437    </td>
438  </tr>
439</table>
440<table cellspacing="5" cellpadding="0" border="0">
441  <tr>
442    <td>
443      &nbsp;
444    </td>
445    <td>
446
447<p>
448[INTERNAL] Reads in the transformation from a given COLLADA XML tree node.
449<p>
450<dl compact><dt><b>Parameters:</b></dt><dd>
451  <table border="0" cellspacing="2" cellpadding="0">
452    <tr><td valign="top"></td><td valign="top"><em>transformNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
453  </table>
454</dl>
455<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 transformation. </dd></dl>
456
457<p>
458Implemented in <a class="el" href="class_f_c_d_t_translation.html#2616b828f332c1af16df36eff76c3647">FCDTTranslation</a>, <a class="el" href="class_f_c_d_t_scale.html#3a8d09070bd48451f22ea7a81f798d4c">FCDTScale</a>, <a class="el" href="class_f_c_d_t_rotation.html#29ffda23c49e1751c72b5c03d7014daa">FCDTRotation</a>, <a class="el" href="class_f_c_d_t_matrix.html#7da6b586ba85e428295ae23d429435b4">FCDTMatrix</a>, <a class="el" href="class_f_c_d_t_look_at.html#6e1b8c12c6d1e55973cd897d17f22135">FCDTLookAt</a>, and <a class="el" href="class_f_c_d_t_skew.html#692c998008f30bd8b90eedf38b277e81">FCDTSkew</a>.    </td>
459  </tr>
460</table>
461<a class="anchor" name="fd7fc3c7dc012782ebb2886c5bc13d01"></a><!-- doxytag: member="FCDTransform::ToMatrix" ref="fd7fc3c7dc012782ebb2886c5bc13d01" args="() const =0" --><p>
462<table class="mdTable" cellpadding="2" cellspacing="0">
463  <tr>
464    <td class="mdRow">
465      <table cellpadding="0" cellspacing="0" border="0">
466        <tr>
467          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_m_matrix44.html">FMMatrix44</a> FCDTransform::ToMatrix           </td>
468          <td class="md" valign="top">(&nbsp;</td>
469          <td class="mdname1" valign="top" nowrap>          </td>
470          <td class="md" valign="top">&nbsp;)&nbsp;</td>
471          <td class="md" nowrap> const<code> [pure virtual]</code></td>
472        </tr>
473      </table>
474    </td>
475  </tr>
476</table>
477<table cellspacing="5" cellpadding="0" border="0">
478  <tr>
479    <td>
480      &nbsp;
481    </td>
482    <td>
483
484<p>
485Converts the transformation into a matrix.
486<p>
487Useful for visual scene nodes with a weird transformation stack. <dl compact><dt><b>Returns:</b></dt><dd>A matrix equivalent of the transformation. </dd></dl>
488
489<p>
490Implemented in <a class="el" href="class_f_c_d_t_translation.html#2b269c7e2e7ecb67ea36fc5e95eb2784">FCDTTranslation</a>, <a class="el" href="class_f_c_d_t_scale.html#e7376a51b0260fce9d1daa89ea6005d3">FCDTScale</a>, <a class="el" href="class_f_c_d_t_rotation.html#9e2794e2d15d330d604a42668002fe75">FCDTRotation</a>, <a class="el" href="class_f_c_d_t_matrix.html#26384eeccaa1205b0f88d0ad16134669">FCDTMatrix</a>, <a class="el" href="class_f_c_d_t_look_at.html#bc110bf43b1c37e7082f24ca3aad1e53">FCDTLookAt</a>, and <a class="el" href="class_f_c_d_t_skew.html#4e5bb42cea0a00ee44ba0487ea34cbac">FCDTSkew</a>.    </td>
491  </tr>
492</table>
493<a class="anchor" name="cd254f154a32d1e313001ee4d693162a"></a><!-- doxytag: member="FCDTransform::WriteToXML" ref="cd254f154a32d1e313001ee4d693162a" args="(xmlNode *parentNode) const =0" --><p>
494<table class="mdTable" cellpadding="2" cellspacing="0">
495  <tr>
496    <td class="mdRow">
497      <table cellpadding="0" cellspacing="0" border="0">
498        <tr>
499          <td class="md" nowrap valign="top">virtual xmlNode* FCDTransform::WriteToXML           </td>
500          <td class="md" valign="top">(&nbsp;</td>
501          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
502          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
503          <td class="md" valign="top">&nbsp;)&nbsp;</td>
504          <td class="md" nowrap> const<code> [pure virtual]</code></td>
505        </tr>
506      </table>
507    </td>
508  </tr>
509</table>
510<table cellspacing="5" cellpadding="0" border="0">
511  <tr>
512    <td>
513      &nbsp;
514    </td>
515    <td>
516
517<p>
518[INTERNAL] Writes out the transformation to the given COLLADA XML tree node.
519<p>
520<dl compact><dt><b>Parameters:</b></dt><dd>
521  <table border="0" cellspacing="2" cellpadding="0">
522    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the transformation. </td></tr>
523  </table>
524</dl>
525<dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl>
526
527<p>
528Implemented in <a class="el" href="class_f_c_d_t_translation.html#994aad69ad61e8bce69e750c3f8d5e92">FCDTTranslation</a>, <a class="el" href="class_f_c_d_t_scale.html#cfbe7a5e7ee23a7f085af342646a0c9e">FCDTScale</a>, <a class="el" href="class_f_c_d_t_rotation.html#9e5499431cf04c8db9eda0d41d50274c">FCDTRotation</a>, <a class="el" href="class_f_c_d_t_matrix.html#3dea48efa2732603cbae43766dea1526">FCDTMatrix</a>, <a class="el" href="class_f_c_d_t_look_at.html#4b447a87388114660db9b94a7c5645ec">FCDTLookAt</a>, and <a class="el" href="class_f_c_d_t_skew.html#3893886d9280afd3cbc01cc8ec1b0e0f">FCDTSkew</a>.    </td>
529  </tr>
530</table>
531<hr>The documentation for this class was generated from the following file:<ul>
532<li>FCDocument/<a class="el" href="_f_c_d_transform_8h-source.html">FCDTransform.h</a></ul>
533<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by&nbsp;
534<a href="http://www.doxygen.org/index.html">
535<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
536</body>
537</html>
Note: See TracBrowser for help on using the repository browser.