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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
							<!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: SpringPart 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_part.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="class_spring_part-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">SpringPart Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Class used in other constraint parts to calculate the required bias factor in the lagrange multiplier for creating springs.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_spring_part_8h_source.html">SpringPart.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:a75d1d4a45e975a5b9b0ad99525c9f52f" id="r_a75d1d4a45e975a5b9b0ad99525c9f52f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a75d1d4a45e975a5b9b0ad99525c9f52f">CalculateSpringPropertiesWithBias</a> (float inBias)</td></tr>
<tr class="separator:a75d1d4a45e975a5b9b0ad99525c9f52f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0414048df549022dee152c2b18b31126" id="r_a0414048df549022dee152c2b18b31126"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0414048df549022dee152c2b18b31126">CalculateSpringPropertiesWithFrequencyAndDamping</a> (float inDeltaTime, float inInvEffectiveMass, float inBias, float inC, float inFrequency, float inDamping, float &amp;outEffectiveMass)</td></tr>
<tr class="separator:a0414048df549022dee152c2b18b31126"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a318ab5426c6b10a8ceebd3258144d20a" id="r_a318ab5426c6b10a8ceebd3258144d20a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a318ab5426c6b10a8ceebd3258144d20a">CalculateSpringPropertiesWithStiffnessAndDamping</a> (float inDeltaTime, float inInvEffectiveMass, float inBias, float inC, float inStiffness, float inDamping, float &amp;outEffectiveMass)</td></tr>
<tr class="separator:a318ab5426c6b10a8ceebd3258144d20a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dbe7d09f4a6aaf7f5edd106fb6fe335" id="r_a9dbe7d09f4a6aaf7f5edd106fb6fe335"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9dbe7d09f4a6aaf7f5edd106fb6fe335">IsActive</a> () const</td></tr>
<tr class="memdesc:a9dbe7d09f4a6aaf7f5edd106fb6fe335"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if this spring is active.  <br /></td></tr>
<tr class="separator:a9dbe7d09f4a6aaf7f5edd106fb6fe335"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42a39d96e15ae84419256c35067e12ad" id="r_a42a39d96e15ae84419256c35067e12ad"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42a39d96e15ae84419256c35067e12ad">GetBias</a> (float inTotalLambda) const</td></tr>
<tr class="memdesc:a42a39d96e15ae84419256c35067e12ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get total bias b, including supplied bias and bias for spring: lambda = J v + b.  <br /></td></tr>
<tr class="separator:a42a39d96e15ae84419256c35067e12ad"><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>Class used in other constraint parts to calculate the required bias factor in the lagrange multiplier for creating springs. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a75d1d4a45e975a5b9b0ad99525c9f52f" name="a75d1d4a45e975a5b9b0ad99525c9f52f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75d1d4a45e975a5b9b0ad99525c9f52f">&#9670;&#160;</a></span>CalculateSpringPropertiesWithBias()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SpringPart::CalculateSpringPropertiesWithBias </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inBias</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>Turn off the spring and set a bias only</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inBias</td><td>Bias term (b) for the constraint impulse: lambda = J v + b </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SpringPart::CalculateSpringPropertiesWithFrequencyAndDamping </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inDeltaTime</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inInvEffectiveMass</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inBias</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inC</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></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 &amp;</td>          <td class="paramname"><span class="paramname"><em>outEffectiveMass</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">
<p>Calculate spring properties based on frequency and damping ratio</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inDeltaTime</td><td>Time step </td></tr>
    <tr><td class="paramname">inInvEffectiveMass</td><td>Inverse effective mass K </td></tr>
    <tr><td class="paramname">inBias</td><td>Bias term (b) for the constraint impulse: lambda = J v + b </td></tr>
    <tr><td class="paramname">inC</td><td>Value of the constraint equation (C). Set to zero if you don't want to drive the constraint to zero with a spring. </td></tr>
    <tr><td class="paramname">inFrequency</td><td>Oscillation frequency (Hz). Set to zero if you don't want to drive the constraint to zero with a spring. </td></tr>
    <tr><td class="paramname">inDamping</td><td>Damping factor (0 = no damping, 1 = critical damping). Set to zero if you don't want to drive the constraint to zero with a spring. </td></tr>
    <tr><td class="paramname">outEffectiveMass</td><td>On return, this contains the new effective mass K^-1 </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SpringPart::CalculateSpringPropertiesWithStiffnessAndDamping </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inDeltaTime</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inInvEffectiveMass</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inBias</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inC</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inStiffness</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 &amp;</td>          <td class="paramname"><span class="paramname"><em>outEffectiveMass</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">
<p>Calculate spring properties with spring Stiffness (k) and damping (c), this is based on the spring equation: F = -k * x - c * v</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inDeltaTime</td><td>Time step </td></tr>
    <tr><td class="paramname">inInvEffectiveMass</td><td>Inverse effective mass K </td></tr>
    <tr><td class="paramname">inBias</td><td>Bias term (b) for the constraint impulse: lambda = J v + b </td></tr>
    <tr><td class="paramname">inC</td><td>Value of the constraint equation (C). Set to zero if you don't want to drive the constraint to zero with a spring. </td></tr>
    <tr><td class="paramname">inStiffness</td><td>Spring stiffness k. Set to zero if you don't want to drive the constraint to zero with a spring. </td></tr>
    <tr><td class="paramname">inDamping</td><td>Spring damping coefficient c. Set to zero if you don't want to drive the constraint to zero with a spring. </td></tr>
    <tr><td class="paramname">outEffectiveMass</td><td>On return, this contains the new effective mass K^-1 </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float SpringPart::GetBias </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inTotalLambda</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>Get total bias b, including supplied bias and bias for spring: lambda = J v + b. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool SpringPart::IsActive </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>Returns if this spring is active. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Physics/Constraints/ConstraintPart/<a class="el" href="_spring_part_8h_source.html">SpringPart.h</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_part.html">SpringPart</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>