struct_compound_shape_1_1_sub_shape.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527
  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: CompoundShape::SubShape Struct 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('struct_compound_shape_1_1_sub_shape.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="struct_compound_shape_1_1_sub_shape-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">CompoundShape::SubShape Struct Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p><code>#include &lt;<a class="el" href="_compound_shape_8h_source.html">CompoundShape.h</a>&gt;</code></p>
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  116. Public Member Functions</h2></td></tr>
  117. <tr class="memitem:a2ea825bfb79c5d059768e60d7b8997d2" id="r_a2ea825bfb79c5d059768e60d7b8997d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ea825bfb79c5d059768e60d7b8997d2">FromSettings</a> (const <a class="el" href="struct_compound_shape_settings_1_1_sub_shape_settings.html">CompoundShapeSettings::SubShapeSettings</a> &amp;inSettings, <a class="el" href="class_shape.html#a11c1ce0984dccb67176566d78331375e">ShapeResult</a> &amp;outResult)</td></tr>
  118. <tr class="separator:a2ea825bfb79c5d059768e60d7b8997d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a3805d809932e3f0d94a3b87e297a47bc" id="r_a3805d809932e3f0d94a3b87e297a47bc"><td class="memItemLeft" align="right" valign="top">JPH_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3805d809932e3f0d94a3b87e297a47bc">SetTransform</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPosition, <a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inRotation, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inCenterOfMass)</td></tr>
  120. <tr class="separator:a3805d809932e3f0d94a3b87e297a47bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a18ba22cc1d5ad095bce61a7fcfcbcc25" id="r_a18ba22cc1d5ad095bce61a7fcfcbcc25"><td class="memItemLeft" align="right" valign="top">JPH_INLINE <a class="el" href="class_mat44.html">Mat44</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18ba22cc1d5ad095bce61a7fcfcbcc25">GetLocalTransformNoScale</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale) const</td></tr>
  122. <tr class="separator:a18ba22cc1d5ad095bce61a7fcfcbcc25"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a33448959f96311ef875a912b8a104dcf" id="r_a33448959f96311ef875a912b8a104dcf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33448959f96311ef875a912b8a104dcf">IsValidScale</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale) const</td></tr>
  124. <tr class="memdesc:a33448959f96311ef875a912b8a104dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if inScale is valid for this sub shape. <br /></td></tr>
  125. <tr class="separator:a33448959f96311ef875a912b8a104dcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a92de7326e077355d680f2d6ce860d7fc" id="r_a92de7326e077355d680f2d6ce860d7fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a92de7326e077355d680f2d6ce860d7fc">TransformScale</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inScale) const</td></tr>
  127. <tr class="memdesc:a92de7326e077355d680f2d6ce860d7fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transform the scale to the local space of the child shape. <br /></td></tr>
  128. <tr class="separator:a92de7326e077355d680f2d6ce860d7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ad02db108fee2f4caeb4d2709a4f14671" id="r_ad02db108fee2f4caeb4d2709a4f14671"><td class="memItemLeft" align="right" valign="top">JPH_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad02db108fee2f4caeb4d2709a4f14671">SetPositionCOM</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPositionCOM)</td></tr>
  130. <tr class="memdesc:ad02db108fee2f4caeb4d2709a4f14671"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compress the center of mass position. <br /></td></tr>
  131. <tr class="separator:ad02db108fee2f4caeb4d2709a4f14671"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ac3fea8705474011f4f5681c18fcdaaa2" id="r_ac3fea8705474011f4f5681c18fcdaaa2"><td class="memItemLeft" align="right" valign="top">JPH_INLINE <a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac3fea8705474011f4f5681c18fcdaaa2">GetPositionCOM</a> () const</td></tr>
  133. <tr class="memdesc:ac3fea8705474011f4f5681c18fcdaaa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uncompress the center of mass position. <br /></td></tr>
  134. <tr class="separator:ac3fea8705474011f4f5681c18fcdaaa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:aeb79df4468aca72a42c1c8dd68f564c1" id="r_aeb79df4468aca72a42c1c8dd68f564c1"><td class="memItemLeft" align="right" valign="top">JPH_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb79df4468aca72a42c1c8dd68f564c1">SetRotation</a> (<a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inRotation)</td></tr>
  136. <tr class="memdesc:aeb79df4468aca72a42c1c8dd68f564c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compress the rotation. <br /></td></tr>
  137. <tr class="separator:aeb79df4468aca72a42c1c8dd68f564c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a13d700b0e7064e9ecdf99afdc0262eae" id="r_a13d700b0e7064e9ecdf99afdc0262eae"><td class="memItemLeft" align="right" valign="top">JPH_INLINE <a class="el" href="class_quat.html">Quat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a13d700b0e7064e9ecdf99afdc0262eae">GetRotation</a> () const</td></tr>
  139. <tr class="memdesc:a13d700b0e7064e9ecdf99afdc0262eae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uncompress the rotation. <br /></td></tr>
  140. <tr class="separator:a13d700b0e7064e9ecdf99afdc0262eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. </table><table class="memberdecls">
  142. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  143. Public Attributes</h2></td></tr>
  144. <tr class="memitem:af0e288762fbe4fcdec676ce1836d5375" id="r_af0e288762fbe4fcdec676ce1836d5375"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_const.html">RefConst</a>&lt; <a class="el" href="class_shape.html">Shape</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af0e288762fbe4fcdec676ce1836d5375">mShape</a></td></tr>
  145. <tr class="separator:af0e288762fbe4fcdec676ce1836d5375"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a16bb59f7313e95ee322d576f5d2d85a7" id="r_a16bb59f7313e95ee322d576f5d2d85a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_float3.html">Float3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a16bb59f7313e95ee322d576f5d2d85a7">mPositionCOM</a></td></tr>
  147. <tr class="memdesc:a16bb59f7313e95ee322d576f5d2d85a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Note: Position of center of mass of sub shape! <br /></td></tr>
  148. <tr class="separator:a16bb59f7313e95ee322d576f5d2d85a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a42a1dc09f0d3bd15367f87d26452bd44" id="r_a42a1dc09f0d3bd15367f87d26452bd44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_float3.html">Float3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42a1dc09f0d3bd15367f87d26452bd44">mRotation</a></td></tr>
  150. <tr class="memdesc:a42a1dc09f0d3bd15367f87d26452bd44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Note: X, Y, Z of rotation quaternion - note we read 4 bytes beyond this so make sure there's something there. <br /></td></tr>
  151. <tr class="separator:a42a1dc09f0d3bd15367f87d26452bd44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a8528ca1f6ee3908b418283517762bd57" id="r_a8528ca1f6ee3908b418283517762bd57"><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="#a8528ca1f6ee3908b418283517762bd57">mUserData</a></td></tr>
  153. <tr class="memdesc:a8528ca1f6ee3908b418283517762bd57"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data value (put here because it falls in padding bytes) <br /></td></tr>
  154. <tr class="separator:a8528ca1f6ee3908b418283517762bd57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a25c797febba76594f53b5303867fe0fb" id="r_a25c797febba76594f53b5303867fe0fb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a25c797febba76594f53b5303867fe0fb">mIsRotationIdentity</a></td></tr>
  156. <tr class="memdesc:a25c797febba76594f53b5303867fe0fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">If mRotation is close to identity (put here because it falls in padding bytes) <br /></td></tr>
  157. <tr class="separator:a25c797febba76594f53b5303867fe0fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table>
  159. <h2 class="groupheader">Member Function Documentation</h2>
  160. <a id="a2ea825bfb79c5d059768e60d7b8997d2" name="a2ea825bfb79c5d059768e60d7b8997d2"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#a2ea825bfb79c5d059768e60d7b8997d2">&#9670;&#160;</a></span>FromSettings()</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="mlabels">
  165. <tr>
  166. <td class="mlabels-left">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">bool CompoundShape::SubShape::FromSettings </td>
  170. <td>(</td>
  171. <td class="paramtype">const <a class="el" href="struct_compound_shape_settings_1_1_sub_shape_settings.html">CompoundShapeSettings::SubShapeSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inSettings</em></span>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype"><a class="el" href="class_shape.html#a11c1ce0984dccb67176566d78331375e">ShapeResult</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outResult</em></span>&#160;)</td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Initialize sub shape from sub shape settings </p><dl class="params"><dt>Parameters</dt><dd>
  186. <table class="params">
  187. <tr><td class="paramname">inSettings</td><td>Settings object </td></tr>
  188. <tr><td class="paramname">outResult</td><td><a class="el" href="class_result.html" title="Helper class that either contains a valid result or an error.">Result</a> object, only used in case of error </td></tr>
  189. </table>
  190. </dd>
  191. </dl>
  192. <dl class="section return"><dt>Returns</dt><dd>True on success, false on failure </dd></dl>
  193. </div>
  194. </div>
  195. <a id="a18ba22cc1d5ad095bce61a7fcfcbcc25" name="a18ba22cc1d5ad095bce61a7fcfcbcc25"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#a18ba22cc1d5ad095bce61a7fcfcbcc25">&#9670;&#160;</a></span>GetLocalTransformNoScale()</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="mlabels">
  200. <tr>
  201. <td class="mlabels-left">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">JPH_INLINE <a class="el" href="class_mat44.html">Mat44</a> CompoundShape::SubShape::GetLocalTransformNoScale </td>
  205. <td>(</td>
  206. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  207. <td> const</td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Get the local transform for this shape given the scale of the child shape The total transform of the child shape will be GetLocalTransformNoScale(inScale) * Mat44::sScaling(TransformScale(inScale)) </p><dl class="params"><dt>Parameters</dt><dd>
  217. <table class="params">
  218. <tr><td class="paramname">inScale</td><td>The scale of the child shape (in local space of this shape) </td></tr>
  219. </table>
  220. </dd>
  221. </dl>
  222. </div>
  223. </div>
  224. <a id="ac3fea8705474011f4f5681c18fcdaaa2" name="ac3fea8705474011f4f5681c18fcdaaa2"></a>
  225. <h2 class="memtitle"><span class="permalink"><a href="#ac3fea8705474011f4f5681c18fcdaaa2">&#9670;&#160;</a></span>GetPositionCOM()</h2>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="mlabels">
  229. <tr>
  230. <td class="mlabels-left">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">JPH_INLINE <a class="el" href="class_vec3.html">Vec3</a> CompoundShape::SubShape::GetPositionCOM </td>
  234. <td>(</td>
  235. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  236. <td> const</td>
  237. </tr>
  238. </table>
  239. </td>
  240. <td class="mlabels-right">
  241. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Uncompress the center of mass position. </p>
  246. </div>
  247. </div>
  248. <a id="a13d700b0e7064e9ecdf99afdc0262eae" name="a13d700b0e7064e9ecdf99afdc0262eae"></a>
  249. <h2 class="memtitle"><span class="permalink"><a href="#a13d700b0e7064e9ecdf99afdc0262eae">&#9670;&#160;</a></span>GetRotation()</h2>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">JPH_INLINE <a class="el" href="class_quat.html">Quat</a> CompoundShape::SubShape::GetRotation </td>
  258. <td>(</td>
  259. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  260. <td> const</td>
  261. </tr>
  262. </table>
  263. </td>
  264. <td class="mlabels-right">
  265. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <p>Uncompress the rotation. </p>
  270. </div>
  271. </div>
  272. <a id="a33448959f96311ef875a912b8a104dcf" name="a33448959f96311ef875a912b8a104dcf"></a>
  273. <h2 class="memtitle"><span class="permalink"><a href="#a33448959f96311ef875a912b8a104dcf">&#9670;&#160;</a></span>IsValidScale()</h2>
  274. <div class="memitem">
  275. <div class="memproto">
  276. <table class="mlabels">
  277. <tr>
  278. <td class="mlabels-left">
  279. <table class="memname">
  280. <tr>
  281. <td class="memname">bool CompoundShape::SubShape::IsValidScale </td>
  282. <td>(</td>
  283. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  284. <td> const</td>
  285. </tr>
  286. </table>
  287. </td>
  288. <td class="mlabels-right">
  289. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>Test if inScale is valid for this sub shape. </p>
  294. </div>
  295. </div>
  296. <a id="ad02db108fee2f4caeb4d2709a4f14671" name="ad02db108fee2f4caeb4d2709a4f14671"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#ad02db108fee2f4caeb4d2709a4f14671">&#9670;&#160;</a></span>SetPositionCOM()</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">JPH_INLINE void CompoundShape::SubShape::SetPositionCOM </td>
  306. <td>(</td>
  307. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inPositionCOM</em></span></td><td>)</td>
  308. <td></td>
  309. </tr>
  310. </table>
  311. </td>
  312. <td class="mlabels-right">
  313. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Compress the center of mass position. </p>
  318. </div>
  319. </div>
  320. <a id="aeb79df4468aca72a42c1c8dd68f564c1" name="aeb79df4468aca72a42c1c8dd68f564c1"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#aeb79df4468aca72a42c1c8dd68f564c1">&#9670;&#160;</a></span>SetRotation()</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">JPH_INLINE void CompoundShape::SubShape::SetRotation </td>
  330. <td>(</td>
  331. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inRotation</em></span></td><td>)</td>
  332. <td></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. <p>Compress the rotation. </p>
  342. </div>
  343. </div>
  344. <a id="a3805d809932e3f0d94a3b87e297a47bc" name="a3805d809932e3f0d94a3b87e297a47bc"></a>
  345. <h2 class="memtitle"><span class="permalink"><a href="#a3805d809932e3f0d94a3b87e297a47bc">&#9670;&#160;</a></span>SetTransform()</h2>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="mlabels">
  349. <tr>
  350. <td class="mlabels-left">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">JPH_INLINE void CompoundShape::SubShape::SetTransform </td>
  354. <td>(</td>
  355. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inPosition</em></span>, </td>
  356. </tr>
  357. <tr>
  358. <td class="paramkey"></td>
  359. <td></td>
  360. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inRotation</em></span>, </td>
  361. </tr>
  362. <tr>
  363. <td class="paramkey"></td>
  364. <td></td>
  365. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inCenterOfMass</em></span>&#160;)</td>
  366. </tr>
  367. </table>
  368. </td>
  369. <td class="mlabels-right">
  370. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <p>Update the transform of this sub shape </p><dl class="params"><dt>Parameters</dt><dd>
  375. <table class="params">
  376. <tr><td class="paramname">inPosition</td><td>New position </td></tr>
  377. <tr><td class="paramname">inRotation</td><td>New orientation </td></tr>
  378. <tr><td class="paramname">inCenterOfMass</td><td>The center of mass of the compound shape </td></tr>
  379. </table>
  380. </dd>
  381. </dl>
  382. </div>
  383. </div>
  384. <a id="a92de7326e077355d680f2d6ce860d7fc" name="a92de7326e077355d680f2d6ce860d7fc"></a>
  385. <h2 class="memtitle"><span class="permalink"><a href="#a92de7326e077355d680f2d6ce860d7fc">&#9670;&#160;</a></span>TransformScale()</h2>
  386. <div class="memitem">
  387. <div class="memproto">
  388. <table class="mlabels">
  389. <tr>
  390. <td class="mlabels-left">
  391. <table class="memname">
  392. <tr>
  393. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CompoundShape::SubShape::TransformScale </td>
  394. <td>(</td>
  395. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inScale</em></span></td><td>)</td>
  396. <td> const</td>
  397. </tr>
  398. </table>
  399. </td>
  400. <td class="mlabels-right">
  401. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. <p>Transform the scale to the local space of the child shape. </p>
  406. </div>
  407. </div>
  408. <h2 class="groupheader">Member Data Documentation</h2>
  409. <a id="a25c797febba76594f53b5303867fe0fb" name="a25c797febba76594f53b5303867fe0fb"></a>
  410. <h2 class="memtitle"><span class="permalink"><a href="#a25c797febba76594f53b5303867fe0fb">&#9670;&#160;</a></span>mIsRotationIdentity</h2>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">bool CompoundShape::SubShape::mIsRotationIdentity</td>
  416. </tr>
  417. </table>
  418. </div><div class="memdoc">
  419. <p>If mRotation is close to identity (put here because it falls in padding bytes) </p>
  420. </div>
  421. </div>
  422. <a id="a16bb59f7313e95ee322d576f5d2d85a7" name="a16bb59f7313e95ee322d576f5d2d85a7"></a>
  423. <h2 class="memtitle"><span class="permalink"><a href="#a16bb59f7313e95ee322d576f5d2d85a7">&#9670;&#160;</a></span>mPositionCOM</h2>
  424. <div class="memitem">
  425. <div class="memproto">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname"><a class="el" href="class_float3.html">Float3</a> CompoundShape::SubShape::mPositionCOM</td>
  429. </tr>
  430. </table>
  431. </div><div class="memdoc">
  432. <p>Note: Position of center of mass of sub shape! </p>
  433. </div>
  434. </div>
  435. <a id="a42a1dc09f0d3bd15367f87d26452bd44" name="a42a1dc09f0d3bd15367f87d26452bd44"></a>
  436. <h2 class="memtitle"><span class="permalink"><a href="#a42a1dc09f0d3bd15367f87d26452bd44">&#9670;&#160;</a></span>mRotation</h2>
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname"><a class="el" href="class_float3.html">Float3</a> CompoundShape::SubShape::mRotation</td>
  442. </tr>
  443. </table>
  444. </div><div class="memdoc">
  445. <p>Note: X, Y, Z of rotation quaternion - note we read 4 bytes beyond this so make sure there's something there. </p>
  446. </div>
  447. </div>
  448. <a id="af0e288762fbe4fcdec676ce1836d5375" name="af0e288762fbe4fcdec676ce1836d5375"></a>
  449. <h2 class="memtitle"><span class="permalink"><a href="#af0e288762fbe4fcdec676ce1836d5375">&#9670;&#160;</a></span>mShape</h2>
  450. <div class="memitem">
  451. <div class="memproto">
  452. <table class="memname">
  453. <tr>
  454. <td class="memname"><a class="el" href="class_ref_const.html">RefConst</a>&lt;<a class="el" href="class_shape.html">Shape</a>&gt; CompoundShape::SubShape::mShape</td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. </div>
  459. </div>
  460. <a id="a8528ca1f6ee3908b418283517762bd57" name="a8528ca1f6ee3908b418283517762bd57"></a>
  461. <h2 class="memtitle"><span class="permalink"><a href="#a8528ca1f6ee3908b418283517762bd57">&#9670;&#160;</a></span>mUserData</h2>
  462. <div class="memitem">
  463. <div class="memproto">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> CompoundShape::SubShape::mUserData</td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>User data value (put here because it falls in padding bytes) </p>
  471. </div>
  472. </div>
  473. <hr/>The documentation for this struct was generated from the following file:<ul>
  474. <li>Jolt/Physics/Collision/Shape/<a class="el" href="_compound_shape_8h_source.html">CompoundShape.h</a></li>
  475. </ul>
  476. </div><!-- contents -->
  477. </div><!-- doc-content -->
  478. <!-- start footer part -->
  479. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  480. <ul>
  481. <li class="navelem"><a class="el" href="class_compound_shape.html">CompoundShape</a></li><li class="navelem"><a class="el" href="struct_compound_shape_1_1_sub_shape.html">SubShape</a></li>
  482. <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>
  483. </ul>
  484. </div>
  485. </body>
  486. </html>