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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570
							<!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: VehicleEngine 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_engine.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-static-attribs">Static Public Attributes</a> &#124;
<a href="class_vehicle_engine-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">VehicleEngine Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Runtime data for engine.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_vehicle_engine_8h_source.html">VehicleEngine.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VehicleEngine:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_vehicle_engine.png" usemap="#VehicleEngine_map" alt=""/>
  <map id="VehicleEngine_map" name="VehicleEngine_map">
<area href="class_vehicle_engine_settings.html" title="Generic properties for a vehicle engine." alt="VehicleEngineSettings" shape="rect" coords="0,0,138,24"/>
  </map>
</div></div>
<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:a10cc014bfd4c08086fc83ef73948c7ba" id="r_a10cc014bfd4c08086fc83ef73948c7ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a10cc014bfd4c08086fc83ef73948c7ba">ClampRPM</a> ()</td></tr>
<tr class="memdesc:a10cc014bfd4c08086fc83ef73948c7ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clamp the RPM between min and max RPM.  <br /></td></tr>
<tr class="separator:a10cc014bfd4c08086fc83ef73948c7ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1f11f381d186b50721cbc058931a2b5" id="r_ac1f11f381d186b50721cbc058931a2b5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1f11f381d186b50721cbc058931a2b5">GetCurrentRPM</a> () const</td></tr>
<tr class="memdesc:ac1f11f381d186b50721cbc058931a2b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current rotation speed of engine in rounds per minute.  <br /></td></tr>
<tr class="separator:ac1f11f381d186b50721cbc058931a2b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab37d0e87f872355e595960fa18510861" id="r_ab37d0e87f872355e595960fa18510861"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab37d0e87f872355e595960fa18510861">SetCurrentRPM</a> (float inRPM)</td></tr>
<tr class="memdesc:ab37d0e87f872355e595960fa18510861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update rotation speed of engine in rounds per minute.  <br /></td></tr>
<tr class="separator:ab37d0e87f872355e595960fa18510861"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6735223f4b1d1fc898309e671504731" id="r_ae6735223f4b1d1fc898309e671504731"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6735223f4b1d1fc898309e671504731">GetAngularVelocity</a> () const</td></tr>
<tr class="memdesc:ae6735223f4b1d1fc898309e671504731"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current angular velocity of the engine in radians / second.  <br /></td></tr>
<tr class="separator:ae6735223f4b1d1fc898309e671504731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22815f9d97cb6318b0b6a3df66e0f6d5" id="r_a22815f9d97cb6318b0b6a3df66e0f6d5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a22815f9d97cb6318b0b6a3df66e0f6d5">GetTorque</a> (float inAcceleration) const</td></tr>
<tr class="separator:a22815f9d97cb6318b0b6a3df66e0f6d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af916ceb8c4a323cee68c72465627901e" id="r_af916ceb8c4a323cee68c72465627901e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af916ceb8c4a323cee68c72465627901e">ApplyTorque</a> (float inTorque, float inDeltaTime)</td></tr>
<tr class="separator:af916ceb8c4a323cee68c72465627901e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad61683b9088153079e3e47334c2caf1a" id="r_ad61683b9088153079e3e47334c2caf1a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad61683b9088153079e3e47334c2caf1a">ApplyDamping</a> (float inDeltaTime)</td></tr>
<tr class="separator:ad61683b9088153079e3e47334c2caf1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39842ae2cd4c9520f0d194814c92d3d1" id="r_a39842ae2cd4c9520f0d194814c92d3d1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a39842ae2cd4c9520f0d194814c92d3d1">ConvertRPMToAngle</a> (float inRPM) const</td></tr>
<tr class="separator:a39842ae2cd4c9520f0d194814c92d3d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b616470faf6ab7c46026706a7c708df" id="r_a1b616470faf6ab7c46026706a7c708df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b616470faf6ab7c46026706a7c708df">DrawRPM</a> (<a class="el" href="class_debug_renderer.html">DebugRenderer</a> *inRenderer, <a class="el" href="_real_8h.html#a43bea2d9c57780b4b66bab1312fd77f3">RVec3Arg</a> inPosition, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inForward, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inUp, float inSize, float inShiftDownRPM, float inShiftUpRPM) const</td></tr>
<tr class="memdesc:a1b616470faf6ab7c46026706a7c708df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug draw a RPM meter.  <br /></td></tr>
<tr class="separator:a1b616470faf6ab7c46026706a7c708df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a542f9131ecce2c3f41526c44759b913b" id="r_a542f9131ecce2c3f41526c44759b913b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a542f9131ecce2c3f41526c44759b913b">AllowSleep</a> () const</td></tr>
<tr class="memdesc:a542f9131ecce2c3f41526c44759b913b"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the engine is idle we allow the vehicle to sleep.  <br /></td></tr>
<tr class="separator:a542f9131ecce2c3f41526c44759b913b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14fa6274b90508346dedcc3e21864204" id="r_a14fa6274b90508346dedcc3e21864204"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14fa6274b90508346dedcc3e21864204">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
<tr class="memdesc:a14fa6274b90508346dedcc3e21864204"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saving state for replay.  <br /></td></tr>
<tr class="separator:a14fa6274b90508346dedcc3e21864204"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1465f66b9bddf12998cd990c8ba05140" id="r_a1465f66b9bddf12998cd990c8ba05140"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1465f66b9bddf12998cd990c8ba05140">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
<tr class="separator:a1465f66b9bddf12998cd990c8ba05140"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_vehicle_engine_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_vehicle_engine_settings')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_vehicle_engine_settings.html">VehicleEngineSettings</a></td></tr>
<tr class="memitem:aa326151c7c343427669a4790b84d7697 inherit pub_methods_class_vehicle_engine_settings" id="r_aa326151c7c343427669a4790b84d7697"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#aa326151c7c343427669a4790b84d7697">VehicleEngineSettings</a> ()</td></tr>
<tr class="memdesc:aa326151c7c343427669a4790b84d7697 inherit pub_methods_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:aa326151c7c343427669a4790b84d7697 inherit pub_methods_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82b4677535f7f39e68081227caf4b547 inherit pub_methods_class_vehicle_engine_settings" id="r_a82b4677535f7f39e68081227caf4b547"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#a82b4677535f7f39e68081227caf4b547">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
<tr class="memdesc:a82b4677535f7f39e68081227caf4b547 inherit pub_methods_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents in binary form to inStream.  <br /></td></tr>
<tr class="separator:a82b4677535f7f39e68081227caf4b547 inherit pub_methods_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07beafb1531780053169dbc05283ed26 inherit pub_methods_class_vehicle_engine_settings" id="r_a07beafb1531780053169dbc05283ed26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#a07beafb1531780053169dbc05283ed26">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
<tr class="memdesc:a07beafb1531780053169dbc05283ed26 inherit pub_methods_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores the contents in binary form to inStream.  <br /></td></tr>
<tr class="separator:a07beafb1531780053169dbc05283ed26 inherit pub_methods_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a0e023a5dd52ec73e3fc43071e52296b2" id="r_a0e023a5dd52ec73e3fc43071e52296b2"><td class="memItemLeft" align="right" valign="top">static constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e023a5dd52ec73e3fc43071e52296b2">cAngularVelocityToRPM</a> = 60.0f / (2.0f * JPH_PI)</td></tr>
<tr class="memdesc:a0e023a5dd52ec73e3fc43071e52296b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiply an angular velocity (rad/s) with this value to get rounds per minute (RPM)  <br /></td></tr>
<tr class="separator:a0e023a5dd52ec73e3fc43071e52296b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_class_vehicle_engine_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_vehicle_engine_settings')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_vehicle_engine_settings.html">VehicleEngineSettings</a></td></tr>
<tr class="memitem:a406aada0f8bcbf536d743de1f8f77329 inherit pub_attribs_class_vehicle_engine_settings" id="r_a406aada0f8bcbf536d743de1f8f77329"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#a406aada0f8bcbf536d743de1f8f77329">mMaxTorque</a> = 500.0f</td></tr>
<tr class="memdesc:a406aada0f8bcbf536d743de1f8f77329 inherit pub_attribs_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max amount of torque (Nm) that the engine can deliver.  <br /></td></tr>
<tr class="separator:a406aada0f8bcbf536d743de1f8f77329 inherit pub_attribs_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ac03e624a16d07af8d20dee5a1924bb inherit pub_attribs_class_vehicle_engine_settings" id="r_a0ac03e624a16d07af8d20dee5a1924bb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#a0ac03e624a16d07af8d20dee5a1924bb">mMinRPM</a> = 1000.0f</td></tr>
<tr class="memdesc:a0ac03e624a16d07af8d20dee5a1924bb inherit pub_attribs_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Min amount of revolutions per minute (rpm) the engine can produce without stalling.  <br /></td></tr>
<tr class="separator:a0ac03e624a16d07af8d20dee5a1924bb inherit pub_attribs_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68b6fa14900e23076bb25b3280fef3c5 inherit pub_attribs_class_vehicle_engine_settings" id="r_a68b6fa14900e23076bb25b3280fef3c5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#a68b6fa14900e23076bb25b3280fef3c5">mMaxRPM</a> = 6000.0f</td></tr>
<tr class="memdesc:a68b6fa14900e23076bb25b3280fef3c5 inherit pub_attribs_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max amount of revolutions per minute (rpm) the engine can generate.  <br /></td></tr>
<tr class="separator:a68b6fa14900e23076bb25b3280fef3c5 inherit pub_attribs_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aa42e9f8a1eabe44171c7b2344661f0 inherit pub_attribs_class_vehicle_engine_settings" id="r_a2aa42e9f8a1eabe44171c7b2344661f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_linear_curve.html">LinearCurve</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#a2aa42e9f8a1eabe44171c7b2344661f0">mNormalizedTorque</a></td></tr>
<tr class="memdesc:a2aa42e9f8a1eabe44171c7b2344661f0 inherit pub_attribs_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Y-axis: Curve that describes a ratio of the max torque the engine can produce (0 = 0, 1 = mMaxTorque). X-axis: the fraction of the RPM of the engine (0 = mMinRPM, 1 = mMaxRPM)  <br /></td></tr>
<tr class="separator:a2aa42e9f8a1eabe44171c7b2344661f0 inherit pub_attribs_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe75cc5c2522753f6f5e4ffc6035a183 inherit pub_attribs_class_vehicle_engine_settings" id="r_abe75cc5c2522753f6f5e4ffc6035a183"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#abe75cc5c2522753f6f5e4ffc6035a183">mInertia</a> = 0.5f</td></tr>
<tr class="memdesc:abe75cc5c2522753f6f5e4ffc6035a183 inherit pub_attribs_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moment of inertia (kg m^2) of the engine.  <br /></td></tr>
<tr class="separator:abe75cc5c2522753f6f5e4ffc6035a183 inherit pub_attribs_class_vehicle_engine_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a721c1a1f97766d41844a337ca4ba1e0b inherit pub_attribs_class_vehicle_engine_settings" id="r_a721c1a1f97766d41844a337ca4ba1e0b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_engine_settings.html#a721c1a1f97766d41844a337ca4ba1e0b">mAngularDamping</a> = 0.2f</td></tr>
<tr class="memdesc:a721c1a1f97766d41844a337ca4ba1e0b inherit pub_attribs_class_vehicle_engine_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Angular damping factor of the wheel: dw/dt = -c * w. Value should be zero or positive and is usually close to 0.  <br /></td></tr>
<tr class="separator:a721c1a1f97766d41844a337ca4ba1e0b inherit pub_attribs_class_vehicle_engine_settings"><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>Runtime data for engine. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a542f9131ecce2c3f41526c44759b913b" name="a542f9131ecce2c3f41526c44759b913b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a542f9131ecce2c3f41526c44759b913b">&#9670;&#160;</a></span>AllowSleep()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool VehicleEngine::AllowSleep </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>If the engine is idle we allow the vehicle to sleep. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleEngine::ApplyDamping </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inDeltaTime</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Update the engine RPM for damping </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inDeltaTime</td><td>Delta time in seconds </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleEngine::ApplyTorque </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inTorque</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inDeltaTime</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Apply a torque to the engine rotation speed </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inTorque</td><td>Torque in N m </td></tr>
    <tr><td class="paramname">inDeltaTime</td><td>Delta time in seconds </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleEngine::ClampRPM </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Clamp the RPM between min and max RPM. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleEngine::ConvertRPMToAngle </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inRPM</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">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleEngine::DrawRPM </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_debug_renderer.html">DebugRenderer</a> *</td>          <td class="paramname"><span class="paramname"><em>inRenderer</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_real_8h.html#a43bea2d9c57780b4b66bab1312fd77f3">RVec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inPosition</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inForward</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inUp</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inSize</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inShiftDownRPM</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inShiftUpRPM</em></span>&#160;) const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Debug draw a RPM meter. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleEngine::GetAngularVelocity </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>Get current angular velocity of the engine in radians / second. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleEngine::GetCurrentRPM </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>Current rotation speed of engine in rounds per minute. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleEngine::GetTorque </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inAcceleration</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 the amount of torque (N m) that the engine can supply </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inAcceleration</td><td>How much the gas pedal is pressed [0, 1] </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleEngine::RestoreState </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleEngine::SaveState </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_state_recorder.html">StateRecorder</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>Saving state for replay. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void VehicleEngine::SetCurrentRPM </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inRPM</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>Update rotation speed of engine in rounds per minute. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float VehicleEngine::cAngularVelocityToRPM = 60.0f / (2.0f * JPH_PI)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Multiply an angular velocity (rad/s) with this value to get rounds per minute (RPM) </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_engine_8h_source.html">VehicleEngine.h</a></li>
<li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_engine_8cpp.html">VehicleEngine.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_engine.html">VehicleEngine</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>