aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleAckermannGeometryData.html
blob: edad650ba61bbf47de5d82559dd12fbd65394362 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleAckermannGeometryData Class Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxVehicleAckermannGeometryData Class Reference<br>
<small>
[<a class="el" href="group__vehicle.html">Vehicle</a>]</small>
</h1><!-- doxytag: class="PxVehicleAckermannGeometryData" --><code>#include &lt;<a class="el" href="PxVehicleComponents_8h-source.html">PxVehicleComponents.h</a>&gt;</code>
<p>

<p>
<a href="classPxVehicleAckermannGeometryData-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#67df50348629357c2034e8517817e896">PxVehicleAckermannGeometryData</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#6d15ee641598033fef887c399f547422">PxVehicleAckermannGeometryData</a> (const <a class="el" href="group__foundation.html#g0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>)</td></tr>

<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#f039623f85305bb425d9bd057810d072">mAccuracy</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Accuracy of Ackermann steer calculation.  <a href="#f039623f85305bb425d9bd057810d072"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#b11fb980c1082f7bcec722a16faa91a2">mFrontWidth</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Distance between center-point of the two front wheels.  <a href="#b11fb980c1082f7bcec722a16faa91a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#d1782c61ec9515dee01722f9620d4b54">mRearWidth</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Distance between center-point of the two rear wheels.  <a href="#d1782c61ec9515dee01722f9620d4b54"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#a3665a214eb8b1188a1c8fdd66f7f74d">mAxleSeparation</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Distance between center of front axle and center of rear axle.  <a href="#a3665a214eb8b1188a1c8fdd66f7f74d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#262db8509d0da0326811f0844b4f0f7d">isValid</a> () const </td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAckermannGeometryData.html#be694ed054b9f8747c22bcd3fe251b98">PxVehicleDriveSimData4W</a></td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="67df50348629357c2034e8517817e896"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::PxVehicleAckermannGeometryData" ref="67df50348629357c2034e8517817e896" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxVehicleAckermannGeometryData::PxVehicleAckermannGeometryData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="6d15ee641598033fef887c399f547422"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::PxVehicleAckermannGeometryData" ref="6d15ee641598033fef887c399f547422" args="(const PxEMPTY)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxVehicleAckermannGeometryData::PxVehicleAckermannGeometryData           </td>
          <td>(</td>
          <td class="paramtype">const &nbsp;</td>
          <td class="paramname"> <em>PxEMPTY</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="262db8509d0da0326811f0844b4f0f7d"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::isValid" ref="262db8509d0da0326811f0844b4f0f7d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool PxVehicleAckermannGeometryData::isValid           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="be694ed054b9f8747c22bcd3fe251b98"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::PxVehicleDriveSimData4W" ref="be694ed054b9f8747c22bcd3fe251b98" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classPxVehicleDriveSimData4W.html">PxVehicleDriveSimData4W</a><code> [friend]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f039623f85305bb425d9bd057810d072"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::mAccuracy" ref="f039623f85305bb425d9bd057810d072" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="classPxVehicleAckermannGeometryData.html#f039623f85305bb425d9bd057810d072">PxVehicleAckermannGeometryData::mAccuracy</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Accuracy of Ackermann steer calculation. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Accuracy with value 0.0 results in no Ackermann steer-correction, while accuracy with value 1.0 results in perfect Ackermann steer-correction.<p>
Perfect Ackermann steer correction modifies the steer angles applied to the front-left and front-right wheels so that the perpendiculars to the wheels' longitudinal directions cross the extended vector of the rear axle at the same point. It is also applied to any steer angle applied to the rear wheels but instead using the extended vector of the front axle.<p>
In general, more steer correction produces better cornering behavior.</dd></dl>
<b>Range:</b> [0, 1]<br>
 
</div>
</div><p>
<a class="anchor" name="a3665a214eb8b1188a1c8fdd66f7f74d"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::mAxleSeparation" ref="a3665a214eb8b1188a1c8fdd66f7f74d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="classPxVehicleAckermannGeometryData.html#a3665a214eb8b1188a1c8fdd66f7f74d">PxVehicleAckermannGeometryData::mAxleSeparation</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Distance between center of front axle and center of rear axle. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Specified in metres (m).</dd></dl>
<b>Range:</b> [0, PX_MAX_F32)<br>
 
</div>
</div><p>
<a class="anchor" name="b11fb980c1082f7bcec722a16faa91a2"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::mFrontWidth" ref="b11fb980c1082f7bcec722a16faa91a2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="classPxVehicleAckermannGeometryData.html#b11fb980c1082f7bcec722a16faa91a2">PxVehicleAckermannGeometryData::mFrontWidth</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Distance between center-point of the two front wheels. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Specified in metres (m).</dd></dl>
<b>Range:</b> [0, PX_MAX_F32)<br>
 
</div>
</div><p>
<a class="anchor" name="d1782c61ec9515dee01722f9620d4b54"></a><!-- doxytag: member="PxVehicleAckermannGeometryData::mRearWidth" ref="d1782c61ec9515dee01722f9620d4b54" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="classPxVehicleAckermannGeometryData.html#d1782c61ec9515dee01722f9620d4b54">PxVehicleAckermannGeometryData::mRearWidth</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Distance between center-point of the two rear wheels. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Specified in metres (m).</dd></dl>
<b>Range:</b> [0, PX_MAX_F32)<br>
 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxVehicleComponents_8h-source.html">PxVehicleComponents.h</a></ul>
</div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>