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

Revision 964, 38.4 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: FCDAnimation 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>FCDAnimation 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="FCDAnimation" --><!-- doxytag: inherits="FCDEntity" -->A COLLADA animation entity. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_animation_8h-source.html">FCDAnimation.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDAnimation:
33<p><center><img src="class_f_c_d_animation.png" usemap="#FCDAnimation_map" border="0" alt=""></center>
34<map name="FCDAnimation_map">
35<area href="class_f_c_d_entity.html" alt="FCDEntity" shape="rect" coords="0,168,109,192">
36<area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="0,112,109,136">
37<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,109,80">
38<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,109,24">
39</map>
40<a href="class_f_c_d_animation-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
41<tr><td></td></tr>
42<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#49c5abeb2077b5bacc0add21851af60a">FCDAnimation</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#49c5abeb2077b5bacc0add21851af60a"></a><br></td></tr>
46<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_animation.html#2bf9c48c7c17e11125fcf09ae70a6bfc">~FCDAnimation</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#2bf9c48c7c17e11125fcf09ae70a6bfc"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#91e3239617da238768340a8bf62b4132">GetType</a> () const </td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the entity class type.  <a href="#91e3239617da238768340a8bf62b4132"></a><br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#4e6f0b0bed8af740da705b3d90716b04">FindDaeId</a> (const string &amp;daeId)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the entity with the given COLLADA id.  <a href="#4e6f0b0bed8af740da705b3d90716b04"></a><br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#8682dc213919aacfab23a2b63bb8d935">GetChildCount</a> () const </td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of animation entity sub-trees contained by this animation entity tree.  <a href="#8682dc213919aacfab23a2b63bb8d935"></a><br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_animation.html">FCDAnimation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#e308d048c95ea72df642f06865e37c3c">GetChild</a> (size_t index)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an animation entity sub-tree contained by this animation entity tree.  <a href="#e308d048c95ea72df642f06865e37c3c"></a><br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49937056a91b0676fe3604457c579009"></a><!-- doxytag: member="FCDAnimation::GetChild" ref="49937056a91b0676fe3604457c579009" args="(size_t index) const " -->
62const <a class="el" href="class_f_c_d_animation.html">FCDAnimation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#49937056a91b0676fe3604457c579009">GetChild</a> (size_t index) const </td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_animation.html">FCDAnimation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#84d292b756931a4ab35ac8cbdf5bef85">AddChild</a> ()</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new animation entity sub-tree contained within this animation entity tree.  <a href="#84d292b756931a4ab35ac8cbdf5bef85"></a><br></td></tr>
68<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_animation.html#3d3d4c0ba63a0aee661d8e66fd7cccb5">ReleaseChild</a> (<a class="el" href="class_f_c_d_animation.html">FCDAnimation</a> *animation)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases an animation entity sub-tree contained by this animation entity tree.  <a href="#3d3d4c0ba63a0aee661d8e66fd7cccb5"></a><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_animation.html#2be2658111aeb876e01f81d8509f5631">FindAnimationChannels</a> (const string &amp;pointer, <a class="el" href="classvector.html">FCDAnimationChannelList</a> &amp;targetChannels)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the animation channels that target the given COLLADA target pointer.  <a href="#2be2658111aeb876e01f81d8509f5631"></a><br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#ce899d6bc499d07fb65bcdd2c5a7fd3c">GetChannelCount</a> () const </td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of animation channels at this level within the animation tree.  <a href="#ce899d6bc499d07fb65bcdd2c5a7fd3c"></a><br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#09826937c16c3c73bdc9995aa751279c">GetChannel</a> (size_t index)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an animation channel contained by this animation entity.  <a href="#09826937c16c3c73bdc9995aa751279c"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c406240a1265a474bef985478d925286"></a><!-- doxytag: member="FCDAnimation::GetChannel" ref="c406240a1265a474bef985478d925286" args="(size_t index) const " -->
81const <a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#c406240a1265a474bef985478d925286">GetChannel</a> (size_t index) const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#e3b76bab5b13c2745a17c2ef9a949da6">AddChannel</a> ()</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new animation channel to this animation entity.  <a href="#e3b76bab5b13c2745a17c2ef9a949da6"></a><br></td></tr>
87<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_animation.html#ff72eb16b357e17dcd45959b5d6981df">ReleaseChannel</a> (<a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a> *channel)</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases an animation channel contained within this animation entity.  <a href="#ff72eb16b357e17dcd45959b5d6981df"></a><br></td></tr>
90<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_animation.html#6018679c8025b3c67e7cddccdb437fc5">GetCurves</a> (<a class="el" href="classvector.html">FCDAnimationCurveList</a> &amp;curves)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves all the curves created in the subtree of this animation element.  <a href="#6018679c8025b3c67e7cddccdb437fc5"></a><br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><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_animation.html#0c0517b99b66cb21e49230c5a6dc218f">Link</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Links the animation sub-tree with the other entities within the document.  <a href="#0c0517b99b66cb21e49230c5a6dc218f"></a><br></td></tr>
96<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_animation.html#86215ba4422bac9a7267286f5bd6af8b">LoadFromXML</a> (xmlNode *animationNode)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the animation entity from a given COLLADA XML tree node.  <a href="#86215ba4422bac9a7267286f5bd6af8b"></a><br></td></tr>
99<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_animation.html#5380e6861a3e70ba3f580412e4badfa1">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the &lt;animation&gt; element to the given COLLADA XML tree node.  <a href="#5380e6861a3e70ba3f580412e4badfa1"></a><br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top">xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#baa1f495ce837ac197d0f2db608308f8">FindChildById</a> (const string &amp;id)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves the child source or sampler.  <a href="#baa1f495ce837ac197d0f2db608308f8"></a><br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation.html#41039431ec4d69e9b2fe6fdc222f5f20">LinkDriver</a> (<a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> *animated)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Links a possible driver with the animation curves contained within the subtree of this animation element.  <a href="#41039431ec4d69e9b2fe6fdc222f5f20"></a><br></td></tr>
108</table>
109<hr><a name="_details"></a><h2>Detailed Description</h2>
110A COLLADA animation entity.
111<p>
112An animation entity contains a list of child animation entities, in order to form a tree of animation entities. It also hold a list of animation channels, which hold the information to generate animation curves.<p>
113In other words, the animation entity is a structural class used to group animation channels hierarchically.
114<p>
115<hr><h2>Constructor &amp; Destructor Documentation</h2>
116<a class="anchor" name="49c5abeb2077b5bacc0add21851af60a"></a><!-- doxytag: member="FCDAnimation::FCDAnimation" ref="49c5abeb2077b5bacc0add21851af60a" args="(FCDocument *document)" --><p>
117<table class="mdTable" cellpadding="2" cellspacing="0">
118  <tr>
119    <td class="mdRow">
120      <table cellpadding="0" cellspacing="0" border="0">
121        <tr>
122          <td class="md" nowrap valign="top">FCDAnimation::FCDAnimation           </td>
123          <td class="md" valign="top">(&nbsp;</td>
124          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
125          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
126          <td class="md" valign="top">&nbsp;)&nbsp;</td>
127          <td class="md" nowrap></td>
128        </tr>
129      </table>
130    </td>
131  </tr>
132</table>
133<table cellspacing="5" cellpadding="0" border="0">
134  <tr>
135    <td>
136      &nbsp;
137    </td>
138    <td>
139
140<p>
141Constructor: do not use directly.
142<p>
143Instead, use the <a class="el" href="class_f_c_d_library.html#a5cdcac5a447298d5e3816e4f8c864d0">FCDLibrary::AddEntity</a> function or the AddChild function, depending on the hierarchical level of the animation entity. <dl compact><dt><b>Parameters:</b></dt><dd>
144  <table border="0" cellspacing="2" cellpadding="0">
145    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animation entity. </td></tr>
146  </table>
147</dl>
148    </td>
149  </tr>
150</table>
151<a class="anchor" name="2bf9c48c7c17e11125fcf09ae70a6bfc"></a><!-- doxytag: member="FCDAnimation::~FCDAnimation" ref="2bf9c48c7c17e11125fcf09ae70a6bfc" 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 FCDAnimation::~FCDAnimation           </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_library.html#3fbfbcf4ade5b9c94d2ee2f59db5921d">FCDLibrary::ReleaseEntity</a> function or the ReleaseChild function, depending on the hierarchical level of the animation entity.     </td>
178  </tr>
179</table>
180<hr><h2>Member Function Documentation</h2>
181<a class="anchor" name="e3b76bab5b13c2745a17c2ef9a949da6"></a><!-- doxytag: member="FCDAnimation::AddChannel" ref="e3b76bab5b13c2745a17c2ef9a949da6" args="()" --><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"><a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a>* FCDAnimation::AddChannel           </td>
188          <td class="md" valign="top">(&nbsp;</td>
189          <td class="mdname1" valign="top" nowrap>          </td>
190          <td class="md" valign="top">&nbsp;)&nbsp;</td>
191          <td class="md" nowrap></td>
192        </tr>
193      </table>
194    </td>
195  </tr>
196</table>
197<table cellspacing="5" cellpadding="0" border="0">
198  <tr>
199    <td>
200      &nbsp;
201    </td>
202    <td>
203
204<p>
205Adds a new animation channel to this animation entity.
206<p>
207<dl compact><dt><b>Returns:</b></dt><dd>The new animation channel. </dd></dl>
208    </td>
209  </tr>
210</table>
211<a class="anchor" name="84d292b756931a4ab35ac8cbdf5bef85"></a><!-- doxytag: member="FCDAnimation::AddChild" ref="84d292b756931a4ab35ac8cbdf5bef85" args="()" --><p>
212<table class="mdTable" cellpadding="2" cellspacing="0">
213  <tr>
214    <td class="mdRow">
215      <table cellpadding="0" cellspacing="0" border="0">
216        <tr>
217          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation.html">FCDAnimation</a>* FCDAnimation::AddChild           </td>
218          <td class="md" valign="top">(&nbsp;</td>
219          <td class="mdname1" valign="top" nowrap>          </td>
220          <td class="md" valign="top">&nbsp;)&nbsp;</td>
221          <td class="md" nowrap><code> [inline]</code></td>
222        </tr>
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing="5" cellpadding="0" border="0">
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235Creates a new animation entity sub-tree contained within this animation entity tree.
236<p>
237<dl compact><dt><b>Returns:</b></dt><dd>The new animation sub-tree. </dd></dl>
238    </td>
239  </tr>
240</table>
241<a class="anchor" name="2be2658111aeb876e01f81d8509f5631"></a><!-- doxytag: member="FCDAnimation::FindAnimationChannels" ref="2be2658111aeb876e01f81d8509f5631" args="(const string &amp;pointer, FCDAnimationChannelList &amp;targetChannels)" --><p>
242<table class="mdTable" cellpadding="2" cellspacing="0">
243  <tr>
244    <td class="mdRow">
245      <table cellpadding="0" cellspacing="0" border="0">
246        <tr>
247          <td class="md" nowrap valign="top">void FCDAnimation::FindAnimationChannels           </td>
248          <td class="md" valign="top">(&nbsp;</td>
249          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
250          <td class="mdname" nowrap> <em>pointer</em>, </td>
251        </tr>
252        <tr>
253          <td class="md" nowrap align="right"></td>
254          <td class="md"></td>
255          <td class="md" nowrap><a class="el" href="classvector.html">FCDAnimationChannelList</a> &amp;&nbsp;</td>
256          <td class="mdname" nowrap> <em>targetChannels</em></td>
257        </tr>
258        <tr>
259          <td class="md"></td>
260          <td class="md">)&nbsp;</td>
261          <td class="md" colspan="2"></td>
262        </tr>
263      </table>
264    </td>
265  </tr>
266</table>
267<table cellspacing="5" cellpadding="0" border="0">
268  <tr>
269    <td>
270      &nbsp;
271    </td>
272    <td>
273
274<p>
275Retrieves the animation channels that target the given COLLADA target pointer.
276<p>
277<dl compact><dt><b>Parameters:</b></dt><dd>
278  <table border="0" cellspacing="2" cellpadding="0">
279    <tr><td valign="top"></td><td valign="top"><em>pointer</em>&nbsp;</td><td>A COLLADA target pointer. </td></tr>
280    <tr><td valign="top"></td><td valign="top"><em>targetChannels</em>&nbsp;</td><td>A list of animation channels to fill in. This list is not cleared. </td></tr>
281  </table>
282</dl>
283    </td>
284  </tr>
285</table>
286<a class="anchor" name="baa1f495ce837ac197d0f2db608308f8"></a><!-- doxytag: member="FCDAnimation::FindChildById" ref="baa1f495ce837ac197d0f2db608308f8" args="(const string &amp;id)" --><p>
287<table class="mdTable" cellpadding="2" cellspacing="0">
288  <tr>
289    <td class="mdRow">
290      <table cellpadding="0" cellspacing="0" border="0">
291        <tr>
292          <td class="md" nowrap valign="top">xmlNode* FCDAnimation::FindChildById           </td>
293          <td class="md" valign="top">(&nbsp;</td>
294          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
295          <td class="mdname1" valign="top" nowrap> <em>id</em>          </td>
296          <td class="md" valign="top">&nbsp;)&nbsp;</td>
297          <td class="md" nowrap></td>
298        </tr>
299      </table>
300    </td>
301  </tr>
302</table>
303<table cellspacing="5" cellpadding="0" border="0">
304  <tr>
305    <td>
306      &nbsp;
307    </td>
308    <td>
309
310<p>
311[INTERNAL] Retrieves the child source or sampler.
312<p>
313This function should only be used by the <a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a> class during the import of a COLLADA document. <dl compact><dt><b>Parameters:</b></dt><dd>
314  <table border="0" cellspacing="2" cellpadding="0">
315    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The COLLADA id of a sampler or a source. </td></tr>
316  </table>
317</dl>
318<dl compact><dt><b>Returns:</b></dt><dd>The XML node tree for the sampler or the source. This pointer will be NULL if there are no child nodes for the given id. </dd></dl>
319    </td>
320  </tr>
321</table>
322<a class="anchor" name="4e6f0b0bed8af740da705b3d90716b04"></a><!-- doxytag: member="FCDAnimation::FindDaeId" ref="4e6f0b0bed8af740da705b3d90716b04" args="(const string &amp;daeId)" --><p>
323<table class="mdTable" cellpadding="2" cellspacing="0">
324  <tr>
325    <td class="mdRow">
326      <table cellpadding="0" cellspacing="0" border="0">
327        <tr>
328          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html">FCDEntity</a>* FCDAnimation::FindDaeId           </td>
329          <td class="md" valign="top">(&nbsp;</td>
330          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
331          <td class="mdname1" valign="top" nowrap> <em>daeId</em>          </td>
332          <td class="md" valign="top">&nbsp;)&nbsp;</td>
333          <td class="md" nowrap><code> [virtual]</code></td>
334        </tr>
335      </table>
336    </td>
337  </tr>
338</table>
339<table cellspacing="5" cellpadding="0" border="0">
340  <tr>
341    <td>
342      &nbsp;
343    </td>
344    <td>
345
346<p>
347Retrieves the entity with the given COLLADA id.
348<p>
349This function will look through the local sub-tree of animations for the given COLLADA id. <dl compact><dt><b>Parameters:</b></dt><dd>
350  <table border="0" cellspacing="2" cellpadding="0">
351    <tr><td valign="top"></td><td valign="top"><em>daeId</em>&nbsp;</td><td>A COLLADA id. </td></tr>
352  </table>
353</dl>
354<dl compact><dt><b>Returns:</b></dt><dd>The animation entity that matches the COLLADA id. This pointer will be NULL if there are no animation entities that matches the COLLADA id. </dd></dl>
355
356<p>
357Reimplemented from <a class="el" href="class_f_c_d_entity.html#90832c3838b2eaf5e5b346052ec2331e">FCDEntity</a>.    </td>
358  </tr>
359</table>
360<a class="anchor" name="09826937c16c3c73bdc9995aa751279c"></a><!-- doxytag: member="FCDAnimation::GetChannel" ref="09826937c16c3c73bdc9995aa751279c" args="(size_t index)" --><p>
361<table class="mdTable" cellpadding="2" cellspacing="0">
362  <tr>
363    <td class="mdRow">
364      <table cellpadding="0" cellspacing="0" border="0">
365        <tr>
366          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a>* FCDAnimation::GetChannel           </td>
367          <td class="md" valign="top">(&nbsp;</td>
368          <td class="md" nowrap valign="top">size_t&nbsp;</td>
369          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
370          <td class="md" valign="top">&nbsp;)&nbsp;</td>
371          <td class="md" nowrap><code> [inline]</code></td>
372        </tr>
373      </table>
374    </td>
375  </tr>
376</table>
377<table cellspacing="5" cellpadding="0" border="0">
378  <tr>
379    <td>
380      &nbsp;
381    </td>
382    <td>
383
384<p>
385Retrieves an animation channel contained by this animation entity.
386<p>
387<dl compact><dt><b>Parameters:</b></dt><dd>
388  <table border="0" cellspacing="2" cellpadding="0">
389    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the channel. </td></tr>
390  </table>
391</dl>
392<dl compact><dt><b>Returns:</b></dt><dd>The channel at the given index. This pointer will be NULL if the index is out-of-bounds. </dd></dl>
393    </td>
394  </tr>
395</table>
396<a class="anchor" name="ce899d6bc499d07fb65bcdd2c5a7fd3c"></a><!-- doxytag: member="FCDAnimation::GetChannelCount" ref="ce899d6bc499d07fb65bcdd2c5a7fd3c" args="() const " --><p>
397<table class="mdTable" cellpadding="2" cellspacing="0">
398  <tr>
399    <td class="mdRow">
400      <table cellpadding="0" cellspacing="0" border="0">
401        <tr>
402          <td class="md" nowrap valign="top">size_t FCDAnimation::GetChannelCount           </td>
403          <td class="md" valign="top">(&nbsp;</td>
404          <td class="mdname1" valign="top" nowrap>          </td>
405          <td class="md" valign="top">&nbsp;)&nbsp;</td>
406          <td class="md" nowrap> const<code> [inline]</code></td>
407        </tr>
408      </table>
409    </td>
410  </tr>
411</table>
412<table cellspacing="5" cellpadding="0" border="0">
413  <tr>
414    <td>
415      &nbsp;
416    </td>
417    <td>
418
419<p>
420Retrieves the number of animation channels at this level within the animation tree.
421<p>
422<dl compact><dt><b>Returns:</b></dt><dd>The number of animation channels. </dd></dl>
423    </td>
424  </tr>
425</table>
426<a class="anchor" name="e308d048c95ea72df642f06865e37c3c"></a><!-- doxytag: member="FCDAnimation::GetChild" ref="e308d048c95ea72df642f06865e37c3c" args="(size_t index)" --><p>
427<table class="mdTable" cellpadding="2" cellspacing="0">
428  <tr>
429    <td class="mdRow">
430      <table cellpadding="0" cellspacing="0" border="0">
431        <tr>
432          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation.html">FCDAnimation</a>* FCDAnimation::GetChild           </td>
433          <td class="md" valign="top">(&nbsp;</td>
434          <td class="md" nowrap valign="top">size_t&nbsp;</td>
435          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
436          <td class="md" valign="top">&nbsp;)&nbsp;</td>
437          <td class="md" nowrap><code> [inline]</code></td>
438        </tr>
439      </table>
440    </td>
441  </tr>
442</table>
443<table cellspacing="5" cellpadding="0" border="0">
444  <tr>
445    <td>
446      &nbsp;
447    </td>
448    <td>
449
450<p>
451Retrieves an animation entity sub-tree contained by this animation entity tree.
452<p>
453<dl compact><dt><b>Parameters:</b></dt><dd>
454  <table border="0" cellspacing="2" cellpadding="0">
455    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the sub-tree. </td></tr>
456  </table>
457</dl>
458<dl compact><dt><b>Returns:</b></dt><dd>The animation entity sub-tree at the given index. This pointer will be NULL if the index is out-of-bounds. </dd></dl>
459    </td>
460  </tr>
461</table>
462<a class="anchor" name="8682dc213919aacfab23a2b63bb8d935"></a><!-- doxytag: member="FCDAnimation::GetChildCount" ref="8682dc213919aacfab23a2b63bb8d935" args="() const " --><p>
463<table class="mdTable" cellpadding="2" cellspacing="0">
464  <tr>
465    <td class="mdRow">
466      <table cellpadding="0" cellspacing="0" border="0">
467        <tr>
468          <td class="md" nowrap valign="top">size_t FCDAnimation::GetChildCount           </td>
469          <td class="md" valign="top">(&nbsp;</td>
470          <td class="mdname1" valign="top" nowrap>          </td>
471          <td class="md" valign="top">&nbsp;)&nbsp;</td>
472          <td class="md" nowrap> const<code> [inline]</code></td>
473        </tr>
474      </table>
475    </td>
476  </tr>
477</table>
478<table cellspacing="5" cellpadding="0" border="0">
479  <tr>
480    <td>
481      &nbsp;
482    </td>
483    <td>
484
485<p>
486Retrieves the number of animation entity sub-trees contained by this animation entity tree.
487<p>
488<dl compact><dt><b>Returns:</b></dt><dd>The number of animation entity sub-trees. </dd></dl>
489    </td>
490  </tr>
491</table>
492<a class="anchor" name="6018679c8025b3c67e7cddccdb437fc5"></a><!-- doxytag: member="FCDAnimation::GetCurves" ref="6018679c8025b3c67e7cddccdb437fc5" args="(FCDAnimationCurveList &amp;curves)" --><p>
493<table class="mdTable" cellpadding="2" cellspacing="0">
494  <tr>
495    <td class="mdRow">
496      <table cellpadding="0" cellspacing="0" border="0">
497        <tr>
498          <td class="md" nowrap valign="top">void FCDAnimation::GetCurves           </td>
499          <td class="md" valign="top">(&nbsp;</td>
500          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDAnimationCurveList</a> &amp;&nbsp;</td>
501          <td class="mdname1" valign="top" nowrap> <em>curves</em>          </td>
502          <td class="md" valign="top">&nbsp;)&nbsp;</td>
503          <td class="md" nowrap></td>
504        </tr>
505      </table>
506    </td>
507  </tr>
508</table>
509<table cellspacing="5" cellpadding="0" border="0">
510  <tr>
511    <td>
512      &nbsp;
513    </td>
514    <td>
515
516<p>
517Retrieves all the curves created in the subtree of this animation element.
518<p>
519<dl compact><dt><b>Parameters:</b></dt><dd>
520  <table border="0" cellspacing="2" cellpadding="0">
521    <tr><td valign="top"></td><td valign="top"><em>curves</em>&nbsp;</td><td>A list of animation curves to fill in. This list is not cleared. </td></tr>
522  </table>
523</dl>
524    </td>
525  </tr>
526</table>
527<a class="anchor" name="91e3239617da238768340a8bf62b4132"></a><!-- doxytag: member="FCDAnimation::GetType" ref="91e3239617da238768340a8bf62b4132" args="() const " --><p>
528<table class="mdTable" cellpadding="2" cellspacing="0">
529  <tr>
530    <td class="mdRow">
531      <table cellpadding="0" cellspacing="0" border="0">
532        <tr>
533          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> FCDAnimation::GetType           </td>
534          <td class="md" valign="top">(&nbsp;</td>
535          <td class="mdname1" valign="top" nowrap>          </td>
536          <td class="md" valign="top">&nbsp;)&nbsp;</td>
537          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
538        </tr>
539      </table>
540    </td>
541  </tr>
542</table>
543<table cellspacing="5" cellpadding="0" border="0">
544  <tr>
545    <td>
546      &nbsp;
547    </td>
548    <td>
549
550<p>
551Retrieves the entity class type.
552<p>
553This function is a part of the <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> interface. <dl compact><dt><b>Returns:</b></dt><dd>The entity class type: ANIMATION. </dd></dl>
554
555<p>
556Reimplemented from <a class="el" href="class_f_c_d_entity.html#bfd4312a7124f92364c1e6517c7e60ba">FCDEntity</a>.    </td>
557  </tr>
558</table>
559<a class="anchor" name="0c0517b99b66cb21e49230c5a6dc218f"></a><!-- doxytag: member="FCDAnimation::Link" ref="0c0517b99b66cb21e49230c5a6dc218f" args="()" --><p>
560<table class="mdTable" cellpadding="2" cellspacing="0">
561  <tr>
562    <td class="mdRow">
563      <table cellpadding="0" cellspacing="0" border="0">
564        <tr>
565          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDAnimation::Link           </td>
566          <td class="md" valign="top">(&nbsp;</td>
567          <td class="mdname1" valign="top" nowrap>          </td>
568          <td class="md" valign="top">&nbsp;)&nbsp;</td>
569          <td class="md" nowrap></td>
570        </tr>
571      </table>
572    </td>
573  </tr>
574</table>
575<table cellspacing="5" cellpadding="0" border="0">
576  <tr>
577    <td>
578      &nbsp;
579    </td>
580    <td>
581
582<p>
583[INTERNAL] Links the animation sub-tree with the other entities within the document.
584<p>
585This function is used at the end of the import of a document to verify that all the necessary drivers were found. <dl compact><dt><b>Returns:</b></dt><dd>The status of the linkage. </dd></dl>
586    </td>
587  </tr>
588</table>
589<a class="anchor" name="41039431ec4d69e9b2fe6fdc222f5f20"></a><!-- doxytag: member="FCDAnimation::LinkDriver" ref="41039431ec4d69e9b2fe6fdc222f5f20" args="(FCDAnimated *animated)" --><p>
590<table class="mdTable" cellpadding="2" cellspacing="0">
591  <tr>
592    <td class="mdRow">
593      <table cellpadding="0" cellspacing="0" border="0">
594        <tr>
595          <td class="md" nowrap valign="top">bool FCDAnimation::LinkDriver           </td>
596          <td class="md" valign="top">(&nbsp;</td>
597          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> *&nbsp;</td>
598          <td class="mdname1" valign="top" nowrap> <em>animated</em>          </td>
599          <td class="md" valign="top">&nbsp;)&nbsp;</td>
600          <td class="md" nowrap></td>
601        </tr>
602      </table>
603    </td>
604  </tr>
605</table>
606<table cellspacing="5" cellpadding="0" border="0">
607  <tr>
608    <td>
609      &nbsp;
610    </td>
611    <td>
612
613<p>
614[INTERNAL] Links a possible driver with the animation curves contained within the subtree of this animation element.
615<p>
616This function is used during the import of a COLLADA document. <dl compact><dt><b>Parameters:</b></dt><dd>
617  <table border="0" cellspacing="2" cellpadding="0">
618    <tr><td valign="top"></td><td valign="top"><em>animated</em>&nbsp;</td><td>The driver animated value. </td></tr>
619  </table>
620</dl>
621<dl compact><dt><b>Returns:</b></dt><dd>Whether any linkage was done. </dd></dl>
622    </td>
623  </tr>
624</table>
625<a class="anchor" name="86215ba4422bac9a7267286f5bd6af8b"></a><!-- doxytag: member="FCDAnimation::LoadFromXML" ref="86215ba4422bac9a7267286f5bd6af8b" args="(xmlNode *animationNode)" --><p>
626<table class="mdTable" cellpadding="2" cellspacing="0">
627  <tr>
628    <td class="mdRow">
629      <table cellpadding="0" cellspacing="0" border="0">
630        <tr>
631          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDAnimation::LoadFromXML           </td>
632          <td class="md" valign="top">(&nbsp;</td>
633          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
634          <td class="mdname1" valign="top" nowrap> <em>animationNode</em>          </td>
635          <td class="md" valign="top">&nbsp;)&nbsp;</td>
636          <td class="md" nowrap><code> [virtual]</code></td>
637        </tr>
638      </table>
639    </td>
640  </tr>
641</table>
642<table cellspacing="5" cellpadding="0" border="0">
643  <tr>
644    <td>
645      &nbsp;
646    </td>
647    <td>
648
649<p>
650[INTERNAL] Reads in the animation entity from a given COLLADA XML tree node.
651<p>
652<dl compact><dt><b>Parameters:</b></dt><dd>
653  <table border="0" cellspacing="2" cellpadding="0">
654    <tr><td valign="top"></td><td valign="top"><em>animationNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
655  </table>
656</dl>
657<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 animation. </dd></dl>
658
659<p>
660Reimplemented from <a class="el" href="class_f_c_d_entity.html#8e32fcc93de76acc4b606db7b5b83890">FCDEntity</a>.    </td>
661  </tr>
662</table>
663<a class="anchor" name="ff72eb16b357e17dcd45959b5d6981df"></a><!-- doxytag: member="FCDAnimation::ReleaseChannel" ref="ff72eb16b357e17dcd45959b5d6981df" args="(FCDAnimationChannel *channel)" --><p>
664<table class="mdTable" cellpadding="2" cellspacing="0">
665  <tr>
666    <td class="mdRow">
667      <table cellpadding="0" cellspacing="0" border="0">
668        <tr>
669          <td class="md" nowrap valign="top">void FCDAnimation::ReleaseChannel           </td>
670          <td class="md" valign="top">(&nbsp;</td>
671          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation_channel.html">FCDAnimationChannel</a> *&nbsp;</td>
672          <td class="mdname1" valign="top" nowrap> <em>channel</em>          </td>
673          <td class="md" valign="top">&nbsp;)&nbsp;</td>
674          <td class="md" nowrap></td>
675        </tr>
676      </table>
677    </td>
678  </tr>
679</table>
680<table cellspacing="5" cellpadding="0" border="0">
681  <tr>
682    <td>
683      &nbsp;
684    </td>
685    <td>
686
687<p>
688Releases an animation channel contained within this animation entity.
689<p>
690<dl compact><dt><b>Parameters:</b></dt><dd>
691  <table border="0" cellspacing="2" cellpadding="0">
692    <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>The animation channel to release. </td></tr>
693  </table>
694</dl>
695    </td>
696  </tr>
697</table>
698<a class="anchor" name="3d3d4c0ba63a0aee661d8e66fd7cccb5"></a><!-- doxytag: member="FCDAnimation::ReleaseChild" ref="3d3d4c0ba63a0aee661d8e66fd7cccb5" args="(FCDAnimation *animation)" --><p>
699<table class="mdTable" cellpadding="2" cellspacing="0">
700  <tr>
701    <td class="mdRow">
702      <table cellpadding="0" cellspacing="0" border="0">
703        <tr>
704          <td class="md" nowrap valign="top">void FCDAnimation::ReleaseChild           </td>
705          <td class="md" valign="top">(&nbsp;</td>
706          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation.html">FCDAnimation</a> *&nbsp;</td>
707          <td class="mdname1" valign="top" nowrap> <em>animation</em>          </td>
708          <td class="md" valign="top">&nbsp;)&nbsp;</td>
709          <td class="md" nowrap><code> [inline]</code></td>
710        </tr>
711      </table>
712    </td>
713  </tr>
714</table>
715<table cellspacing="5" cellpadding="0" border="0">
716  <tr>
717    <td>
718      &nbsp;
719    </td>
720    <td>
721
722<p>
723Releases an animation entity sub-tree contained by this animation entity tree.
724<p>
725<dl compact><dt><b>Parameters:</b></dt><dd>
726  <table border="0" cellspacing="2" cellpadding="0">
727    <tr><td valign="top"></td><td valign="top"><em>animation</em>&nbsp;</td><td>The animation entity the release. </td></tr>
728  </table>
729</dl>
730    </td>
731  </tr>
732</table>
733<a class="anchor" name="5380e6861a3e70ba3f580412e4badfa1"></a><!-- doxytag: member="FCDAnimation::WriteToXML" ref="5380e6861a3e70ba3f580412e4badfa1" args="(xmlNode *parentNode) const " --><p>
734<table class="mdTable" cellpadding="2" cellspacing="0">
735  <tr>
736    <td class="mdRow">
737      <table cellpadding="0" cellspacing="0" border="0">
738        <tr>
739          <td class="md" nowrap valign="top">virtual xmlNode* FCDAnimation::WriteToXML           </td>
740          <td class="md" valign="top">(&nbsp;</td>
741          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
742          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
743          <td class="md" valign="top">&nbsp;)&nbsp;</td>
744          <td class="md" nowrap> const<code> [virtual]</code></td>
745        </tr>
746      </table>
747    </td>
748  </tr>
749</table>
750<table cellspacing="5" cellpadding="0" border="0">
751  <tr>
752    <td>
753      &nbsp;
754    </td>
755    <td>
756
757<p>
758[INTERNAL] Writes out the &lt;animation&gt; element to the given COLLADA XML tree node.
759<p>
760<dl compact><dt><b>Parameters:</b></dt><dd>
761  <table border="0" cellspacing="2" cellpadding="0">
762    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the animation tree. </td></tr>
763  </table>
764</dl>
765<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
766
767<p>
768Reimplemented from <a class="el" href="class_f_c_d_entity.html#b27f0c175c3f8fd7064cde48bcf1d7a0">FCDEntity</a>.    </td>
769  </tr>
770</table>
771<hr>The documentation for this class was generated from the following file:<ul>
772<li>FCDocument/<a class="el" href="_f_c_d_animation_8h-source.html">FCDAnimation.h</a></ul>
773<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
774<a href="http://www.doxygen.org/index.html">
775<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
776</body>
777</html>
Note: See TracBrowser for help on using the repository browser.