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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
							<!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: VehicleDifferentialSettings 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_vehicle_differential_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_vehicle_differential_settings-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">VehicleDifferentialSettings Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_vehicle_differential_8h_source.html">VehicleDifferential.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:aab96aa7556774945dbf7886849015af9" id="r_aab96aa7556774945dbf7886849015af9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aab96aa7556774945dbf7886849015af9">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
<tr class="memdesc:aab96aa7556774945dbf7886849015af9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents in binary form to inStream.  <br /></td></tr>
<tr class="separator:aab96aa7556774945dbf7886849015af9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57a075d772fdd921f8da88a9c4c2f0e7" id="r_a57a075d772fdd921f8da88a9c4c2f0e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57a075d772fdd921f8da88a9c4c2f0e7">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
<tr class="memdesc:a57a075d772fdd921f8da88a9c4c2f0e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores the contents in binary form to inStream.  <br /></td></tr>
<tr class="separator:a57a075d772fdd921f8da88a9c4c2f0e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcf68680b07ae1a917bfa0a9ff0be829" id="r_adcf68680b07ae1a917bfa0a9ff0be829"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adcf68680b07ae1a917bfa0a9ff0be829">CalculateTorqueRatio</a> (float inLeftAngularVelocity, float inRightAngularVelocity, float &amp;outLeftTorqueFraction, float &amp;outRightTorqueFraction) const</td></tr>
<tr class="separator:adcf68680b07ae1a917bfa0a9ff0be829"><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:a55fb4d9bec462184471ba37ec367bd90" id="r_a55fb4d9bec462184471ba37ec367bd90"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a55fb4d9bec462184471ba37ec367bd90">mLeftWheel</a> = -1</td></tr>
<tr class="memdesc:a55fb4d9bec462184471ba37ec367bd90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index (in mWheels) that represents the left wheel of this differential (can be -1 to indicate no wheel)  <br /></td></tr>
<tr class="separator:a55fb4d9bec462184471ba37ec367bd90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6b9ff3394079722a2255b9ec20ecbfd" id="r_ad6b9ff3394079722a2255b9ec20ecbfd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad6b9ff3394079722a2255b9ec20ecbfd">mRightWheel</a> = -1</td></tr>
<tr class="memdesc:ad6b9ff3394079722a2255b9ec20ecbfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index (in mWheels) that represents the right wheel of this differential (can be -1 to indicate no wheel)  <br /></td></tr>
<tr class="separator:ad6b9ff3394079722a2255b9ec20ecbfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a172648d9abd2125049692c9562488498" id="r_a172648d9abd2125049692c9562488498"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a172648d9abd2125049692c9562488498">mDifferentialRatio</a> = 3.42f</td></tr>
<tr class="memdesc:a172648d9abd2125049692c9562488498"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ratio between rotation speed of gear box and wheels.  <br /></td></tr>
<tr class="separator:a172648d9abd2125049692c9562488498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85f84f17c3b26d4cef5b1036e3da9728" id="r_a85f84f17c3b26d4cef5b1036e3da9728"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a85f84f17c3b26d4cef5b1036e3da9728">mLeftRightSplit</a> = 0.5f</td></tr>
<tr class="memdesc:a85f84f17c3b26d4cef5b1036e3da9728"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines how the engine torque is split across the left and right wheel (0 = left, 0.5 = center, 1 = right)  <br /></td></tr>
<tr class="separator:a85f84f17c3b26d4cef5b1036e3da9728"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5556c4beadddfc653931faeafddbc18" id="r_ad5556c4beadddfc653931faeafddbc18"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad5556c4beadddfc653931faeafddbc18">mLimitedSlipRatio</a> = 1.4f</td></tr>
<tr class="memdesc:ad5556c4beadddfc653931faeafddbc18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ratio max / min wheel speed. When this ratio is exceeded, all torque gets distributed to the slowest moving wheel. This allows implementing a limited slip differential. Set to FLT_MAX for an open differential. Value should be &gt; 1.  <br /></td></tr>
<tr class="separator:ad5556c4beadddfc653931faeafddbc18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0d4ed7b362ab81c9d0e0e4422e40519" id="r_ac0d4ed7b362ab81c9d0e0e4422e40519"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0d4ed7b362ab81c9d0e0e4422e40519">mEngineTorqueRatio</a> = 1.0f</td></tr>
<tr class="memdesc:ac0d4ed7b362ab81c9d0e0e4422e40519"><td class="mdescLeft">&#160;</td><td class="mdescRight">How much of the engines torque is applied to this differential (0 = none, 1 = full), make sure the sum of all differentials is 1.  <br /></td></tr>
<tr class="separator:ac0d4ed7b362ab81c9d0e0e4422e40519"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adcf68680b07ae1a917bfa0a9ff0be829" name="adcf68680b07ae1a917bfa0a9ff0be829"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcf68680b07ae1a917bfa0a9ff0be829">&#9670;&#160;</a></span>CalculateTorqueRatio()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleDifferentialSettings::CalculateTorqueRatio </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inLeftAngularVelocity</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inRightAngularVelocity</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float &amp;</td>          <td class="paramname"><span class="paramname"><em>outLeftTorqueFraction</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float &amp;</td>          <td class="paramname"><span class="paramname"><em>outRightTorqueFraction</em></span>&#160;) const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Calculate the torque ratio between left and right wheel </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inLeftAngularVelocity</td><td>Angular velocity of left wheel (rad / s) </td></tr>
    <tr><td class="paramname">inRightAngularVelocity</td><td>Angular velocity of right wheel (rad / s) </td></tr>
    <tr><td class="paramname">outLeftTorqueFraction</td><td>Fraction of torque that should go to the left wheel </td></tr>
    <tr><td class="paramname">outRightTorqueFraction</td><td>Fraction of torque that should go to the right wheel </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleDifferentialSettings::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 the contents in binary form to inStream. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleDifferentialSettings::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 in binary form to inStream. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleDifferentialSettings::mDifferentialRatio = 3.42f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Ratio between rotation speed of gear box and wheels. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleDifferentialSettings::mEngineTorqueRatio = 1.0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How much of the engines torque is applied to this differential (0 = none, 1 = full), make sure the sum of all differentials is 1. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleDifferentialSettings::mLeftRightSplit = 0.5f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Defines how the engine torque is split across the left and right wheel (0 = left, 0.5 = center, 1 = right) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int VehicleDifferentialSettings::mLeftWheel = -1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Index (in mWheels) that represents the left wheel of this differential (can be -1 to indicate no wheel) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleDifferentialSettings::mLimitedSlipRatio = 1.4f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Ratio max / min wheel speed. When this ratio is exceeded, all torque gets distributed to the slowest moving wheel. This allows implementing a limited slip differential. Set to FLT_MAX for an open differential. Value should be &gt; 1. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int VehicleDifferentialSettings::mRightWheel = -1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Index (in mWheels) that represents the right wheel of this differential (can be -1 to indicate no wheel) </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_differential_8h_source.html">VehicleDifferential.h</a></li>
<li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_differential_8cpp.html">VehicleDifferential.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_vehicle_differential_settings.html">VehicleDifferentialSettings</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>