blob: ffdb85d9a39ec548bc4360a8c335a46bc6c867ab (
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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleClutchData 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>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxVehicleClutchData Class Reference<br>
<small>
[<a class="el" href="group__vehicle.html">Vehicle</a>]</small>
</h1><!-- doxytag: class="PxVehicleClutchData" --><code>#include <<a class="el" href="PxVehicleComponents_8h-source.html">PxVehicleComponents.h</a>></code>
<p>
<p>
<a href="classPxVehicleClutchData-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#963c71a977c0bfbb465fd75d1e106dc0">PxVehicleClutchData</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#5f50479c769bfc6ae880b92036abce8d">PxVehicleClutchData</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#fa3118a1b2b8d091a96a29f1b03ec339">mStrength</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Strength of clutch. <a href="#fa3118a1b2b8d091a96a29f1b03ec339"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxVehicleClutchAccuracyMode.html#8cb4ae31cf929f344f2049939b9f61ce">PxVehicleClutchAccuracyMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#8f1a138c63ae5bd015ed18de90168dab">mAccuracyMode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The engine and wheel rotation speeds that are coupled through the clutch can be updated by choosing one of two modes: eESTIMATE and eBEST_POSSIBLE. <a href="#8f1a138c63ae5bd015ed18de90168dab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#64f27aab12c4d3f6deae242e04c95e3f">mEstimateIterations</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tune the mathematical accuracy and computational cost of the computed estimate to the wheel and engine rotation speeds if eESTIMATE is chosen. <a href="#64f27aab12c4d3f6deae242e04c95e3f"></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#b6b86a78df445b43f48cfbeb1afccabf">isValid</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU8 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#64734e299b40dacd3de949b2cabd8b67">mPad</a> [4]</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#a2f8773ce851c65e3c7d31b8991ea8f8">PxVehicleDriveSimData</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="963c71a977c0bfbb465fd75d1e106dc0"></a><!-- doxytag: member="PxVehicleClutchData::PxVehicleClutchData" ref="963c71a977c0bfbb465fd75d1e106dc0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxVehicleClutchData::PxVehicleClutchData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5f50479c769bfc6ae880b92036abce8d"></a><!-- doxytag: member="PxVehicleClutchData::PxVehicleClutchData" ref="5f50479c769bfc6ae880b92036abce8d" args="(const PxEMPTY)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxVehicleClutchData::PxVehicleClutchData </td>
<td>(</td>
<td class="paramtype">const </td>
<td class="paramname"> <em>PxEMPTY</em> </td>
<td> ) </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="b6b86a78df445b43f48cfbeb1afccabf"></a><!-- doxytag: member="PxVehicleClutchData::isValid" ref="b6b86a78df445b43f48cfbeb1afccabf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PxVehicleClutchData::isValid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="a2f8773ce851c65e3c7d31b8991ea8f8"></a><!-- doxytag: member="PxVehicleClutchData::PxVehicleDriveSimData" ref="a2f8773ce851c65e3c7d31b8991ea8f8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</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="8f1a138c63ae5bd015ed18de90168dab"></a><!-- doxytag: member="PxVehicleClutchData::mAccuracyMode" ref="8f1a138c63ae5bd015ed18de90168dab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPxVehicleClutchAccuracyMode.html#8cb4ae31cf929f344f2049939b9f61ce">PxVehicleClutchAccuracyMode::Enum</a> <a class="el" href="classPxVehicleClutchData.html#8f1a138c63ae5bd015ed18de90168dab">PxVehicleClutchData::mAccuracyMode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The engine and wheel rotation speeds that are coupled through the clutch can be updated by choosing one of two modes: eESTIMATE and eBEST_POSSIBLE.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>If eESTIMATE is chosen the vehicle sdk will update the wheel and engine rotation speeds with estimated values to the implemented clutch model.<p>
If eBEST_POSSIBLE is chosen the vehicle sdk will compute the best possible solution (within floating point tolerance) to the implemented clutch model. This is the recommended mode.<p>
The clutch model remains the same if either eESTIMATE or eBEST_POSSIBLE is chosen but the accuracy and computational cost of the solution to the model can be tuned as required. </dd></dl>
</div>
</div><p>
<a class="anchor" name="64f27aab12c4d3f6deae242e04c95e3f"></a><!-- doxytag: member="PxVehicleClutchData::mEstimateIterations" ref="64f27aab12c4d3f6deae242e04c95e3f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxVehicleClutchData.html#64f27aab12c4d3f6deae242e04c95e3f">PxVehicleClutchData::mEstimateIterations</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tune the mathematical accuracy and computational cost of the computed estimate to the wheel and engine rotation speeds if eESTIMATE is chosen.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>As mEstimateIterations increases the computational cost of the clutch also increases and the solution approaches the solution that would be computed if eBEST_POSSIBLE was chosen instead.<p>
This has no effect if eBEST_POSSIBLE is chosen as the accuracy mode.<p>
A value of zero is not allowed if eESTIMATE is chosen as the accuracy mode. </dd></dl>
</div>
</div><p>
<a class="anchor" name="64734e299b40dacd3de949b2cabd8b67"></a><!-- doxytag: member="PxVehicleClutchData::mPad" ref="64734e299b40dacd3de949b2cabd8b67" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxU8 <a class="el" href="classPxVehicleClutchData.html#64734e299b40dacd3de949b2cabd8b67">PxVehicleClutchData::mPad</a>[4]<code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="fa3118a1b2b8d091a96a29f1b03ec339"></a><!-- doxytag: member="PxVehicleClutchData::mStrength" ref="fa3118a1b2b8d091a96a29f1b03ec339" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxVehicleClutchData.html#fa3118a1b2b8d091a96a29f1b03ec339">PxVehicleClutchData::mStrength</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Strength of clutch.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The clutch is the mechanism that couples the engine to the wheels. A stronger clutch more strongly couples the engine to the wheels, while a clutch of strength zero completely decouples the engine from the wheels. Stronger clutches more quickly bring the wheels and engine into equilibrium, while weaker clutches take longer, resulting in periods of clutch slip and delays in power transmission from the engine to the wheels. The torque generated by the clutch is proportional to the clutch strength and the velocity difference between the engine's rotational speed and the rotational speed of the driven wheels after accounting for the gear ratio. The torque at the clutch is applied negatively to the engine and positively to the driven wheels.<p>
Specified in kilograms metres-squared per second (kg m^2 s^-1)</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 © 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>
|