class_skeletal_animation.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: SkeletalAnimation Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_skeletal_animation.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#nested-classes">Classes</a> &#124;
  108. <a href="#pub-types">Public Types</a> &#124;
  109. <a href="#pub-methods">Public Member Functions</a> &#124;
  110. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  111. <a href="class_skeletal_animation-members.html">List of all members</a> </div>
  112. <div class="headertitle"><div class="title">SkeletalAnimation Class Reference</div></div>
  113. </div><!--header-->
  114. <div class="contents">
  115. <p>Resource for a skinned animation.
  116. <a href="#details">More...</a></p>
  117. <p><code>#include &lt;<a class="el" href="_skeletal_animation_8h_source.html">SkeletalAnimation.h</a>&gt;</code></p>
  118. <div class="dynheader">
  119. Inheritance diagram for SkeletalAnimation:</div>
  120. <div class="dyncontent">
  121. <div class="center">
  122. <img src="class_skeletal_animation.png" usemap="#SkeletalAnimation_map" alt=""/>
  123. <map id="SkeletalAnimation_map" name="SkeletalAnimation_map">
  124. <area href="class_ref_target.html" alt="RefTarget&lt; SkeletalAnimation &gt;" shape="rect" coords="0,0,190,24"/>
  125. </map>
  126. </div></div>
  127. <table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  129. Classes</h2></td></tr>
  130. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_skeletal_animation_1_1_animated_joint.html">AnimatedJoint</a></td></tr>
  131. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the animation for a single joint. <a href="class_skeletal_animation_1_1_animated_joint.html#details">More...</a><br /></td></tr>
  132. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_skeletal_animation_1_1_joint_state.html">JointState</a></td></tr>
  134. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the current state of a joint, a local space transformation relative to its parent joint. <a href="class_skeletal_animation_1_1_joint_state.html#details">More...</a><br /></td></tr>
  135. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_skeletal_animation_1_1_keyframe.html">Keyframe</a></td></tr>
  137. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the state of a single joint at a particular time. <a href="class_skeletal_animation_1_1_keyframe.html#details">More...</a><br /></td></tr>
  138. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table><table class="memberdecls">
  140. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  141. Public Types</h2></td></tr>
  142. <tr class="memitem:ae9603ef068dbb1fde3b1dde64fe232cc" id="r_ae9603ef068dbb1fde3b1dde64fe232cc"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae9603ef068dbb1fde3b1dde64fe232cc">KeyframeVector</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_skeletal_animation_1_1_keyframe.html">Keyframe</a>&gt;</td></tr>
  143. <tr class="separator:ae9603ef068dbb1fde3b1dde64fe232cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:afcf962a25906787e317084b81e4d4435" id="r_afcf962a25906787e317084b81e4d4435"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afcf962a25906787e317084b81e4d4435">AnimatedJointVector</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_skeletal_animation_1_1_animated_joint.html">AnimatedJoint</a>&gt;</td></tr>
  145. <tr class="separator:afcf962a25906787e317084b81e4d4435"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a6e6684d3d6a93a8a49118d6fb6911c2c" id="r_a6e6684d3d6a93a8a49118d6fb6911c2c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e6684d3d6a93a8a49118d6fb6911c2c">AnimationResult</a> = <a class="el" href="class_result.html">Result</a>&lt;<a class="el" href="class_ref.html">Ref</a>&lt;<a class="el" href="class_skeletal_animation.html">SkeletalAnimation</a>&gt;&gt;</td></tr>
  147. <tr class="separator:a6e6684d3d6a93a8a49118d6fb6911c2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. </table><table class="memberdecls">
  149. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  150. Public Member Functions</h2></td></tr>
  151. <tr class="memitem:abfab43ab605ec8a52b89adc38e1e092d" id="r_abfab43ab605ec8a52b89adc38e1e092d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abfab43ab605ec8a52b89adc38e1e092d">GetDuration</a> () const</td></tr>
  152. <tr class="memdesc:abfab43ab605ec8a52b89adc38e1e092d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the length (in seconds) of this animation. <br /></td></tr>
  153. <tr class="separator:abfab43ab605ec8a52b89adc38e1e092d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a2af19e78e177662f1f8c3c3e5924d55e" id="r_a2af19e78e177662f1f8c3c3e5924d55e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2af19e78e177662f1f8c3c3e5924d55e">ScaleJoints</a> (float inScale)</td></tr>
  155. <tr class="memdesc:a2af19e78e177662f1f8c3c3e5924d55e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scale the size of all joints by inScale. <br /></td></tr>
  156. <tr class="separator:a2af19e78e177662f1f8c3c3e5924d55e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:ab140a305e6090afd7ba7d00075aa4bf1" id="r_ab140a305e6090afd7ba7d00075aa4bf1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab140a305e6090afd7ba7d00075aa4bf1">SetIsLooping</a> (bool inIsLooping)</td></tr>
  158. <tr class="memdesc:ab140a305e6090afd7ba7d00075aa4bf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the animation is looping or not. If an animation is looping, the animation will continue playing after completion. <br /></td></tr>
  159. <tr class="separator:ab140a305e6090afd7ba7d00075aa4bf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a6dfa9e29b046d5c37501caf5ef02f7df" id="r_a6dfa9e29b046d5c37501caf5ef02f7df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6dfa9e29b046d5c37501caf5ef02f7df">IsLooping</a> () const</td></tr>
  161. <tr class="separator:a6dfa9e29b046d5c37501caf5ef02f7df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a1cc26e80f2a36deac4cbe3ecee10299b" id="r_a1cc26e80f2a36deac4cbe3ecee10299b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1cc26e80f2a36deac4cbe3ecee10299b">Sample</a> (float inTime, <a class="el" href="class_skeleton_pose.html">SkeletonPose</a> &amp;ioPose) const</td></tr>
  163. <tr class="memdesc:a1cc26e80f2a36deac4cbe3ecee10299b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the (interpolated) joint transforms at time inTime. <br /></td></tr>
  164. <tr class="separator:a1cc26e80f2a36deac4cbe3ecee10299b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a97437c1bae4626bb0c1e289db73dd712" id="r_a97437c1bae4626bb0c1e289db73dd712"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#afcf962a25906787e317084b81e4d4435">AnimatedJointVector</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a97437c1bae4626bb0c1e289db73dd712">GetAnimatedJoints</a> () const</td></tr>
  166. <tr class="memdesc:a97437c1bae4626bb0c1e289db73dd712"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get joint samples. <br /></td></tr>
  167. <tr class="separator:a97437c1bae4626bb0c1e289db73dd712"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a364b26f699464be275b70b5cf9f4f76c" id="r_a364b26f699464be275b70b5cf9f4f76c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#afcf962a25906787e317084b81e4d4435">AnimatedJointVector</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a364b26f699464be275b70b5cf9f4f76c">GetAnimatedJoints</a> ()</td></tr>
  169. <tr class="separator:a364b26f699464be275b70b5cf9f4f76c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a7a79545601f7b713372164001443d7e6" id="r_a7a79545601f7b713372164001443d7e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a79545601f7b713372164001443d7e6">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  171. <tr class="memdesc:a7a79545601f7b713372164001443d7e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the state of this animation in binary form to inStream. <br /></td></tr>
  172. <tr class="separator:a7a79545601f7b713372164001443d7e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="inherit_header pub_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; SkeletalAnimation &gt;</a></td></tr>
  174. <tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
  175. <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  176. <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a50444e3b659c6f93c64aee224a93f6ab">RefTarget</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
  178. <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
  180. <tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">assert no one is referencing us <br /></td></tr>
  181. <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
  183. <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target" id="r_a1fc15bfe979bc43a7fa71c7c34f87ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_target.html">RefTarget</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a1fc15bfe979bc43a7fa71c7c34f87ed0">operator=</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
  185. <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
  186. <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target" id="r_acaf07366183c51cd8460c7d3dcd07c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
  188. <tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current refcount of this object. <br /></td></tr>
  189. <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
  191. <tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add or release a reference to this object. <br /></td></tr>
  192. <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
  194. <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. </table><table class="memberdecls">
  196. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  197. Static Public Member Functions</h2></td></tr>
  198. <tr class="memitem:a8f1bdd3258f9a9cc16c8288b46adab16" id="r_a8f1bdd3258f9a9cc16c8288b46adab16"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#a6e6684d3d6a93a8a49118d6fb6911c2c">AnimationResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8f1bdd3258f9a9cc16c8288b46adab16">sRestoreFromBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  199. <tr class="memdesc:a8f1bdd3258f9a9cc16c8288b46adab16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore a saved ragdoll from inStream. <br /></td></tr>
  200. <tr class="separator:a8f1bdd3258f9a9cc16c8288b46adab16"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="inherit_header pub_static_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; SkeletalAnimation &gt;</a></td></tr>
  202. <tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
  203. <tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION. <br /></td></tr>
  204. <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. </table><table class="memberdecls">
  206. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  207. Additional Inherited Members</h2></td></tr>
  208. <tr class="inherit_header pro_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; SkeletalAnimation &gt;</a></td></tr>
  209. <tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic&lt; <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
  210. <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count. <br /></td></tr>
  211. <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="inherit_header pro_static_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; SkeletalAnimation &gt;</a></td></tr>
  213. <tr class="memitem:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target" id="r_ad37db773efa3c8756f6d95df3862b875"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
  214. <tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded. <br /></td></tr>
  215. <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. </table>
  217. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  218. <div class="textblock"><p>Resource for a skinned animation. </p>
  219. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  220. <a id="afcf962a25906787e317084b81e4d4435" name="afcf962a25906787e317084b81e4d4435"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#afcf962a25906787e317084b81e4d4435">&#9670;&#160;</a></span>AnimatedJointVector</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">using <a class="el" href="#afcf962a25906787e317084b81e4d4435">SkeletalAnimation::AnimatedJointVector</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_skeletal_animation_1_1_animated_joint.html">AnimatedJoint</a>&gt;</td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. </div>
  231. </div>
  232. <a id="a6e6684d3d6a93a8a49118d6fb6911c2c" name="a6e6684d3d6a93a8a49118d6fb6911c2c"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#a6e6684d3d6a93a8a49118d6fb6911c2c">&#9670;&#160;</a></span>AnimationResult</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">using <a class="el" href="#a6e6684d3d6a93a8a49118d6fb6911c2c">SkeletalAnimation::AnimationResult</a> = <a class="el" href="class_result.html">Result</a>&lt;<a class="el" href="class_ref.html">Ref</a>&lt;<a class="el" href="class_skeletal_animation.html">SkeletalAnimation</a>&gt;&gt;</td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. </div>
  243. </div>
  244. <a id="ae9603ef068dbb1fde3b1dde64fe232cc" name="ae9603ef068dbb1fde3b1dde64fe232cc"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#ae9603ef068dbb1fde3b1dde64fe232cc">&#9670;&#160;</a></span>KeyframeVector</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">using <a class="el" href="#ae9603ef068dbb1fde3b1dde64fe232cc">SkeletalAnimation::KeyframeVector</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_skeletal_animation_1_1_keyframe.html">Keyframe</a>&gt;</td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. </div>
  255. </div>
  256. <h2 class="groupheader">Member Function Documentation</h2>
  257. <a id="a364b26f699464be275b70b5cf9f4f76c" name="a364b26f699464be275b70b5cf9f4f76c"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#a364b26f699464be275b70b5cf9f4f76c">&#9670;&#160;</a></span>GetAnimatedJoints() <span class="overload">[1/2]</span></h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="mlabels">
  262. <tr>
  263. <td class="mlabels-left">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname"><a class="el" href="#afcf962a25906787e317084b81e4d4435">AnimatedJointVector</a> &amp; SkeletalAnimation::GetAnimatedJoints </td>
  267. <td>(</td>
  268. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  269. <td></td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. </div>
  279. </div>
  280. <a id="a97437c1bae4626bb0c1e289db73dd712" name="a97437c1bae4626bb0c1e289db73dd712"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#a97437c1bae4626bb0c1e289db73dd712">&#9670;&#160;</a></span>GetAnimatedJoints() <span class="overload">[2/2]</span></h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="mlabels">
  285. <tr>
  286. <td class="mlabels-left">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname">const <a class="el" href="#afcf962a25906787e317084b81e4d4435">AnimatedJointVector</a> &amp; SkeletalAnimation::GetAnimatedJoints </td>
  290. <td>(</td>
  291. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  292. <td> const</td>
  293. </tr>
  294. </table>
  295. </td>
  296. <td class="mlabels-right">
  297. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Get joint samples. </p>
  302. </div>
  303. </div>
  304. <a id="abfab43ab605ec8a52b89adc38e1e092d" name="abfab43ab605ec8a52b89adc38e1e092d"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#abfab43ab605ec8a52b89adc38e1e092d">&#9670;&#160;</a></span>GetDuration()</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">float SkeletalAnimation::GetDuration </td>
  311. <td>(</td>
  312. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  313. <td> const</td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Get the length (in seconds) of this animation. </p>
  318. </div>
  319. </div>
  320. <a id="a6dfa9e29b046d5c37501caf5ef02f7df" name="a6dfa9e29b046d5c37501caf5ef02f7df"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#a6dfa9e29b046d5c37501caf5ef02f7df">&#9670;&#160;</a></span>IsLooping()</h2>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <table class="mlabels">
  325. <tr>
  326. <td class="mlabels-left">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">bool SkeletalAnimation::IsLooping </td>
  330. <td>(</td>
  331. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  332. <td> const</td>
  333. </tr>
  334. </table>
  335. </td>
  336. <td class="mlabels-right">
  337. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. </div>
  342. </div>
  343. <a id="a1cc26e80f2a36deac4cbe3ecee10299b" name="a1cc26e80f2a36deac4cbe3ecee10299b"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a1cc26e80f2a36deac4cbe3ecee10299b">&#9670;&#160;</a></span>Sample()</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">void SkeletalAnimation::Sample </td>
  350. <td>(</td>
  351. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inTime</em></span>, </td>
  352. </tr>
  353. <tr>
  354. <td class="paramkey"></td>
  355. <td></td>
  356. <td class="paramtype"><a class="el" href="class_skeleton_pose.html">SkeletonPose</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioPose</em></span>&#160;) const</td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Get the (interpolated) joint transforms at time inTime. </p>
  361. </div>
  362. </div>
  363. <a id="a7a79545601f7b713372164001443d7e6" name="a7a79545601f7b713372164001443d7e6"></a>
  364. <h2 class="memtitle"><span class="permalink"><a href="#a7a79545601f7b713372164001443d7e6">&#9670;&#160;</a></span>SaveBinaryState()</h2>
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">void SkeletalAnimation::SaveBinaryState </td>
  370. <td>(</td>
  371. <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  372. <td> const</td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>Saves the state of this animation in binary form to inStream. </p>
  377. </div>
  378. </div>
  379. <a id="a2af19e78e177662f1f8c3c3e5924d55e" name="a2af19e78e177662f1f8c3c3e5924d55e"></a>
  380. <h2 class="memtitle"><span class="permalink"><a href="#a2af19e78e177662f1f8c3c3e5924d55e">&#9670;&#160;</a></span>ScaleJoints()</h2>
  381. <div class="memitem">
  382. <div class="memproto">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">void SkeletalAnimation::ScaleJoints </td>
  386. <td>(</td>
  387. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  388. <td></td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <p>Scale the size of all joints by inScale. </p>
  393. </div>
  394. </div>
  395. <a id="ab140a305e6090afd7ba7d00075aa4bf1" name="ab140a305e6090afd7ba7d00075aa4bf1"></a>
  396. <h2 class="memtitle"><span class="permalink"><a href="#ab140a305e6090afd7ba7d00075aa4bf1">&#9670;&#160;</a></span>SetIsLooping()</h2>
  397. <div class="memitem">
  398. <div class="memproto">
  399. <table class="mlabels">
  400. <tr>
  401. <td class="mlabels-left">
  402. <table class="memname">
  403. <tr>
  404. <td class="memname">void SkeletalAnimation::SetIsLooping </td>
  405. <td>(</td>
  406. <td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>inIsLooping</em></span></td><td>)</td>
  407. <td></td>
  408. </tr>
  409. </table>
  410. </td>
  411. <td class="mlabels-right">
  412. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. <p>If the animation is looping or not. If an animation is looping, the animation will continue playing after completion. </p>
  417. </div>
  418. </div>
  419. <a id="a8f1bdd3258f9a9cc16c8288b46adab16" name="a8f1bdd3258f9a9cc16c8288b46adab16"></a>
  420. <h2 class="memtitle"><span class="permalink"><a href="#a8f1bdd3258f9a9cc16c8288b46adab16">&#9670;&#160;</a></span>sRestoreFromBinaryState()</h2>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="mlabels">
  424. <tr>
  425. <td class="mlabels-left">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname"><a class="el" href="#a6e6684d3d6a93a8a49118d6fb6911c2c">SkeletalAnimation::AnimationResult</a> SkeletalAnimation::sRestoreFromBinaryState </td>
  429. <td>(</td>
  430. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  431. <td></td>
  432. </tr>
  433. </table>
  434. </td>
  435. <td class="mlabels-right">
  436. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  437. </tr>
  438. </table>
  439. </div><div class="memdoc">
  440. <p>Restore a saved ragdoll from inStream. </p>
  441. </div>
  442. </div>
  443. <hr/>The documentation for this class was generated from the following files:<ul>
  444. <li>Jolt/Skeleton/<a class="el" href="_skeletal_animation_8h_source.html">SkeletalAnimation.h</a></li>
  445. <li>Jolt/Skeleton/<a class="el" href="_skeletal_animation_8cpp.html">SkeletalAnimation.cpp</a></li>
  446. </ul>
  447. </div><!-- contents -->
  448. </div><!-- doc-content -->
  449. <!-- start footer part -->
  450. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  451. <ul>
  452. <li class="navelem"><a class="el" href="class_skeletal_animation.html">SkeletalAnimation</a></li>
  453. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  454. </ul>
  455. </div>
  456. </body>
  457. </html>