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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
							<!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: WheelSettings 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_wheel_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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_wheel_settings-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">WheelSettings Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Base class for wheel settings, each <a class="el" href="class_vehicle_controller.html" title="Runtime data for interface that controls acceleration / deceleration of the vehicle.">VehicleController</a> can implement a derived class of this.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_wheel_8h_source.html">Wheel.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for WheelSettings:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_wheel_settings.png" usemap="#WheelSettings_map" alt=""/>
  <map id="WheelSettings_map" name="WheelSettings_map">
<area href="class_serializable_object.html" alt="SerializableObject" shape="rect" coords="0,0,170,24"/>
<area href="class_ref_target.html" alt="RefTarget&lt; WheelSettings &gt;" shape="rect" coords="180,0,350,24"/>
<area href="class_wheel_settings_t_v.html" title="WheelSettings object specifically for TrackedVehicleController." alt="WheelSettingsTV" shape="rect" coords="0,112,170,136"/>
<area href="class_wheel_settings_w_v.html" title="WheelSettings object specifically for WheeledVehicleController." alt="WheelSettingsWV" shape="rect" coords="180,112,350,136"/>
  </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:a52e5ea54df8206459139d6fce7f77503" id="r_a52e5ea54df8206459139d6fce7f77503"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a52e5ea54df8206459139d6fce7f77503">SaveBinaryState</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream) const</td></tr>
