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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleDrivableSurfaceToTireFrictionPairs 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>PxVehicleDrivableSurfaceToTireFrictionPairs Class Reference<br>
<small>
[<a class="el" href="group__vehicle.html">Vehicle</a>]</small>
</h1><!-- doxytag: class="PxVehicleDrivableSurfaceToTireFrictionPairs" -->Friction for each combination of driving surface type and tire type.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxVehicleTireFriction_8h-source.html">PxVehicleTireFriction.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for PxVehicleDrivableSurfaceToTireFrictionPairs:</div>
<div class="dynsection">
<p><center><img src="classPxVehicleDrivableSurfaceToTireFrictionPairs__coll__graph.png" border="0" usemap="#PxVehicleDrivableSurfaceToTireFrictionPairs__coll__map" alt="Collaboration graph"></center>
<map name="PxVehicleDrivableSurfaceToTireFrictionPairs__coll__map">
<area shape="rect" href="classPxMaterial.html" title="Material class to represent a set of surface properties." alt="PxMaterial" coords="89,179,161,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,107,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,37"><area shape="rect" href="structPxVehicleDrivableSurfaceType.html" title="Driving surface type. Each PxMaterial is associated with a corresponding PxVehicleDrivableSurfaceTyp..." alt="PxVehicleDrivableSurfaceType" coords="245,179,432,200"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxVehicleDrivableSurfaceToTireFrictionPairs-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#b084651e983da47444643883989c9b41b2a1b700aec01af2e3ade75acf926d14">eMAX_NB_SURFACE_TYPES</a> = 256
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#7104485ac201ef952d8b164982ac222f">setup</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> nbTireTypes, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> nbSurfaceTypes, const <a class="el" href="classPxMaterial.html">PxMaterial</a> **drivableSurfaceMaterials, const <a class="el" href="structPxVehicleDrivableSurfaceType.html">PxVehicleDrivableSurfaceType</a> *drivableSurfaceTypes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set up a <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> instance for combinations of nbTireTypes tire types and nbSurfaceTypes surface types. <a href="#7104485ac201ef952d8b164982ac222f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#9068e2dae3d8693743da87a62e7ad918">release</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deallocate a <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> instance. <a href="#9068e2dae3d8693743da87a62e7ad918"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#23b36296b4be7a569f4e97e6849c1ad8">setTypePairFriction</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> surfaceType, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> tireType, const PxReal value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the friction for a specified pair of tire type and drivable surface type. <a href="#23b36296b4be7a569f4e97e6849c1ad8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#f65e20ba4b96bf8a57ca614e7d1c8330">getTypePairFriction</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> surfaceType, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> tireType) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the friction for a specified combination of surface type and tire type. <a href="#f65e20ba4b96bf8a57ca614e7d1c8330"></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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#0bdb2bff5acb5f730374518d20a725f3">getMaxNbSurfaceTypes</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum number of surface types. <a href="#0bdb2bff5acb5f730374518d20a725f3"></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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ba7edfbe72634e61271aaaf5dc9e8a95">getMaxNbTireTypes</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum number of tire types. <a href="#ba7edfbe72634e61271aaaf5dc9e8a95"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br class="typebreak">
<a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html">PxVehicleDrivableSurfaceToTireFrictionPairs</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ecff4e0404b9c0458f701754a9a7e1bb">allocate</a> (const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> maxNbTireTypes, const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> maxNbSurfaceTypes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate the memory for a <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> instance that can hold data for combinations of tire type and surface type with up to maxNbTireTypes types of tire and maxNbSurfaceTypes types of surface. <a href="#ecff4e0404b9c0458f701754a9a7e1bb"></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#6838139851fe46e93a55cc3fb4f55239">PxVehicleDrivableSurfaceToTireFrictionPairs</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#b318b7ef23407bdf40ea05c367ef2b81">~PxVehicleDrivableSurfaceToTireFrictionPairs</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#16921de5c1ead922e0b2f68bfb43d95d">mPairs</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ptr to base address of a 2d PxReal array with dimensions [mNbSurfaceTypes][mNbTireTypes]. <a href="#16921de5c1ead922e0b2f68bfb43d95d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classPxMaterial.html">PxMaterial</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#7c9886f9960190aad098e0b0249ba993">mDrivableSurfaceMaterials</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ptr to 1d array of material ptrs that is of length mNbSurfaceTypes. <a href="#7c9886f9960190aad098e0b0249ba993"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxVehicleDrivableSurfaceType.html">PxVehicleDrivableSurfaceType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ca01890cbb1302d4710e3e689bb74cba">mDrivableSurfaceTypes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ptr to 1d array of <a class="el" href="structPxVehicleDrivableSurfaceType.html" title="Driving surface type. Each PxMaterial is associated with a corresponding PxVehicleDrivableSurfaceTyp...">PxVehicleDrivableSurfaceType</a> that is of length mNbSurfaceTypes. <a href="#ca01890cbb1302d4710e3e689bb74cba"></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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#0325991a3580bbfd04b57c01c03a6ab8">mNbSurfaceTypes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of different driving surface types. <a href="#0325991a3580bbfd04b57c01c03a6ab8"></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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#2d133e4f753dfff74bed7aad963b3254">mMaxNbSurfaceTypes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of different driving surface types. <a href="#2d133e4f753dfff74bed7aad963b3254"></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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#3994d4e6a4bad267c4c1fcaa54e571d1">mNbTireTypes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of different tire types. <a href="#3994d4e6a4bad267c4c1fcaa54e571d1"></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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#d4b247a10569533b5afd523f529c467c">mMaxNbTireTypes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of different tire types. <a href="#d4b247a10569533b5afd523f529c467c"></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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#56908c7cc92d8fa93455699f4ed2645a">mPad</a> [1]</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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#7791ae023cfacd994421355401e4a54e">VehicleSurfaceTypeHashTable</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Friction for each combination of driving surface type and tire type.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxVehicleDrivableSurfaceType.html" title="Driving surface type. Each PxMaterial is associated with a corresponding PxVehicleDrivableSurfaceTyp...">PxVehicleDrivableSurfaceType</a>, <a class="el" href="classPxVehicleTireData.html#8a9469d1683718ba3e5a2d2632dd9218" title="Tire type denoting slicks, wets, snow, winter, summer, all-terrain, mud etc.">PxVehicleTireData::mType</a> </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="b084651e983da47444643883989c9b41"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::@8" ref="b084651e983da47444643883989c9b41" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="b084651e983da47444643883989c9b41b2a1b700aec01af2e3ade75acf926d14"></a><!-- doxytag: member="eMAX_NB_SURFACE_TYPES" ref="b084651e983da47444643883989c9b41b2a1b700aec01af2e3ade75acf926d14" args="" -->eMAX_NB_SURFACE_TYPES</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="6838139851fe46e93a55cc3fb4f55239"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::PxVehicleDrivableSurfaceToTireFrictionPairs" ref="6838139851fe46e93a55cc3fb4f55239" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxVehicleDrivableSurfaceToTireFrictionPairs::PxVehicleDrivableSurfaceToTireFrictionPairs </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b318b7ef23407bdf40ea05c367ef2b81"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::~PxVehicleDrivableSurfaceToTireFrictionPairs" ref="b318b7ef23407bdf40ea05c367ef2b81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxVehicleDrivableSurfaceToTireFrictionPairs::~PxVehicleDrivableSurfaceToTireFrictionPairs </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ecff4e0404b9c0458f701754a9a7e1bb"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::allocate" ref="ecff4e0404b9c0458f701754a9a7e1bb" args="(const PxU32 maxNbTireTypes, const PxU32 maxNbSurfaceTypes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html">PxVehicleDrivableSurfaceToTireFrictionPairs</a>* PxVehicleDrivableSurfaceToTireFrictionPairs::allocate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>maxNbTireTypes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>maxNbSurfaceTypes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate the memory for a <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> instance that can hold data for combinations of tire type and surface type with up to maxNbTireTypes types of tire and maxNbSurfaceTypes types of surface.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>maxNbTireTypes</em> </td><td>is the maximum number of allowed tire types. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>maxNbSurfaceTypes</em> </td><td>is the maximum number of allowed surface types. Must be less than or equal to eMAX_NB_SURFACE_TYPES</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> instance that can be reused later with new type and friction data.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#7104485ac201ef952d8b164982ac222f" title="Set up a PxVehicleDrivableSurfaceToTireFrictionPairs instance for combinations of...">setup</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="0bdb2bff5acb5f730374518d20a725f3"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::getMaxNbSurfaceTypes" ref="0bdb2bff5acb5f730374518d20a725f3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleDrivableSurfaceToTireFrictionPairs::getMaxNbSurfaceTypes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the maximum number of surface types.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The maximum number of surface types </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ecff4e0404b9c0458f701754a9a7e1bb" title="Allocate the memory for a PxVehicleDrivableSurfaceToTireFrictionPairs instance that...">allocate</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ba7edfbe72634e61271aaaf5dc9e8a95"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::getMaxNbTireTypes" ref="ba7edfbe72634e61271aaaf5dc9e8a95" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleDrivableSurfaceToTireFrictionPairs::getMaxNbTireTypes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the maximum number of tire types.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The maximum number of tire types </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ecff4e0404b9c0458f701754a9a7e1bb" title="Allocate the memory for a PxVehicleDrivableSurfaceToTireFrictionPairs instance that...">allocate</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f65e20ba4b96bf8a57ca614e7d1c8330"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::getTypePairFriction" ref="f65e20ba4b96bf8a57ca614e7d1c8330" args="(const PxU32 surfaceType, const PxU32 tireType) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal PxVehicleDrivableSurfaceToTireFrictionPairs::getTypePairFriction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>surfaceType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>tireType</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the friction for a specified combination of surface type and tire type.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The friction for a specified combination of surface type and tire type. </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The final friction value used by the tire model is the value returned by getTypePairFriction multiplied by the value computed from <a class="el" href="classPxVehicleTireData.html#ab2bbd4b293db8fb9b94f310a59176a2" title="Graph of friction vs longitudinal slip with 3 points.">PxVehicleTireData::mFrictionVsSlipGraph</a> </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleTireData.html#ab2bbd4b293db8fb9b94f310a59176a2" title="Graph of friction vs longitudinal slip with 3 points.">PxVehicleTireData::mFrictionVsSlipGraph</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9068e2dae3d8693743da87a62e7ad918"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::release" ref="9068e2dae3d8693743da87a62e7ad918" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PxVehicleDrivableSurfaceToTireFrictionPairs::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deallocate a <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> instance.
<p>
</div>
</div><p>
<a class="anchor" name="23b36296b4be7a569f4e97e6849c1ad8"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::setTypePairFriction" ref="23b36296b4be7a569f4e97e6849c1ad8" args="(const PxU32 surfaceType, const PxU32 tireType, const PxReal value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PxVehicleDrivableSurfaceToTireFrictionPairs::setTypePairFriction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>surfaceType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>tireType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const PxReal </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the friction for a specified pair of tire type and drivable surface type.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>surfaceType</em> </td><td>describes the surface type </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>tireType</em> </td><td>describes the tire type. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>value</em> </td><td>describes the friction coefficient for the combination of surface type and tire type. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7104485ac201ef952d8b164982ac222f"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::setup" ref="7104485ac201ef952d8b164982ac222f" args="(const PxU32 nbTireTypes, const PxU32 nbSurfaceTypes, const PxMaterial **drivableSurfaceMaterials, const PxVehicleDrivableSurfaceType *drivableSurfaceTypes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PxVehicleDrivableSurfaceToTireFrictionPairs::setup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>nbTireTypes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>nbSurfaceTypes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxMaterial.html">PxMaterial</a> ** </td>
<td class="paramname"> <em>drivableSurfaceMaterials</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structPxVehicleDrivableSurfaceType.html">PxVehicleDrivableSurfaceType</a> * </td>
<td class="paramname"> <em>drivableSurfaceTypes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set up a <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html" title="Friction for each combination of driving surface type and tire type.">PxVehicleDrivableSurfaceToTireFrictionPairs</a> instance for combinations of nbTireTypes tire types and nbSurfaceTypes surface types.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nbTireTypes</em> </td><td>is the number of different types of tire. This value must be less than or equal to maxNbTireTypes specified in <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ecff4e0404b9c0458f701754a9a7e1bb" title="Allocate the memory for a PxVehicleDrivableSurfaceToTireFrictionPairs instance that...">allocate()</a>. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nbSurfaceTypes</em> </td><td>is the number of different types of surface. This value must be less than or equal to maxNbSurfaceTypes specified in <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ecff4e0404b9c0458f701754a9a7e1bb" title="Allocate the memory for a PxVehicleDrivableSurfaceToTireFrictionPairs instance that...">allocate()</a>. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>drivableSurfaceMaterials</em> </td><td>is an array of <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> pointers of length nbSurfaceTypes. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>drivableSurfaceTypes</em> </td><td>is an array of <a class="el" href="structPxVehicleDrivableSurfaceType.html" title="Driving surface type. Each PxMaterial is associated with a corresponding PxVehicleDrivableSurfaceTyp...">PxVehicleDrivableSurfaceType</a> instances of length nbSurfaceTypes.</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>If the pointer to the <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> that touches the tire is found in drivableSurfaceMaterials[x] then the surface type is drivableSurfaceTypes[x].mType and the friction is the value that is set with setTypePairFriction(drivableSurfaceTypes[x].mType, <a class="el" href="classPxVehicleTireData.html#8a9469d1683718ba3e5a2d2632dd9218" title="Tire type denoting slicks, wets, snow, winter, summer, all-terrain, mud etc.">PxVehicleTireData::mType</a>, frictionValue).<p>
A friction value of 1.0 will be assigned as default to each combination of tire and surface type. To override this use setTypePairFriction. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#9068e2dae3d8693743da87a62e7ad918" title="Deallocate a PxVehicleDrivableSurfaceToTireFrictionPairs instance.">release</a>, <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#23b36296b4be7a569f4e97e6849c1ad8" title="Set the friction for a specified pair of tire type and drivable surface type.">setTypePairFriction</a>, <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#f65e20ba4b96bf8a57ca614e7d1c8330" title="Return the friction for a specified combination of surface type and tire type.">getTypePairFriction</a>, <a class="el" href="classPxVehicleTireData.html#8a9469d1683718ba3e5a2d2632dd9218" title="Tire type denoting slicks, wets, snow, winter, summer, all-terrain, mud etc.">PxVehicleTireData.mType</a> </dd></dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="7791ae023cfacd994421355401e4a54e"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::VehicleSurfaceTypeHashTable" ref="7791ae023cfacd994421355401e4a54e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class VehicleSurfaceTypeHashTable<code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="7c9886f9960190aad098e0b0249ba993"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mDrivableSurfaceMaterials" ref="7c9886f9960190aad098e0b0249ba993" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classPxMaterial.html">PxMaterial</a>** <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#7c9886f9960190aad098e0b0249ba993">PxVehicleDrivableSurfaceToTireFrictionPairs::mDrivableSurfaceMaterials</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ptr to 1d array of material ptrs that is of length mNbSurfaceTypes.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>If the <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> that touches the tire corresponds to mDrivableSurfaceMaterials[x] then the drivable surface type is mDrivableSurfaceTypes[x].mType and the friction for that contact is mPairs[mDrivableSurfaceTypes[x].mType][y], assuming a tire type y.<p>
If the <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> that touches the tire is not found in mDrivableSurfaceMaterials then the friction is mPairs[0][y], assuming a tire type y. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ca01890cbb1302d4710e3e689bb74cba"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mDrivableSurfaceTypes" ref="ca01890cbb1302d4710e3e689bb74cba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPxVehicleDrivableSurfaceType.html">PxVehicleDrivableSurfaceType</a>* <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#ca01890cbb1302d4710e3e689bb74cba">PxVehicleDrivableSurfaceToTireFrictionPairs::mDrivableSurfaceTypes</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ptr to 1d array of <a class="el" href="structPxVehicleDrivableSurfaceType.html" title="Driving surface type. Each PxMaterial is associated with a corresponding PxVehicleDrivableSurfaceTyp...">PxVehicleDrivableSurfaceType</a> that is of length mNbSurfaceTypes.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>If the <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> that touches the tire is found in mDrivableSurfaceMaterials[x] then the drivable surface type is mDrivableSurfaceTypes[x].mType and the friction for that contact is mPairs[mDrivableSurfaceTypes[x].mType][y], assuming a tire type y.<p>
If the <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> that touches the tire is not found in mDrivableSurfaceMaterials then the friction is mPairs[0][y], assuming a tire type y. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2d133e4f753dfff74bed7aad963b3254"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mMaxNbSurfaceTypes" ref="2d133e4f753dfff74bed7aad963b3254" 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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#2d133e4f753dfff74bed7aad963b3254">PxVehicleDrivableSurfaceToTireFrictionPairs::mMaxNbSurfaceTypes</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Maximum number of different driving surface types.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>mMaxNbSurfaceTypes must be less than or equal to eMAX_NB_SURFACE_TYPES. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d4b247a10569533b5afd523f529c467c"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mMaxNbTireTypes" ref="d4b247a10569533b5afd523f529c467c" 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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#d4b247a10569533b5afd523f529c467c">PxVehicleDrivableSurfaceToTireFrictionPairs::mMaxNbTireTypes</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Maximum number of different tire types.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Tire types stored in <a class="el" href="classPxVehicleTireData.html#8a9469d1683718ba3e5a2d2632dd9218" title="Tire type denoting slicks, wets, snow, winter, summer, all-terrain, mud etc.">PxVehicleTireData.mType</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="0325991a3580bbfd04b57c01c03a6ab8"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mNbSurfaceTypes" ref="0325991a3580bbfd04b57c01c03a6ab8" 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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#0325991a3580bbfd04b57c01c03a6ab8">PxVehicleDrivableSurfaceToTireFrictionPairs::mNbSurfaceTypes</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of different driving surface types.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>mDrivableSurfaceMaterials and mDrivableSurfaceTypes are both 1d arrays of length mMaxNbSurfaceTypes.<p>
mNbSurfaceTypes must be less than or equal to mMaxNbSurfaceTypes. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3994d4e6a4bad267c4c1fcaa54e571d1"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mNbTireTypes" ref="3994d4e6a4bad267c4c1fcaa54e571d1" 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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#3994d4e6a4bad267c4c1fcaa54e571d1">PxVehicleDrivableSurfaceToTireFrictionPairs::mNbTireTypes</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of different tire types.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Tire types stored in <a class="el" href="classPxVehicleTireData.html#8a9469d1683718ba3e5a2d2632dd9218" title="Tire type denoting slicks, wets, snow, winter, summer, all-terrain, mud etc.">PxVehicleTireData.mType</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="56908c7cc92d8fa93455699f4ed2645a"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mPad" ref="56908c7cc92d8fa93455699f4ed2645a" args="[1]" -->
<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="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#56908c7cc92d8fa93455699f4ed2645a">PxVehicleDrivableSurfaceToTireFrictionPairs::mPad</a>[1]<code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="16921de5c1ead922e0b2f68bfb43d95d"></a><!-- doxytag: member="PxVehicleDrivableSurfaceToTireFrictionPairs::mPairs" ref="16921de5c1ead922e0b2f68bfb43d95d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal* <a class="el" href="classPxVehicleDrivableSurfaceToTireFrictionPairs.html#16921de5c1ead922e0b2f68bfb43d95d">PxVehicleDrivableSurfaceToTireFrictionPairs::mPairs</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ptr to base address of a 2d PxReal array with dimensions [mNbSurfaceTypes][mNbTireTypes].
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Each element of the array describes the maximum friction provided by a surface type-tire type combination. eg the friction corresponding to a combination of surface type x and tire type y is mPairs[x][y] </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxVehicleTireFriction_8h-source.html">PxVehicleTireFriction.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>
|