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

Revision 964, 30.2 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: FCDAnimationChannel 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>FCDAnimationChannel 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="FCDAnimationChannel" --><!-- doxytag: inherits="FCDObject" -->A COLLADA animation channel. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_animation_channel_8h-source.html">FCDAnimationChannel.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDAnimationChannel:
33<p><center><img src="class_f_c_d_animation_channel.png" usemap="#FCDAnimationChannel_map" border="0" alt=""></center>
34<map name="FCDAnimationChannel_map">
35<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,140,80">
36<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,140,24">
37</map>
38<a href="class_f_c_d_animation_channel-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
39<tr><td></td></tr>
40<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
41<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_channel.html#06b82dde2395bf29253670cd20e6b04c">FCDAnimationChannel</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_c_d_animation.html">FCDAnimation</a> *parent)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#06b82dde2395bf29253670cd20e6b04c"></a><br></td></tr>
44<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_channel.html#5c54b1f496f34ed7f3e0d3b25cc7da27">~FCDAnimationChannel</a> ()</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#5c54b1f496f34ed7f3e0d3b25cc7da27"></a><br></td></tr>
47<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_channel.html#208109679a16dec1f0103cbaa7b28324">GetParent</a> ()</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the animation sub-tree that contains the animation channel.  <a href="#208109679a16dec1f0103cbaa7b28324"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="984c713570fdcd79242c2b260df91b0c"></a><!-- doxytag: member="FCDAnimationChannel::GetParent" ref="984c713570fdcd79242c2b260df91b0c" args="() const " -->
51const <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_channel.html#984c713570fdcd79242c2b260df91b0c">GetParent</a> () const </td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classvector.html">FCDAnimationCurveList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_channel.html#fa3c640a2dd9bfe68ea45a5208772af5">GetCurves</a> () const </td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of animation curves contained within the channel.  <a href="#fa3c640a2dd9bfe68ea45a5208772af5"></a><br></td></tr>
57<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_channel.html#c1b1e057ebccde60502ea1a12b00f358">GetCurveCount</a> () const </td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of animation curves contained within the channel.  <a href="#c1b1e057ebccde60502ea1a12b00f358"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_channel.html#6022ce6350b29c74b21f253f779739c4">GetCurve</a> (size_t index)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an animation curve contained within the channel.  <a href="#6022ce6350b29c74b21f253f779739c4"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6716d448ab360c794901b072e27909c"></a><!-- doxytag: member="FCDAnimationChannel::GetCurve" ref="e6716d448ab360c794901b072e27909c" args="(size_t index) const " -->
64const <a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_channel.html#e6716d448ab360c794901b072e27909c">GetCurve</a> (size_t index) const </td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_channel.html#3cd77e243432a42c614e8c510bb69138">AddCurve</a> ()</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new animation curve to this animation channel.  <a href="#3cd77e243432a42c614e8c510bb69138"></a><br></td></tr>
70<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_channel.html#7737b8e386bcd898225565bdd730740e">ReleaseCurve</a> (<a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> *curve)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases an animation curve contained within this channel.  <a href="#7737b8e386bcd898225565bdd730740e"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top">const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_channel.html#a3cdb2fb7ca73e7f9026251f861edf32">GetTargetPointer</a> () const </td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves the target pointer prefix for this animation channel.  <a href="#a3cdb2fb7ca73e7f9026251f861edf32"></a><br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top">const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_channel.html#db7692a3c78cb4277eb5bfd7aced3bc8">GetTargetQualifier</a> () const </td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves the target qualifier for this animation channel.  <a href="#db7692a3c78cb4277eb5bfd7aced3bc8"></a><br></td></tr>
79<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_channel.html#3bbf9bbc45437d7ab34a2972da6ab784">SetTargetPointer</a> (const string &amp;p)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Enforces the tarrget pointer prefix for the animation channel.  <a href="#3bbf9bbc45437d7ab34a2972da6ab784"></a><br></td></tr>
82<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_channel.html#ca7e6d2bb7e632d4f814e4178146f39a">LinkDriver</a> (<a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> *animated)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Considers the given animated element as the driver for this animation channel.  <a href="#ca7e6d2bb7e632d4f814e4178146f39a"></a><br></td></tr>
85<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_channel.html#f509cb79cb6350ae64d375053759ecb8">CheckDriver</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Verifies that if a driver is used by this channel, then it was found during the import of the animated elements.  <a href="#f509cb79cb6350ae64d375053759ecb8"></a><br></td></tr>
88<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_channel.html#7821e346181d25c0eced3c679e34274d">LoadFromXML</a> (xmlNode *channelNode)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the animation channel from a given COLLADA XML tree node.  <a href="#7821e346181d25c0eced3c679e34274d"></a><br></td></tr>
91<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_channel.html#d27f91a4cde919a6d5c7505e57fb1779">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the animation channel to the given COLLADA XML tree node.  <a href="#d27f91a4cde919a6d5c7505e57fb1779"></a><br></td></tr>
94</table>
95<hr><a name="_details"></a><h2>Detailed Description</h2>
96A COLLADA animation channel.
97<p>
98Each animation channel holds the animation curves for one animatable element, such as a single floating-point value, a 3D vector or a matrix.<p>
99<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> </dd></dl>
100
101<p>
102<hr><h2>Constructor &amp; Destructor Documentation</h2>
103<a class="anchor" name="06b82dde2395bf29253670cd20e6b04c"></a><!-- doxytag: member="FCDAnimationChannel::FCDAnimationChannel" ref="06b82dde2395bf29253670cd20e6b04c" args="(FCDocument *document, FCDAnimation *parent)" --><p>
104<table class="mdTable" cellpadding="2" cellspacing="0">
105  <tr>
106    <td class="mdRow">
107      <table cellpadding="0" cellspacing="0" border="0">
108        <tr>
109          <td class="md" nowrap valign="top">FCDAnimationChannel::FCDAnimationChannel           </td>
110          <td class="md" valign="top">(&nbsp;</td>
111          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
112          <td class="mdname" nowrap> <em>document</em>, </td>
113        </tr>
114        <tr>
115          <td class="md" nowrap align="right"></td>
116          <td class="md"></td>
117          <td class="md" nowrap><a class="el" href="class_f_c_d_animation.html">FCDAnimation</a> *&nbsp;</td>
118          <td class="mdname" nowrap> <em>parent</em></td>
119        </tr>
120        <tr>
121          <td class="md"></td>
122          <td class="md">)&nbsp;</td>
123          <td class="md" colspan="2"></td>
124        </tr>
125      </table>
126    </td>
127  </tr>
128</table>
129<table cellspacing="5" cellpadding="0" border="0">
130  <tr>
131    <td>
132      &nbsp;
133    </td>
134    <td>
135
136<p>
137Constructor: do not use directly.
138<p>
139Instead, call the <a class="el" href="class_f_c_d_animation.html#e3b76bab5b13c2745a17c2ef9a949da6">FCDAnimation::AddChannel</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
140  <table border="0" cellspacing="2" cellpadding="0">
141    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animation channel. </td></tr>
142    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The animation sub-tree that contains the animation channel. </td></tr>
143  </table>
144</dl>
145    </td>
146  </tr>
147</table>
148<a class="anchor" name="5c54b1f496f34ed7f3e0d3b25cc7da27"></a><!-- doxytag: member="FCDAnimationChannel::~FCDAnimationChannel" ref="5c54b1f496f34ed7f3e0d3b25cc7da27" args="()" --><p>
149<table class="mdTable" cellpadding="2" cellspacing="0">
150  <tr>
151    <td class="mdRow">
152      <table cellpadding="0" cellspacing="0" border="0">
153        <tr>
154          <td class="md" nowrap valign="top">virtual FCDAnimationChannel::~FCDAnimationChannel           </td>
155          <td class="md" valign="top">(&nbsp;</td>
156          <td class="mdname1" valign="top" nowrap>          </td>
157          <td class="md" valign="top">&nbsp;)&nbsp;</td>
158          <td class="md" nowrap><code> [virtual]</code></td>
159        </tr>
160      </table>
161    </td>
162  </tr>
163</table>
164<table cellspacing="5" cellpadding="0" border="0">
165  <tr>
166    <td>
167      &nbsp;
168    </td>
169    <td>
170
171<p>
172Destructor: do not use directly.
173<p>
174Instead, call the <a class="el" href="class_f_c_d_animation.html#ff72eb16b357e17dcd45959b5d6981df">FCDAnimation::ReleaseChannel</a> function.     </td>
175  </tr>
176</table>
177<hr><h2>Member Function Documentation</h2>
178<a class="anchor" name="3cd77e243432a42c614e8c510bb69138"></a><!-- doxytag: member="FCDAnimationChannel::AddCurve" ref="3cd77e243432a42c614e8c510bb69138" args="()" --><p>
179<table class="mdTable" cellpadding="2" cellspacing="0">
180  <tr>
181    <td class="mdRow">
182      <table cellpadding="0" cellspacing="0" border="0">
183        <tr>
184          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a>* FCDAnimationChannel::AddCurve           </td>
185          <td class="md" valign="top">(&nbsp;</td>
186          <td class="mdname1" valign="top" nowrap>          </td>
187          <td class="md" valign="top">&nbsp;)&nbsp;</td>
188          <td class="md" nowrap></td>
189        </tr>
190      </table>
191    </td>
192  </tr>
193</table>
194<table cellspacing="5" cellpadding="0" border="0">
195  <tr>
196    <td>
197      &nbsp;
198    </td>
199    <td>
200
201<p>
202Adds a new animation curve to this animation channel.
203<p>
204<dl compact><dt><b>Returns:</b></dt><dd>The new animation curve. </dd></dl>
205    </td>
206  </tr>
207</table>
208<a class="anchor" name="f509cb79cb6350ae64d375053759ecb8"></a><!-- doxytag: member="FCDAnimationChannel::CheckDriver" ref="f509cb79cb6350ae64d375053759ecb8" args="()" --><p>
209<table class="mdTable" cellpadding="2" cellspacing="0">
210  <tr>
211    <td class="mdRow">
212      <table cellpadding="0" cellspacing="0" border="0">
213        <tr>
214          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDAnimationChannel::CheckDriver           </td>
215          <td class="md" valign="top">(&nbsp;</td>
216          <td class="mdname1" valign="top" nowrap>          </td>
217          <td class="md" valign="top">&nbsp;)&nbsp;</td>
218          <td class="md" nowrap></td>
219        </tr>
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing="5" cellpadding="0" border="0">
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232[INTERNAL] Verifies that if a driver is used by this channel, then it was found during the import of the animated elements.
233<p>
234<dl compact><dt><b>Returns:</b></dt><dd>The status of the verification. </dd></dl>
235    </td>
236  </tr>
237</table>
238<a class="anchor" name="6022ce6350b29c74b21f253f779739c4"></a><!-- doxytag: member="FCDAnimationChannel::GetCurve" ref="6022ce6350b29c74b21f253f779739c4" args="(size_t index)" --><p>
239<table class="mdTable" cellpadding="2" cellspacing="0">
240  <tr>
241    <td class="mdRow">
242      <table cellpadding="0" cellspacing="0" border="0">
243        <tr>
244          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a>* FCDAnimationChannel::GetCurve           </td>
245          <td class="md" valign="top">(&nbsp;</td>
246          <td class="md" nowrap valign="top">size_t&nbsp;</td>
247          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
248          <td class="md" valign="top">&nbsp;)&nbsp;</td>
249          <td class="md" nowrap><code> [inline]</code></td>
250        </tr>
251      </table>
252    </td>
253  </tr>
254</table>
255<table cellspacing="5" cellpadding="0" border="0">
256  <tr>
257    <td>
258      &nbsp;
259    </td>
260    <td>
261
262<p>
263Retrieves an animation curve contained within the channel.
264<p>
265<dl compact><dt><b>Parameters:</b></dt><dd>
266  <table border="0" cellspacing="2" cellpadding="0">
267    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the animation curve. </td></tr>
268  </table>
269</dl>
270<dl compact><dt><b>Returns:</b></dt><dd>The animation curve at the given index. This pointer will be NULL if the index is out-of-bounds. </dd></dl>
271    </td>
272  </tr>
273</table>
274<a class="anchor" name="c1b1e057ebccde60502ea1a12b00f358"></a><!-- doxytag: member="FCDAnimationChannel::GetCurveCount" ref="c1b1e057ebccde60502ea1a12b00f358" args="() const " --><p>
275<table class="mdTable" cellpadding="2" cellspacing="0">
276  <tr>
277    <td class="mdRow">
278      <table cellpadding="0" cellspacing="0" border="0">
279        <tr>
280          <td class="md" nowrap valign="top">size_t FCDAnimationChannel::GetCurveCount           </td>
281          <td class="md" valign="top">(&nbsp;</td>
282          <td class="mdname1" valign="top" nowrap>          </td>
283          <td class="md" valign="top">&nbsp;)&nbsp;</td>
284          <td class="md" nowrap> const<code> [inline]</code></td>
285        </tr>
286      </table>
287    </td>
288  </tr>
289</table>
290<table cellspacing="5" cellpadding="0" border="0">
291  <tr>
292    <td>
293      &nbsp;
294    </td>
295    <td>
296
297<p>
298Retrieves the number of animation curves contained within the channel.
299<p>
300<dl compact><dt><b>Returns:</b></dt><dd>The number of animation curves. </dd></dl>
301    </td>
302  </tr>
303</table>
304<a class="anchor" name="fa3c640a2dd9bfe68ea45a5208772af5"></a><!-- doxytag: member="FCDAnimationChannel::GetCurves" ref="fa3c640a2dd9bfe68ea45a5208772af5" args="() const " --><p>
305<table class="mdTable" cellpadding="2" cellspacing="0">
306  <tr>
307    <td class="mdRow">
308      <table cellpadding="0" cellspacing="0" border="0">
309        <tr>
310          <td class="md" nowrap valign="top">const <a class="el" href="classvector.html">FCDAnimationCurveList</a>&amp; FCDAnimationChannel::GetCurves           </td>
311          <td class="md" valign="top">(&nbsp;</td>
312          <td class="mdname1" valign="top" nowrap>          </td>
313          <td class="md" valign="top">&nbsp;)&nbsp;</td>
314          <td class="md" nowrap> const<code> [inline]</code></td>
315        </tr>
316      </table>
317    </td>
318  </tr>
319</table>
320<table cellspacing="5" cellpadding="0" border="0">
321  <tr>
322    <td>
323      &nbsp;
324    </td>
325    <td>
326
327<p>
328Retrieves the list of animation curves contained within the channel.
329<p>
330<dl compact><dt><b>Returns:</b></dt><dd>The list of animation curves. </dd></dl>
331    </td>
332  </tr>
333</table>
334<a class="anchor" name="208109679a16dec1f0103cbaa7b28324"></a><!-- doxytag: member="FCDAnimationChannel::GetParent" ref="208109679a16dec1f0103cbaa7b28324" args="()" --><p>
335<table class="mdTable" cellpadding="2" cellspacing="0">
336  <tr>
337    <td class="mdRow">
338      <table cellpadding="0" cellspacing="0" border="0">
339        <tr>
340          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation.html">FCDAnimation</a>* FCDAnimationChannel::GetParent           </td>
341          <td class="md" valign="top">(&nbsp;</td>
342          <td class="mdname1" valign="top" nowrap>          </td>
343          <td class="md" valign="top">&nbsp;)&nbsp;</td>
344          <td class="md" nowrap><code> [inline]</code></td>
345        </tr>
346      </table>
347    </td>
348  </tr>
349</table>
350<table cellspacing="5" cellpadding="0" border="0">
351  <tr>
352    <td>
353      &nbsp;
354    </td>
355    <td>
356
357<p>
358Retrieves the animation sub-tree that contains the animation channel.
359<p>
360<dl compact><dt><b>Returns:</b></dt><dd>The parent animation sub-tree. </dd></dl>
361    </td>
362  </tr>
363</table>
364<a class="anchor" name="a3cdb2fb7ca73e7f9026251f861edf32"></a><!-- doxytag: member="FCDAnimationChannel::GetTargetPointer" ref="a3cdb2fb7ca73e7f9026251f861edf32" args="() const " --><p>
365<table class="mdTable" cellpadding="2" cellspacing="0">
366  <tr>
367    <td class="mdRow">
368      <table cellpadding="0" cellspacing="0" border="0">
369        <tr>
370          <td class="md" nowrap valign="top">const string&amp; FCDAnimationChannel::GetTargetPointer           </td>
371          <td class="md" valign="top">(&nbsp;</td>
372          <td class="mdname1" valign="top" nowrap>          </td>
373          <td class="md" valign="top">&nbsp;)&nbsp;</td>
374          <td class="md" nowrap> const<code> [inline]</code></td>
375        </tr>
376      </table>
377    </td>
378  </tr>
379</table>
380<table cellspacing="5" cellpadding="0" border="0">
381  <tr>
382    <td>
383      &nbsp;
384    </td>
385    <td>
386
387<p>
388[INTERNAL] Retrieves the target pointer prefix for this animation channel.
389<p>
390This function is used during the import of a COLLADA document to match the target pointer prefixes with the animated elements. <dl compact><dt><b>Returns:</b></dt><dd>The target pointer prefix. </dd></dl>
391    </td>
392  </tr>
393</table>
394<a class="anchor" name="db7692a3c78cb4277eb5bfd7aced3bc8"></a><!-- doxytag: member="FCDAnimationChannel::GetTargetQualifier" ref="db7692a3c78cb4277eb5bfd7aced3bc8" args="() const " --><p>
395<table class="mdTable" cellpadding="2" cellspacing="0">
396  <tr>
397    <td class="mdRow">
398      <table cellpadding="0" cellspacing="0" border="0">
399        <tr>
400          <td class="md" nowrap valign="top">const string&amp; FCDAnimationChannel::GetTargetQualifier           </td>
401          <td class="md" valign="top">(&nbsp;</td>
402          <td class="mdname1" valign="top" nowrap>          </td>
403          <td class="md" valign="top">&nbsp;)&nbsp;</td>
404          <td class="md" nowrap> const<code> [inline]</code></td>
405        </tr>
406      </table>
407    </td>
408  </tr>
409</table>
410<table cellspacing="5" cellpadding="0" border="0">
411  <tr>
412    <td>
413      &nbsp;
414    </td>
415    <td>
416
417<p>
418[INTERNAL] Retrieves the target qualifier for this animation channel.
419<p>
420This function is used during the import of a COLLADA document. Where there is a target qualifier, there should be only one curve contained by the channel. <dl compact><dt><b>Returns:</b></dt><dd>The target qualifier. This value may be the empty string if the channel targets all the values targeted by the target pointer prefix. </dd></dl>
421    </td>
422  </tr>
423</table>
424<a class="anchor" name="ca7e6d2bb7e632d4f814e4178146f39a"></a><!-- doxytag: member="FCDAnimationChannel::LinkDriver" ref="ca7e6d2bb7e632d4f814e4178146f39a" args="(FCDAnimated *animated)" --><p>
425<table class="mdTable" cellpadding="2" cellspacing="0">
426  <tr>
427    <td class="mdRow">
428      <table cellpadding="0" cellspacing="0" border="0">
429        <tr>
430          <td class="md" nowrap valign="top">bool FCDAnimationChannel::LinkDriver           </td>
431          <td class="md" valign="top">(&nbsp;</td>
432          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> *&nbsp;</td>
433          <td class="mdname1" valign="top" nowrap> <em>animated</em>          </td>
434          <td class="md" valign="top">&nbsp;)&nbsp;</td>
435          <td class="md" nowrap></td>
436        </tr>
437      </table>
438    </td>
439  </tr>
440</table>
441<table cellspacing="5" cellpadding="0" border="0">
442  <tr>
443    <td>
444      &nbsp;
445    </td>
446    <td>
447
448<p>
449[INTERNAL] Considers the given animated element as the driver for this animation channel.
450<p>
451<dl compact><dt><b>Parameters:</b></dt><dd>
452  <table border="0" cellspacing="2" cellpadding="0">
453    <tr><td valign="top"></td><td valign="top"><em>animated</em>&nbsp;</td><td>An animated element. </td></tr>
454  </table>
455</dl>
456<dl compact><dt><b>Returns:</b></dt><dd>Whether the animated element is in fact the driver for the animation channel. </dd></dl>
457    </td>
458  </tr>
459</table>
460<a class="anchor" name="7821e346181d25c0eced3c679e34274d"></a><!-- doxytag: member="FCDAnimationChannel::LoadFromXML" ref="7821e346181d25c0eced3c679e34274d" args="(xmlNode *channelNode)" --><p>
461<table class="mdTable" cellpadding="2" cellspacing="0">
462  <tr>
463    <td class="mdRow">
464      <table cellpadding="0" cellspacing="0" border="0">
465        <tr>
466          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDAnimationChannel::LoadFromXML           </td>
467          <td class="md" valign="top">(&nbsp;</td>
468          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
469          <td class="mdname1" valign="top" nowrap> <em>channelNode</em>          </td>
470          <td class="md" valign="top">&nbsp;)&nbsp;</td>
471          <td class="md" nowrap></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>
485[INTERNAL] Reads in the animation channel from a given COLLADA XML tree node.
486<p>
487<dl compact><dt><b>Parameters:</b></dt><dd>
488  <table border="0" cellspacing="2" cellpadding="0">
489    <tr><td valign="top"></td><td valign="top"><em>channelNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
490  </table>
491</dl>
492<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 channel. </dd></dl>
493    </td>
494  </tr>
495</table>
496<a class="anchor" name="7737b8e386bcd898225565bdd730740e"></a><!-- doxytag: member="FCDAnimationChannel::ReleaseCurve" ref="7737b8e386bcd898225565bdd730740e" args="(FCDAnimationCurve *curve)" --><p>
497<table class="mdTable" cellpadding="2" cellspacing="0">
498  <tr>
499    <td class="mdRow">
500      <table cellpadding="0" cellspacing="0" border="0">
501        <tr>
502          <td class="md" nowrap valign="top">void FCDAnimationChannel::ReleaseCurve           </td>
503          <td class="md" valign="top">(&nbsp;</td>
504          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> *&nbsp;</td>
505          <td class="mdname1" valign="top" nowrap> <em>curve</em>          </td>
506          <td class="md" valign="top">&nbsp;)&nbsp;</td>
507          <td class="md" nowrap></td>
508        </tr>
509      </table>
510    </td>
511  </tr>
512</table>
513<table cellspacing="5" cellpadding="0" border="0">
514  <tr>
515    <td>
516      &nbsp;
517    </td>
518    <td>
519
520<p>
521Releases an animation curve contained within this channel.
522<p>
523<dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>This function is not yet implemented, as it requires a lot more memory management than <a class="el" href="namespace_f_collada.html">FCollada</a> currently does. </dd></dl>
524<dl compact><dt><b>Parameters:</b></dt><dd>
525  <table border="0" cellspacing="2" cellpadding="0">
526    <tr><td valign="top"></td><td valign="top"><em>curve</em>&nbsp;</td><td>The animation curve to release. </td></tr>
527  </table>
528</dl>
529    </td>
530  </tr>
531</table>
532<a class="anchor" name="3bbf9bbc45437d7ab34a2972da6ab784"></a><!-- doxytag: member="FCDAnimationChannel::SetTargetPointer" ref="3bbf9bbc45437d7ab34a2972da6ab784" args="(const string &amp;p)" --><p>
533<table class="mdTable" cellpadding="2" cellspacing="0">
534  <tr>
535    <td class="mdRow">
536      <table cellpadding="0" cellspacing="0" border="0">
537        <tr>
538          <td class="md" nowrap valign="top">void FCDAnimationChannel::SetTargetPointer           </td>
539          <td class="md" valign="top">(&nbsp;</td>
540          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
541          <td class="mdname1" valign="top" nowrap> <em>p</em>          </td>
542          <td class="md" valign="top">&nbsp;)&nbsp;</td>
543          <td class="md" nowrap><code> [inline]</code></td>
544        </tr>
545      </table>
546    </td>
547  </tr>
548</table>
549<table cellspacing="5" cellpadding="0" border="0">
550  <tr>
551    <td>
552      &nbsp;
553    </td>
554    <td>
555
556<p>
557[INTERNAL] Enforces the tarrget pointer prefix for the animation channel.
558<p>
559This function is used during the export of a COLLADA document. <dl compact><dt><b>Parameters:</b></dt><dd>
560  <table border="0" cellspacing="2" cellpadding="0">
561    <tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>The new target pointer prefix. </td></tr>
562  </table>
563</dl>
564    </td>
565  </tr>
566</table>
567<a class="anchor" name="d27f91a4cde919a6d5c7505e57fb1779"></a><!-- doxytag: member="FCDAnimationChannel::WriteToXML" ref="d27f91a4cde919a6d5c7505e57fb1779" args="(xmlNode *parentNode) const " --><p>
568<table class="mdTable" cellpadding="2" cellspacing="0">
569  <tr>
570    <td class="mdRow">
571      <table cellpadding="0" cellspacing="0" border="0">
572        <tr>
573          <td class="md" nowrap valign="top">void FCDAnimationChannel::WriteToXML           </td>
574          <td class="md" valign="top">(&nbsp;</td>
575          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
576          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
577          <td class="md" valign="top">&nbsp;)&nbsp;</td>
578          <td class="md" nowrap> const</td>
579        </tr>
580      </table>
581    </td>
582  </tr>
583</table>
584<table cellspacing="5" cellpadding="0" border="0">
585  <tr>
586    <td>
587      &nbsp;
588    </td>
589    <td>
590
591<p>
592[INTERNAL] Writes out the animation channel to the given COLLADA XML tree node.
593<p>
594<dl compact><dt><b>Parameters:</b></dt><dd>
595  <table border="0" cellspacing="2" cellpadding="0">
596    <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 channel. </td></tr>
597  </table>
598</dl>
599<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
600    </td>
601  </tr>
602</table>
603<hr>The documentation for this class was generated from the following file:<ul>
604<li>FCDocument/<a class="el" href="_f_c_d_animation_channel_8h-source.html">FCDAnimationChannel.h</a></ul>
605<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
606<a href="http://www.doxygen.org/index.html">
607<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
608</body>
609</html>
Note: See TracBrowser for help on using the repository browser.