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

Revision 964, 12.0 KB checked in by igarcia, 19 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: FCDAnimatedFloat 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>FCDAnimatedFloat 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="FCDAnimatedFloat" --><!-- doxytag: inherits="FCDAnimated" -->A COLLADA animated single floating-point value element. 
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 FCDAnimatedFloat:
33<p><center><img src="class_f_c_d_animated_float.png" usemap="#FCDAnimatedFloat_map" border="0" alt=""></center>
34<map name="FCDAnimatedFloat_map">
35<area href="class_f_c_d_animated.html" alt="FCDAnimated" shape="rect" coords="0,112,118,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,118,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,118,24">
38</map>
39<a href="class_f_c_d_animated_float-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_float.html">FCDAnimatedFloat</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animated_float.html#556a7298145447e050b4bc9fb2f3971f">Create</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, float *value, 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="#556a7298145447e050b4bc9fb2f3971f"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_animated_float.html">FCDAnimatedFloat</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animated_float.html#53c7bb5f0f1ac5ef60d7d754d0720186">Create</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, xmlNode *node, float *value, 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="#53c7bb5f0f1ac5ef60d7d754d0720186"></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_float.html#5387d9d5e843a08bbeb0e8b4200016bf">Clone</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, const float *oldValue, float *newValue)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Clones an animated element.  <a href="#5387d9d5e843a08bbeb0e8b4200016bf"></a><br></td></tr>
51</table>
52<hr><a name="_details"></a><h2>Detailed Description</h2>
53A COLLADA animated single floating-point value element.
54<p>
55Use this animated element class for all generic-purpose single floating-point values. For angles, use the <a class="el" href="class_f_c_d_animated_angle.html">FCDAnimatedAngle</a> class.
56<p>
57<hr><h2>Member Function Documentation</h2>
58<a class="anchor" name="5387d9d5e843a08bbeb0e8b4200016bf"></a><!-- doxytag: member="FCDAnimatedFloat::Clone" ref="5387d9d5e843a08bbeb0e8b4200016bf" args="(FCDocument *document, const float *oldValue, float *newValue)" --><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>* FCDAnimatedFloat::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>oldValue</em>, </td>
74        </tr>
75        <tr>
76          <td class="md" nowrap align="right"></td>
77          <td class="md"></td>
78          <td class="md" nowrap>float *&nbsp;</td>
79          <td class="mdname" nowrap> <em>newValue</em></td>
80        </tr>
81        <tr>
82          <td class="md"></td>
83          <td class="md">)&nbsp;</td>
84          <td class="md" colspan="2"><code> [static]</code></td>
85        </tr>
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing="5" cellpadding="0" border="0">
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98[INTERNAL] Clones an animated element.
99<p>
100<dl compact><dt><b>Parameters:</b></dt><dd>
101  <table border="0" cellspacing="2" cellpadding="0">
102    <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>
103    <tr><td valign="top"></td><td valign="top"><em>oldValue</em>&nbsp;</td><td>The single floating-point value pointer contained within the original animated element. </td></tr>
104    <tr><td valign="top"></td><td valign="top"><em>newValue</em>&nbsp;</td><td>The single floating-point value pointer for the cloned animated element. </td></tr>
105  </table>
106</dl>
107<dl compact><dt><b>Returns:</b></dt><dd>The cloned animated value. </dd></dl>
108    </td>
109  </tr>
110</table>
111<a class="anchor" name="53c7bb5f0f1ac5ef60d7d754d0720186"></a><!-- doxytag: member="FCDAnimatedFloat::Create" ref="53c7bb5f0f1ac5ef60d7d754d0720186" args="(FCDocument *document, xmlNode *node, float *value, int32 arrayElement=-1)" --><p>
112<table class="mdTable" cellpadding="2" cellspacing="0">
113  <tr>
114    <td class="mdRow">
115      <table cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animated_float.html">FCDAnimatedFloat</a>* FCDAnimatedFloat::Create           </td>
118          <td class="md" valign="top">(&nbsp;</td>
119          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
120          <td class="mdname" nowrap> <em>document</em>, </td>
121        </tr>
122        <tr>
123          <td class="md" nowrap align="right"></td>
124          <td class="md"></td>
125          <td class="md" nowrap>xmlNode *&nbsp;</td>
126          <td class="mdname" nowrap> <em>node</em>, </td>
127        </tr>
128        <tr>
129          <td class="md" nowrap align="right"></td>
130          <td class="md"></td>
131          <td class="md" nowrap>float *&nbsp;</td>
132          <td class="mdname" nowrap> <em>value</em>, </td>
133        </tr>
134        <tr>
135          <td class="md" nowrap align="right"></td>
136          <td class="md"></td>
137          <td class="md" nowrap>int32&nbsp;</td>
138          <td class="mdname" nowrap> <em>arrayElement</em> = <code>-1</code></td>
139        </tr>
140        <tr>
141          <td class="md"></td>
142          <td class="md">)&nbsp;</td>
143          <td class="md" colspan="2"><code> [static]</code></td>
144        </tr>
145      </table>
146    </td>
147  </tr>
148</table>
149<table cellspacing="5" cellpadding="0" border="0">
150  <tr>
151    <td>
152      &nbsp;
153    </td>
154    <td>
155
156<p>
157[INTERNAL] Creates a new animated element.
158<p>
159This function is used during the import of a COLLADA document. <dl compact><dt><b>Parameters:</b></dt><dd>
160  <table border="0" cellspacing="2" cellpadding="0">
161    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animated element. </td></tr>
162    <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>
163    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The value pointer for the single floating-point value. </td></tr>
164    <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>
165  </table>
166</dl>
167<dl compact><dt><b>Returns:</b></dt><dd>The new animated element. </dd></dl>
168    </td>
169  </tr>
170</table>
171<a class="anchor" name="556a7298145447e050b4bc9fb2f3971f"></a><!-- doxytag: member="FCDAnimatedFloat::Create" ref="556a7298145447e050b4bc9fb2f3971f" args="(FCDocument *document, float *value, int32 arrayElement=-1)" --><p>
172<table class="mdTable" cellpadding="2" cellspacing="0">
173  <tr>
174    <td class="mdRow">
175      <table cellpadding="0" cellspacing="0" border="0">
176        <tr>
177          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animated_float.html">FCDAnimatedFloat</a>* FCDAnimatedFloat::Create           </td>
178          <td class="md" valign="top">(&nbsp;</td>
179          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
180          <td class="mdname" nowrap> <em>document</em>, </td>
181        </tr>
182        <tr>
183          <td class="md" nowrap align="right"></td>
184          <td class="md"></td>
185          <td class="md" nowrap>float *&nbsp;</td>
186          <td class="mdname" nowrap> <em>value</em>, </td>
187        </tr>
188        <tr>
189          <td class="md" nowrap align="right"></td>
190          <td class="md"></td>
191          <td class="md" nowrap>int32&nbsp;</td>
192          <td class="mdname" nowrap> <em>arrayElement</em> = <code>-1</code></td>
193        </tr>
194        <tr>
195          <td class="md"></td>
196          <td class="md">)&nbsp;</td>
197          <td class="md" colspan="2"><code> [static]</code></td>
198        </tr>
199      </table>
200    </td>
201  </tr>
202</table>
203<table cellspacing="5" cellpadding="0" border="0">
204  <tr>
205    <td>
206      &nbsp;
207    </td>
208    <td>
209
210<p>
211Creates a new animated element.
212<p>
213<dl compact><dt><b>Parameters:</b></dt><dd>
214  <table border="0" cellspacing="2" cellpadding="0">
215    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animated element. </td></tr>
216    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The value pointer for the single floating-point value. </td></tr>
217    <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>
218  </table>
219</dl>
220<dl compact><dt><b>Returns:</b></dt><dd>The new animated element. </dd></dl>
221    </td>
222  </tr>
223</table>
224<hr>The documentation for this class was generated from the following file:<ul>
225<li>FCDocument/<a class="el" href="_f_c_d_animated_8h-source.html">FCDAnimated.h</a></ul>
226<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:40 2006 for FCollada by&nbsp;
227<a href="http://www.doxygen.org/index.html">
228<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
229</body>
230</html>
Note: See TracBrowser for help on using the repository browser.