class_independent_axis_constraint_part.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587
  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: IndependentAxisConstraintPart 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_independent_axis_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="class_independent_axis_constraint_part-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">IndependentAxisConstraintPart Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p><code>#include &lt;<a class="el" href="_independent_axis_constraint_part_8h_source.html">IndependentAxisConstraintPart.h</a>&gt;</code></p>
  113. <table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  115. Public Member Functions</h2></td></tr>
  116. <tr class="memitem:a0b42c35e39bcfe122954e5a2052dfafd" id="r_a0b42c35e39bcfe122954e5a2052dfafd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0b42c35e39bcfe122954e5a2052dfafd">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#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inR1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inR2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN2, float inRatio)</td></tr>
  117. <tr class="separator:a0b42c35e39bcfe122954e5a2052dfafd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a75a0e94426831c24d9a05022788a33a0" id="r_a75a0e94426831c24d9a05022788a33a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75a0e94426831c24d9a05022788a33a0">Deactivate</a> ()</td></tr>
  119. <tr class="memdesc:a75a0e94426831c24d9a05022788a33a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivate this constraint. <br /></td></tr>
  120. <tr class="separator:a75a0e94426831c24d9a05022788a33a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a564752c8c4a381de55000c66debc8b0f" id="r_a564752c8c4a381de55000c66debc8b0f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a564752c8c4a381de55000c66debc8b0f">IsActive</a> () const</td></tr>
  122. <tr class="memdesc:a564752c8c4a381de55000c66debc8b0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if constraint is active. <br /></td></tr>
  123. <tr class="separator:a564752c8c4a381de55000c66debc8b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a6ec13ff5361ad148d405ee79bbaedc6c" id="r_a6ec13ff5361ad148d405ee79bbaedc6c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6ec13ff5361ad148d405ee79bbaedc6c">WarmStart</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#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN2, float inRatio, float inWarmStartImpulseRatio)</td></tr>
  125. <tr class="separator:a6ec13ff5361ad148d405ee79bbaedc6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a715a99f78d1e0f0cb03752d4279b4d05" id="r_a715a99f78d1e0f0cb03752d4279b4d05"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a715a99f78d1e0f0cb03752d4279b4d05">SolveVelocityConstraint</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#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN2, float inRatio, float inMinLambda, float inMaxLambda)</td></tr>
  127. <tr class="separator:a715a99f78d1e0f0cb03752d4279b4d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a14a6dfff54b12cacff9f4794c5fa4fa8" id="r_a14a6dfff54b12cacff9f4794c5fa4fa8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14a6dfff54b12cacff9f4794c5fa4fa8">GetTotalLambda</a> () const</td></tr>
  129. <tr class="memdesc:a14a6dfff54b12cacff9f4794c5fa4fa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return lagrange multiplier. <br /></td></tr>
  130. <tr class="separator:a14a6dfff54b12cacff9f4794c5fa4fa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a75f7e8a6d760c806d8aadc911965ecce" id="r_a75f7e8a6d760c806d8aadc911965ecce"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75f7e8a6d760c806d8aadc911965ecce">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#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inN2, float inRatio, float inC, float inBaumgarte) const</td></tr>
  132. <tr class="separator:a75f7e8a6d760c806d8aadc911965ecce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a8982c9bb0de919245c5a463880877a32" id="r_a8982c9bb0de919245c5a463880877a32"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8982c9bb0de919245c5a463880877a32">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  134. <tr class="memdesc:a8982c9bb0de919245c5a463880877a32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save state of this constraint part. <br /></td></tr>
  135. <tr class="separator:a8982c9bb0de919245c5a463880877a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a1b5d7adfe5abea0da836a725b91d4f85" id="r_a1b5d7adfe5abea0da836a725b91d4f85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b5d7adfe5abea0da836a725b91d4f85">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  137. <tr class="memdesc:a1b5d7adfe5abea0da836a725b91d4f85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore state of this constraint part. <br /></td></tr>
  138. <tr class="separator:a1b5d7adfe5abea0da836a725b91d4f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table>
  140. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  141. <div class="textblock"><p><a class="el" href="class_constraint.html" title="Base class for all physics constraints. A constraint removes one or more degrees of freedom for a rig...">Constraint</a> part to an <a class="el" href="class_axis_constraint_part.html">AxisConstraintPart</a> but both bodies have an independent axis on which the force is applied.</p>
  142. <p><a class="el" href="class_constraint.html" title="Base class for all physics constraints. A constraint removes one or more degrees of freedom for a rig...">Constraint</a> equation:</p>
  143. <p class="formulaDsp">
  144. \[C = (x_1 + r_1 - f_1) . n_1 + r (x_2 + r_2 - f_2) \cdot n_2\]
  145. </p>
  146. <p>Calculating the Jacobian:</p>
  147. <p class="formulaDsp">
  148. \[dC/dt = (v_1 + w_1 \times r_1) \cdot n_1 + (x_1 + r_1 - f_1) \cdot d n_1/dt + r (v_2 + w_2 \times r_2) \cdot n_2 + r (x_2 + r_2 - f_2) \cdot d n_2/dt\]
  149. </p>
  150. <p>Assuming that d n1/dt and d n2/dt are small this becomes:</p>
  151. <p class="formulaDsp">
  152. \[(v_1 + w_1 \times r_1) \cdot n_1 + r (v_2 + w_2 \times r_2) \cdot n_2\]
  153. </p>
  154. <p class="formulaDsp">
  155. \[= v_1 \cdot n_1 + r_1 \times n_1 \cdot w_1 + r v_2 \cdot n_2 + r r_2 \times n_2 \cdot w_2\]
  156. </p>
  157. <p>Jacobian:</p>
  158. <p class="formulaDsp">
  159. \[J = \begin{bmatrix}n_1 &amp; r_1 \times n_1 &amp; r n_2 &amp; r r_2 \times n_2\end{bmatrix}\]
  160. </p>
  161. <p>Effective mass:</p>
  162. <p class="formulaDsp">
  163. \[K = m_1^{-1} + r_1 \times n_1 I_1^{-1} r_1 \times n_1 + r^2 m_2^{-1} + r^2 r_2 \times n_2 I_2^{-1} r_2 \times n_2\]
  164. </p>
  165. <p>Used terms (here and below, everything in world space):<br />
  166. n1 = (x1 + r1 - f1) / |x1 + r1 - f1|, axis along which the force is applied for body 1<br />
  167. n2 = (x2 + r2 - f2) / |x2 + r2 - f2|, axis along which the force is applied for body 2<br />
  168. r = ratio how forces are applied between bodies.<br />
  169. x1, x2 = center of mass for the bodies.<br />
  170. v = [v1, w1, v2, w2].<br />
  171. v1, v2 = linear velocity of body 1 and 2.<br />
  172. w1, w2 = angular velocity of body 1 and 2.<br />
  173. M = mass matrix, a diagonal matrix of the mass and inertia with diagonal [m1, I1, m2, I2].<br />
  174. \(K^{-1} = \left( J M^{-1} J^T \right)^{-1}\) = effective mass.<br />
  175. b = velocity bias.<br />
  176. \(\beta\) = baumgarte constant. </p>
  177. </div><h2 class="groupheader">Member Function Documentation</h2>
  178. <a id="a0b42c35e39bcfe122954e5a2052dfafd" name="a0b42c35e39bcfe122954e5a2052dfafd"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#a0b42c35e39bcfe122954e5a2052dfafd">&#9670;&#160;</a></span>CalculateConstraintProperties()</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="mlabels">
  183. <tr>
  184. <td class="mlabels-left">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">void IndependentAxisConstraintPart::CalculateConstraintProperties </td>
  188. <td>(</td>
  189. <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>
  190. </tr>
  191. <tr>
  192. <td class="paramkey"></td>
  193. <td></td>
  194. <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>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inR1</em></span>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN1</em></span>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inR2</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#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN2</em></span>, </td>
  215. </tr>
  216. <tr>
  217. <td class="paramkey"></td>
  218. <td></td>
  219. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inRatio</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">inR1</td><td>The position on which the constraint operates on body 1 relative to COM </td></tr>
  233. <tr><td class="paramname">inN1</td><td>The world space normal in which the constraint operates for body 1 </td></tr>
  234. <tr><td class="paramname">inR2</td><td>The position on which the constraint operates on body 1 relative to COM </td></tr>
  235. <tr><td class="paramname">inN2</td><td>The world space normal in which the constraint operates for body 2 </td></tr>
  236. <tr><td class="paramname">inRatio</td><td>The ratio how forces are applied between bodies </td></tr>
  237. </table>
  238. </dd>
  239. </dl>
  240. </div>
  241. </div>
  242. <a id="a75a0e94426831c24d9a05022788a33a0" name="a75a0e94426831c24d9a05022788a33a0"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#a75a0e94426831c24d9a05022788a33a0">&#9670;&#160;</a></span>Deactivate()</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">void IndependentAxisConstraintPart::Deactivate </td>
  252. <td>(</td>
  253. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  254. <td></td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p>Deactivate this constraint. </p>
  264. </div>
  265. </div>
  266. <a id="a14a6dfff54b12cacff9f4794c5fa4fa8" name="a14a6dfff54b12cacff9f4794c5fa4fa8"></a>
  267. <h2 class="memtitle"><span class="permalink"><a href="#a14a6dfff54b12cacff9f4794c5fa4fa8">&#9670;&#160;</a></span>GetTotalLambda()</h2>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="mlabels">
  271. <tr>
  272. <td class="mlabels-left">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname">float IndependentAxisConstraintPart::GetTotalLambda </td>
  276. <td>(</td>
  277. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  278. <td> const</td>
  279. </tr>
  280. </table>
  281. </td>
  282. <td class="mlabels-right">
  283. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Return lagrange multiplier. </p>
  288. </div>
  289. </div>
  290. <a id="a564752c8c4a381de55000c66debc8b0f" name="a564752c8c4a381de55000c66debc8b0f"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#a564752c8c4a381de55000c66debc8b0f">&#9670;&#160;</a></span>IsActive()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">bool IndependentAxisConstraintPart::IsActive </td>
  300. <td>(</td>
  301. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  302. <td> const</td>
  303. </tr>
  304. </table>
  305. </td>
  306. <td class="mlabels-right">
  307. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Check if constraint is active. </p>
  312. </div>
  313. </div>
  314. <a id="a1b5d7adfe5abea0da836a725b91d4f85" name="a1b5d7adfe5abea0da836a725b91d4f85"></a>
  315. <h2 class="memtitle"><span class="permalink"><a href="#a1b5d7adfe5abea0da836a725b91d4f85">&#9670;&#160;</a></span>RestoreState()</h2>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="mlabels">
  319. <tr>
  320. <td class="mlabels-left">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname">void IndependentAxisConstraintPart::RestoreState </td>
  324. <td>(</td>
  325. <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>
  326. <td></td>
  327. </tr>
  328. </table>
  329. </td>
  330. <td class="mlabels-right">
  331. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>Restore state of this constraint part. </p>
  336. </div>
  337. </div>
  338. <a id="a8982c9bb0de919245c5a463880877a32" name="a8982c9bb0de919245c5a463880877a32"></a>
  339. <h2 class="memtitle"><span class="permalink"><a href="#a8982c9bb0de919245c5a463880877a32">&#9670;&#160;</a></span>SaveState()</h2>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="mlabels">
  343. <tr>
  344. <td class="mlabels-left">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname">void IndependentAxisConstraintPart::SaveState </td>
  348. <td>(</td>
  349. <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>
  350. <td> const</td>
  351. </tr>
  352. </table>
  353. </td>
  354. <td class="mlabels-right">
  355. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>Save state of this constraint part. </p>
  360. </div>
  361. </div>
  362. <a id="a75f7e8a6d760c806d8aadc911965ecce" name="a75f7e8a6d760c806d8aadc911965ecce"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#a75f7e8a6d760c806d8aadc911965ecce">&#9670;&#160;</a></span>SolvePositionConstraint()</h2>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="mlabels">
  367. <tr>
  368. <td class="mlabels-left">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">bool IndependentAxisConstraintPart::SolvePositionConstraint </td>
  372. <td>(</td>
  373. <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>
  374. </tr>
  375. <tr>
  376. <td class="paramkey"></td>
  377. <td></td>
  378. <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>
  379. </tr>
  380. <tr>
  381. <td class="paramkey"></td>
  382. <td></td>
  383. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN1</em></span>, </td>
  384. </tr>
  385. <tr>
  386. <td class="paramkey"></td>
  387. <td></td>
  388. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN2</em></span>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inRatio</em></span>, </td>
  394. </tr>
  395. <tr>
  396. <td class="paramkey"></td>
  397. <td></td>
  398. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inC</em></span>, </td>
  399. </tr>
  400. <tr>
  401. <td class="paramkey"></td>
  402. <td></td>
  403. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inBaumgarte</em></span>&#160;) 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>Iteratively update the position constraint. Makes sure C(...) == 0. </p><dl class="params"><dt>Parameters</dt><dd>
  413. <table class="params">
  414. <tr><td class="paramname">ioBody1</td><td>The first body that this constraint is attached to </td></tr>
  415. <tr><td class="paramname">ioBody2</td><td>The second body that this constraint is attached to </td></tr>
  416. <tr><td class="paramname">inN1</td><td>The world space normal in which the constraint operates for body 1 </td></tr>
  417. <tr><td class="paramname">inN2</td><td>The world space normal in which the constraint operates for body 2 </td></tr>
  418. <tr><td class="paramname">inRatio</td><td>The ratio how forces are applied between bodies </td></tr>
  419. <tr><td class="paramname">inC</td><td>Value of the constraint equation (C) </td></tr>
  420. <tr><td class="paramname">inBaumgarte</td><td>Baumgarte constant (fraction of the error to correct) </td></tr>
  421. </table>
  422. </dd>
  423. </dl>
  424. </div>
  425. </div>
  426. <a id="a715a99f78d1e0f0cb03752d4279b4d05" name="a715a99f78d1e0f0cb03752d4279b4d05"></a>
  427. <h2 class="memtitle"><span class="permalink"><a href="#a715a99f78d1e0f0cb03752d4279b4d05">&#9670;&#160;</a></span>SolveVelocityConstraint()</h2>
  428. <div class="memitem">
  429. <div class="memproto">
  430. <table class="mlabels">
  431. <tr>
  432. <td class="mlabels-left">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">bool IndependentAxisConstraintPart::SolveVelocityConstraint </td>
  436. <td>(</td>
  437. <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>
  438. </tr>
  439. <tr>
  440. <td class="paramkey"></td>
  441. <td></td>
  442. <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>
  443. </tr>
  444. <tr>
  445. <td class="paramkey"></td>
  446. <td></td>
  447. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN1</em></span>, </td>
  448. </tr>
  449. <tr>
  450. <td class="paramkey"></td>
  451. <td></td>
  452. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN2</em></span>, </td>
  453. </tr>
  454. <tr>
  455. <td class="paramkey"></td>
  456. <td></td>
  457. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inRatio</em></span>, </td>
  458. </tr>
  459. <tr>
  460. <td class="paramkey"></td>
  461. <td></td>
  462. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMinLambda</em></span>, </td>
  463. </tr>
  464. <tr>
  465. <td class="paramkey"></td>
  466. <td></td>
  467. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMaxLambda</em></span>&#160;)</td>
  468. </tr>
  469. </table>
  470. </td>
  471. <td class="mlabels-right">
  472. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  473. </tr>
  474. </table>
  475. </div><div class="memdoc">
  476. <p>Iteratively update the velocity constraint. Makes sure d/dt C(...) = 0, where C is the constraint equation. </p><dl class="params"><dt>Parameters</dt><dd>
  477. <table class="params">
  478. <tr><td class="paramname">ioBody1</td><td>The first body that this constraint is attached to </td></tr>
  479. <tr><td class="paramname">ioBody2</td><td>The second body that this constraint is attached to </td></tr>
  480. <tr><td class="paramname">inN1</td><td>The world space normal in which the constraint operates for body 1 </td></tr>
  481. <tr><td class="paramname">inN2</td><td>The world space normal in which the constraint operates for body 2 </td></tr>
  482. <tr><td class="paramname">inRatio</td><td>The ratio how forces are applied between bodies </td></tr>
  483. <tr><td class="paramname">inMinLambda</td><td>Minimum angular impulse to apply (N m s) </td></tr>
  484. <tr><td class="paramname">inMaxLambda</td><td>Maximum angular impulse to apply (N m s) </td></tr>
  485. </table>
  486. </dd>
  487. </dl>
  488. </div>
  489. </div>
  490. <a id="a6ec13ff5361ad148d405ee79bbaedc6c" name="a6ec13ff5361ad148d405ee79bbaedc6c"></a>
  491. <h2 class="memtitle"><span class="permalink"><a href="#a6ec13ff5361ad148d405ee79bbaedc6c">&#9670;&#160;</a></span>WarmStart()</h2>
  492. <div class="memitem">
  493. <div class="memproto">
  494. <table class="mlabels">
  495. <tr>
  496. <td class="mlabels-left">
  497. <table class="memname">
  498. <tr>
  499. <td class="memname">void IndependentAxisConstraintPart::WarmStart </td>
  500. <td>(</td>
  501. <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>
  502. </tr>
  503. <tr>
  504. <td class="paramkey"></td>
  505. <td></td>
  506. <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>
  507. </tr>
  508. <tr>
  509. <td class="paramkey"></td>
  510. <td></td>
  511. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN1</em></span>, </td>
  512. </tr>
  513. <tr>
  514. <td class="paramkey"></td>
  515. <td></td>
  516. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inN2</em></span>, </td>
  517. </tr>
  518. <tr>
  519. <td class="paramkey"></td>
  520. <td></td>
  521. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inRatio</em></span>, </td>
  522. </tr>
  523. <tr>
  524. <td class="paramkey"></td>
  525. <td></td>
  526. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inWarmStartImpulseRatio</em></span>&#160;)</td>
  527. </tr>
  528. </table>
  529. </td>
  530. <td class="mlabels-right">
  531. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  532. </tr>
  533. </table>
  534. </div><div class="memdoc">
  535. <p>Must be called from the WarmStartVelocityConstraint call to apply the previous frame's impulses </p><dl class="params"><dt>Parameters</dt><dd>
  536. <table class="params">
  537. <tr><td class="paramname">ioBody1</td><td>The first body that this constraint is attached to </td></tr>
  538. <tr><td class="paramname">ioBody2</td><td>The second body that this constraint is attached to </td></tr>
  539. <tr><td class="paramname">inN1</td><td>The world space normal in which the constraint operates for body 1 </td></tr>
  540. <tr><td class="paramname">inN2</td><td>The world space normal in which the constraint operates for body 2 </td></tr>
  541. <tr><td class="paramname">inRatio</td><td>The ratio how forces are applied between bodies </td></tr>
  542. <tr><td class="paramname">inWarmStartImpulseRatio</td><td>Ratio of new step to old time step (dt_new / dt_old) for scaling the lagrange multiplier of the previous frame </td></tr>
  543. </table>
  544. </dd>
  545. </dl>
  546. </div>
  547. </div>
  548. <hr/>The documentation for this class was generated from the following file:<ul>
  549. <li>Jolt/Physics/Constraints/ConstraintPart/<a class="el" href="_independent_axis_constraint_part_8h_source.html">IndependentAxisConstraintPart.h</a></li>
  550. </ul>
  551. </div><!-- contents -->
  552. </div><!-- doc-content -->
  553. <!-- start footer part -->
  554. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  555. <ul>
  556. <li class="navelem"><a class="el" href="class_independent_axis_constraint_part.html">IndependentAxisConstraintPart</a></li>
  557. <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>
  558. </ul>
  559. </div>
  560. </body>
  561. </html>