class_vehicle_track_settings.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312
  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: VehicleTrackSettings 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_track_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_track_settings-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">VehicleTrackSettings Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Generic properties for tank tracks.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_vehicle_track_8h_source.html">VehicleTrack.h</a>&gt;</code></p>
  116. <div class="dynheader">
  117. Inheritance diagram for VehicleTrackSettings:</div>
  118. <div class="dyncontent">
  119. <div class="center">
  120. <img src="class_vehicle_track_settings.png" usemap="#VehicleTrackSettings_map" alt=""/>
  121. <map id="VehicleTrackSettings_map" name="VehicleTrackSettings_map">
  122. <area href="class_vehicle_track.html" title="Runtime data for tank tracks." alt="VehicleTrack" shape="rect" coords="0,56,131,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:a22893d7c73b60b53e21885cdf65ac7ba" id="r_a22893d7c73b60b53e21885cdf65ac7ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a22893d7c73b60b53e21885cdf65ac7ba">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
  129. <tr class="memdesc:a22893d7c73b60b53e21885cdf65ac7ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents in binary form to inStream. <br /></td></tr>
  130. <tr class="separator:a22893d7c73b60b53e21885cdf65ac7ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a019707dd72812c4af4799ee1f7077115" id="r_a019707dd72812c4af4799ee1f7077115"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a019707dd72812c4af4799ee1f7077115">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
  132. <tr class="memdesc:a019707dd72812c4af4799ee1f7077115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores the contents in binary form to inStream. <br /></td></tr>
  133. <tr class="separator:a019707dd72812c4af4799ee1f7077115"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  136. Public Attributes</h2></td></tr>
  137. <tr class="memitem:aff65474e817507daa9d777ebc47d4aa1" id="r_aff65474e817507daa9d777ebc47d4aa1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff65474e817507daa9d777ebc47d4aa1">mDrivenWheel</a></td></tr>
  138. <tr class="memdesc:aff65474e817507daa9d777ebc47d4aa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Which wheel on the track is connected to the engine. <br /></td></tr>
  139. <tr class="separator:aff65474e817507daa9d777ebc47d4aa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:abdcb4574025a04f9779c86d8bf3f24a4" id="r_abdcb4574025a04f9779c86d8bf3f24a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_array.html">Array</a>&lt; <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abdcb4574025a04f9779c86d8bf3f24a4">mWheels</a></td></tr>
  141. <tr class="memdesc:abdcb4574025a04f9779c86d8bf3f24a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indices of wheels that are inside this track, should include the driven wheel too. <br /></td></tr>
  142. <tr class="separator:abdcb4574025a04f9779c86d8bf3f24a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:aa8f02b8434926bcb503772b9cf798d00" id="r_aa8f02b8434926bcb503772b9cf798d00"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8f02b8434926bcb503772b9cf798d00">mInertia</a> = 10.0f</td></tr>
  144. <tr class="memdesc:aa8f02b8434926bcb503772b9cf798d00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moment of inertia (kg m^2) of the track and its wheels as seen on the driven wheel. <br /></td></tr>
  145. <tr class="separator:aa8f02b8434926bcb503772b9cf798d00"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:affda379a129ca982243cdb36017d690e" id="r_affda379a129ca982243cdb36017d690e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#affda379a129ca982243cdb36017d690e">mAngularDamping</a> = 0.5f</td></tr>
  147. <tr class="memdesc:affda379a129ca982243cdb36017d690e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Damping factor of track and its wheels: dw/dt = -c * w as seen on the driven wheel. <br /></td></tr>
  148. <tr class="separator:affda379a129ca982243cdb36017d690e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a0bd6cbda956b1149e646733fd5791a68" id="r_a0bd6cbda956b1149e646733fd5791a68"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bd6cbda956b1149e646733fd5791a68">mMaxBrakeTorque</a> = 15000.0f</td></tr>
  150. <tr class="memdesc:a0bd6cbda956b1149e646733fd5791a68"><td class="mdescLeft">&#160;</td><td class="mdescRight">How much torque (Nm) the brakes can apply on the driven wheel. <br /></td></tr>
  151. <tr class="separator:a0bd6cbda956b1149e646733fd5791a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:adfc2a350504c7850a1c544f6dc06f6ab" id="r_adfc2a350504c7850a1c544f6dc06f6ab"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfc2a350504c7850a1c544f6dc06f6ab">mDifferentialRatio</a> = 6.0f</td></tr>
  153. <tr class="memdesc:adfc2a350504c7850a1c544f6dc06f6ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ratio between rotation speed of gear box and driven wheel of track. <br /></td></tr>
  154. <tr class="separator:adfc2a350504c7850a1c544f6dc06f6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. </table>
  156. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  157. <div class="textblock"><p>Generic properties for tank tracks. </p>
  158. </div><h2 class="groupheader">Member Function Documentation</h2>
  159. <a id="a019707dd72812c4af4799ee1f7077115" name="a019707dd72812c4af4799ee1f7077115"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#a019707dd72812c4af4799ee1f7077115">&#9670;&#160;</a></span>RestoreBinaryState()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">void VehicleTrackSettings::RestoreBinaryState </td>
  166. <td>(</td>
  167. <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>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Restores the contents in binary form to inStream. </p>
  173. </div>
  174. </div>
  175. <a id="a22893d7c73b60b53e21885cdf65ac7ba" name="a22893d7c73b60b53e21885cdf65ac7ba"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#a22893d7c73b60b53e21885cdf65ac7ba">&#9670;&#160;</a></span>SaveBinaryState()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">void VehicleTrackSettings::SaveBinaryState </td>
  182. <td>(</td>
  183. <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>
  184. <td> const</td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Saves the contents in binary form to inStream. </p>
  189. </div>
  190. </div>
  191. <h2 class="groupheader">Member Data Documentation</h2>
  192. <a id="affda379a129ca982243cdb36017d690e" name="affda379a129ca982243cdb36017d690e"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#affda379a129ca982243cdb36017d690e">&#9670;&#160;</a></span>mAngularDamping</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">float VehicleTrackSettings::mAngularDamping = 0.5f</td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Damping factor of track and its wheels: dw/dt = -c * w as seen on the driven wheel. </p>
  203. </div>
  204. </div>
  205. <a id="adfc2a350504c7850a1c544f6dc06f6ab" name="adfc2a350504c7850a1c544f6dc06f6ab"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#adfc2a350504c7850a1c544f6dc06f6ab">&#9670;&#160;</a></span>mDifferentialRatio</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">float VehicleTrackSettings::mDifferentialRatio = 6.0f</td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Ratio between rotation speed of gear box and driven wheel of track. </p>
  216. </div>
  217. </div>
  218. <a id="aff65474e817507daa9d777ebc47d4aa1" name="aff65474e817507daa9d777ebc47d4aa1"></a>
  219. <h2 class="memtitle"><span class="permalink"><a href="#aff65474e817507daa9d777ebc47d4aa1">&#9670;&#160;</a></span>mDrivenWheel</h2>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> VehicleTrackSettings::mDrivenWheel</td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Which wheel on the track is connected to the engine. </p>
  229. </div>
  230. </div>
  231. <a id="aa8f02b8434926bcb503772b9cf798d00" name="aa8f02b8434926bcb503772b9cf798d00"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#aa8f02b8434926bcb503772b9cf798d00">&#9670;&#160;</a></span>mInertia</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">float VehicleTrackSettings::mInertia = 10.0f</td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Moment of inertia (kg m^2) of the track and its wheels as seen on the driven wheel. </p>
  242. </div>
  243. </div>
  244. <a id="a0bd6cbda956b1149e646733fd5791a68" name="a0bd6cbda956b1149e646733fd5791a68"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#a0bd6cbda956b1149e646733fd5791a68">&#9670;&#160;</a></span>mMaxBrakeTorque</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">float VehicleTrackSettings::mMaxBrakeTorque = 15000.0f</td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>How much torque (Nm) the brakes can apply on the driven wheel. </p>
  255. </div>
  256. </div>
  257. <a id="abdcb4574025a04f9779c86d8bf3f24a4" name="abdcb4574025a04f9779c86d8bf3f24a4"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#abdcb4574025a04f9779c86d8bf3f24a4">&#9670;&#160;</a></span>mWheels</h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname"><a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a>&gt; VehicleTrackSettings::mWheels</td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Indices of wheels that are inside this track, should include the driven wheel too. </p>
  268. </div>
  269. </div>
  270. <hr/>The documentation for this class was generated from the following files:<ul>
  271. <li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_track_8h_source.html">VehicleTrack.h</a></li>
  272. <li>Jolt/Physics/Vehicle/<a class="el" href="_vehicle_track_8cpp.html">VehicleTrack.cpp</a></li>
  273. </ul>
  274. </div><!-- contents -->
  275. </div><!-- doc-content -->
  276. <!-- start footer part -->
  277. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  278. <ul>
  279. <li class="navelem"><a class="el" href="class_vehicle_track_settings.html">VehicleTrackSettings</a></li>
  280. <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>
  281. </ul>
  282. </div>
  283. </body>
  284. </html>