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

Revision 964, 18.6 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: FCDMorphTarget 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>FCDMorphTarget Class Reference</h1><!-- doxytag: class="FCDMorphTarget" --><!-- doxytag: inherits="FCDObject" -->A COLLADA morph target. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_morph_controller_8h-source.html">FCDMorphController.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDMorphTarget:
30<p><center><img src="class_f_c_d_morph_target.png" usemap="#FCDMorphTarget_map" border="0" alt=""></center>
31<map name="FCDMorphTarget_map">
32<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,111,80">
33<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,111,24">
34</map>
35<a href="class_f_c_d_morph_target-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
36<tr><td></td></tr>
37<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#3704c6c2176ffabe20c3b10ef3c36e90">FCDMorphTarget</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a> *parent)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#3704c6c2176ffabe20c3b10ef3c36e90"></a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c337ad4927402898f74bbf1d8d2d0bd7"></a><!-- doxytag: member="FCDMorphTarget::~FCDMorphTarget" ref="c337ad4927402898f74bbf1d8d2d0bd7" args="()" -->
42virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#c337ad4927402898f74bbf1d8d2d0bd7">~FCDMorphTarget</a> ()</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#1cfed74a428ce68c944e487c335753f8">GetParent</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the morph controller which contains this target.  <a href="#1cfed74a428ce68c944e487c335753f8"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1e29057218a17fa7ab31b76fde8715cf"></a><!-- doxytag: member="FCDMorphTarget::GetParent" ref="1e29057218a17fa7ab31b76fde8715cf" args="() const " -->
49const <a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#1e29057218a17fa7ab31b76fde8715cf">GetParent</a> () const </td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#e96770062ed44c9fdb01681750b490c5">GetGeometry</a> ()</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the target geometry.  <a href="#e96770062ed44c9fdb01681750b490c5"></a><br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d21ba74ba248acddeef276d5e9298e24"></a><!-- doxytag: member="FCDMorphTarget::GetGeometry" ref="d21ba74ba248acddeef276d5e9298e24" args="() const " -->
56const <a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#d21ba74ba248acddeef276d5e9298e24">GetGeometry</a> () const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
59<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_morph_target.html#998bd66544b91f0f41bbc2739acf65c2">SetGeometry</a> (<a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *geometry)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the target geometry.  <a href="#998bd66544b91f0f41bbc2739acf65c2"></a><br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top">float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#c315b0eb37d95da814d951ae5c7c1684">GetWeight</a> ()</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the morphing weight.  <a href="#c315b0eb37d95da814d951ae5c7c1684"></a><br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33a4752bb891530ef5e718f29693381c"></a><!-- doxytag: member="FCDMorphTarget::GetWeight" ref="33a4752bb891530ef5e718f29693381c" args="() const " -->
66const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#33a4752bb891530ef5e718f29693381c">GetWeight</a> () const </td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
69<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_morph_target.html#1019a25890e87253afde129c4ad3e002">SetWeight</a> (float _weight)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the morphing weight.  <a href="#1019a25890e87253afde129c4ad3e002"></a><br></td></tr>
72<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_morph_target.html#4a9f0f8805841af97ac1cbaabb0f3bd4">IsAnimated</a> () const </td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether the morphing weight is animated.  <a href="#4a9f0f8805841af97ac1cbaabb0f3bd4"></a><br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#48808f59055edb49f84d3b3682f3e773">GetAnimatedWeight</a> ()</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the animation associated with the morphing weight.  <a href="#48808f59055edb49f84d3b3682f3e773"></a><br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0d7c9711dc27ec4b505f1b7d5eda08c"></a><!-- doxytag: member="FCDMorphTarget::GetAnimatedWeight" ref="b0d7c9711dc27ec4b505f1b7d5eda08c" args="() const " -->
79const <a class="el" href="class_f_c_d_animated.html">FCDAnimated</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_morph_target.html#b0d7c9711dc27ec4b505f1b7d5eda08c">GetAnimatedWeight</a> () const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
82</table>
83<hr><a name="_details"></a><h2>Detailed Description</h2>
84A COLLADA morph target.
85<p>
86A morph target is just a geometric entity with a weight assigned. The weight may be animated.
87<p>
88<hr><h2>Constructor &amp; Destructor Documentation</h2>
89<a class="anchor" name="3704c6c2176ffabe20c3b10ef3c36e90"></a><!-- doxytag: member="FCDMorphTarget::FCDMorphTarget" ref="3704c6c2176ffabe20c3b10ef3c36e90" args="(FCDocument *document, FCDMorphController *parent)" --><p>
90<table class="mdTable" cellpadding="2" cellspacing="0">
91  <tr>
92    <td class="mdRow">
93      <table cellpadding="0" cellspacing="0" border="0">
94        <tr>
95          <td class="md" nowrap valign="top">FCDMorphTarget::FCDMorphTarget           </td>
96          <td class="md" valign="top">(&nbsp;</td>
97          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
98          <td class="mdname" nowrap> <em>document</em>, </td>
99        </tr>
100        <tr>
101          <td class="md" nowrap align="right"></td>
102          <td class="md"></td>
103          <td class="md" nowrap><a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a> *&nbsp;</td>
104          <td class="mdname" nowrap> <em>parent</em></td>
105        </tr>
106        <tr>
107          <td class="md"></td>
108          <td class="md">)&nbsp;</td>
109          <td class="md" colspan="2"></td>
110        </tr>
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing="5" cellpadding="0" border="0">
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Constructor: do not use directly.
124<p>
125Instead, use the <a class="el" href="class_f_c_d_morph_controller.html#b1babb0f099e835967219c1a477e46e9">FCDMorphController::AddTarget</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
126  <table border="0" cellspacing="2" cellpadding="0">
127    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the morph target. </td></tr>
128    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The morph controller that contains the morph target. </td></tr>
129  </table>
130</dl>
131    </td>
132  </tr>
133</table>
134<hr><h2>Member Function Documentation</h2>
135<a class="anchor" name="48808f59055edb49f84d3b3682f3e773"></a><!-- doxytag: member="FCDMorphTarget::GetAnimatedWeight" ref="48808f59055edb49f84d3b3682f3e773" args="()" --><p>
136<table class="mdTable" cellpadding="2" cellspacing="0">
137  <tr>
138    <td class="mdRow">
139      <table cellpadding="0" cellspacing="0" border="0">
140        <tr>
141          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_animated.html">FCDAnimated</a>* FCDMorphTarget::GetAnimatedWeight           </td>
142          <td class="md" valign="top">(&nbsp;</td>
143          <td class="mdname1" valign="top" nowrap>          </td>
144          <td class="md" valign="top">&nbsp;)&nbsp;</td>
145          <td class="md" nowrap></td>
146        </tr>
147      </table>
148    </td>
149  </tr>
150</table>
151<table cellspacing="5" cellpadding="0" border="0">
152  <tr>
153    <td>
154      &nbsp;
155    </td>
156    <td>
157
158<p>
159Retrieves the animation associated with the morphing weight.
160<p>
161<dl compact><dt><b>Returns:</b></dt><dd>The animated value associated with the morphing weight. This pointer will be NULL if the morphing weight is not animated. </dd></dl>
162    </td>
163  </tr>
164</table>
165<a class="anchor" name="e96770062ed44c9fdb01681750b490c5"></a><!-- doxytag: member="FCDMorphTarget::GetGeometry" ref="e96770062ed44c9fdb01681750b490c5" args="()" --><p>
166<table class="mdTable" cellpadding="2" cellspacing="0">
167  <tr>
168    <td class="mdRow">
169      <table cellpadding="0" cellspacing="0" border="0">
170        <tr>
171          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a>* FCDMorphTarget::GetGeometry           </td>
172          <td class="md" valign="top">(&nbsp;</td>
173          <td class="mdname1" valign="top" nowrap>          </td>
174          <td class="md" valign="top">&nbsp;)&nbsp;</td>
175          <td class="md" nowrap><code> [inline]</code></td>
176        </tr>
177      </table>
178    </td>
179  </tr>
180</table>
181<table cellspacing="5" cellpadding="0" border="0">
182  <tr>
183    <td>
184      &nbsp;
185    </td>
186    <td>
187
188<p>
189Retrieves the target geometry.
190<p>
191This is what the morphed geometry should look like if the morphing weight is set to 1.0f. <dl compact><dt><b>Returns:</b></dt><dd>The target geometry. </dd></dl>
192    </td>
193  </tr>
194</table>
195<a class="anchor" name="1cfed74a428ce68c944e487c335753f8"></a><!-- doxytag: member="FCDMorphTarget::GetParent" ref="1cfed74a428ce68c944e487c335753f8" args="()" --><p>
196<table class="mdTable" cellpadding="2" cellspacing="0">
197  <tr>
198    <td class="mdRow">
199      <table cellpadding="0" cellspacing="0" border="0">
200        <tr>
201          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a>* FCDMorphTarget::GetParent           </td>
202          <td class="md" valign="top">(&nbsp;</td>
203          <td class="mdname1" valign="top" nowrap>          </td>
204          <td class="md" valign="top">&nbsp;)&nbsp;</td>
205          <td class="md" nowrap><code> [inline]</code></td>
206        </tr>
207      </table>
208    </td>
209  </tr>
210</table>
211<table cellspacing="5" cellpadding="0" border="0">
212  <tr>
213    <td>
214      &nbsp;
215    </td>
216    <td>
217
218<p>
219Retrieves the morph controller which contains this target.
220<p>
221<dl compact><dt><b>Returns:</b></dt><dd>The parent morpher. </dd></dl>
222    </td>
223  </tr>
224</table>
225<a class="anchor" name="c315b0eb37d95da814d951ae5c7c1684"></a><!-- doxytag: member="FCDMorphTarget::GetWeight" ref="c315b0eb37d95da814d951ae5c7c1684" args="()" --><p>
226<table class="mdTable" cellpadding="2" cellspacing="0">
227  <tr>
228    <td class="mdRow">
229      <table cellpadding="0" cellspacing="0" border="0">
230        <tr>
231          <td class="md" nowrap valign="top">float&amp; FCDMorphTarget::GetWeight           </td>
232          <td class="md" valign="top">(&nbsp;</td>
233          <td class="mdname1" valign="top" nowrap>          </td>
234          <td class="md" valign="top">&nbsp;)&nbsp;</td>
235          <td class="md" nowrap><code> [inline]</code></td>
236        </tr>
237      </table>
238    </td>
239  </tr>
240</table>
241<table cellspacing="5" cellpadding="0" border="0">
242  <tr>
243    <td>
244      &nbsp;
245    </td>
246    <td>
247
248<p>
249Retrieves the morphing weight.
250<p>
251<dl compact><dt><b>Returns:</b></dt><dd>The morphing weight. </dd></dl>
252    </td>
253  </tr>
254</table>
255<a class="anchor" name="4a9f0f8805841af97ac1cbaabb0f3bd4"></a><!-- doxytag: member="FCDMorphTarget::IsAnimated" ref="4a9f0f8805841af97ac1cbaabb0f3bd4" args="() const " --><p>
256<table class="mdTable" cellpadding="2" cellspacing="0">
257  <tr>
258    <td class="mdRow">
259      <table cellpadding="0" cellspacing="0" border="0">
260        <tr>
261          <td class="md" nowrap valign="top">bool FCDMorphTarget::IsAnimated           </td>
262          <td class="md" valign="top">(&nbsp;</td>
263          <td class="mdname1" valign="top" nowrap>          </td>
264          <td class="md" valign="top">&nbsp;)&nbsp;</td>
265          <td class="md" nowrap> const</td>
266        </tr>
267      </table>
268    </td>
269  </tr>
270</table>
271<table cellspacing="5" cellpadding="0" border="0">
272  <tr>
273    <td>
274      &nbsp;
275    </td>
276    <td>
277
278<p>
279Retrieves whether the morphing weight is animated.
280<p>
281<dl compact><dt><b>Returns:</b></dt><dd>Whether the morphing weight is animated. </dd></dl>
282    </td>
283  </tr>
284</table>
285<a class="anchor" name="998bd66544b91f0f41bbc2739acf65c2"></a><!-- doxytag: member="FCDMorphTarget::SetGeometry" ref="998bd66544b91f0f41bbc2739acf65c2" args="(FCDGeometry *geometry)" --><p>
286<table class="mdTable" cellpadding="2" cellspacing="0">
287  <tr>
288    <td class="mdRow">
289      <table cellpadding="0" cellspacing="0" border="0">
290        <tr>
291          <td class="md" nowrap valign="top">void FCDMorphTarget::SetGeometry           </td>
292          <td class="md" valign="top">(&nbsp;</td>
293          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *&nbsp;</td>
294          <td class="mdname1" valign="top" nowrap> <em>geometry</em>          </td>
295          <td class="md" valign="top">&nbsp;)&nbsp;</td>
296          <td class="md" nowrap></td>
297        </tr>
298      </table>
299    </td>
300  </tr>
301</table>
302<table cellspacing="5" cellpadding="0" border="0">
303  <tr>
304    <td>
305      &nbsp;
306    </td>
307    <td>
308
309<p>
310Sets the target geometry.
311<p>
312This is what the morphed geometry should look like if the morphing weight is set to 1.0f. As such, the target geometry should be similar to the base target geometry. You can verify this using the <a class="el" href="class_f_c_d_morph_controller.html#43685ec9f55c43b66e75f62c8b820980">FCDMorphController::IsSimilar</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
313  <table border="0" cellspacing="2" cellpadding="0">
314    <tr><td valign="top"></td><td valign="top"><em>geometry</em>&nbsp;</td><td>The target geometry. </td></tr>
315  </table>
316</dl>
317    </td>
318  </tr>
319</table>
320<a class="anchor" name="1019a25890e87253afde129c4ad3e002"></a><!-- doxytag: member="FCDMorphTarget::SetWeight" ref="1019a25890e87253afde129c4ad3e002" args="(float _weight)" --><p>
321<table class="mdTable" cellpadding="2" cellspacing="0">
322  <tr>
323    <td class="mdRow">
324      <table cellpadding="0" cellspacing="0" border="0">
325        <tr>
326          <td class="md" nowrap valign="top">void FCDMorphTarget::SetWeight           </td>
327          <td class="md" valign="top">(&nbsp;</td>
328          <td class="md" nowrap valign="top">float&nbsp;</td>
329          <td class="mdname1" valign="top" nowrap> <em>_weight</em>          </td>
330          <td class="md" valign="top">&nbsp;)&nbsp;</td>
331          <td class="md" nowrap><code> [inline]</code></td>
332        </tr>
333      </table>
334    </td>
335  </tr>
336</table>
337<table cellspacing="5" cellpadding="0" border="0">
338  <tr>
339    <td>
340      &nbsp;
341    </td>
342    <td>
343
344<p>
345Sets the morphing weight.
346<p>
347This function has no impact on any animations that target the morphing weight. <dl compact><dt><b>Parameters:</b></dt><dd>
348  <table border="0" cellspacing="2" cellpadding="0">
349    <tr><td valign="top"></td><td valign="top"><em>_weight</em>&nbsp;</td><td>The morphing weight. </td></tr>
350  </table>
351</dl>
352    </td>
353  </tr>
354</table>
355<hr>The documentation for this class was generated from the following file:<ul>
356<li>FCDocument/<a class="el" href="_f_c_d_morph_controller_8h-source.html">FCDMorphController.h</a></ul>
357<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by&nbsp;
358<a href="http://www.doxygen.org/index.html">
359<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
360</body>
361</html>
Note: See TracBrowser for help on using the repository browser.