<tr class="memdesc:a52e5ea54df8206459139d6fce7f77503"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saves the contents in binary form to inStream.  <br /></td></tr>
<tr class="separator:a52e5ea54df8206459139d6fce7f77503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73a4d72105d91343f5811df864dcd4a8" id="r_a73a4d72105d91343f5811df864dcd4a8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73a4d72105d91343f5811df864dcd4a8">RestoreBinaryState</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream)</td></tr>
<tr class="memdesc:a73a4d72105d91343f5811df864dcd4a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores the contents in binary form to inStream.  <br /></td></tr>
<tr class="separator:a73a4d72105d91343f5811df864dcd4a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_serializable_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
<tr class="memitem:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object" id="r_afad98c73b77e9cef11cf5083a5866d49"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#afad98c73b77e9cef11cf5083a5866d49">~SerializableObject</a> ()=default</td></tr>
<tr class="memdesc:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; WheelSettings &gt;</a></td></tr>
<tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
<tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a50444e3b659c6f93c64aee224a93f6ab">RefTarget</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
<tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
<tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">assert no one is referencing us  <br /></td></tr>
<tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
<tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target" id="r_a1fc15bfe979bc43a7fa71c7c34f87ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_target.html">RefTarget</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a1fc15bfe979bc43a7fa71c7c34f87ed0">operator=</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
<tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <br /></td></tr>
<tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target" id="r_acaf07366183c51cd8460c7d3dcd07c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
<tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current refcount of this object.  <br /></td></tr>
<tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
<tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add or release a reference to this object.  <br /></td></tr>
<tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
<tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</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:a498fc7496addb2d3bb1798ffc494d1ae" id="r_a498fc7496addb2d3bb1798ffc494d1ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a498fc7496addb2d3bb1798ffc494d1ae">mPosition</a> { 0, 0, 0 }</td></tr>
<tr class="memdesc:a498fc7496addb2d3bb1798ffc494d1ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attachment point of wheel suspension in local space of the body.  <br /></td></tr>
<tr class="separator:a498fc7496addb2d3bb1798ffc494d1ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3981fc1b27c64cadc8a8a5e0d0e66521" id="r_a3981fc1b27c64cadc8a8a5e0d0e66521"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3981fc1b27c64cadc8a8a5e0d0e66521">mSuspensionForcePoint</a> { 0, 0, 0 }</td></tr>
<tr class="memdesc:a3981fc1b27c64cadc8a8a5e0d0e66521"><td class="mdescLeft">&#160;</td><td class="mdescRight">Where tire forces (suspension and traction) are applied, in local space of the body. A good default is the center of the wheel in its neutral pose. See mEnableSuspensionForcePoint.  <br /></td></tr>
<tr class="separator:a3981fc1b27c64cadc8a8a5e0d0e66521"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1901645636d97056d9966bdcff58d3f4" id="r_a1901645636d97056d9966bdcff58d3f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1901645636d97056d9966bdcff58d3f4">mSuspensionDirection</a> { 0, -1, 0 }</td></tr>
<tr class="memdesc:a1901645636d97056d9966bdcff58d3f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Direction of the suspension in local space of the body, should point down.  <br /></td></tr>
<tr class="separator:a1901645636d97056d9966bdcff58d3f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3ee3a56dcf0f0c4b679d9be1b44e4bb" id="r_aa3ee3a56dcf0f0c4b679d9be1b44e4bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3ee3a56dcf0f0c4b679d9be1b44e4bb">mSteeringAxis</a> { 0, 1, 0 }</td></tr>
<tr class="memdesc:aa3ee3a56dcf0f0c4b679d9be1b44e4bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Direction of the steering axis in local space of the body, should point up (e.g. for a bike would be -mSuspensionDirection)  <br /></td></tr>
<tr class="separator:aa3ee3a56dcf0f0c4b679d9be1b44e4bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80888c1fe230a769b72eed7885fe6878" id="r_a80888c1fe230a769b72eed7885fe6878"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a80888c1fe230a769b72eed7885fe6878">mWheelUp</a> { 0, 1, 0 }</td></tr>
<tr class="memdesc:a80888c1fe230a769b72eed7885fe6878"><td class="mdescLeft">&#160;</td><td class="mdescRight">Up direction when the wheel is in the neutral steering position (usually <a class="el" href="class_vehicle_constraint_settings.html#a90697fd39e19d071664f0fec05d75764" title="Vector indicating the up direction of the vehicle (in local space to the body)">VehicleConstraintSettings::mUp</a> but can be used to give the wheel camber or for a bike would be -mSuspensionDirection)  <br /></td></tr>
<tr class="separator:a80888c1fe230a769b72eed7885fe6878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af591b9f4e43a65991bff1706ad62031f" id="r_af591b9f4e43a65991bff1706ad62031f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af591b9f4e43a65991bff1706ad62031f">mWheelForward</a> { 0, 0, 1 }</td></tr>
<tr class="memdesc:af591b9f4e43a65991bff1706ad62031f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward direction when the wheel is in the neutral steering position (usually <a class="el" href="class_vehicle_constraint_settings.html#a8b5ce772889e8a121a3975f09dc511a0" title="Vector indicating forward direction of the vehicle (in local space to the body)">VehicleConstraintSettings::mForward</a> but can be used to give the wheel toe, does not need to be perpendicular to mWheelUp)  <br /></td></tr>
<tr class="separator:af591b9f4e43a65991bff1706ad62031f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afde39534b2ab075300c88a6284aeb904" id="r_afde39534b2ab075300c88a6284aeb904"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afde39534b2ab075300c88a6284aeb904">mSuspensionMinLength</a> = 0.3f</td></tr>
<tr class="memdesc:afde39534b2ab075300c88a6284aeb904"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long the suspension is in max raised position relative to the attachment point (m)  <br /></td></tr>
<tr class="separator:afde39534b2ab075300c88a6284aeb904"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29632dde4d9c95457019aa478e415345" id="r_a29632dde4d9c95457019aa478e415345"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29632dde4d9c95457019aa478e415345">mSuspensionMaxLength</a> = 0.5f</td></tr>
<tr class="memdesc:a29632dde4d9c95457019aa478e415345"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long the suspension is in max droop position relative to the attachment point (m)  <br /></td></tr>
<tr class="separator:a29632dde4d9c95457019aa478e415345"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10cfbcf5f888bf21d046c75cbdd63c67" id="r_a10cfbcf5f888bf21d046c75cbdd63c67"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a10cfbcf5f888bf21d046c75cbdd63c67">mSuspensionPreloadLength</a> = 0.0f</td></tr>
<tr class="memdesc:a10cfbcf5f888bf21d046c75cbdd63c67"><td class="mdescLeft">&#160;</td><td class="mdescRight">The natural length (m) of the suspension spring is defined as mSuspensionMaxLength + mSuspensionPreloadLength. Can be used to preload the suspension as the spring is compressed by mSuspensionPreloadLength when the suspension is in max droop position. Note that this means when the vehicle touches the ground there is a discontinuity so it will also make the vehicle more bouncy as we're updating with discrete time steps.  <br /></td></tr>
<tr class="separator:a10cfbcf5f888bf21d046c75cbdd63c67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a778e1295b5e6187b4435a66f8812be4e" id="r_a778e1295b5e6187b4435a66f8812be4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_spring_settings.html">SpringSettings</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a778e1295b5e6187b4435a66f8812be4e">mSuspensionSpring</a> { <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a>, 1.5f, 0.5f }</td></tr>
<tr class="memdesc:a778e1295b5e6187b4435a66f8812be4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Settings for the suspension spring.  <br /></td></tr>
<tr class="separator:a778e1295b5e6187b4435a66f8812be4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbcdefc252798e8ba1c9029a14a6fd84" id="r_afbcdefc252798e8ba1c9029a14a6fd84"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afbcdefc252798e8ba1c9029a14a6fd84">mRadius</a> = 0.3f</td></tr>
<tr class="memdesc:afbcdefc252798e8ba1c9029a14a6fd84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Radius of the wheel (m)  <br /></td></tr>
<tr class="separator:afbcdefc252798e8ba1c9029a14a6fd84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3384bb6aef1272f1f36c56c6397232f1" id="r_a3384bb6aef1272f1f36c56c6397232f1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3384bb6aef1272f1f36c56c6397232f1">mWidth</a> = 0.1f</td></tr>
<tr class="memdesc:a3384bb6aef1272f1f36c56c6397232f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width of the wheel (m)  <br /></td></tr>
<tr class="separator:a3384bb6aef1272f1f36c56c6397232f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6958c6097a36cfe3e3a5ad4e8930ec1d" id="r_a6958c6097a36cfe3e3a5ad4e8930ec1d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6958c6097a36cfe3e3a5ad4e8930ec1d">mEnableSuspensionForcePoint</a> = false</td></tr>
<tr class="memdesc:a6958c6097a36cfe3e3a5ad4e8930ec1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables mSuspensionForcePoint, if disabled, the forces are applied at the collision contact point. This leads to a more accurate simulation when interacting with dynamic objects but makes the vehicle less stable. When setting this to true, all forces will be applied to a fixed point on the vehicle body.  <br /></td></tr>
<tr class="separator:a6958c6097a36cfe3e3a5ad4e8930ec1d"><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_static_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; WheelSettings &gt;</a></td></tr>
<tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
<tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION.  <br /></td></tr>
<tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_serializable_object')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
<tr class="memitem:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object" id="r_a17ef2cfabac970a7b97b3dc75fa06eee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a17ef2cfabac970a7b97b3dc75fa06eee">SerializableObject</a> ()=default</td></tr>
<tr class="memdesc:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves.  <br /></td></tr>
<tr class="separator:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object" id="r_aaf09b99b1dcfe726a392cfa2f9e2b3eb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#aaf09b99b1dcfe726a392cfa2f9e2b3eb">SerializableObject</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &amp;)=default</td></tr>
<tr class="separator:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object" id="r_a2e1b9e7dda273bacf82f2708c9f8537a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_serializable_object.html">SerializableObject</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a2e1b9e7dda273bacf82f2708c9f8537a">operator=</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &amp;)=default</td></tr>
<tr class="separator:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; WheelSettings &gt;</a></td></tr>
<tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic&lt; <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
<tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count.  <br /></td></tr>
<tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; WheelSettings &gt;</a></td></tr>
<tr class="memitem:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target" id="r_ad37db773efa3c8756f6d95df3862b875"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
<tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded.  <br /></td></tr>
<tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><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>Base class for wheel settings, each <a class="el" href="class_vehicle_controller.html" title="Runtime data for interface that controls acceleration / deceleration of the vehicle.">VehicleController</a> can implement a derived class of this. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a73a4d72105d91343f5811df864dcd4a8" name="a73a4d72105d91343f5811df864dcd4a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73a4d72105d91343f5811df864dcd4a8">&#9670;&#160;</a></span>RestoreBinaryState()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void WheelSettings::RestoreBinaryState </td>
          <td>(</td>
          <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>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Restores the contents in binary form to inStream. </p>

<p>Reimplemented in <a class="el" href="class_wheel_settings_t_v.html#a026d2a093b4da2f93be1a50a855eac5d">WheelSettingsTV</a>, and <a class="el" href="class_wheel_settings_w_v.html#a30dc23071eb952eaf4ec80cdd3453c39">WheelSettingsWV</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void WheelSettings::SaveBinaryState </td>
          <td>(</td>
          <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>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Saves the contents in binary form to inStream. </p>

<p>Reimplemented in <a class="el" href="class_wheel_settings_t_v.html#aa38d108404d72d9ddac0d87be1b22e8e">WheelSettingsTV</a>, and <a class="el" href="class_wheel_settings_w_v.html#a907782aa9c6e6c2dde932b9b01835796">WheelSettingsWV</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool WheelSettings::mEnableSuspensionForcePoint = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables mSuspensionForcePoint, if disabled, the forces are applied at the collision contact point. This leads to a more accurate simulation when interacting with dynamic objects but makes the vehicle less stable. When setting this to true, all forces will be applied to a fixed point on the vehicle body. </p>

</div>
</div>
<a id="a498fc7496addb2d3bb1798ffc494d1ae" name="a498fc7496addb2d3bb1798ffc494d1ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a498fc7496addb2d3bb1798ffc494d1ae">&#9670;&#160;</a></span>mPosition</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> WheelSettings::mPosition { 0, 0, 0 }</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Attachment point of wheel suspension in local space of the body. </p>

</div>
</div>
<a id="afbcdefc252798e8ba1c9029a14a6fd84" name="afbcdefc252798e8ba1c9029a14a6fd84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbcdefc252798e8ba1c9029a14a6fd84">&#9670;&#160;</a></span>mRadius</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float WheelSettings::mRadius = 0.3f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Radius of the wheel (m) </p>

</div>
</div>
<a id="aa3ee3a56dcf0f0c4b679d9be1b44e4bb" name="aa3ee3a56dcf0f0c4b679d9be1b44e4bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3ee3a56dcf0f0c4b679d9be1b44e4bb">&#9670;&#160;</a></span>mSteeringAxis</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> WheelSettings::mSteeringAxis { 0, 1, 0 }</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Direction of the steering axis in local space of the body, should point up (e.g. for a bike would be -mSuspensionDirection) </p>

</div>
</div>
<a id="a1901645636d97056d9966bdcff58d3f4" name="a1901645636d97056d9966bdcff58d3f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1901645636d97056d9966bdcff58d3f4">&#9670;&#160;</a></span>mSuspensionDirection</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> WheelSettings::mSuspensionDirection { 0, -1, 0 }</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Direction of the suspension in local space of the body, should point down. </p>

</div>
</div>
<a id="a3981fc1b27c64cadc8a8a5e0d0e66521" name="a3981fc1b27c64cadc8a8a5e0d0e66521"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3981fc1b27c64cadc8a8a5e0d0e66521">&#9670;&#160;</a></span>mSuspensionForcePoint</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> WheelSettings::mSuspensionForcePoint { 0, 0, 0 }</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Where tire forces (suspension and traction) are applied, in local space of the body. A good default is the center of the wheel in its neutral pose. See mEnableSuspensionForcePoint. </p>

</div>
</div>
<a id="a29632dde4d9c95457019aa478e415345" name="a29632dde4d9c95457019aa478e415345"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29632dde4d9c95457019aa478e415345">&#9670;&#160;</a></span>mSuspensionMaxLength</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float WheelSettings::mSuspensionMaxLength = 0.5f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How long the suspension is in max droop position relative to the attachment point (m) </p>

</div>
</div>
<a id="afde39534b2ab075300c88a6284aeb904" name="afde39534b2ab075300c88a6284aeb904"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afde39534b2ab075300c88a6284aeb904">&#9670;&#160;</a></span>mSuspensionMinLength</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float WheelSettings::mSuspensionMinLength = 0.3f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How long the suspension is in max raised position relative to the attachment point (m) </p>

</div>
</div>
<a id="a10cfbcf5f888bf21d046c75cbdd63c67" name="a10cfbcf5f888bf21d046c75cbdd63c67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10cfbcf5f888bf21d046c75cbdd63c67">&#9670;&#160;</a></span>mSuspensionPreloadLength</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float WheelSettings::mSuspensionPreloadLength = 0.0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The natural length (m) of the suspension spring is defined as mSuspensionMaxLength + mSuspensionPreloadLength. Can be used to preload the suspension as the spring is compressed by mSuspensionPreloadLength when the suspension is in max droop position. Note that this means when the vehicle touches the ground there is a discontinuity so it will also make the vehicle more bouncy as we're updating with discrete time steps. </p>

</div>
</div>
<a id="a778e1295b5e6187b4435a66f8812be4e" name="a778e1295b5e6187b4435a66f8812be4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a778e1295b5e6187b4435a66f8812be4e">&#9670;&#160;</a></span>mSuspensionSpring</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_spring_settings.html">SpringSettings</a> WheelSettings::mSuspensionSpring { <a class="el" href="_spring_settings_8h.html#ac805e5e93f24003512d2ca7e0d71512da52630869b4ed10261d514c91e9c9c018">ESpringMode::FrequencyAndDamping</a>, 1.5f, 0.5f }</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Settings for the suspension spring. </p>

</div>
</div>
<a id="af591b9f4e43a65991bff1706ad62031f" name="af591b9f4e43a65991bff1706ad62031f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af591b9f4e43a65991bff1706ad62031f">&#9670;&#160;</a></span>mWheelForward</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> WheelSettings::mWheelForward { 0, 0, 1 }</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Forward direction when the wheel is in the neutral steering position (usually <a class="el" href="class_vehicle_constraint_settings.html#a8b5ce772889e8a121a3975f09dc511a0" title="Vector indicating forward direction of the vehicle (in local space to the body)">VehicleConstraintSettings::mForward</a> but can be used to give the wheel toe, does not need to be perpendicular to mWheelUp) </p>

</div>
</div>
<a id="a80888c1fe230a769b72eed7885fe6878" name="a80888c1fe230a769b72eed7885fe6878"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80888c1fe230a769b72eed7885fe6878">&#9670;&#160;</a></span>mWheelUp</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> WheelSettings::mWheelUp { 0, 1, 0 }</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Up direction when the wheel is in the neutral steering position (usually <a class="el" href="class_vehicle_constraint_settings.html#a90697fd39e19d071664f0fec05d75764" title="Vector indicating the up direction of the vehicle (in local space to the body)">VehicleConstraintSettings::mUp</a> but can be used to give the wheel camber or for a bike would be -mSuspensionDirection) </p>

</div>
</div>
<a id="a3384bb6aef1272f1f36c56c6397232f1" name="a3384bb6aef1272f1f36c56c6397232f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3384bb6aef1272f1f36c56c6397232f1">&#9670;&#160;</a></span>mWidth</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float WheelSettings::mWidth = 0.1f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Width of the wheel (m) </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Physics/Vehicle/<a class="el" href="_wheel_8h_source.html">Wheel.h</a></li>
<li>Jolt/Physics/Vehicle/<a class="el" href="_wheel_8cpp.html">Wheel.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_wheel_settings.html">WheelSettings</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>