class_vehicle_transmission.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450
  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: VehicleTransmission 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_transmission.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="class_vehicle_transmission-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">VehicleTransmission Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>Runtime data for transmission.
  113. <a href="#details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="_vehicle_transmission_8h_source.html">VehicleTransmission.h</a>&gt;</code></p>
  115. <div class="dynheader">
  116. Inheritance diagram for VehicleTransmission:</div>
  117. <div class="dyncontent">
  118. <div class="center">
  119. <img src="class_vehicle_transmission.png" usemap="#VehicleTransmission_map" alt=""/>
  120. <map id="VehicleTransmission_map" name="VehicleTransmission_map">
  121. <area href="class_vehicle_transmission_settings.html" title="Configuration for the transmission of a vehicle (gear box)" alt="VehicleTransmissionSettings" shape="rect" coords="0,0,172,24"/>
  122. </map>
  123. </div></div>
  124. <table class="memberdecls">
  125. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  126. Public Member Functions</h2></td></tr>
  127. <tr class="memitem:a4d2b3e12b61038846be21623f1c2694e" id="r_a4d2b3e12b61038846be21623f1c2694e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d2b3e12b61038846be21623f1c2694e">Set</a> (int inCurrentGear, float inClutchFriction)</td></tr>
  128. <tr class="separator:a4d2b3e12b61038846be21623f1c2694e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:abd88a375576b8d35f854a5f687bf8acb" id="r_abd88a375576b8d35f854a5f687bf8acb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd88a375576b8d35f854a5f687bf8acb">Update</a> (float inDeltaTime, float inCurrentRPM, float inForwardInput, bool inCanShiftUp)</td></tr>
  130. <tr class="separator:abd88a375576b8d35f854a5f687bf8acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a2770cd2da41162587a2addd366ba4535" id="r_a2770cd2da41162587a2addd366ba4535"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2770cd2da41162587a2addd366ba4535">GetCurrentGear</a> () const</td></tr>
  132. <tr class="memdesc:a2770cd2da41162587a2addd366ba4535"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current gear, -1 = reverse, 0 = neutral, 1 = 1st gear etc. <br /></td></tr>
  133. <tr class="separator:a2770cd2da41162587a2addd366ba4535"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a2dc82e524311127f8bb8d5fe2cd63809" id="r_a2dc82e524311127f8bb8d5fe2cd63809"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2dc82e524311127f8bb8d5fe2cd63809">GetClutchFriction</a> () const</td></tr>
  135. <tr class="memdesc:a2dc82e524311127f8bb8d5fe2cd63809"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value between 0 and 1 indicating how much friction the clutch gives (0 = no friction, 1 = full friction) <br /></td></tr>
  136. <tr class="separator:a2dc82e524311127f8bb8d5fe2cd63809"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:aebbd24ac8a0b55f474d7654507739059" id="r_aebbd24ac8a0b55f474d7654507739059"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aebbd24ac8a0b55f474d7654507739059">IsSwitchingGear</a> () const</td></tr>
  138. <tr class="memdesc:aebbd24ac8a0b55f474d7654507739059"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the auto box is currently switching gears. <br /></td></tr>
  139. <tr class="separator:aebbd24ac8a0b55f474d7654507739059"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aa58a4bc8d9ede0b99f622a0f20b36012" id="r_aa58a4bc8d9ede0b99f622a0f20b36012"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa58a4bc8d9ede0b99f622a0f20b36012">GetCurrentRatio</a> () const</td></tr>
  141. <tr class="memdesc:aa58a4bc8d9ede0b99f622a0f20b36012"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the transmission ratio based on the current gear (ratio between engine and differential) <br /></td></tr>
  142. <tr class="separator:aa58a4bc8d9ede0b99f622a0f20b36012"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a237601b6ae13f2d8b31ff20981b7ac9c" id="r_a237601b6ae13f2d8b31ff20981b7ac9c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a237601b6ae13f2d8b31ff20981b7ac9c">AllowSleep</a> () const</td></tr>
  144. <tr class="memdesc:a237601b6ae13f2d8b31ff20981b7ac9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Only allow sleeping when the transmission is idle. <br /></td></tr>
  145. <tr class="separator:a237601b6ae13f2d8b31ff20981b7ac9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a9424eebce9e6a038862d1a3e66fa94ad" id="r_a9424eebce9e6a038862d1a3e66fa94ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9424eebce9e6a038862d1a3e66fa94ad">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  147. <tr class="memdesc:a9424eebce9e6a038862d1a3e66fa94ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saving state for replay. <br /></td></tr>
  148. <tr class="separator:a9424eebce9e6a038862d1a3e66fa94ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a1c3c2fef737c176e558081a0175f71f9" id="r_a1c3c2fef737c176e558081a0175f71f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1c3c2fef737c176e558081a0175f71f9">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  150. <tr class="separator:a1c3c2fef737c176e558081a0175f71f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="inherit_header pub_methods_class_vehicle_transmission_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_vehicle_transmission_settings')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_vehicle_transmission_settings.html">VehicleTransmissionSettings</a></td></tr>
  152. <tr class="memitem:ac843a815cfe9ce6ad3fd4f5872d187e1 inherit pub_methods_class_vehicle_transmission_settings" id="r_ac843a815cfe9ce6ad3fd4f5872d187e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#ac843a815cfe9ce6ad3fd4f5872d187e1">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  153. <tr class="memdesc:ac843a815cfe9ce6ad3fd4f5872d187e1 inherit pub_methods_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents in binary form to inStream. <br /></td></tr>
  154. <tr class="separator:ac843a815cfe9ce6ad3fd4f5872d187e1 inherit pub_methods_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a3055b6c810a88a1ae3fd2946a1683d5d inherit pub_methods_class_vehicle_transmission_settings" id="r_a3055b6c810a88a1ae3fd2946a1683d5d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a3055b6c810a88a1ae3fd2946a1683d5d">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  156. <tr class="memdesc:a3055b6c810a88a1ae3fd2946a1683d5d inherit pub_methods_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores the contents in binary form to inStream. <br /></td></tr>
  157. <tr class="separator:a3055b6c810a88a1ae3fd2946a1683d5d inherit pub_methods_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table><table class="memberdecls">
  159. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  160. Additional Inherited Members</h2></td></tr>
  161. <tr class="inherit_header pub_attribs_class_vehicle_transmission_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_vehicle_transmission_settings')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_vehicle_transmission_settings.html">VehicleTransmissionSettings</a></td></tr>
  162. <tr class="memitem:a57d1f98cbd50ba710d6c1941e2788e8f inherit pub_attribs_class_vehicle_transmission_settings" id="r_a57d1f98cbd50ba710d6c1941e2788e8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_vehicle_transmission_8h.html#ad3e125d6d786c09fddfa10be390f851d">ETransmissionMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a57d1f98cbd50ba710d6c1941e2788e8f">mMode</a> = <a class="el" href="_vehicle_transmission_8h.html#ad3e125d6d786c09fddfa10be390f851da06b9281e396db002010bde1de57262eb">ETransmissionMode::Auto</a></td></tr>
  163. <tr class="memdesc:a57d1f98cbd50ba710d6c1941e2788e8f inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">How to switch gears. <br /></td></tr>
  164. <tr class="separator:a57d1f98cbd50ba710d6c1941e2788e8f inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a3632548e7e09e7eb2fc8594ff039265e inherit pub_attribs_class_vehicle_transmission_settings" id="r_a3632548e7e09e7eb2fc8594ff039265e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_array.html">Array</a>&lt; float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a3632548e7e09e7eb2fc8594ff039265e">mGearRatios</a> { 2.66f, 1.78f, 1.3f, 1.0f, 0.74f }</td></tr>
  166. <tr class="memdesc:a3632548e7e09e7eb2fc8594ff039265e inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ratio in rotation rate between engine and gear box, first element is 1st gear, 2nd element 2nd gear etc. <br /></td></tr>
  167. <tr class="separator:a3632548e7e09e7eb2fc8594ff039265e inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ac0a9ec4f7eb2fa4d2bfbb5c49c46171d inherit pub_attribs_class_vehicle_transmission_settings" id="r_ac0a9ec4f7eb2fa4d2bfbb5c49c46171d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_array.html">Array</a>&lt; float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#ac0a9ec4f7eb2fa4d2bfbb5c49c46171d">mReverseGearRatios</a> { -2.90f }</td></tr>
  169. <tr class="memdesc:ac0a9ec4f7eb2fa4d2bfbb5c49c46171d inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ratio in rotation rate between engine and gear box when driving in reverse. <br /></td></tr>
  170. <tr class="separator:ac0a9ec4f7eb2fa4d2bfbb5c49c46171d inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:ad890effc2f497795fb22fd56da27888e inherit pub_attribs_class_vehicle_transmission_settings" id="r_ad890effc2f497795fb22fd56da27888e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#ad890effc2f497795fb22fd56da27888e">mSwitchTime</a> = 0.5f</td></tr>
  172. <tr class="memdesc:ad890effc2f497795fb22fd56da27888e inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long it takes to switch gears (s), only used in auto mode. <br /></td></tr>
  173. <tr class="separator:ad890effc2f497795fb22fd56da27888e inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a06bfd0f8f234b58488615250e7cc5703 inherit pub_attribs_class_vehicle_transmission_settings" id="r_a06bfd0f8f234b58488615250e7cc5703"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a06bfd0f8f234b58488615250e7cc5703">mClutchReleaseTime</a> = 0.3f</td></tr>
  175. <tr class="memdesc:a06bfd0f8f234b58488615250e7cc5703 inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long it takes to release the clutch (go to full friction), only used in auto mode. <br /></td></tr>
  176. <tr class="separator:a06bfd0f8f234b58488615250e7cc5703 inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a8c1734a64d58ae36d49082c56d563986 inherit pub_attribs_class_vehicle_transmission_settings" id="r_a8c1734a64d58ae36d49082c56d563986"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a8c1734a64d58ae36d49082c56d563986">mSwitchLatency</a> = 0.5f</td></tr>
  178. <tr class="memdesc:a8c1734a64d58ae36d49082c56d563986 inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long to wait after releasing the clutch before another switch is attempted (s), only used in auto mode. <br /></td></tr>
  179. <tr class="separator:a8c1734a64d58ae36d49082c56d563986 inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:a928b1aea1e5cae37d92bd18ccc3ab74c inherit pub_attribs_class_vehicle_transmission_settings" id="r_a928b1aea1e5cae37d92bd18ccc3ab74c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a928b1aea1e5cae37d92bd18ccc3ab74c">mShiftUpRPM</a> = 4000.0f</td></tr>
  181. <tr class="memdesc:a928b1aea1e5cae37d92bd18ccc3ab74c inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">If RPM of engine is bigger then this we will shift a gear up, only used in auto mode. <br /></td></tr>
  182. <tr class="separator:a928b1aea1e5cae37d92bd18ccc3ab74c inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:a9c89ba7571dd3ba9e5dff909a379ab3f inherit pub_attribs_class_vehicle_transmission_settings" id="r_a9c89ba7571dd3ba9e5dff909a379ab3f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a9c89ba7571dd3ba9e5dff909a379ab3f">mShiftDownRPM</a> = 2000.0f</td></tr>
  184. <tr class="memdesc:a9c89ba7571dd3ba9e5dff909a379ab3f inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">If RPM of engine is smaller then this we will shift a gear down, only used in auto mode. <br /></td></tr>
  185. <tr class="separator:a9c89ba7571dd3ba9e5dff909a379ab3f inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a86105ca9b3215ec2a6208815f4e10740 inherit pub_attribs_class_vehicle_transmission_settings" id="r_a86105ca9b3215ec2a6208815f4e10740"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vehicle_transmission_settings.html#a86105ca9b3215ec2a6208815f4e10740">mClutchStrength</a> = 10.0f</td></tr>
  187. <tr class="memdesc:a86105ca9b3215ec2a6208815f4e10740 inherit pub_attribs_class_vehicle_transmission_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strength of the clutch when fully engaged. Total torque a clutch applies is Torque = ClutchStrength * (Velocity Engine - Avg Velocity Wheels At Clutch) (units: k m^2 s^-1) <br /></td></tr>
  188. <tr class="separator:a86105ca9b3215ec2a6208815f4e10740 inherit pub_attribs_class_vehicle_transmission_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. </table>
  190. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  191. <div class="textblock"><p>Runtime data for transmission. </p>
  192. </div><h2 class="groupheader">Member Function Documentation</h2>
  193. <a id="a237601b6ae13f2d8b31ff20981b7ac9c" name="a237601b6ae13f2d8b31ff20981b7ac9c"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#a237601b6ae13f2d8b31ff20981b7ac9c">&#9670;&#160;</a></span>AllowSleep()</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="mlabels">
  198. <tr>
  199. <td class="mlabels-left">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">bool VehicleTransmission::AllowSleep </td>
  203. <td>(</td>
  204. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  205. <td> const</td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Only allow sleeping when the transmission is idle. </p>
  215. </div>
  216. </div>
  217. <a id="a2dc82e524311127f8bb8d5fe2cd63809" name="a2dc82e524311127f8bb8d5fe2cd63809"></a>
  218. <h2 class="memtitle"><span class="permalink"><a href="#a2dc82e524311127f8bb8d5fe2cd63809">&#9670;&#160;</a></span>GetClutchFriction()</h2>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="mlabels">
  222. <tr>
  223. <td class="mlabels-left">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">float VehicleTransmission::GetClutchFriction </td>
  227. <td>(</td>
  228. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  229. <td> const</td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Value between 0 and 1 indicating how much friction the clutch gives (0 = no friction, 1 = full friction) </p>
  239. </div>
  240. </div>
  241. <a id="a2770cd2da41162587a2addd366ba4535" name="a2770cd2da41162587a2addd366ba4535"></a>
  242. <h2 class="memtitle"><span class="permalink"><a href="#a2770cd2da41162587a2addd366ba4535">&#9670;&#160;</a></span>GetCurrentGear()</h2>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="mlabels">
  246. <tr>
  247. <td class="mlabels-left">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">int VehicleTransmission::GetCurrentGear </td>
  251. <td>(</td>
  252. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  253. <td> const</td>
  254. </tr>
  255. </table>
  256. </td>
  257. <td class="mlabels-right">
  258. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Current gear, -1 = reverse, 0 = neutral, 1 = 1st gear etc. </p>
  263. </div>
  264. </div>
  265. <a id="aa58a4bc8d9ede0b99f622a0f20b36012" name="aa58a4bc8d9ede0b99f622a0f20b36012"></a>
  266. <h2 class="memtitle"><span class="permalink"><a href="#aa58a4bc8d9ede0b99f622a0f20b36012">&#9670;&#160;</a></span>GetCurrentRatio()</h2>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">float VehicleTransmission::GetCurrentRatio </td>
  272. <td>(</td>
  273. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  274. <td> const</td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <p>Return the transmission ratio based on the current gear (ratio between engine and differential) </p>
  279. </div>
  280. </div>
  281. <a id="aebbd24ac8a0b55f474d7654507739059" name="aebbd24ac8a0b55f474d7654507739059"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#aebbd24ac8a0b55f474d7654507739059">&#9670;&#160;</a></span>IsSwitchingGear()</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="mlabels">
  286. <tr>
  287. <td class="mlabels-left">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">bool VehicleTransmission::IsSwitchingGear </td>
  291. <td>(</td>
  292. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  293. <td> const</td>
  294. </tr>
  295. </table>
  296. </td>
  297. <td class="mlabels-right">
  298. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>If the auto box is currently switching gears. </p>
  303. </div>
  304. </div>
  305. <a id="a1c3c2fef737c176e558081a0175f71f9" name="a1c3c2fef737c176e558081a0175f71f9"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#a1c3c2fef737c176e558081a0175f71f9">&#9670;&#160;</a></span>RestoreState()</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">void VehicleTransmission::RestoreState </td>
  312. <td>(</td>
  313. <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>
  314. <td></td>
  315. </tr>
  316. </table>
  317. </div><div class="memdoc">
  318. </div>
  319. </div>
  320. <a id="a9424eebce9e6a038862d1a3e66fa94ad" name="a9424eebce9e6a038862d1a3e66fa94ad"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#a9424eebce9e6a038862d1a3e66fa94ad">&#9670;&#160;</a></span>SaveState()</h2>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname">void VehicleTransmission::SaveState </td>
  327. <td>(</td>
  328. <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>
  329. <td> const</td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Saving state for replay. </p>
  334. </div>
  335. </div>
  336. <a id="a4d2b3e12b61038846be21623f1c2694e" name="a4d2b3e12b61038846be21623f1c2694e"></a>
  337. <h2 class="memtitle"><span class="permalink"><a href="#a4d2b3e12b61038846be21623f1c2694e">&#9670;&#160;</a></span>Set()</h2>
  338. <div class="memitem">
  339. <div class="memproto">
  340. <table class="mlabels">
  341. <tr>
  342. <td class="mlabels-left">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">void VehicleTransmission::Set </td>
  346. <td>(</td>
  347. <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>inCurrentGear</em></span>, </td>
  348. </tr>
  349. <tr>
  350. <td class="paramkey"></td>
  351. <td></td>
  352. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inClutchFriction</em></span>&#160;)</td>
  353. </tr>
  354. </table>
  355. </td>
  356. <td class="mlabels-right">
  357. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <p>Set input from driver regarding the transmission (only relevant when transmission is set to manual mode) </p><dl class="params"><dt>Parameters</dt><dd>
  362. <table class="params">
  363. <tr><td class="paramname">inCurrentGear</td><td>Current gear, -1 = reverse, 0 = neutral, 1 = 1st gear etc. </td></tr>
  364. <tr><td class="paramname">inClutchFriction</td><td>Value between 0 and 1 indicating how much friction the clutch gives (0 = no friction, 1 = full friction) </td></tr>
  365. </table>
  366. </dd>
  367. </dl>
  368. </div>
  369. </div>
  370. <a id="abd88a375576b8d35f854a5f687bf8acb" name="abd88a375576b8d35f854a5f687bf8acb"></a>
  371. <h2 class="memtitle"><span class="permalink"><a href="#abd88a375576b8d35f854a5f687bf8acb">&#9670;&#160;</a></span>Update()</h2>
  372. <div class="memitem">
  373. <div class="memproto">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">void VehicleTransmission::Update </td>
  377. <td>(</td>
  378. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inDeltaTime</em></span>, </td>
  379. </tr>
  380. <tr>
  381. <td class="paramkey"></td>
  382. <td></td>
  383. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inCurrentRPM</em></span>, </td>
  384. </tr>
  385. <tr>
  386. <td class="paramkey"></td>
  387. <td></td>
  388. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inForwardInput</em></span>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>inCanShiftUp</em></span>&#160;)</td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. <p>Update the current gear and clutch friction if the transmission is in auto mode </p><dl class="params"><dt>Parameters</dt><dd>
  398. <table class="params">
  399. <tr><td class="paramname">inDeltaTime</td><td>Time step delta time in s </td></tr>
  400. <tr><td class="paramname">inCurrentRPM</td><td>Current RPM for engine </td></tr>
  401. <tr><td class="paramname">inForwardInput</td><td>Hint if the user wants to drive forward (&gt; 0) or backwards (&lt; 0) </td></tr>
  402. <tr><td class="paramname">inCanShiftUp</td><td>Indicates if we want to allow the transmission to shift up (e.g. pass false if wheels are slipping) </td></tr>
  403. </table>
  404. </dd>
  405. </dl>
  406. </div>
  407. </div>
  408. <hr/>The documentation for this class was generated from the following files:<ul>
  409. <li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_transmission_8h_source.html">VehicleTransmission.h</a></li>
  410. <li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_transmission_8cpp.html">VehicleTransmission.cpp</a></li>
  411. </ul>
  412. </div><!-- contents -->
  413. </div><!-- doc-content -->
  414. <!-- start footer part -->
  415. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  416. <ul>
  417. <li class="navelem"><a class="el" href="class_vehicle_transmission.html">VehicleTransmission</a></li>
  418. <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>
  419. </ul>
  420. </div>
  421. </body>
  422. </html>