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

Revision 964, 8.7 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: FCDAnimatedCustom 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>FCDAnimatedCustom 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="FCDAnimatedCustom" --><!-- doxytag: inherits="FCDAnimated" -->A COLLADA custom animated value. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_animated_8h-source.html">FCDAnimated.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDAnimatedCustom:
33<p><center><img src="class_f_c_d_animated_custom.png" usemap="#FCDAnimatedCustom_map" border="0" alt=""></center>
34<map name="FCDAnimatedCustom_map">
35<area href="class_f_c_d_animated.html" alt="FCDAnimated" shape="rect" coords="0,112,131,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,131,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,131,24">
38</map>
39<a href="class_f_c_d_animated_custom-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animated_custom.html#e2e70908717bea35adcb50162066ee97">GetDummy</a> () const </td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the floating-point value used for all the value pointers.  <a href="#e2e70908717bea35adcb50162066ee97"></a><br></td></tr>
45<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_animated_custom.html">FCDAnimatedCustom</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animated_custom.html#833cbdc08b27c620f0f9eff09e1120fd">Create</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new animated element.  <a href="#833cbdc08b27c620f0f9eff09e1120fd"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_animated_custom.html">FCDAnimatedCustom</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animated_custom.html#12eaefe31775efe3d31bbe539564aea0">Create</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, xmlNode *node)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Creates a new animated element.  <a href="#12eaefe31775efe3d31bbe539564aea0"></a><br></td></tr>
52</table>
53<hr><a name="_details"></a><h2>Detailed Description</h2>
54A COLLADA custom animated value.
55<p>
56Used for animated extra elements. A single value is used multiple times to hold as many value pointers are necessary to hold the animation curves.
57<p>
58<hr><h2>Member Function Documentation</h2>
59<a class="anchor" name="12eaefe31775efe3d31bbe539564aea0"></a><!-- doxytag: member="FCDAnimatedCustom::Create" ref="12eaefe31775efe3d31bbe539564aea0" args="(FCDocument *document, xmlNode *node)" --><p>
60<table class="mdTable" cellpadding="2" cellspacing="0">
61  <tr>
62    <td class="mdRow">
63      <table cellpadding="0" cellspacing="0" border="0">
64        <tr>
65          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animated_custom.html">FCDAnimatedCustom</a>* FCDAnimatedCustom::Create           </td>
66          <td class="md" valign="top">(&nbsp;</td>
67          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
68          <td class="mdname" nowrap> <em>document</em>, </td>
69        </tr>
70        <tr>
71          <td class="md" nowrap align="right"></td>
72          <td class="md"></td>
73          <td class="md" nowrap>xmlNode *&nbsp;</td>
74          <td class="mdname" nowrap> <em>node</em></td>
75        </tr>
76        <tr>
77          <td class="md"></td>
78          <td class="md">)&nbsp;</td>
79          <td class="md" colspan="2"><code> [static]</code></td>
80        </tr>
81      </table>
82    </td>
83  </tr>
84</table>
85<table cellspacing="5" cellpadding="0" border="0">
86  <tr>
87    <td>
88      &nbsp;
89    </td>
90    <td>
91
92<p>
93[INTERNAL] Creates a new animated element.
94<p>
95This function is used during the import of a COLLADA document. <dl compact><dt><b>Parameters:</b></dt><dd>
96  <table border="0" cellspacing="2" cellpadding="0">
97    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animated element. </td></tr>
98    <tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The XML tree node that contains the animated values. </td></tr>
99  </table>
100</dl>
101<dl compact><dt><b>Returns:</b></dt><dd>The new animated element. </dd></dl>
102    </td>
103  </tr>
104</table>
105<a class="anchor" name="833cbdc08b27c620f0f9eff09e1120fd"></a><!-- doxytag: member="FCDAnimatedCustom::Create" ref="833cbdc08b27c620f0f9eff09e1120fd" args="(FCDocument *document)" --><p>
106<table class="mdTable" cellpadding="2" cellspacing="0">
107  <tr>
108    <td class="mdRow">
109      <table cellpadding="0" cellspacing="0" border="0">
110        <tr>
111          <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_animated_custom.html">FCDAnimatedCustom</a>* FCDAnimatedCustom::Create           </td>
112          <td class="md" valign="top">(&nbsp;</td>
113          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
114          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
115          <td class="md" valign="top">&nbsp;)&nbsp;</td>
116          <td class="md" nowrap><code> [static]</code></td>
117        </tr>
118      </table>
119    </td>
120  </tr>
121</table>
122<table cellspacing="5" cellpadding="0" border="0">
123  <tr>
124    <td>
125      &nbsp;
126    </td>
127    <td>
128
129<p>
130Creates a new animated element.
131<p>
132<dl compact><dt><b>Parameters:</b></dt><dd>
133  <table border="0" cellspacing="2" cellpadding="0">
134    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the animated element. </td></tr>
135  </table>
136</dl>
137<dl compact><dt><b>Returns:</b></dt><dd>The new animated element. </dd></dl>
138    </td>
139  </tr>
140</table>
141<a class="anchor" name="e2e70908717bea35adcb50162066ee97"></a><!-- doxytag: member="FCDAnimatedCustom::GetDummy" ref="e2e70908717bea35adcb50162066ee97" args="() const " --><p>
142<table class="mdTable" cellpadding="2" cellspacing="0">
143  <tr>
144    <td class="mdRow">
145      <table cellpadding="0" cellspacing="0" border="0">
146        <tr>
147          <td class="md" nowrap valign="top">const float&amp; FCDAnimatedCustom::GetDummy           </td>
148          <td class="md" valign="top">(&nbsp;</td>
149          <td class="mdname1" valign="top" nowrap>          </td>
150          <td class="md" valign="top">&nbsp;)&nbsp;</td>
151          <td class="md" nowrap> const<code> [inline]</code></td>
152        </tr>
153      </table>
154    </td>
155  </tr>
156</table>
157<table cellspacing="5" cellpadding="0" border="0">
158  <tr>
159    <td>
160      &nbsp;
161    </td>
162    <td>
163
164<p>
165Retrieves the floating-point value used for all the value pointers.
166<p>
167<dl compact><dt><b>Returns:</b></dt><dd>The dummy floating-point value. </dd></dl>
168    </td>
169  </tr>
170</table>
171<hr>The documentation for this class was generated from the following file:<ul>
172<li>FCDocument/<a class="el" href="_f_c_d_animated_8h-source.html">FCDAnimated.h</a></ul>
173<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:40 2006 for FCollada by&nbsp;
174<a href="http://www.doxygen.org/index.html">
175<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
176</body>
177</html>
Note: See TracBrowser for help on using the repository browser.