class_rotation_euler_constraint_part.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612
  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: RotationEulerConstraintPart 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_rotation_euler_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="class_rotation_euler_constraint_part-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">RotationEulerConstraintPart Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p><code>#include &lt;<a class="el" href="_rotation_euler_constraint_part_8h_source.html">RotationEulerConstraintPart.h</a>&gt;</code></p>
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  116. Public Member Functions</h2></td></tr>
  117. <tr class="memitem:af37f613895af10af42c71f644fe3f2f5" id="r_af37f613895af10af42c71f644fe3f2f5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af37f613895af10af42c71f644fe3f2f5">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, const <a class="el" href="class_body.html">Body</a> &amp;inBody2, <a class="el" href="_math_types_8h.html#af10dd31c5ad4acb62aba8025732597e6">Mat44Arg</a> inRotation2)</td></tr>
  118. <tr class="memdesc:af37f613895af10af42c71f644fe3f2f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate properties used during the functions below. <br /></td></tr>
  119. <tr class="separator:af37f613895af10af42c71f644fe3f2f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ab5ff022582eb45db942a196a32795661" id="r_ab5ff022582eb45db942a196a32795661"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab5ff022582eb45db942a196a32795661">Deactivate</a> ()</td></tr>
  121. <tr class="memdesc:ab5ff022582eb45db942a196a32795661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivate this constraint. <br /></td></tr>
  122. <tr class="separator:ab5ff022582eb45db942a196a32795661"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a5580f01673bcbbde31fd75108d2866b4" id="r_a5580f01673bcbbde31fd75108d2866b4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5580f01673bcbbde31fd75108d2866b4">IsActive</a> () const</td></tr>
  124. <tr class="memdesc:a5580f01673bcbbde31fd75108d2866b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if constraint is active. <br /></td></tr>
  125. <tr class="separator:a5580f01673bcbbde31fd75108d2866b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a492a0801dd2881d0ab58f9c8b0abfec8" id="r_a492a0801dd2881d0ab58f9c8b0abfec8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a492a0801dd2881d0ab58f9c8b0abfec8">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>
  127. <tr class="memdesc:a492a0801dd2881d0ab58f9c8b0abfec8"><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>
  128. <tr class="separator:a492a0801dd2881d0ab58f9c8b0abfec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:af9a7e556643d4162eb300045d9a40df1" id="r_af9a7e556643d4162eb300045d9a40df1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af9a7e556643d4162eb300045d9a40df1">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>
  130. <tr class="memdesc:af9a7e556643d4162eb300045d9a40df1"><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>
  131. <tr class="separator:af9a7e556643d4162eb300045d9a40df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ab2276b37dd0f8eaf4229469def2627b6" id="r_ab2276b37dd0f8eaf4229469def2627b6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2276b37dd0f8eaf4229469def2627b6">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> inInvInitialOrientation, float inBaumgarte) const</td></tr>
  133. <tr class="memdesc:ab2276b37dd0f8eaf4229469def2627b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iteratively update the position constraint. Makes sure C(...) = 0. <br /></td></tr>
  134. <tr class="separator:ab2276b37dd0f8eaf4229469def2627b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:aada1e7c8fcf62c1674aa5080cd70687e" id="r_aada1e7c8fcf62c1674aa5080cd70687e"><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="#aada1e7c8fcf62c1674aa5080cd70687e">GetTotalLambda</a> () const</td></tr>
  136. <tr class="memdesc:aada1e7c8fcf62c1674aa5080cd70687e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return lagrange multiplier. <br /></td></tr>
  137. <tr class="separator:aada1e7c8fcf62c1674aa5080cd70687e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:afda34f355272d02e5daf8103639b22bf" id="r_afda34f355272d02e5daf8103639b22bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afda34f355272d02e5daf8103639b22bf">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  139. <tr class="memdesc:afda34f355272d02e5daf8103639b22bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save state of this constraint part. <br /></td></tr>
  140. <tr class="separator:afda34f355272d02e5daf8103639b22bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:aba8f2a3ca2aa7ab982b16499cf938ee3" id="r_aba8f2a3ca2aa7ab982b16499cf938ee3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aba8f2a3ca2aa7ab982b16499cf938ee3">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  142. <tr class="memdesc:aba8f2a3ca2aa7ab982b16499cf938ee3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore state of this constraint part. <br /></td></tr>
  143. <tr class="separator:aba8f2a3ca2aa7ab982b16499cf938ee3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. </table><table class="memberdecls">
  145. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  146. Static Public Member Functions</h2></td></tr>
  147. <tr class="memitem:a40c10735335691be99e7911139dc2884" id="r_a40c10735335691be99e7911139dc2884"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_quat.html">Quat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40c10735335691be99e7911139dc2884">sGetInvInitialOrientation</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)</td></tr>
  148. <tr class="memdesc:a40c10735335691be99e7911139dc2884"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return inverse of initial rotation from body 1 to body 2 in body 1 space. <br /></td></tr>
  149. <tr class="separator:a40c10735335691be99e7911139dc2884"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a6757c3b96eff4a145d9228fb1679222d" id="r_a6757c3b96eff4a145d9228fb1679222d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_quat.html">Quat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6757c3b96eff4a145d9228fb1679222d">sGetInvInitialOrientationXY</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisX1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisY1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisX2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisY2)</td></tr>
  151. <tr class="memdesc:a6757c3b96eff4a145d9228fb1679222d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return inverse of initial rotation from body 1 to body 2 in body 1 space. <br /></td></tr>
  152. <tr class="separator:a6757c3b96eff4a145d9228fb1679222d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:ae84f7a33a2d609dd5138c9a7f3f82f65" id="r_ae84f7a33a2d609dd5138c9a7f3f82f65"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_quat.html">Quat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae84f7a33a2d609dd5138c9a7f3f82f65">sGetInvInitialOrientationXZ</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisX1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisZ1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisX2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inAxisZ2)</td></tr>
  154. <tr class="memdesc:ae84f7a33a2d609dd5138c9a7f3f82f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return inverse of initial rotation from body 1 to body 2 in body 1 space. <br /></td></tr>
  155. <tr class="separator:ae84f7a33a2d609dd5138c9a7f3f82f65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. </table>
  157. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  158. <div class="textblock"><p>Constrains rotation around all axis so that only translation is allowed</p>
  159. <p>Based on: "Constraints Derivation for Rigid Body Simulation in 3D" - Daniel Chappuis, section 2.5.1</p>
  160. <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 129):</p>
  161. <p class="formulaDsp">
  162. \[C = \begin{bmatrix}\Delta\theta_x, \Delta\theta_y, \Delta\theta_z\end{bmatrix}\]
  163. </p>
  164. <p>Jacobian (eq 131):</p>
  165. <p class="formulaDsp">
  166. \[J = \begin{bmatrix}0 &amp; -E &amp; 0 &amp; E\end{bmatrix}\]
  167. </p>
  168. <p>Used terms (here and below, everything in world space):<br />
  169. delta_theta_* = difference in rotation between initial rotation of bodies 1 and 2.<br />
  170. x1, x2 = center of mass for the bodies.<br />
  171. v = [v1, w1, v2, w2].<br />
  172. v1, v2 = linear velocity of body 1 and 2.<br />
  173. w1, w2 = angular velocity of body 1 and 2.<br />
  174. M = mass matrix, a diagonal matrix of the mass and inertia with diagonal [m1, I1, m2, I2].<br />
  175. \(K^{-1} = \left( J M^{-1} J^T \right)^{-1}\) = effective mass.<br />
  176. b = velocity bias.<br />
  177. \(\beta\) = baumgarte constant.<br />
  178. E = identity matrix.<br />
  179. </p>
  180. </div><h2 class="groupheader">Member Function Documentation</h2>
  181. <a id="af37f613895af10af42c71f644fe3f2f5" name="af37f613895af10af42c71f644fe3f2f5"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#af37f613895af10af42c71f644fe3f2f5">&#9670;&#160;</a></span>CalculateConstraintProperties()</h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">void RotationEulerConstraintPart::CalculateConstraintProperties </td>
  191. <td>(</td>
  192. <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>
  193. </tr>
  194. <tr>
  195. <td class="paramkey"></td>
  196. <td></td>
  197. <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>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <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>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <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>&#160;)</td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Calculate properties used during the functions below. </p>
  217. </div>
  218. </div>
  219. <a id="ab5ff022582eb45db942a196a32795661" name="ab5ff022582eb45db942a196a32795661"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#ab5ff022582eb45db942a196a32795661">&#9670;&#160;</a></span>Deactivate()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">void RotationEulerConstraintPart::Deactivate </td>
  229. <td>(</td>
  230. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  231. <td></td>
  232. </tr>
  233. </table>
  234. </td>
  235. <td class="mlabels-right">
  236. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>Deactivate this constraint. </p>
  241. </div>
  242. </div>
  243. <a id="aada1e7c8fcf62c1674aa5080cd70687e" name="aada1e7c8fcf62c1674aa5080cd70687e"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#aada1e7c8fcf62c1674aa5080cd70687e">&#9670;&#160;</a></span>GetTotalLambda()</h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="mlabels">
  248. <tr>
  249. <td class="mlabels-left">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> RotationEulerConstraintPart::GetTotalLambda </td>
  253. <td>(</td>
  254. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  255. <td> const</td>
  256. </tr>
  257. </table>
  258. </td>
  259. <td class="mlabels-right">
  260. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Return lagrange multiplier. </p>
  265. </div>
  266. </div>
  267. <a id="a5580f01673bcbbde31fd75108d2866b4" name="a5580f01673bcbbde31fd75108d2866b4"></a>
  268. <h2 class="memtitle"><span class="permalink"><a href="#a5580f01673bcbbde31fd75108d2866b4">&#9670;&#160;</a></span>IsActive()</h2>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="mlabels">
  272. <tr>
  273. <td class="mlabels-left">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">bool RotationEulerConstraintPart::IsActive </td>
  277. <td>(</td>
  278. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  279. <td> const</td>
  280. </tr>
  281. </table>
  282. </td>
  283. <td class="mlabels-right">
  284. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Check if constraint is active. </p>
  289. </div>
  290. </div>
  291. <a id="aba8f2a3ca2aa7ab982b16499cf938ee3" name="aba8f2a3ca2aa7ab982b16499cf938ee3"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#aba8f2a3ca2aa7ab982b16499cf938ee3">&#9670;&#160;</a></span>RestoreState()</h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="mlabels">
  296. <tr>
  297. <td class="mlabels-left">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">void RotationEulerConstraintPart::RestoreState </td>
  301. <td>(</td>
  302. <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>
  303. <td></td>
  304. </tr>
  305. </table>
  306. </td>
  307. <td class="mlabels-right">
  308. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. <p>Restore state of this constraint part. </p>
  313. </div>
  314. </div>
  315. <a id="afda34f355272d02e5daf8103639b22bf" name="afda34f355272d02e5daf8103639b22bf"></a>
  316. <h2 class="memtitle"><span class="permalink"><a href="#afda34f355272d02e5daf8103639b22bf">&#9670;&#160;</a></span>SaveState()</h2>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="mlabels">
  320. <tr>
  321. <td class="mlabels-left">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">void RotationEulerConstraintPart::SaveState </td>
  325. <td>(</td>
  326. <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>
  327. <td> const</td>
  328. </tr>
  329. </table>
  330. </td>
  331. <td class="mlabels-right">
  332. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Save state of this constraint part. </p>
  337. </div>
  338. </div>
  339. <a id="a40c10735335691be99e7911139dc2884" name="a40c10735335691be99e7911139dc2884"></a>
  340. <h2 class="memtitle"><span class="permalink"><a href="#a40c10735335691be99e7911139dc2884">&#9670;&#160;</a></span>sGetInvInitialOrientation()</h2>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="mlabels">
  344. <tr>
  345. <td class="mlabels-left">
  346. <table class="memname">
  347. <tr>
  348. <td class="memname">static <a class="el" href="class_quat.html">Quat</a> RotationEulerConstraintPart::sGetInvInitialOrientation </td>
  349. <td>(</td>
  350. <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>
  351. </tr>
  352. <tr>
  353. <td class="paramkey"></td>
  354. <td></td>
  355. <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>&#160;)</td>
  356. </tr>
  357. </table>
  358. </td>
  359. <td class="mlabels-right">
  360. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  361. </tr>
  362. </table>
  363. </div><div class="memdoc">
  364. <p>Return inverse of initial rotation from body 1 to body 2 in body 1 space. </p>
  365. </div>
  366. </div>
  367. <a id="a6757c3b96eff4a145d9228fb1679222d" name="a6757c3b96eff4a145d9228fb1679222d"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#a6757c3b96eff4a145d9228fb1679222d">&#9670;&#160;</a></span>sGetInvInitialOrientationXY()</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">static <a class="el" href="class_quat.html">Quat</a> RotationEulerConstraintPart::sGetInvInitialOrientationXY </td>
  377. <td>(</td>
  378. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inAxisX1</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>inAxisY1</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>inAxisX2</em></span>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inAxisY2</em></span>&#160;)</td>
  394. </tr>
  395. </table>
  396. </td>
  397. <td class="mlabels-right">
  398. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Return inverse of initial rotation from body 1 to body 2 in body 1 space. </p>
  403. <dl class="params"><dt>Parameters</dt><dd>
  404. <table class="params">
  405. <tr><td class="paramname">inAxisX1</td><td>Reference axis X for body 1 </td></tr>
  406. <tr><td class="paramname">inAxisY1</td><td>Reference axis Y for body 1 </td></tr>
  407. <tr><td class="paramname">inAxisX2</td><td>Reference axis X for body 2 </td></tr>
  408. <tr><td class="paramname">inAxisY2</td><td>Reference axis Y for body 2 </td></tr>
  409. </table>
  410. </dd>
  411. </dl>
  412. </div>
  413. </div>
  414. <a id="ae84f7a33a2d609dd5138c9a7f3f82f65" name="ae84f7a33a2d609dd5138c9a7f3f82f65"></a>
  415. <h2 class="memtitle"><span class="permalink"><a href="#ae84f7a33a2d609dd5138c9a7f3f82f65">&#9670;&#160;</a></span>sGetInvInitialOrientationXZ()</h2>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="mlabels">
  419. <tr>
  420. <td class="mlabels-left">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname">static <a class="el" href="class_quat.html">Quat</a> RotationEulerConstraintPart::sGetInvInitialOrientationXZ </td>
  424. <td>(</td>
  425. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inAxisX1</em></span>, </td>
  426. </tr>
  427. <tr>
  428. <td class="paramkey"></td>
  429. <td></td>
  430. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inAxisZ1</em></span>, </td>
  431. </tr>
  432. <tr>
  433. <td class="paramkey"></td>
  434. <td></td>
  435. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inAxisX2</em></span>, </td>
  436. </tr>
  437. <tr>
  438. <td class="paramkey"></td>
  439. <td></td>
  440. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inAxisZ2</em></span>&#160;)</td>
  441. </tr>
  442. </table>
  443. </td>
  444. <td class="mlabels-right">
  445. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <p>Return inverse of initial rotation from body 1 to body 2 in body 1 space. </p>
  450. <dl class="params"><dt>Parameters</dt><dd>
  451. <table class="params">
  452. <tr><td class="paramname">inAxisX1</td><td>Reference axis X for body 1 </td></tr>
  453. <tr><td class="paramname">inAxisZ1</td><td>Reference axis Z for body 1 </td></tr>
  454. <tr><td class="paramname">inAxisX2</td><td>Reference axis X for body 2 </td></tr>
  455. <tr><td class="paramname">inAxisZ2</td><td>Reference axis Z for body 2 </td></tr>
  456. </table>
  457. </dd>
  458. </dl>
  459. </div>
  460. </div>
  461. <a id="ab2276b37dd0f8eaf4229469def2627b6" name="ab2276b37dd0f8eaf4229469def2627b6"></a>
  462. <h2 class="memtitle"><span class="permalink"><a href="#ab2276b37dd0f8eaf4229469def2627b6">&#9670;&#160;</a></span>SolvePositionConstraint()</h2>
  463. <div class="memitem">
  464. <div class="memproto">
  465. <table class="mlabels">
  466. <tr>
  467. <td class="mlabels-left">
  468. <table class="memname">
  469. <tr>
  470. <td class="memname">bool RotationEulerConstraintPart::SolvePositionConstraint </td>
  471. <td>(</td>
  472. <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>
  473. </tr>
  474. <tr>
  475. <td class="paramkey"></td>
  476. <td></td>
  477. <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>
  478. </tr>
  479. <tr>
  480. <td class="paramkey"></td>
  481. <td></td>
  482. <td class="paramtype"><a class="el" href="_math_types_8h.html#a3c723d55f34e02bc506abe3dfb7bd2aa">QuatArg</a></td> <td class="paramname"><span class="paramname"><em>inInvInitialOrientation</em></span>, </td>
  483. </tr>
  484. <tr>
  485. <td class="paramkey"></td>
  486. <td></td>
  487. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inBaumgarte</em></span>&#160;) const</td>
  488. </tr>
  489. </table>
  490. </td>
  491. <td class="mlabels-right">
  492. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  493. </tr>
  494. </table>
  495. </div><div class="memdoc">
  496. <p>Iteratively update the position constraint. Makes sure C(...) = 0. </p>
  497. </div>
  498. </div>
  499. <a id="af9a7e556643d4162eb300045d9a40df1" name="af9a7e556643d4162eb300045d9a40df1"></a>
  500. <h2 class="memtitle"><span class="permalink"><a href="#af9a7e556643d4162eb300045d9a40df1">&#9670;&#160;</a></span>SolveVelocityConstraint()</h2>
  501. <div class="memitem">
  502. <div class="memproto">
  503. <table class="mlabels">
  504. <tr>
  505. <td class="mlabels-left">
  506. <table class="memname">
  507. <tr>
  508. <td class="memname">bool RotationEulerConstraintPart::SolveVelocityConstraint </td>
  509. <td>(</td>
  510. <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>
  511. </tr>
  512. <tr>
  513. <td class="paramkey"></td>
  514. <td></td>
  515. <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>
  516. </tr>
  517. </table>
  518. </td>
  519. <td class="mlabels-right">
  520. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  521. </tr>
  522. </table>
  523. </div><div class="memdoc">
  524. <p>Iteratively update the velocity constraint. Makes sure d/dt C(...) = 0, where C is the constraint equation. </p>
  525. </div>
  526. </div>
  527. <a id="a492a0801dd2881d0ab58f9c8b0abfec8" name="a492a0801dd2881d0ab58f9c8b0abfec8"></a>
  528. <h2 class="memtitle"><span class="permalink"><a href="#a492a0801dd2881d0ab58f9c8b0abfec8">&#9670;&#160;</a></span>WarmStart()</h2>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="mlabels">
  532. <tr>
  533. <td class="mlabels-left">
  534. <table class="memname">
  535. <tr>
  536. <td class="memname">void RotationEulerConstraintPart::WarmStart </td>
  537. <td>(</td>
  538. <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>
  539. </tr>
  540. <tr>
  541. <td class="paramkey"></td>
  542. <td></td>
  543. <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>
  544. </tr>
  545. <tr>
  546. <td class="paramkey"></td>
  547. <td></td>
  548. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inWarmStartImpulseRatio</em></span>&#160;)</td>
  549. </tr>
  550. </table>
  551. </td>
  552. <td class="mlabels-right">
  553. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  554. </tr>
  555. </table>
  556. </div><div class="memdoc">
  557. <p>Must be called from the WarmStartVelocityConstraint call to apply the previous frame's impulses. </p>
  558. </div>
  559. </div>
  560. <hr/>The documentation for this class was generated from the following file:<ul>
  561. <li>Jolt/Physics/Constraints/ConstraintPart/<a class="el" href="_rotation_euler_constraint_part_8h_source.html">RotationEulerConstraintPart.h</a></li>
  562. </ul>
  563. </div><!-- contents -->
  564. </div><!-- doc-content -->
  565. <!-- start footer part -->
  566. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  567. <ul>
  568. <li class="navelem"><a class="el" href="class_rotation_euler_constraint_part.html">RotationEulerConstraintPart</a></li>
  569. <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>
  570. </ul>
  571. </div>
  572. </body>
  573. </html>