cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: Skeleton Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_skeleton.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_skeleton-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Skeleton Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Resource that contains the joint hierarchy for a skeleton.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_skeleton_8h_source.html">Skeleton.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Skeleton:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_skeleton.png" usemap="#Skeleton_map" alt=""/>
  <map id="Skeleton_map" name="Skeleton_map">
<area href="class_ref_target.html" alt="RefTarget&lt; Skeleton &gt;" shape="rect" coords="0,0,139,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_skeleton_1_1_joint.html">Joint</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Declare internal structure for a joint.  <a href="class_skeleton_1_1_joint.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0ddf8aaab0d23fee5379e271db3a9282" id="r_a0ddf8aaab0d23fee5379e271db3a9282"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ddf8aaab0d23fee5379e271db3a9282">SkeletonResult</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_skeleton.html">Skeleton</a>&gt;&gt;</td></tr>
<tr class="separator:a0ddf8aaab0d23fee5379e271db3a9282"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc73ae3dc3fae778e7da6cea24f0897a" id="r_abc73ae3dc3fae778e7da6cea24f0897a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abc73ae3dc3fae778e7da6cea24f0897a">JointVector</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_skeleton_1_1_joint.html">Joint</a>&gt;</td></tr>
<tr class="separator:abc73ae3dc3fae778e7da6cea24f0897a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8cd408fd1003399fcdd91c9272ccf06d" id="r_a8cd408fd1003399fcdd91c9272ccf06d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8cd408fd1003399fcdd91c9272ccf06d">GetJointIndex</a> (const string_view &amp;inName) const</td></tr>
<tr class="memdesc:a8cd408fd1003399fcdd91c9272ccf06d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find joint by name.  <br /></td></tr>
<tr class="separator:a8cd408fd1003399fcdd91c9272ccf06d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79ade25d7ec74a8bd21c87062844e21e" id="r_a79ade25d7ec74a8bd21c87062844e21e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a79ade25d7ec74a8bd21c87062844e21e">CalculateParentJointIndices</a> ()</td></tr>
<tr class="memdesc:a79ade25d7ec74a8bd21c87062844e21e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fill in parent joint indices based on name.  <br /></td></tr>
<tr class="separator:a79ade25d7ec74a8bd21c87062844e21e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac4965d2cd0cf26b47ddc769e51c62fe" id="r_aac4965d2cd0cf26b47ddc769e51c62fe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aac4965d2cd0cf26b47ddc769e51c62fe">AreJointsCorrectlyOrdered</a> () const</td></tr>
<tr class="separator:aac4965d2cd0cf26b47ddc769e51c62fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79a39de0388c130dd03acfb1d9e71f8d" id="r_a79a39de0388c130dd03acfb1d9e71f8d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a79a39de0388c130dd03acfb1d9e71f8d">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
<tr class="memdesc:a79a39de0388c130dd03acfb1d9e71f8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the state of this object in binary form to inStream.  <br /></td></tr>
<tr class="separator:a79a39de0388c130dd03acfb1d9e71f8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Access to the joints</div></td></tr>
<tr class="memitem:a70591341dd88358d31e0b8dd442c0ac2" id="r_a70591341dd88358d31e0b8dd442c0ac2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#abc73ae3dc3fae778e7da6cea24f0897a">JointVector</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a70591341dd88358d31e0b8dd442c0ac2">GetJoints</a> () const</td></tr>
<tr class="separator:a70591341dd88358d31e0b8dd442c0ac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f6a4cc9a5272704684dc07cea7e2fd9" id="r_a9f6a4cc9a5272704684dc07cea7e2fd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#abc73ae3dc3fae778e7da6cea24f0897a">JointVector</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f6a4cc9a5272704684dc07cea7e2fd9">GetJoints</a> ()</td></tr>
<tr class="separator:a9f6a4cc9a5272704684dc07cea7e2fd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42baf00a00f27baa28254ebcd638ecd3" id="r_a42baf00a00f27baa28254ebcd638ecd3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42baf00a00f27baa28254ebcd638ecd3">GetJointCount</a> () const</td></tr>
<tr class="separator:a42baf00a00f27baa28254ebcd638ecd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec4d0e10a2ea5d08f7ea2ab4c40263c7" id="r_aec4d0e10a2ea5d08f7ea2ab4c40263c7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_skeleton_1_1_joint.html">Joint</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aec4d0e10a2ea5d08f7ea2ab4c40263c7">GetJoint</a> (int inJoint) const</td></tr>
<tr class="separator:aec4d0e10a2ea5d08f7ea2ab4c40263c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a707d5fe6d41b2d5c2e8ecd1778c96551" id="r_a707d5fe6d41b2d5c2e8ecd1778c96551"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_skeleton_1_1_joint.html">Joint</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a707d5fe6d41b2d5c2e8ecd1778c96551">GetJoint</a> (int inJoint)</td></tr>
<tr class="separator:a707d5fe6d41b2d5c2e8ecd1778c96551"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa058a06eb2f163d14b481bbd8d602be6" id="r_aa058a06eb2f163d14b481bbd8d602be6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa058a06eb2f163d14b481bbd8d602be6">AddJoint</a> (const string_view &amp;inName, const string_view &amp;inParentName=string_view())</td></tr>
<tr class="separator:aa058a06eb2f163d14b481bbd8d602be6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae52ee99ff637c0ceea37d46ba3b2d712" id="r_ae52ee99ff637c0ceea37d46ba3b2d712"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae52ee99ff637c0ceea37d46ba3b2d712">AddJoint</a> (const string_view &amp;inName, int inParentIndex)</td></tr>
<tr class="separator:ae52ee99ff637c0ceea37d46ba3b2d712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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; Skeleton &gt;</a></td></tr>
<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>
<tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <br /></td></tr>
<tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a3429d0d7e38215ebc548ec1668e5835f" id="r_a3429d0d7e38215ebc548ec1668e5835f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#a0ddf8aaab0d23fee5379e271db3a9282">SkeletonResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3429d0d7e38215ebc548ec1668e5835f">sRestoreFromBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
<tr class="memdesc:a3429d0d7e38215ebc548ec1668e5835f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore the state of this object from inStream.  <br /></td></tr>
<tr class="separator:a3429d0d7e38215ebc548ec1668e5835f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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; Skeleton &gt;</a></td></tr>
<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>
<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>
<tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<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; Skeleton &gt;</a></td></tr>
<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>
<tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count.  <br /></td></tr>
<tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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; Skeleton &gt;</a></td></tr>
<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>
<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>
<tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Resource that contains the joint hierarchy for a skeleton. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="abc73ae3dc3fae778e7da6cea24f0897a" name="abc73ae3dc3fae778e7da6cea24f0897a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc73ae3dc3fae778e7da6cea24f0897a">&#9670;&#160;</a></span>JointVector</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#abc73ae3dc3fae778e7da6cea24f0897a">Skeleton::JointVector</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_skeleton_1_1_joint.html">Joint</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a0ddf8aaab0d23fee5379e271db3a9282" name="a0ddf8aaab0d23fee5379e271db3a9282"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ddf8aaab0d23fee5379e271db3a9282">&#9670;&#160;</a></span>SkeletonResult</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#a0ddf8aaab0d23fee5379e271db3a9282">Skeleton::SkeletonResult</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_skeleton.html">Skeleton</a>&gt;&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa058a06eb2f163d14b481bbd8d602be6" name="aa058a06eb2f163d14b481bbd8d602be6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa058a06eb2f163d14b481bbd8d602be6">&#9670;&#160;</a></span>AddJoint() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> Skeleton::AddJoint </td>
          <td>(</td>
          <td class="paramtype">const string_view &amp;</td>          <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string_view &amp;</td>          <td class="paramname"><span class="paramname"><em>inParentName</em></span><span class="paramdefsep"> = </span><span class="paramdefval">string_view()</span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ae52ee99ff637c0ceea37d46ba3b2d712" name="ae52ee99ff637c0ceea37d46ba3b2d712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae52ee99ff637c0ceea37d46ba3b2d712">&#9670;&#160;</a></span>AddJoint() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> Skeleton::AddJoint </td>
          <td>(</td>
          <td class="paramtype">const string_view &amp;</td>          <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inParentIndex</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aac4965d2cd0cf26b47ddc769e51c62fe" name="aac4965d2cd0cf26b47ddc769e51c62fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac4965d2cd0cf26b47ddc769e51c62fe">&#9670;&#160;</a></span>AreJointsCorrectlyOrdered()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Skeleton::AreJointsCorrectlyOrdered </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Many of the algorithms that use the <a class="el" href="class_skeleton.html" title="Resource that contains the joint hierarchy for a skeleton.">Skeleton</a> class require that parent joints are in the mJoints array before their children. This function returns true if this is the case, false if not. </p>

</div>
</div>
<a id="a79ade25d7ec74a8bd21c87062844e21e" name="a79ade25d7ec74a8bd21c87062844e21e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79ade25d7ec74a8bd21c87062844e21e">&#9670;&#160;</a></span>CalculateParentJointIndices()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Skeleton::CalculateParentJointIndices </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Fill in parent joint indices based on name. </p>

</div>
</div>
<a id="a707d5fe6d41b2d5c2e8ecd1778c96551" name="a707d5fe6d41b2d5c2e8ecd1778c96551"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a707d5fe6d41b2d5c2e8ecd1778c96551">&#9670;&#160;</a></span>GetJoint() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_skeleton_1_1_joint.html">Joint</a> &amp; Skeleton::GetJoint </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inJoint</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aec4d0e10a2ea5d08f7ea2ab4c40263c7" name="aec4d0e10a2ea5d08f7ea2ab4c40263c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec4d0e10a2ea5d08f7ea2ab4c40263c7">&#9670;&#160;</a></span>GetJoint() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="class_skeleton_1_1_joint.html">Joint</a> &amp; Skeleton::GetJoint </td>
          <td>(</td>
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>inJoint</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a42baf00a00f27baa28254ebcd638ecd3" name="a42baf00a00f27baa28254ebcd638ecd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42baf00a00f27baa28254ebcd638ecd3">&#9670;&#160;</a></span>GetJointCount()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int Skeleton::GetJointCount </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a8cd408fd1003399fcdd91c9272ccf06d" name="a8cd408fd1003399fcdd91c9272ccf06d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cd408fd1003399fcdd91c9272ccf06d">&#9670;&#160;</a></span>GetJointIndex()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Skeleton::GetJointIndex </td>
          <td>(</td>
          <td class="paramtype">const string_view &amp;</td>          <td class="paramname"><span class="paramname"><em>inName</em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find joint by name. </p>

</div>
</div>
<a id="a9f6a4cc9a5272704684dc07cea7e2fd9" name="a9f6a4cc9a5272704684dc07cea7e2fd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f6a4cc9a5272704684dc07cea7e2fd9">&#9670;&#160;</a></span>GetJoints() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#abc73ae3dc3fae778e7da6cea24f0897a">JointVector</a> &amp; Skeleton::GetJoints </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a70591341dd88358d31e0b8dd442c0ac2" name="a70591341dd88358d31e0b8dd442c0ac2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70591341dd88358d31e0b8dd442c0ac2">&#9670;&#160;</a></span>GetJoints() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="#abc73ae3dc3fae778e7da6cea24f0897a">JointVector</a> &amp; Skeleton::GetJoints </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a79a39de0388c130dd03acfb1d9e71f8d" name="a79a39de0388c130dd03acfb1d9e71f8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79a39de0388c130dd03acfb1d9e71f8d">&#9670;&#160;</a></span>SaveBinaryState()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Skeleton::SaveBinaryState </td>
          <td>(</td>
          <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>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Saves the state of this object in binary form to inStream. </p>

</div>
</div>
<a id="a3429d0d7e38215ebc548ec1668e5835f" name="a3429d0d7e38215ebc548ec1668e5835f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3429d0d7e38215ebc548ec1668e5835f">&#9670;&#160;</a></span>sRestoreFromBinaryState()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#a0ddf8aaab0d23fee5379e271db3a9282">Skeleton::SkeletonResult</a> Skeleton::sRestoreFromBinaryState </td>
          <td>(</td>
          <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>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Restore the state of this object from inStream. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Skeleton/<a class="el" href="_skeleton_8h_source.html">Skeleton.h</a></li>
<li>Jolt/Skeleton/<a class="el" href="_skeleton_8cpp.html">Skeleton.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_skeleton.html">Skeleton</a></li>
    <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>
  </ul>
</div>
</body>
</html>