cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
							<!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: SpringSettings 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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_spring_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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_spring_settings-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">SpringSettings Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Settings for a linear or angular spring.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_spring_settings_8h_source.html">SpringSettings.h</a>&gt;</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:aefa8b0caa0840d58f74b297ad275c1cf" id="r_aefa8b0caa0840d58f74b297ad275c1cf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aefa8b0caa0840d58f74b297ad275c1cf">SpringSettings</a> ()=default</td></tr>
<tr class="memdesc:aefa8b0caa0840d58f74b297ad275c1cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:aefa8b0caa0840d58f74b297ad275c1cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad21b30d2d06ed66e8660ccfc14403827" id="r_ad21b30d2d06ed66e8660ccfc14403827"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad21b30d2d06ed66e8660ccfc14403827">SpringSettings</a> (const <a class="el" href="class_spring_settings.html">SpringSettings</a> &amp;)=default</td></tr>
<tr class="separator:ad21b30d2d06ed66e8660ccfc14403827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a035ab930afc30365053d1814f838f335" id="r_a035ab930afc30365053d1814f838f335"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_spring_settings.html">SpringSettings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a035ab930afc30365053d1814f838f335">operator=</a> (const <a class="el" href="class_spring_settings.html">SpringSettings</a> &amp;)=default</td></tr>
<tr class="separator:a035ab930afc30365053d1814f838f335"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cf17470851be12c258e0c2f200f27e4" id="r_a3cf17470851be12c258e0c2f200f27e4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cf17470851be12c258e0c2f200f27e4">SpringSettings</a> (<a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a> inMode, float inFrequencyOrStiffness, float inDamping)</td></tr>
<tr class="separator:a3cf17470851be12c258e0c2f200f27e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8da853a3005b1797148dd6c8350d0c62" id="r_a8da853a3005b1797148dd6c8350d0c62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8da853a3005b1797148dd6c8350d0c62">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
<tr class="memdesc:a8da853a3005b1797148dd6c8350d0c62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents of the spring settings in binary form to inStream.  <br /></td></tr>
<tr class="separator:a8da853a3005b1797148dd6c8350d0c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6f75e6e5167b54a2cff64808a106297" id="r_af6f75e6e5167b54a2cff64808a106297"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af6f75e6e5167b54a2cff64808a106297">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
<tr class="memdesc:af6f75e6e5167b54a2cff64808a106297"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores contents from the binary stream inStream.  <br /></td></tr>
<tr class="separator:af6f75e6e5167b54a2cff64808a106297"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb683eddb2db25f62403a6af6410eebb" id="r_afb683eddb2db25f62403a6af6410eebb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb683eddb2db25f62403a6af6410eebb">HasStiffness</a> () const</td></tr>
<tr class="memdesc:afb683eddb2db25f62403a6af6410eebb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the spring has a valid frequency / stiffness, if not the spring will be hard.  <br /></td></tr>
<tr class="separator:afb683eddb2db25f62403a6af6410eebb"><td class="memSeparator" colspan="2">&#160;</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:a7d27c541e7d25d9da0c263ec99ea528a" id="r_a7d27c541e7d25d9da0c263ec99ea528a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7d27c541e7d25d9da0c263ec99ea528a">mMode</a> = <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a></td></tr>
<tr class="separator:a7d27c541e7d25d9da0c263ec99ea528a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22be9edf8636e091201e3191e47efbe4" id="r_a22be9edf8636e091201e3191e47efbe4"><td class="memItemLeft" >union {&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66afd2dacb3aa59de882ad5e87b5153a" id="r_a66afd2dacb3aa59de882ad5e87b5153a"><td class="memItemLeft" >&#160;&#160;&#160;float&#160;&#160;&#160;<a class="el" href="#acea8e3f5767edbfaffa01417733b5dc0">mFrequency</a> = 0.0f&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a66afd2dacb3aa59de882ad5e87b5153a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f527b170cdab4b15e295d719b485984" id="r_a9f527b170cdab4b15e295d719b485984"><td class="memItemLeft" >&#160;&#160;&#160;float&#160;&#160;&#160;<a class="el" href="#a688815c0e85518f1ac42f1d077415472">mStiffness</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a9f527b170cdab4b15e295d719b485984"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22be9edf8636e091201e3191e47efbe4" id="r_a22be9edf8636e091201e3191e47efbe4"><td class="memItemLeft" valign="top">};&#160;</td><td class="memItemRight" valign="bottom">&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a22be9edf8636e091201e3191e47efbe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72165bbe14974afb17df18e88f6d205e" id="r_a72165bbe14974afb17df18e88f6d205e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a72165bbe14974afb17df18e88f6d205e">mDamping</a> = 0.0f</td></tr>
<tr class="separator:a72165bbe14974afb17df18e88f6d205e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Settings for a linear or angular spring. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aefa8b0caa0840d58f74b297ad275c1cf" name="aefa8b0caa0840d58f74b297ad275c1cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefa8b0caa0840d58f74b297ad275c1cf">&#9670;&#160;</a></span>SpringSettings() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SpringSettings::SpringSettings </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="ad21b30d2d06ed66e8660ccfc14403827" name="ad21b30d2d06ed66e8660ccfc14403827"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad21b30d2d06ed66e8660ccfc14403827">&#9670;&#160;</a></span>SpringSettings() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SpringSettings::SpringSettings </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_spring_settings.html">SpringSettings</a> &amp;</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="a3cf17470851be12c258e0c2f200f27e4" name="a3cf17470851be12c258e0c2f200f27e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cf17470851be12c258e0c2f200f27e4">&#9670;&#160;</a></span>SpringSettings() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SpringSettings::SpringSettings </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a></td>          <td class="paramname"><span class="paramname"><em>inMode</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inFrequencyOrStiffness</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>&#160;)</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="afb683eddb2db25f62403a6af6410eebb" name="afb683eddb2db25f62403a6af6410eebb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb683eddb2db25f62403a6af6410eebb">&#9670;&#160;</a></span>HasStiffness()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool SpringSettings::HasStiffness </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 the spring has a valid frequency / stiffness, if not the spring will be hard. </p>

</div>
</div>
<a id="a035ab930afc30365053d1814f838f335" name="a035ab930afc30365053d1814f838f335"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a035ab930afc30365053d1814f838f335">&#9670;&#160;</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_spring_settings.html">SpringSettings</a> &amp; SpringSettings::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_spring_settings.html">SpringSettings</a> &amp;</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="af6f75e6e5167b54a2cff64808a106297" name="af6f75e6e5167b54a2cff64808a106297"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6f75e6e5167b54a2cff64808a106297">&#9670;&#160;</a></span>RestoreBinaryState()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SpringSettings::RestoreBinaryState </td>
          <td>(</td>
          <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>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Restores contents from the binary stream inStream. </p>

</div>
</div>
<a id="a8da853a3005b1797148dd6c8350d0c62" name="a8da853a3005b1797148dd6c8350d0c62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8da853a3005b1797148dd6c8350d0c62">&#9670;&#160;</a></span>SaveBinaryState()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SpringSettings::SaveBinaryState </td>
          <td>(</td>
          <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>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Saves the contents of the spring settings in binary form to inStream. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a22be9edf8636e091201e3191e47efbe4" name="a22be9edf8636e091201e3191e47efbe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22be9edf8636e091201e3191e47efbe4">&#9670;&#160;</a></span>[union]</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union  { ... }  <a class="el" href="class_spring_settings.html">SpringSettings</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a72165bbe14974afb17df18e88f6d205e" name="a72165bbe14974afb17df18e88f6d205e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72165bbe14974afb17df18e88f6d205e">&#9670;&#160;</a></span>mDamping</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float SpringSettings::mDamping = 0.0f</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>When mSpringMode = <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018" title="Frequency and damping are specified.">ESpringMode::FrequencyAndDamping</a> mDamping is the damping ratio (0 = no damping, 1 = critical damping). When mSpringMode = <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da80c2dd5c28197f2baebff76bf0299d47" title="Stiffness and damping are specified.">ESpringMode::StiffnessAndDamping</a> mDamping is the damping (c) in the spring equation F = -k * x - c * v for a linear or T = -k * theta - c * w for an angular spring. Note that if you set mDamping = 0, you will not get an infinite oscillation. Because we integrate physics using an explicit Euler scheme, there is always energy loss. This is done to keep the simulation from exploding, because with a damping of 0 and even the slightest rounding error, the oscillation could become bigger and bigger until the simulation explodes. </p>

</div>
</div>
<a id="acea8e3f5767edbfaffa01417733b5dc0" name="acea8e3f5767edbfaffa01417733b5dc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acea8e3f5767edbfaffa01417733b5dc0">&#9670;&#160;</a></span>mFrequency</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float SpringSettings::mFrequency = 0.0f</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Valid when mSpringMode = <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018" title="Frequency and damping are specified.">ESpringMode::FrequencyAndDamping</a>. If mFrequency &gt; 0 the constraint will be soft and mFrequency specifies the oscillation frequency in Hz. If mFrequency &lt;= 0, mDamping is ignored and the constraint will have hard limits (as hard as the time step / the number of velocity / position solver steps allows). </p>

</div>
</div>
<a id="a7d27c541e7d25d9da0c263ec99ea528a" name="a7d27c541e7d25d9da0c263ec99ea528a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d27c541e7d25d9da0c263ec99ea528a">&#9670;&#160;</a></span>mMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512d">ESpringMode</a> SpringSettings::mMode = <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Selects the way in which the spring is defined If the mode is StiffnessAndDamping then mFrequency becomes the stiffness (k) and mDamping becomes the damping ratio (c) in the spring equation F = -k * x - c * v. Otherwise the properties are as documented. </p>

</div>
</div>
<a id="a688815c0e85518f1ac42f1d077415472" name="a688815c0e85518f1ac42f1d077415472"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a688815c0e85518f1ac42f1d077415472">&#9670;&#160;</a></span>mStiffness</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float SpringSettings::mStiffness</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Valid when mSpringMode = <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da80c2dd5c28197f2baebff76bf0299d47" title="Stiffness and damping are specified.">ESpringMode::StiffnessAndDamping</a>. If mStiffness &gt; 0 the constraint will be soft and mStiffness specifies the stiffness (k) in the spring equation F = -k * x - c * v for a linear or T = -k * theta - c * w for an angular spring. If mStiffness &lt;= 0, mDamping is ignored and the constraint will have hard limits (as hard as the time step / the number of velocity / position solver steps allows).</p>
<p>Note that stiffness values are large numbers. To calculate a ballpark value for the needed stiffness you can use: force = stiffness * delta_spring_length = mass * gravity &lt;=&gt; stiffness = mass * gravity / delta_spring_length. So if your object weighs 1500 kg and the spring compresses by 2 meters, you need a stiffness in the order of 1500 * 9.81 / 2 ~ 7500 N/m. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Physics/Constraints/<a class="el" href="_spring_settings_8h_source.html">SpringSettings.h</a></li>
<li>Jolt/Physics/Constraints/<a class="el" href="_spring_settings_8cpp.html">SpringSettings.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_spring_settings.html">SpringSettings</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>