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

Revision 964, 13.3 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: FCDAnimatedAngleAxis 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>FCDAnimatedAngleAxis 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="FCDAnimatedAngleAxis" --><!-- doxytag: inherits="FCDAnimated" -->A COLLADA animated angle-axis. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_animated_8h-source.html">FCDAnimated.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDAnimatedAngleAxis:
33<p><center><img src="class_f_c_d_animated_angle_axis.png" usemap="#FCDAnimatedAngleAxis_map" border="0" alt=""></center>
34<map name="FCDAnimatedAngleAxis_map">
35<area href="class_f_c_d_animated.html" alt="FCDAnimated" shape="rect" coords="0,112,147,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,147,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,147,24">
38</map>
39<a href="class_f_c_d_animated_angle_axis-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>Static Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_animated_angle_axis.html">FCDAnimatedAngleAxis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animated_angle_axis.html#b5c047c0eccb64ace3683964abbb5944">Create</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_m_vector3.html">FMVector3</a> *value, float *angle, int32 <a class="el" href="class_f_c_d_animated.html#27daa356d592abe62b5f84871bb6fefc">arrayElement</a>=-1)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new animated element.  <a href="#b5c047c0eccb64ace3683964abbb5944"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_animated_angle_axis.html">FCDAnimatedAngleAxis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animated_angle_axis.html#c3bcba62898244d145acee9957f5d354">Create</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, xmlNode *node, <a class="el" href="class_f_m_vector3.html">FMVector3</a> *axis, float *angle, int32 <a class="el" href="class_f_c_d_animated.html#27daa356d592abe62b5f84871bb6fefc">arrayElement</a>=-1)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Creates a new animated element.  <a href="#c3bcba62898244d145acee9957f5d354"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">static <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_animated_angle_axis.html#780436c6256f6d6b4859f3e5dd81f0f9">Clone</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, const float *oldAngle, <a class="el" href="class_f_m_vector3.html">FMVector3</a> *newAxis, float *newAngle)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Clones an animated element.  <a href="#780436c6256f6d6b4859f3e5dd81f0f9"></a><br></td></tr>
51</table>
52<hr><a name="_details"></a><h2>Detailed Description</h2>
53A COLLADA animated angle-axis.
54<p>
55Used for rotations, takes in a 3D vector for the axis and a single floating-point value for the angle.
56<p>
57<hr><h2>Member Function Documentation</h2>
58<a class="anchor" name="780436c6256f6d6b4859f3e5dd81f0f9"></a><!-- doxytag: member="FCDAnimatedAngleAxis::Clone" ref="780436c6256f6d6b4859f3e5dd81f0f9" args="(FCDocument *document, const float *oldAngle, FMVector3 *newAxis, float *newAngle)" --><p>
59<table class="mdTable" cellpadding="2" cellspacing="0">
60  <tr>
61    <td class="mdRow">
62      <table cellpadding="0" cellspacing="0" border="0">
63        <tr>
64          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animated.html">FCDAnimated</a>* FCDAnimatedAngleAxis::Clone           </td>
65          <td class="md" valign="top">(&nbsp;</td>
66          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
67          <td class="mdname" nowrap> <em>document</em>, </td>
68        </tr>
69        <tr>
70          <td class="md" nowrap align="right"></td>
71          <td class="md"></td>
72          <td class="md" nowrap>const float *&nbsp;</td>
73          <td class="mdname" nowrap> <em>oldAngle</em>, </td>
74        </tr>
75        <tr>
76          <td class="md" nowrap align="right"></td>
77          <td class="md"></td>
78          <td class="md" nowrap><a class="el" href="class_f_m_vector3.html">FMVector3</a> *&nbsp;</td>
79          <td class="mdname" nowrap> <em>newAxis</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>newAngle</em></td>
86        </tr>
87        <tr>
88          <td class="md"></td>
89          <td class="md">)&nbsp;</td>
90          <td class="md" colspan="2"><code> [static]</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>
104[INTERNAL] Clones an animated element.
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>document</em>&nbsp;</td><td>The COLLADA document that owns the cloned animated element. </td></tr>
109    <tr><td valign="top"></td><td valign="top"><em>oldAngle</em>&nbsp;</td><td>The angle value pointer contained within the original animated element. </td></tr>
110    <tr><td valign="top"></td><td valign="top"><em>newAxis</em>&nbsp;</td><td>The axis value pointer for the cloned animated element. </td></tr>
111    <tr><td valign="top"></td><td valign="top"><em>newAngle</em>&nbsp;</td><td>The angle value pointer for the cloned animated element. </td></tr>
112  </table>
113</dl>
114<dl compact><dt><b>Returns:</b></dt><dd>The cloned animated value. </dd></dl>
115    </td>
116  </tr>
117</table>
118<a class="anchor" name="c3bcba62898244d145acee9957f5d354"></a><!-- doxytag: member="FCDAnimatedAngleAxis::Create" ref="c3bcba62898244d145acee9957f5d354" args="(FCDocument *document, xmlNode *node, FMVector3 *axis, float *angle, int32 arrayElement=-1)" --><p>
119<table class="mdTable" cellpadding="2" cellspacing="0">
120  <tr>
121    <td class="mdRow">
122      <table cellpadding="0" cellspacing="0" border="0">
123        <tr>
124          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animated_angle_axis.html">FCDAnimatedAngleAxis</a>* FCDAnimatedAngleAxis::Create           </td>
125          <td class="md" valign="top">(&nbsp;</td>
126          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
127          <td class="mdname" nowrap> <em>document</em>, </td>
128        </tr>
129        <tr>
130          <td class="md" nowrap align="right"></td>
131          <td class="md"></td>
132          <td class="md" nowrap>xmlNode *&nbsp;</td>
133          <td class="mdname" nowrap> <em>node</em>, </td>
134        </tr>
135        <tr>
136          <td class="md" nowrap align="right"></td>
137          <td class="md"></td>
138          <td class="md" nowrap><a class="el" href="class_f_m_vector3.html">FMVector3</a> *&nbsp;</td>
139          <td class="mdname" nowrap> <em>axis</em>, </td>
140        </tr>
141        <tr>
142          <td class="md" nowrap align="right"></td>
143          <td class="md"></td>
144          <td class="md" nowrap>float *&nbsp;</td>
145          <td class="mdname" nowrap> <em>angle</em>, </td>
146        </tr>
147        <tr>
148          <td class="md" nowrap align="right"></td>
149          <td class="md"></td>
150          <td class="md" nowrap>int32&nbsp;</td>
151          <td class="mdname" nowrap> <em>arrayElement</em> = <code>-1</code></td>
152        </tr>
153        <tr>
154          <td class="md"></td>
155          <td class="md">)&nbsp;</td>
156          <td class="md" colspan="2"><code> [static]</code></td>
157        </tr>
158      </table>
159    </td>
160  </tr>
161</table>
162<table cellspacing="5" cellpadding="0" border="0">
163  <tr>
164    <td>
165      &nbsp;
166    </td>
167    <td>
168
169<p>
170[INTERNAL] Creates a new animated element.
171<p>
172This function is used during the import of a COLLADA document. <dl compact><dt><b>Parameters:</b></dt><dd>
173  <table border="0" cellspacing="2" cellpadding="0">
174    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animated element. </td></tr>
175    <tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The XML tree node that contains the animated values. </td></tr>
176    <tr><td valign="top"></td><td valign="top"><em>axis</em>&nbsp;</td><td>The value pointer for the axis. </td></tr>
177    <tr><td valign="top"></td><td valign="top"><em>angle</em>&nbsp;</td><td>The value pointer for the angle. </td></tr>
178    <tr><td valign="top"></td><td valign="top"><em>arrayElement</em>&nbsp;</td><td>The optional array index for animated element that belong to an animated element list. </td></tr>
179  </table>
180</dl>
181<dl compact><dt><b>Returns:</b></dt><dd>The new animated element. </dd></dl>
182    </td>
183  </tr>
184</table>
185<a class="anchor" name="b5c047c0eccb64ace3683964abbb5944"></a><!-- doxytag: member="FCDAnimatedAngleAxis::Create" ref="b5c047c0eccb64ace3683964abbb5944" args="(FCDocument *document, FMVector3 *value, float *angle, int32 arrayElement=-1)" --><p>
186<table class="mdTable" cellpadding="2" cellspacing="0">
187  <tr>
188    <td class="mdRow">
189      <table cellpadding="0" cellspacing="0" border="0">
190        <tr>
191          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animated_angle_axis.html">FCDAnimatedAngleAxis</a>* FCDAnimatedAngleAxis::Create           </td>
192          <td class="md" valign="top">(&nbsp;</td>
193          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
194          <td class="mdname" nowrap> <em>document</em>, </td>
195        </tr>
196        <tr>
197          <td class="md" nowrap align="right"></td>
198          <td class="md"></td>
199          <td class="md" nowrap><a class="el" href="class_f_m_vector3.html">FMVector3</a> *&nbsp;</td>
200          <td class="mdname" nowrap> <em>value</em>, </td>
201        </tr>
202        <tr>
203          <td class="md" nowrap align="right"></td>
204          <td class="md"></td>
205          <td class="md" nowrap>float *&nbsp;</td>
206          <td class="mdname" nowrap> <em>angle</em>, </td>
207        </tr>
208        <tr>
209          <td class="md" nowrap align="right"></td>
210          <td class="md"></td>
211          <td class="md" nowrap>int32&nbsp;</td>
212          <td class="mdname" nowrap> <em>arrayElement</em> = <code>-1</code></td>
213        </tr>
214        <tr>
215          <td class="md"></td>
216          <td class="md">)&nbsp;</td>
217          <td class="md" colspan="2"><code> [static]</code></td>
218        </tr>
219      </table>
220    </td>
221  </tr>
222</table>
223<table cellspacing="5" cellpadding="0" border="0">
224  <tr>
225    <td>
226      &nbsp;
227    </td>
228    <td>
229
230<p>
231Creates a new animated element.
232<p>
233<dl compact><dt><b>Parameters:</b></dt><dd>
234  <table border="0" cellspacing="2" cellpadding="0">
235    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animated element. </td></tr>
236    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The value pointer for the axis. </td></tr>
237    <tr><td valign="top"></td><td valign="top"><em>angle</em>&nbsp;</td><td>The value pointer for the angle. </td></tr>
238    <tr><td valign="top"></td><td valign="top"><em>arrayElement</em>&nbsp;</td><td>The optional array index for animated element that belong to an animated element list. </td></tr>
239  </table>
240</dl>
241<dl compact><dt><b>Returns:</b></dt><dd>The new animated element. </dd></dl>
242    </td>
243  </tr>
244</table>
245<hr>The documentation for this class was generated from the following file:<ul>
246<li>FCDocument/<a class="el" href="_f_c_d_animated_8h-source.html">FCDAnimated.h</a></ul>
247<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:40 2006 for FCollada by&nbsp;
248<a href="http://www.doxygen.org/index.html">
249<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
250</body>
251</html>
Note: See TracBrowser for help on using the repository browser.