| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.12.0"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Jolt Physics: MotorSettings Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <script type="text/javascript" src="clipboard.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="cookie.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/x-mathjax-config">
- MathJax.Hub.Config({
- extensions: ["tex2jax.js"],
- jax: ["input/TeX","output/HTML-CSS"],
- });
- </script>
- <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
- <td id="projectalign">
- <div id="projectname">Jolt Physics
- </div>
- <div id="projectbrief">A multi core friendly Game Physics Engine</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.12.0 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() { codefold.init(0); });
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search',true);
- $(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function(){initNavTree('class_motor_settings.html',''); initResizable(true); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="class_motor_settings-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">MotorSettings Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <<a class="el" href="_motor_settings_8h_source.html">MotorSettings.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a9931c598c884e6be4baea88a612ef59e" id="r_a9931c598c884e6be4baea88a612ef59e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9931c598c884e6be4baea88a612ef59e">MotorSettings</a> ()=default</td></tr>
- <tr class="memdesc:a9931c598c884e6be4baea88a612ef59e"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
- <tr class="separator:a9931c598c884e6be4baea88a612ef59e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3da51e1a3f8feb8e6a2b056c7e26d24b" id="r_a3da51e1a3f8feb8e6a2b056c7e26d24b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3da51e1a3f8feb8e6a2b056c7e26d24b">MotorSettings</a> (const <a class="el" href="class_motor_settings.html">MotorSettings</a> &)=default</td></tr>
- <tr class="separator:a3da51e1a3f8feb8e6a2b056c7e26d24b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a33d51a2bb5a231a689a1620577aed53a" id="r_a33d51a2bb5a231a689a1620577aed53a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_motor_settings.html">MotorSettings</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a33d51a2bb5a231a689a1620577aed53a">operator=</a> (const <a class="el" href="class_motor_settings.html">MotorSettings</a> &)=default</td></tr>
- <tr class="separator:a33d51a2bb5a231a689a1620577aed53a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a81a42488fb27a4e36f3f2802bca0bdcc" id="r_a81a42488fb27a4e36f3f2802bca0bdcc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a81a42488fb27a4e36f3f2802bca0bdcc">MotorSettings</a> (float inFrequency, float inDamping)</td></tr>
- <tr class="separator:a81a42488fb27a4e36f3f2802bca0bdcc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a280a8c958af57873bd500de0104ef574" id="r_a280a8c958af57873bd500de0104ef574"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a280a8c958af57873bd500de0104ef574">MotorSettings</a> (float inFrequency, float inDamping, float inForceLimit, float inTorqueLimit)</td></tr>
- <tr class="separator:a280a8c958af57873bd500de0104ef574"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a35ce9e0a888fed7059694121e7d8e66f" id="r_a35ce9e0a888fed7059694121e7d8e66f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a35ce9e0a888fed7059694121e7d8e66f">SetForceLimits</a> (float inMin, float inMax)</td></tr>
- <tr class="memdesc:a35ce9e0a888fed7059694121e7d8e66f"><td class="mdescLeft"> </td><td class="mdescRight">Set asymmetric force limits. <br /></td></tr>
- <tr class="separator:a35ce9e0a888fed7059694121e7d8e66f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3953c02a21926f36d415e805ffce289c" id="r_a3953c02a21926f36d415e805ffce289c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3953c02a21926f36d415e805ffce289c">SetTorqueLimits</a> (float inMin, float inMax)</td></tr>
- <tr class="memdesc:a3953c02a21926f36d415e805ffce289c"><td class="mdescLeft"> </td><td class="mdescRight">Set asymmetric torque limits. <br /></td></tr>
- <tr class="separator:a3953c02a21926f36d415e805ffce289c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7dbbf359da6a861e6876f702650dd5ea" id="r_a7dbbf359da6a861e6876f702650dd5ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7dbbf359da6a861e6876f702650dd5ea">SetForceLimit</a> (float inLimit)</td></tr>
- <tr class="memdesc:a7dbbf359da6a861e6876f702650dd5ea"><td class="mdescLeft"> </td><td class="mdescRight">Set symmetric force limits. <br /></td></tr>
- <tr class="separator:a7dbbf359da6a861e6876f702650dd5ea"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8eeaad102049c8586b180f516119ddeb" id="r_a8eeaad102049c8586b180f516119ddeb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8eeaad102049c8586b180f516119ddeb">SetTorqueLimit</a> (float inLimit)</td></tr>
- <tr class="memdesc:a8eeaad102049c8586b180f516119ddeb"><td class="mdescLeft"> </td><td class="mdescRight">Set symmetric torque limits. <br /></td></tr>
- <tr class="separator:a8eeaad102049c8586b180f516119ddeb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a86075f9a0d21b35897e7f6f7e9c50fbc" id="r_a86075f9a0d21b35897e7f6f7e9c50fbc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a86075f9a0d21b35897e7f6f7e9c50fbc">IsValid</a> () const</td></tr>
- <tr class="memdesc:a86075f9a0d21b35897e7f6f7e9c50fbc"><td class="mdescLeft"> </td><td class="mdescRight">Check if settings are valid. <br /></td></tr>
- <tr class="separator:a86075f9a0d21b35897e7f6f7e9c50fbc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac0a3de2c2c2545e381d5c00014bef682" id="r_ac0a3de2c2c2545e381d5c00014bef682"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0a3de2c2c2545e381d5c00014bef682">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &inStream) const</td></tr>
- <tr class="memdesc:ac0a3de2c2c2545e381d5c00014bef682"><td class="mdescLeft"> </td><td class="mdescRight">Saves the contents of the motor settings in binary form to inStream. <br /></td></tr>
- <tr class="separator:ac0a3de2c2c2545e381d5c00014bef682"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0d171537fc44218d3c3a6159a95aab74" id="r_a0d171537fc44218d3c3a6159a95aab74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d171537fc44218d3c3a6159a95aab74">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &inStream)</td></tr>
- <tr class="memdesc:a0d171537fc44218d3c3a6159a95aab74"><td class="mdescLeft"> </td><td class="mdescRight">Restores contents from the binary stream inStream. <br /></td></tr>
- <tr class="separator:a0d171537fc44218d3c3a6159a95aab74"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr class="memitem:a5a51d3f04aa12947eb85d08a1f01dab6" id="r_a5a51d3f04aa12947eb85d08a1f01dab6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_spring_settings.html">SpringSettings</a> </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>
- <tr class="memdesc:a5a51d3f04aa12947eb85d08a1f01dab6"><td class="mdescLeft"> </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>
- <tr class="separator:a5a51d3f04aa12947eb85d08a1f01dab6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8b066324ceb0052a8ff637e77d4e9c1" id="r_ac8b066324ceb0052a8ff637e77d4e9c1"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac8b066324ceb0052a8ff637e77d4e9c1">mMinForceLimit</a> = -FLT_MAX</td></tr>
- <tr class="memdesc:ac8b066324ceb0052a8ff637e77d4e9c1"><td class="mdescLeft"> </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>
- <tr class="separator:ac8b066324ceb0052a8ff637e77d4e9c1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aacf73d5d1dc3d729ed505b01f2b91425" id="r_aacf73d5d1dc3d729ed505b01f2b91425"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#aacf73d5d1dc3d729ed505b01f2b91425">mMaxForceLimit</a> = FLT_MAX</td></tr>
- <tr class="memdesc:aacf73d5d1dc3d729ed505b01f2b91425"><td class="mdescLeft"> </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>
- <tr class="separator:aacf73d5d1dc3d729ed505b01f2b91425"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7073ab453c838bef080a3386da6927bd" id="r_a7073ab453c838bef080a3386da6927bd"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7073ab453c838bef080a3386da6927bd">mMinTorqueLimit</a> = -FLT_MAX</td></tr>
- <tr class="memdesc:a7073ab453c838bef080a3386da6927bd"><td class="mdescLeft"> </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>
- <tr class="separator:a7073ab453c838bef080a3386da6927bd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a53921d266a57d01aa6833ca3fe09c3a7" id="r_a53921d266a57d01aa6833ca3fe09c3a7"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a53921d266a57d01aa6833ca3fe09c3a7">mMaxTorqueLimit</a> = FLT_MAX</td></tr>
- <tr class="memdesc:a53921d266a57d01aa6833ca3fe09c3a7"><td class="mdescLeft"> </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>
- <tr class="separator:a53921d266a57d01aa6833ca3fe09c3a7"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <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>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a9931c598c884e6be4baea88a612ef59e" name="a9931c598c884e6be4baea88a612ef59e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9931c598c884e6be4baea88a612ef59e">◆ </a></span>MotorSettings() <span class="overload">[1/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">MotorSettings::MotorSettings </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">default</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Constructor. </p>
- </div>
- </div>
- <a id="a3da51e1a3f8feb8e6a2b056c7e26d24b" name="a3da51e1a3f8feb8e6a2b056c7e26d24b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3da51e1a3f8feb8e6a2b056c7e26d24b">◆ </a></span>MotorSettings() <span class="overload">[2/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">MotorSettings::MotorSettings </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_motor_settings.html">MotorSettings</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">default</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a81a42488fb27a4e36f3f2802bca0bdcc" name="a81a42488fb27a4e36f3f2802bca0bdcc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a81a42488fb27a4e36f3f2802bca0bdcc">◆ </a></span>MotorSettings() <span class="overload">[3/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">MotorSettings::MotorSettings </td>
- <td>(</td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFrequency</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inDamping</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a280a8c958af57873bd500de0104ef574" name="a280a8c958af57873bd500de0104ef574"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a280a8c958af57873bd500de0104ef574">◆ </a></span>MotorSettings() <span class="overload">[4/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">MotorSettings::MotorSettings </td>
- <td>(</td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inFrequency</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inDamping</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inForceLimit</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inTorqueLimit</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a86075f9a0d21b35897e7f6f7e9c50fbc" name="a86075f9a0d21b35897e7f6f7e9c50fbc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a86075f9a0d21b35897e7f6f7e9c50fbc">◆ </a></span>IsValid()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool MotorSettings::IsValid </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Check if settings are valid. </p>
- </div>
- </div>
- <a id="a33d51a2bb5a231a689a1620577aed53a" name="a33d51a2bb5a231a689a1620577aed53a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a33d51a2bb5a231a689a1620577aed53a">◆ </a></span>operator=()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_motor_settings.html">MotorSettings</a> & MotorSettings::operator= </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_motor_settings.html">MotorSettings</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">default</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a0d171537fc44218d3c3a6159a95aab74" name="a0d171537fc44218d3c3a6159a95aab74"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0d171537fc44218d3c3a6159a95aab74">◆ </a></span>RestoreBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void MotorSettings::RestoreBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Restores contents from the binary stream inStream. </p>
- </div>
- </div>
- <a id="ac0a3de2c2c2545e381d5c00014bef682" name="ac0a3de2c2c2545e381d5c00014bef682"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac0a3de2c2c2545e381d5c00014bef682">◆ </a></span>SaveBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void MotorSettings::SaveBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Saves the contents of the motor settings in binary form to inStream. </p>
- </div>
- </div>
- <a id="a7dbbf359da6a861e6876f702650dd5ea" name="a7dbbf359da6a861e6876f702650dd5ea"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7dbbf359da6a861e6876f702650dd5ea">◆ </a></span>SetForceLimit()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void MotorSettings::SetForceLimit </td>
- <td>(</td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inLimit</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set symmetric force limits. </p>
- </div>
- </div>
- <a id="a35ce9e0a888fed7059694121e7d8e66f" name="a35ce9e0a888fed7059694121e7d8e66f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a35ce9e0a888fed7059694121e7d8e66f">◆ </a></span>SetForceLimits()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void MotorSettings::SetForceLimits </td>
- <td>(</td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMin</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMax</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set asymmetric force limits. </p>
- </div>
- </div>
- <a id="a8eeaad102049c8586b180f516119ddeb" name="a8eeaad102049c8586b180f516119ddeb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8eeaad102049c8586b180f516119ddeb">◆ </a></span>SetTorqueLimit()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void MotorSettings::SetTorqueLimit </td>
- <td>(</td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inLimit</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set symmetric torque limits. </p>
- </div>
- </div>
- <a id="a3953c02a21926f36d415e805ffce289c" name="a3953c02a21926f36d415e805ffce289c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3953c02a21926f36d415e805ffce289c">◆ </a></span>SetTorqueLimits()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void MotorSettings::SetTorqueLimits </td>
- <td>(</td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMin</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMax</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set asymmetric torque limits. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="aacf73d5d1dc3d729ed505b01f2b91425" name="aacf73d5d1dc3d729ed505b01f2b91425"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aacf73d5d1dc3d729ed505b01f2b91425">◆ </a></span>mMaxForceLimit</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float MotorSettings::mMaxForceLimit = FLT_MAX</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Maximum force to apply in case of a linear constraint (N). Not used when motor is an angular motor. </p>
- </div>
- </div>
- <a id="a53921d266a57d01aa6833ca3fe09c3a7" name="a53921d266a57d01aa6833ca3fe09c3a7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a53921d266a57d01aa6833ca3fe09c3a7">◆ </a></span>mMaxTorqueLimit</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float MotorSettings::mMaxTorqueLimit = FLT_MAX</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Maximum torque to apply in case of a angular constraint (N m). Not used when motor is a position motor. </p>
- </div>
- </div>
- <a id="ac8b066324ceb0052a8ff637e77d4e9c1" name="ac8b066324ceb0052a8ff637e77d4e9c1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac8b066324ceb0052a8ff637e77d4e9c1">◆ </a></span>mMinForceLimit</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float MotorSettings::mMinForceLimit = -FLT_MAX</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="a7073ab453c838bef080a3386da6927bd" name="a7073ab453c838bef080a3386da6927bd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7073ab453c838bef080a3386da6927bd">◆ </a></span>mMinTorqueLimit</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float MotorSettings::mMinTorqueLimit = -FLT_MAX</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="a5a51d3f04aa12947eb85d08a1f01dab6" name="a5a51d3f04aa12947eb85d08a1f01dab6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5a51d3f04aa12947eb85d08a1f01dab6">◆ </a></span>mSpringSettings</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <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>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Settings for the spring that is used to drive to the position target (not used when motor is a velocity motor). </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>Jolt/Physics/Constraints/<a class="el" href="_motor_settings_8h_source.html">MotorSettings.h</a></li>
- <li>Jolt/Physics/Constraints/<a class="el" href="_motor_settings_8cpp.html">MotorSettings.cpp</a></li>
- </ul>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="class_motor_settings.html">MotorSettings</a></li>
- <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>
- </ul>
- </div>
- </body>
- </html>
|