class_vehicle_engine_settings.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: VehicleEngineSettings Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_vehicle_engine_settings.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="#pub-attribs">Public Attributes</a> &#124;
  109. <a href="class_vehicle_engine_settings-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">VehicleEngineSettings Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Generic properties for a vehicle engine.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_vehicle_engine_8h_source.html">VehicleEngine.h</a>&gt;</code></p>
  116. <div class="dynheader">
  117. Inheritance diagram for VehicleEngineSettings:</div>
  118. <div class="dyncontent">
  119. <div class="center">
  120. <img src="class_vehicle_engine_settings.png" usemap="#VehicleEngineSettings_map" alt=""/>
  121. <map id="VehicleEngineSettings_map" name="VehicleEngineSettings_map">
  122. <area href="class_vehicle_engine.html" title="Runtime data for engine." alt="VehicleEngine" shape="rect" coords="0,56,138,80"/>
  123. </map>
  124. </div></div>
  125. <table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  127. Public Member Functions</h2></td></tr>
  128. <tr class="memitem:aa326151c7c343427669a4790b84d7697" id="r_aa326151c7c343427669a4790b84d7697"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa326151c7c343427669a4790b84d7697">VehicleEngineSettings</a> ()</td></tr>
  129. <tr class="memdesc:aa326151c7c343427669a4790b84d7697"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  130. <tr class="separator:aa326151c7c343427669a4790b84d7697"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a82b4677535f7f39e68081227caf4b547" id="r_a82b4677535f7f39e68081227caf4b547"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a82b4677535f7f39e68081227caf4b547">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  132. <tr class="memdesc:a82b4677535f7f39e68081227caf4b547"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents in binary form to inStream. <br /></td></tr>
  133. <tr class="separator:a82b4677535f7f39e68081227caf4b547"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a07beafb1531780053169dbc05283ed26" id="r_a07beafb1531780053169dbc05283ed26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07beafb1531780053169dbc05283ed26">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  135. <tr class="memdesc:a07beafb1531780053169dbc05283ed26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores the contents in binary form to inStream. <br /></td></tr>
  136. <tr class="separator:a07beafb1531780053169dbc05283ed26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table><table class="memberdecls">
  138. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  139. Public Attributes</h2></td></tr>
  140. <tr class="memitem:a406aada0f8bcbf536d743de1f8f77329" id="r_a406aada0f8bcbf536d743de1f8f77329"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a406aada0f8bcbf536d743de1f8f77329">mMaxTorque</a> = 500.0f</td></tr>
  141. <tr class="memdesc:a406aada0f8bcbf536d743de1f8f77329"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max amount of torque (Nm) that the engine can deliver. <br /></td></tr>
  142. <tr class="separator:a406aada0f8bcbf536d743de1f8f77329"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a0ac03e624a16d07af8d20dee5a1924bb" id="r_a0ac03e624a16d07af8d20dee5a1924bb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ac03e624a16d07af8d20dee5a1924bb">mMinRPM</a> = 1000.0f</td></tr>
  144. <tr class="memdesc:a0ac03e624a16d07af8d20dee5a1924bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Min amount of revolutions per minute (rpm) the engine can produce without stalling. <br /></td></tr>
  145. <tr class="separator:a0ac03e624a16d07af8d20dee5a1924bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a68b6fa14900e23076bb25b3280fef3c5" id="r_a68b6fa14900e23076bb25b3280fef3c5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a68b6fa14900e23076bb25b3280fef3c5">mMaxRPM</a> = 6000.0f</td></tr>
  147. <tr class="memdesc:a68b6fa14900e23076bb25b3280fef3c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Max amount of revolutions per minute (rpm) the engine can generate. <br /></td></tr>
  148. <tr class="separator:a68b6fa14900e23076bb25b3280fef3c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a2aa42e9f8a1eabe44171c7b2344661f0" 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="#a2aa42e9f8a1eabe44171c7b2344661f0">mNormalizedTorque</a></td></tr>
  150. <tr class="memdesc:a2aa42e9f8a1eabe44171c7b2344661f0"><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>
  151. <tr class="separator:a2aa42e9f8a1eabe44171c7b2344661f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:abe75cc5c2522753f6f5e4ffc6035a183" id="r_abe75cc5c2522753f6f5e4ffc6035a183"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe75cc5c2522753f6f5e4ffc6035a183">mInertia</a> = 0.5f</td></tr>
  153. <tr class="memdesc:abe75cc5c2522753f6f5e4ffc6035a183"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moment of inertia (kg m^2) of the engine. <br /></td></tr>
  154. <tr class="separator:abe75cc5c2522753f6f5e4ffc6035a183"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a721c1a1f97766d41844a337ca4ba1e0b" id="r_a721c1a1f97766d41844a337ca4ba1e0b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a721c1a1f97766d41844a337ca4ba1e0b">mAngularDamping</a> = 0.2f</td></tr>
  156. <tr class="memdesc:a721c1a1f97766d41844a337ca4ba1e0b"><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>
  157. <tr class="separator:a721c1a1f97766d41844a337ca4ba1e0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table>
  159. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  160. <div class="textblock"><p>Generic properties for a vehicle engine. </p>
  161. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  162. <a id="aa326151c7c343427669a4790b84d7697" name="aa326151c7c343427669a4790b84d7697"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#aa326151c7c343427669a4790b84d7697">&#9670;&#160;</a></span>VehicleEngineSettings()</h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">VehicleEngineSettings::VehicleEngineSettings </td>
  169. <td>(</td>
  170. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  171. <td></td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Constructor. </p>
  176. </div>
  177. </div>
  178. <h2 class="groupheader">Member Function Documentation</h2>
  179. <a id="a07beafb1531780053169dbc05283ed26" name="a07beafb1531780053169dbc05283ed26"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#a07beafb1531780053169dbc05283ed26">&#9670;&#160;</a></span>RestoreBinaryState()</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">void VehicleEngineSettings::RestoreBinaryState </td>
  186. <td>(</td>
  187. <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>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Restores the contents in binary form to inStream. </p>
  193. </div>
  194. </div>
  195. <a id="a82b4677535f7f39e68081227caf4b547" name="a82b4677535f7f39e68081227caf4b547"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#a82b4677535f7f39e68081227caf4b547">&#9670;&#160;</a></span>SaveBinaryState()</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">void VehicleEngineSettings::SaveBinaryState </td>
  202. <td>(</td>
  203. <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>
  204. <td> const</td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Saves the contents in binary form to inStream. </p>
  209. </div>
  210. </div>
  211. <h2 class="groupheader">Member Data Documentation</h2>
  212. <a id="a721c1a1f97766d41844a337ca4ba1e0b" name="a721c1a1f97766d41844a337ca4ba1e0b"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#a721c1a1f97766d41844a337ca4ba1e0b">&#9670;&#160;</a></span>mAngularDamping</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">float VehicleEngineSettings::mAngularDamping = 0.2f</td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Angular damping factor of the wheel: dw/dt = -c * w. Value should be zero or positive and is usually close to 0. </p>
  223. </div>
  224. </div>
  225. <a id="abe75cc5c2522753f6f5e4ffc6035a183" name="abe75cc5c2522753f6f5e4ffc6035a183"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#abe75cc5c2522753f6f5e4ffc6035a183">&#9670;&#160;</a></span>mInertia</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">float VehicleEngineSettings::mInertia = 0.5f</td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. <p>Moment of inertia (kg m^2) of the engine. </p>
  236. </div>
  237. </div>
  238. <a id="a68b6fa14900e23076bb25b3280fef3c5" name="a68b6fa14900e23076bb25b3280fef3c5"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#a68b6fa14900e23076bb25b3280fef3c5">&#9670;&#160;</a></span>mMaxRPM</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">float VehicleEngineSettings::mMaxRPM = 6000.0f</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Max amount of revolutions per minute (rpm) the engine can generate. </p>
  249. </div>
  250. </div>
  251. <a id="a406aada0f8bcbf536d743de1f8f77329" name="a406aada0f8bcbf536d743de1f8f77329"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#a406aada0f8bcbf536d743de1f8f77329">&#9670;&#160;</a></span>mMaxTorque</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">float VehicleEngineSettings::mMaxTorque = 500.0f</td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Max amount of torque (Nm) that the engine can deliver. </p>
  262. </div>
  263. </div>
  264. <a id="a0ac03e624a16d07af8d20dee5a1924bb" name="a0ac03e624a16d07af8d20dee5a1924bb"></a>
  265. <h2 class="memtitle"><span class="permalink"><a href="#a0ac03e624a16d07af8d20dee5a1924bb">&#9670;&#160;</a></span>mMinRPM</h2>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">float VehicleEngineSettings::mMinRPM = 1000.0f</td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Min amount of revolutions per minute (rpm) the engine can produce without stalling. </p>
  275. </div>
  276. </div>
  277. <a id="a2aa42e9f8a1eabe44171c7b2344661f0" name="a2aa42e9f8a1eabe44171c7b2344661f0"></a>
  278. <h2 class="memtitle"><span class="permalink"><a href="#a2aa42e9f8a1eabe44171c7b2344661f0">&#9670;&#160;</a></span>mNormalizedTorque</h2>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname"><a class="el" href="class_linear_curve.html">LinearCurve</a> VehicleEngineSettings::mNormalizedTorque</td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <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>
  288. </div>
  289. </div>
  290. <hr/>The documentation for this class was generated from the following files:<ul>
  291. <li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_engine_8h_source.html">VehicleEngine.h</a></li>
  292. <li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_engine_8cpp.html">VehicleEngine.cpp</a></li>
  293. </ul>
  294. </div><!-- contents -->
  295. </div><!-- doc-content -->
  296. <!-- start footer part -->
  297. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  298. <ul>
  299. <li class="navelem"><a class="el" href="class_vehicle_engine_settings.html">VehicleEngineSettings</a></li>
  300. <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>
  301. </ul>
  302. </div>
  303. </body>
  304. </html>