class_skeleton_1_1_joint.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  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: Skeleton::Joint 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_skeleton_1_1_joint.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="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="#pub-attribs">Public Attributes</a> &#124;
  109. <a href="class_skeleton_1_1_joint-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">Skeleton::Joint Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Declare internal structure for a joint.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_skeleton_8h_source.html">Skeleton.h</a>&gt;</code></p>
  116. <table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  118. Public Member Functions</h2></td></tr>
  119. <tr class="memitem:a87e1ff289639d959858305f1fb06635f" id="r_a87e1ff289639d959858305f1fb06635f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a87e1ff289639d959858305f1fb06635f">Joint</a> ()=default</td></tr>
  120. <tr class="separator:a87e1ff289639d959858305f1fb06635f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:aa9efa0126fb47778e2a95f81c512ad0b" id="r_aa9efa0126fb47778e2a95f81c512ad0b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9efa0126fb47778e2a95f81c512ad0b">Joint</a> (const string_view &amp;inName, const string_view &amp;inParentName, int inParentJointIndex)</td></tr>
  122. <tr class="separator:aa9efa0126fb47778e2a95f81c512ad0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table><table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  125. Public Attributes</h2></td></tr>
  126. <tr class="memitem:a49426f9af65fba0c7a0a687079d38ff3" id="r_a49426f9af65fba0c7a0a687079d38ff3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a49426f9af65fba0c7a0a687079d38ff3">mName</a></td></tr>
  127. <tr class="memdesc:a49426f9af65fba0c7a0a687079d38ff3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the joint. <br /></td></tr>
  128. <tr class="separator:a49426f9af65fba0c7a0a687079d38ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a575a54eccd755c88fd484272fd3cf38d" id="r_a575a54eccd755c88fd484272fd3cf38d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a575a54eccd755c88fd484272fd3cf38d">mParentName</a></td></tr>
  130. <tr class="memdesc:a575a54eccd755c88fd484272fd3cf38d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of parent joint. <br /></td></tr>
  131. <tr class="separator:a575a54eccd755c88fd484272fd3cf38d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a2bf4993eb1dc238b968e3881592e9823" id="r_a2bf4993eb1dc238b968e3881592e9823"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bf4993eb1dc238b968e3881592e9823">mParentJointIndex</a> = -1</td></tr>
  133. <tr class="memdesc:a2bf4993eb1dc238b968e3881592e9823"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of parent joint (in mJoints) or -1 if it has no parent. <br /></td></tr>
  134. <tr class="separator:a2bf4993eb1dc238b968e3881592e9823"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  137. <div class="textblock"><p>Declare internal structure for a joint. </p>
  138. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  139. <a id="a87e1ff289639d959858305f1fb06635f" name="a87e1ff289639d959858305f1fb06635f"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#a87e1ff289639d959858305f1fb06635f">&#9670;&#160;</a></span>Joint() <span class="overload">[1/2]</span></h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="mlabels">
  144. <tr>
  145. <td class="mlabels-left">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">Skeleton::Joint::Joint </td>
  149. <td>(</td>
  150. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  151. <td></td>
  152. </tr>
  153. </table>
  154. </td>
  155. <td class="mlabels-right">
  156. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. </div>
  161. </div>
  162. <a id="aa9efa0126fb47778e2a95f81c512ad0b" name="aa9efa0126fb47778e2a95f81c512ad0b"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#aa9efa0126fb47778e2a95f81c512ad0b">&#9670;&#160;</a></span>Joint() <span class="overload">[2/2]</span></h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">Skeleton::Joint::Joint </td>
  172. <td>(</td>
  173. <td class="paramtype">const string_view &amp;</td> <td class="paramname"><span class="paramname"><em>inName</em></span>, </td>
  174. </tr>
  175. <tr>
  176. <td class="paramkey"></td>
  177. <td></td>
  178. <td class="paramtype">const string_view &amp;</td> <td class="paramname"><span class="paramname"><em>inParentName</em></span>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>inParentJointIndex</em></span>&#160;)</td>
  184. </tr>
  185. </table>
  186. </td>
  187. <td class="mlabels-right">
  188. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. </div>
  193. </div>
  194. <h2 class="groupheader">Member Data Documentation</h2>
  195. <a id="a49426f9af65fba0c7a0a687079d38ff3" name="a49426f9af65fba0c7a0a687079d38ff3"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#a49426f9af65fba0c7a0a687079d38ff3">&#9670;&#160;</a></span>mName</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname"><a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a> Skeleton::Joint::mName</td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>Name of the joint. </p>
  206. </div>
  207. </div>
  208. <a id="a2bf4993eb1dc238b968e3881592e9823" name="a2bf4993eb1dc238b968e3881592e9823"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#a2bf4993eb1dc238b968e3881592e9823">&#9670;&#160;</a></span>mParentJointIndex</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">int Skeleton::Joint::mParentJointIndex = -1</td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>Index of parent joint (in mJoints) or -1 if it has no parent. </p>
  219. </div>
  220. </div>
  221. <a id="a575a54eccd755c88fd484272fd3cf38d" name="a575a54eccd755c88fd484272fd3cf38d"></a>
  222. <h2 class="memtitle"><span class="permalink"><a href="#a575a54eccd755c88fd484272fd3cf38d">&#9670;&#160;</a></span>mParentName</h2>
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname"><a class="el" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a> Skeleton::Joint::mParentName</td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Name of parent joint. </p>
  232. </div>
  233. </div>
  234. <hr/>The documentation for this class was generated from the following file:<ul>
  235. <li>Jolt/Skeleton/<a class="el" href="_skeleton_8h_source.html">Skeleton.h</a></li>
  236. </ul>
  237. </div><!-- contents -->
  238. </div><!-- doc-content -->
  239. <!-- start footer part -->
  240. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  241. <ul>
  242. <li class="navelem"><a class="el" href="class_skeleton.html">Skeleton</a></li><li class="navelem"><a class="el" href="class_skeleton_1_1_joint.html">Joint</a></li>
  243. <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>
  244. </ul>
  245. </div>
  246. </body>
  247. </html>