class_swing_twist_constraint_part.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877
  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: SwingTwistConstraintPart 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_swing_twist_constraint_part.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-static-methods">Static Public Member Functions</a> &#124;
  109. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  110. <a href="class_swing_twist_constraint_part-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">SwingTwistConstraintPart Class Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p><code>#include &lt;<a class="el" href="_swing_twist_constraint_part_8h_source.html">SwingTwistConstraintPart.h</a>&gt;</code></p>
  115. <table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  117. Public Member Functions</h2></td></tr>
  118. <tr class="memitem:a848425a649ffd87b994ea1efe3cf9944" id="r_a848425a649ffd87b994ea1efe3cf9944"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a848425a649ffd87b994ea1efe3cf9944">SetSwingType</a> (<a class="el" href="_swing_twist_constraint_part_8h.html#add9e89df628b33308461ef46e1b796b6">ESwingType</a> inSwingType)</td></tr>
  119. <tr class="memdesc:a848425a649ffd87b994ea1efe3cf9944"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override the swing type. <br /></td></tr>
  120. <tr class="separator:a848425a649ffd87b994ea1efe3cf9944"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a1e8cca76a13bf4490e18086adfe44fb5" id="r_a1e8cca76a13bf4490e18086adfe44fb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_swing_twist_constraint_part_8h.html#add9e89df628b33308461ef46e1b796b6">ESwingType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e8cca76a13bf4490e18086adfe44fb5">GetSwingType</a> () const</td></tr>
  122. <tr class="memdesc:a1e8cca76a13bf4490e18086adfe44fb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the swing type for this part. <br /></td></tr>
  123. <tr class="separator:a1e8cca76a13bf4490e18086adfe44fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:aad526f8386b3e605f88fddf583ec215b" id="r_aad526f8386b3e605f88fddf583ec215b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aad526f8386b3e605f88fddf583ec215b">SetLimits</a> (float inTwistMinAngle, float inTwistMaxAngle, float inSwingYMinAngle, float inSwingYMaxAngle, float inSwingZMinAngle, float inSwingZMaxAngle)</td></tr>
  125. <tr class="memdesc:aad526f8386b3e605f88fddf583ec215b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set limits for this constraint (see description above for parameters) <br /></td></tr>
  126. <tr class="separator:aad526f8386b3e605f88fddf583ec215b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a63a4870b93b5bb0d90555edbacbf5229" id="r_a63a4870b93b5bb0d90555edbacbf5229"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a63a4870b93b5bb0d90555edbacbf5229">ClampSwingTwist</a> (<a class="el" href="class_quat.html">Quat</a> &amp;ioSwing, <a class="el" href="class_quat.html">Quat</a> &amp;ioTwist, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;outClampedAxis) const</td></tr>
  128. <tr class="memdesc:a63a4870b93b5bb0d90555edbacbf5229"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clamp twist and swing against the constraint limits, returns which parts were clamped (everything assumed in constraint space) <br /></td></tr>
  129. <tr class="separator:a63a4870b93b5bb0d90555edbacbf5229"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:aaf0e7de8bc6c556f7d1a1d2ef4c32317" id="r_aaf0e7de8bc6c556f7d1a1d2ef4c32317"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf0e7de8bc6c556f7d1a1d2ef4c32317">CalculateConstraintProperties</a> (const <a class="el" href="class_body.html">Body</a> &amp;inBody1, const <a class="el" href="class_body.html">Body</a> &amp;inBody2, <a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inConstraintRotation, <a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inConstraintToWorld)</td></tr>
  131. <tr class="separator:aaf0e7de8bc6c556f7d1a1d2ef4c32317"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ae76162c3dfe72782a020162752a7ccf5" id="r_ae76162c3dfe72782a020162752a7ccf5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae76162c3dfe72782a020162752a7ccf5">Deactivate</a> ()</td></tr>
  133. <tr class="memdesc:ae76162c3dfe72782a020162752a7ccf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivate this constraint. <br /></td></tr>
  134. <tr class="separator:ae76162c3dfe72782a020162752a7ccf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:af3c12b4e902bc93120df5ec5a706de99" id="r_af3c12b4e902bc93120df5ec5a706de99"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af3c12b4e902bc93120df5ec5a706de99">IsActive</a> () const</td></tr>
  136. <tr class="memdesc:af3c12b4e902bc93120df5ec5a706de99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if constraint is active. <br /></td></tr>
  137. <tr class="separator:af3c12b4e902bc93120df5ec5a706de99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a507f0506fd29b63f244e73670d85d55d" id="r_a507f0506fd29b63f244e73670d85d55d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a507f0506fd29b63f244e73670d85d55d">WarmStart</a> (<a class="el" href="class_body.html">Body</a> &amp;ioBody1, <a class="el" href="class_body.html">Body</a> &amp;ioBody2, float inWarmStartImpulseRatio)</td></tr>
  139. <tr class="memdesc:a507f0506fd29b63f244e73670d85d55d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Must be called from the WarmStartVelocityConstraint call to apply the previous frame's impulses. <br /></td></tr>
  140. <tr class="separator:a507f0506fd29b63f244e73670d85d55d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:ad62155a6ac18bfc95a038b72df927e02" id="r_ad62155a6ac18bfc95a038b72df927e02"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad62155a6ac18bfc95a038b72df927e02">SolveVelocityConstraint</a> (<a class="el" href="class_body.html">Body</a> &amp;ioBody1, <a class="el" href="class_body.html">Body</a> &amp;ioBody2)</td></tr>
  142. <tr class="memdesc:ad62155a6ac18bfc95a038b72df927e02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iteratively update the velocity constraint. Makes sure d/dt C(...) = 0, where C is the constraint equation. <br /></td></tr>
  143. <tr class="separator:ad62155a6ac18bfc95a038b72df927e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ae8a947eca657db9a653b0d3de921e7c1" id="r_ae8a947eca657db9a653b0d3de921e7c1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8a947eca657db9a653b0d3de921e7c1">SolvePositionConstraint</a> (<a class="el" href="class_body.html">Body</a> &amp;ioBody1, <a class="el" href="class_body.html">Body</a> &amp;ioBody2, <a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inConstraintRotation, <a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inConstraintToBody1, <a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a> inConstraintToBody2, float inBaumgarte) const</td></tr>
  145. <tr class="separator:ae8a947eca657db9a653b0d3de921e7c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a16832ee912d335e0865e78f37fe7ad81" id="r_a16832ee912d335e0865e78f37fe7ad81"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a16832ee912d335e0865e78f37fe7ad81">GetTotalSwingYLambda</a> () const</td></tr>
  147. <tr class="memdesc:a16832ee912d335e0865e78f37fe7ad81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return lagrange multiplier for swing. <br /></td></tr>
  148. <tr class="separator:a16832ee912d335e0865e78f37fe7ad81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a31a518f141eab3f601906193d7b56ada" id="r_a31a518f141eab3f601906193d7b56ada"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a31a518f141eab3f601906193d7b56ada">GetTotalSwingZLambda</a> () const</td></tr>
  150. <tr class="separator:a31a518f141eab3f601906193d7b56ada"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a45a880db0765176f7e807f4aba08da6e" id="r_a45a880db0765176f7e807f4aba08da6e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a45a880db0765176f7e807f4aba08da6e">GetTotalTwistLambda</a> () const</td></tr>
  152. <tr class="memdesc:a45a880db0765176f7e807f4aba08da6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return lagrange multiplier for twist. <br /></td></tr>
  153. <tr class="separator:a45a880db0765176f7e807f4aba08da6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a901f23c5450f15ee2c8979776fcdbf15" id="r_a901f23c5450f15ee2c8979776fcdbf15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a901f23c5450f15ee2c8979776fcdbf15">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  155. <tr class="memdesc:a901f23c5450f15ee2c8979776fcdbf15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save state of this constraint part. <br /></td></tr>
  156. <tr class="separator:a901f23c5450f15ee2c8979776fcdbf15"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a2964a0ed18137258a244d1b4926fa290" id="r_a2964a0ed18137258a244d1b4926fa290"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2964a0ed18137258a244d1b4926fa290">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  158. <tr class="memdesc:a2964a0ed18137258a244d1b4926fa290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore state of this constraint part. <br /></td></tr>
  159. <tr class="separator:a2964a0ed18137258a244d1b4926fa290"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. </table><table class="memberdecls">
  161. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  162. Static Public Member Functions</h2></td></tr>
  163. <tr class="memitem:a6588973f6ab2b380c62caaa2d3658f20" id="r_a6588973f6ab2b380c62caaa2d3658f20"><td class="memItemLeft" align="right" valign="top">static JPH_INLINE bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6588973f6ab2b380c62caaa2d3658f20">sDistanceToMinShorter</a> (float inDeltaMin, float inDeltaMax)</td></tr>
  164. <tr class="memdesc:a6588973f6ab2b380c62caaa2d3658f20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to determine if we're clamped against the min or max limit. <br /></td></tr>
  165. <tr class="separator:a6588973f6ab2b380c62caaa2d3658f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. </table><table class="memberdecls">
  167. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  168. Static Public Attributes</h2></td></tr>
  169. <tr class="memitem:a52114d8a17117ba0e7db21c6d65ac317" id="r_a52114d8a17117ba0e7db21c6d65ac317"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a52114d8a17117ba0e7db21c6d65ac317">cClampedTwistMin</a> = 1 &lt;&lt; 0</td></tr>
  170. <tr class="memdesc:a52114d8a17117ba0e7db21c6d65ac317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags to indicate which axis got clamped by ClampSwingTwist. <br /></td></tr>
  171. <tr class="separator:a52114d8a17117ba0e7db21c6d65ac317"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a6b558e5a79ffce7ef3fcc4a10df1c932" id="r_a6b558e5a79ffce7ef3fcc4a10df1c932"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b558e5a79ffce7ef3fcc4a10df1c932">cClampedTwistMax</a> = 1 &lt;&lt; 1</td></tr>
  173. <tr class="separator:a6b558e5a79ffce7ef3fcc4a10df1c932"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a9b80a201af6ea27d2d35b485c88c9b0e" id="r_a9b80a201af6ea27d2d35b485c88c9b0e"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b80a201af6ea27d2d35b485c88c9b0e">cClampedSwingYMin</a> = 1 &lt;&lt; 2</td></tr>
  175. <tr class="separator:a9b80a201af6ea27d2d35b485c88c9b0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a480178e78f7f5c4bd4dd9043bcea0f03" id="r_a480178e78f7f5c4bd4dd9043bcea0f03"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a480178e78f7f5c4bd4dd9043bcea0f03">cClampedSwingYMax</a> = 1 &lt;&lt; 3</td></tr>
  177. <tr class="separator:a480178e78f7f5c4bd4dd9043bcea0f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a808d818a63cd8380799ace91d9a2b94c" id="r_a808d818a63cd8380799ace91d9a2b94c"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a808d818a63cd8380799ace91d9a2b94c">cClampedSwingZMin</a> = 1 &lt;&lt; 4</td></tr>
  179. <tr class="separator:a808d818a63cd8380799ace91d9a2b94c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:ac96e6d6e42458d8ca8d230763c451321" id="r_ac96e6d6e42458d8ca8d230763c451321"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac96e6d6e42458d8ca8d230763c451321">cClampedSwingZMax</a> = 1 &lt;&lt; 5</td></tr>
  181. <tr class="separator:ac96e6d6e42458d8ca8d230763c451321"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. </table>
  183. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  184. <div class="textblock"><p>Quaternion based constraint that decomposes the rotation in constraint space in swing and twist: q = q_swing * q_twist where q_swing.x = 0 and where q_twist.y = q_twist.z = 0</p>
  185. <ul>
  186. <li>Rotation around the twist (x-axis) is within [inTwistMinAngle, inTwistMaxAngle].</li>
  187. <li>Rotation around the swing axis (y and z axis) are limited to an ellipsoid in quaternion space formed by the equation:</li>
  188. </ul>
  189. <p>(q_swing.y / sin(inSwingYHalfAngle / 2))^2 + (q_swing.z / sin(inSwingZHalfAngle / 2))^2 &lt;= 1</p>
  190. <p>Which roughly corresponds to an elliptic cone shape with major axis (inSwingYHalfAngle, inSwingZHalfAngle).</p>
  191. <p>In case inSwingYHalfAngle = 0, the rotation around Y will be constrained to 0 and the rotation around Z will be constrained between [-inSwingZHalfAngle, inSwingZHalfAngle]. Vice versa if inSwingZHalfAngle = 0. </p>
  192. </div><h2 class="groupheader">Member Function Documentation</h2>
  193. <a id="aaf0e7de8bc6c556f7d1a1d2ef4c32317" name="aaf0e7de8bc6c556f7d1a1d2ef4c32317"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#aaf0e7de8bc6c556f7d1a1d2ef4c32317">&#9670;&#160;</a></span>CalculateConstraintProperties()</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="mlabels">
  198. <tr>
  199. <td class="mlabels-left">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">void SwingTwistConstraintPart::CalculateConstraintProperties </td>
  203. <td>(</td>
  204. <td class="paramtype">const <a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inBody1</em></span>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype">const <a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inBody2</em></span>, </td>
  210. </tr>
  211. <tr>
  212. <td class="paramkey"></td>
  213. <td></td>
  214. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inConstraintRotation</em></span>, </td>
  215. </tr>
  216. <tr>
  217. <td class="paramkey"></td>
  218. <td></td>
  219. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inConstraintToWorld</em></span>&#160;)</td>
  220. </tr>
  221. </table>
  222. </td>
  223. <td class="mlabels-right">
  224. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Calculate properties used during the functions below </p><dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <tr><td class="paramname">inBody1</td><td>The first body that this constraint is attached to </td></tr>
  231. <tr><td class="paramname">inBody2</td><td>The second body that this constraint is attached to </td></tr>
  232. <tr><td class="paramname">inConstraintRotation</td><td>The current rotation of the constraint in constraint space </td></tr>
  233. <tr><td class="paramname">inConstraintToWorld</td><td>Rotates from constraint space into world space </td></tr>
  234. </table>
  235. </dd>
  236. </dl>
  237. </div>
  238. </div>
  239. <a id="a63a4870b93b5bb0d90555edbacbf5229" name="a63a4870b93b5bb0d90555edbacbf5229"></a>
  240. <h2 class="memtitle"><span class="permalink"><a href="#a63a4870b93b5bb0d90555edbacbf5229">&#9670;&#160;</a></span>ClampSwingTwist()</h2>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="mlabels">
  244. <tr>
  245. <td class="mlabels-left">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">void SwingTwistConstraintPart::ClampSwingTwist </td>
  249. <td>(</td>
  250. <td class="paramtype"><a class="el" href="class_quat.html">Quat</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioSwing</em></span>, </td>
  251. </tr>
  252. <tr>
  253. <td class="paramkey"></td>
  254. <td></td>
  255. <td class="paramtype"><a class="el" href="class_quat.html">Quat</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioTwist</em></span>, </td>
  256. </tr>
  257. <tr>
  258. <td class="paramkey"></td>
  259. <td></td>
  260. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &amp;</td> <td class="paramname"><span class="paramname"><em>outClampedAxis</em></span>&#160;) 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>Clamp twist and swing against the constraint limits, returns which parts were clamped (everything assumed in constraint space) </p>
  270. </div>
  271. </div>
  272. <a id="ae76162c3dfe72782a020162752a7ccf5" name="ae76162c3dfe72782a020162752a7ccf5"></a>
  273. <h2 class="memtitle"><span class="permalink"><a href="#ae76162c3dfe72782a020162752a7ccf5">&#9670;&#160;</a></span>Deactivate()</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">void SwingTwistConstraintPart::Deactivate </td>
  282. <td>(</td>
  283. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  284. <td></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>Deactivate this constraint. </p>
  294. </div>
  295. </div>
  296. <a id="a1e8cca76a13bf4490e18086adfe44fb5" name="a1e8cca76a13bf4490e18086adfe44fb5"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#a1e8cca76a13bf4490e18086adfe44fb5">&#9670;&#160;</a></span>GetSwingType()</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"><a class="el" href="_swing_twist_constraint_part_8h.html#add9e89df628b33308461ef46e1b796b6">ESwingType</a> SwingTwistConstraintPart::GetSwingType </td>
  306. <td>(</td>
  307. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  308. <td> const</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>Get the swing type for this part. </p>
  318. </div>
  319. </div>
  320. <a id="a16832ee912d335e0865e78f37fe7ad81" name="a16832ee912d335e0865e78f37fe7ad81"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#a16832ee912d335e0865e78f37fe7ad81">&#9670;&#160;</a></span>GetTotalSwingYLambda()</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">float SwingTwistConstraintPart::GetTotalSwingYLambda </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. <p>Return lagrange multiplier for swing. </p>
  342. </div>
  343. </div>
  344. <a id="a31a518f141eab3f601906193d7b56ada" name="a31a518f141eab3f601906193d7b56ada"></a>
  345. <h2 class="memtitle"><span class="permalink"><a href="#a31a518f141eab3f601906193d7b56ada">&#9670;&#160;</a></span>GetTotalSwingZLambda()</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">float SwingTwistConstraintPart::GetTotalSwingZLambda </td>
  354. <td>(</td>
  355. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  356. <td> const</td>
  357. </tr>
  358. </table>
  359. </td>
  360. <td class="mlabels-right">
  361. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. </div>
  366. </div>
  367. <a id="a45a880db0765176f7e807f4aba08da6e" name="a45a880db0765176f7e807f4aba08da6e"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#a45a880db0765176f7e807f4aba08da6e">&#9670;&#160;</a></span>GetTotalTwistLambda()</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="mlabels">
  372. <tr>
  373. <td class="mlabels-left">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">float SwingTwistConstraintPart::GetTotalTwistLambda </td>
  377. <td>(</td>
  378. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  379. <td> const</td>
  380. </tr>
  381. </table>
  382. </td>
  383. <td class="mlabels-right">
  384. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Return lagrange multiplier for twist. </p>
  389. </div>
  390. </div>
  391. <a id="af3c12b4e902bc93120df5ec5a706de99" name="af3c12b4e902bc93120df5ec5a706de99"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#af3c12b4e902bc93120df5ec5a706de99">&#9670;&#160;</a></span>IsActive()</h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="mlabels">
  396. <tr>
  397. <td class="mlabels-left">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">bool SwingTwistConstraintPart::IsActive </td>
  401. <td>(</td>
  402. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  403. <td> const</td>
  404. </tr>
  405. </table>
  406. </td>
  407. <td class="mlabels-right">
  408. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <p>Check if constraint is active. </p>
  413. </div>
  414. </div>
  415. <a id="a2964a0ed18137258a244d1b4926fa290" name="a2964a0ed18137258a244d1b4926fa290"></a>
  416. <h2 class="memtitle"><span class="permalink"><a href="#a2964a0ed18137258a244d1b4926fa290">&#9670;&#160;</a></span>RestoreState()</h2>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="mlabels">
  420. <tr>
  421. <td class="mlabels-left">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname">void SwingTwistConstraintPart::RestoreState </td>
  425. <td>(</td>
  426. <td class="paramtype"><a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  427. <td></td>
  428. </tr>
  429. </table>
  430. </td>
  431. <td class="mlabels-right">
  432. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <p>Restore state of this constraint part. </p>
  437. </div>
  438. </div>
  439. <a id="a901f23c5450f15ee2c8979776fcdbf15" name="a901f23c5450f15ee2c8979776fcdbf15"></a>
  440. <h2 class="memtitle"><span class="permalink"><a href="#a901f23c5450f15ee2c8979776fcdbf15">&#9670;&#160;</a></span>SaveState()</h2>
  441. <div class="memitem">
  442. <div class="memproto">
  443. <table class="mlabels">
  444. <tr>
  445. <td class="mlabels-left">
  446. <table class="memname">
  447. <tr>
  448. <td class="memname">void SwingTwistConstraintPart::SaveState </td>
  449. <td>(</td>
  450. <td class="paramtype"><a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  451. <td> const</td>
  452. </tr>
  453. </table>
  454. </td>
  455. <td class="mlabels-right">
  456. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  457. </tr>
  458. </table>
  459. </div><div class="memdoc">
  460. <p>Save state of this constraint part. </p>
  461. </div>
  462. </div>
  463. <a id="a6588973f6ab2b380c62caaa2d3658f20" name="a6588973f6ab2b380c62caaa2d3658f20"></a>
  464. <h2 class="memtitle"><span class="permalink"><a href="#a6588973f6ab2b380c62caaa2d3658f20">&#9670;&#160;</a></span>sDistanceToMinShorter()</h2>
  465. <div class="memitem">
  466. <div class="memproto">
  467. <table class="mlabels">
  468. <tr>
  469. <td class="mlabels-left">
  470. <table class="memname">
  471. <tr>
  472. <td class="memname">static JPH_INLINE bool SwingTwistConstraintPart::sDistanceToMinShorter </td>
  473. <td>(</td>
  474. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inDeltaMin</em></span>, </td>
  475. </tr>
  476. <tr>
  477. <td class="paramkey"></td>
  478. <td></td>
  479. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inDeltaMax</em></span>&#160;)</td>
  480. </tr>
  481. </table>
  482. </td>
  483. <td class="mlabels-right">
  484. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  485. </tr>
  486. </table>
  487. </div><div class="memdoc">
  488. <p>Helper function to determine if we're clamped against the min or max limit. </p>
  489. </div>
  490. </div>
  491. <a id="aad526f8386b3e605f88fddf583ec215b" name="aad526f8386b3e605f88fddf583ec215b"></a>
  492. <h2 class="memtitle"><span class="permalink"><a href="#aad526f8386b3e605f88fddf583ec215b">&#9670;&#160;</a></span>SetLimits()</h2>
  493. <div class="memitem">
  494. <div class="memproto">
  495. <table class="mlabels">
  496. <tr>
  497. <td class="mlabels-left">
  498. <table class="memname">
  499. <tr>
  500. <td class="memname">void SwingTwistConstraintPart::SetLimits </td>
  501. <td>(</td>
  502. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inTwistMinAngle</em></span>, </td>
  503. </tr>
  504. <tr>
  505. <td class="paramkey"></td>
  506. <td></td>
  507. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inTwistMaxAngle</em></span>, </td>
  508. </tr>
  509. <tr>
  510. <td class="paramkey"></td>
  511. <td></td>
  512. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inSwingYMinAngle</em></span>, </td>
  513. </tr>
  514. <tr>
  515. <td class="paramkey"></td>
  516. <td></td>
  517. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inSwingYMaxAngle</em></span>, </td>
  518. </tr>
  519. <tr>
  520. <td class="paramkey"></td>
  521. <td></td>
  522. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inSwingZMinAngle</em></span>, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inSwingZMaxAngle</em></span>&#160;)</td>
  528. </tr>
  529. </table>
  530. </td>
  531. <td class="mlabels-right">
  532. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  533. </tr>
  534. </table>
  535. </div><div class="memdoc">
  536. <p>Set limits for this constraint (see description above for parameters) </p>
  537. </div>
  538. </div>
  539. <a id="a848425a649ffd87b994ea1efe3cf9944" name="a848425a649ffd87b994ea1efe3cf9944"></a>
  540. <h2 class="memtitle"><span class="permalink"><a href="#a848425a649ffd87b994ea1efe3cf9944">&#9670;&#160;</a></span>SetSwingType()</h2>
  541. <div class="memitem">
  542. <div class="memproto">
  543. <table class="mlabels">
  544. <tr>
  545. <td class="mlabels-left">
  546. <table class="memname">
  547. <tr>
  548. <td class="memname">void SwingTwistConstraintPart::SetSwingType </td>
  549. <td>(</td>
  550. <td class="paramtype"><a class="el" href="_swing_twist_constraint_part_8h.html#add9e89df628b33308461ef46e1b796b6">ESwingType</a></td> <td class="paramname"><span class="paramname"><em>inSwingType</em></span></td><td>)</td>
  551. <td></td>
  552. </tr>
  553. </table>
  554. </td>
  555. <td class="mlabels-right">
  556. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  557. </tr>
  558. </table>
  559. </div><div class="memdoc">
  560. <p>Override the swing type. </p>
  561. </div>
  562. </div>
  563. <a id="ae8a947eca657db9a653b0d3de921e7c1" name="ae8a947eca657db9a653b0d3de921e7c1"></a>
  564. <h2 class="memtitle"><span class="permalink"><a href="#ae8a947eca657db9a653b0d3de921e7c1">&#9670;&#160;</a></span>SolvePositionConstraint()</h2>
  565. <div class="memitem">
  566. <div class="memproto">
  567. <table class="mlabels">
  568. <tr>
  569. <td class="mlabels-left">
  570. <table class="memname">
  571. <tr>
  572. <td class="memname">bool SwingTwistConstraintPart::SolvePositionConstraint </td>
  573. <td>(</td>
  574. <td class="paramtype"><a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioBody1</em></span>, </td>
  575. </tr>
  576. <tr>
  577. <td class="paramkey"></td>
  578. <td></td>
  579. <td class="paramtype"><a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioBody2</em></span>, </td>
  580. </tr>
  581. <tr>
  582. <td class="paramkey"></td>
  583. <td></td>
  584. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inConstraintRotation</em></span>, </td>
  585. </tr>
  586. <tr>
  587. <td class="paramkey"></td>
  588. <td></td>
  589. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inConstraintToBody1</em></span>, </td>
  590. </tr>
  591. <tr>
  592. <td class="paramkey"></td>
  593. <td></td>
  594. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inConstraintToBody2</em></span>, </td>
  595. </tr>
  596. <tr>
  597. <td class="paramkey"></td>
  598. <td></td>
  599. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inBaumgarte</em></span>&#160;) const</td>
  600. </tr>
  601. </table>
  602. </td>
  603. <td class="mlabels-right">
  604. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  605. </tr>
  606. </table>
  607. </div><div class="memdoc">
  608. <p>Iteratively update the position constraint. Makes sure C(...) = 0. </p><dl class="params"><dt>Parameters</dt><dd>
  609. <table class="params">
  610. <tr><td class="paramname">ioBody1</td><td>The first body that this constraint is attached to </td></tr>
  611. <tr><td class="paramname">ioBody2</td><td>The second body that this constraint is attached to </td></tr>
  612. <tr><td class="paramname">inConstraintRotation</td><td>The current rotation of the constraint in constraint space </td></tr>
  613. <tr><td class="paramname">inConstraintToBody1,inConstraintToBody2</td><td>Rotates from constraint space to body 1/2 space </td></tr>
  614. <tr><td class="paramname">inBaumgarte</td><td>Baumgarte constant (fraction of the error to correct) </td></tr>
  615. </table>
  616. </dd>
  617. </dl>
  618. </div>
  619. </div>
  620. <a id="ad62155a6ac18bfc95a038b72df927e02" name="ad62155a6ac18bfc95a038b72df927e02"></a>
  621. <h2 class="memtitle"><span class="permalink"><a href="#ad62155a6ac18bfc95a038b72df927e02">&#9670;&#160;</a></span>SolveVelocityConstraint()</h2>
  622. <div class="memitem">
  623. <div class="memproto">
  624. <table class="mlabels">
  625. <tr>
  626. <td class="mlabels-left">
  627. <table class="memname">
  628. <tr>
  629. <td class="memname">bool SwingTwistConstraintPart::SolveVelocityConstraint </td>
  630. <td>(</td>
  631. <td class="paramtype"><a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioBody1</em></span>, </td>
  632. </tr>
  633. <tr>
  634. <td class="paramkey"></td>
  635. <td></td>
  636. <td class="paramtype"><a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioBody2</em></span>&#160;)</td>
  637. </tr>
  638. </table>
  639. </td>
  640. <td class="mlabels-right">
  641. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  642. </tr>
  643. </table>
  644. </div><div class="memdoc">
  645. <p>Iteratively update the velocity constraint. Makes sure d/dt C(...) = 0, where C is the constraint equation. </p>
  646. </div>
  647. </div>
  648. <a id="a507f0506fd29b63f244e73670d85d55d" name="a507f0506fd29b63f244e73670d85d55d"></a>
  649. <h2 class="memtitle"><span class="permalink"><a href="#a507f0506fd29b63f244e73670d85d55d">&#9670;&#160;</a></span>WarmStart()</h2>
  650. <div class="memitem">
  651. <div class="memproto">
  652. <table class="mlabels">
  653. <tr>
  654. <td class="mlabels-left">
  655. <table class="memname">
  656. <tr>
  657. <td class="memname">void SwingTwistConstraintPart::WarmStart </td>
  658. <td>(</td>
  659. <td class="paramtype"><a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioBody1</em></span>, </td>
  660. </tr>
  661. <tr>
  662. <td class="paramkey"></td>
  663. <td></td>
  664. <td class="paramtype"><a class="el" href="class_body.html">Body</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioBody2</em></span>, </td>
  665. </tr>
  666. <tr>
  667. <td class="paramkey"></td>
  668. <td></td>
  669. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inWarmStartImpulseRatio</em></span>&#160;)</td>
  670. </tr>
  671. </table>
  672. </td>
  673. <td class="mlabels-right">
  674. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  675. </tr>
  676. </table>
  677. </div><div class="memdoc">
  678. <p>Must be called from the WarmStartVelocityConstraint call to apply the previous frame's impulses. </p>
  679. </div>
  680. </div>
  681. <h2 class="groupheader">Member Data Documentation</h2>
  682. <a id="a480178e78f7f5c4bd4dd9043bcea0f03" name="a480178e78f7f5c4bd4dd9043bcea0f03"></a>
  683. <h2 class="memtitle"><span class="permalink"><a href="#a480178e78f7f5c4bd4dd9043bcea0f03">&#9670;&#160;</a></span>cClampedSwingYMax</h2>
  684. <div class="memitem">
  685. <div class="memproto">
  686. <table class="mlabels">
  687. <tr>
  688. <td class="mlabels-left">
  689. <table class="memname">
  690. <tr>
  691. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> SwingTwistConstraintPart::cClampedSwingYMax = 1 &lt;&lt; 3</td>
  692. </tr>
  693. </table>
  694. </td>
  695. <td class="mlabels-right">
  696. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  697. </tr>
  698. </table>
  699. </div><div class="memdoc">
  700. </div>
  701. </div>
  702. <a id="a9b80a201af6ea27d2d35b485c88c9b0e" name="a9b80a201af6ea27d2d35b485c88c9b0e"></a>
  703. <h2 class="memtitle"><span class="permalink"><a href="#a9b80a201af6ea27d2d35b485c88c9b0e">&#9670;&#160;</a></span>cClampedSwingYMin</h2>
  704. <div class="memitem">
  705. <div class="memproto">
  706. <table class="mlabels">
  707. <tr>
  708. <td class="mlabels-left">
  709. <table class="memname">
  710. <tr>
  711. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> SwingTwistConstraintPart::cClampedSwingYMin = 1 &lt;&lt; 2</td>
  712. </tr>
  713. </table>
  714. </td>
  715. <td class="mlabels-right">
  716. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  717. </tr>
  718. </table>
  719. </div><div class="memdoc">
  720. </div>
  721. </div>
  722. <a id="ac96e6d6e42458d8ca8d230763c451321" name="ac96e6d6e42458d8ca8d230763c451321"></a>
  723. <h2 class="memtitle"><span class="permalink"><a href="#ac96e6d6e42458d8ca8d230763c451321">&#9670;&#160;</a></span>cClampedSwingZMax</h2>
  724. <div class="memitem">
  725. <div class="memproto">
  726. <table class="mlabels">
  727. <tr>
  728. <td class="mlabels-left">
  729. <table class="memname">
  730. <tr>
  731. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> SwingTwistConstraintPart::cClampedSwingZMax = 1 &lt;&lt; 5</td>
  732. </tr>
  733. </table>
  734. </td>
  735. <td class="mlabels-right">
  736. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  737. </tr>
  738. </table>
  739. </div><div class="memdoc">
  740. </div>
  741. </div>
  742. <a id="a808d818a63cd8380799ace91d9a2b94c" name="a808d818a63cd8380799ace91d9a2b94c"></a>
  743. <h2 class="memtitle"><span class="permalink"><a href="#a808d818a63cd8380799ace91d9a2b94c">&#9670;&#160;</a></span>cClampedSwingZMin</h2>
  744. <div class="memitem">
  745. <div class="memproto">
  746. <table class="mlabels">
  747. <tr>
  748. <td class="mlabels-left">
  749. <table class="memname">
  750. <tr>
  751. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> SwingTwistConstraintPart::cClampedSwingZMin = 1 &lt;&lt; 4</td>
  752. </tr>
  753. </table>
  754. </td>
  755. <td class="mlabels-right">
  756. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  757. </tr>
  758. </table>
  759. </div><div class="memdoc">
  760. </div>
  761. </div>
  762. <a id="a6b558e5a79ffce7ef3fcc4a10df1c932" name="a6b558e5a79ffce7ef3fcc4a10df1c932"></a>
  763. <h2 class="memtitle"><span class="permalink"><a href="#a6b558e5a79ffce7ef3fcc4a10df1c932">&#9670;&#160;</a></span>cClampedTwistMax</h2>
  764. <div class="memitem">
  765. <div class="memproto">
  766. <table class="mlabels">
  767. <tr>
  768. <td class="mlabels-left">
  769. <table class="memname">
  770. <tr>
  771. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> SwingTwistConstraintPart::cClampedTwistMax = 1 &lt;&lt; 1</td>
  772. </tr>
  773. </table>
  774. </td>
  775. <td class="mlabels-right">
  776. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  777. </tr>
  778. </table>
  779. </div><div class="memdoc">
  780. </div>
  781. </div>
  782. <a id="a52114d8a17117ba0e7db21c6d65ac317" name="a52114d8a17117ba0e7db21c6d65ac317"></a>
  783. <h2 class="memtitle"><span class="permalink"><a href="#a52114d8a17117ba0e7db21c6d65ac317">&#9670;&#160;</a></span>cClampedTwistMin</h2>
  784. <div class="memitem">
  785. <div class="memproto">
  786. <table class="mlabels">
  787. <tr>
  788. <td class="mlabels-left">
  789. <table class="memname">
  790. <tr>
  791. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> SwingTwistConstraintPart::cClampedTwistMin = 1 &lt;&lt; 0</td>
  792. </tr>
  793. </table>
  794. </td>
  795. <td class="mlabels-right">
  796. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  797. </tr>
  798. </table>
  799. </div><div class="memdoc">
  800. <p>Flags to indicate which axis got clamped by ClampSwingTwist. </p>
  801. </div>
  802. </div>
  803. <hr/>The documentation for this class was generated from the following file:<ul>
  804. <li>Jolt/Physics/Constraints/ConstraintPart/<a class="el" href="_swing_twist_constraint_part_8h_source.html">SwingTwistConstraintPart.h</a></li>
  805. </ul>
  806. </div><!-- contents -->
  807. </div><!-- doc-content -->
  808. <!-- start footer part -->
  809. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  810. <ul>
  811. <li class="navelem"><a class="el" href="class_swing_twist_constraint_part.html">SwingTwistConstraintPart</a></li>
  812. <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>
  813. </ul>
  814. </div>
  815. </body>
  816. </html>