class_motor_settings.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  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: MotorSettings 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_motor_settings.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-attribs">Public Attributes</a> &#124;
  109. <a href="class_motor_settings-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">MotorSettings Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p><code>#include &lt;<a class="el" href="_motor_settings_8h_source.html">MotorSettings.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:a9931c598c884e6be4baea88a612ef59e" id="r_a9931c598c884e6be4baea88a612ef59e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9931c598c884e6be4baea88a612ef59e">MotorSettings</a> ()=default</td></tr>
  118. <tr class="memdesc:a9931c598c884e6be4baea88a612ef59e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  119. <tr class="separator:a9931c598c884e6be4baea88a612ef59e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a3da51e1a3f8feb8e6a2b056c7e26d24b" id="r_a3da51e1a3f8feb8e6a2b056c7e26d24b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3da51e1a3f8feb8e6a2b056c7e26d24b">MotorSettings</a> (const <a class="el" href="class_motor_settings.html">MotorSettings</a> &amp;)=default</td></tr>
  121. <tr class="separator:a3da51e1a3f8feb8e6a2b056c7e26d24b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a33d51a2bb5a231a689a1620577aed53a" id="r_a33d51a2bb5a231a689a1620577aed53a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_motor_settings.html">MotorSettings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33d51a2bb5a231a689a1620577aed53a">operator=</a> (const <a class="el" href="class_motor_settings.html">MotorSettings</a> &amp;)=default</td></tr>
  123. <tr class="separator:a33d51a2bb5a231a689a1620577aed53a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a81a42488fb27a4e36f3f2802bca0bdcc" id="r_a81a42488fb27a4e36f3f2802bca0bdcc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a81a42488fb27a4e36f3f2802bca0bdcc">MotorSettings</a> (float inFrequency, float inDamping)</td></tr>
  125. <tr class="separator:a81a42488fb27a4e36f3f2802bca0bdcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a280a8c958af57873bd500de0104ef574" id="r_a280a8c958af57873bd500de0104ef574"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a280a8c958af57873bd500de0104ef574">MotorSettings</a> (float inFrequency, float inDamping, float inForceLimit, float inTorqueLimit)</td></tr>
  127. <tr class="separator:a280a8c958af57873bd500de0104ef574"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a35ce9e0a888fed7059694121e7d8e66f" id="r_a35ce9e0a888fed7059694121e7d8e66f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a35ce9e0a888fed7059694121e7d8e66f">SetForceLimits</a> (float inMin, float inMax)</td></tr>
  129. <tr class="memdesc:a35ce9e0a888fed7059694121e7d8e66f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set asymmetric force limits. <br /></td></tr>
  130. <tr class="separator:a35ce9e0a888fed7059694121e7d8e66f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a3953c02a21926f36d415e805ffce289c" id="r_a3953c02a21926f36d415e805ffce289c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3953c02a21926f36d415e805ffce289c">SetTorqueLimits</a> (float inMin, float inMax)</td></tr>
  132. <tr class="memdesc:a3953c02a21926f36d415e805ffce289c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set asymmetric torque limits. <br /></td></tr>
  133. <tr class="separator:a3953c02a21926f36d415e805ffce289c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a7dbbf359da6a861e6876f702650dd5ea" id="r_a7dbbf359da6a861e6876f702650dd5ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7dbbf359da6a861e6876f702650dd5ea">SetForceLimit</a> (float inLimit)</td></tr>
  135. <tr class="memdesc:a7dbbf359da6a861e6876f702650dd5ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set symmetric force limits. <br /></td></tr>
  136. <tr class="separator:a7dbbf359da6a861e6876f702650dd5ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a8eeaad102049c8586b180f516119ddeb" id="r_a8eeaad102049c8586b180f516119ddeb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8eeaad102049c8586b180f516119ddeb">SetTorqueLimit</a> (float inLimit)</td></tr>
  138. <tr class="memdesc:a8eeaad102049c8586b180f516119ddeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set symmetric torque limits. <br /></td></tr>
  139. <tr class="separator:a8eeaad102049c8586b180f516119ddeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a86075f9a0d21b35897e7f6f7e9c50fbc" id="r_a86075f9a0d21b35897e7f6f7e9c50fbc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a86075f9a0d21b35897e7f6f7e9c50fbc">IsValid</a> () const</td></tr>
  141. <tr class="memdesc:a86075f9a0d21b35897e7f6f7e9c50fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if settings are valid. <br /></td></tr>
  142. <tr class="separator:a86075f9a0d21b35897e7f6f7e9c50fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:ac0a3de2c2c2545e381d5c00014bef682" id="r_ac0a3de2c2c2545e381d5c00014bef682"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0a3de2c2c2545e381d5c00014bef682">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  144. <tr class="memdesc:ac0a3de2c2c2545e381d5c00014bef682"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents of the motor settings in binary form to inStream. <br /></td></tr>
  145. <tr class="separator:ac0a3de2c2c2545e381d5c00014bef682"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a0d171537fc44218d3c3a6159a95aab74" id="r_a0d171537fc44218d3c3a6159a95aab74"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d171537fc44218d3c3a6159a95aab74">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  147. <tr class="memdesc:a0d171537fc44218d3c3a6159a95aab74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores contents from the binary stream inStream. <br /></td></tr>
  148. <tr class="separator:a0d171537fc44218d3c3a6159a95aab74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table><table class="memberdecls">
  150. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  151. Public Attributes</h2></td></tr>
  152. <tr class="memitem:a5a51d3f04aa12947eb85d08a1f01dab6" id="r_a5a51d3f04aa12947eb85d08a1f01dab6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_spring_settings.html">SpringSettings</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5a51d3f04aa12947eb85d08a1f01dab6">mSpringSettings</a> { <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a>, 2.0f, 1.0f }</td></tr>
  153. <tr class="memdesc:a5a51d3f04aa12947eb85d08a1f01dab6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Settings for the spring that is used to drive to the position target (not used when motor is a velocity motor). <br /></td></tr>
  154. <tr class="separator:a5a51d3f04aa12947eb85d08a1f01dab6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ac8b066324ceb0052a8ff637e77d4e9c1" id="r_ac8b066324ceb0052a8ff637e77d4e9c1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac8b066324ceb0052a8ff637e77d4e9c1">mMinForceLimit</a> = -FLT_MAX</td></tr>
  156. <tr class="memdesc:ac8b066324ceb0052a8ff637e77d4e9c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum force to apply in case of a linear constraint (N). Usually this is -mMaxForceLimit unless you want a motor that can e.g. push but not pull. Not used when motor is an angular motor. <br /></td></tr>
  157. <tr class="separator:ac8b066324ceb0052a8ff637e77d4e9c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:aacf73d5d1dc3d729ed505b01f2b91425" id="r_aacf73d5d1dc3d729ed505b01f2b91425"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aacf73d5d1dc3d729ed505b01f2b91425">mMaxForceLimit</a> = FLT_MAX</td></tr>
  159. <tr class="memdesc:aacf73d5d1dc3d729ed505b01f2b91425"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum force to apply in case of a linear constraint (N). Not used when motor is an angular motor. <br /></td></tr>
  160. <tr class="separator:aacf73d5d1dc3d729ed505b01f2b91425"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a7073ab453c838bef080a3386da6927bd" id="r_a7073ab453c838bef080a3386da6927bd"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7073ab453c838bef080a3386da6927bd">mMinTorqueLimit</a> = -FLT_MAX</td></tr>
  162. <tr class="memdesc:a7073ab453c838bef080a3386da6927bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum torque to apply in case of a angular constraint (N m). Usually this is -mMaxTorqueLimit unless you want a motor that can e.g. push but not pull. Not used when motor is a position motor. <br /></td></tr>
  163. <tr class="separator:a7073ab453c838bef080a3386da6927bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a53921d266a57d01aa6833ca3fe09c3a7" id="r_a53921d266a57d01aa6833ca3fe09c3a7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53921d266a57d01aa6833ca3fe09c3a7">mMaxTorqueLimit</a> = FLT_MAX</td></tr>
  165. <tr class="memdesc:a53921d266a57d01aa6833ca3fe09c3a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum torque to apply in case of a angular constraint (N m). Not used when motor is a position motor. <br /></td></tr>
  166. <tr class="separator:a53921d266a57d01aa6833ca3fe09c3a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table>
  168. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  169. <div class="textblock"><p>Class that contains the settings for a constraint motor. See the main page of the API documentation for more information on how to configure a motor. </p>
  170. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  171. <a id="a9931c598c884e6be4baea88a612ef59e" name="a9931c598c884e6be4baea88a612ef59e"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#a9931c598c884e6be4baea88a612ef59e">&#9670;&#160;</a></span>MotorSettings() <span class="overload">[1/4]</span></h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="mlabels">
  176. <tr>
  177. <td class="mlabels-left">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">MotorSettings::MotorSettings </td>
  181. <td>(</td>
  182. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  183. <td></td>
  184. </tr>
  185. </table>
  186. </td>
  187. <td class="mlabels-right">
  188. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Constructor. </p>
  193. </div>
  194. </div>
  195. <a id="a3da51e1a3f8feb8e6a2b056c7e26d24b" name="a3da51e1a3f8feb8e6a2b056c7e26d24b"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#a3da51e1a3f8feb8e6a2b056c7e26d24b">&#9670;&#160;</a></span>MotorSettings() <span class="overload">[2/4]</span></h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="mlabels">
  200. <tr>
  201. <td class="mlabels-left">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">MotorSettings::MotorSettings </td>
  205. <td>(</td>
  206. <td class="paramtype">const <a class="el" href="class_motor_settings.html">MotorSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. </div>
  217. </div>
  218. <a id="a81a42488fb27a4e36f3f2802bca0bdcc" name="a81a42488fb27a4e36f3f2802bca0bdcc"></a>
  219. <h2 class="memtitle"><span class="permalink"><a href="#a81a42488fb27a4e36f3f2802bca0bdcc">&#9670;&#160;</a></span>MotorSettings() <span class="overload">[3/4]</span></h2>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="mlabels">
  223. <tr>
  224. <td class="mlabels-left">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">MotorSettings::MotorSettings </td>
  228. <td>(</td>
  229. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFrequency</em></span>, </td>
  230. </tr>
  231. <tr>
  232. <td class="paramkey"></td>
  233. <td></td>
  234. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inDamping</em></span>&#160;)</td>
  235. </tr>
  236. </table>
  237. </td>
  238. <td class="mlabels-right">
  239. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  240. </tr>
  241. </table>
  242. </div><div class="memdoc">
  243. </div>
  244. </div>
  245. <a id="a280a8c958af57873bd500de0104ef574" name="a280a8c958af57873bd500de0104ef574"></a>
  246. <h2 class="memtitle"><span class="permalink"><a href="#a280a8c958af57873bd500de0104ef574">&#9670;&#160;</a></span>MotorSettings() <span class="overload">[4/4]</span></h2>
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="mlabels">
  250. <tr>
  251. <td class="mlabels-left">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">MotorSettings::MotorSettings </td>
  255. <td>(</td>
  256. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFrequency</em></span>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inDamping</em></span>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inForceLimit</em></span>, </td>
  267. </tr>
  268. <tr>
  269. <td class="paramkey"></td>
  270. <td></td>
  271. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inTorqueLimit</em></span>&#160;)</td>
  272. </tr>
  273. </table>
  274. </td>
  275. <td class="mlabels-right">
  276. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. </div>
  281. </div>
  282. <h2 class="groupheader">Member Function Documentation</h2>
  283. <a id="a86075f9a0d21b35897e7f6f7e9c50fbc" name="a86075f9a0d21b35897e7f6f7e9c50fbc"></a>
  284. <h2 class="memtitle"><span class="permalink"><a href="#a86075f9a0d21b35897e7f6f7e9c50fbc">&#9670;&#160;</a></span>IsValid()</h2>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="mlabels">
  288. <tr>
  289. <td class="mlabels-left">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">bool MotorSettings::IsValid </td>
  293. <td>(</td>
  294. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  295. <td> const</td>
  296. </tr>
  297. </table>
  298. </td>
  299. <td class="mlabels-right">
  300. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>Check if settings are valid. </p>
  305. </div>
  306. </div>
  307. <a id="a33d51a2bb5a231a689a1620577aed53a" name="a33d51a2bb5a231a689a1620577aed53a"></a>
  308. <h2 class="memtitle"><span class="permalink"><a href="#a33d51a2bb5a231a689a1620577aed53a">&#9670;&#160;</a></span>operator=()</h2>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="mlabels">
  312. <tr>
  313. <td class="mlabels-left">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname"><a class="el" href="class_motor_settings.html">MotorSettings</a> &amp; MotorSettings::operator= </td>
  317. <td>(</td>
  318. <td class="paramtype">const <a class="el" href="class_motor_settings.html">MotorSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </td>
  323. <td class="mlabels-right">
  324. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. </div>
  329. </div>
  330. <a id="a0d171537fc44218d3c3a6159a95aab74" name="a0d171537fc44218d3c3a6159a95aab74"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#a0d171537fc44218d3c3a6159a95aab74">&#9670;&#160;</a></span>RestoreBinaryState()</h2>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="memname">
  335. <tr>
  336. <td class="memname">void MotorSettings::RestoreBinaryState </td>
  337. <td>(</td>
  338. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  339. <td></td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Restores contents from the binary stream inStream. </p>
  344. </div>
  345. </div>
  346. <a id="ac0a3de2c2c2545e381d5c00014bef682" name="ac0a3de2c2c2545e381d5c00014bef682"></a>
  347. <h2 class="memtitle"><span class="permalink"><a href="#ac0a3de2c2c2545e381d5c00014bef682">&#9670;&#160;</a></span>SaveBinaryState()</h2>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="memname">
  351. <tr>
  352. <td class="memname">void MotorSettings::SaveBinaryState </td>
  353. <td>(</td>
  354. <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  355. <td> const</td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>Saves the contents of the motor settings in binary form to inStream. </p>
  360. </div>
  361. </div>
  362. <a id="a7dbbf359da6a861e6876f702650dd5ea" name="a7dbbf359da6a861e6876f702650dd5ea"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#a7dbbf359da6a861e6876f702650dd5ea">&#9670;&#160;</a></span>SetForceLimit()</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">void MotorSettings::SetForceLimit </td>
  372. <td>(</td>
  373. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inLimit</em></span></td><td>)</td>
  374. <td></td>
  375. </tr>
  376. </table>
  377. </td>
  378. <td class="mlabels-right">
  379. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <p>Set symmetric force limits. </p>
  384. </div>
  385. </div>
  386. <a id="a35ce9e0a888fed7059694121e7d8e66f" name="a35ce9e0a888fed7059694121e7d8e66f"></a>
  387. <h2 class="memtitle"><span class="permalink"><a href="#a35ce9e0a888fed7059694121e7d8e66f">&#9670;&#160;</a></span>SetForceLimits()</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">void MotorSettings::SetForceLimits </td>
  396. <td>(</td>
  397. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMin</em></span>, </td>
  398. </tr>
  399. <tr>
  400. <td class="paramkey"></td>
  401. <td></td>
  402. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMax</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>Set asymmetric force limits. </p>
  412. </div>
  413. </div>
  414. <a id="a8eeaad102049c8586b180f516119ddeb" name="a8eeaad102049c8586b180f516119ddeb"></a>
  415. <h2 class="memtitle"><span class="permalink"><a href="#a8eeaad102049c8586b180f516119ddeb">&#9670;&#160;</a></span>SetTorqueLimit()</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">void MotorSettings::SetTorqueLimit </td>
  424. <td>(</td>
  425. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inLimit</em></span></td><td>)</td>
  426. <td></td>
  427. </tr>
  428. </table>
  429. </td>
  430. <td class="mlabels-right">
  431. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Set symmetric torque limits. </p>
  436. </div>
  437. </div>
  438. <a id="a3953c02a21926f36d415e805ffce289c" name="a3953c02a21926f36d415e805ffce289c"></a>
  439. <h2 class="memtitle"><span class="permalink"><a href="#a3953c02a21926f36d415e805ffce289c">&#9670;&#160;</a></span>SetTorqueLimits()</h2>
  440. <div class="memitem">
  441. <div class="memproto">
  442. <table class="mlabels">
  443. <tr>
  444. <td class="mlabels-left">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname">void MotorSettings::SetTorqueLimits </td>
  448. <td>(</td>
  449. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMin</em></span>, </td>
  450. </tr>
  451. <tr>
  452. <td class="paramkey"></td>
  453. <td></td>
  454. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMax</em></span>&#160;)</td>
  455. </tr>
  456. </table>
  457. </td>
  458. <td class="mlabels-right">
  459. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  460. </tr>
  461. </table>
  462. </div><div class="memdoc">
  463. <p>Set asymmetric torque limits. </p>
  464. </div>
  465. </div>
  466. <h2 class="groupheader">Member Data Documentation</h2>
  467. <a id="aacf73d5d1dc3d729ed505b01f2b91425" name="aacf73d5d1dc3d729ed505b01f2b91425"></a>
  468. <h2 class="memtitle"><span class="permalink"><a href="#aacf73d5d1dc3d729ed505b01f2b91425">&#9670;&#160;</a></span>mMaxForceLimit</h2>
  469. <div class="memitem">
  470. <div class="memproto">
  471. <table class="memname">
  472. <tr>
  473. <td class="memname">float MotorSettings::mMaxForceLimit = FLT_MAX</td>
  474. </tr>
  475. </table>
  476. </div><div class="memdoc">
  477. <p>Maximum force to apply in case of a linear constraint (N). Not used when motor is an angular motor. </p>
  478. </div>
  479. </div>
  480. <a id="a53921d266a57d01aa6833ca3fe09c3a7" name="a53921d266a57d01aa6833ca3fe09c3a7"></a>
  481. <h2 class="memtitle"><span class="permalink"><a href="#a53921d266a57d01aa6833ca3fe09c3a7">&#9670;&#160;</a></span>mMaxTorqueLimit</h2>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">float MotorSettings::mMaxTorqueLimit = FLT_MAX</td>
  487. </tr>
  488. </table>
  489. </div><div class="memdoc">
  490. <p>Maximum torque to apply in case of a angular constraint (N m). Not used when motor is a position motor. </p>
  491. </div>
  492. </div>
  493. <a id="ac8b066324ceb0052a8ff637e77d4e9c1" name="ac8b066324ceb0052a8ff637e77d4e9c1"></a>
  494. <h2 class="memtitle"><span class="permalink"><a href="#ac8b066324ceb0052a8ff637e77d4e9c1">&#9670;&#160;</a></span>mMinForceLimit</h2>
  495. <div class="memitem">
  496. <div class="memproto">
  497. <table class="memname">
  498. <tr>
  499. <td class="memname">float MotorSettings::mMinForceLimit = -FLT_MAX</td>
  500. </tr>
  501. </table>
  502. </div><div class="memdoc">
  503. <p>Minimum force to apply in case of a linear constraint (N). Usually this is -mMaxForceLimit unless you want a motor that can e.g. push but not pull. Not used when motor is an angular motor. </p>
  504. </div>
  505. </div>
  506. <a id="a7073ab453c838bef080a3386da6927bd" name="a7073ab453c838bef080a3386da6927bd"></a>
  507. <h2 class="memtitle"><span class="permalink"><a href="#a7073ab453c838bef080a3386da6927bd">&#9670;&#160;</a></span>mMinTorqueLimit</h2>
  508. <div class="memitem">
  509. <div class="memproto">
  510. <table class="memname">
  511. <tr>
  512. <td class="memname">float MotorSettings::mMinTorqueLimit = -FLT_MAX</td>
  513. </tr>
  514. </table>
  515. </div><div class="memdoc">
  516. <p>Minimum torque to apply in case of a angular constraint (N m). Usually this is -mMaxTorqueLimit unless you want a motor that can e.g. push but not pull. Not used when motor is a position motor. </p>
  517. </div>
  518. </div>
  519. <a id="a5a51d3f04aa12947eb85d08a1f01dab6" name="a5a51d3f04aa12947eb85d08a1f01dab6"></a>
  520. <h2 class="memtitle"><span class="permalink"><a href="#a5a51d3f04aa12947eb85d08a1f01dab6">&#9670;&#160;</a></span>mSpringSettings</h2>
  521. <div class="memitem">
  522. <div class="memproto">
  523. <table class="memname">
  524. <tr>
  525. <td class="memname"><a class="el" href="class_spring_settings.html">SpringSettings</a> MotorSettings::mSpringSettings { <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a>, 2.0f, 1.0f }</td>
  526. </tr>
  527. </table>
  528. </div><div class="memdoc">
  529. <p>Settings for the spring that is used to drive to the position target (not used when motor is a velocity motor). </p>
  530. </div>
  531. </div>
  532. <hr/>The documentation for this class was generated from the following files:<ul>
  533. <li>Jolt/Physics/Constraints/<a class="el" href="_motor_settings_8h_source.html">MotorSettings.h</a></li>
  534. <li>Jolt/Physics/Constraints/<a class="el" href="_motor_settings_8cpp.html">MotorSettings.cpp</a></li>
  535. </ul>
  536. </div><!-- contents -->
  537. </div><!-- doc-content -->
  538. <!-- start footer part -->
  539. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  540. <ul>
  541. <li class="navelem"><a class="el" href="class_motor_settings.html">MotorSettings</a></li>
  542. <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>
  543. </ul>
  544. </div>
  545. </body>
  546. </html>