class_point_constraint_part.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499
  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: PointConstraintPart 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_point_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_point_constraint_part-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">PointConstraintPart Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p><code>#include &lt;<a class="el" href="_point_constraint_part_8h_source.html">PointConstraintPart.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:abd3afc9ccf62aea6e07029b35d718a75" id="r_abd3afc9ccf62aea6e07029b35d718a75"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd3afc9ccf62aea6e07029b35d718a75">CalculateConstraintProperties</a> (const <a class="el" href="class_body.html">Body</a> &amp;inBody1, <a class="el" href="_math_types_8h.html#af10dd31c5ad4acb62aba8025732597e6">Mat44Arg</a> inRotation1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inR1, const <a class="el" href="class_body.html">Body</a> &amp;inBody2, <a class="el" href="_math_types_8h.html#af10dd31c5ad4acb62aba8025732597e6">Mat44Arg</a> inRotation2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inR2)</td></tr>
  117. <tr class="separator:abd3afc9ccf62aea6e07029b35d718a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a79eddd21eea247c5560ab8208a627019" id="r_a79eddd21eea247c5560ab8208a627019"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a79eddd21eea247c5560ab8208a627019">Deactivate</a> ()</td></tr>
  119. <tr class="memdesc:a79eddd21eea247c5560ab8208a627019"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivate this constraint. <br /></td></tr>
  120. <tr class="separator:a79eddd21eea247c5560ab8208a627019"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a9b183e233b8fc258ab72f447499c5ad8" id="r_a9b183e233b8fc258ab72f447499c5ad8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b183e233b8fc258ab72f447499c5ad8">IsActive</a> () const</td></tr>
  122. <tr class="memdesc:a9b183e233b8fc258ab72f447499c5ad8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if constraint is active. <br /></td></tr>
  123. <tr class="separator:a9b183e233b8fc258ab72f447499c5ad8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a5d4d5fcf514dd0d2ea3b26e2071ee75e" id="r_a5d4d5fcf514dd0d2ea3b26e2071ee75e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d4d5fcf514dd0d2ea3b26e2071ee75e">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>
  125. <tr class="separator:a5d4d5fcf514dd0d2ea3b26e2071ee75e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a217800970665e456d24664aad0b860a6" id="r_a217800970665e456d24664aad0b860a6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a217800970665e456d24664aad0b860a6">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>
  127. <tr class="separator:a217800970665e456d24664aad0b860a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a123b2fd3e83ea307dfd8a946f6b7a449" id="r_a123b2fd3e83ea307dfd8a946f6b7a449"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a123b2fd3e83ea307dfd8a946f6b7a449">SolvePositionConstraint</a> (<a class="el" href="class_body.html">Body</a> &amp;ioBody1, <a class="el" href="class_body.html">Body</a> &amp;ioBody2, float inBaumgarte) const</td></tr>
  129. <tr class="separator:a123b2fd3e83ea307dfd8a946f6b7a449"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a268ba07c6a229a0b8d2c3504566c355d" id="r_a268ba07c6a229a0b8d2c3504566c355d"><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="#a268ba07c6a229a0b8d2c3504566c355d">GetTotalLambda</a> () const</td></tr>
  131. <tr class="memdesc:a268ba07c6a229a0b8d2c3504566c355d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return lagrange multiplier. <br /></td></tr>
  132. <tr class="separator:a268ba07c6a229a0b8d2c3504566c355d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:ae6cd6fa33d18b3f7123a2a093a976257" id="r_ae6cd6fa33d18b3f7123a2a093a976257"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6cd6fa33d18b3f7123a2a093a976257">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  134. <tr class="memdesc:ae6cd6fa33d18b3f7123a2a093a976257"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save state of this constraint part. <br /></td></tr>
  135. <tr class="separator:ae6cd6fa33d18b3f7123a2a093a976257"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a019489117b367decab440da408e316b8" id="r_a019489117b367decab440da408e316b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a019489117b367decab440da408e316b8">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  137. <tr class="memdesc:a019489117b367decab440da408e316b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore state of this constraint part. <br /></td></tr>
  138. <tr class="separator:a019489117b367decab440da408e316b8"><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>Constrains movement along 3 axis</p>
  142. <dl class="section see"><dt>See also</dt><dd>"Constraints Derivation for Rigid Body Simulation in 3D" - Daniel Chappuis, section 2.2.1</dd></dl>
  143. <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 (eq 45):</p>
  144. <p class="formulaDsp">
  145. \[C = p_2 - p_1\]
  146. </p>
  147. <p>Jacobian (transposed) (eq 47):</p>
  148. <p class="formulaDsp">
  149. \[J^T = \begin{bmatrix}-E &amp; r1x &amp; E &amp; -r2x^T\end{bmatrix}
  150. = \begin{bmatrix}-E^T \\ r1x^T \\ E^T \\ -r2x^T\end{bmatrix}
  151. = \begin{bmatrix}-E \\ -r1x \\ E \\ r2x\end{bmatrix}\]
  152. </p>
  153. <p>Used terms (here and below, everything in world space):<br />
  154. p1, p2 = constraint points.<br />
  155. r1 = p1 - x1.<br />
  156. r2 = p2 - x2.<br />
  157. r1x = 3x3 matrix for which r1x v = r1 x v (cross product).<br />
  158. x1, x2 = center of mass for the bodies.<br />
  159. v = [v1, w1, v2, w2].<br />
  160. v1, v2 = linear velocity of body 1 and 2.<br />
  161. w1, w2 = angular velocity of body 1 and 2.<br />
  162. M = mass matrix, a diagonal matrix of the mass and inertia with diagonal [m1, I1, m2, I2].<br />
  163. \(K^{-1} = \left( J M^{-1} J^T \right)^{-1}\) = effective mass.<br />
  164. b = velocity bias.<br />
  165. \(\beta\) = baumgarte constant.<br />
  166. E = identity matrix. </p>
  167. </div><h2 class="groupheader">Member Function Documentation</h2>
  168. <a id="abd3afc9ccf62aea6e07029b35d718a75" name="abd3afc9ccf62aea6e07029b35d718a75"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#abd3afc9ccf62aea6e07029b35d718a75">&#9670;&#160;</a></span>CalculateConstraintProperties()</h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname">void PointConstraintPart::CalculateConstraintProperties </td>
  178. <td>(</td>
  179. <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>
  180. </tr>
  181. <tr>
  182. <td class="paramkey"></td>
  183. <td></td>
  184. <td class="paramtype"><a class="el" href="_math_types_8h.html#af10dd31c5ad4acb62aba8025732597e6">Mat44Arg</a></td> <td class="paramname"><span class="paramname"><em>inRotation1</em></span>, </td>
  185. </tr>
  186. <tr>
  187. <td class="paramkey"></td>
  188. <td></td>
  189. <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>
  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#af10dd31c5ad4acb62aba8025732597e6">Mat44Arg</a></td> <td class="paramname"><span class="paramname"><em>inRotation2</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>inR2</em></span>&#160;)</td>
  205. </tr>
  206. </table>
  207. </td>
  208. <td class="mlabels-right">
  209. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Calculate properties used during the functions below </p><dl class="params"><dt>Parameters</dt><dd>
  214. <table class="params">
  215. <tr><td class="paramname">inBody1</td><td>The first body that this constraint is attached to </td></tr>
  216. <tr><td class="paramname">inBody2</td><td>The second body that this constraint is attached to </td></tr>
  217. <tr><td class="paramname">inRotation1</td><td>The 3x3 rotation matrix for body 1 (translation part is ignored) </td></tr>
  218. <tr><td class="paramname">inRotation2</td><td>The 3x3 rotation matrix for body 2 (translation part is ignored) </td></tr>
  219. <tr><td class="paramname">inR1</td><td>Local space vector from center of mass to constraint point for body 1 </td></tr>
  220. <tr><td class="paramname">inR2</td><td>Local space vector from center of mass to constraint point for body 2 </td></tr>
  221. </table>
  222. </dd>
  223. </dl>
  224. </div>
  225. </div>
  226. <a id="a79eddd21eea247c5560ab8208a627019" name="a79eddd21eea247c5560ab8208a627019"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#a79eddd21eea247c5560ab8208a627019">&#9670;&#160;</a></span>Deactivate()</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="mlabels">
  231. <tr>
  232. <td class="mlabels-left">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">void PointConstraintPart::Deactivate </td>
  236. <td>(</td>
  237. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Deactivate this constraint. </p>
  248. </div>
  249. </div>
  250. <a id="a268ba07c6a229a0b8d2c3504566c355d" name="a268ba07c6a229a0b8d2c3504566c355d"></a>
  251. <h2 class="memtitle"><span class="permalink"><a href="#a268ba07c6a229a0b8d2c3504566c355d">&#9670;&#160;</a></span>GetTotalLambda()</h2>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="mlabels">
  255. <tr>
  256. <td class="mlabels-left">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> PointConstraintPart::GetTotalLambda </td>
  260. <td>(</td>
  261. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  262. <td> const</td>
  263. </tr>
  264. </table>
  265. </td>
  266. <td class="mlabels-right">
  267. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Return lagrange multiplier. </p>
  272. </div>
  273. </div>
  274. <a id="a9b183e233b8fc258ab72f447499c5ad8" name="a9b183e233b8fc258ab72f447499c5ad8"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#a9b183e233b8fc258ab72f447499c5ad8">&#9670;&#160;</a></span>IsActive()</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="mlabels">
  279. <tr>
  280. <td class="mlabels-left">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">bool PointConstraintPart::IsActive </td>
  284. <td>(</td>
  285. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  286. <td> const</td>
  287. </tr>
  288. </table>
  289. </td>
  290. <td class="mlabels-right">
  291. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Check if constraint is active. </p>
  296. </div>
  297. </div>
  298. <a id="a019489117b367decab440da408e316b8" name="a019489117b367decab440da408e316b8"></a>
  299. <h2 class="memtitle"><span class="permalink"><a href="#a019489117b367decab440da408e316b8">&#9670;&#160;</a></span>RestoreState()</h2>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="mlabels">
  303. <tr>
  304. <td class="mlabels-left">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">void PointConstraintPart::RestoreState </td>
  308. <td>(</td>
  309. <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>
  310. <td></td>
  311. </tr>
  312. </table>
  313. </td>
  314. <td class="mlabels-right">
  315. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Restore state of this constraint part. </p>
  320. </div>
  321. </div>
  322. <a id="ae6cd6fa33d18b3f7123a2a093a976257" name="ae6cd6fa33d18b3f7123a2a093a976257"></a>
  323. <h2 class="memtitle"><span class="permalink"><a href="#ae6cd6fa33d18b3f7123a2a093a976257">&#9670;&#160;</a></span>SaveState()</h2>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="mlabels">
  327. <tr>
  328. <td class="mlabels-left">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">void PointConstraintPart::SaveState </td>
  332. <td>(</td>
  333. <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>
  334. <td> const</td>
  335. </tr>
  336. </table>
  337. </td>
  338. <td class="mlabels-right">
  339. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Save state of this constraint part. </p>
  344. </div>
  345. </div>
  346. <a id="a123b2fd3e83ea307dfd8a946f6b7a449" name="a123b2fd3e83ea307dfd8a946f6b7a449"></a>
  347. <h2 class="memtitle"><span class="permalink"><a href="#a123b2fd3e83ea307dfd8a946f6b7a449">&#9670;&#160;</a></span>SolvePositionConstraint()</h2>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="mlabels">
  351. <tr>
  352. <td class="mlabels-left">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">bool PointConstraintPart::SolvePositionConstraint </td>
  356. <td>(</td>
  357. <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>
  358. </tr>
  359. <tr>
  360. <td class="paramkey"></td>
  361. <td></td>
  362. <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>
  363. </tr>
  364. <tr>
  365. <td class="paramkey"></td>
  366. <td></td>
  367. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inBaumgarte</em></span>&#160;) const</td>
  368. </tr>
  369. </table>
  370. </td>
  371. <td class="mlabels-right">
  372. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>Iteratively update the position constraint. Makes sure C(...) = 0. </p><dl class="params"><dt>Parameters</dt><dd>
  377. <table class="params">
  378. <tr><td class="paramname">ioBody1</td><td>The first body that this constraint is attached to </td></tr>
  379. <tr><td class="paramname">ioBody2</td><td>The second body that this constraint is attached to </td></tr>
  380. <tr><td class="paramname">inBaumgarte</td><td>Baumgarte constant (fraction of the error to correct) </td></tr>
  381. </table>
  382. </dd>
  383. </dl>
  384. </div>
  385. </div>
  386. <a id="a217800970665e456d24664aad0b860a6" name="a217800970665e456d24664aad0b860a6"></a>
  387. <h2 class="memtitle"><span class="permalink"><a href="#a217800970665e456d24664aad0b860a6">&#9670;&#160;</a></span>SolveVelocityConstraint()</h2>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="mlabels">
  391. <tr>
  392. <td class="mlabels-left">
  393. <table class="memname">
  394. <tr>
  395. <td class="memname">bool PointConstraintPart::SolveVelocityConstraint </td>
  396. <td>(</td>
  397. <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>
  398. </tr>
  399. <tr>
  400. <td class="paramkey"></td>
  401. <td></td>
  402. <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>
  403. </tr>
  404. </table>
  405. </td>
  406. <td class="mlabels-right">
  407. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. <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>
  412. <table class="params">
  413. <tr><td class="paramname">ioBody1</td><td>The first body that this constraint is attached to </td></tr>
  414. <tr><td class="paramname">ioBody2</td><td>The second body that this constraint is attached to </td></tr>
  415. </table>
  416. </dd>
  417. </dl>
  418. </div>
  419. </div>
  420. <a id="a5d4d5fcf514dd0d2ea3b26e2071ee75e" name="a5d4d5fcf514dd0d2ea3b26e2071ee75e"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#a5d4d5fcf514dd0d2ea3b26e2071ee75e">&#9670;&#160;</a></span>WarmStart()</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="mlabels">
  425. <tr>
  426. <td class="mlabels-left">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">void PointConstraintPart::WarmStart </td>
  430. <td>(</td>
  431. <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>
  432. </tr>
  433. <tr>
  434. <td class="paramkey"></td>
  435. <td></td>
  436. <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>
  437. </tr>
  438. <tr>
  439. <td class="paramkey"></td>
  440. <td></td>
  441. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inWarmStartImpulseRatio</em></span>&#160;)</td>
  442. </tr>
  443. </table>
  444. </td>
  445. <td class="mlabels-right">
  446. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  447. </tr>
  448. </table>
  449. </div><div class="memdoc">
  450. <p>Must be called from the WarmStartVelocityConstraint call to apply the previous frame's impulses </p><dl class="params"><dt>Parameters</dt><dd>
  451. <table class="params">
  452. <tr><td class="paramname">ioBody1</td><td>The first body that this constraint is attached to </td></tr>
  453. <tr><td class="paramname">ioBody2</td><td>The second body that this constraint is attached to </td></tr>
  454. <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>
  455. </table>
  456. </dd>
  457. </dl>
  458. </div>
  459. </div>
  460. <hr/>The documentation for this class was generated from the following file:<ul>
  461. <li>Jolt/Physics/Constraints/ConstraintPart/<a class="el" href="_point_constraint_part_8h_source.html">PointConstraintPart.h</a></li>
  462. </ul>
  463. </div><!-- contents -->
  464. </div><!-- doc-content -->
  465. <!-- start footer part -->
  466. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  467. <ul>
  468. <li class="navelem"><a class="el" href="class_point_constraint_part.html">PointConstraintPart</a></li>
  469. <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>
  470. </ul>
  471. </div>
  472. </body>
  473. </html>