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
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxMaterial 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>PxMaterial Class Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxMaterial" --><!-- doxytag: inherits="PxBase" -->Material class to represent a set of surface properties.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxMaterial_8h-source.html">PxMaterial.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxMaterial:</div>
<div class="dynsection">
<p><center><img src="classPxMaterial__inherit__graph.png" border="0" usemap="#PxMaterial__inherit__map" alt="Inheritance graph"></center>
<map name="PxMaterial__inherit__map">
<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="15,16,71,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxMaterial:</div>
<div class="dynsection">
<p><center><img src="classPxMaterial__coll__graph.png" border="0" usemap="#PxMaterial__coll__map" alt="Collaboration graph"></center>
<map name="PxMaterial__coll__map">
<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxMaterial-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#c0635989d3c9a12d55d25fe468e91256">release</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count of a material and releases it if the new reference count is zero. <a href="#c0635989d3c9a12d55d25fe468e91256"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#459b91a5b16327891dc7b9364c854888">getReferenceCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference count of the material. <a href="#459b91a5b16327891dc7b9364c854888"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#2d19a3388f5c3f023540661baa587de5">acquireReference</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquires a counted reference to a material. <a href="#2d19a3388f5c3f023540661baa587de5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#971a4c6a385310c28aaeaa1f5ead78e9">setDynamicFriction</a> (PxReal coef)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the coefficient of dynamic friction. <a href="#971a4c6a385310c28aaeaa1f5ead78e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#fc25f357ba1de24c8b98b22f94153d3d">getDynamicFriction</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the DynamicFriction value. <a href="#fc25f357ba1de24c8b98b22f94153d3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#0384706084d22fe2ec745bc81d54ef14">setStaticFriction</a> (PxReal coef)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the coefficient of static friction. <a href="#0384706084d22fe2ec745bc81d54ef14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#b80c2e686ea428c58dbd020e067eaa70">getStaticFriction</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the coefficient of static friction. <a href="#b80c2e686ea428c58dbd020e067eaa70"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1">setRestitution</a> (PxReal rest)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the coefficient of restitution. <a href="#9038f690c180b962a7543734f44ec0f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#06db9f154df542598da209a31fdc123f">getRestitution</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the coefficient of restitution. <a href="#06db9f154df542598da209a31fdc123f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#3dbcd175e805766442291c1285eafe8c">setFlag</a> (<a class="el" href="structPxMaterialFlag.html#0cbfebf648d620e4619a5a81b49cc298">PxMaterialFlag::Enum</a> flag, bool)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Raises or clears a particular material flag. <a href="#3dbcd175e805766442291c1285eafe8c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#452856bae712ad60a281ec45a4bd69a9">setFlags</a> (<a class="el" href="classPxFlags.html">PxMaterialFlags</a> inFlags)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets all the material flags. <a href="#452856bae712ad60a281ec45a4bd69a9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxMaterialFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#f8fca7a3079e8da26c8275a9fe3ce635">getFlags</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the flags. See <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a>. <a href="#f8fca7a3079e8da26c8275a9fe3ce635"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#15c32fcd28a63a02caad0247dd2e9835">setFrictionCombineMode</a> (<a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> combMode)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the friction combine mode. <a href="#15c32fcd28a63a02caad0247dd2e9835"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#0d97b1335e367b8f27f32f6c3766f5a8">getFrictionCombineMode</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the friction combine mode. <a href="#0d97b1335e367b8f27f32f6c3766f5a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#8f9930b0e18a932e428a061891e4683f">setRestitutionCombineMode</a> (<a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> combMode)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the restitution combine mode. <a href="#8f9930b0e18a932e428a061891e4683f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#a4f567c979252e84dc88cbd626dc8812">getRestitutionCombineMode</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the restitution combine mode. <a href="#a4f567c979252e84dc88cbd626dc8812"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#1a6bbe6443abf57f9b81104cae070e4c">getConcreteTypeName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#1a6bbe6443abf57f9b81104cae070e4c"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#462f7d7aa49aec69871bbf066632a5d4">userData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">user can assign this to whatever, usually to create a 1:1 relationship with a user object. <a href="#462f7d7aa49aec69871bbf066632a5d4"></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="classPxMaterial.html#9f402b870b0729455ba8199b46a0fccd">PxMaterial</a> (<a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#f307774d0f072ac743621419a5d7c1a7">PxMaterial</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#f304d5eda8ffb0d1afeada9a98186c0a">~PxMaterial</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxMaterial.html#51a36ceb87a3713a997e498b012e9ebd">isKindOf</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#51a36ceb87a3713a997e498b012e9ebd"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Material class to represent a set of surface properties.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#35c1965ae47b24e119c6a2d8ce25477e" title="Creates a new material with default properties.">PxPhysics.createMaterial</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9f402b870b0729455ba8199b46a0fccd"></a><!-- doxytag: member="PxMaterial::PxMaterial" ref="9f402b870b0729455ba8199b46a0fccd" args="(PxType concreteType, PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxMaterial::PxMaterial </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> </td>
<td class="paramname"> <em>concreteType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td>
<td class="paramname"> <em>baseFlags</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="f307774d0f072ac743621419a5d7c1a7"></a><!-- doxytag: member="PxMaterial::PxMaterial" ref="f307774d0f072ac743621419a5d7c1a7" args="(PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxMaterial::PxMaterial </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td>
<td class="paramname"> <em>baseFlags</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="f304d5eda8ffb0d1afeada9a98186c0a"></a><!-- doxytag: member="PxMaterial::~PxMaterial" ref="f304d5eda8ffb0d1afeada9a98186c0a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxMaterial::~PxMaterial </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2d19a3388f5c3f023540661baa587de5"></a><!-- doxytag: member="PxMaterial::acquireReference" ref="2d19a3388f5c3f023540661baa587de5" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::acquireReference </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Acquires a counted reference to a material.
<p>
This method increases the reference count of the material by 1. Decrement the reference count by calling <a class="el" href="classPxMaterial.html#c0635989d3c9a12d55d25fe468e91256" title="Decrements the reference count of a material and releases it if the new reference...">release()</a>
</div>
</div><p>
<a class="anchor" name="1a6bbe6443abf57f9b81104cae070e4c"></a><!-- doxytag: member="PxMaterial::getConcreteTypeName" ref="1a6bbe6443abf57f9b81104cae070e4c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* PxMaterial::getConcreteTypeName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns string name of dynamic type.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl>
<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="fc25f357ba1de24c8b98b22f94153d3d"></a><!-- doxytag: member="PxMaterial::getDynamicFriction" ref="fc25f357ba1de24c8b98b22f94153d3d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxMaterial::getDynamicFriction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the DynamicFriction value.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of dynamic friction.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#971a4c6a385310c28aaeaa1f5ead78e9" title="Sets the coefficient of dynamic friction.">setDynamicFriction</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f8fca7a3079e8da26c8275a9fe3ce635"></a><!-- doxytag: member="PxMaterial::getFlags" ref="f8fca7a3079e8da26c8275a9fe3ce635" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxFlags.html">PxMaterialFlags</a> PxMaterial::getFlags </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the flags. See <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The material flags.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a> <a class="el" href="classPxMaterial.html#452856bae712ad60a281ec45a4bd69a9" title="sets all the material flags.">setFlags()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="0d97b1335e367b8f27f32f6c3766f5a8"></a><!-- doxytag: member="PxMaterial::getFrictionCombineMode" ref="0d97b1335e367b8f27f32f6c3766f5a8" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> PxMaterial::getFrictionCombineMode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the friction combine mode.
<p>
See <a class="el" href="classPxMaterial.html#15c32fcd28a63a02caad0247dd2e9835" title="Sets the friction combine mode.">setFrictionCombineMode</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The friction combine mode for this material.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#15c32fcd28a63a02caad0247dd2e9835" title="Sets the friction combine mode.">setFrictionCombineMode()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="459b91a5b16327891dc7b9364c854888"></a><!-- doxytag: member="PxMaterial::getReferenceCount" ref="459b91a5b16327891dc7b9364c854888" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxMaterial::getReferenceCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the reference count of the material.
<p>
At creation, the reference count of the material is 1. Every shape referencing this material increments the count by 1. When the reference count reaches 0, and only then, the material gets destroyed automatically.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the current reference count. </dd></dl>
</div>
</div><p>
<a class="anchor" name="06db9f154df542598da209a31fdc123f"></a><!-- doxytag: member="PxMaterial::getRestitution" ref="06db9f154df542598da209a31fdc123f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxMaterial::getRestitution </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the coefficient of restitution.
<p>
See <a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1" title="Sets the coefficient of restitution.">setRestitution</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of restitution.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1" title="Sets the coefficient of restitution.">setRestitution()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="a4f567c979252e84dc88cbd626dc8812"></a><!-- doxytag: member="PxMaterial::getRestitutionCombineMode" ref="a4f567c979252e84dc88cbd626dc8812" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> PxMaterial::getRestitutionCombineMode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the restitution combine mode.
<p>
See <a class="el" href="classPxMaterial.html#8f9930b0e18a932e428a061891e4683f" title="Sets the restitution combine mode.">setRestitutionCombineMode</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of restitution combine mode for this material.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#8f9930b0e18a932e428a061891e4683f" title="Sets the restitution combine mode.">setRestitutionCombineMode</a> <a class="el" href="classPxMaterial.html#06db9f154df542598da209a31fdc123f" title="Retrieves the coefficient of restitution.">getRestitution()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b80c2e686ea428c58dbd020e067eaa70"></a><!-- doxytag: member="PxMaterial::getStaticFriction" ref="b80c2e686ea428c58dbd020e067eaa70" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxMaterial::getStaticFriction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the coefficient of static friction.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The coefficient of static friction.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#0384706084d22fe2ec745bc81d54ef14" title="Sets the coefficient of static friction.">setStaticFriction</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="51a36ceb87a3713a997e498b012e9ebd"></a><!-- doxytag: member="PxMaterial::isKindOf" ref="51a36ceb87a3713a997e498b012e9ebd" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxMaterial::isKindOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>superClass</em> </td>
<td> ) </td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether a given type name matches with the type of this instance.
<p>
<p>Reimplemented from <a class="el" href="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef">PxBase</a>.</p>
<p>References <a class="el" href="PxBase_8h-source.html#l00178">PxBase::isKindOf()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c0635989d3c9a12d55d25fe468e91256"></a><!-- doxytag: member="PxMaterial::release" ref="c0635989d3c9a12d55d25fe468e91256" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decrements the reference count of a material and releases it if the new reference count is zero.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#35c1965ae47b24e119c6a2d8ce25477e" title="Creates a new material with default properties.">PxPhysics.createMaterial()</a> </dd></dl>
<p>Implements <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="971a4c6a385310c28aaeaa1f5ead78e9"></a><!-- doxytag: member="PxMaterial::setDynamicFriction" ref="971a4c6a385310c28aaeaa1f5ead78e9" args="(PxReal coef)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::setDynamicFriction </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>coef</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the coefficient of dynamic friction.
<p>
The coefficient of dynamic friction should be in [0, PX_MAX_F32). If set to greater than staticFriction, the effective value of staticFriction will be increased to match.<p>
<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<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>coef</em> </td><td>Coefficient of dynamic friction. <b>Range:</b> [0, PX_MAX_F32)</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#fc25f357ba1de24c8b98b22f94153d3d" title="Retrieves the DynamicFriction value.">getDynamicFriction()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="3dbcd175e805766442291c1285eafe8c"></a><!-- doxytag: member="PxMaterial::setFlag" ref="3dbcd175e805766442291c1285eafe8c" args="(PxMaterialFlag::Enum flag, bool)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::setFlag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPxMaterialFlag.html#0cbfebf648d620e4619a5a81b49cc298">PxMaterialFlag::Enum</a> </td>
<td class="paramname"> <em>flag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Raises or clears a particular material flag.
<p>
See the list of flags <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a><p>
<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<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>flag</em> </td><td>The <a class="el" href="classPxMaterial.html" title="Material class to represent a set of surface properties.">PxMaterial</a> flag to raise(set) or clear.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#f8fca7a3079e8da26c8275a9fe3ce635" title="Retrieves the flags. See PxMaterialFlag.">getFlags()</a> <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="452856bae712ad60a281ec45a4bd69a9"></a><!-- doxytag: member="PxMaterial::setFlags" ref="452856bae712ad60a281ec45a4bd69a9" args="(PxMaterialFlags inFlags)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::setFlags </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxFlags.html">PxMaterialFlags</a> </td>
<td class="paramname"> <em>inFlags</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets all the material flags.
<p>
See the list of flags <a class="el" href="structPxMaterialFlag.html" title="Flags which control the behavior of a material.">PxMaterialFlag</a><p>
<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.
</div>
</div><p>
<a class="anchor" name="15c32fcd28a63a02caad0247dd2e9835"></a><!-- doxytag: member="PxMaterial::setFrictionCombineMode" ref="15c32fcd28a63a02caad0247dd2e9835" args="(PxCombineMode::Enum combMode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::setFrictionCombineMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td>
<td class="paramname"> <em>combMode</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the friction combine mode.
<p>
See the enum <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> .<p>
<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<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>combMode</em> </td><td>Friction combine mode to set for this material. See <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a>.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#0d97b1335e367b8f27f32f6c3766f5a8" title="Retrieves the friction combine mode.">getFrictionCombineMode</a> <a class="el" href="classPxMaterial.html#0384706084d22fe2ec745bc81d54ef14" title="Sets the coefficient of static friction.">setStaticFriction()</a> <a class="el" href="classPxMaterial.html#971a4c6a385310c28aaeaa1f5ead78e9" title="Sets the coefficient of dynamic friction.">setDynamicFriction()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9038f690c180b962a7543734f44ec0f1"></a><!-- doxytag: member="PxMaterial::setRestitution" ref="9038f690c180b962a7543734f44ec0f1" args="(PxReal rest)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::setRestitution </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>rest</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the coefficient of restitution.
<p>
A coefficient of 0 makes the object bounce as little as possible, higher values up to 1.0 result in more bounce.<p>
<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<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>rest</em> </td><td>Coefficient of restitution. <b>Range:</b> [0,1]</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#06db9f154df542598da209a31fdc123f" title="Retrieves the coefficient of restitution.">getRestitution()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8f9930b0e18a932e428a061891e4683f"></a><!-- doxytag: member="PxMaterial::setRestitutionCombineMode" ref="8f9930b0e18a932e428a061891e4683f" args="(PxCombineMode::Enum combMode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::setRestitutionCombineMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPxCombineMode.html#7d586f7800efb63ee14c7a24e0eb6727">PxCombineMode::Enum</a> </td>
<td class="paramname"> <em>combMode</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the restitution combine mode.
<p>
See the enum <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> .<p>
<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<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>combMode</em> </td><td>Restitution combine mode for this material. See <a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a>.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxCombineMode.html" title="enumeration that determines the way in which two material properties will be combined...">PxCombineMode</a> <a class="el" href="classPxMaterial.html#a4f567c979252e84dc88cbd626dc8812" title="Retrieves the restitution combine mode.">getRestitutionCombineMode()</a> <a class="el" href="classPxMaterial.html#9038f690c180b962a7543734f44ec0f1" title="Sets the coefficient of restitution.">setRestitution()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="0384706084d22fe2ec745bc81d54ef14"></a><!-- doxytag: member="PxMaterial::setStaticFriction" ref="0384706084d22fe2ec745bc81d54ef14" args="(PxReal coef)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxMaterial::setStaticFriction </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>coef</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the coefficient of static friction.
<p>
The coefficient of static friction should be in the range [0, PX_MAX_F32)<p>
<b>Sleeping:</b> Does <b>NOT</b> wake any actors which may be affected.<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>coef</em> </td><td>Coefficient of static friction. <b>Range:</b> [0, PX_MAX_F32)</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxMaterial.html#b80c2e686ea428c58dbd020e067eaa70" title="Retrieves the coefficient of static friction.">getStaticFriction()</a> </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="462f7d7aa49aec69871bbf066632a5d4"></a><!-- doxytag: member="PxMaterial::userData" ref="462f7d7aa49aec69871bbf066632a5d4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classPxMaterial.html#462f7d7aa49aec69871bbf066632a5d4">PxMaterial::userData</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
user can assign this to whatever, usually to create a 1:1 relationship with a user object.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxMaterial_8h-source.html">PxMaterial.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>
|