| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335 |
- <!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: VehicleEngineSettings Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <script type="text/javascript" src="clipboard.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="cookie.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/x-mathjax-config">
- MathJax.Hub.Config({
- extensions: ["tex2jax.js"],
- jax: ["input/TeX","output/HTML-CSS"],
- });
- </script>
- <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
- <td id="projectalign">
- <div id="projectname">Jolt Physics
- </div>
- <div id="projectbrief">A multi core friendly Game Physics Engine</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.12.0 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() { codefold.init(0); });
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search',true);
- $(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function(){initNavTree('class_vehicle_engine_settings.html',''); initResizable(true); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="class_vehicle_engine_settings-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">VehicleEngineSettings Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p>Generic properties for a vehicle engine.
- <a href="#details">More...</a></p>
- <p><code>#include <<a class="el" href="_vehicle_engine_8h_source.html">VehicleEngine.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for VehicleEngineSettings:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="class_vehicle_engine_settings.png" usemap="#VehicleEngineSettings_map" alt=""/>
- <map id="VehicleEngineSettings_map" name="VehicleEngineSettings_map">
- <area href="class_vehicle_engine.html" title="Runtime data for engine." alt="VehicleEngine" shape="rect" coords="0,56,138,80"/>
- </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:aa326151c7c343427669a4790b84d7697" id="r_aa326151c7c343427669a4790b84d7697"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa326151c7c343427669a4790b84d7697">VehicleEngineSettings</a> ()</td></tr>
- <tr class="memdesc:aa326151c7c343427669a4790b84d7697"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
- <tr class="separator:aa326151c7c343427669a4790b84d7697"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a82b4677535f7f39e68081227caf4b547" id="r_a82b4677535f7f39e68081227caf4b547"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a82b4677535f7f39e68081227caf4b547">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &inStream) const</td></tr>
- <tr class="memdesc:a82b4677535f7f39e68081227caf4b547"><td class="mdescLeft"> </td><td class="mdescRight">Saves the contents in binary form to inStream. <br /></td></tr>
- <tr class="separator:a82b4677535f7f39e68081227caf4b547"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a07beafb1531780053169dbc05283ed26" id="r_a07beafb1531780053169dbc05283ed26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a07beafb1531780053169dbc05283ed26">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &inStream)</td></tr>
- <tr class="memdesc:a07beafb1531780053169dbc05283ed26"><td class="mdescLeft"> </td><td class="mdescRight">Restores the contents in binary form to inStream. <br /></td></tr>
- <tr class="separator:a07beafb1531780053169dbc05283ed26"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr class="memitem:a406aada0f8bcbf536d743de1f8f77329" id="r_a406aada0f8bcbf536d743de1f8f77329"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a406aada0f8bcbf536d743de1f8f77329">mMaxTorque</a> = 500.0f</td></tr>
- <tr class="memdesc:a406aada0f8bcbf536d743de1f8f77329"><td class="mdescLeft"> </td><td class="mdescRight">Max amount of torque (Nm) that the engine can deliver. <br /></td></tr>
- <tr class="separator:a406aada0f8bcbf536d743de1f8f77329"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0ac03e624a16d07af8d20dee5a1924bb" id="r_a0ac03e624a16d07af8d20dee5a1924bb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ac03e624a16d07af8d20dee5a1924bb">mMinRPM</a> = 1000.0f</td></tr>
- <tr class="memdesc:a0ac03e624a16d07af8d20dee5a1924bb"><td class="mdescLeft"> </td><td class="mdescRight">Min amount of revolutions per minute (rpm) the engine can produce without stalling. <br /></td></tr>
- <tr class="separator:a0ac03e624a16d07af8d20dee5a1924bb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a68b6fa14900e23076bb25b3280fef3c5" id="r_a68b6fa14900e23076bb25b3280fef3c5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a68b6fa14900e23076bb25b3280fef3c5">mMaxRPM</a> = 6000.0f</td></tr>
- <tr class="memdesc:a68b6fa14900e23076bb25b3280fef3c5"><td class="mdescLeft"> </td><td class="mdescRight">Max amount of revolutions per minute (rpm) the engine can generate. <br /></td></tr>
- <tr class="separator:a68b6fa14900e23076bb25b3280fef3c5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2aa42e9f8a1eabe44171c7b2344661f0" id="r_a2aa42e9f8a1eabe44171c7b2344661f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_linear_curve.html">LinearCurve</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2aa42e9f8a1eabe44171c7b2344661f0">mNormalizedTorque</a></td></tr>
- <tr class="memdesc:a2aa42e9f8a1eabe44171c7b2344661f0"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abe75cc5c2522753f6f5e4ffc6035a183" id="r_abe75cc5c2522753f6f5e4ffc6035a183"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#abe75cc5c2522753f6f5e4ffc6035a183">mInertia</a> = 0.5f</td></tr>
- <tr class="memdesc:abe75cc5c2522753f6f5e4ffc6035a183"><td class="mdescLeft"> </td><td class="mdescRight">Moment of inertia (kg m^2) of the engine. <br /></td></tr>
- <tr class="separator:abe75cc5c2522753f6f5e4ffc6035a183"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a721c1a1f97766d41844a337ca4ba1e0b" id="r_a721c1a1f97766d41844a337ca4ba1e0b"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a721c1a1f97766d41844a337ca4ba1e0b">mAngularDamping</a> = 0.2f</td></tr>
- <tr class="memdesc:a721c1a1f97766d41844a337ca4ba1e0b"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Generic properties for a vehicle engine. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="aa326151c7c343427669a4790b84d7697" name="aa326151c7c343427669a4790b84d7697"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa326151c7c343427669a4790b84d7697">◆ </a></span>VehicleEngineSettings()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">VehicleEngineSettings::VehicleEngineSettings </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Constructor. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a07beafb1531780053169dbc05283ed26" name="a07beafb1531780053169dbc05283ed26"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a07beafb1531780053169dbc05283ed26">◆ </a></span>RestoreBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void VehicleEngineSettings::RestoreBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Restores the contents in binary form to inStream. </p>
- </div>
- </div>
- <a id="a82b4677535f7f39e68081227caf4b547" name="a82b4677535f7f39e68081227caf4b547"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a82b4677535f7f39e68081227caf4b547">◆ </a></span>SaveBinaryState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void VehicleEngineSettings::SaveBinaryState </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Saves the contents in binary form to inStream. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a721c1a1f97766d41844a337ca4ba1e0b" name="a721c1a1f97766d41844a337ca4ba1e0b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a721c1a1f97766d41844a337ca4ba1e0b">◆ </a></span>mAngularDamping</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float VehicleEngineSettings::mAngularDamping = 0.2f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Angular damping factor of the wheel: dw/dt = -c * w. Value should be zero or positive and is usually close to 0. </p>
- </div>
- </div>
- <a id="abe75cc5c2522753f6f5e4ffc6035a183" name="abe75cc5c2522753f6f5e4ffc6035a183"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abe75cc5c2522753f6f5e4ffc6035a183">◆ </a></span>mInertia</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float VehicleEngineSettings::mInertia = 0.5f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Moment of inertia (kg m^2) of the engine. </p>
- </div>
- </div>
- <a id="a68b6fa14900e23076bb25b3280fef3c5" name="a68b6fa14900e23076bb25b3280fef3c5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a68b6fa14900e23076bb25b3280fef3c5">◆ </a></span>mMaxRPM</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float VehicleEngineSettings::mMaxRPM = 6000.0f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Max amount of revolutions per minute (rpm) the engine can generate. </p>
- </div>
- </div>
- <a id="a406aada0f8bcbf536d743de1f8f77329" name="a406aada0f8bcbf536d743de1f8f77329"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a406aada0f8bcbf536d743de1f8f77329">◆ </a></span>mMaxTorque</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float VehicleEngineSettings::mMaxTorque = 500.0f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Max amount of torque (Nm) that the engine can deliver. </p>
- </div>
- </div>
- <a id="a0ac03e624a16d07af8d20dee5a1924bb" name="a0ac03e624a16d07af8d20dee5a1924bb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0ac03e624a16d07af8d20dee5a1924bb">◆ </a></span>mMinRPM</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float VehicleEngineSettings::mMinRPM = 1000.0f</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Min amount of revolutions per minute (rpm) the engine can produce without stalling. </p>
- </div>
- </div>
- <a id="a2aa42e9f8a1eabe44171c7b2344661f0" name="a2aa42e9f8a1eabe44171c7b2344661f0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2aa42e9f8a1eabe44171c7b2344661f0">◆ </a></span>mNormalizedTorque</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_linear_curve.html">LinearCurve</a> VehicleEngineSettings::mNormalizedTorque</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>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) </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_settings.html">VehicleEngineSettings</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>
|