PageRenderTime 62ms CodeModel.GetById 36ms RepoModel.GetById 0ms app.codeStats 0ms

/Core/Dependencies/OgreCollada/FCollada/FCollada/Documentation/html/class_f_c_d_animation_m_key.html

https://bitbucket.org/barakianc/nvidia-physx-and-apex-in-gge
HTML | 190 lines | 179 code | 10 blank | 1 comment | 0 complexity | c16d75f8c7a38ca095532ee585ad2774 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    3. 

  3. <title>FCollada: FCDAnimationMKey Class Reference</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.4.6-NO -->
    8. 

  8. <div class="tabs">
    9. 

  9.   <ul>
    10. 

  10.     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    11. 

  11.     <li><a href="modules.html"><span>Modules</span></a></li>
    12. 

  12.     <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    13. 

  13.     <li id="current"><a href="classes.html"><span>Classes</span></a></li>
    14. 

  14.     <li><a href="files.html"><span>Files</span></a></li>
    15. 

  15.     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    16. 

  16.   </ul></div>
    17. 

  17. <div class="tabs">
    18. 

  18.   <ul>
    19. 

  19.     <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    20. 

  20.     <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    21. 

  21.     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    22. 

  22.     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    23. 

  23.   </ul></div>
    24. 

  24. <h1>FCDAnimationMKey Class Reference</h1><!-- doxytag: class="FCDAnimationMKey" -->A simple multi-dimensional animation key.  
    25. 

  25. <a href="#_details">More...</a>
    26. 

  26. <p>
    27. 

  27. <code>#include &lt;<a class="el" href="_f_c_d_animation_key_8h-source.html">FCDAnimationKey.h</a>&gt;</code>
    28. 

  28. <p>
    29. 

  29. <p>Inheritance diagram for FCDAnimationMKey:
    30. 

  30. <p><center><img src="class_f_c_d_animation_m_key.png" usemap="#FCDAnimationMKey_map" border="0" alt=""></center>
    31. 

  31. <map name="FCDAnimationMKey_map">
    32. 

  32. <area href="class_f_c_d_animation_m_key_bezier.html" alt="FCDAnimationMKeyBezier" shape="rect" coords="0,56,162,80">
    33. 

  33. <area href="class_f_c_d_animation_m_key_t_c_b.html" alt="FCDAnimationMKeyTCB" shape="rect" coords="172,56,334,80">
    34. 

  34. </map>
    35. 

  35. <a href="class_f_c_d_animation_m_key-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
    36. 

  36. <tr><td></td></tr>
    37. 

  37. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
    38. 

  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_animation_m_key.html#47f7144948d1042b187492722c2db4ae">FCDAnimationMKey</a> (uint32 dimension)</td></tr>
    39. 

  39. 

  40. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#47f7144948d1042b187492722c2db4ae"></a><br></td></tr>
    41. 

  41. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36fc14826e6f213ddbe35d88cedb918e"></a><!-- doxytag: member="FCDAnimationMKey::~FCDAnimationMKey" ref="36fc14826e6f213ddbe35d88cedb918e" args="()" -->
    42. 

  42. virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_m_key.html#36fc14826e6f213ddbe35d88cedb918e">~FCDAnimationMKey</a> ()</td></tr>
    43. 

  43. 

  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
    45. 

  45. <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_m_key.html#b1effabe7abcc46821442b88f7c459ba">GetDimension</a> () const </td></tr>
    46. 

  46. 

  47. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of dimensions for this key.  <a href="#b1effabe7abcc46821442b88f7c459ba"></a><br></td></tr>
    48. 

  48. <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
    49. 

  49. <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_m_key.html#23e2a29dcce4b317979da21ec48f8e68">input</a></td></tr>
    50. 

  50. 

  51. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The key input.  <a href="#23e2a29dcce4b317979da21ec48f8e68"></a><br></td></tr>
    52. 

  52. <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_m_key.html#fde626bbddacb9897d80a6158f1a8e2a">interpolation</a></td></tr>
    53. 

  53. 

  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The key interpolation type.  <a href="#fde626bbddacb9897d80a6158f1a8e2a"></a><br></td></tr>
    55. 

  55. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44bfaf4f29f3946f9a3ffe0db81828cb"></a><!-- doxytag: member="FCDAnimationMKey::output" ref="44bfaf4f29f3946f9a3ffe0db81828cb" args="" -->
    56. 

  56. float *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_animation_m_key.html#44bfaf4f29f3946f9a3ffe0db81828cb">output</a></td></tr>
    57. 

  57. 

  58. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The multi-dimensional key output. <br></td></tr>
    59. 

  59. </table>
    60. 

  60. <hr><a name="_details"></a><h2>Detailed Description</h2>
    61. 

  61. A simple multi-dimensional animation key. 
    62. 

  62. <p>
    63. 

  63. This class is the base for the more complex multi-dimensional keys and it is used directly for linear and step multi-dimensional keys. 
    64. 

  64. <p>
    65. 

  65. <hr><h2>Constructor &amp; Destructor Documentation</h2>
    66. 

  66. <a class="anchor" name="47f7144948d1042b187492722c2db4ae"></a><!-- doxytag: member="FCDAnimationMKey::FCDAnimationMKey" ref="47f7144948d1042b187492722c2db4ae" args="(uint32 dimension)" --><p>
    67. 

  67. <table class="mdTable" cellpadding="2" cellspacing="0">
    68. 

  68.   <tr>
    69. 

  69.     <td class="mdRow">
    70. 

  70.       <table cellpadding="0" cellspacing="0" border="0">
    71. 

  71.         <tr>
    72. 

  72.           <td class="md" nowrap valign="top">FCDAnimationMKey::FCDAnimationMKey           </td>
    73. 

  73.           <td class="md" valign="top">(&nbsp;</td>
    74. 

  74.           <td class="md" nowrap valign="top">uint32&nbsp;</td>
    75. 

  75.           <td class="mdname1" valign="top" nowrap> <em>dimension</em>          </td>
    76. 

  76.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    77. 

  77.           <td class="md" nowrap></td>
    78. 

  78.         </tr>
    79. 

  79.       </table>
    80. 

  80.     </td>
    81. 

  81.   </tr>
    82. 

  82. </table>
    83. 

  83. <table cellspacing="5" cellpadding="0" border="0">
    84. 

  84.   <tr>
    85. 

  85.     <td>
    86. 

  86.       &nbsp;
    87. 

  87.     </td>
    88. 

  88.     <td>
    89. 

  89. 

  90. <p>
    91. 

  91. Constructor. 
    92. 

  92. <p>
    93. 

  93. Do not use directly. Instead call FCDAnimationMultiCurve::AddKey(FUDaeInterpolation::LINEAR) or FCDAnimationMultiCurve::AddKey(FUDaeInterpolation::STEP). <dl compact><dt><b>Parameters:</b></dt><dd>
    94. 

  94.   <table border="0" cellspacing="2" cellpadding="0">
    95. 

  95.     <tr><td valign="top"></td><td valign="top"><em>dimension</em>&nbsp;</td><td>The number of dimension to the key output. </td></tr>
    96. 

  96.   </table>
    97. 

  97. </dl>
    98. 

  98.     </td>
    99. 

  99.   </tr>
    100. 

  100. </table>
    101. 

  101. <hr><h2>Member Function Documentation</h2>
    102. 

  102. <a class="anchor" name="b1effabe7abcc46821442b88f7c459ba"></a><!-- doxytag: member="FCDAnimationMKey::GetDimension" ref="b1effabe7abcc46821442b88f7c459ba" args="() const " --><p>
    103. 

  103. <table class="mdTable" cellpadding="2" cellspacing="0">
    104. 

  104.   <tr>
    105. 

  105.     <td class="mdRow">
    106. 

  106.       <table cellpadding="0" cellspacing="0" border="0">
    107. 

  107.         <tr>
    108. 

  108.           <td class="md" nowrap valign="top">uint32 FCDAnimationMKey::GetDimension           </td>
    109. 

  109.           <td class="md" valign="top">(&nbsp;</td>
    110. 

  110.           <td class="mdname1" valign="top" nowrap>          </td>
    111. 

  111.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    112. 

  112.           <td class="md" nowrap> const<code> [inline]</code></td>
    113. 

  113.         </tr>
    114. 

  114.       </table>
    115. 

  115.     </td>
    116. 

  116.   </tr>
    117. 

  117. </table>
    118. 

  118. <table cellspacing="5" cellpadding="0" border="0">
    119. 

  119.   <tr>
    120. 

  120.     <td>
    121. 

  121.       &nbsp;
    122. 

  122.     </td>
    123. 

  123.     <td>
    124. 

  124. 

  125. <p>
    126. 

  126. Retrieves the number of dimensions for this key. 
    127. 

  127. <p>
    128. 

  128. <dl compact><dt><b>Returns:</b></dt><dd>The number of dimensions. </dd></dl>
    129. 

  129.     </td>
    130. 

  130.   </tr>
    131. 

  131. </table>
    132. 

  132. <hr><h2>Member Data Documentation</h2>
    133. 

  133. <a class="anchor" name="23e2a29dcce4b317979da21ec48f8e68"></a><!-- doxytag: member="FCDAnimationMKey::input" ref="23e2a29dcce4b317979da21ec48f8e68" args="" --><p>
    134. 

  134. <table class="mdTable" cellpadding="2" cellspacing="0">
    135. 

  135.   <tr>
    136. 

  136.     <td class="mdRow">
    137. 

  137.       <table cellpadding="0" cellspacing="0" border="0">
    138. 

  138.         <tr>
    139. 

  139.           <td class="md" nowrap valign="top">float <a class="el" href="class_f_c_d_animation_m_key.html#23e2a29dcce4b317979da21ec48f8e68">FCDAnimationMKey::input</a>          </td>
    140. 

  140.         </tr>
    141. 

  141.       </table>
    142. 

  142.     </td>
    143. 

  143.   </tr>
    144. 

  144. </table>
    145. 

  145. <table cellspacing="5" cellpadding="0" border="0">
    146. 

  146.   <tr>
    147. 

  147.     <td>
    148. 

  148.       &nbsp;
    149. 

  149.     </td>
    150. 

  150.     <td>
    151. 

  151. 

  152. <p>
    153. 

  153. The key input. 
    154. 

  154. <p>
    155. 

  155. Typically, this will be a time value, in seconds. For driven curves, the dimension of this value will depend on the driver.     </td>
    156. 

  156.   </tr>
    157. 

  157. </table>
    158. 

  158. <a class="anchor" name="fde626bbddacb9897d80a6158f1a8e2a"></a><!-- doxytag: member="FCDAnimationMKey::interpolation" ref="fde626bbddacb9897d80a6158f1a8e2a" args="" --><p>
    159. 

  159. <table class="mdTable" cellpadding="2" cellspacing="0">
    160. 

  160.   <tr>
    161. 

  161.     <td class="mdRow">
    162. 

  162.       <table cellpadding="0" cellspacing="0" border="0">
    163. 

  163.         <tr>
    164. 

  164.           <td class="md" nowrap valign="top">uint32 <a class="el" href="class_f_c_d_animation_m_key.html#fde626bbddacb9897d80a6158f1a8e2a">FCDAnimationMKey::interpolation</a>          </td>
    165. 

  165.         </tr>
    166. 

  166.       </table>
    167. 

  167.     </td>
    168. 

  168.   </tr>
    169. 

  169. </table>
    170. 

  170. <table cellspacing="5" cellpadding="0" border="0">
    171. 

  171.   <tr>
    172. 

  172.     <td>
    173. 

  173.       &nbsp;
    174. 

  174.     </td>
    175. 

  175.     <td>
    176. 

  176. 

  177. <p>
    178. 

  178. The key interpolation type. 
    179. 

  179. <p>
    180. 

  180. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="namespace_f_u_dae_interpolation.html#209a941c2fb6ece1325352968aa0374f">FUDaeInterpolation::Interpolation</a> </dd></dl>
    181. 

  181.     </td>
    182. 

  182.   </tr>
    183. 

  183. </table>
    184. 

  184. <hr>The documentation for this class was generated from the following file:<ul>
    185. 

  185. <li>FCDocument/<a class="el" href="_f_c_d_animation_key_8h-source.html">FCDAnimationKey.h</a></ul>
    186. 

  186. <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 17 13:25:02 2007 for FCollada by&nbsp;
    187. 

  187. <a href="http://www.doxygen.org/index.html">
    188. 

  188. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
    189. 

  189. </body>
    190. 

  190. </html>
    191. 

  191.