_path_constraint_8h.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  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: Jolt/Physics/Constraints/PathConstraint.h File 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('_path_constraint_8h.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="#nested-classes">Classes</a> &#124;
  108. <a href="#enum-members">Enumerations</a> </div>
  109. <div class="headertitle"><div class="title">PathConstraint.h File Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><code>#include &lt;<a class="el" href="_two_body_constraint_8h_source.html">Jolt/Physics/Constraints/TwoBodyConstraint.h</a>&gt;</code><br />
  113. <code>#include &lt;<a class="el" href="_path_constraint_path_8h_source.html">Jolt/Physics/Constraints/PathConstraintPath.h</a>&gt;</code><br />
  114. <code>#include &lt;<a class="el" href="_motor_settings_8h_source.html">Jolt/Physics/Constraints/MotorSettings.h</a>&gt;</code><br />
  115. <code>#include &lt;<a class="el" href="_axis_constraint_part_8h_source.html">Jolt/Physics/Constraints/ConstraintPart/AxisConstraintPart.h</a>&gt;</code><br />
  116. <code>#include &lt;<a class="el" href="_dual_axis_constraint_part_8h_source.html">Jolt/Physics/Constraints/ConstraintPart/DualAxisConstraintPart.h</a>&gt;</code><br />
  117. <code>#include &lt;<a class="el" href="_hinge_rotation_constraint_part_8h_source.html">Jolt/Physics/Constraints/ConstraintPart/HingeRotationConstraintPart.h</a>&gt;</code><br />
  118. <code>#include &lt;<a class="el" href="_rotation_euler_constraint_part_8h_source.html">Jolt/Physics/Constraints/ConstraintPart/RotationEulerConstraintPart.h</a>&gt;</code><br />
  119. </div>
  120. <p><a href="_path_constraint_8h_source.html">Go to the source code of this file.</a></p>
  121. <table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  123. Classes</h2></td></tr>
  124. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint_settings.html">PathConstraintSettings</a></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_path_constraint.html">PathConstraint</a></td></tr>
  127. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Path constraint, used to constrain the degrees of freedom between two bodies to a path. <a href="class_path_constraint.html#details">More...</a><br /></td></tr>
  128. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table><table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
  131. Enumerations</h2></td></tr>
  132. <tr class="memitem:ad9f01f2f5231cdacf562f04aefbba51b" id="r_ad9f01f2f5231cdacf562f04aefbba51b"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51b">EPathRotationConstraintType</a> { <br />
  133. &#160;&#160;<a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51bab24ce0cd392a5b0b8dedc66c25213594">Free</a>
  134. , <a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51bae683cb817d9b6df8318feeff63c0dc7a">ConstrainAroundTangent</a>
  135. , <a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51bab302156e1f72f50fcaf8f21a79175edb">ConstrainAroundNormal</a>
  136. , <a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51bac47ca6b2c57b8f6f71ffc3447b2bc732">ConstrainAroundBinormal</a>
  137. , <br />
  138. &#160;&#160;<a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51ba073f41f446822810e8d12d203367a61f">ConstrainToPath</a>
  139. , <a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51ba22d4f54f5a2001373cac7b8d8f246f11">FullyConstrained</a>
  140. <br />
  141. }</td></tr>
  142. <tr class="memdesc:ad9f01f2f5231cdacf562f04aefbba51b"><td class="mdescLeft">&#160;</td><td class="mdescRight">How to constrain the rotation of the body to a <a class="el" href="class_path_constraint.html" title="Path constraint, used to constrain the degrees of freedom between two bodies to a path.">PathConstraint</a>. <a href="#ad9f01f2f5231cdacf562f04aefbba51b">More...</a><br /></td></tr>
  143. <tr class="separator:ad9f01f2f5231cdacf562f04aefbba51b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. </table>
  145. <h2 class="groupheader">Enumeration Type Documentation</h2>
  146. <a id="ad9f01f2f5231cdacf562f04aefbba51b" name="ad9f01f2f5231cdacf562f04aefbba51b"></a>
  147. <h2 class="memtitle"><span class="permalink"><a href="#ad9f01f2f5231cdacf562f04aefbba51b">&#9670;&#160;</a></span>EPathRotationConstraintType</h2>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="mlabels">
  151. <tr>
  152. <td class="mlabels-left">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">enum class <a class="el" href="#ad9f01f2f5231cdacf562f04aefbba51b">EPathRotationConstraintType</a></td>
  156. </tr>
  157. </table>
  158. </td>
  159. <td class="mlabels-right">
  160. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>How to constrain the rotation of the body to a <a class="el" href="class_path_constraint.html" title="Path constraint, used to constrain the degrees of freedom between two bodies to a path.">PathConstraint</a>. </p>
  165. <table class="fieldtable">
  166. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad9f01f2f5231cdacf562f04aefbba51bab24ce0cd392a5b0b8dedc66c25213594" name="ad9f01f2f5231cdacf562f04aefbba51bab24ce0cd392a5b0b8dedc66c25213594"></a>Free&#160;</td><td class="fielddoc"><p>Do not constrain the rotation of the body at all. </p>
  167. </td></tr>
  168. <tr><td class="fieldname"><a id="ad9f01f2f5231cdacf562f04aefbba51bae683cb817d9b6df8318feeff63c0dc7a" name="ad9f01f2f5231cdacf562f04aefbba51bae683cb817d9b6df8318feeff63c0dc7a"></a>ConstrainAroundTangent&#160;</td><td class="fielddoc"><p>Only allow rotation around the tangent vector (following the path) </p>
  169. </td></tr>
  170. <tr><td class="fieldname"><a id="ad9f01f2f5231cdacf562f04aefbba51bab302156e1f72f50fcaf8f21a79175edb" name="ad9f01f2f5231cdacf562f04aefbba51bab302156e1f72f50fcaf8f21a79175edb"></a>ConstrainAroundNormal&#160;</td><td class="fielddoc"><p>Only allow rotation around the normal vector (perpendicular to the path) </p>
  171. </td></tr>
  172. <tr><td class="fieldname"><a id="ad9f01f2f5231cdacf562f04aefbba51bac47ca6b2c57b8f6f71ffc3447b2bc732" name="ad9f01f2f5231cdacf562f04aefbba51bac47ca6b2c57b8f6f71ffc3447b2bc732"></a>ConstrainAroundBinormal&#160;</td><td class="fielddoc"><p>Only allow rotation around the binormal vector (perpendicular to the path) </p>
  173. </td></tr>
  174. <tr><td class="fieldname"><a id="ad9f01f2f5231cdacf562f04aefbba51ba073f41f446822810e8d12d203367a61f" name="ad9f01f2f5231cdacf562f04aefbba51ba073f41f446822810e8d12d203367a61f"></a>ConstrainToPath&#160;</td><td class="fielddoc"><p>Fully constrain the rotation of body 2 to the path (following the tangent and normal of the path) </p>
  175. </td></tr>
  176. <tr><td class="fieldname"><a id="ad9f01f2f5231cdacf562f04aefbba51ba22d4f54f5a2001373cac7b8d8f246f11" name="ad9f01f2f5231cdacf562f04aefbba51ba22d4f54f5a2001373cac7b8d8f246f11"></a>FullyConstrained&#160;</td><td class="fielddoc"><p>Fully constrain the rotation of the body 2 to the rotation of body 1. </p>
  177. </td></tr>
  178. </table>
  179. </div>
  180. </div>
  181. </div><!-- contents -->
  182. </div><!-- doc-content -->
  183. <!-- start footer part -->
  184. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  185. <ul>
  186. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_a0f33af92addde396fc27b064c5eb8a9.html">Physics</a></li><li class="navelem"><a class="el" href="dir_166975991df1b4ecc6dd5a6639d45e50.html">Constraints</a></li><li class="navelem"><a class="el" href="_path_constraint_8h.html">PathConstraint.h</a></li>
  187. <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>
  188. </ul>
  189. </div>
  190. </body>
  191. </html>