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
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxControllerDesc 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>PxControllerDesc Class Reference<br>
<small>
[<a class="el" href="group__character.html">Character</a>]</small>
</h1><!-- doxytag: class="PxControllerDesc" -->Descriptor class for a character controller.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxController_8h-source.html">PxController.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxControllerDesc:</div>
<div class="dynsection">
<p><center><img src="classPxControllerDesc__inherit__graph.png" border="0" usemap="#PxControllerDesc__inherit__map" alt="Inheritance graph"></center>
<map name="PxControllerDesc__inherit__map">
<area shape="rect" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller." alt="PxBoxControllerDesc" coords="7,85,140,107"><area shape="rect" href="classPxCapsuleControllerDesc.html" title="A descriptor for a capsule character controller." alt="PxCapsuleControllerDesc" coords="164,85,324,107"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxControllerDesc:</div>
<div class="dynsection">
<p><center><img src="classPxControllerDesc__coll__graph.png" border="0" usemap="#PxControllerDesc__coll__map" alt="Collaboration graph"></center>
<map name="PxControllerDesc__coll__map">
<area shape="rect" href="structPxExtendedVec3.html" title="PxExtendedVec3" alt="PxExtendedVec3" coords="535,16,644,38"><area shape="rect" href="classPxMaterial.html" title="Material class to represent a set of surface properties." alt="PxMaterial" coords="553,86,625,107"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="389,86,445,107"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="17,86,255,107"><area shape="rect" href="classPxControllerBehaviorCallback.html" title="User behavior callback." alt="PxControllerBehaviorCallback" coords="499,155,680,176"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="563,224,616,246"><area shape="rect" href="classPxUserControllerHitReport.html" title="User callback class for character controller events." alt="PxUserControllerHitReport" coords="508,294,671,315"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxControllerDesc-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">virtual PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#g4bc247ac0f6c9cf1a0baa75c6b1c5ce1">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the current settings are valid <a href="group__character.html#g4bc247ac0f6c9cf1a0baa75c6b1c5ce1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE <br class="typebreak">
<a class="el" href="structPxControllerShapeType.html#46022b44cb41038a1b05bcaa6e043d03">PxControllerShapeType::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#609846f3b5cc062d7c98686b669cca72">getType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the character controller type. <a href="#609846f3b5cc062d7c98686b669cca72"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxExtendedVec3.html">PxExtendedVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#32b1a3f9f58902b31058b9c076fd8ae3">position</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The position of the character. <a href="#32b1a3f9f58902b31058b9c076fd8ae3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#f1a0990b26249f3114c41e20a9cb3087">upDirection</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies the 'up' direction. <a href="#f1a0990b26249f3114c41e20a9cb3087"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#adb1325a040c61b6cd29cfa94d24c180">slopeLimit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum slope which the character can walk up. <a href="#adb1325a040c61b6cd29cfa94d24c180"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#c67b8bbd1150f4e9fb30e56e4a81a7e1">invisibleWallHeight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Height of invisible walls created around non-walkable triangles. <a href="#c67b8bbd1150f4e9fb30e56e4a81a7e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#36e184a8b3c7a4ffbd1f2ab934d37ae1">maxJumpHeight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum height a jumping character can reach. <a href="#36e184a8b3c7a4ffbd1f2ab934d37ae1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#811b0354ee3c9c037dca94f7cae4205e">contactOffset</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The contact offset used by the controller. <a href="#811b0354ee3c9c037dca94f7cae4205e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#51fe254a4807b832b2d34e884d856438">stepOffset</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Defines the maximum height of an obstacle which the character can climb. <a href="#51fe254a4807b832b2d34e884d856438"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#6da1c7c40072c2419015dc40e754ab66">density</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Density of underlying kinematic actor. <a href="#6da1c7c40072c2419015dc40e754ab66"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#c8f9db4e34061ab9193886159e1d76f7">scaleCoeff</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scale coefficient for underlying kinematic actor. <a href="#c8f9db4e34061ab9193886159e1d76f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#93930e888fcd4c2f7bafeac83621612e">volumeGrowth</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cached volume growth. <a href="#93930e888fcd4c2f7bafeac83621612e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxUserControllerHitReport.html">PxUserControllerHitReport</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#56056268aeb2b3c460060d593b1df118">reportCallback</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies a user report callback. <a href="#56056268aeb2b3c460060d593b1df118"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxControllerBehaviorCallback.html">PxControllerBehaviorCallback</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#1638be92a0c32864ccd7f78a8035260a">behaviorCallback</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies a user behavior callback. <a href="#1638be92a0c32864ccd7f78a8035260a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxControllerNonWalkableMode.html#4dd560c274d7c9076469ae267ffa87f2">PxControllerNonWalkableMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#d8286ec8cdb374997b9902a1ef21192c">nonWalkableMode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The non-walkable mode controls if a character controller slides or not on a non-walkable part. <a href="#d8286ec8cdb374997b9902a1ef21192c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxMaterial.html">PxMaterial</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#7a249fbbf5920b61715eb518178496f1">material</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The material for the actor associated with the controller. <a href="#7a249fbbf5920b61715eb518178496f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#ce3cfde3ada3a9a4b12c7c117cf1d137">registerDeletionListener</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use a deletion listener to get informed about released objects and clear internal caches if needed. <a href="#ce3cfde3ada3a9a4b12c7c117cf1d137"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#b1144ac32fd0a4173e8d3136ae3e604f">userData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">User specified data associated with the controller. <a href="#b1144ac32fd0a4173e8d3136ae3e604f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#g749a16c7bcdb8341d346abe43c023c12">PxControllerDesc</a> (<a class="el" href="structPxControllerShapeType.html#46022b44cb41038a1b05bcaa6e043d03">PxControllerShapeType::Enum</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor sets to default. <a href="group__character.html#g749a16c7bcdb8341d346abe43c023c12"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#geea81704d1af3dec82b411b53d39b7e0">~PxControllerDesc</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#g3144636d9207dbed885c9579898987a5">PxControllerDesc</a> (const <a class="el" href="classPxControllerDesc.html">PxControllerDesc</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor. <a href="group__character.html#g3144636d9207dbed885c9579898987a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE <a class="el" href="classPxControllerDesc.html">PxControllerDesc</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#ge237ed6fc1c29cdf83cda84e7e0c8b39">operator=</a> (const <a class="el" href="classPxControllerDesc.html">PxControllerDesc</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">assignment operator. <a href="group__character.html#ge237ed6fc1c29cdf83cda84e7e0c8b39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#gf9c49d2828ce1a5d48d828145a67ae14">copy</a> (const <a class="el" href="classPxControllerDesc.html">PxControllerDesc</a> &)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structPxControllerShapeType.html#46022b44cb41038a1b05bcaa6e043d03">PxControllerShapeType::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerDesc.html#dc3a15c47a52f31c449724fe71686d1b">mType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The type of the controller. This gets set by the derived class' ctor, the user should not have to change it. <a href="#dc3a15c47a52f31c449724fe71686d1b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Descriptor class for a character controller.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxController.html" title="Box character controller.">PxBoxController</a> <a class="el" href="classPxCapsuleController.html" title="A capsule character controller.">PxCapsuleController</a> </dd></dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="609846f3b5cc062d7c98686b669cca72"></a><!-- doxytag: member="PxControllerDesc::getType" ref="609846f3b5cc062d7c98686b669cca72" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE <a class="el" href="structPxControllerShapeType.html#46022b44cb41038a1b05bcaa6e043d03">PxControllerShapeType::Enum</a> PxControllerDesc::getType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the character controller type.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The controllers type.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>PxControllerType <a class="el" href="classPxCapsuleControllerDesc.html" title="A descriptor for a capsule character controller.">PxCapsuleControllerDesc</a> <a class="el" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a> </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1638be92a0c32864ccd7f78a8035260a"></a><!-- doxytag: member="PxControllerDesc::behaviorCallback" ref="1638be92a0c32864ccd7f78a8035260a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPxControllerBehaviorCallback.html">PxControllerBehaviorCallback</a>* <a class="el" href="classPxControllerDesc.html#1638be92a0c32864ccd7f78a8035260a">PxControllerDesc::behaviorCallback</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specifies a user behavior callback.
<p>
This behavior callback is called to customize the controller's behavior w.r.t. touched shapes.<p>
Setting this to NULL disables the callback.<p>
<b>Default:</b> NULL<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxControllerBehaviorCallback.html" title="User behavior callback.">PxControllerBehaviorCallback</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="811b0354ee3c9c037dca94f7cae4205e"></a><!-- doxytag: member="PxControllerDesc::contactOffset" ref="811b0354ee3c9c037dca94f7cae4205e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#811b0354ee3c9c037dca94f7cae4205e">PxControllerDesc::contactOffset</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The contact offset used by the controller.
<p>
Specifies a skin around the object within which contacts will be generated. Use it to avoid numerical precision issues.<p>
This is dependant on the scale of the users world, but should be a small, positive non zero value.<p>
<b>Default:</b> 0.1
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6da1c7c40072c2419015dc40e754ab66"></a><!-- doxytag: member="PxControllerDesc::density" ref="6da1c7c40072c2419015dc40e754ab66" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#6da1c7c40072c2419015dc40e754ab66">PxControllerDesc::density</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Density of underlying kinematic actor.
<p>
The CCT creates a PhysX's kinematic actor under the hood. This controls its density.<p>
<b>Default:</b> 10.0
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c67b8bbd1150f4e9fb30e56e4a81a7e1"></a><!-- doxytag: member="PxControllerDesc::invisibleWallHeight" ref="c67b8bbd1150f4e9fb30e56e4a81a7e1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#c67b8bbd1150f4e9fb30e56e4a81a7e1">PxControllerDesc::invisibleWallHeight</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Height of invisible walls created around non-walkable triangles.
<p>
The library can automatically create invisible walls around non-walkable triangles defined by the 'slopeLimit' parameter. This defines the height of those walls. If it is 0.0, then no extra triangles are created.<p>
<b>Default:</b> 0.0<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxControllerDesc.html#f1a0990b26249f3114c41e20a9cb3087" title="Specifies the 'up' direction.">upDirection</a> <a class="el" href="classPxControllerDesc.html#adb1325a040c61b6cd29cfa94d24c180" title="The maximum slope which the character can walk up.">slopeLimit</a> <a class="el" href="classPxControllerDesc.html#36e184a8b3c7a4ffbd1f2ab934d37ae1" title="Maximum height a jumping character can reach.">maxJumpHeight</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="7a249fbbf5920b61715eb518178496f1"></a><!-- doxytag: member="PxControllerDesc::material" ref="7a249fbbf5920b61715eb518178496f1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPxMaterial.html">PxMaterial</a>* <a class="el" href="classPxControllerDesc.html#7a249fbbf5920b61715eb518178496f1">PxControllerDesc::material</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The material for the actor associated with the controller.
<p>
The controller internally creates a rigid body actor. This parameter specifies the material of the actor.<p>
<b>Default:</b> NULL<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="36e184a8b3c7a4ffbd1f2ab934d37ae1"></a><!-- doxytag: member="PxControllerDesc::maxJumpHeight" ref="36e184a8b3c7a4ffbd1f2ab934d37ae1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#36e184a8b3c7a4ffbd1f2ab934d37ae1">PxControllerDesc::maxJumpHeight</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Maximum height a jumping character can reach.
<p>
This is only used if invisible walls are created ('invisibleWallHeight' is non zero).<p>
When a character jumps, the non-walkable triangles he might fly over are not found by the collision queries (since the character's bounding volume does not touch them). Thus those non-walkable triangles do not create invisible walls, and it is possible for a jumping character to land on a non-walkable triangle, while he wouldn't have reached that place by just walking.<p>
The 'maxJumpHeight' variable is used to extend the size of the collision volume downward. This way, all the non-walkable triangles are properly found by the collision queries and it becomes impossible to 'jump over' invisible walls.<p>
If the character in your game can not jump, it is safe to use 0.0 here. Otherwise it is best to keep this value as small as possible, since a larger collision volume means more triangles to process.<p>
<b>Default:</b> 0.0<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxControllerDesc.html#f1a0990b26249f3114c41e20a9cb3087" title="Specifies the 'up' direction.">upDirection</a> <a class="el" href="classPxControllerDesc.html#adb1325a040c61b6cd29cfa94d24c180" title="The maximum slope which the character can walk up.">slopeLimit</a> <a class="el" href="classPxControllerDesc.html#c67b8bbd1150f4e9fb30e56e4a81a7e1" title="Height of invisible walls created around non-walkable triangles.">invisibleWallHeight</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="dc3a15c47a52f31c449724fe71686d1b"></a><!-- doxytag: member="PxControllerDesc::mType" ref="dc3a15c47a52f31c449724fe71686d1b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structPxControllerShapeType.html#46022b44cb41038a1b05bcaa6e043d03">PxControllerShapeType::Enum</a> <a class="el" href="classPxControllerDesc.html#dc3a15c47a52f31c449724fe71686d1b">PxControllerDesc::mType</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The type of the controller. This gets set by the derived class' ctor, the user should not have to change it.
<p>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d8286ec8cdb374997b9902a1ef21192c"></a><!-- doxytag: member="PxControllerDesc::nonWalkableMode" ref="d8286ec8cdb374997b9902a1ef21192c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPxControllerNonWalkableMode.html#4dd560c274d7c9076469ae267ffa87f2">PxControllerNonWalkableMode::Enum</a> <a class="el" href="classPxControllerDesc.html#d8286ec8cdb374997b9902a1ef21192c">PxControllerDesc::nonWalkableMode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The non-walkable mode controls if a character controller slides or not on a non-walkable part.
<p>
This is only used when slopeLimit is non zero.<p>
<b>Default:</b> <a class="el" href="structPxControllerNonWalkableMode.html#4dd560c274d7c9076469ae267ffa87f2da7953fa71ceda3b66aeeb078e8f6f35" title="Stops character from climbing up non-walkable slopes, but doesn't move it otherwise...">PxControllerNonWalkableMode::ePREVENT_CLIMBING</a><p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerNonWalkableMode.html" title="specifies how a CCT interacts with non-walkable parts.">PxControllerNonWalkableMode</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="32b1a3f9f58902b31058b9c076fd8ae3"></a><!-- doxytag: member="PxControllerDesc::position" ref="32b1a3f9f58902b31058b9c076fd8ae3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPxExtendedVec3.html">PxExtendedVec3</a> <a class="el" href="classPxControllerDesc.html#32b1a3f9f58902b31058b9c076fd8ae3">PxControllerDesc::position</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The position of the character.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The character's initial position must be such that it does not overlap the static geometry.</dd></dl>
<b>Default:</b> Zero
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ce3cfde3ada3a9a4b12c7c117cf1d137"></a><!-- doxytag: member="PxControllerDesc::registerDeletionListener" ref="ce3cfde3ada3a9a4b12c7c117cf1d137" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classPxControllerDesc.html#ce3cfde3ada3a9a4b12c7c117cf1d137">PxControllerDesc::registerDeletionListener</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Use a deletion listener to get informed about released objects and clear internal caches if needed.
<p>
If a character controller registers a deletion listener, it will get informed about released objects. That allows the controller to invalidate cached data that connects to a released object. If a deletion listener is not registered, <a class="el" href="classPxController.html#4d65669022c2f65926fde8112e72c500" title="Flushes internal geometry cache.">PxController::invalidateCache</a> has to be called manually after objects have been released.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxController.html#4d65669022c2f65926fde8112e72c500" title="Flushes internal geometry cache.">PxController::invalidateCache</a></dd></dl>
<b>Default:</b> true
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="56056268aeb2b3c460060d593b1df118"></a><!-- doxytag: member="PxControllerDesc::reportCallback" ref="56056268aeb2b3c460060d593b1df118" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPxUserControllerHitReport.html">PxUserControllerHitReport</a>* <a class="el" href="classPxControllerDesc.html#56056268aeb2b3c460060d593b1df118">PxControllerDesc::reportCallback</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specifies a user report callback.
<p>
This report callback is called when the character collides with shapes and other characters.<p>
Setting this to NULL disables the callback.<p>
<b>Default:</b> NULL<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxUserControllerHitReport.html" title="User callback class for character controller events.">PxUserControllerHitReport</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c8f9db4e34061ab9193886159e1d76f7"></a><!-- doxytag: member="PxControllerDesc::scaleCoeff" ref="c8f9db4e34061ab9193886159e1d76f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#c8f9db4e34061ab9193886159e1d76f7">PxControllerDesc::scaleCoeff</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Scale coefficient for underlying kinematic actor.
<p>
The CCT creates a PhysX's kinematic actor under the hood. This controls its scale factor. This should be a number a bit smaller than 1.0.<p>
<b>Default:</b> 0.8
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="adb1325a040c61b6cd29cfa94d24c180"></a><!-- doxytag: member="PxControllerDesc::slopeLimit" ref="adb1325a040c61b6cd29cfa94d24c180" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#adb1325a040c61b6cd29cfa94d24c180">PxControllerDesc::slopeLimit</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The maximum slope which the character can walk up.
<p>
In general it is desirable to limit where the character can walk, in particular it is unrealistic for the character to be able to climb arbitary slopes.<p>
The limit is expressed as the cosine of desired limit angle. A value of 0 disables this feature.<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>It is currently enabled for static actors only (not for dynamic/kinematic actors), and not supported for spheres or capsules.</dd></dl>
<b>Default:</b> 0.707<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxControllerDesc.html#f1a0990b26249f3114c41e20a9cb3087" title="Specifies the 'up' direction.">upDirection</a> <a class="el" href="classPxControllerDesc.html#c67b8bbd1150f4e9fb30e56e4a81a7e1" title="Height of invisible walls created around non-walkable triangles.">invisibleWallHeight</a> <a class="el" href="classPxControllerDesc.html#36e184a8b3c7a4ffbd1f2ab934d37ae1" title="Maximum height a jumping character can reach.">maxJumpHeight</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="51fe254a4807b832b2d34e884d856438"></a><!-- doxytag: member="PxControllerDesc::stepOffset" ref="51fe254a4807b832b2d34e884d856438" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#51fe254a4807b832b2d34e884d856438">PxControllerDesc::stepOffset</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Defines the maximum height of an obstacle which the character can climb.
<p>
A small value will mean that the character gets stuck and cannot walk up stairs etc, a value which is too large will mean that the character can climb over unrealistically high obstacles.<p>
<b>Default:</b> 0.5<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxControllerDesc.html#f1a0990b26249f3114c41e20a9cb3087" title="Specifies the 'up' direction.">upDirection</a> </dd></dl>
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>, <a class="el" href="PxCapsuleController_8h-source.html#l00152">PxCapsuleControllerDesc::isValid()</a>, <a class="el" href="PxBoxController_8h-source.html#l00138">PxBoxControllerDesc::isValid()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f1a0990b26249f3114c41e20a9cb3087"></a><!-- doxytag: member="PxControllerDesc::upDirection" ref="f1a0990b26249f3114c41e20a9cb3087" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="classPxControllerDesc.html#f1a0990b26249f3114c41e20a9cb3087">PxControllerDesc::upDirection</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specifies the 'up' direction.
<p>
In order to provide stepping functionality the SDK must be informed about the up direction.<p>
<b>Default:</b> (0, 1, 0)
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b1144ac32fd0a4173e8d3136ae3e604f"></a><!-- doxytag: member="PxControllerDesc::userData" ref="b1144ac32fd0a4173e8d3136ae3e604f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classPxControllerDesc.html#b1144ac32fd0a4173e8d3136ae3e604f">PxControllerDesc::userData</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
User specified data associated with the controller.
<p>
<b>Default:</b> NULL
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<a class="anchor" name="93930e888fcd4c2f7bafeac83621612e"></a><!-- doxytag: member="PxControllerDesc::volumeGrowth" ref="93930e888fcd4c2f7bafeac83621612e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxF32 <a class="el" href="classPxControllerDesc.html#93930e888fcd4c2f7bafeac83621612e">PxControllerDesc::volumeGrowth</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cached volume growth.
<p>
Amount of space around the controller we cache to improve performance. This is a scale factor that should be higher than 1.0f but not too big, ideally lower than 2.0f.<p>
<b>Default:</b> 1.5
<p>Referenced by <a class="el" href="PxController_8h-source.html#l00575">copy()</a>, <a class="el" href="PxController_8h-source.html#l00601">isValid()</a>, and <a class="el" href="PxController_8h-source.html#l00542">PxControllerDesc()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxController_8h-source.html">PxController.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>
|