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

Revision 964, 37.4 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: FCDAnimationMultiCurve 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>FCDAnimationMultiCurve 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="FCDAnimationMultiCurve" --><!-- doxytag: inherits="FCDObject" -->A COLLADA multi-dimensional animation curve. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_animation_multi_curve_8h-source.html">FCDAnimationMultiCurve.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDAnimationMultiCurve:
33<p><center><img src="class_f_c_d_animation_multi_curve.png" usemap="#FCDAnimationMultiCurve_map" border="0" alt=""></center>
34<map name="FCDAnimationMultiCurve_map">
35<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,155,80">
36<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,155,24">
37</map>
38<a href="class_f_c_d_animation_multi_curve-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_multi_curve.html#2d24f269824f986407c0fa247b80e96c">FCDAnimationMultiCurve</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, uint32 dimension)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#2d24f269824f986407c0fa247b80e96c"></a><br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2bd5c16192ce0046f4e58aed4f302e6a"></a><!-- doxytag: member="FCDAnimationMultiCurve::~FCDAnimationMultiCurve" ref="2bd5c16192ce0046f4e58aed4f302e6a" args="()" -->
45virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#2bd5c16192ce0046f4e58aed4f302e6a">~FCDAnimationMultiCurve</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#0b6badef0fb401db1e99820d043a69f4">GetDimension</a> () const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of dimensions for the curve.  <a href="#0b6badef0fb401db1e99820d043a69f4"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FloatList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#22e01ace826cbbd9e75c0b6801d6ff91">GetKeys</a> ()</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of key inputs for the animation curve.  <a href="#22e01ace826cbbd9e75c0b6801d6ff91"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab0902fe24acfa070cf9c3191efd8896"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetKeys" ref="ab0902fe24acfa070cf9c3191efd8896" args="() const " -->
55const <a class="el" href="classvector.html">FloatList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#ab0902fe24acfa070cf9c3191efd8896">GetKeys</a> () const </td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FloatList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#e990967bd4c5ac88e8f55a33fc4bd905">GetKeyValues</a> ()</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the lists of key outputs for the animation curve.  <a href="#e990967bd4c5ac88e8f55a33fc4bd905"></a><br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8964d1d8f93e5b737053a536ba76cb0"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetKeyValues" ref="d8964d1d8f93e5b737053a536ba76cb0" args="() const " -->
62const <a class="el" href="classvector.html">FloatList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#d8964d1d8f93e5b737053a536ba76cb0">GetKeyValues</a> () 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="classvector.html">FloatList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#a012025a8665396e5ce44b5eee8d2eaa">GetInTangents</a> ()</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the lists of key in-tangent values for the animation curve.  <a href="#a012025a8665396e5ce44b5eee8d2eaa"></a><br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6d5c6a5093e24dcbc54f533de7e89d3"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetInTangents" ref="d6d5c6a5093e24dcbc54f533de7e89d3" args="() const " -->
69const <a class="el" href="classvector.html">FloatList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#d6d5c6a5093e24dcbc54f533de7e89d3">GetInTangents</a> () const </td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FloatList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#9376f96c2a86ada335112a1842afd3be">GetOutTangents</a> ()</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the lists of key out-tangent values for the animation curve.  <a href="#9376f96c2a86ada335112a1842afd3be"></a><br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e4026381924ce2bf73eca75664295936"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetOutTangents" ref="e4026381924ce2bf73eca75664295936" args="() const " -->
76const <a class="el" href="classvector.html">FloatList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#e4026381924ce2bf73eca75664295936">GetOutTangents</a> () const </td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">UInt32List</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#6f92c9903251caf43fecf49f592c2c0b">GetInterpolations</a> ()</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of interpolation type for the segments of the animation curve.  <a href="#6f92c9903251caf43fecf49f592c2c0b"></a><br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78df9e1b191d626918e072df941a61c3"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetInterpolations" ref="78df9e1b191d626918e072df941a61c3" args="() const " -->
83const <a class="el" href="classvector.html">UInt32List</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#78df9e1b191d626918e072df941a61c3">GetInterpolations</a> () const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
86<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_multi_curve.html#50979bee5862ccb12a5c829e9410a4eb">Evaluate</a> (float input, float *output) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates the animation curve.  <a href="#50979bee5862ccb12a5c829e9410a4eb"></a><br></td></tr>
89<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_multi_curve.html#bbd29dc59cbdbf65914a01cbd86ec07a">Collapse</a> (<a class="el" href="_f_c_d_animation_multi_curve_8h.html#108f3f31a5097fdde5a065a1c7ad0acc">FCDCollapsingFunction</a> collapse=NULL) const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Collapses this multi-dimensional curve into a one-dimensional curve.  <a href="#bbd29dc59cbdbf65914a01cbd86ec07a"></a><br></td></tr>
92<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_multi_curve.html#1eca0d4557e711ca9e112948baffd0e6">WriteSourceToXML</a> (xmlNode *parentNode, const string &amp;baseId)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the data sources necessary to import the animation curve to a given XML tree node.  <a href="#1eca0d4557e711ca9e112948baffd0e6"></a><br></td></tr>
95<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_multi_curve.html#2f09b98996f798c52628e7f3318cc407">WriteSamplerToXML</a> (xmlNode *parentNode, const string &amp;baseId)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the sampler that puts together the data sources and generates a sampling function.  <a href="#2f09b98996f798c52628e7f3318cc407"></a><br></td></tr>
98<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_multi_curve.html#70b326c153d62dbce5afda9df1da81fd">WriteChannelToXML</a> (xmlNode *parentNode, const string &amp;baseId, const string &amp;pointer)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the animation channel that attaches the sampling function to the animatable value.  <a href="#70b326c153d62dbce5afda9df1da81fd"></a><br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top">int32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#e1cd6afb67f21bc40e706ec73bc911e5">GetTargetElement</a> () const </td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves the target element suffix for the curve.  <a href="#e1cd6afb67f21bc40e706ec73bc911e5"></a><br></td></tr>
104<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_multi_curve.html#e9a30b28b6ab7f201717fd6a3d4db770">SetTargetElement</a> (int32 e)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Sets the target element suffix for the curve.  <a href="#e9a30b28b6ab7f201717fd6a3d4db770"></a><br></td></tr>
107<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_animation_multi_curve.html">FCDAnimationMultiCurve</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#c04df763873cdc731262085e98afed3c">MergeCurves</a> (const <a class="el" href="classvector.html">vector</a>&lt; <a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> * &gt; &amp;toMerge, const <a class="el" href="classvector.html">FloatList</a> &amp;defaultValues)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Merges multiple single-dimensional animation curves into one multi-dimensional animation curve.  <a href="#c04df763873cdc731262085e98afed3c"></a><br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83e315f86efeec69b66fdd0f2d08c0dd"></a><!-- doxytag: member="FCDAnimationMultiCurve::MergeCurves" ref="83e315f86efeec69b66fdd0f2d08c0dd" args="(const vector&lt; const FCDAnimationCurve * &gt; &amp;toMerge, const FloatList &amp;defaultValues)" -->
112static <a class="el" href="class_f_c_d_animation_multi_curve.html">FCDAnimationMultiCurve</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_multi_curve.html#83e315f86efeec69b66fdd0f2d08c0dd">MergeCurves</a> (const <a class="el" href="classvector.html">vector</a>&lt; const <a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> * &gt; &amp;toMerge, const <a class="el" href="classvector.html">FloatList</a> &amp;defaultValues)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
115</table>
116<hr><a name="_details"></a><h2>Detailed Description</h2>
117A COLLADA multi-dimensional animation curve.
118<p>
119This is a utility class that is used to convert multiple animation curves into one animation curve that has multiple dimensions, but only one list of key inputs.<p>
120<a class="el" href="namespace_f_collada.html">FCollada</a> will never create a multi-dimensional animation curve during the import of a COLLADA document.
121<p>
122<hr><h2>Constructor &amp; Destructor Documentation</h2>
123<a class="anchor" name="2d24f269824f986407c0fa247b80e96c"></a><!-- doxytag: member="FCDAnimationMultiCurve::FCDAnimationMultiCurve" ref="2d24f269824f986407c0fa247b80e96c" args="(FCDocument *document, uint32 dimension)" --><p>
124<table class="mdTable" cellpadding="2" cellspacing="0">
125  <tr>
126    <td class="mdRow">
127      <table cellpadding="0" cellspacing="0" border="0">
128        <tr>
129          <td class="md" nowrap valign="top">FCDAnimationMultiCurve::FCDAnimationMultiCurve           </td>
130          <td class="md" valign="top">(&nbsp;</td>
131          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
132          <td class="mdname" nowrap> <em>document</em>, </td>
133        </tr>
134        <tr>
135          <td class="md" nowrap align="right"></td>
136          <td class="md"></td>
137          <td class="md" nowrap>uint32&nbsp;</td>
138          <td class="mdname" nowrap> <em>dimension</em></td>
139        </tr>
140        <tr>
141          <td class="md"></td>
142          <td class="md">)&nbsp;</td>
143          <td class="md" colspan="2"></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>
157Constructor.
158<p>
159The number of dimensions will not change in the lifetime of a multi-dimensional curve. <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 animation curve. </td></tr>
162    <tr><td valign="top"></td><td valign="top"><em>dimension</em>&nbsp;</td><td>The number of dimensions for the animation curve. </td></tr>
163  </table>
164</dl>
165    </td>
166  </tr>
167</table>
168<hr><h2>Member Function Documentation</h2>
169<a class="anchor" name="bbd29dc59cbdbf65914a01cbd86ec07a"></a><!-- doxytag: member="FCDAnimationMultiCurve::Collapse" ref="bbd29dc59cbdbf65914a01cbd86ec07a" args="(FCDCollapsingFunction collapse=NULL) const " --><p>
170<table class="mdTable" cellpadding="2" cellspacing="0">
171  <tr>
172    <td class="mdRow">
173      <table cellpadding="0" cellspacing="0" border="0">
174        <tr>
175          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a>* FCDAnimationMultiCurve::Collapse           </td>
176          <td class="md" valign="top">(&nbsp;</td>
177          <td class="md" nowrap valign="top"><a class="el" href="_f_c_d_animation_multi_curve_8h.html#108f3f31a5097fdde5a065a1c7ad0acc">FCDCollapsingFunction</a>&nbsp;</td>
178          <td class="mdname1" valign="top" nowrap> <em>collapse</em> = <code>NULL</code>          </td>
179          <td class="md" valign="top">&nbsp;)&nbsp;</td>
180          <td class="md" nowrap> const</td>
181        </tr>
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing="5" cellpadding="0" border="0">
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194Collapses this multi-dimensional curve into a one-dimensional curve.
195<p>
196<dl compact><dt><b>Parameters:</b></dt><dd>
197  <table border="0" cellspacing="2" cellpadding="0">
198    <tr><td valign="top"></td><td valign="top"><em>collapse</em>&nbsp;</td><td>The function to use to collapse multiple floating-point values into one. Set this to NULL to use the default collapsing function, which averages all the values. </td></tr>
199  </table>
200</dl>
201<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="_f_c_d_animation_multi_curve_8h.html#b7cdae42225091810d11a0fd0e261fe6">Average</a> <a class="el" href="_f_c_d_animation_multi_curve_8h.html#3ce437fb85f8b207da562dec849414c2">TakeFirst</a> </dd></dl>
202    </td>
203  </tr>
204</table>
205<a class="anchor" name="50979bee5862ccb12a5c829e9410a4eb"></a><!-- doxytag: member="FCDAnimationMultiCurve::Evaluate" ref="50979bee5862ccb12a5c829e9410a4eb" args="(float input, float *output) const " --><p>
206<table class="mdTable" cellpadding="2" cellspacing="0">
207  <tr>
208    <td class="mdRow">
209      <table cellpadding="0" cellspacing="0" border="0">
210        <tr>
211          <td class="md" nowrap valign="top">void FCDAnimationMultiCurve::Evaluate           </td>
212          <td class="md" valign="top">(&nbsp;</td>
213          <td class="md" nowrap valign="top">float&nbsp;</td>
214          <td class="mdname" nowrap> <em>input</em>, </td>
215        </tr>
216        <tr>
217          <td class="md" nowrap align="right"></td>
218          <td class="md"></td>
219          <td class="md" nowrap>float *&nbsp;</td>
220          <td class="mdname" nowrap> <em>output</em></td>
221        </tr>
222        <tr>
223          <td class="md"></td>
224          <td class="md">)&nbsp;</td>
225          <td class="md" colspan="2"> const</td>
226        </tr>
227      </table>
228    </td>
229  </tr>
230</table>
231<table cellspacing="5" cellpadding="0" border="0">
232  <tr>
233    <td>
234      &nbsp;
235    </td>
236    <td>
237
238<p>
239Evaluates the animation curve.
240<p>
241<dl compact><dt><b>Parameters:</b></dt><dd>
242  <table border="0" cellspacing="2" cellpadding="0">
243    <tr><td valign="top"></td><td valign="top"><em>input</em>&nbsp;</td><td>An input value. </td></tr>
244    <tr><td valign="top"></td><td valign="top"><em>output</em>&nbsp;</td><td>An array of floating-point values to fill in with the sampled values. </td></tr>
245  </table>
246</dl>
247    </td>
248  </tr>
249</table>
250<a class="anchor" name="0b6badef0fb401db1e99820d043a69f4"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetDimension" ref="0b6badef0fb401db1e99820d043a69f4" args="() const " --><p>
251<table class="mdTable" cellpadding="2" cellspacing="0">
252  <tr>
253    <td class="mdRow">
254      <table cellpadding="0" cellspacing="0" border="0">
255        <tr>
256          <td class="md" nowrap valign="top">uint32 FCDAnimationMultiCurve::GetDimension           </td>
257          <td class="md" valign="top">(&nbsp;</td>
258          <td class="mdname1" valign="top" nowrap>          </td>
259          <td class="md" valign="top">&nbsp;)&nbsp;</td>
260          <td class="md" nowrap> const<code> [inline]</code></td>
261        </tr>
262      </table>
263    </td>
264  </tr>
265</table>
266<table cellspacing="5" cellpadding="0" border="0">
267  <tr>
268    <td>
269      &nbsp;
270    </td>
271    <td>
272
273<p>
274Retrieves the number of dimensions for the curve.
275<p>
276<dl compact><dt><b>Returns:</b></dt><dd>The number of dimensions for the curve. </dd></dl>
277    </td>
278  </tr>
279</table>
280<a class="anchor" name="a012025a8665396e5ce44b5eee8d2eaa"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetInTangents" ref="a012025a8665396e5ce44b5eee8d2eaa" args="()" --><p>
281<table class="mdTable" cellpadding="2" cellspacing="0">
282  <tr>
283    <td class="mdRow">
284      <table cellpadding="0" cellspacing="0" border="0">
285        <tr>
286          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FloatList</a>* FCDAnimationMultiCurve::GetInTangents           </td>
287          <td class="md" valign="top">(&nbsp;</td>
288          <td class="mdname1" valign="top" nowrap>          </td>
289          <td class="md" valign="top">&nbsp;)&nbsp;</td>
290          <td class="md" nowrap><code> [inline]</code></td>
291        </tr>
292      </table>
293    </td>
294  </tr>
295</table>
296<table cellspacing="5" cellpadding="0" border="0">
297  <tr>
298    <td>
299      &nbsp;
300    </td>
301    <td>
302
303<p>
304Retrieves the lists of key in-tangent values for the animation curve.
305<p>
306These lists have data only if the curve includes segments with the bezier interpolation. There is one separate list of key in-tangent values for each dimension of the curve. <dl compact><dt><b>Returns:</b></dt><dd>The lists of in-tangent values. </dd></dl>
307    </td>
308  </tr>
309</table>
310<a class="anchor" name="6f92c9903251caf43fecf49f592c2c0b"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetInterpolations" ref="6f92c9903251caf43fecf49f592c2c0b" args="()" --><p>
311<table class="mdTable" cellpadding="2" cellspacing="0">
312  <tr>
313    <td class="mdRow">
314      <table cellpadding="0" cellspacing="0" border="0">
315        <tr>
316          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">UInt32List</a>&amp; FCDAnimationMultiCurve::GetInterpolations           </td>
317          <td class="md" valign="top">(&nbsp;</td>
318          <td class="mdname1" valign="top" nowrap>          </td>
319          <td class="md" valign="top">&nbsp;)&nbsp;</td>
320          <td class="md" nowrap><code> [inline]</code></td>
321        </tr>
322      </table>
323    </td>
324  </tr>
325</table>
326<table cellspacing="5" cellpadding="0" border="0">
327  <tr>
328    <td>
329      &nbsp;
330    </td>
331    <td>
332
333<p>
334Retrieves the list of interpolation type for the segments of the animation curve.
335<p>
336There is always one interpolation type for each key in the curve. The interpolation type of a segment of the curve is set at the key at which begins the segment. <dl compact><dt><b>See also:</b></dt><dd>FUDaeInterpolation </dd></dl>
337<dl compact><dt><b>Returns:</b></dt><dd>The list of interpolation types. </dd></dl>
338    </td>
339  </tr>
340</table>
341<a class="anchor" name="22e01ace826cbbd9e75c0b6801d6ff91"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetKeys" ref="22e01ace826cbbd9e75c0b6801d6ff91" args="()" --><p>
342<table class="mdTable" cellpadding="2" cellspacing="0">
343  <tr>
344    <td class="mdRow">
345      <table cellpadding="0" cellspacing="0" border="0">
346        <tr>
347          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FloatList</a>&amp; FCDAnimationMultiCurve::GetKeys           </td>
348          <td class="md" valign="top">(&nbsp;</td>
349          <td class="mdname1" valign="top" nowrap>          </td>
350          <td class="md" valign="top">&nbsp;)&nbsp;</td>
351          <td class="md" nowrap><code> [inline]</code></td>
352        </tr>
353      </table>
354    </td>
355  </tr>
356</table>
357<table cellspacing="5" cellpadding="0" border="0">
358  <tr>
359    <td>
360      &nbsp;
361    </td>
362    <td>
363
364<p>
365Retrieves the list of key inputs for the animation curve.
366<p>
367<dl compact><dt><b>Returns:</b></dt><dd>The list of key inputs. </dd></dl>
368    </td>
369  </tr>
370</table>
371<a class="anchor" name="e990967bd4c5ac88e8f55a33fc4bd905"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetKeyValues" ref="e990967bd4c5ac88e8f55a33fc4bd905" args="()" --><p>
372<table class="mdTable" cellpadding="2" cellspacing="0">
373  <tr>
374    <td class="mdRow">
375      <table cellpadding="0" cellspacing="0" border="0">
376        <tr>
377          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FloatList</a>* FCDAnimationMultiCurve::GetKeyValues           </td>
378          <td class="md" valign="top">(&nbsp;</td>
379          <td class="mdname1" valign="top" nowrap>          </td>
380          <td class="md" valign="top">&nbsp;)&nbsp;</td>
381          <td class="md" nowrap><code> [inline]</code></td>
382        </tr>
383      </table>
384    </td>
385  </tr>
386</table>
387<table cellspacing="5" cellpadding="0" border="0">
388  <tr>
389    <td>
390      &nbsp;
391    </td>
392    <td>
393
394<p>
395Retrieves the lists of key outputs for the animation curve.
396<p>
397There is one separate list of key outputs for each dimension of the curve. <dl compact><dt><b>Returns:</b></dt><dd>The lists of key outputs. </dd></dl>
398    </td>
399  </tr>
400</table>
401<a class="anchor" name="9376f96c2a86ada335112a1842afd3be"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetOutTangents" ref="9376f96c2a86ada335112a1842afd3be" args="()" --><p>
402<table class="mdTable" cellpadding="2" cellspacing="0">
403  <tr>
404    <td class="mdRow">
405      <table cellpadding="0" cellspacing="0" border="0">
406        <tr>
407          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FloatList</a>* FCDAnimationMultiCurve::GetOutTangents           </td>
408          <td class="md" valign="top">(&nbsp;</td>
409          <td class="mdname1" valign="top" nowrap>          </td>
410          <td class="md" valign="top">&nbsp;)&nbsp;</td>
411          <td class="md" nowrap><code> [inline]</code></td>
412        </tr>
413      </table>
414    </td>
415  </tr>
416</table>
417<table cellspacing="5" cellpadding="0" border="0">
418  <tr>
419    <td>
420      &nbsp;
421    </td>
422    <td>
423
424<p>
425Retrieves the lists of key out-tangent values for the animation curve.
426<p>
427These lists have data only if the curve includes segments with the bezier interpolation. There is one separate list of key out-tangent values for each dimension of the curve. <dl compact><dt><b>Returns:</b></dt><dd>The lists of out-tangent values. </dd></dl>
428    </td>
429  </tr>
430</table>
431<a class="anchor" name="e1cd6afb67f21bc40e706ec73bc911e5"></a><!-- doxytag: member="FCDAnimationMultiCurve::GetTargetElement" ref="e1cd6afb67f21bc40e706ec73bc911e5" args="() const " --><p>
432<table class="mdTable" cellpadding="2" cellspacing="0">
433  <tr>
434    <td class="mdRow">
435      <table cellpadding="0" cellspacing="0" border="0">
436        <tr>
437          <td class="md" nowrap valign="top">int32 FCDAnimationMultiCurve::GetTargetElement           </td>
438          <td class="md" valign="top">(&nbsp;</td>
439          <td class="mdname1" valign="top" nowrap>          </td>
440          <td class="md" valign="top">&nbsp;)&nbsp;</td>
441          <td class="md" nowrap> const<code> [inline]</code></td>
442        </tr>
443      </table>
444    </td>
445  </tr>
446</table>
447<table cellspacing="5" cellpadding="0" border="0">
448  <tr>
449    <td>
450      &nbsp;
451    </td>
452    <td>
453
454<p>
455[INTERNAL] Retrieves the target element suffix for the curve.
456<p>
457This will be -1 if the animated element does not belong to an animated element list. <dl compact><dt><b>Returns:</b></dt><dd>The target element suffix. </dd></dl>
458    </td>
459  </tr>
460</table>
461<a class="anchor" name="c04df763873cdc731262085e98afed3c"></a><!-- doxytag: member="FCDAnimationMultiCurve::MergeCurves" ref="c04df763873cdc731262085e98afed3c" args="(const vector&lt; FCDAnimationCurve * &gt; &amp;toMerge, const FloatList &amp;defaultValues)" --><p>
462<table class="mdTable" cellpadding="2" cellspacing="0">
463  <tr>
464    <td class="mdRow">
465      <table cellpadding="0" cellspacing="0" border="0">
466        <tr>
467          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animation_multi_curve.html">FCDAnimationMultiCurve</a>* FCDAnimationMultiCurve::MergeCurves           </td>
468          <td class="md" valign="top">(&nbsp;</td>
469          <td class="md" nowrap valign="top">const <a class="el" href="classvector.html">vector</a>&lt; <a class="el" href="class_f_c_d_animation_curve.html">FCDAnimationCurve</a> * &gt; &amp;&nbsp;</td>
470          <td class="mdname" nowrap> <em>toMerge</em>, </td>
471        </tr>
472        <tr>
473          <td class="md" nowrap align="right"></td>
474          <td class="md"></td>
475          <td class="md" nowrap>const <a class="el" href="classvector.html">FloatList</a> &amp;&nbsp;</td>
476          <td class="mdname" nowrap> <em>defaultValues</em></td>
477        </tr>
478        <tr>
479          <td class="md"></td>
480          <td class="md">)&nbsp;</td>
481          <td class="md" colspan="2"><code> [static]</code></td>
482        </tr>
483      </table>
484    </td>
485  </tr>
486</table>
487<table cellspacing="5" cellpadding="0" border="0">
488  <tr>
489    <td>
490      &nbsp;
491    </td>
492    <td>
493
494<p>
495Merges multiple single-dimensional animation curves into one multi-dimensional animation curve.
496<p>
497For each NULL element found within the 'toMerge' list, the corresponding default value is used. If there are not enough default values provided, zero is assumed. The number of dimensions for the output animation curve is taken as the size of the 'toMerge' list. <dl compact><dt><b>Parameters:</b></dt><dd>
498  <table border="0" cellspacing="2" cellpadding="0">
499    <tr><td valign="top"></td><td valign="top"><em>toMerge</em>&nbsp;</td><td>The list of single-dimensional animation curves to merge. This list may contain NULL elements, as explained above. </td></tr>
500    <tr><td valign="top"></td><td valign="top"><em>defaultValues</em>&nbsp;</td><td>The list of default values to use when a NULL element is encountered. Default values should be provided even for the elements that are not NULL. </td></tr>
501  </table>
502</dl>
503    </td>
504  </tr>
505</table>
506<a class="anchor" name="e9a30b28b6ab7f201717fd6a3d4db770"></a><!-- doxytag: member="FCDAnimationMultiCurve::SetTargetElement" ref="e9a30b28b6ab7f201717fd6a3d4db770" args="(int32 e)" --><p>
507<table class="mdTable" cellpadding="2" cellspacing="0">
508  <tr>
509    <td class="mdRow">
510      <table cellpadding="0" cellspacing="0" border="0">
511        <tr>
512          <td class="md" nowrap valign="top">void FCDAnimationMultiCurve::SetTargetElement           </td>
513          <td class="md" valign="top">(&nbsp;</td>
514          <td class="md" nowrap valign="top">int32&nbsp;</td>
515          <td class="mdname1" valign="top" nowrap> <em>e</em>          </td>
516          <td class="md" valign="top">&nbsp;)&nbsp;</td>
517          <td class="md" nowrap><code> [inline]</code></td>
518        </tr>
519      </table>
520    </td>
521  </tr>
522</table>
523<table cellspacing="5" cellpadding="0" border="0">
524  <tr>
525    <td>
526      &nbsp;
527    </td>
528    <td>
529
530<p>
531[INTERNAL] Sets the target element suffix for the curve.
532<p>
533<dl compact><dt><b>Parameters:</b></dt><dd>
534  <table border="0" cellspacing="2" cellpadding="0">
535    <tr><td valign="top"></td><td valign="top"><em>e</em>&nbsp;</td><td>The target element suffix. Set to value to -1 if the animated element does not belong to an animated element list. </td></tr>
536  </table>
537</dl>
538    </td>
539  </tr>
540</table>
541<a class="anchor" name="70b326c153d62dbce5afda9df1da81fd"></a><!-- doxytag: member="FCDAnimationMultiCurve::WriteChannelToXML" ref="70b326c153d62dbce5afda9df1da81fd" args="(xmlNode *parentNode, const string &amp;baseId, const string &amp;pointer)" --><p>
542<table class="mdTable" cellpadding="2" cellspacing="0">
543  <tr>
544    <td class="mdRow">
545      <table cellpadding="0" cellspacing="0" border="0">
546        <tr>
547          <td class="md" nowrap valign="top">xmlNode* FCDAnimationMultiCurve::WriteChannelToXML           </td>
548          <td class="md" valign="top">(&nbsp;</td>
549          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
550          <td class="mdname" nowrap> <em>parentNode</em>, </td>
551        </tr>
552        <tr>
553          <td class="md" nowrap align="right"></td>
554          <td class="md"></td>
555          <td class="md" nowrap>const string &amp;&nbsp;</td>
556          <td class="mdname" nowrap> <em>baseId</em>, </td>
557        </tr>
558        <tr>
559          <td class="md" nowrap align="right"></td>
560          <td class="md"></td>
561          <td class="md" nowrap>const string &amp;&nbsp;</td>
562          <td class="mdname" nowrap> <em>pointer</em></td>
563        </tr>
564        <tr>
565          <td class="md"></td>
566          <td class="md">)&nbsp;</td>
567          <td class="md" colspan="2"></td>
568        </tr>
569      </table>
570    </td>
571  </tr>
572</table>
573<table cellspacing="5" cellpadding="0" border="0">
574  <tr>
575    <td>
576      &nbsp;
577    </td>
578    <td>
579
580<p>
581[INTERNAL] Writes out the animation channel that attaches the sampling function to the animatable value.
582<p>
583<dl compact><dt><b>Parameters:</b></dt><dd>
584  <table border="0" cellspacing="2" cellpadding="0">
585    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The XML tree node in which to create the sampler. </td></tr>
586    <tr><td valign="top"></td><td valign="top"><em>baseId</em>&nbsp;</td><td>The COLLADA Id prefix used when generating the source ids and the sampler id. </td></tr>
587    <tr><td valign="top"></td><td valign="top"><em>pointer</em>&nbsp;</td><td>The target pointer prefix for the targeted animated element. </td></tr>
588  </table>
589</dl>
590<dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl>
591    </td>
592  </tr>
593</table>
594<a class="anchor" name="2f09b98996f798c52628e7f3318cc407"></a><!-- doxytag: member="FCDAnimationMultiCurve::WriteSamplerToXML" ref="2f09b98996f798c52628e7f3318cc407" args="(xmlNode *parentNode, const string &amp;baseId)" --><p>
595<table class="mdTable" cellpadding="2" cellspacing="0">
596  <tr>
597    <td class="mdRow">
598      <table cellpadding="0" cellspacing="0" border="0">
599        <tr>
600          <td class="md" nowrap valign="top">xmlNode* FCDAnimationMultiCurve::WriteSamplerToXML           </td>
601          <td class="md" valign="top">(&nbsp;</td>
602          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
603          <td class="mdname" nowrap> <em>parentNode</em>, </td>
604        </tr>
605        <tr>
606          <td class="md" nowrap align="right"></td>
607          <td class="md"></td>
608          <td class="md" nowrap>const string &amp;&nbsp;</td>
609          <td class="mdname" nowrap> <em>baseId</em></td>
610        </tr>
611        <tr>
612          <td class="md"></td>
613          <td class="md">)&nbsp;</td>
614          <td class="md" colspan="2"></td>
615        </tr>
616      </table>
617    </td>
618  </tr>
619</table>
620<table cellspacing="5" cellpadding="0" border="0">
621  <tr>
622    <td>
623      &nbsp;
624    </td>
625    <td>
626
627<p>
628[INTERNAL] Writes out the sampler that puts together the data sources and generates a sampling function.
629<p>
630<dl compact><dt><b>Parameters:</b></dt><dd>
631  <table border="0" cellspacing="2" cellpadding="0">
632    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The XML tree node in which to create the sampler. </td></tr>
633    <tr><td valign="top"></td><td valign="top"><em>baseId</em>&nbsp;</td><td>The COLLADA id prefix used when generating the source ids. This prefix is also used to generate the sampler COLLADA id. </td></tr>
634  </table>
635</dl>
636<dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl>
637    </td>
638  </tr>
639</table>
640<a class="anchor" name="1eca0d4557e711ca9e112948baffd0e6"></a><!-- doxytag: member="FCDAnimationMultiCurve::WriteSourceToXML" ref="1eca0d4557e711ca9e112948baffd0e6" args="(xmlNode *parentNode, const string &amp;baseId)" --><p>
641<table class="mdTable" cellpadding="2" cellspacing="0">
642  <tr>
643    <td class="mdRow">
644      <table cellpadding="0" cellspacing="0" border="0">
645        <tr>
646          <td class="md" nowrap valign="top">void FCDAnimationMultiCurve::WriteSourceToXML           </td>
647          <td class="md" valign="top">(&nbsp;</td>
648          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
649          <td class="mdname" nowrap> <em>parentNode</em>, </td>
650        </tr>
651        <tr>
652          <td class="md" nowrap align="right"></td>
653          <td class="md"></td>
654          <td class="md" nowrap>const string &amp;&nbsp;</td>
655          <td class="mdname" nowrap> <em>baseId</em></td>
656        </tr>
657        <tr>
658          <td class="md"></td>
659          <td class="md">)&nbsp;</td>
660          <td class="md" colspan="2"></td>
661        </tr>
662      </table>
663    </td>
664  </tr>
665</table>
666<table cellspacing="5" cellpadding="0" border="0">
667  <tr>
668    <td>
669      &nbsp;
670    </td>
671    <td>
672
673<p>
674[INTERNAL] Writes out the data sources necessary to import the animation curve to a given XML tree node.
675<p>
676<dl compact><dt><b>Parameters:</b></dt><dd>
677  <table border="0" cellspacing="2" cellpadding="0">
678    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The XML tree node in which to create the data sources. </td></tr>
679    <tr><td valign="top"></td><td valign="top"><em>baseId</em>&nbsp;</td><td>A COLLADA Id prefix to use when generating the source ids. </td></tr>
680  </table>
681</dl>
682    </td>
683  </tr>
684</table>
685<hr>The documentation for this class was generated from the following file:<ul>
686<li>FCDocument/<a class="el" href="_f_c_d_animation_multi_curve_8h-source.html">FCDAnimationMultiCurve.h</a></ul>
687<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
688<a href="http://www.doxygen.org/index.html">
689<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
690</body>
691</html>
Note: See TracBrowser for help on using the repository browser.