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
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxArticulation 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>PxArticulation Class Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxArticulation" --><!-- doxytag: inherits="PxBase" -->a tree structure of bodies connected by joints that is treated as a unit by the dynamics solver
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxArticulation_8h-source.html">PxArticulation.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxArticulation:</div>
<div class="dynsection">
<p><center><img src="classPxArticulation__inherit__graph.png" border="0" usemap="#PxArticulation__inherit__map" alt="Inheritance graph"></center>
<map name="PxArticulation__inherit__map">
<area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="21,16,77,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxArticulation:</div>
<div class="dynsection">
<p><center><img src="classPxArticulation__coll__graph.png" border="0" usemap="#PxArticulation__coll__map" alt="Collaboration graph"></center>
<map name="PxArticulation__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="classPxArticulation-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="classPxArticulation.html#05473039f1bd3bb20f824be6ae5aa435">release</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes the articulation. <a href="#05473039f1bd3bb20f824be6ae5aa435"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxScene.html">PxScene</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxArticulation.html#fd299e63283d38910c48243e6d9755dd">getScene</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the scene which this articulation belongs to. <a href="#fd299e63283d38910c48243e6d9755dd"></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="classPxArticulation.html#4154ccfb1afad6e3b8145a67e7f580bd">setMaxProjectionIterations</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> iterations)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets maxProjectionIterations. <a href="#4154ccfb1afad6e3b8145a67e7f580bd"></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="classPxArticulation.html#f3685ff6164f06bec07499a0d1b0336a">getMaxProjectionIterations</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">gets maxProjectionIterations. <a href="#f3685ff6164f06bec07499a0d1b0336a"></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="classPxArticulation.html#284072a943c7e9caa992c513e0855aaf">setSeparationTolerance</a> (PxReal tolerance)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets separationTolerance. <a href="#284072a943c7e9caa992c513e0855aaf"></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="classPxArticulation.html#cacffbf3e5e6e2e02e8b0929e9b73cf6">getSeparationTolerance</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">gets separationTolerance. <a href="#cacffbf3e5e6e2e02e8b0929e9b73cf6"></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="classPxArticulation.html#cda14790e09cb759007038d35885065a">setInternalDriveIterations</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> iterations)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the number of iterations used to compute the drive response to internal forces <a href="#cda14790e09cb759007038d35885065a"></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="classPxArticulation.html#6d02a86ad795aaed3e1a2dc6a3d49762">getInternalDriveIterations</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">gets internal driveIterations. <a href="#6d02a86ad795aaed3e1a2dc6a3d49762"></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="classPxArticulation.html#767fb3ec58b891bcd8dd0d769a5789cf">setExternalDriveIterations</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> iterations)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the number of iterations for drive response to external forces. <a href="#767fb3ec58b891bcd8dd0d769a5789cf"></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="classPxArticulation.html#563b2f0279522377f86d7947d790e31f">getExternalDriveIterations</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">gets externalDriveIterations. <a href="#563b2f0279522377f86d7947d790e31f"></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="classPxArticulation.html#f31eb23f85c5a8516612cad455d4fef3">setSolverIterationCounts</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> minPositionIters, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> minVelocityIters=1)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the solver iteration counts for the articulation. <a href="#f31eb23f85c5a8516612cad455d4fef3"></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="classPxArticulation.html#895c71778bd0ec8905719f507e0a966f">getSolverIterationCounts</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> &minPositionIters, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> &minVelocityIters) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the solver iteration counts. <a href="#895c71778bd0ec8905719f507e0a966f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df">isSleeping</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this articulation is sleeping. <a href="#2ab9a560f94ce01b499fedff8f54a9df"></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="classPxArticulation.html#e7e4735b8c23aaf5f41d829208cccce6">setSleepThreshold</a> (PxReal threshold)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the mass-normalized energy threshold below which an articulation may go to sleep. <a href="#e7e4735b8c23aaf5f41d829208cccce6"></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="classPxArticulation.html#9e7f831e514e0de1c15812f62c0ab20b">getSleepThreshold</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mass-normalized energy below which an articulation may go to sleep. <a href="#9e7f831e514e0de1c15812f62c0ab20b"></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="classPxArticulation.html#259748392f6223dc218d1e1ba8ee9944">setStabilizationThreshold</a> (PxReal threshold)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the mass-normalized kinetic energy threshold below which an articulation may participate in stabilization. <a href="#259748392f6223dc218d1e1ba8ee9944"></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="classPxArticulation.html#a7fd4f3e2ea751de54885d62510289cd">getStabilizationThreshold</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mass-normalized kinetic energy below which an articulation may participate in stabilization. <a href="#a7fd4f3e2ea751de54885d62510289cd"></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="classPxArticulation.html#aef04ee0fba882eb8212f6baa5dde0b2">setWakeCounter</a> (PxReal wakeCounterValue)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the wake counter for the articulation. <a href="#aef04ee0fba882eb8212f6baa5dde0b2"></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="classPxArticulation.html#9e7c111d4f17746b2b6686a2f5393e7e">getWakeCounter</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the wake counter of the articulation. <a href="#9e7c111d4f17746b2b6686a2f5393e7e"></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="classPxArticulation.html#596fb9e8f1d136d571965583bc5d0d1b">wakeUp</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wakes up the articulation if it is sleeping. <a href="#596fb9e8f1d136d571965583bc5d0d1b"></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="classPxArticulation.html#b7da60ba6a4a5b7068115dc79a545b73">putToSleep</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Forces the articulation to sleep. <a href="#b7da60ba6a4a5b7068115dc79a545b73"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxArticulation.html#5e2777634f2b482e7366fb7649834c37">createLink</a> (<a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> *parent, const <a class="el" href="classPxTransform.html">PxTransform</a> &pose)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">adds a link to the articulation with default attribute values. <a href="#5e2777634f2b482e7366fb7649834c37"></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="classPxArticulation.html#c5de09243fe7491e92bf7720cba35782">getNbLinks</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the number of links in the articulation <a href="#c5de09243fe7491e92bf7720cba35782"></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="classPxArticulation.html#62e84e4ee52202ec0812f0258541e777">getLinks</a> (<a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> **userBuffer, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> bufferSize, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> startIndex=0) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the set of links in the articulation <a href="#62e84e4ee52202ec0812f0258541e777"></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="classPxArticulation.html#1efa57c3102cb6258ee90ac70a3c2657">setName</a> (const char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a name string for the object that can be retrieved with <a class="el" href="classPxArticulation.html#e10c600444771ea7e29d531b84f3c734" title="Retrieves the name string set with setName().">getName()</a>. <a href="#1efa57c3102cb6258ee90ac70a3c2657"></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="classPxArticulation.html#e10c600444771ea7e29d531b84f3c734">getName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name string set with <a class="el" href="classPxArticulation.html#1efa57c3102cb6258ee90ac70a3c2657" title="Sets a name string for the object that can be retrieved with getName().">setName()</a>. <a href="#e10c600444771ea7e29d531b84f3c734"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxBounds3.html">PxBounds3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxArticulation.html#96d818fec86bc80cbcae2097cfc5cf1b">getWorldBounds</a> (float inflation=1.01f) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the axis aligned bounding box enclosing the articulation. <a href="#96d818fec86bc80cbcae2097cfc5cf1b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxAggregate.html">PxAggregate</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxArticulation.html#b8c30bf0858be5f35f5e18c10e19ea85">getAggregate</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the aggregate the articulation might be a part of. <a href="#b8c30bf0858be5f35f5e18c10e19ea85"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxArticulation.html#795fd4cd7bb40e05c9e9bfd6f0d73a70">createDriveCache</a> (PxReal compliance, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> driveIterations) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a drive cache for applying impulses which are propagated to the entire articulation <a href="#795fd4cd7bb40e05c9e9bfd6f0d73a70"></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="classPxArticulation.html#65811cf8f73da01a8cea28d2dfebe290">updateDriveCache</a> (<a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> &driveCache, PxReal compliance, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> driveIterations) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update a drive cache <a href="#65811cf8f73da01a8cea28d2dfebe290"></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="classPxArticulation.html#da8e885a5ea020e2b41be20d6c202f26">releaseDriveCache</a> (<a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> &driveCache) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">release a drive cache <a href="#da8e885a5ea020e2b41be20d6c202f26"></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="classPxArticulation.html#29fd49597cee46481679988e3ace38a5">applyImpulse</a> (<a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> *link, const <a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> &driveCache, const <a class="el" href="classPxVec3.html">PxVec3</a> &linearImpulse, const <a class="el" href="classPxVec3.html">PxVec3</a> &angularImpulse)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">apply an impulse to an entire articulation <a href="#29fd49597cee46481679988e3ace38a5"></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="classPxArticulation.html#bfe3887e17be7b04d71a7d21c96c181d">computeImpulseResponse</a> (<a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> *link, <a class="el" href="classPxVec3.html">PxVec3</a> &linearResponse, <a class="el" href="classPxVec3.html">PxVec3</a> &angularResponse, const <a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> &driveCache, const <a class="el" href="classPxVec3.html">PxVec3</a> &linearImpulse, const <a class="el" href="classPxVec3.html">PxVec3</a> &angularImpulse) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">determine the effect of applying an impulse to an entire articulation, without applying the impulse <a href="#bfe3887e17be7b04d71a7d21c96c181d"></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="classPxArticulation.html#7cbe2a99ed02a02156011a69d4830355">getConcreteTypeName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#7cbe2a99ed02a02156011a69d4830355"></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="classPxArticulation.html#d292404f71931e4e465bfe7581c2aa1e">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="#d292404f71931e4e465bfe7581c2aa1e"></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="classPxArticulation.html#34e5bd7f69fc0de6c32a9bdd86ad42cc">PxArticulation</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="classPxArticulation.html#c4581a1b3e03a2fa156dc12a18929361">PxArticulation</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="classPxArticulation.html#30d90e77b54c18880636629aea545ac3">~PxArticulation</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxArticulation.html#ebd44e6ecdffe21d718935245277e55a">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="#ebd44e6ecdffe21d718935245277e55a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
a tree structure of bodies connected by joints that is treated as a unit by the dynamics solver
<p>
Articulations are more expensive to simulate than the equivalent collection of <a class="el" href="classPxRigidDynamic.html" title="PxRigidDynamic represents a dynamic rigid simulation object in the physics SDK.">PxRigidDynamic</a> and <a class="el" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints">PxJoint</a> structures, but because the dynamics solver treats each articulation as a single object, they are much less prone to separation and have better support for actuation. An articulation may have at most 64 links.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulationJoint.html" title="a joint between two links in an articulation.">PxArticulationJoint</a> <a class="el" href="classPxArticulationLink.html" title="a component of an articulation that represents a rigid body">PxArticulationLink</a> <a class="el" href="classPxPhysics.html#a65bf245c40886f007b7cda86dee9f3f" title="Creates an articulation with all fields initialized to their default values.">PxPhysics.createArticulation</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="34e5bd7f69fc0de6c32a9bdd86ad42cc"></a><!-- doxytag: member="PxArticulation::PxArticulation" ref="34e5bd7f69fc0de6c32a9bdd86ad42cc" args="(PxType concreteType, PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxArticulation::PxArticulation </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="c4581a1b3e03a2fa156dc12a18929361"></a><!-- doxytag: member="PxArticulation::PxArticulation" ref="c4581a1b3e03a2fa156dc12a18929361" args="(PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxArticulation::PxArticulation </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="30d90e77b54c18880636629aea545ac3"></a><!-- doxytag: member="PxArticulation::~PxArticulation" ref="30d90e77b54c18880636629aea545ac3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxArticulation::~PxArticulation </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="29fd49597cee46481679988e3ace38a5"></a><!-- doxytag: member="PxArticulation::applyImpulse" ref="29fd49597cee46481679988e3ace38a5" args="(PxArticulationLink *link, const PxArticulationDriveCache &driveCache, const PxVec3 &linearImpulse, const PxVec3 &angularImpulse)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::applyImpulse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> * </td>
<td class="paramname"> <em>link</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> & </td>
<td class="paramname"> <em>driveCache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td>
<td class="paramname"> <em>linearImpulse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td>
<td class="paramname"> <em>angularImpulse</em></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>
apply an impulse to an entire articulation
<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>link</em> </td><td>the link to which to apply the impulse </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveCache</em> </td><td>the drive cache </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>linearImpulse</em> </td><td>the linear impulse to apply </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>angularImpulse</em> </td><td>the angular impulse to apply</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#bfe3887e17be7b04d71a7d21c96c181d" title="determine the effect of applying an impulse to an entire articulation, without applying...">computeImpulseResponse</a></dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>this call may only be made on articulations that are in a scene, and may not be made during simulation </dd></dl>
</div>
</div><p>
<a class="anchor" name="bfe3887e17be7b04d71a7d21c96c181d"></a><!-- doxytag: member="PxArticulation::computeImpulseResponse" ref="bfe3887e17be7b04d71a7d21c96c181d" args="(PxArticulationLink *link, PxVec3 &linearResponse, PxVec3 &angularResponse, const PxArticulationDriveCache &driveCache, const PxVec3 &linearImpulse, const PxVec3 &angularImpulse) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::computeImpulseResponse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> * </td>
<td class="paramname"> <em>link</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a> & </td>
<td class="paramname"> <em>linearResponse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a> & </td>
<td class="paramname"> <em>angularResponse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> & </td>
<td class="paramname"> <em>driveCache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td>
<td class="paramname"> <em>linearImpulse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td>
<td class="paramname"> <em>angularImpulse</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
determine the effect of applying an impulse to an entire articulation, without applying the impulse
<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>link</em> </td><td>the link to which to apply the impulse </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>linearResponse</em> </td><td>the change in linear velocity of the articulation link </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>angularResponse</em> </td><td>the change in angular velocity of the articulation link </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveCache</em> </td><td>the drive cache </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>linearImpulse</em> </td><td>the linear impulse to apply </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>angularImpulse</em> </td><td>the angular impulse to apply</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#29fd49597cee46481679988e3ace38a5" title="apply an impulse to an entire articulation">applyImpulse</a></dd></dl>
This call will wake up the articulation if it is asleep.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>this call may only be made on articulations that are in a scene, and may not be made during simulation </dd></dl>
</div>
</div><p>
<a class="anchor" name="795fd4cd7bb40e05c9e9bfd6f0d73a70"></a><!-- doxytag: member="PxArticulation::createDriveCache" ref="795fd4cd7bb40e05c9e9bfd6f0d73a70" args="(PxReal compliance, PxU32 driveIterations) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a>* PxArticulation::createDriveCache </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>compliance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>driveIterations</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a drive cache for applying impulses which are propagated to the entire articulation
<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>compliance</em> </td><td>the compliance value to use at all joints of the articulation. This is equivalent to the external compliance parameter for articulation joints, as the impulse is treated as an external force </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveIterations</em> </td><td>the number of iterations to use to evaluate the drive strengths</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a drive cache</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulationDriveCache.html" title="Articulation drive cache.">PxArticulationDriveCache</a> <a class="el" href="classPxArticulation.html#65811cf8f73da01a8cea28d2dfebe290" title="update a drive cache">updateDriveCache</a> <a class="el" href="classPxArticulation.html#da8e885a5ea020e2b41be20d6c202f26" title="release a drive cache">releaseDriveCache</a> <a class="el" href="classPxArticulation.html#29fd49597cee46481679988e3ace38a5" title="apply an impulse to an entire articulation">applyImpulse</a> <a class="el" href="classPxArticulation.html#bfe3887e17be7b04d71a7d21c96c181d" title="determine the effect of applying an impulse to an entire articulation, without applying...">computeImpulseResponse</a></dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>this call may only be made on articulations that are in a scene, and may not be made during simulation </dd></dl>
</div>
</div><p>
<a class="anchor" name="5e2777634f2b482e7366fb7649834c37"></a><!-- doxytag: member="PxArticulation::createLink" ref="5e2777634f2b482e7366fb7649834c37" args="(PxArticulationLink *parent, const PxTransform &pose)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxArticulationLink.html">PxArticulationLink</a>* PxArticulation::createLink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> * </td>
<td class="paramname"> <em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> & </td>
<td class="paramname"> <em>pose</em></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>
adds a link to the articulation with default attribute values.
<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>parent</em> </td><td>the parent link of the articulation. Should be NULL if (and only if) this is the root link </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pose</em> </td><td>the initial pose of the new link. Must be a valid transform</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the new link, or NULL if the link cannot be created because the articulation has reached its maximum link count (currently 64).</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulationLink.html" title="a component of an articulation that represents a rigid body">PxArticulationLink</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b8c30bf0858be5f35f5e18c10e19ea85"></a><!-- doxytag: member="PxArticulation::getAggregate" ref="b8c30bf0858be5f35f5e18c10e19ea85" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxAggregate.html">PxAggregate</a>* PxArticulation::getAggregate </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 aggregate the articulation might be a part of.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The aggregate the articulation is a part of, or NULL if the articulation does not belong to an aggregate.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxAggregate.html" title="Class to aggregate actors into a single broad-phase entry.">PxAggregate</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="7cbe2a99ed02a02156011a69d4830355"></a><!-- doxytag: member="PxArticulation::getConcreteTypeName" ref="7cbe2a99ed02a02156011a69d4830355" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* PxArticulation::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="563b2f0279522377f86d7947d790e31f"></a><!-- doxytag: member="PxArticulation::getExternalDriveIterations" ref="563b2f0279522377f86d7947d790e31f" 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> PxArticulation::getExternalDriveIterations </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
gets externalDriveIterations.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of iterations used to compute the drive response to external forces</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#767fb3ec58b891bcd8dd0d769a5789cf" title="sets the number of iterations for drive response to external forces.">setExternalDriveIterations()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="6d02a86ad795aaed3e1a2dc6a3d49762"></a><!-- doxytag: member="PxArticulation::getInternalDriveIterations" ref="6d02a86ad795aaed3e1a2dc6a3d49762" 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> PxArticulation::getInternalDriveIterations </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
gets internal driveIterations.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of iterations used to compute the drive response to internal forces</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#cda14790e09cb759007038d35885065a" title="sets the number of iterations used to compute the drive response to internal forces...">setInternalDriveIterations()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="62e84e4ee52202ec0812f0258541e777"></a><!-- doxytag: member="PxArticulation::getLinks" ref="62e84e4ee52202ec0812f0258541e777" args="(PxArticulationLink **userBuffer, PxU32 bufferSize, PxU32 startIndex=0) 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> PxArticulation::getLinks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxArticulationLink.html">PxArticulationLink</a> ** </td>
<td class="paramname"> <em>userBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>bufferSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>startIndex</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the set of links in the articulation
<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>userBuffer</em> </td><td>buffer into which to write an array of articulation link pointers </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>bufferSize</em> </td><td>the size of the buffer. If this is not large enough to contain all the pointers to links, only as many as will fit are written. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>startIndex</em> </td><td>Index of first link pointer to be retrieved</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of links written into the buffer.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>ArticulationLink </dd></dl>
</div>
</div><p>
<a class="anchor" name="f3685ff6164f06bec07499a0d1b0336a"></a><!-- doxytag: member="PxArticulation::getMaxProjectionIterations" ref="f3685ff6164f06bec07499a0d1b0336a" 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> PxArticulation::getMaxProjectionIterations </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
gets maxProjectionIterations.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the maximum number of projection iterations</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#4154ccfb1afad6e3b8145a67e7f580bd" title="sets maxProjectionIterations.">setMaxProjectionIterations()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="e10c600444771ea7e29d531b84f3c734"></a><!-- doxytag: member="PxArticulation::getName" ref="e10c600444771ea7e29d531b84f3c734" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* PxArticulation::getName </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 name string set with <a class="el" href="classPxArticulation.html#1efa57c3102cb6258ee90ac70a3c2657" title="Sets a name string for the object that can be retrieved with getName().">setName()</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Name string associated with object.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#1efa57c3102cb6258ee90ac70a3c2657" title="Sets a name string for the object that can be retrieved with getName().">setName()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="c5de09243fe7491e92bf7720cba35782"></a><!-- doxytag: member="PxArticulation::getNbLinks" ref="c5de09243fe7491e92bf7720cba35782" 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> PxArticulation::getNbLinks </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 number of links in the articulation
<p>
</div>
</div><p>
<a class="anchor" name="fd299e63283d38910c48243e6d9755dd"></a><!-- doxytag: member="PxArticulation::getScene" ref="fd299e63283d38910c48243e6d9755dd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxScene.html">PxScene</a>* PxArticulation::getScene </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 scene which this articulation belongs to.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Owner Scene. NULL if not part of a scene.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="cacffbf3e5e6e2e02e8b0929e9b73cf6"></a><!-- doxytag: member="PxArticulation::getSeparationTolerance" ref="cacffbf3e5e6e2e02e8b0929e9b73cf6" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxArticulation::getSeparationTolerance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
gets separationTolerance.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the separation tolerance</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#284072a943c7e9caa992c513e0855aaf" title="sets separationTolerance.">setSeparationTolerance()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9e7f831e514e0de1c15812f62c0ab20b"></a><!-- doxytag: member="PxArticulation::getSleepThreshold" ref="9e7f831e514e0de1c15812f62c0ab20b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxArticulation::getSleepThreshold </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 mass-normalized energy below which an articulation may go to sleep.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The energy threshold for sleeping.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df" title="Returns true if this articulation is sleeping.">isSleeping()</a> <a class="el" href="classPxArticulation.html#596fb9e8f1d136d571965583bc5d0d1b" title="Wakes up the articulation if it is sleeping.">wakeUp()</a> <a class="el" href="classPxArticulation.html#b7da60ba6a4a5b7068115dc79a545b73" title="Forces the articulation to sleep.">putToSleep()</a> <a class="el" href="classPxArticulation.html#e7e4735b8c23aaf5f41d829208cccce6" title="Sets the mass-normalized energy threshold below which an articulation may go to sleep...">setSleepThreshold()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="895c71778bd0ec8905719f507e0a966f"></a><!-- doxytag: member="PxArticulation::getSolverIterationCounts" ref="895c71778bd0ec8905719f507e0a966f" args="(PxU32 &minPositionIters, PxU32 &minVelocityIters) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::getSolverIterationCounts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> & </td>
<td class="paramname"> <em>minPositionIters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> & </td>
<td class="paramname"> <em>minVelocityIters</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the solver iteration counts.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#f31eb23f85c5a8516612cad455d4fef3" title="Sets the solver iteration counts for the articulation.">setSolverIterationCounts()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="a7fd4f3e2ea751de54885d62510289cd"></a><!-- doxytag: member="PxArticulation::getStabilizationThreshold" ref="a7fd4f3e2ea751de54885d62510289cd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxArticulation::getStabilizationThreshold </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 mass-normalized kinetic energy below which an articulation may participate in stabilization.
<p>
Articulations whose kinetic energy divided by their mass is above this threshold will not participate in stabilization.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The energy threshold for participating in stabilization.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#259748392f6223dc218d1e1ba8ee9944" title="Sets the mass-normalized kinetic energy threshold below which an articulation may...">setStabilizationThreshold()</a> <a class="el" href="structPxSceneFlag.html#b4c347372b4433d34d983da780916c53909e1cb63ea9c0394e2c2b3a526f47fe" title="Enables additional stabilization pass in solver.">PxSceneFlag::eENABLE_STABILIZATION</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9e7c111d4f17746b2b6686a2f5393e7e"></a><!-- doxytag: member="PxArticulation::getWakeCounter" ref="9e7c111d4f17746b2b6686a2f5393e7e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxReal PxArticulation::getWakeCounter </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 wake counter of the articulation.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The wake counter of the articulation.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df" title="Returns true if this articulation is sleeping.">isSleeping()</a> <a class="el" href="classPxArticulation.html#aef04ee0fba882eb8212f6baa5dde0b2" title="Sets the wake counter for the articulation.">setWakeCounter()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="96d818fec86bc80cbcae2097cfc5cf1b"></a><!-- doxytag: member="PxArticulation::getWorldBounds" ref="96d818fec86bc80cbcae2097cfc5cf1b" args="(float inflation=1.01f) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPxBounds3.html">PxBounds3</a> PxArticulation::getWorldBounds </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>inflation</em> = <code>1.01f</code> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the axis aligned bounding box enclosing the articulation.
<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>inflation</em> </td><td>Scale factor for computed world bounds. Box extents are multiplied by this value.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The articulation's bounding box.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box.">PxBounds3</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ebd44e6ecdffe21d718935245277e55a"></a><!-- doxytag: member="PxArticulation::isKindOf" ref="ebd44e6ecdffe21d718935245277e55a" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxArticulation::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="2ab9a560f94ce01b499fedff8f54a9df"></a><!-- doxytag: member="PxArticulation::isSleeping" ref="2ab9a560f94ce01b499fedff8f54a9df" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxArticulation::isSleeping </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if this articulation is sleeping.
<p>
When an actor does not move for a period of time, it is no longer simulated in order to save time. This state is called sleeping. However, because the object automatically wakes up when it is either touched by an awake object, or a sleep-affecting property is changed by the user, the entire sleep mechanism should be transparent to the user.<p>
An articulation can only go to sleep if all links are ready for sleeping. An articulation is guaranteed to be awake if at least one of the following holds:<p>
<ul>
<li>The wake counter is positive (see <a class="el" href="classPxArticulation.html#aef04ee0fba882eb8212f6baa5dde0b2" title="Sets the wake counter for the articulation.">setWakeCounter()</a>). </li>
<li>The linear or angular velocity of any link is non-zero. </li>
<li>A non-zero force or torque has been applied to the articulation or any of its links.</li>
</ul>
If an articulation is sleeping, the following state is guaranteed:<p>
<ul>
<li>The wake counter is zero. </li>
<li>The linear and angular velocity of all links is zero. </li>
<li>There is no force update pending.</li>
</ul>
When an articulation gets inserted into a scene, it will be considered asleep if all the points above hold, else it will be treated as awake.<p>
If an articulation is asleep after the call to <a class="el" href="classPxScene.html#b34e054ccf428a1cdbd81bf1e2b87fae">PxScene::fetchResults()</a> returns, it is guaranteed that the poses of the links were not changed. You can use this information to avoid updating the transforms of associated of dependent objects.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>It is invalid to use this method if the articulation has not been added to a scene already.</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the articulation is sleeping.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df" title="Returns true if this articulation is sleeping.">isSleeping()</a> <a class="el" href="classPxArticulation.html#596fb9e8f1d136d571965583bc5d0d1b" title="Wakes up the articulation if it is sleeping.">wakeUp()</a> <a class="el" href="classPxArticulation.html#b7da60ba6a4a5b7068115dc79a545b73" title="Forces the articulation to sleep.">putToSleep()</a> <a class="el" href="classPxArticulation.html#9e7f831e514e0de1c15812f62c0ab20b" title="Returns the mass-normalized energy below which an articulation may go to sleep.">getSleepThreshold()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b7da60ba6a4a5b7068115dc79a545b73"></a><!-- doxytag: member="PxArticulation::putToSleep" ref="b7da60ba6a4a5b7068115dc79a545b73" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::putToSleep </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Forces the articulation to sleep.
<p>
The articulation will stay asleep during the next simulation step if not touched by another non-sleeping actor.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This will set any applied force, the velocity and the wake counter of all bodies in the articulation to zero.<p>
It is invalid to use this method if the articulation has not been added to a scene already.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df" title="Returns true if this articulation is sleeping.">isSleeping()</a> <a class="el" href="classPxArticulation.html#596fb9e8f1d136d571965583bc5d0d1b" title="Wakes up the articulation if it is sleeping.">wakeUp()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="05473039f1bd3bb20f824be6ae5aa435"></a><!-- doxytag: member="PxArticulation::release" ref="05473039f1bd3bb20f824be6ae5aa435" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::release </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deletes the articulation.
<p>
Do not keep a reference to the deleted instance.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxPhysics.html#a65bf245c40886f007b7cda86dee9f3f" title="Creates an articulation with all fields initialized to their default values.">PxPhysics.createArticulation()</a> </dd></dl>
<p>Implements <a class="el" href="classPxBase.html#fe6aedda1df0d6d29b1a28213a5ee25a">PxBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="da8e885a5ea020e2b41be20d6c202f26"></a><!-- doxytag: member="PxArticulation::releaseDriveCache" ref="da8e885a5ea020e2b41be20d6c202f26" args="(PxArticulationDriveCache &driveCache) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::releaseDriveCache </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> & </td>
<td class="paramname"> <em>driveCache</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
release a drive cache
<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>driveCache</em> </td><td>the drive cache to release</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#795fd4cd7bb40e05c9e9bfd6f0d73a70" title="create a drive cache for applying impulses which are propagated to the entire articulation...">createDriveCache</a> <a class="el" href="classPxArticulation.html#65811cf8f73da01a8cea28d2dfebe290" title="update a drive cache">updateDriveCache</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="767fb3ec58b891bcd8dd0d769a5789cf"></a><!-- doxytag: member="PxArticulation::setExternalDriveIterations" ref="767fb3ec58b891bcd8dd0d769a5789cf" args="(PxU32 iterations)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setExternalDriveIterations </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>iterations</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets the number of iterations for drive response to external forces.
<p>
The drive model uses an iterative algorithm to determine the load on each joint of the articulation. This is the number of iterations to use when computing response of the drive to external forces.<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>iterations</em> </td><td>the number of iterations used to compute the drive response to external forces.</td></tr>
</table>
</dl>
<b>Default:</b> 4<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#563b2f0279522377f86d7947d790e31f" title="gets externalDriveIterations.">getExternalDriveIterations()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="cda14790e09cb759007038d35885065a"></a><!-- doxytag: member="PxArticulation::setInternalDriveIterations" ref="cda14790e09cb759007038d35885065a" args="(PxU32 iterations)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setInternalDriveIterations </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>iterations</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets the number of iterations used to compute the drive response to internal forces
<p>
The drive model uses an iterative algorithm to determine the load on each joint of the articulation. This is the number of iterations to use when computing response of the drive to internal forces.<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>iterations</em> </td><td>the number of iterations used to compute the drive response to internal forces.</td></tr>
</table>
</dl>
<b>Default:</b> 4<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#6d02a86ad795aaed3e1a2dc6a3d49762" title="gets internal driveIterations.">getInternalDriveIterations()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="4154ccfb1afad6e3b8145a67e7f580bd"></a><!-- doxytag: member="PxArticulation::setMaxProjectionIterations" ref="4154ccfb1afad6e3b8145a67e7f580bd" args="(PxU32 iterations)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setMaxProjectionIterations </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>iterations</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets maxProjectionIterations.
<p>
This is the maximum number of iterations to run projection on the articulation to bring the links back together if the separation tolerance is exceeded.<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>iterations</em> </td><td>the maximum number of projection iterations <b>Default:</b> 4</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#f3685ff6164f06bec07499a0d1b0336a" title="gets maxProjectionIterations.">getMaxProjectionIterations()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1efa57c3102cb6258ee90ac70a3c2657"></a><!-- doxytag: member="PxArticulation::setName" ref="1efa57c3102cb6258ee90ac70a3c2657" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a name string for the object that can be retrieved with <a class="el" href="classPxArticulation.html#e10c600444771ea7e29d531b84f3c734" title="Retrieves the name string set with setName().">getName()</a>.
<p>
This is for debugging and is not used by the SDK. The string is not copied by the SDK, only the pointer is stored.<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>name</em> </td><td>String to set the objects name to.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#e10c600444771ea7e29d531b84f3c734" title="Retrieves the name string set with setName().">getName()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="284072a943c7e9caa992c513e0855aaf"></a><!-- doxytag: member="PxArticulation::setSeparationTolerance" ref="284072a943c7e9caa992c513e0855aaf" args="(PxReal tolerance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setSeparationTolerance </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>tolerance</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets separationTolerance.
<p>
This is the maximum allowed separation of any joint in the articulation before projection is used<p>
<b>Default: 0.1f, scaled by the tolerance scale </b><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>tolerance</em> </td><td>the separation tolerance for the articulation</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#cacffbf3e5e6e2e02e8b0929e9b73cf6" title="gets separationTolerance.">getSeparationTolerance()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="e7e4735b8c23aaf5f41d829208cccce6"></a><!-- doxytag: member="PxArticulation::setSleepThreshold" ref="e7e4735b8c23aaf5f41d829208cccce6" args="(PxReal threshold)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setSleepThreshold </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>threshold</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the mass-normalized energy threshold below which an articulation may go to sleep.
<p>
The articulation will sleep if the energy of each body is below this threshold.<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>threshold</em> </td><td>Energy below which an actor may go to sleep. <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="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df" title="Returns true if this articulation is sleeping.">isSleeping()</a> <a class="el" href="classPxArticulation.html#9e7f831e514e0de1c15812f62c0ab20b" title="Returns the mass-normalized energy below which an articulation may go to sleep.">getSleepThreshold()</a> <a class="el" href="classPxArticulation.html#596fb9e8f1d136d571965583bc5d0d1b" title="Wakes up the articulation if it is sleeping.">wakeUp()</a> <a class="el" href="classPxArticulation.html#b7da60ba6a4a5b7068115dc79a545b73" title="Forces the articulation to sleep.">putToSleep()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f31eb23f85c5a8516612cad455d4fef3"></a><!-- doxytag: member="PxArticulation::setSolverIterationCounts" ref="f31eb23f85c5a8516612cad455d4fef3" args="(PxU32 minPositionIters, PxU32 minVelocityIters=1)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setSolverIterationCounts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>minPositionIters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>minVelocityIters</em> = <code>1</code></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>
Sets the solver iteration counts for the articulation.
<p>
The solver iteration count determines how accurately joints and contacts are resolved. If you are having trouble with jointed bodies oscillating and behaving erratically, then setting a higher position iteration count may improve their stability.<p>
If intersecting bodies are being depenetrated too violently, increase the number of velocity iterations. More velocity iterations will drive the relative exit velocity of the intersecting objects closer to the correct value given the restitution.<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>minPositionIters</em> </td><td>Number of position iterations the solver should perform for this articulation. <b>Range:</b> [1,255] </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>minVelocityIters</em> </td><td>Number of velocity iterations the solver should perform for this articulation. <b>Range:</b> [1,255]</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#895c71778bd0ec8905719f507e0a966f" title="Retrieves the solver iteration counts.">getSolverIterationCounts()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="259748392f6223dc218d1e1ba8ee9944"></a><!-- doxytag: member="PxArticulation::setStabilizationThreshold" ref="259748392f6223dc218d1e1ba8ee9944" args="(PxReal threshold)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setStabilizationThreshold </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>threshold</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the mass-normalized kinetic energy threshold below which an articulation may participate in stabilization.
<p>
Articulation whose kinetic energy divided by their mass is above this threshold will not participate in stabilization.<p>
This value has no effect if <a class="el" href="structPxSceneFlag.html#b4c347372b4433d34d983da780916c53909e1cb63ea9c0394e2c2b3a526f47fe" title="Enables additional stabilization pass in solver.">PxSceneFlag::eENABLE_STABILIZATION</a> was not enabled on the <a class="el" href="classPxSceneDesc.html" title="Descriptor class for scenes. See PxScene.">PxSceneDesc</a>.<p>
<b>Default:</b> 0.01 * <a class="el" href="classPxTolerancesScale.html#629358a15988697feaa85759d5c57e33">PxTolerancesScale::speed</a> * <a class="el" href="classPxTolerancesScale.html#629358a15988697feaa85759d5c57e33">PxTolerancesScale::speed</a><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>threshold</em> </td><td>Energy below which an actor may participate in stabilization. <b>Range:</b> [0,inf)</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#a7fd4f3e2ea751de54885d62510289cd" title="Returns the mass-normalized kinetic energy below which an articulation may participate...">getStabilizationThreshold()</a> <a class="el" href="structPxSceneFlag.html#b4c347372b4433d34d983da780916c53909e1cb63ea9c0394e2c2b3a526f47fe" title="Enables additional stabilization pass in solver.">PxSceneFlag::eENABLE_STABILIZATION</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="aef04ee0fba882eb8212f6baa5dde0b2"></a><!-- doxytag: member="PxArticulation::setWakeCounter" ref="aef04ee0fba882eb8212f6baa5dde0b2" args="(PxReal wakeCounterValue)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::setWakeCounter </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>wakeCounterValue</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the wake counter for the articulation.
<p>
The wake counter value determines the minimum amount of time until the articulation can be put to sleep. Please note that an articulation will not be put to sleep if the energy is above the specified threshold (see <a class="el" href="classPxArticulation.html#e7e4735b8c23aaf5f41d829208cccce6" title="Sets the mass-normalized energy threshold below which an articulation may go to sleep...">setSleepThreshold()</a>) or if other awake objects are touching it.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Passing in a positive value will wake the articulation up automatically.</dd></dl>
<b>Default:</b> 0.4 (which corresponds to 20 frames for a time step of 0.02)<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>wakeCounterValue</em> </td><td>Wake counter value. <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="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df" title="Returns true if this articulation is sleeping.">isSleeping()</a> <a class="el" href="classPxArticulation.html#9e7c111d4f17746b2b6686a2f5393e7e" title="Returns the wake counter of the articulation.">getWakeCounter()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="65811cf8f73da01a8cea28d2dfebe290"></a><!-- doxytag: member="PxArticulation::updateDriveCache" ref="65811cf8f73da01a8cea28d2dfebe290" args="(PxArticulationDriveCache &driveCache, PxReal compliance, PxU32 driveIterations) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::updateDriveCache </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxArticulationDriveCache.html">PxArticulationDriveCache</a> & </td>
<td class="paramname"> <em>driveCache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>compliance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>driveIterations</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update a drive cache
<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>driveCache</em> </td><td>the drive cache to update </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>compliance</em> </td><td>the compliance value to use at all joints of the articulation. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>driveIterations</em> </td><td>the number of iterations to use to evaluate the drive strengths</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#da8e885a5ea020e2b41be20d6c202f26" title="release a drive cache">releaseDriveCache</a> <a class="el" href="classPxArticulation.html#795fd4cd7bb40e05c9e9bfd6f0d73a70" title="create a drive cache for applying impulses which are propagated to the entire articulation...">createDriveCache</a> <a class="el" href="classPxArticulation.html#29fd49597cee46481679988e3ace38a5" title="apply an impulse to an entire articulation">applyImpulse</a> <a class="el" href="classPxArticulation.html#bfe3887e17be7b04d71a7d21c96c181d" title="determine the effect of applying an impulse to an entire articulation, without applying...">computeImpulseResponse</a></dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>this call may only be made on articulations that are in a scene, and may not be made during simulation </dd></dl>
</div>
</div><p>
<a class="anchor" name="596fb9e8f1d136d571965583bc5d0d1b"></a><!-- doxytag: member="PxArticulation::wakeUp" ref="596fb9e8f1d136d571965583bc5d0d1b" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxArticulation::wakeUp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Wakes up the articulation if it is sleeping.
<p>
The articulation will get woken up and might cause other touching objects to wake up as well during the next simulation step.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This will set the wake counter of the articulation to the value specified in <a class="el" href="classPxSceneDesc.html#79e2c9c06f711272a48d7f07451117b7" title="The wake counter reset value.">PxSceneDesc::wakeCounterResetValue</a>.<p>
It is invalid to use this method if the articulation has not been added to a scene already.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxArticulation.html#2ab9a560f94ce01b499fedff8f54a9df" title="Returns true if this articulation is sleeping.">isSleeping()</a> <a class="el" href="classPxArticulation.html#b7da60ba6a4a5b7068115dc79a545b73" title="Forces the articulation to sleep.">putToSleep()</a> </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="d292404f71931e4e465bfe7581c2aa1e"></a><!-- doxytag: member="PxArticulation::userData" ref="d292404f71931e4e465bfe7581c2aa1e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classPxArticulation.html#d292404f71931e4e465bfe7581c2aa1e">PxArticulation::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="PxArticulation_8h-source.html">PxArticulation.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>
|