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
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
|
=============
XML Reference
=============
Introduction
------------
This chapter is the reference manual for the MJCF modeling language used in MuJoCo.
.. _CSchema:
XML schema
~~~~~~~~~~
The table below summarizes the XML elements and their attributes in MJCF. Note that all information in MJCF is entered
through elements and attributes. Text content in elements is not used; if present, the parser ignores it. The symbols
in the second column of the table have the following meaning:
====== ===================================================
**!** required element, can appear only once
**?** optional element, can appear only once
**\*** optional element, can appear many times
**R** optional element, can appear many times recursively
====== ===================================================
+--------------------------+----+------------------------------------------------------------------------------------+
| :el:`mujoco` | ! | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`model` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`compiler` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`boundmass` | :at:`boundinertia` | :at:`settotalmass` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`balanceinertia` | :at:`strippath` | :at:`coordinate` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`angle` | :at:`fitaabb` | :at:`eulerseq` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`meshdir` | :at:`texturedir` | :at:`discardvisual` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`convexhull` | :at:`usethread` | :at:`fusestatic` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`inertiafromgeom` | :at:`inertiagrouprange` | :at:`exactmeshinertia` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`autolimits` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`lengthrange` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`mode` | :at:`useexisting` | :at:`uselimit` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`accel` | :at:`maxforce` | :at:`timeconst` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`timestep` | :at:`inttotal` | :at:`inteval` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`tolrange` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`option` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`timestep` | :at:`apirate` | :at:`impratio` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`tolerance` | :at:`noslip_tolerance` | :at:`mpr_tolerance` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`gravity` | :at:`wind` | :at:`magnetic` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`density` | :at:`viscosity` | :at:`o_margin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`o_solref` | :at:`o_solimp` | :at:`integrator` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`collision` | :at:`cone` | :at:`jacobian` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solver` | :at:`iterations` | :at:`noslip_iterations` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`mpr_iterations` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`flag` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`constraint` | :at:`equality` | :at:`frictionloss` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`limit` | :at:`contact` | :at:`passive` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`gravity` | :at:`clampctrl` | :at:`warmstart` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`filterparent` | :at:`actuation` | :at:`refsafe` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`sensor` | :at:`override` | :at:`energy` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fwdinv` | :at:`sensornoise` | :at:`multiccd` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`size` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`njmax` | :at:`nconmax` | :at:`nstack` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`nuserdata` | :at:`nkey` | :at:`nuser_body` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`nuser_jnt` | :at:`nuser_geom` | :at:`nuser_site` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`nuser_cam` | :at:`nuser_tendon` | :at:`nuser_actuator` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`nuser_sensor` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`visual` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`global` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fovy` | :at:`ipd` | :at:`azimuth` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`elevation` | :at:`linewidth` | :at:`glow` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`offwidth` | :at:`offheight` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`quality` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`shadowsize` | :at:`offsamples` | :at:`numslices` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`numstacks` | :at:`numquads` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`headlight` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ambient` | :at:`diffuse` | :at:`specular` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`active` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`map` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`stiffness` | :at:`stiffnessrot` | :at:`force` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`torque` | :at:`alpha` | :at:`fogstart` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fogend` | :at:`znear` | :at:`zfar` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`haze` | :at:`shadowclip` | :at:`shadowscale` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`actuatortendon` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`scale` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcewidth` | :at:`contactwidth` | :at:`contactheight` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`connect` | :at:`com` | :at:`camera` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`light` | :at:`selectpoint` | :at:`jointlength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`jointwidth` | :at:`actuatorlength` | :at:`actuatorwidth` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`framelength` | :at:`framewidth` | :at:`constraint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`slidercrank` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`rgba` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fog` | :at:`haze` | :at:`force` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`inertia` | :at:`joint` | :at:`actuator` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`actuatornegative` | :at:`actuatorpositive` | :at:`com` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`camera` | :at:`light` | :at:`selectpoint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`connect` | :at:`contactpoint` | :at:`contactforce` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`contactfriction` | :at:`contacttorque` | :at:`contactgap` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`rangefinder` | :at:`constraint` | :at:`slidercrank` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`crankbroken` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`statistic` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`meaninertia` | :at:`meanmass` | :at:`meansize` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`extent` | :at:`center` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`default` | R | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`class` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`mesh` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`scale` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`material` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`texture` | :at:`emission` | :at:`specular` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`shininess` | :at:`reflectance` | :at:`rgba` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`texrepeat` | :at:`texuniform` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`joint` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`type` | :at:`group` | :at:`pos` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`axis` | :at:`springdamper` | :at:`limited` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solreflimit` | :at:`solimplimit` | :at:`solreffriction` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimpfriction` | :at:`stiffness` | :at:`range` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`margin` | :at:`ref` | :at:`springref` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`armature` | :at:`damping` | :at:`frictionloss` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`geom` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`type` | :at:`pos` | :at:`quat` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`contype` | :at:`conaffinity` | :at:`condim` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`group` | :at:`priority` | :at:`size` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`material` | :at:`friction` | :at:`mass` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`density` | :at:`solmix` | :at:`solref` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimp` | :at:`margin` | :at:`gap` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fromto` | :at:`axisangle` | :at:`xyaxes` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`zaxis` | :at:`euler` | :at:`hfield` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`mesh` | :at:`fitscale` | :at:`rgba` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`fluidshape` | :at:`fluidcoef` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`shellinertia` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`site` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`type` | :at:`group` | :at:`pos` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`quat` | :at:`material` | :at:`size` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fromto` | :at:`axisangle` | :at:`xyaxes` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`zaxis` | :at:`euler` | :at:`rgba` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`camera` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fovy` | :at:`ipd` | :at:`pos` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`quat` | :at:`axisangle` | :at:`xyaxes` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`zaxis` | :at:`euler` | :at:`mode` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`light` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`pos` | :at:`dir` | :at:`directional` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`castshadow` | :at:`active` | :at:`attenuation` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`exponent` | :at:`ambient` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`diffuse` | :at:`specular` | :at:`mode` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`pair` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`condim` | :at:`friction` | :at:`solref` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimp` | :at:`gap` | :at:`margin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`equality` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`active` | :at:`solref` | :at:`solimp` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tendon` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`group` | :at:`limited` | :at:`range` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solreflimit` | :at:`solimplimit` | :at:`solreffriction` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimpfriction` | :at:`frictionloss` | :at:`springlength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`width` | :at:`material` | :at:`margin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`stiffness` | :at:`damping` | :at:`rgba` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`general` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`actlimited` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrlrange` | :at:`forcerange` | :at:`actrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`gear` | :at:`cranklength` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`dyntype` | :at:`gaintype` | :at:`biastype` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`dynprm` | :at:`gainprm` | :at:`biasprm` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`motor` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`gear` | :at:`cranklength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`position` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`gear` | :at:`cranklength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | :at:`kp` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`velocity` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`gear` | :at:`cranklength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | :at:`kv` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`intvelocity` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`gear` | :at:`cranklength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | :at:`kp` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`actrange` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`damper` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`gear` | :at:`cranklength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | :at:`kv` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`cylinder` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`gear` | :at:`cranklength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | :at:`timeconst` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`area` | :at:`diameter` | :at:`bias` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`muscle` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`gear` | :at:`cranklength` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | :at:`group` | :at:`timeconst` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`range` | :at:`force` | :at:`scale` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`lmin` | :at:`lmax` | :at:`vmax` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fpmax` | :at:`fvmax` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`custom` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`numeric` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`size` | :at:`data` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`text` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`data` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tuple` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`element` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`objtype` | :at:`objname` | :at:`prm` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`asset` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`texture` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`type` | :at:`file` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`gridsize` | :at:`gridlayout` | :at:`fileright` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fileleft` | :at:`fileup` | :at:`filedown` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`filefront` | :at:`fileback` | :at:`builtin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`rgb1` | :at:`rgb2` | :at:`mark` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`markrgb` | :at:`random` | :at:`width` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`height` | :at:`hflip` | :at:`vflip` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`hfield` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`file` | :at:`nrow` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ncol` | :at:`size` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`mesh` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`file` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`vertex` | :at:`normal` | :at:`texcoord` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`face` | :at:`refpos` | :at:`refquat` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`scale` | :at:`smoothnormal` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`skin` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`file` | :at:`material` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`rgba` | :at:`inflate` | :at:`vertex` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`texcoord` | :at:`face` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`bone` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`body` | :at:`bindpos` | :at:`bindquat` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`vertid` | :at:`vertweight` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`material` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`texture` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`texrepeat` | :at:`texuniform` | :at:`emission` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`specular` | :at:`shininess` | :at:`reflectance` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`rgba` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`(world)body` | R | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`childclass` | :at:`pos` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`quat` | :at:`mocap` | :at:`axisangle` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`xyaxes` | :at:`zaxis` | :at:`euler` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`inertial` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`pos` | :at:`quat` | :at:`mass` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`diaginertia` | :at:`axisangle` | :at:`xyaxes` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`zaxis` | :at:`euler` | :at:`fullinertia` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`joint` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`type` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`group` | :at:`pos` | :at:`axis` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`springdamper` | :at:`limited` | :at:`solreflimit` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimplimit` | :at:`solreffriction` | :at:`solimpfriction` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`stiffness` | :at:`range` | :at:`margin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ref` | :at:`springref` | :at:`armature` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`damping` | :at:`frictionloss` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`freejoint` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`group` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`geom` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`type` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`contype` | :at:`conaffinity` | :at:`condim` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`group` | :at:`priority` | :at:`size` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`material` | :at:`friction` | :at:`mass` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`density` | :at:`solmix` | :at:`solref` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimp` | :at:`margin` | :at:`gap` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fromto` | :at:`pos` | :at:`quat` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`axisangle` | :at:`xyaxes` | :at:`zaxis` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`euler` | :at:`hfield` | :at:`mesh` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fitscale` | :at:`rgba` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fluidshape` | :at:`fluidcoef` | :at:`shellinertia` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`site` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`type` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`group` | :at:`pos` | :at:`quat` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`material` | :at:`size` | :at:`fromto` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`axisangle` | :at:`xyaxes` | :at:`zaxis` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`euler` | :at:`rgba` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`camera` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`fovy` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ipd` | :at:`pos` | :at:`quat` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`axisangle` | :at:`xyaxes` | :at:`zaxis` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`euler` | :at:`mode` | :at:`target` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`light` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`directional` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`castshadow` | :at:`active` | :at:`pos` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`dir` | :at:`attenuation` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`exponent` | :at:`ambient` | :at:`diffuse` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`specular` | :at:`mode` | :at:`target` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`composite` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`prefix` | :at:`type` | :at:`count` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`spacing` | :at:`offset` | :at:`flatinertia` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solrefsmooth` | :at:`solimpsmooth` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`joint` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`kind` | :at:`group` | :at:`stiffness` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`damping` | :at:`armature` | :at:`solreffix` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimpfix` | :at:`limited` | :at:`range` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`margin` | :at:`solreflimit` | :at:`solimplimit` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`frictionloss` | :at:`solreffriction` | :at:`solimpfriction` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`tendon` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`kind` | :at:`group` | :at:`stiffness` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`damping` | :at:`solreffix` | :at:`solimpfix` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`limited` | :at:`range` | :at:`margin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solreflimit` | :at:`solimplimit` | :at:`frictionloss` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solreffriction` | :at:`solimpfriction` | :at:`material` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`rgba` | :at:`width` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`skin` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`texcoord` | :at:`material` | :at:`rgba` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`inflate` | :at:`subgrid` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`geom` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`type` | :at:`contype` | :at:`conaffinity` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`condim` | :at:`group` | :at:`priority` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`size` | :at:`material` | :at:`rgba` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`friction` | :at:`mass` | :at:`density` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solmix` | :at:`solref` | :at:`solimp` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`margin` | :at:`gap` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`site` | ? | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`group` | :at:`size` | :at:`material` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`rgba` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`pin` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`coord` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`contact` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`pair` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`geom1` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`geom2` | :at:`condim` | :at:`friction` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solref` | :at:`solimp` | :at:`gap` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`margin` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`exclude` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`body1` | :at:`body2` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`equality` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`connect` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`body1` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`body2` | :at:`anchor` | :at:`active` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solref` | :at:`solimp` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`weld` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`body1` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`body2` | :at:`relpose` | :at:`active` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solref` | :at:`solimp` | :at:`anchor` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`torquescale` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`joint` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`joint1` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`joint2` | :at:`polycoef` | :at:`active` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solref` | :at:`solimp` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tendon` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`tendon1` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`tendon2` | :at:`polycoef` | :at:`active` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solref` | :at:`solimp` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`distance` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`geom1` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`geom2` | :at:`distance` | :at:`active` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solref` | :at:`solimp` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`tendon` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`spatial` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`limited` | :at:`range` | :at:`solreflimit` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimplimit` | :at:`solreffriction` | :at:`solimpfriction` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`frictionloss` | :at:`springlength` | :at:`width` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`material` | :at:`margin` | :at:`stiffness` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`damping` | :at:`rgba` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`site` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`site` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`geom` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`geom` | :at:`sidesite` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`pulley` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`divisor` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`fixed` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`limited` | :at:`range` | :at:`solreflimit` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`solimplimit` | :at:`solreffriction` | :at:`solimpfriction` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`frictionloss` | :at:`springlength` | :at:`margin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`stiffness` | :at:`damping` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_3|:el:`joint` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`joint` | :at:`coef` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`actuator` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`general` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`actlimited` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrlrange` | :at:`forcerange` | :at:`actrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`joint` | :at:`tendon` | :at:`site` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`lengthrange` | :at:`gear` | :at:`jointinparent` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranklength` | :at:`cranksite` | :at:`slidersite` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`user` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`dyntype` | :at:`gaintype` | :at:`biastype` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`dynprm` | :at:`gainprm` | :at:`biasprm` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`motor` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`lengthrange` | :at:`gear` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranklength` | :at:`user` | :at:`joint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`jointinparent` | :at:`tendon` | :at:`slidersite` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranksite` | :at:`site` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`position` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`lengthrange` | :at:`gear` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranklength` | :at:`user` | :at:`joint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`jointinparent` | :at:`tendon` | :at:`slidersite` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranksite` | :at:`site` | :at:`kp` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`velocity` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`lengthrange` | :at:`gear` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranklength` | :at:`user` | :at:`joint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`jointinparent` | :at:`tendon` | :at:`slidersite` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranksite` | :at:`site` | :at:`kv` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`intvelocity` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`lengthrange` | :at:`actrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`gear` | :at:`cranklength` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`joint` | :at:`jointinparent` | :at:`tendon` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`slidersite` | :at:`cranksite` | :at:`site` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`kp` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`damper` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`lengthrange` | :at:`gear` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranklength` | :at:`user` | :at:`joint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`jointinparent` | :at:`tendon` | :at:`slidersite` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranksite` | :at:`site` | :at:`kv` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`cylinder` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`lengthrange` | :at:`gear` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranklength` | :at:`user` | :at:`joint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`jointinparent` | :at:`tendon` | :at:`slidersite` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranksite` | :at:`site` | :at:`timeconst` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`area` | :at:`diameter` | :at:`bias` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`muscle` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`class` | :at:`group` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`ctrllimited` | :at:`forcelimited` | :at:`ctrlrange` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`forcerange` | :at:`lengthrange` | :at:`gear` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranklength` | :at:`user` | :at:`joint` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`jointinparent` | :at:`tendon` | :at:`slidersite` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cranksite` | :at:`timeconst` | :at:`range` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`force` | :at:`scale` | :at:`lmin` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`lmax` | :at:`vmax` | :at:`fpmax` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`fvmax` | | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`sensor` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`touch` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`accelerometer` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`velocimeter` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`gyro` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`force` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`torque` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`magnetometer` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`rangefinder` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`site` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`jointpos` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`joint` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`jointvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`joint` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tendonpos` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`tendon` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tendonvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`tendon` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`actuatorpos` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`actuator` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`actuatorvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`actuator` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`actuatorfrc` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`actuator` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`ballquat` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`joint` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`ballangvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`joint` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`jointlimitpos` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`joint` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`jointlimitvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`joint` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`jointlimitfrc` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`joint` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tendonlimitpos` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`tendon` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tendonlimitvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`tendon` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`tendonlimitfrc` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`tendon` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`framepos` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`reftype` | :at:`refname` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`framequat` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`reftype` | :at:`refname` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`framexaxis` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`reftype` | :at:`refname` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`frameyaxis` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`reftype` | :at:`refname` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`framezaxis` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`reftype` | :at:`refname` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`framelinvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`reftype` | :at:`refname` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`frameangvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`reftype` | :at:`refname` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`framelinacc` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`frameangacc` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`subtreecom` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`body` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`subtreelinvel` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`body` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`subtreeangmom` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`body` | :at:`cutoff` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`noise` | :at:`user` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`user` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`objtype` | :at:`objname` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`datatype` | :at:`needstage` | :at:`dim` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`cutoff` | :at:`noise` | :at:`user` | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_|:el:`keyframe` | \* | *no attribute* |
+--------------------------+----+------------------------------------------------------------------------------------+
| |_2|:el:`key` | \* | .. table:: |
| | | :class: mjcf-attributes |
| | | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`name` | :at:`time` | :at:`qpos` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`qvel` | :at:`act` | :at:`ctrl` | |
| | | +-------------------------+-------------------------+-------------------------+ |
| | | | :at:`mpos` | :at:`mquat` | | |
| | | +-------------------------+-------------------------+-------------------------+ |
+--------------------------+----+------------------------------------------------------------------------------------+
.. _CType:
Attribute types
~~~~~~~~~~~~~~~
| Each attribute has a data type enforced by the parser. The available data types are:
========= ==============================================================================================
string   An arbitrary string, usually specifying a file name or a user-defined name of a model element.
int(N) An array of N integers. If N is omitted it equals 1.
real(N) An array of N real-valued numbers. If N is omitted it equals 1.
[...] Keyword attribute. The list of valid keywords is given in brackets.
========= ==============================================================================================
|
| For array-type attributes, the length of the array is enforced by the parser unless specified otherwise in the
reference documentation below.
| In addition to having a data type, attributes can be required or optional. Optional attributes can have internal
defaults or not. Optional attributes that do not have internal defaults are initialized in a special undefined state.
This state is different from any valid setting that can be entered in the XML. This mechanism enables the compiler to
determine if the attribute has been "touched" by the user, either explicitly or through defaults, and take
appropriate action. Some attributes have internal defaults (usually 0) which are not actually allowed by the
compiler. When such attributes become relevant in a given context, they must be set to allowed values.
+-------------+--------------------------------------------------------------------------------------------------+
| required   | The attribute is required by the parser. If it is not present the parser will generate an error. |
+-------------+--------------------------------------------------------------------------------------------------+
| optional | The attribute is optional. There is no internal default. The attribute is initialized in the |
| | undefined state. |
+-------------+--------------------------------------------------------------------------------------------------+
| "..." | The attribute is optional. The internal default is given in quotes. |
+-------------+--------------------------------------------------------------------------------------------------+
|
| In the reference documentation below the attribute name is shown in boldface, followed by its data type, followed by
the required/optional status including the internal default if any. For example, the attribute angle is a keyword
attribute whose value can be "radian" or "degree". It is an optional attribute and has internal default "degree".
Therefore it will appear in the reference documentation as
:at:`angle`: :at-val:`[radian, degree], "degree"`
.. _Reference:
MJCF Reference
--------------
| MJCF files have a unique top-level element :ref:`mujoco <mujoco>`. The next-level elements are referred to as
*sections*. They are all optional. Some sections are merely used for grouping and have no attributes. Sections can be
repeated, to facilitate merging of models via the :ref:`include <include>` element.
| The *order* of attributes within an element can be arbitrary. The order of child elements within a parent element can
also be arbitrary, with four exceptions:
- The order of :ref:`joint <joint>` elements within a :ref:`body <body>` matters because joint transformations are
performed in sequence.
- The order of elements in a :ref:`spatial <spatial>` tendon matters because it determines the sequence of objects that
the tendon passes through or wraps around.
- The order of repeated sections matters when the same attribute is set multiple times to different values. In that
case the last setting takes effect for the entire model.
- The order of multiple actuator shortcuts in the same defaults class matters, because each shortcut sets the
attributes of the single :ref:`general <general>` element in that defaults class, overriding the previous settings.
In the remainder of this chapter we describe all valid MJCF elements and their attributes. Some elements can be used in
multiple contexts, in which case their meaning depends on the parent element. This is why we always show the parent as a
prefix in the documentation below.
.. _include:
**include** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This element does not strictly speaking belong to MJCF. Instead it is a meta-element, used to assemble multiple XML
files in a single document object model (DOM) before parsing. The included file must be a valid XML file with a unique
top-level element. This top-level element is removed by the parser, and the elements below it are inserted at the
location of the :el:`include` element. At least one element must be inserted as a result of this procedure. The
:el:`include` element can be used where ever an XML element is expected in the MJFC file. Nested includes are allowed,
however a given XML file can be included at most once in the entire model. After all the included XML files have been
assembled into a single DOM, it must correspond to a valid MJCF model. Other than that, it is up to the user to decide
how to use includes and how to modularize large files if desired.
:at:`file`: :at-val:`string, required`
The name of the XML file to be included. The file location is relative to the directory of the main MJCF file. If the
file is not in the same directory, it should be prefixed with a relative path.
.. _mujoco:
**mujoco** (!)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The unique top-level element, identifying the XML file as an MJCF model file.
:at:`model`: :at-val:`string, "MuJoCo Model"`
The name of the model. This name is shown in the title bar of `simulate.cc
<https://github.com/deepmind/mujoco/blob/main/sample/simulate.cc>`_.
.. _compiler:
**compiler** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This element is used to set options for the built-in parser and compiler. After parsing and compilation it no longer has
any effect. The settings here are global and apply to the entire model.
:at:`autolimits`: :at-val:`[false, true], "false"`
This attribute affects the behavior of attributes such as "limited" (on <joint> or <tendon>), "forcelimited",
"ctrllimited", and "actlimited" (on <actuator>). If "true", these attributes are unnecessary and their value
will be inferred from the presence of their corresponding "range" attribute.
If "false", no such inference will happen: For a joint to be limited, both limited="true" and range="min max" must
be specified. In this mode, it is an error to specify a range without a limit.
|br| The default for this option will be set to "true" in an upcoming release.
:at:`boundmass`: :at-val:`real, "0"`
This attribute imposes a lower bound on the mass of each body except for the world body. Setting this attribute to
a value greater than 0 can be used as a quick fix for poorly designed models that contain massless moving bodies,
such as the dummy bodies often used in URDF models to attach sensors. Note that in MuJoCo there is no need to create
dummy bodies.
:at:`boundinertia`: :at-val:`real, "0"`
This attribute imposes a lower bound on the diagonal inertia components of each body except for the world body. Its
use is similar to boundmass above.
:at:`settotalmass`: :at-val:`real, "-1"`
If this value is positive, the compiler will scale the masses and inertias of all bodies in the model, so that the
total mass equals the value specified here. The world body has mass 0 and does not participate in any mass-related
computations. This scaling is performed last, after all other operations affecting the body mass and inertia. The
same scaling operation can be applied at runtime to the compiled mjModel with the function
:ref:`mj_setTotalmass`.
:at:`balanceinertia`: :at-val:`[false, true], "false"`
A valid diagonal inertia matrix must satisfy A+B>=C for all permutations of the three diagonal elements. Some poorly
designed models violate this constraint, which will normally result in compile error. If this attribute is set to
"true", the compiler will silently set all three diagonal elements to their average value whenever the above
condition is violated.
:at:`strippath`: :at-val:`[false, true], "false" for MJCF, "true" for URDF`
The this attribute is "true", the parser will remove any path information in file names specified in the model. This
is useful for loading models created on a different system using a different directory structure.
:at:`coordinate`: :at-val:`[local, global], "local" for MJCF, always "local" for URDF`
This attribute specifies whether the frame positions and orientations in the MJCF model are expressed in local or
global coordinates; recall :ref:`Coordinate frames <CFrame>`. The compiler converts global into local
coordinates, and mjModel always uses local coordinates. For URDF models the parser sets this attribute to "local"
internally, regardless of the XML setting.
:at:`angle`: :at-val:`[radian, degree], "degree" for MJCF, always "radian" for URDF`
This attribute specifies whether the angles in the MJCF model are expressed in units of degrees or radians. The
compiler converts degrees into radians, and mjModel always uses radians. For URDF models the parser sets this
attribute to "radian" internally, regardless of the XML setting.
:at:`fitaabb`: :at-val:`[false, true], "false"`
The compiler is able to replace a mesh with a geometric primitive fitted to that mesh; see :ref:`geom <geom>` below.
If this attribute is "true", the fitting procedure uses the axis-aligned bounding box (aabb) of the mesh. Otherwise
it uses the equivalent-inertia box of the mesh. The type of geometric primitive used for fitting is specified
separately for each geom.
:at:`eulerseq`: :at-val:`string, "xyz"`
This attribute specifies the sequence of Euler rotations for all euler attributes of elements that have spatial
frames, as explained in :ref:`COrientation`. This must be a string with exactly 3
characters from the set {'x', 'y', 'z', 'X', 'Y', 'Z'}. The character at position n determines the axis around which
the n-th rotation is performed. Lower case denotes axes that rotate with the frame, while upper case denotes axes
that remain fixed in the parent frame. The "rpy" convention used in URDF corresponds to the default "xyz" in MJCF.
:at:`meshdir`: :at-val:`string, optional`
This attribute instructs the compiler where to look for mesh and height field files. The full path to a file is
determined as follows. If the strippath attribute described above is "true", all path information from the file name
is removed. The following checks are then applied in order: (1) if the file name contains an absolute path, it is
used without further changes; (2) if this attribute is set and contains an absolute path, the full path is the string
given here appended with the file name; (3) the full path is the path to the main MJCF model file, appended with the
value of this attribute if specified, appended with the file name.
:at:`texturedir`: :at-val:`string, optional`
This attribute is used to instruct the compiler where to look for texture files. It works in the same way as meshdir
above.
:at:`discardvisual`: :at-val:`[false, true], "false" for MJCF, "true" for URDF`
This attribute instructs the parser to discard "visual geoms", defined as geoms whose contype and conaffinity
attributes are both set to 0. This functionality is useful for models that contain two sets of geoms, one for
collisions and the other for visualization. Note that URDF models are usually constructed in this way. It rarely
makes sense to have two sets of geoms in the model, especially since MuJoCo uses convex hulls for collisions, so we
recommend using this feature to discard redundant geoms. Keep in mind however that geoms considered visual per the
above definition can still participate in collisions, if they appear in the explicit list of contact
:ref:`pairs <pair>`. The parser does not check this list before discarding geoms; it relies solely on the geom
attributes to make the determination.
:at:`convexhull`: :at-val:`[false, true], "true"`
If this attribute is "true", the compiler will automatically generate a convex hull for every mesh that is used in at
least one non-visual geom (in the sense of the discardvisual attribute above). This is done to speed up collision
detection; recall :ref:`Collision` section in the Computation chapter. Even if the mesh is already convex, the hull
contains edge information that is not present in the mesh file, so it needs to be constructed. The only reason to
disable this feature is to speed up re-loading of a model with large meshes during model editing (since the convex
hull computation is the slowest operation performed by the compiler). However once model design is finished, this
feature should be enabled, because the availability of convex hulls substantially speeds up collision detection with
large meshes.
:at:`usethread`: :at-val:`[false, true], "true"`
If this attribute is "true", the model compiler will run in multi-threaded mode. Currently multi-threading is only
used when computing the length ranges of actuators, but in the future additional compiler phases may be
multi-threaded.
:at:`fusestatic`: :at-val:`[false, true], "false" for MJCF, "true" for URDF`
This attribute controls a compiler optimization feature where static bodies are fused with their parent, and any
elements defined in those bodies are reassigned to the parent. This feature can only be used in models which do not
have elements capable of named references inside the kinematic tree - namely skins, contact pairs, excludes, tendons,
actuators, sensors, tuples, cameras, lights. If a model has any these elements, fusestatic does nothing even if
enabled. This optimization is particularly useful when importing URDF models which often have many dummy bodies, but
can also be used to optimize MJCF models. After optimization, the new model has identical kinematics and dynamics as
the original but is faster to simulate.
:at:`inertiafromgeom`: :at-val:`[false, true, auto], "auto"`
This attribute controls the automatic inference of body masses and inertias from geoms attached to the body. If this
setting is "false", no automatic inference is performed. In that case each body must have explicitly defined mass and
inertia with the :ref:`inertial <inertial>` element, or else a compile error will be generated. If this setting is
"true", the mass and inertia of each body will be inferred from the geoms attached to it, overriding any values
specified with the :el:`inertial` element. The default setting "auto" means that masses and inertias are inferred
automatically only when the :el:`inertial` element is missing in the body definition. One reason to set this
attribute to "true" instead of "auto" is to override inertial data imported from a poorly designed model. In
particular, a number of publicly available URDF models have seemingly arbitrary inertias which are too large compared
to the mass. This results in equivalent inertia boxes which extend far beyond the geometric boundaries of the model.
Note that the built-in OpenGL visualizer can render equivalent inertia boxes.
:at:`exactmeshinertia`: :at-val:`[false, true], "false"`
If this attribute is set to false, computes mesh inertia with the legacy algorithm, which is exact only for convex
meshes. If set to true, it is exact for any closed mesh geometry.
:at:`inertiagrouprange`: :at-val:`int(2), "0 5"`
This attribute specifies the range of geom groups that are used to infer body masses and inertias (when such
inference is enabled). The group attribute of :ref:`geom <geom>` is an integer. If this integer falls in the range
specified here, the geom will be used in the inertial computation, otherwise it will be ignored. This feature is
useful in models that have redundant sets of geoms for collision and visualization. Note that the world body does not
participate in the inertial computations, so any geoms attached to it are automatically ignored. Therefore it is not
necessary to adjust this attribute and the geom-specific groups so as to exclude world geoms from the inertial
computation.
.. _compiler-lengthrange:
:el-prefix:`compiler/` **lengthrange** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element controls the computation of actuator length ranges. For an overview of this functionality see :ref:`Length
range <CLengthRange>` section. Note that if this element is omitted the defaults shown below still apply. In order to
disable length range computations altogether, include this element and set mode="none".
:at:`mode`: :at-val:`[none, muscle, muscleuser, all], "muscle"`
Determines the type of actuators to which length range computation is applied. "none" disables this functionality.
"all" applies it to all actuators. "muscle" applies it to actuators whose gaintype or biastype is set to "muscle".
"muscleuser" applies it to actuators whose gaintype or biastype is set to either "muscle" or "user". The default is
"muscle" because MuJoCo's muscle model requires actuator length ranges to be defined.
:at:`useexisting`: :at-val:`[false, true], "true"`
If this attribute is "true" and the length range for a given actuator is already defined in the model, the existing
value will be used and the automatic computation will be skipped. The range is considered defined if the first number
is smaller than the second number. The only reason to set this attribute to "false" is to force re-computation of
actuator length ranges - which is needed when the model geometry is modified. Note that the automatic computation
relies on simulation and can be slow, so saving the model and using the existing values when possible is recommended.
:at:`uselimit`: :at-val:`[false, true], "false"`
If this attribute is "true" and the actuator is attached to a joint or a tendon which has limits defined, these
limits will be copied into the actuator length range and the automatic computation will be skipped. This may seem
like a good idea but note that in complex models the feasible range of tendon actuators depends on the entire model,
and may be smaller than the user-defined limits for that tendon. So the safer approach is to set this to "false", and
let the automatic computation discover the feasible range.
:at:`accel`: :at-val:`real, "20"`
This attribute scales the forces applied to the simulation in order to push each actuator to its smallest and largest
length. The force magnitude is computed so that the resulting joint-space acceleration vector has norm equal to this
attribute.
:at:`maxforce`: :at-val:`real, "0"`
The force computed via the accel attribute above can be very large when the actuator has very small moments. Such a
force will still produce reasonable acceleration (by construction) but large numbers could cause numerical issues.
Although we have never observed such issues, the present attribute is provided as a safeguard. Setting it to a value
larger than 0 limits the norm of the force being applied during simulation. The default setting of 0 disables this
safeguard.
:at:`timeconst`: :at-val:`real, "1"`
The simulation is damped in a non-physical way so as to push the actuators to their limits without the risk of
instabilities. This is done by simply scaling down the joint velocity at each time step. In the absence of new
accelerations, such scaling will decrease the velocity exponentially. The timeconst attribute specifies the time
constant of this exponential decrease, in seconds.
:at:`timestep`: :at-val:`real, "0.01"`
The timestep used for the internal simulation. Setting this to 0 will cause the model timestep to be used. The latter
is not the default because models that can go unstable usually have small timesteps, while the simulation here is
artificially damped and very stable. To speed up the length range computation, users can attempt to increase this
value.
:at:`inttotal`: :at-val:`real, "10"`
The total time interval (in seconds) for running the internal simulation, for each actuator and actuator direction.
Each simulation is initialized at qpos0. It is expected to settle after inttotal time has passed.
:at:`inteval`: :at-val:`real, "2"`
The time interval at the end of the simulation over which length data is collected and analyzed. The maximum (or
respectively minimum) length achieved during this interval is recorded. The difference between the maximum and
minimum is also recorded and is used as a measure of divergence. If the simulation settles, this difference will be
small. If it is not small, this could be because the simulation has not yet settled - in which case the above
attributes should be adjusted - or because the model does not have sufficient joint and tendon limits and so the
actuator range is effectively unlimited. Both of these conditions cause the same compiler error. Recall that contacts
are disabled in this simulation, so joint and tendon limits as well as overall geometry are the only things that can
prevent actuators from having infinite length.
:at:`tolrange`: :at-val:`real, "0.05"`
This determines the threshold for detecting divergence and generating a compiler error. The range of actuator lengths
observed during inteval is divided by the overall range computed via simulation. If that value is larger than
tolrange, a compiler error is generated. So one way to suppress compiler errors is to simply make this attribute
larger, but in that case the results could be inaccurate.
.. _option:
**option** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
This element is is one-to-one correspondence with the low level structure mjOption contained in the field mjModel.opt of
mjModel. These are simulation options and do not affect the compilation process in any way; they are simply copied into
the low level model. Even though mjOption can be modified by the user at runtime, it is nevertheless a good idea to
adjust it properly through the XML.
:at:`timestep`: :at-val:`real, "0.002"`
Simulation time step in seconds. This is the single most important parameter affecting the speed-accuracy trade-off
which is inherent in every physics simulation. Smaller values result in better accuracy and stability. To achieve
real-time performance, the time step must be larger than the CPU time per step (or 4 times larger when using the RK4
integrator). The CPU time is measured with internal timers. It should be monitored when adjusting the time step.
MuJoCo can simulate most robotic systems a lot faster than real-time, however models with many floating objects
(resulting in many contacts) are more demanding computationally. Keep in mind that stability is determined not only
by the time step but also by the :ref:`CSolver`; in particular softer constraints can be simulated with larger time
steps. When fine-tuning a challenging model, it is recommended to experiment with both settings jointly. In
optimization-related applications, real-time is no longer good enough and instead it is desirable to run the
simulation as fast as possible. In that case the time step should be made as large as possible.
:at:`apirate`: :at-val:`real, "100"`
This parameter determines the rate (in Hz) at which an external API allows the update function to be executed. This
mechanism is used to simulate devices with limited communication bandwidth. It only affects the socket API and not
the physics simulation.
:at:`impratio`: :at-val:`real, "1"`
This attribute determines the ratio of frictional-to-normal constraint impedance for elliptic friction cones. The
setting of solimp determines a single impedance value for all contact dimensions, which is then modulated by this
attribute. Settings larger than 1 cause friction forces to be "harder" than normal forces, having the general effect
of preventing slip, without increasing the actual friction coefficient. For pyramidal friction cones the situation is
more complex because the pyramidal approximation mixes normal and frictional dimensions within each basis vector; but
the overall effect of this attribute is qualitatively similar.
:at:`gravity`: :at-val:`real(3), "0 0 -9.81"`
Gravitational acceleration vector. In the default world orientation the Z-axis points up. The MuJoCo GUI is organized
around this convention (both the camera and perturbation commands are based on it) so we do not recommend deviating
from it.
:at:`wind`: :at-val:`real(3), "0 0 0"`
Velocity vector of the medium (i.e., wind). This vector is subtracted from the 3D translational velocity of each
body, and the result is used to compute viscous, lift and drag forces acting on the body; recall :ref:`Passive forces
<gePassive>` in the Computation chapter. The magnitude of these forces scales with the values of the next two
attributes.
:at:`magnetic`: :at-val:`real(3), "0 -0.5 0"`
Global magnetic flux. This vector is used by magnetometer sensors, which are defined as sites and return the magnetic
flux at the site position expressed in the site frame.
:at:`density`: :at-val:`real, "0"`
Density of the medium, not to be confused with the geom density used to infer masses and inertias. This parameter is
used to simulate lift and drag forces, which scale quadratically with velocity. In SI units the density of air is
around 1.2 while the density of water is around 1000 depending on temperature. Setting density to 0 disables lift and
drag forces.
:at:`viscosity`: :at-val:`real, "0"`
Viscosity of the medium. This parameter is used to simulate viscous forces, which scale linearly with velocity. In SI
units the viscosity of air is around 0.00002 while the viscosity of water is around 0.0009 depending on temperature.
Setting viscosity to 0 disables viscous forces. Note that the default Euler :ref:`integrator <geIntegration>` handles
damping in the joints implicitly – which improves stability and accuracy. It does not presently do this with body
viscosity. Therefore, if the goal is merely to create a damped simulation (as opposed to modeling the specific
effects of viscosity), we recommend using joint damping rather than body viscosity, or switching to the
:at:`implicit` integrator.
:at:`o_margin`: :at-val:`real, "0"`
This attribute replaces the margin parameter of all active contact pairs when :ref:`Contact override <COverride>` is
enabled. Otherwise MuJoCo uses the element-specific margin attribute of :ref:`geom <geom>` or :ref:`pair <pair>`
depending on how the contact pair was generated. See also :ref:`Collision` in the Computation chapter. The related
gap parameter does not have a global override.
:at:`o_solref`, :at:`o_solimp`
These attributes replace the solref and solimp parameters of all active contact pairs when contact override is
enabled. See :ref:`CSolver` for details.
:at:`integrator`: :at-val:`[Euler, RK4, implicit], "Euler"`
This attribute selects the numerical :ref:`integrator <geIntegration>` to be used. Currently the available
integrators are the semi-implicit Euler method, the fixed-step 4-th order Runge Kutta method, and
the Implicit-in-velocity Euler method.
:at:`collision`: :at-val:`[all, predefined, dynamic], "all"`
This attribute specifies which geom pairs should be checked for collision; recall :ref:`Collision` in the Computation
chapter. "predefined" means that only the explicitly-defined contact :ref:`pairs <pair>` are checked. "dynamic" means
that only the contact pairs generated dynamically are checked. "all" means that the contact pairs from both sources
are checked.
:at:`cone`: :at-val:`[pyramidal, elliptic], "pyramidal"`
The type of contact friction cone. Elliptic cones are a better model of the physical reality, but pyramidal cones
sometimes make the solver faster and more robust.
:at:`jacobian`: :at-val:`[dense, sparse, auto], "auto"`
The type of constraint Jacobian and matrices computed from it. Auto resolves to dense when the number of degrees of
freedom is up to 60, and sparse over 60.
:at:`solver`: :at-val:`[PGS, CG, Newton], "Newton"`
This attribute selects one of the constraint solver :ref:`algorithms <soAlgorithms>` described in the Computation
chapter. Guidelines for solver selection and parameter tuning are available in the :ref:`Algorithms <CAlgorithms>`
section above.
:at:`iterations`: :at-val:`int, "100"`
Maximum number of iterations of the constraint solver. When the warmstart attribute of :ref:`flag <option-flag>` is
enabled (which is the default), accurate results are obtained with fewer iterations. Larger and more complex systems
with many interacting constraints require more iterations. Note that mjData.solver contains statistics about solver
convergence, also shown in the profiler.
:at:`tolerance`: :at-val:`real, "1e-8"`
Tolerance threshold used for early termination of the iterative solver. For PGS, the threshold is applied to the cost
improvement between two iterations. For CG and Newton, it is applied to the smaller of the cost improvement and the
gradient norm. Set the tolerance to 0 to disable early termination.
:at:`noslip_iterations`: :at-val:`int, "0"`
Maximum number of iterations of the Noslip solver. This is a post-processing step executed after the main solver. It
uses a modified PGS method to suppress slip/drift in friction dimensions resulting from the soft-constraint model.
The default setting 0 disables this post-processing step.
:at:`noslip_tolerance`: :at-val:`real, "1e-6"`
Tolerance threshold used for early termination of the Noslip solver.
:at:`mpr_iterations`: :at-val:`int, "50"`
Maximum number of iterations of the MPR algorithm used for convex mesh collisions. This rarely needs to be adjusted,
except in situations where some geoms have very large aspect ratios.
:at:`mpr_tolerance`: :at-val:`real, "1e-6"`
Tolerance threshold used for early termination of the MPR algorithm.
.. _option-flag:
:el-prefix:`option/` **flag** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element sets the flags that enable and disable different parts of the simulation pipeline. The actual flags used at
runtime are represented as the bits of two integers, namely mjModel.opt.disableflags and mjModel.opt.enableflags, used
to disable standard features and enable optional features respectively. The reason for this separation is that setting
both integers to 0 restores the default. In the XML we do not make this separation explicit, except for the default
attribute values - which are "enable" for flags corresponding to standard features, and "disable" for flags
corresponding to optional features. In the documentation below, we explain what happens when the setting is different
from its default.
:at:`constraint`: :at-val:`[disable, enable], "enable"`
This flag disables all standard computations related to the constraint solver. As a result, no constraint forces are
applied. Note that the next four flags disable the computations related to a specific type of constraint. Both this
flag and the type-specific flag must be set to "enable" for a given computation to be performed.
:at:`equality`: :at-val:`[disable, enable], "enable"`
This flag disables all standard computations related to equality constraints.
:at:`frictionloss`: :at-val:`[disable, enable], "enable"`
This flag disables all standard computations related to friction loss constraints.
:at:`limit`: :at-val:`[disable, enable], "enable"`
This flag disables all standard computations related to joint and tendon limit constraints.
:at:`contact`: :at-val:`[disable, enable], "enable"`
This flag disables all standard computations related to contact constraints.
:at:`passive`: :at-val:`[disable, enable], "enable"`
This flag disables the simulation of joint and tendon spring-dampers, fluid dynamics forces, and custom passive
forces computed by the :ref:`mjcb_passive` callback. As a result, no passive forces are applied.
:at:`gravity`: :at-val:`[disable, enable], "enable"`
This flag causes the gravitational acceleration vector in mjOption to be replaced with (0 0 0) at runtime, without
changing the value in mjOption. Once the flag is re-enabled, the value in mjOption is used.
:at:`clampctrl`: :at-val:`[disable, enable], "enable"`
This flag disables the clamping of control inputs to all actuators, even if the actuator-specific attributes are set
to enable clamping.
:at:`warmstart`: :at-val:`[disable, enable], "enable"`
This flag disables warm-starting of the constraint solver. By default the solver uses the solution (i.e., the
constraint force) from the previous time step to initialize the iterative optimization. This feature should be
disabled when evaluating the dynamics at a collection of states that do not form a trajectory - in which case warm
starts make no sense and are likely to slow down the solver.
:at:`filterparent`: :at-val:`[disable, enable], "enable"`
This flag disables the filtering of contact pairs where the two geoms belong to a parent and child body; recall
contact :ref:`selection <coSelection>` in the Computation chapter.
:at:`actuation`: :at-val:`[disable, enable], "enable"`
This flag disables all standard computations related to actuator forces, including the actuator dynamics. As a
result, no actuator forces are applied to the simulation.
:at:`refsafe`: :at-val:`[disable, enable], "enable"`
This flag enables a safety mechanism that prevents instabilities due to solref[0] being too small compared to the
simulation timestep. Recall that solref[0] is the stiffness of the virtual spring-damper used for constraint
stabilization. If this setting is enabled, the solver uses max(solref[0], 2*timestep) in place of solref[0]
separately for each active constraint.
:at:`sensor`: :at-val:`[disable, enable], "enable"`
This flag disables all computations related to sensors. When disabled, sensor values will remain constant, either
zeros if disabled at the start of simulation, or, if disabled at runtime, whatever value was last computed.
:at:`override`: :at-val:`[disable, enable], "disable"`
This flag enables to :ref:`Contact override <COverride>` mechanism explained above.
:at:`energy`: :at-val:`[disable, enable], "disable"`
This flag enables the computation of kinetic and potential energy, stored in mjData.energy and displayed in the GUI.
This feature adds some CPU time but it is usually negligible. Monitoring energy for a system that is supposed to be
energy-conserving is one of the best ways to assess the accuracy of a complex simulation.
:at:`fwdinv`: :at-val:`[disable, enable], "disable"`
This flag enables the automatic comparison of forward and inverse dynamics. When enabled, the inverse dynamics is
invoked after mj_forward (or internally within mj_step) and the difference in applied forces is recorded in
mjData.solver_fwdinv[2]. The first value is the relative norm of the discrepancy in joint space, the next is in
constraint space.
:at:`sensornoise`: :at-val:`[disable, enable], "disable"`
This flag enables the simulation of sensor noise. When disabled (which is the default) noise is not added to
sensordata, even if the sensors specify non-zero noise amplitudes. When enabled, zero-mean Gaussian noise is added to
the underlying deterministic sensor data. Its standard deviation is determined by the noise parameter of each sensor.
:at:`multiccd`: :at-val:`[disable, enable], "disable"` **(experimental feature)**
This flag enables multiple-contact collision detection for geom pairs that use the general-purpose convex-convex
collider based on :ref:`libccd <coChecking>` e.g., mesh-mesh collisions. This can be useful when the contacting geoms
have a flat surface, and the single contact point generated by the convex-convex collider cannot accurately capture
the surface contact, leading to instabilities that typically manifest as sliding or wobbling. Multiple contact points
are found by rotating the two geoms by ±1e-3 radians around the tangential axes and re-running the collision
function. If a new contact is detected it is added, allowing for up to 4 additional contact points. This feature is
currently considered experimental, and both the behavior and the way it is activated may change in the future.
.. _size:
**size** (*)
~~~~~~~~~~~~
This element specifies size parameters that cannot be inferred from the number of elements in the model. Unlike the
fields of mjOption which can be modified at runtime, sizes are structural parameters and should not be modified after
compilation.
:at:`njmax`: :at-val:`int, "-1"`
This and the next two attributes specify the maximum sizes of the dynamic arrays in mjData, i.e., arrays whose
effective length varies at runtime. This attribute specifies the maximum number of scalar constraints (or
equivalently, rows of the constraint Jacobian) that can be handled at runtime. If the number of active constraints is
about to exceed this maximum (usually because too many contacts become active) the extra constraints are discarded
and a warning is generated. The number of active constraints is stored in mjData.nefc. The default setting of -1
instructs the compiler to guess how much space to allocate (using heuristics that can be improved). This default is
effectively an undefined state. If the user specifies a positive value, the compiler heuristics are disabled and the
specified value is used. Modern computers have sufficient memory to handle very large models (larger than one would
normally have the patience to simulate) so tuning this setting aggressively is not necessary. When size-related
warnings or errors are generated, simply increase the value of the corresponding attribute.
:at:`nconmax`: :at-val:`int, "-1"`
This attribute specifies the maximum number of contacts (both frictional and frictionless) that can be handled at
runtime. If the number of active contacts is about to exceed this value, the extra contacts are discarded and a
warning is generated. The actual number of contacts is stored in mjData.ncon. If this value is negative, the compiler
will use a heuristic to guess an appropriate number.
:at:`nstack`: :at-val:`int, "-1"`
This attribute specifies the size of the preallocated stack in mjData, in units of sizeof(mjtNum) which is currently
defined as double; thus the size in bytes is 8 times larger. The custom stack is used by all MuJoCo functions that
need dynamically allocated memory. We do not use heap memory allocation at runtime, so as to speed up processing as
well as avoid heap fragmentation. Note that the internal allocator keeps track of how much stack space has ever been
utilized, in the field mjData.maxstackuse of mjData. If the stack size is exceeded at runtime, MuJoCo will generate
an error. If this value is negative, the compiler will use a heuristic to guess an appropriate number.
:at:`nuserdata`: :at-val:`int, "0"`
The size of the field mjData.userdata of mjData. This field should be used to store custom dynamic variables. See
also :ref:`CUser`.
:at:`nkey`: :at-val:`int, "0"`
The number of key frames allocated in mjModel is the larger of this value and the number of :ref:`key <key>` elements
below. Note that the interactive simulator has the ability to take snapshots of the system state and save them as key
frames.
:at:`nuser_body`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each body. See also :ref:`User parameters <CUser>`.
The parameter values are set via the user attribute of the :ref:`body <body>` element. These values are not accessed
by MuJoCo. They can be used to define element properties needed in user callbacks and other custom code.
:at:`nuser_jnt`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each :ref:`joint <joint>`.
:at:`nuser_geom`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each :ref:`geom <geom>`.
:at:`nuser_site`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each :ref:`site <site>`.
:at:`nuser_cam`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each :ref:`camera <camera>`.
:at:`nuser_tendon`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each :ref:`tendon <tendon>`.
:at:`nuser_actuator`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each :ref:`actuator <actuator>`.
:at:`nuser_sensor`: :at-val:`int, "-1"`
The number of custom user parameters added to the definition of each :ref:`sensor <sensor>`.
.. _visual:
**visual** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
| This element is is one-to-one correspondence with the low level structure mjVisual contained in the field mjModel.vis
of mjModel. The settings here affect the visualizer, or more precisely the abstract phase of visualization which
yields a list of geometric entities for subsequent rendering. The settings here are global, in contrast with the
element-specific visual settings. The global and element-specific settings refer to non-overlapping properties. Some
of the global settings affect properties such as triangulation of geometric primitives that cannot be set per element.
Other global settings affect the properties of decorative objects, i.e., objects such as contact points and force
arrows which do not correspond to model elements. The visual settings are grouped semantically into several
subsections.
| This element is a good candidate for the :ref:`file include <CInclude>` mechanism. One can create an XML file with
coordinated visual settings corresponding to a "theme", and then include this file in multiple models.
.. _global:
:el-prefix:`visual/` **global** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
While all settings in mjVisual are global, the settings here could not be fit into any of the other subsections. So this
is effectively a miscellaneous subsection.
:at:`fovy`: :at-val:`real, "45"`
This attribute specifies the vertical field of view of the free camera, i.e., the camera that is always available in
the visualizer even if no cameras are explicitly defined in the model. It is always expressed in degrees, regardless
of the setting of the angle attribute of :ref:`compiler <compiler>`, and is also represented in the low level model
in degrees. This is because we pass it to OpenGL which uses degrees. The same convention applies to the fovy
attribute of the :ref:`camera <camera>` element below.
:at:`ipd`: :at-val:`real, "0.068"`
This attribute specifies the inter-pupilary distance of the free camera. It only affects the rendering in
stereoscopic mode. The left and right viewpoints are offset by half of this value in the corresponding direction.
:at:`azimuth`: :at-val:`real, "90"`
This attribute specifies the initial azimuth of the free camera around the vertical z-axis, in degrees. A value of 0
corresponds to looking in the positive x direction, while the default value of 90 corresponds to looking in the
positive y direction.
:at:`elevation`: :at-val:`real, "-45"`
This attribute specifies the initial elevation of the free camera with respect to the lookat point. Note that since
this is a rotation around a vector parallel to the camera's X-axis (right in pixel space), *negative* numbers
correspond to moving the camera *up* from the horizontal plane, and vice-versa.
:at:`linewidth`: :at-val:`real, "1"`
This attribute specifies the line-width in the sense of OpenGL. It affects the rendering in wire-frame mode.
:at:`glow`: :at-val:`real, "0.3"`
The value of this attribute is added to the emission coefficient of all geoms attached to the selected body. As a
result, the selected body appears to glow.
:at:`offwidth`: :at-val:`int, "640"`
This and the next attribute specify the size in pixels of the off-screen OpenGL rendering buffer. This attribute
specifies the width of the buffer. The size of this buffer can also be adjusted at runtime, but it is usually more
convenient to set it in the XML.
:at:`offheight`: :at-val:`int, "480"`
This attribute specifies the height in pixels of the OpenGL off-screen rendering buffer.
.. _quality:
:el-prefix:`visual/` **quality** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element specifies settings that affect the quality of the rendering. Larger values result in higher quality but
possibly slower speed. Note that `simulate.cc <https://github.com/deepmind/mujoco/blob/main/sample/simulate.cc>`_
displays the frames per second (FPS). The target FPS is 60 Hz; if the number shown in the visualizer is substantially
lower, this means that the GPU is over-loaded and the visualization should somehow be simplified.
:at:`shadowsize`: :at-val:`int, "4096"`
This attribute specifies the size of the square texture used for shadow mapping. Higher values result is smoother
shadows. The size of the area over which a :ref:`light <light>` can cast shadows also affects smoothness, so these
settings should be adjusted jointly. The default here is somewhat conservative. Most modern GPUs are able to handle
significantly larger textures without slowing down.
:at:`offsamples`: :at-val:`int, "4"`
This attribute specifies the number of multi-samples for offscreen rendering. Larger values produce better
anti-aliasing but can slow down the GPU. Set this to 0 to disable multi-sampling. Note that this attribute only
affects offscreen rendering. For regular window rendering, multi-sampling is specified in an OS-dependent way when
the OpenGL context for the window is first created, and cannot be changed from within MuJoCo.
:at:`numslices`: :at-val:`int, "28"`
This and the next three attributes specify the density of internally-generated meshes for geometric primitives. Such
meshes are only used for rendering, while the collision detector works with the underlying analytic surfaces. This
value is passed to the various visualizer functions as the "slices" parameter as used in GLU. It specifies the number
of subdivisions around the Z-axis, similar to lines of longitude.
:at:`numstacks`: :at-val:`int, "16"`
This value of this attribute is passed to the various visualization functions as the "stacks" parameter as used in
GLU. It specifies the number of subdivisions along the Z-axis, similar to lines of latitude.
:at:`numquads`: :at-val:`int, "4"`
This attribute specifies the number of rectangles for rendering box faces, automatically-generated planes (as opposed
to geom planes which have an element-specific attribute with the same function), and sides of height fields. Even
though a geometrically correct rendering can be obtained by setting this value to 1, illumination works better for
larger values because we use per-vertex illumination (as opposed to per-fragment).
.. _headlight:
:el-prefix:`visual/` **headlight** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element is used to adjust the properties of the headlight. There is always a built-in headlight, in addition to any
lights explicitly defined in the model. The headlight is a directional light centered at the current camera and pointed
in the direction in which the camera is looking. It does not cast shadows (which would be invisible anyway). Note that
lights are additive, so if explicit lights are defined in the model, the intensity of the headlight would normally need
to be reduced.
:at:`ambient`: :at-val:`real(3), "0.1 0.1 0.1"`
The ambient component of the headlight, in the sense of OpenGL. The alpha component here and in the next two
attributes is set to 1 and cannot be adjusted.
:at:`diffuse`: :at-val:`real(3), "0.4 0.4 0.4"`
The diffuse component of the headlight, in the sense of OpenGL.
:at:`specular`: :at-val:`real(3), "0.5 0.5 0.5"`
The specular component of the headlight, in the sense of OpenGL.
:at:`active`: :at-val:`int, "1"`
This attribute enables and disables the headlight. A value of 0 means disabled, any other value means enabled.
.. _map:
:el-prefix:`visual/` **map** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element is used to specify scaling quantities that affect both the visualization and built-in mouse perturbations.
Unlike the scaling quantities in the next element which are specific to spatial extent, the quantities here are
miscellaneous.
:at:`stiffness`: :at-val:`real, "100"`
This attribute controls the strength of mouse perturbations. The internal perturbation mechanism simulates a
mass-spring-damper with critical damping, unit mass, and stiffness given here. Larger values mean that a larger force
will be applied for the same displacement between the selected body and the mouse-controlled target.
:at:`stiffnessrot`: :at-val:`real, "500"`
Same as above but applies to rotational perturbations rather than translational perturbations. Empirically, the
rotational stiffness needs to be larger in order for rotational mouse perturbations to have an effect.
:at:`force`: :at-val:`real, "0.005"`
This attributes controls the visualization of both contact forces and perturbation forces. The length of the rendered
force vector equals the force magnitude multiplied by the value of this attribute and divided by the mean body mass
for the model (see :ref:`statistic <statistic>` element below).
:at:`torque`: :at-val:`real, "0.1"`
Same as above, but controls the rendering of contact torque and perturbation torque rather than force (currently
disabled).
:at:`alpha`: :at-val:`real, "0.3"`
When transparency is turned on in the visualizer, the geoms attached to all moving bodies are made more transparent.
This is done by multiplying the geom-specific alpha values by this value.
:at:`fogstart`: :at-val:`real, "3"`
The visualizer can simulate linear fog, in the sense of OpenGL. The start position of the fog is the model extent
(see :ref:`statistic <statistic>` element below) multiplied by the value of this attribute.
:at:`fogend`: :at-val:`real, "10"`
The end position of the fog is the model extent multiplied by the value of this attribute.
:at:`znear`: :at-val:`real, "0.01"`
This and the next attribute determine the clipping planes of the OpenGL projection. The near clipping plane is
particularly important: setting it too close causes (often severe) loss of resolution in the depth buffer, while
setting it too far causes objects of interest to be clipped, making it impossible to zoom in. The distance to the
near clipping plane is the model extent multiplied by the value of this attribute.
:at:`zfar`: :at-val:`real, "50"`
The distance to the far clipping plane is the model extent multiplied by the value of this attribute.
:at:`haze`: :at-val:`real, "0.3"`
Proportion of the distance-to-horizon that is covered by haze (when haze rendering is enabled and a skybox is
present).
:at:`shadowclip`: :at-val:`real, "1"`
As mentioned above, shadow quality depends on the size of the shadow texture as well as the area where a given light
can cast shadows. For directional lights, the area would be infinite unless we limited it somehow. This attribute
specifies the limits, as +/- the model extent multiplied by the present value. These limits define a square in the
plane orthogonal to the light direction. If a shadow crosses the boundary of this virtual square, it will disappear
abruptly, revealing the edges of the square.
:at:`shadowscale`: :at-val:`real, "0.6"`
This attribute plays a similar role as the previous one, but applies to spotlights rather than directional lights.
Spotlights have a cutoff angle, limited internally to 80 deg. However this angle is often too large to obtain good
quality shadows, and it is necessary to limit the shadow to a smaller cone. The angle of the cone in which shadows
can be cast is the light cutoff multiplied by the present value.
:at:`actuatortendon`: :at-val:`real, "2"`
Ratio of actuator width to tendon width for rendering of actuators attached to tendons.
.. _scale:
:el-prefix:`visual/` **scale** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The settings in this element control the spatial extent of various decorative objects. In all cases, the rendered size
equals the mean body size (see :ref:`statistic <statistic>` element below) multiplied by the value of an attribute
documented below.
:at:`forcewidth`: :at-val:`real, "0.1"`
The radius of the arrows used to render contact forces and perturbation forces.
:at:`contactwidth`: :at-val:`real, "0.3"`
The radius of the cylinders used to render contact points. The normal direction of the cylinder is aligned with the
contact normal. Making the cylinder short and wide results in a "pancake" representation of the tangent plane.
:at:`contactheight`: :at-val:`real, "0.1"`
The height of the cylinders used to render contact points.
:at:`connect`: :at-val:`real, "0.2"`
The radius of the capsules used to connect bodies and joints, resulting in an automatically generated skeleton.
:at:`com`: :at-val:`real, "0.4"`
The radius of the spheres used to render the centers of mass of kinematic sub-trees.
:at:`camera`: :at-val:`real, "0.3"`
The size of the decorative object used to represent model cameras in the rendering.
:at:`light`: :at-val:`real, "0.3"`
The size of the decorative object used to represent model lights in the rendering.
:at:`selectpoint`: :at-val:`real, "0.2"`
The radius of the sphere used to render the selection point (i.e., the point where the user left-double-clicked to
select a body). Note that the local and global coordinates of this point can be printed in the 3D view by activating
the corresponding rendering flags. In this way, the coordinates of points of interest can be found.
:at:`jointlength`: :at-val:`real, "1.0"`
The length of the arrows used to render joint axes.
:at:`jointwidth`: :at-val:`real, "0.1"`
The radius of the arrows used to render joint axes.
:at:`actuatorlength`: :at-val:`real, "0.7"`
The length of the arrows used to render actuators acting on scalar joints only.
:at:`actuatorwidth`: :at-val:`real, "0.2"`
The radius of the arrows used to render actuators acting on scalar joints only.
:at:`framelength`: :at-val:`real, "1.0"`
The length of the cylinders used to render coordinate frames. The world frame is automatically scaled relative to
this setting.
:at:`framewidth`: :at-val:`real, "0.1"`
The radius of the cylinders used to render coordinate frames.
:at:`constraint`: :at-val:`real, "0.1"`
The radius of the capsules used to render violations in spatial constraints.
:at:`slidercrank`: :at-val:`real, "0.2"`
The radius of the capsules used to render slider-crank mechanisms. The second part of the mechanism is automatically
scaled relative to this setting.
.. _rgba:
:el-prefix:`visual/` **rgba** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The settings in this element control the color and transparency (rgba) of various decorative objects. We will call this
combined attribute "color" to simplify terminology below. All values should be in the range [0 1]. An alpha value of 0
disables the rendering of the corresponding object.
:at:`fog`: :at-val:`real(4), "0 0 0 1"`
When fog is enabled, the color of all pixels fades towards the color specified here. The spatial extent of the fading
is controlled by the fogstart and fogend attributes of the :ref:`map <map>` element above.
:at:`haze`: :at-val:`real(4), "1 1 1 1"`
Haze color at the horizon, used to transition between an infinite plane and a skybox smoothly. The default creates
white haze. To create a seamless transition, make sure the skybox colors near the horizon are similar to the plane
color/texture, and set the haze color somewhere in that color gamut.
:at:`force`: :at-val:`real(4), "1 0.5 0.5 1"`
Color of the arrows used to render perturbation forces.
:at:`inertia`: :at-val:`real(4), "0.8 0.2 0.2 0.6"`
Color of the boxes used to render equivalent body inertias. This is the only rgba setting that has transparency by
default, because it is usually desirable to see the geoms inside the inertia box.
:at:`joint`: :at-val:`real(4), "0.2 0.6 0.8 1"`
Color of the arrows used to render joint axes.
:at:`actuator`: :at-val:`real(4), "0.2 0.25 0.2 1"`
Actuator color for neutral value of the control.
:at:`actuatornegative`: :at-val:`real(4), "0.2 0.6 0.9 1"`
Actuator color for most negative value of the control.
:at:`actuatorpositive`: :at-val:`real(4), "0.9 0.4 0.2 1"`
Actuator color for most positive value of the control.
:at:`com`: :at-val:`real(4), "0.9 0.9 0.9 1"`
Color of the spheres used to render sub-tree centers of mass.
:at:`camera`: :at-val:`real(4), "0.6 0.9 0.6 1"`
Color of the decorative object used to represent model cameras in the rendering.
:at:`light`: :at-val:`real(4), "0.6 0.6 0.9 1"`
Color of the decorative object used to represent model lights in the rendering.
:at:`selectpoint`: :at-val:`real(4), "0.9 0.9 0.1 1"`
Color of the sphere used to render the selection point.
:at:`connect`: :at-val:`real(4), "0.2 0.2 0.8 1"`
Color of the capsules used to connect bodies and joints, resulting in an automatically generated skeleton.
:at:`contactpoint`: :at-val:`real(4), "0.9 0.6 0.2 1"`
Color of the cylinders used to render contact points.
:at:`contactforce`: :at-val:`real(4), "0.7 0.9 0.9 1"`
Color of the arrows used to render contact forces. When splitting of contact forces into normal and tangential
components is enabled, this color is used to render the normal components.
:at:`contactfriction`: :at-val:`real(4), "0.9 0.8 0.4 1"`
Color of the arrows used to render contact tangential forces, only when splitting is enabled.
:at:`contacttorque`: :at-val:`real(4), "0.9 0.7 0.9 1"`
Color of the arrows used to render contact torques (currently disabled).
:at:`contactgap`: :at-val:`real(4), "0.5, 0.8, 0.9, 1"`
Color of contacts that fall in the contact gap (and are thereby excluded from contact force computations).
:at:`rangefinder`: :at-val:`real(4), "1 1 0.1 1"`
Color of line geoms used to render rangefinder sensors.
:at:`constraint`: :at-val:`real(4), "0.9 0 0 1"`
Color of the capsules corresponding to spatial constraint violations.
:at:`slidercrank`: :at-val:`real(4), "0.5 0.3 0.8 1"`
Color of slider-crank mechanisms.
:at:`crankbroken`: :at-val:`real(4), "0.9 0 0 1"`
Color used to render the crank of slide-crank mechanisms, in model configurations where the specified rod length
cannot be maintained, i.e., it is "broken".
.. _statistic:
**statistic** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This element is used to override model statistics computed by the compiler. These statistics are not only informational
but are also used to scale various components of the rendering and perturbation. We provide an override mechanism in the
XML because it is sometimes easier to adjust a small number of model statistics than a larger number of visual
parameters.
:at:`meanmass`: :at-val:`real, optional`
If this attribute is specified, it replaces the value of mjModel.stat.meanmass computed by the compiler. The computed
value is the average body mass, not counting the massless world body. At runtime this value scales the perturbation
force.
:at:`meaninertia`: :at-val:`real, optional`
If this attribute is specified, it replaces the value of mjModel.stat.meaninertia computed by the compiler. The
computed value is the average diagonal element of the joint-space inertia matrix when the model is in qpos0. At
runtime this value scales the solver cost and gradient used for early termination.
:at:`meansize`: :at-val:`real, optional`
If this attribute is specified, it replaces the value of ``mjModel.stat.meansize`` computed by the compiler. At
runtime this value multiplies the attributes of the :ref:`scale <scale>` element above, and acts as their length
unit. If specific lengths are desired, it can be convenient to set :at:`meansize` to a round number like 1 or 0.01 so
that :ref:`scale <scale>` values are in recognized length units. This is the only semantic of :at:`meansize` and
setting it has no other side-effect. The automatically computed value is heuristic, representing the average body
radius. The heuristic is based on geom sizes when present, the distances between joints when present, and the sizes
of the body equivalent inertia boxes.
:at:`extent`: :at-val:`real, optional`
If this attribute is specified, it replaces the value of mjModel.stat.extent computed by the compiler. The computed
value is half the side of the bounding box of the model in the initial configuration. At runtime this value is
multiplied by some of the attributes of the :ref:`map <map>` element above. When the model is first loaded, the free
camera's initial distance from the :at:`center` (see below) is 1.5 times the :at:`extent`.
:at:`center`: :at-val:`real(3), optional`
If this attribute is specified, it replaces the value of mjModel.stat.center computed by the compiler. The computed
value is the center of the bounding box of the entire model in the initial configuration. This 3D vector is used to
center the view of the free camera when the model is first loaded.
.. _default:
**default** (R)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This element is used to create a new defaults class; see :ref:`CDefault` above. Defaults classes can be nested,
inheriting all attribute values from their parent. The top-level defaults class is always defined; it is called "main"
if omitted.
:at:`class`: :at-val:`string, required (except at the top level)`
The name of the defaults class. It must be unique among all defaults classes. This name is used to make the class
active when creating an actual model element.
.. _default-mesh:
:el-prefix:`default/` **mesh** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`mesh <mesh>` element of the defaults class.
| The only mesh attribute available here is: **scale**.
.. _default-material:
:el-prefix:`default/` **material** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`material <material>` element of the defaults class.
| All material attributes are available here except: name, class.
.. _default-joint:
:el-prefix:`default/` **joint** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`joint <joint>` element of the defaults class.
| All joint attributes are available here except: name, class.
.. _default-geom:
:el-prefix:`default/` **geom** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`geom <geom>` element of the defaults class.
| All geom attributes are available here except: name, class.
.. _default-site:
:el-prefix:`default/` **site** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`site <site>` element of the defaults class.
| All site attributes are available here except: name, class.
.. _default-camera:
:el-prefix:`default/` **camera** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`camera <camera>` element of the defaults class.
| All camera attributes are available here except: name, class.
.. _default-light:
:el-prefix:`default/` **light** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`light <light>` element of the defaults class.
| All light attributes are available here except: name, class.
.. _default-pair:
:el-prefix:`default/` **pair** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`pair <pair>` element of the defaults class.
| All pair attributes are available here except: name, class, geom1, geom2.
.. _default-equality:
:el-prefix:`default/` **equality** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`equality <equality>` element of the defaults class. The actual
equality constraints have types depending on the sub-element used to define them. However here we are setting
attributes common to all equality constraint types, which is why we do not make a distinction between types.
| The equality sub-element attributes available here are: **active, solref, solimp**.
.. _default-tendon:
:el-prefix:`default/` **tendon** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`tendon <tendon>` element of the defaults class. Similar to
equality constraints, the actual tendons have types, but here we are setting attributes common to all types.
| All tendon sub-element attributes are available here except: name, class.
.. _default-general:
:el-prefix:`default/` **general** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element sets the attributes of the dummy :ref:`general <general>` element of the defaults class.
| All general attributes are available here except: name, class, joint, jointinparent, site, tendon, slidersite,
cranksite.
.. _default-motor:
:el-prefix:`default/` **motor** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This and the next three elements set the attributes of the :ref:`general <general>` element using :ref:`Actuator
shortcuts <CActuator>`. It does not make sense to use more than one such shortcut in the same defaults
class, because they set the same underlying attributes, replacing any previous settings.
| All :ref:`motor <motor>` attributes are available here except: name, class, joint, jointinparent, site, tendon,
slidersite, cranksite.
.. _default-position:
:el-prefix:`default/` **position** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All :ref:`position <position>` attributes are available here except: name, class, joint, jointinparent, site, tendon,
slidersite, cranksite.
.. _default-velocity:
:el-prefix:`default/` **velocity** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All :ref:`velocity <velocity>` attributes are available here except: name, class, joint, jointinparent, site, tendon,
slidersite, cranksite.
.. _default-intvelocity:
:el-prefix:`default/` **intvelocity** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All :ref:`intvelocity <intvelocity>` attributes are available here except: name, class, joint, jointinparent, site, tendon,
slidersite, cranksite.
.. _default-damper:
:el-prefix:`default/` **damper** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All :ref:`damper <damper>` attributes are available here except: name, class, joint, jointinparent, site, tendon,
slidersite, cranksite.
.. _default-cylinder:
:el-prefix:`default/` **cylinder** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All :ref:`cylinder <cylinder>` attributes are available here except: name, class, joint, jointinparent, site, tendon,
slidersite, cranksite.
.. _default-muscle:
:el-prefix:`default/` **muscle** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All :ref:`muscle <muscle>` attributes are available here except: name, class, joint, jointinparent, site, tendon,
slidersite, cranksite.
:el-prefix:`default/` **adhesion** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All :ref:`adhesion <adhesion>` attributes are available here except: name, class, body.
.. _custom:
**custom** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a grouping element for custom numeric and text elements. It does not have attributes.
.. _numeric:
:el-prefix:`custom/` **numeric** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a custom numeric array in mjModel.
:at:`name`: :at-val:`string, required`
The name of the array. This attribute is required because the only way to find a custom element of interest at
runtime is through its name.
:at:`size`: :at-val:`int, optional`
If specified this attribute sets the size of the data array, in doubles. If this attribute is not specified, the size
will be inferred from the actual data array below.
:at:`data`: :at-val:`real(size), "0 0 ..."`
Numeric data to be copied into mjModel. If size is specified, the length of the array given here cannot exceed the
specified size. If the length of the array is smaller, the missing components are set to 0. Note that custom arrays
can be created for storing information at runtime - which is why data initialization is optional. It becomes required
only when the array size is omitted.
.. _text:
:el-prefix:`custom/` **text** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a custom text field in mjModel. It could be used to store keyword commands for user callbacks and
other custom computations.
:at:`name`: :at-val:`string, required`
Name of the custom text field.
:at:`data`: :at-val:`string, required`
Custom text to be copied into mjModel.
.. _tuple:
:el-prefix:`custom/` **tuple** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a custom tuple, which is a list of MuJoCo objects. The list is created by referencing the desired
objects by name.
:at:`name`: :at-val:`string, required`
Name of the custom tuple.
.. _tupleelement:
:el-prefix:`custom/tuple/` **element** (*)
''''''''''''''''''''''''''''''''''''''''''
This adds an element to the tuple.
:at:`objtype`: :at-val:`(any element type that can be named), required`
Type of the object being added.
:at:`objname`: :at-val:`string, required`
Name of the object being added. The type and name must reference a named MuJoCo element defined somewhere in the
model. Tuples can also be referenced (including self-references).
:at:`prm`: :at-val:`real, "0"`
Real-valued parameter associated with this element of the tuple. Its use is up to the user.
.. _asset:
**asset** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a grouping element for defining assets. It does not have attributes. Assets are created in the model so that
they can be referenced from other model elements; recall the discussion of :ref:`Assets <Assets>` in the Overview
chapter.
.. _texture:
:el-prefix:`asset/` **texture** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| This element creates a texture asset, which is then referenced from a :ref:`material <material>` asset, which is
finally referenced from a model element that needs to be textured. MuJoCo provides access to the texture mapping
mechanism in OpenGL. Texture coordinates are generated automatically in GL_OBJECT_PLANE mode, using either 2D or cube
mapping. MIP maps are always enabled in GL_LINEAR_MIPMAP_LINEAR mode. The texture color is combined with the object
color in GL_MODULATE mode. The texture data can be loaded from PNG files, with provisions for loading cube and skybox
textures. Alternatively the data can be generated by the compiler as a procedural texture. Because different texture
types require different parameters, only a subset of the attributes below are used for any given texture.
| MuJoCo 2.0 introduced a second file format for loading textures, in addition to PNG. If the file name extension is
different from .png or .PNG, MuJoCo assumes that the texture is in the new format. This is a custom binary file
format, containing the following data:
.. code:: Text
(int32) width
(int32) height
(byte) rgb_data[3*width*height]
:at:`name`: :at-val:`string, optional`
As with all other assets, a texture must have a name in order to be referenced. However if the texture is loaded from
a single file with the file attribute, the explicit name can be omitted and the file name (without the path and
extension) becomes the texture name. If the name after parsing is empty and the texture type is not "skybox", the
compiler will generate an error.
:at:`type`: :at-val:`[2d, cube, skybox], "cube"`
This attribute determines how the texture is represented and mapped to objects. It also determines which of the
remaining attributes are relevant. The keywords have the following meaning:
The **cube** type is the most common. It has the effect of shrink-wrapping a texture cube over an object. Apart from
the adjustment provided by the texuniform attribute of :ref:`material <material>`, the process is automatic.
Internally the GPU constructs a ray from the center of the object to each pixel (or rather fragment), finds the
intersection of this ray with the cube surface (the cube and the object have the same center), and uses the
corresponding texture color. The six square images defining the cube can be the same or different; if they are the
same, only one copy is stored in mjModel. There are four mechanisms for specifying the texture data:
#. Single file (PNG or custom) specified with the file attribute, containing a square image which is repeated on each
side of the cube. This is the most common approach. If for example the goal is to create the appearance of wood,
repeating the same image on all sides is sufficient.
#. Single file containing a composite image from which the six squares are extracted by the compiler. The layout of
the composite image is determined by the gridsize and gridlayout attributes.
#. Six separate files specified with the attributes fileright, fileleft etc, each containing one square image.
#. Procedural texture generated internally. The type of procedural texture is determined by the builtin attribute.
The texture data also depends on a number of parameters documented below.
The **skybox** type is very similar to cube mapping, and in fact the texture data is specified in exactly the same
way. The only difference is that the visualizer uses the first such texture defined in the model to render a skybox.
This is a large box centered at the camera and always moving with it, with size determined automatically from the far
clipping plane. The idea is that images on the skybox appear stationary, as if they are infinitely far away. If such
a texture is referenced from a material applied to a regular object, the effect is equivalent to a cube map. Note
however that the images suitable for skyboxes are rarely suitable for texturing objects.
The **2d** type may be the most familiar to users, however it is only suitable for planes and height fields. This is
because the texture coordinate generator is trying to map a 2D image to 3D space, and as a result there are entire
curves on the object surface that correspond to the same texture pixel. For a box geom for example, the two faces
whose normals are aligned with the Z axis of the local frame appear normal, while the other four faces appear
stretched. For planes this is not an issue because the plane is always normal to the local Z axis. For height fields
the sides enclosing the terrain map appear stretched, but in that case the effect is actually desirable. 2d textures
can be rectangular, unlike the sides of cube textures which must be square. The scaling can be controlled with the
texrepeat attribute of :ref:`material <material>`. The data can be loaded from a singlefile or created procedurally.
:at:`file`: :at-val:`string, optional`
If this attribute is specified, and the builtin attribute below is set to "none", the texture data is loaded from a
single file. See the texturedir attribute of :ref:`compiler <compiler>` regarding the file path.
:at:`gridsize`: :at-val:`int(2), "1 1"`
When a cube or skybox texture is loaded from a single file, this attribute and the next specify how the six square
sides of the texture cube are obtained from the single image. The default setting "1 1" means that the same image is
repeated on all sides of the cube. Otherwise the image is interpreted as a grid from which the six sides are
extracted. The two integers here correspond to the number of rows and columns in the grid. Each integer must be
positive and the product of the two cannot exceed 12. The number of rows and columns in the image must be integer
multiples of the number of rows and columns in the grid, and these two multiples must be equal, so that the extracted
images are square.
:at:`gridlayout`: :at-val:`string, "............"`
.. figure:: images/modeling/skybox.png
:width: 250px
:align: right
When a cube or skybox texture is loaded from a single file, and the grid size is different from "1 1", this attribute
specifies which grid cells are used and which side of the cube they correspond to. There are many skybox textures
available online as composite images, but they do not use the same convention, which is why we have designed a
flexible mechanism for decoding them. The string specified here must be composed of characters from the set {'.',
'R', 'L', 'U', 'D', 'F', 'B'}. The number of characters must equal the product of the two grid sizes. The grid is
scanned in row-major order. The '.' character denotes an unused cell. The other characters are the first letters of
Right, Left, Up, Down, Front, Back; see below for coordinate frame description. If the symbol for a given side
appears more than once, the last definition is used. If a given side is omitted, it is filled with the color
specified by the rgb1 attribute. For example, the desert landscape below can be loaded as a skybox or a cube map
using gridsize = "3 4" and gridlayout = ".U..LFRB.D.." The full-resolution image file without the markings can be
downloaded `here <_static/desert.png>`__.
:at:`fileright`, :at:`fileleft`, :at:`fileup`, :at:`filedown`, :at:`filefront`, :at:`fileback` : string, optional
These attributes are used to load the six sides of a cube or skybox texture from separate files, but only if the file
attribute is omitted and the builtin attribute is set to "none". If any one of these attributes are omitted, the
corresponding side is filled with the color specified by the rgb1 attribute. The coordinate frame here is unusual.
When a skybox is viewed with the default free camera in its initial configuration, the Right, Left, Up, Down sides
appear where one would expect them. The Back side appears in front of the viewer, because the viewer is in the middle
of the box and is facing its back. There is however a complication. In MuJoCo the +Z axis points up, while existing
skybox textures (which are non-trivial to design) tend to assume that the +Y axis points up. Changing coordinates
cannot be done by merely renaming files; instead one would have to transpose and/or mirror some of the images. To
avoid this complication, we render the skybox rotated by 90 deg around the +X axis, in violation of our convention.
However we cannot do the same for regular objects. Thus the mapping of skybox and cube textures on regular objects,
expressed in the local frame of the object, is as follows:
Right = +X, Left = -X, Up = +Y, Down = -Y, Front = +Z, Back = -Z.
:at:`builtin`: :at-val:`[none, gradient, checker, flat], "none"`
This and the remaining attributes control the generation of procedural textures. If the value of this attribute is
different from "none", the texture is treated as procedural and any file names are ignored. The keywords have the
following meaning:
The **gradient** type generates a color gradient from rgb1 to rgb2. The interpolation in color space is done through
a sigmoid function. For cube and skybox textures the gradient is along the +Y axis, i.e., from top to bottom for
skybox rendering.
The **checker** type generates a 2-by-2 checker pattern with alternating colors given by rgb1 to rgb2. This is
suitable for rendering ground planes and also for marking objects with rotational symmetries. Note that 2d textures
can be scaled so as to repeat the pattern as many times as necessary. For cube and skybox textures, the checker
pattern is painted on each side of the cube.
The **flat** type fills the entire texture with rgb1, except for the bottom face of cube and skybox textures which is
filled with rgb2.
:at:`rgb1`: :at-val:`real(3), "0.8 0.8 0.8"`
The first color used for procedural texture generation. This color is also used to fill missing sides of cube and
skybox textures loaded from files. The components of this and all other RGB(A) vectors should be in the range [0 1].
:at:`rgb2`: :at-val:`real(3), "0.5 0.5 0.5"`
The second color used for procedural texture generation.
:at:`mark`: :at-val:`[none, edge, cross, random], "none"`
Procedural textures can be marked with the markrgb color, on top of the colors determined by the builtin type. "edge"
means that the edges of all texture images are marked. "cross" means that a cross is marked in the middle of each
image. "random" means that randomly chosen pixels are marked. All markings are one-pixel wide, thus the markings
appear larger and more diffuse on smaller textures.
:at:`markrgb`: :at-val:`real(3), "0 0 0"`
The color used for procedural texture markings.
:at:`random`: :at-val:`real, "0.01"`
When the mark attribute is set to "random", this attribute determines the probability of turning on each pixel. Note
that larger textures have more pixels, and the probability here is applied independently to each pixel - thus the
texture size and probability need to be adjusted jointly. Together with a gradient skybox texture, this can create
the appearance of a night sky with stars.
:at:`width`: :at-val:`int, "0"`
The width of the procedural texture, i.e., the number of columns in the image. For cube and skybox procedural
textures the width and height must be equal. Larger values usually result in higher quality images, although in some
cases (e.g. checker patterns) small values are sufficient.
:at:`height`: :at-val:`int, "0"`
The height of the procedural texture, i.e., the number of rows in the image.
:at:`hflip`: :at-val:`[false, true], "false"`
If true, images loaded from file are flipped in the horizontal direction. Does not affect procedural textures.
:at:`vflip`: :at-val:`[false, true], "false"`
If true, images loaded from file are flipped in the vertical direction. Does not affect procedural textures.
.. _hfield:
:el-prefix:`asset/` **hfield** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a height field asset, which can then be referenced from geoms with type "hfield". A height field,
also known as terrain map, is a 2D matrix of elevation data. The data can be specified in one of three ways:
#. The elevation data can be loaded from a PNG file. The image is converted internally to gray scale, and the intensity
of each pixel is used to define elevation; white is high and black is low.
#. The elevation data can be loaded from a binary file in the custom format described below. As with all other matrices
used in MuJoCo, the data ordering is row-major, like pixels in an image. If the data size is nrow-by-ncol, the file
must have 4*(2+nrow*ncol) bytes:
::
(int32) nrow
(int32) ncol
(float32) data[nrow*ncol]
#. The elevation data can be left undefined at compile time. This is done by specifying the attributes nrow and ncol.
The compiler allocates space for the height field data in mjModel and sets it to 0. The user can then generate a
custom height field at runtime, either programmatically or using sensor data.
| Regardless of which method is used to specify the elevation data, the compiler always normalizes it to the range [0
1]. However if the data is left undefined at compile time and generated later at runtime, it is the user's
responsibility to normalize it.
| The position and orientation of the height field is determined by the geom that references it. The spatial extent on
the other hand is specified by the height field asset itself via the size attribute, and cannot be modified by the
referencing geom (the geom size parameters are ignored in this case). The same approach is used for meshes below:
positioning is done by the geom while sizing is done by the asset. This is because height fields and meshes involve
sizing operations that are not common to other geoms.
| For collision detection, a height field is treated as a union of triangular prisms. Collisions between height fields
and other geoms (except for planes and other height fields which are not supported) are computed by first selecting
the sub-grid of prisms that could collide with the geom based on its bounding box, and then using the general convex
collider. The number of possible contacts between a height field and a geom is limited to 9; any contacts beyond that
are discarded. To avoid penetration due to discarded contacts, the spatial features of the height field should be
large compared to the geoms it collides with.
:at:`name`: :at-val:`string, optional`
Name of the height field, used for referencing. If the name is omitted and a file name is specified, the height field
name equals the file name without the path and extension.
:at:`file`: :at-val:`string, optional`
If this attribute is specified, the elevation data is loaded from the given file. If the file extension is ".png",
not case-sensitive, the file is treated as a PNG file. Otherwise it is treated as a binary file in the above custom
format. The number of rows and columns in the data are determined from the file contents. Loading data from a file
and setting nrow or ncol below to non-zero values results is compile error, even if these settings are consistent
with the file contents.
:at:`nrow`: :at-val:`int, "0"`
This attribute and the next are used to allocate a height field in mjModel and leave the elevation data undefined
(i.e., set to 0). This attribute specifies the number of rows in the elevation data matrix. The default value of 0
means that the data will be loaded from a file, which will be used to infer the size of the matrix.
:at:`ncol`: :at-val:`int, "0"`
This attribute specifies the number of columns in the elevation data matrix.
:at:`size`: :at-val:`real(4), required`
.. figure:: images/modeling/peaks.png
:width: 350px
:align: right
The four numbers here are (radius_x, radius_y, elevation_z, base_z). The height field is centered at the referencing
geom's local frame. Elevation is in the +Z direction. The first two numbers specify the X and Y extent (or "radius")
of the rectangle over which the height field is defined. This may seem unnatural for rectangles, but it is natural
for spheres and other geom types, and we prefer to use the same convention throughout the model. The third number is
the maximum elevation; it scales the elevation data which is normalized to [0-1]. Thus the minimum elevation point is
at Z=0 and the maximum elevation point is at Z=elevation_z. The last number is the depth of a box in the -Z direction
serving as a "base" for the height field. Without this automatically generated box, the height field would have zero
thickness at places there the normalized elevation data is zero. Unlike planes which impose global unilateral
constraints, height fields are treated as unions of regular geoms, so there is no notion of being "under" the height
field. Instead a geom is either inside or outside the height field - which is why the inside part must have non-zero
thickness. The example on the right is the MATLAB "peaks" surface saved in our custom height field format, and loaded
as an asset with size = "1 1 1 0.1". The horizontal size of the box is 2, the difference between the maximum and
minimum elevation is 1, and the depth of the base added below the minimum elevation point is 0.1.
.. _mesh:
:el-prefix:`asset/` **mesh** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a mesh asset, which can then be referenced from geoms. If the referencing geom type is
:at-val:`mesh` the mesh is instantiated in the model, otherwise a geometric primitive is automatically fitted to it; see
the :ref:`geom <geom>` element below.
MuJoCo works with triangulated meshes. They can be loaded from binary STL files, OBJ files or MSH files with custom
format described below, or vertex and face data specified directly in the XML. Software such as MeshLab can be used to
convert from other mesh formats to STL or OBJ. While any collection of triangles can be loaded as a mesh and rendered,
collision detection works with the convex hull of the mesh as explained in :ref:`Collision`. See also the convexhull
attribute of the :ref:`compiler <compiler>` element which controls the automatic generation of convex hulls. The mesh
appearance (including texture mapping) is controlled by the :at:`material` and :at:`rgba` attributes of the referencing
geom, similarly to height fields.
Starting with MuJoCo 2.0, meshes can have explicit texture coordinates instead of relying on the automated texture
mapping mechanism. When provided, these explicit coordinates have priority. Note that texture coordinates can be
specified with OBJ files and MSH files, as well as explicitly in the XML with the :at:`texcoord` attribute, but not via
STL files. These mechanism cannot be mixed. So if you have an STL mesh, the only way to add texture coordinates to it is
to convert to one of the other supported formats.
MSH file format
The binary MSH file starts with 4 integers specifying the number of vertex positions (nvertex), vertex normals
(nnormal), vertex texture coordinates (ntexcoord), and vertex indices making up the faces (nface), followed by the
numeric data. nvertex must be at least 4. nnormal and ntexcoord can be zero (in which case the corresponding data is
not defined) or equal to nvertex. nface can also be zero, in which case faces are constructed automatically from the
convex hull of the vertex positions. The file size in bytes must be exactly: 16 + 12*(nvertex + nnormal + nface) +
8*ntexcoord. The contents of the file must be as follows:
.. code:: Text
(int32) nvertex
(int32) nnormal
(int32) ntexcoord
(int32) nface
(float) vertex_positions[3*nvertex]
(float) vertex_normals[3*nnormal]
(float) vertex_texcoords[2*ntexcoord]
(int32) face_vertex_indices[3*nface]
Poorly designed meshes can display rendering artifacts. In particular, the shadow mapping mechanism relies on having
some distance between front and back-facing triangle faces. If the faces are repeated, with opposite normals as
determined by the vertex order in each triangle, this causes shadow aliasing. The solution is to remove the repeated
faces (which can be done in MeshLab) or use a better designed mesh. Flipped faces are checked by MuJoCo for meshes specified as OBJ or XML and an error message is returned.
The size of the mesh is determined by the 3D coordinates of the vertex data in the mesh file, multiplied by the
components of the :at:`scale` attribute below. Scaling is applied separately for each coordinate axis. Note that
negative scaling values can be used to flip the mesh; this is a legitimate operation. The size parameters of the
referening geoms are ignored, similarly to height fields. As of MuJoCo 2.0 we also provide a mechanism to translate and
rotate the 3D coordinates, using the attributes refpos and refquat.
Another new feature in MuJoCo 2.0 is that a mesh can be defined without faces (a point cloud essentially). In that case
the convex hull is constructed automatically, even if the compiler attribute convexhull is false. This makes it easy to
construct simple shapes directly in the XML. For example, a pyramid can be created as:
.. code-block:: xml
<asset>
<mesh name="pyramid" vertex="0 0 0 1 0 0 0 1 0 0 0 1"/>
</asset>
Positioning and orienting is complicated by the fact that vertex data are often designed relative to coordinate frames
whose origin is not inside the mesh. In contrast, MuJoCo expects the origin of a geom's local frame to coincide with the
geometric center of the shape. We resolve this discrepancy by pre-processing the mesh in the compiler, so that it is
centered around (0,0,0) and its principal axes of inertia are the coordinate axes. We also save the translation and
rotation offsets needed to achieve such alignment. These offsets are then applied to the referencing geom's position and
orientation; see also :at:`mesh` attribute of :ref:`geom <geom>` below. Fortunately most meshes used in robot models are
designed in a coordinate frame centered at the joint. This makes the corresponding MJCF model intuitive: we set the body
frame at the joint, so that the joint position is (0,0,0) in the body frame, and simply reference the mesh. Below is an
MJCF model fragment of a forearm, containing all the information needed to put the mesh where one would expect it to be.
The body position is specified relative to the parent body, namely the upper arm (not shown). It is offset by 35 cm
which is the typical length of the human upper arm. If the mesh vertex data were not designed in the above convention,
we would have to use the geom position and orientation (or the new refpos, refquat mechanism) to compensate, but in
practice this is rarely needed.
.. code-block:: xml
<asset>
<mesh file="forearm.stl"/>
</asset>
<body pos="0 0 0.35"/>
<joint type="hinge" axis="1 0 0"/>
<geom type="mesh" mesh="forearm"/>
</body>
The inertial computation mentioned above is part of an algorithm used not only to center and align the mesh, but also
to infer the mass and inertia of the body to which it is attached. This is done by computing the centroid of the
triangle faces, connecting each face with the centroid to form a triangular pyramid, computing the mass and signed inertia of all pyramids (considered solid or hollow if :at:`shellinertia` is true) and accumulating them. The sign ensures that pyramids on the outside of the surfaces are subtracted, as it can occur with concave geometries. This algorithm can be found in section 1.3.8 of Computational Geometry in C (Second Edition) by Joseph O'Rourke.
The full list of processing steps applied by the compiler to each mesh is as follows:
#. For STL meshes, remove any repeated vertices and re-index the faces if needed. If the mesh is not STL, we assume that
the desired vertices and faces have already been generated and do not apply removal or re-indexing;
#. If vertex normals are not provided, generate normals automatically, using a weighted average of the surrounding face
normals. If sharp edges are encountered, the renderer uses the face normals to preserve the visual information about
the edge, unless smoothnormal is true. Note that normals cannot be provided with STL meshes;
#. Scale, translate and rotate the vertices and normals, re-normalize the normals in case of scaling;
#. Construct the convex hull if specified;
#. Find the centroid of all triangle faces, and construct the union-of-pyramids representation. Triangles whose area is
too small (below the :ref:`mjMINVAL <glNumeric>` value of 1E-14) result in compile error;
#. Compute the center of mass and inertia matrix of the union-of-pyramids. Use eigenvalue decomposition to find the
principal axes of inertia. Center and align the mesh, saving the translational and rotational offsets for subsequent
geom-related computations.
:at:`name`: :at-val:`string, optional`
Name of the mesh, used for referencing. If omitted, the mesh name equals the file name without the path and
extension.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes (only scale in this case).
:at:`file`: :at-val:`string, optional`
The file from which the mesh will be loaded. The path is determined as described in the meshdir attribute of
:ref:`compiler <compiler>`. The file extension must be "stl" or "msh" (not case sensitive) specifying the file type.
If the file name is omitted, the vertex attribute becomes required.
:at:`scale`: :at-val:`real(3), "1 1 1"`
This attribute specifies the scaling that will be applied to the vertex data along each coordinate axis. Negative
values are allowed, resulting in flipping the mesh along the corresponding axis.
:at:`smoothnormal`: :at-val:`[false, true], "false"`
Controls the automatic generation of vertex normals when normals are not given explicitly. If true, smooth normals
are generated by averaging the face normals at each vertex, with weight proportional to the face area. If false,
faces at large angles relative to the average normal are excluded from the average. In this way, sharp edges (as in
cube edges) are not smoothed.
:at:`vertex`: :at-val:`real(3*nvert), optional`
Vertex 3D position data. You can specify position data in the XML using this attribute, or using a binary file, but
not both.
:at:`normal`: :at-val:`real(3*nvert), optional`
Vertex 3D normal data. If specified, the number of normals must equal the number of vertices. The model compiler
normalizes the normals automatically.
:at:`texcoord`: :at-val:`real(2*nvert), optional`
Vertex 2D texture coordinates, which are numbers between 0 and 1. If specified, the number of texture coordinate
pairs must equal the number of vertices.
:at:`face`: :at-val:`int(3*nface), optional`
Faces of the mesh. Each face is a sequence of 3 vertex indices, in counter-clockwise order. The indices must be
integers between 0 and nvert-1.
:at:`refpos`: :at-val:`real(3), "0 0 0"`
Reference position relative to which the 3D vertex coordinates are defined. This vector is subtracted from the
positions.
:at:`refquat`: :at-val:`real(4), "1 0 0 0"`
Reference orientation relative to which the 3D vertex coordinates and normals are defined. The conjugate of this
quaternion is used to rotate the positions and normals. The model compiler normalizes the quaternion automatically.
.. _skin:
:el-prefix:`asset/` **skin** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Skinned meshes (or skins) were added in MuJoCo 2.0. These are deformable meshes whose vertex positions and normals are
computed each time the model is rendered. MuJoCo skins are only used for visualization and do not affect the physics
in any way. In particular, collisions involve the geoms of the bodies to which the skin is attached, and not the skin
itself. Unlike regular meshes which are referenced from geoms and participate in collisions, the skin is not
referenced from anywhere else in the model. It is a stand-alone asset that is used by renderer and not by the
simulator.
The skin has vertex positions and normals updated at runtime, and triangle faces and optional texture coordinates
which are predefined. It also has "bones" used for updating. Bones are regular MuJoCo bodies referenced with the
:el:`bone` subelement. Each bone has a list of vertex indices and corresponding real-valued weights which specify how
much the bone position and orientation influence the corresponding vertex. The vertex has local coordinates with
respect to every bone that influences it. The local coordinates are computed by the model compiler, given global
vertex coordinates and global bind poses for each body. The bind poses do not have to correspond to the model
reference configuration qpos0. Note that the vertex positions and bone bind poses provided in the skin definition are
always global, even if the model itself is defined in local coordinates.
At runtime the local coordinates of each vertex with respect to each bone that influences it are converted to global
coordinates, and averaged in proportion to the corresponding weights to obtain a single set of 3D coordinates for each
vertex. Normals then are computed automatically given the resulting global vertex positions and face information.
Finally, the skin can be inflated by applying an offset to each vertex position along its (computed) normal.
Skins are one-sided for rendering purposes; this is because back-face culling is needed to avoid shading and aliasing
artifacts. When the skin is a closed 3D shape this does not matter because the back sides cannot be seen. But if the
skin is a 2D object, we have to specify both sides and offset them slightly to avoid artifacts. Note that the
composite objects introduced in MuJoCo 2.0 generate skins automatically. So one can save an XML model with a composite
object, and obtain an elaborate example of how a skin is specified in the XML.
Similar to meshes, skins can be specified directly in the XML via attributes documented later, or loaded from a binary
SKN file which is in a custom format. The specification of skins is more complex than meshes because of the bone
subelements. The file format starts with a header of 4 integers: nvertex, ntexcoord, nface, nbone. The first three are
the same as in meshes, and specify the total number of vertices, texture coordinate pairs, and triangle faces in the
skin. ntexcoord can be zero or equal to nvertex. nbone specifies the number of MuJoCo bodies that will be used as
bones in the skin. The header is followed by the vertex, texcoord and face data, followed by a specification for each
bone. The bone specification contains the name of the corresponding model body, 3D bind position, 4D bind quaternion,
number of vertices influenced by the bone, and the vertex index array and weight array. Body names are represented as
fixed-length character arrays and are expected to be 0-terminated. Characters after the first 0 are ignored. The
contents of the SKN file are:
.. code:: Text
(int32) nvertex
(int32) ntexcoord
(int32) nface
(int32) nbone
(float) vertex_positions[3*nvertex]
(float) vertex_texcoords[2*ntexcoord]
(int32) face_vertex_indices[3*nface]
for each bone:
(char) body_name[40]
(float) bind_position[3]
(float) bind_quaternion[4]
(int32) vertex_count
(int32) vertex_index[vertex_count]
(float) vertex_weight[vertex_count]
Similar to the other custom binary formats used in MuJoCo, the file size in bytes is strictly enforced by the model
compiler. The skin file format has subelements so the overall file size formula is difficult to write down, but should
be clear from the above specification.
:at:`name`: :at-val:`string, optional`
Name of the skin.
:at:`file`: :at-val:`string, optional`
The SKN file from which the skin will be loaded. The path is determined as described in the meshdir attribute of
:ref:`compiler <compiler>`. If the file is omitted, the skin specification must be provided in the XML using the
attributes below.
:at:`vertex`: :at-val:`real(3*nvert), optional`
Vertex 3D positions, in the global bind pose where the skin is defined.
:at:`texcoord`: :at-val:`real(2*nvert), optional`
Vertex 2D texture coordinates, between 0 and 1. Note that skin and geom texturing are somewhat different. Geoms can
use automated texture coordinate generation while skins cannot. This is because skin data are computed directly in
global coordinates. So if the material references a texture, one should specify explicit texture coordinates for the
skin using this attribute. Otherwise the texture will appear to be stationary in the world while the skin moves
around (creating an interesting effect but probably not as intended).
:at:`face`: :at-val:`int(3*nface), optional`
Trinagular skin faces. Each face is a triple of vertex indices, which are integers between zero and nvert-1.
:at:`inflate`: :at-val:`real, "0"`
If this number is not zero, the position of vertex during updating will be offset along the vertex normal, but the
distance specified in this attribute. This is particularly useful for skins representing flexible 2D shapes.
:at:`material`: :at-val:`string, optional`
If specified, this attribute applies a material to the skin.
:at:`rgba`: :at-val:`real(4), "0.5 0.5 0.5 1"`
Instead of creating material assets and referencing them, this attribute can be used to set color and transparency
only. This is not as flexible as the material mechanism, but is more convenient and is often sufficient. If the value
of this attribute is different from the internal default, it takes precedence over the material.
.. _skinbone:
:el-prefix:`asset/skin/` **bone** (*)
'''''''''''''''''''''''''''''''''''''
This element defines a bone of the skin. The bone is a regular MuJoCo body which is referenced by name here.
:at:`body`: :at-val:`string, required`
Name of the body corresponding to this bone.
:at:`bindpos`: :at-val:`real(3), required`
Global body position corresponding to the bind pose.
:at:`bindquat`: :at-val:`real(4), required`
Global body orientation corresponding to the bind pose.
:at:`vertid`: :at-val:`int(nvert), required`
Integer indices of the vertices influenced by this bone. The vertex index corresponds to the order of the vertex in
the skin mesh. The number of vertex indices specified here (nvert) must equal the number of vertex weights specified
with the next attribute. The same vertex may be influenced by multiple bones, and each vertex must be influenced by
at least one bone.
:at:`vertweight`: :at-val:`real(nvert), required`
Weights for the vertices influenced by this bone, in the same order as the vertex indices. Negative weights are
allowed (which is needed for cubic interpolation for example) however the sum of all bone weights for a given vertex
must be positive.
.. _material:
:el-prefix:`asset/` **material** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a material asset. It can be referenced from :ref:`skins <skin>`, :ref:`geoms <geom>`, :ref:`sites
<site>` and :ref:`tendons <tendon>` to set their appearance. Note that all these elements also have a local rgba
attribute, which is more convenient when only colors need to be adjusted, because it does not require creating materials
and referencing them. Materials are useful for adjusting appearance properties beyond color. However once a material is
created, it is more natural the specify the color using the material, so that all appearance properties are grouped
together.
:at:`name`: :at-val:`string, required`
Name of the material, used for referencing.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`texture`: :at-val:`string, optional`
If this attribute is specified, the material has a texture associated with it. Referencing the material from a model
element will cause the texture to be applied to that element. Note that the value of this attribute is the name of a
texture asset, not a texture file name. Textures cannot be loaded in the material definition; instead they must be
loaded explicitly via the :ref:`texture <texture>` element and then referenced here.
:at:`texrepeat`: :at-val:`real(2), "1 1"`
This attribute applies to textures of type "2d". It specifies how many times the texture image is repeated, relative
to either the object size or the spatial unit, as determined by the next attribute.
:at:`texuniform`: :at-val:`[false, true], "false"`
For cube textures, this attribute controls how cube mapping is applied. The default value "false" means apply cube
mapping directly, using the actual size of the object. The value "true" maps the texture to a unit object before
scaling it to its actual size (geometric primitives are created by the renderer as unit objects and then scaled). In
some cases this leads to more uniform texture appearance, but in general, which settings produces better results
depends on the texture and the object. For 2d textures, this attribute interacts with texrepeat above. Let texrepeat
be N. The default value "false" means that the 2d texture is repeated N times over the (z-facing side of the) object.
The value "true" means that the 2d texture is repeated N times over one spatial unit, regardless of object size.
:at:`emission`: :at-val:`real, "0"`
Emission in OpenGL has the RGBA format, however we only provide a scalar setting. The RGB components of the OpenGL
emission vector are the RGB components of the material color multiplied by the value specified here. The alpha
component is 1.
:at:`specular`: :at-val:`real, "0.5"`
Specularity in OpenGL has the RGBA format, however we only provide a scalar setting. The RGB components of the OpenGL
specularity vector are all equal to the value specified here. The alpha component is 1. This value should be in the
range [0 1].
:at:`shininess`: :at-val:`real, "0.5"`
Shininess in OpenGL is a number between 0 and 128. The value given here is multiplied by 128 before passing it to
OpenGL, so it should be in the range [0 1]. Larger values correspond to tighter specular highlight (thus reducing the
overall amount of highlight but making it more salient visually). This interacts with the specularity setting; see
OpenGL documentation for details.
:at:`reflectance`: :at-val:`real, "0"`
This attribute should be in the range [0 1]. If the value is greater than 0, and the material is applied to a plane
or a box geom, the renderer will simulate reflectance. The larger the value, the stronger the reflectance. For boxes,
only the face in the direction of the local +Z axis is reflective. Simulating reflectance properly requires
ray-tracing which cannot (yet) be done in real-time. We are using the stencil buffer and suitable projections
instead. Only the first reflective geom in the model is rendered as such. This adds one extra rendering pass through
all geoms, in addition to the extra rendering pass added by each shadow-casting light.
:at:`rgba`: :at-val:`real(4), "1 1 1 1"`
Color and transparency of the material. All components should be in the range [0 1]. Note that textures are applied
in GL_MODULATE mode, meaning that the texture color and the color specified here are multiplied component-wise. Thus
the default value of "1 1 1 1" has the effect of leaving the texture unchanged. When the material is applied to a
model element which defines its own local rgba attribute, the local definition has precedence. Note that this "local"
definition could in fact come from a defaults class. The remaining material properties always apply.
.. _body:
**(world)body** (R)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This element is used to construct the :ref:`kinematic tree <CTree>` via nesting. The element :el:`worldbody` is used for
the top-level body, while the element :el:`body` is used for all other bodies. The top-level body is a restricted type
of body: it cannot have child elements :ref:`inertial <inertial>` and :ref:`joint <joint>`, and also cannot have any
attributes. It corresponds to the origin of the world frame, within which the rest of the kinematic tree is defined. Its
body name is automatically defined as "world".
:at:`name`: :at-val:`string, optional`
Name of the body.
:at:`childclass`: :at-val:`string, optional`
If this attribute is present, all descendant elements that admit a defaults class will use the class specified here,
unless they specify their own class or another body with a childclass attribute is encountered along the chain of
nested bodies. Recall :ref:`CDefault`.
:at:`mocap`: :at-val:`[false, true], "false"`
If this attribute is "true", the body is labeled as a mocap body. This is allowed only for bodies that are children
of the world body and have no joints. Such bodies are fixed from the viewpoint of the dynamics, but nevertheless the
forward kinematics set their position and orientation from the fields mjData.mocap_pos and mjData.mocap_quat at each
time step. The size of these arrays is adjusted by the compiler so as to match the number of mocap bodies in the
model. This mechanism can be used to stream motion capture data into the simulation. Mocap bodies can also be moved
via mouse perturbations in the interactive visualizer, even in dynamic simulation mode. This can be useful for
creating props with adjustable position and orientation. See also the mocap attribute of :ref:`flag <option-flag>`.
:at:`pos`: :at-val:`real(3), optional`
The 3D position of the body frame, in local or global coordinates as determined by the coordinate attribute of
:ref:`compiler <compiler>`. Recall the earlier discussion of local and global coordinates in :ref:`Coordinate frames
<CFrame>`. In local coordinates, if the body position is left undefined it defaults to (0,0,0). In global
coordinates, an undefined body position is inferred by the compiler through the following steps:
#. If the inertial frame is not defined via the :ref:`inertial <inertial>` element, it is inferred from the geoms
attached to the body. If there are no geoms, the inertial frame remains undefined. This step is applied in both
local and global coordinates.
#. If both the body frame and the inertial frame are undefined, a compile error is generated.
#. If one of these two frames is defined and the other is not, the defined one is copied into the undefined one. At
this point both frames are defined, in global coordinates.
#. The inertial frame as well as all elements defined in the body are converted to local coordinates, relative to the
body frame.
Note that whether a frame is defined or not depends on its pos attribute, which is in the special undefined state by
default. Orientation cannot be used to make this determination because it has an internal default (the unit
quaternion).
:at:`quat`, :at:`axisangle`, :at:`xyaxes`, :at:`zaxis`, :at:`euler`
See :ref:`COrientation`. Similar to position, the orientation specified here is
interpreted in either local or global coordinates as determined by the coordinate attribute of
:ref:`compiler <compiler>`. Unlike position which is required in local coordinates, the orientation defaults to the
unit quaternion, thus specifying it is optional even in local coordinates. If the body frame was copied from the body
inertial frame per the above rules, the copy operation applies to both position and orientation, and the setting of
the orientation-related attributes is ignored.
:at:`user`: :at-val:`real(nbody_user), "0 0 ..."`
See :ref:`CUser`.
.. _inertial:
:el-prefix:`body/` **inertial** (?)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element specifies the mass and inertial properties of the body. If this element is not included in a given body,
the inertial properties are inferred from the geoms attached to the body. When a compiled MJCF model is saved, the XML
writer saves the inertial properties explicitly using this element, even if they were inferred from geoms. The inertial
frame is such that its center coincides with the center of mass of the body, and its axes coincide with the principal
axes of inertia of the body. Thus the inertia matrix is diagonal in this frame.
:at:`pos`: :at-val:`real(3), required`
Position of the inertial frame. This attribute is required even when the inertial properties can be inferred from
geoms. This is because the presence of the :el:`inertial` element itself disabled the automatic inference mechanism.
:at:`quat`, :at:`axisangle`, :at:`xyaxes`, :at:`zaxis`, :at:`euler`
Orientation of the inertial frame. See :ref:`COrientation`.
:at:`mass`: :at-val:`real, required`
Mass of the body. Negative values are not allowed. MuJoCo requires the inertia matrix in generalized coordinates to
be positive-definite, which can sometimes be achieved even if some bodies have zero mass. In general however there is
no reason to use massless bodies. Such bodies are often used in other engines to bypass the limitation that joints
cannot be combined, or to attach sensors and cameras. In MuJoCo primitive joint types can be combined, and we have
sites which are a more efficient attachment mechanism.
:at:`diaginertia`: :at-val:`real(3), optional`
Diagonal inertia matrix, expressing the body inertia relative to the inertial frame. If this attribute is omitted,
the next attribute becomes required.
:at:`fullinertia`: :at-val:`real(6), optional`
Full inertia matrix M. Since M is 3-by-3 and symmetric, it is specified using only 6 numbers in the following order:
M(1,1), M(2,2), M(3,3), M(1,2), M(1,3), M(2,3). The compiler computes the eigenvalue decomposition of M and sets the
frame orientation and diagonal inertia accordingly. If non-positive eigenvalues are encountered (i.e., if M is not
positive definite) a compile error is generated.
.. _joint:
:el-prefix:`body/` **joint** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a joint. As explained in :ref:`Kinematic tree <CTree>`, a joint creates motion degrees of freedom
between the body where it is defined and the body's parent. If multiple joints are defined in the same body, the
corresponding spatial transformations (of the body frame relative to the parent frame) are applied in order. If no
joints are defined, the body is welded to its parent. Joints cannot be defined in the world body. At runtime the
positions and orientations of all joints defined in the model are stored in the vector mjData.qpos, in the order in
which the appear in the kinematic tree. The linear and angular velocities are stored in the vector mjData.qvel. These
two vectors have different dimensionality when free or ball joints are used, because such joints represent rotations as
unit quaternions.
:at:`name`: :at-val:`string, optional`
Name of the joint.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`type`: :at-val:`[free, ball, slide, hinge], "hinge"`
Type of the joint. The keywords have the following meaning:
The **free** type creates a free "joint" with three translational degrees of freedom followed by three rotational
degrees of freedom. In other words it makes the body floating. The rotation is represented as a unit quaternion. This
joint type is only allowed in bodies that are children of the world body. No other joints can be defined in the body
if a free joint is defined. Unlike the remaining joint types, free joints do not have a position within the body
frame. Instead the joint position is assumed to coincide with the center of the body frame. Thus at runtime the
position and orientation data of the free joint correspond to the global position and orientation of the body frame.
Free joints cannot have limits.
The **ball** type creates a ball joint with three rotational degrees of freedom. The rotation is represented as a
unit quaternion. The quaternion (1,0,0,0) corresponds to the initial configuration in which the model is defined. Any
other quaternion is interpreted as a 3D rotation relative to this initial configuration. The rotation is around the
point defined by the pos attribute below. If a body has a ball joint, it cannot have other rotational joints (ball or
hinge). Combining ball joints with slide joints in the same body is allowed.
The **slide** type creates a sliding or prismatic joint with one translational degree of freedom. Such joints are
defined by a position and a sliding direction. For simulation purposes only the direction is needed; the joint
position is used for rendering purposes.
The **hinge** type creates a hinge joint with one rotational degree of freedom. The rotation takes place around a
specified axis through a specified position. This is the most common type of joint and is therefore the default. Most
models contain only hinge and free joints.
:at:`group`: :at-val:`int, "0"`
Integer group to which the joint belongs. This attribute can be used for custom tags. It is also used by the
visualizer to enable and disable the rendering of entire groups of joints.
:at:`pos`: :at-val:`real(3), "0 0 0"`
Position of the joint, specified in local or global coordinates as determined by the coordinate attribute of
:ref:`compiler <compiler>`. For free joints this attribute is ignored.
:at:`axis`: :at-val:`real(3), "0 0 1"`
This attribute specifies the axis of rotation for hinge joints and the direction of translation for slide joints. It
is ignored for free and ball joints. The vector specified here is automatically normalized to unit length as long as
its length is greater than 10E-14; otherwise a compile error is generated.
:at:`springdamper`: :at-val:`real(2), "0 0"`
When both numbers are positive, the compiler will override any stiffness and damping values specified with the
attributes below, and will instead set them automatically so that the resulting mass-spring-damper for this joint has
the desired time constant (first value) and damping ratio (second value). This is done by taking into account the
joint inertia in the model reference configuration. Note that the format is the same as the solref parameter of the
constraint solver.
:at:`limited`: :at-val:`[false, true, auto], "auto"`
This attribute specifies if the joint has limits. It interacts with the range attribute below. If this attribute
is "false", joint limits are disabled. If this attribute is "true", joint limits are enabled. If this
attribute is "auto", and :at:`autolimits` is set in :ref:`compiler <compiler>`, joint limits will be enabled
if range is defined.
:at:`solreflimit`, :at:`solimplimit`
Constraint solver parameters for simulating joint limits. See :ref:`CSolver`.
:at:`solreffriction`, :at:`solimpfriction`
Constraint solver parameters for simulating dry friction. See :ref:`CSolver`.
:at:`stiffness`: :at-val:`real, "0"`
Joint stiffness. If this value is positive, a spring will be created with equilibrium position given by springref
below. The spring force is computed along with the other passive forces.
:at:`range`: :at-val:`real(2), "0 0"`
The joint limits. Limits can be imposed on all joint types except for free joints. For hinge and ball joints, the
range is specified in degrees or radians depending on the angle attribute of :ref:`compiler <compiler>`. For ball
joints, the limit is imposed on the angle of rotation (relative to the reference configuration) regardless of the
axis of rotation. Only the second range parameter is used for ball joints; the first range parameter should be set to
0. See the :ref:`Limit <coLimit>` section in the Computation chapter for more information.
|br| Setting this attribute without specifying :at:`limited` is an error, unless :at:`autolimits` is set in
:ref:`compiler <compiler>`.
:at:`margin`: :at-val:`real, "0"`
The distance threshold below which limits become active. Recall that the :ref:`Constraint solver <Solver>` normally
generates forces as soon as a constraint becomes active, even if the margin parameter makes that happen at a
distance. This attribute together with solreflimit and solimplimit can be used to model a soft joint limit.
:at:`ref`: :at-val:`real, "0"`
The reference position or angle of the joint. This attribute is only used for slide and hinge joints. It defines the
joint value corresponding to the initial model configuration. The amount of spatial transformation that the joint
applies at runtime equals the current joint value stored in mjData.qpos minus this reference value stored in
mjModel.qpos0. The meaning of these vectors was discussed in the :ref:`Stand-alone <Standalone>` section in
the Overview chapter.
:at:`springref`: :at-val:`real, "0"`
The joint position or angle in which the joint spring (if any) achieves equilibrium. Similar to the vector
mjModel.qpos0 which stores all joint reference values specified with the ref attribute above, all spring reference
values specified with this attribute are stored in the vector mjModel.qpos_spring. The model configuration
corresponding to mjModel.qpos_spring is also used to compute the spring reference lengths of all tendons, stored in
mjModel.tendon_lengthspring. This is because :ref:`tendons <tendon>` can also have springs.
:at:`armature`: :at-val:`real, "0"`
Armature inertia (or rotor inertia, or reflected inertia) of all degrees of freedom created by this joint. These are
constants added to the diagonal of the inertia matrix in generalized coordinates. They make the simulation more
stable, and often increase physical realism. This is because when a motor is attached to the system with a
transmission that amplifies the motor force by c, the inertia of the rotor (i.e., the moving part of the motor) is
amplified by c*c. The same holds for gears in the early stages of planetary gear boxes. These extra inertias often
dominate the inertias of the robot parts that are represented explicitly in the model, and the armature attribute is
the way to model them.
:at:`damping`: :at-val:`real, "0"`
Damping applied to all degrees of freedom created by this joint. Unlike friction loss which is computed by the
constraint solver, damping is simply a force linear in velocity. It is included in the passive forces. Despite this
simplicity, larger damping values can make numerical integrators unstable, which is why our Euler integrator handles
damping implicitly. See :ref:`Integration <geIntegration>` in the Computation chapter.
:at:`frictionloss`: :at-val:`real, "0"`
Friction loss due to dry friction. This value is the same for all degrees of freedom created by this joint.
Semantically friction loss does not make sense for free joints, but the compiler allows it. To enable friction loss,
set this attribute to a positive value.
:at:`user`: :at-val:`real(njnt_user), "0 0 ..."`
See :ref:`CUser`.
.. _freejoint:
:el-prefix:`body/` **freejoint** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a free joint whose only attributes are :at:`name` and :at:`group`. The :el:`freejoint` element is
an XML shortcut for
.. code-block:: xml
<joint type="free" stiffness="0" damping="0" frictionloss="0" armature="0"/>
While this joint can evidently be created with the :ref:`joint <joint>` element, default joint settings could affect it.
This is usually undesirable as physical free bodies do not have nonzero stiffness, damping, friction or armature. To
avoid this complication, the :el:`freejoint` element was introduced, ensuring joint defaults are *not inherited*. If
the XML model is saved, it will appear as a regular joint of type :at:`free`.
:at:`name`: :at-val:`string, optional`
Name of the joint.
:at:`group`: :at-val:`int, "0"`
Integer group to which the joint belongs. This attribute can be used for custom tags. It is also used by the
visualizer to enable and disable the rendering of entire groups of joints.
.. _geom:
:el-prefix:`body/` **geom** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a geom, and attaches it rigidly to the body within which the geom is defined. Multiple geoms can
be attached to the same body. At runtime they determine the appearance and collision properties of the body. At
compile time they can also determine the inertial properties of the body, depending on the presence of the
:ref:`inertial <inertial>` element and the setting of the inertiafromgeom attribute of :ref:`compiler <compiler>`.
This is done by summing the masses and inertias of all geoms attached to the body with geom group in the range
specified by the inertiagrouprange attribute of :ref:`compiler <compiler>`. The geom masses and inertias are computed
using the geom shape, a specified density or a geom mass which implies a density, and the assumption of uniform
density.
Geoms are not strictly required for physics simulation. One can create and simulate a model that only has bodies and
joints. Such a model can even be visualized, using equivalent inertia boxes to represent bodies. Only contact forces
would be missing from such a simulation. We do not recommend using such models, but knowing that this is possible
helps clarify the role of bodies and geoms in MuJoCo.
:at:`name`: :at-val:`string, optional`
Name of the geom.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`type`: :at-val:`[plane, hfield, sphere, capsule, ellipsoid, cylinder, box, mesh], "sphere"`
Type of geometric shape. The keywords have the following meaning:
The **plane** type defines a plane which is infinite for collision detection purposes. It can only be attached to the
world body or static children of the world. The plane passes through a point specified via the pos attribute. It is
normal to the Z axis of the geom's local frame. The +Z direction corresponds to empty space. Thus the position and
orientation defaults of (0,0,0) and (1,0,0,0) would create a ground plane at Z=0 elevation, with +Z being the
vertical direction in the world (which is MuJoCo's convention). Since the plane is infinite, it could have been
defined using any other point in the plane. The specified position however has additional meaning with regard to
rendering. If either of the first two size parameters are positive, the plane is rendered as a rectangle of finite
size (in the positive dimensions). This rectangle is centered at the specified position. Three size parameters are
required. The first two specify the half-size of the rectangle along the X and Y axes. The third size parameter is
unusual: it specifies the spacing between the grid subdivisions of the plane for rendering purposes. The subdivisions
are revealed in wireframe rendering mode, but in general they should not be used to paint a grid over the ground
plane (textures should be used for that purpose). Instead their role is to improve lighting and shadows, similar to
the subdivisions used to render boxes. When planes are viewed from the back, the are automatically made
semi-transparent. Planes and the +Z faces of boxes are the only surfaces that can show reflections, if the
:ref:`material <material>` applied to the geom has positive reflection. To render an infinite plane, set the first
two size parameters to zero.
The **hfield** type defines a height field geom. The geom must reference the desired height field asset with the
hfield attribute below. The position and orientation of the geom set the position and orientation of the height
field. The size of the geom is ignored, and the size parameters of the height field asset are used instead. See the
description of the :ref:`hfield <hfield>` element. Similar to planes, height field geoms can only be attached to the
world body or to static children of the world.
The **sphere** type defines a sphere. This and the next four types correspond to built-in geometric primitives. These
primitives are treated as analytic surfaces for collision detection purposes, in many cases relying on custom
pair-wise collision routines. Models including only planes, spheres, capsules and boxes are the most efficient in
terms of collision detection. Other geom types invoke the general-purpose convex collider. The sphere is centered at
the geom's position. Only one size parameter is used, specifying the radius of the sphere. Rendering of geometric
primitives is done with automatically generated meshes whose density can be adjusted via :ref:`quality <quality>`.
The sphere mesh is triangulated along the lines of latitude and longitude, with the Z axis passing through the north
and south pole. This can be useful in wireframe mode for visualizing frame orientation.
The **capsule** type defines a capsule, which is a cylinder capped with two half-spheres. It is oriented along the Z
axis of the geom's frame. When the geom frame is specified in the usual way, two size parameters are required: the
radius of the capsule followed by the half-height of the cylinder part. However capsules as well as cylinders can
also be thought of as connectors, allowing an alternative specification with the fromto attribute below. In that case
only one size parameter is required, namely the radius of the capsule.
The **ellipsoid** type defines a ellipsoid. This is a sphere scaled separately along the X, Y and Z axes of the local
frame. It requires three size parameters, corresponding to the three radii. Note that even though ellipsoids are
smooth, their collisions are handled via the general-purpose convex collider. The only exception are plane-ellipsoid
collisions which are computed analytically.
The **cylinder** type defines a cylinder. It requires two size parameters: the radius and half-height of the
cylinder. The cylinder is oriented along the Z axis of the geom's frame. It can alternatively be specified with the
fromto attribute below.
The **box** type defines a box. Three size parameters are required, corresponding to the half-sizes of the box along
the X, Y and Z axes of the geom's frame. Note that box-box collisions are the only pair-wise collision type that can
generate a large number of contact points, up to 8 depending on the configuration. The contact generation itself is
fast but this can slow down the constraint solver. As an alternative, we provide the boxconvex attribute in
:ref:`flag <option-flag>` which causes the general-purpose convex collider to be used instead, yielding at most one
contact point per geom pair.
The **mesh** type defines a mesh. The geom must reference the desired mesh asset with the mesh attribute. Note that
mesh assets can also be referenced from other geom types, causing primitive shapes to be fitted; see below. The size
is determined by the mesh asset and the geom size parameters are ignored. Unlike all other geoms, the position and
orientation of mesh geoms after compilation do not equal the settings of the corresponding attributes here. Instead
they are offset by the translation and rotation that were needed to center and align the mesh asset in its own
coordinate frame. Recall the discussion of centering and alignment in the :ref:`mesh <mesh>` element.
:at:`contype`: :at-val:`int, "1"`
This attribute and the next specify 32-bit integer bitmasks used for contact filtering of dynamically generated
contact pairs. See :ref:`Collision` in the Computation chapter. Two geoms can collide if the contype of one geom
is compatible with the conaffinity of the other geom or vice versa. Compatible means that the two bitmasks have
a common bit set to 1.
:at:`conaffinity`: :at-val:`int, "1"`
Bitmask for contact filtering; see contype above.
:at:`condim`: :at-val:`int, "3"`
The dimensionality of the contact space for a dynamically generated contact pair is set to the maximum of the condim
values of the two participating geoms. See :ref:`coContact` in the Computation chapter. The allowed values and their
meaning are:
+--------+----------------------------------------------------------------------------------------------------------+
| condim | Description |
+========+==========================================================================================================+
| 1 | Frictionless contact. |
+--------+----------------------------------------------------------------------------------------------------------+
| 3 | Regular frictional contact, opposing slip in the tangent plane. |
+--------+----------------------------------------------------------------------------------------------------------+
| 4 | Frictional contact, opposing slip in the tangent plane and rotation around the contact normal. This is |
| | useful for modeling soft contacts (independent of contact penetration). |
+--------+----------------------------------------------------------------------------------------------------------+
| 6 | Frictional contact, opposing slip in the tangent plane, rotation around the contact normal and rotation |
| | around the two axes of the tangent plane. The latter frictional effects are useful for preventing |
| | objects from indefinite rolling. |
+--------+----------------------------------------------------------------------------------------------------------+
:at:`group`: :at-val:`int, "0"`
This attribute specifies an integer group to which the geom belongs. The only effect on the physics is at compile
time, when body masses and inertias are inferred from geoms selected based on their group; see inertiagrouprange
attribute of :ref:`compiler <compiler>`. At runtime this attribute is used by the visualizer to enable and disable
the rendering of entire geom groups. It can also be used as a tag for custom computations.
:at:`priority`: :at-val:`int, "0"`
The geom priority determines how the properties of two colliding geoms are combined to form the properties of the
contact. This interacts with the solmix attribute. See :ref:`CContact`.
:at:`size`: :at-val:`real(3), "0 0 0"`
Geom size parameters. The number of required parameters and their meaning depends on the geom type as documented
under the type attribute. Here we only provide a summary. All required size parameters must be positive; the internal
defaults correspond to invalid settings. Note that when a non-mesh geom type references a mesh, a geometric primitive
of that type is fitted to the mesh. In that case the sizes are obtained from the mesh, and the geom size parameters
are ignored. Thus the number and description of required size parameters in the table below only apply to geoms that
do not reference meshes.
+---------+--------+------------------------------------------------------------------------------------------------+
| Type | Number | Description |
+=========+========+================================================================================================+
| plane | 3 | X half-size; Y half-size; spacing between square grid lines for rendering. If either the X or Y|
| | | half-size is 0, the plane is rendered as infinite in the dimension(s) with 0 size. |
+---------+--------+------------------------------------------------------------------------------------------------+
| hfield | 0 | The geom sizes are ignored and the height field sizes are used instead. |
+---------+--------+------------------------------------------------------------------------------------------------+
| sphere | 1 | Radius of the sphere. |
+---------+--------+------------------------------------------------------------------------------------------------+
| capsule | 1 or 2 | Radius of the capsule; half-length of the cylinder part when not using the :at:`fromto` |
| | | specification. |
+---------+--------+------------------------------------------------------------------------------------------------+
|ellipsoid| 1 | X radius; Y radius; Z radius. |
+---------+--------+------------------------------------------------------------------------------------------------+
|cylinder | 1 or 2 | Radius of the cylinder; half-length of the cylinder when not using the :at:`fromto` |
| | | specification. |
+---------+--------+------------------------------------------------------------------------------------------------+
| box | 3 | X half-size; Y half-size; Z half-size. |
+---------+--------+------------------------------------------------------------------------------------------------+
| mesh | 0 | The geom sizes are ignored and the mesh sizes are used instead. |
+---------+--------+------------------------------------------------------------------------------------------------+
:at:`material`: :at-val:`string, optional`
If specified, this attribute applies a material to the geom. The material determines the visual properties of the
geom. The only exception is color: if the rgba attribute below is different from its internal default, it takes
precedence while the remaining material properties are still applied. Note that if the same material is referenced
from multiple geoms (as well as sites and tendons) and the user changes some of its properties at runtime, these
changes will take effect immediately for all model elements referencing the material. This is because the compiler
saves the material and its properties as a separate element in mjModel, and the elements using this material only
keep a reference to it.
:at:`rgba`: :at-val:`real(4), "0.5 0.5 0.5 1"`
Instead of creating material assets and referencing them, this attribute can be used to set color and transparency
only. This is not as flexible as the material mechanism, but is more convenient and is often sufficient. If the value
of this attribute is different from the internal default, it takes precedence over the material.
:at:`friction`: :at-val:`real(3), "1 0.005 0.0001"`
Contact friction parameters for dynamically generated contact pairs. The first number is the sliding friction, acting
along both axes of the tangent plane. The second number is the torsional friction, acting around the contact normal.
The third number is the rolling friction, acting around both axes of the tangent plane. The friction parameters for
the contact pair are combined depending on the solmix and priority attributes, as explained in :ref:`Contact
parameters <CContact>`.
:at:`mass`: :at-val:`real, optional`
If this attribute is specified, the density attribute below is ignored and the geom density is computed from the
given mass, using the geom shape and the assumption of uniform density. The computed density is then used to obtain
the geom inertia. Recall that the geom mass and inertia are only used during compilation, to infer the body mass and
inertia if necessary. At runtime only the body inertial properties affect the simulation; the geom mass and inertia
are not even saved in mjModel.
:at:`density`: :at-val:`real, "1000"`
Material density used to compute the geom mass and inertia. The computation is based on the geom shape and the
assumption of uniform density. The internal default of 1000 is the density of water in SI units. This attribute is
used only when the mass attribute above is unspecified.
:at:`shellinertia` :at-val:`[false, true], "false"`
If true, the geom's inertia is computed assuming that all the mass is concentrated on the boundary. In this case
:at:`density` is interpreted as surface density rather than volumetric density.
:at:`solmix`: :at-val:`real, "1"`
This attribute specifies the weight used for averaging of contact parameters, and interacts with the priority
attribute. See :ref:`CContact`.
:at:`solref`, :at:`solimp`
Constraint solver parameters for contact simulation. See :ref:`CSolver`.
:at:`margin`: :at-val:`real, "0"`
Distance threshold below which contacts are detected and included in the global array mjData.contact. This however
does not mean that contact force will be generated. A contact is considered active only if the distance between the
two geom surfaces is below margin-gap. Recall that constraint impedance can be a function of distance, as explained
in :ref:`CSolver`. The quantity this function is applied to is the distance between
the two geoms minus the margin plus the gap.
:at:`gap`: :at-val:`real, "0"`
This attribute is used to enable the generation of inactive contacts, i.e., contacts that are ignored by the
constraint solver but are included in mjData.contact for the purpose of custom computations. When this value is
positive, geom distances between margin and margin-gap correspond to such inactive contacts.
:at:`fromto`: :at-val:`real(6), optional`
This attribute can only be used with capsule, cylinder, ellipsoid and box geoms. It provides an alternative
specification of the geom length as well as the frame position and orientation. The six numbers are the 3D
coordinates of one point followed by the 3D coordinates of another point. The elongated part of the geom connects
these two points, with the +Z axis of the geom's frame oriented from the first towards the second point. The frame
orientation is obtained with the same procedure as the zaxis attribute described in :ref:`Frame orientations
<COrientation>`. The frame position is in the middle between the two points. If this attribute is specified, the
remaining position and orientation-related attributes are ignored.
:at:`pos`: :at-val:`real(3), "0 0 0"`
Position of the geom frame, in local or global coordinates as determined by the coordinate attribute of
:ref:`compiler <compiler>`.
:at:`quat`, :at:`axisangle`, :at:`xyaxes`, :at:`zaxis`, :at:`euler`
Orientation of the geom frame. See :ref:`COrientation`.
:at:`hfield`: :at-val:`string, optional`
This attribute must be specified if and only if the geom type is "hfield". It references the height field asset to be
instantiated at the position and orientation of the geom frame.
:at:`mesh`: :at-val:`string, optional`
If the geom type is "mesh", this attribute is required. It references the mesh asset to be instantiated. This
attribute can also be specified if the geom type corresponds to a geometric primitive, namely one of "sphere",
"capsule", "cylinder", "ellipsoid", "box". In that case the primitive is automatically fitted to the mesh asset
referenced here. The fitting procedure uses either the equivalent inertia box or the axis-aligned bounding box of the
mesh, as determined by the attribute fitaabb of :ref:`compiler <compiler>`. The resulting size of the fitted geom is
usually what one would expect, but if not, it can be further adjusted with the fitscale attribute below. In the
compiled mjModel the geom is represented as a regular geom of the specified primitive type, and there is no reference
to the mesh used for fitting.
:at:`fitscale`: :at-val:`real, "1"`
This attribute is used only when a primitive geometric type is being fitted to a mesh asset. The scale specified here
is relative to the output of the automated fitting procedure. The default value of 1 leaves the result unchanged, a
value of 2 makes all sizes of the fitted geom two times larger.
:at:`fluidshape`: :at-val:`[none, ellipsoid], "none"`
"ellipsoid" Activates geom-level stateless fluid interaction model based on an ellipsoidal approximation of the geom
shape. When active, the model based on :ref:`body inertia sizes <gePassive>` is disabled for the parent body.
:at:`fluidcoef`: :at-val:`real(5), "0.5 0.25 1.5 1.0 1.0"`
Dimensionless coefficients of fluid interaction model, as follows.
.. table::
:align: left
+--------+-----------------------------+----------+
| Index | Description | Default |
+========+=============================+==========+
| 0 | Blunt drag coefficient. | 0.5 |
+--------+-----------------------------+----------+
| 1 | Slender drag coeficient. | 0.25 |
+--------+-----------------------------+----------+
| 2 | Angular drag coefficient. | 1.5 |
+--------+-----------------------------+----------+
| 3 | Kutta lift coeficient. | 1.0 |
+--------+-----------------------------+----------+
| 4 | Magnus lift coeficient. | 1.0 |
+--------+-----------------------------+----------+
:at:`user`: :at-val:`real(nuser_geom), "0 0 ..."`
See :ref:`CUser`.
.. _site:
:el-prefix:`body/` **site** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a site, which is a simplified and restricted kind of geom. A small subset of the geom attributes
are available here; see the :ref:`geom <geom>` element for their detailed documentation. Semantically sites represent
locations of interest relative to the body frames. Sites do not participate in collisions and computation of body masses
and inertias. The geometric shapes that can be used to render sites are limited to a subset of the available geom types.
However sites can be used in some places where geoms are not allowed: mounting sensors, specifying via-points of spatial
tendons, constructing slider-crank transmissions for actuators.
:at:`name`: :at-val:`string, optional`
Name of the site.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`type`: :at-val:`[sphere, capsule, ellipsoid, cylinder, box], "sphere"`
Type of geometric shape. This is used for rendering, and also determines the active sensor zone for :ref:`touch
sensors <sensor-touch>`.
:at:`group`: :at-val:`int, "0"`
Integer group to which the site belongs. This attribute can be used for custom tags. It is also used by the
visualizer to enable and disable the rendering of entire groups of sites.
:at:`material`: :at-val:`string, optional`
Material used to specify the visual properties of the site.
:at:`rgba`: :at-val:`real(4), "0.5 0.5 0.5 1"`
Color and transparency. If this value is different from the internal default, it overrides the corresponding material
properties.
:at:`size`: :at-val:`real(3), "0.005 0.005 0.005"`
Sizes of the geometric shape representing the site.
:at:`fromto`: :at-val:`real(6), optional`
This attribute can only be used with capsule, cylinder, ellipsoid and box sites. It provides an alternative
specification of the site length as well as the frame position and orientation. The six numbers are the 3D
coordinates of one point followed by the 3D coordinates of another point. The elongated part of the site connects
these two points, with the +Z axis of the site's frame oriented from the first towards the second point. The frame
orientation is obtained with the same procedure as the zaxis attribute described in :ref:`Frame orientations
<COrientation>`. The frame position is in the middle between the two points. If this attribute is specified, the
remaining position and orientation-related attributes are ignored.
:at:`pos`: :at-val:`real(3), "0 0 0"`
Position of the site frame.
:at:`quat`, :at:`axisangle`, :at:`xyaxes`, :at:`zaxis`, :at:`euler`
Orientation of the site frame. See :ref:`COrientation`.
:at:`user`: :at-val:`real(nuser_site), "0 0 ..."`
See :ref:`CUser`.
.. _camera:
:el-prefix:`body/` **camera** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a camera, which moves with the body where it is defined. To create a fixed camera, define it in the
world body. The cameras created here are in addition to the default free camera which is always defined and is adjusted
via the :ref:`visual <visual>` element. Internally MuJoCo uses a flexible camera model, where the viewpoint and
projection surface are adjusted independently so as to obtain oblique projections needed for virtual environments. This
functionality however is not accessible through MJCF. Instead, the cameras created with this element (as well as the
free camera) have a viewpoint that is always centered in front of the projection surface. The viewpoint coincides with
the center of the camera frame. The camera is looking along the -Z axis of its frame. The +X axis points to the right,
and the +Y axis points up. Thus the frame position and orientation are the key adjustments that need to be made here.
:at:`name`: :at-val:`string, optional`
Name of the camera.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`mode`: :at-val:`[fixed, track, trackcom, targetbody, targetbodycom], "fixed"`
This attribute specifies how the camera position and orientation in world coordinates are computed in forward
kinematics (which in turn determine what the camera sees). "fixed" means that the position and orientation specified
below are fixed relative to the parent (i.e., the body where the camera is defined). "track" means that the camera
position is at a constant offset from the parent in world coordinates, while the camera orientation is constant in
world coordinates. These constants are determined by applying forward kinematics in qpos0 and treating the camera as
fixed. Tracking can be used for example to position a camera above a body, point it down so it sees the body, and
have it always remain above the body no matter how the body translates and rotates. "trackcom" is similar to "track"
but the constant spatial offset is defined relative to the center of mass of the kinematic subtree starting at the
parent body. This can be used to keep an entire mechanism in view. Note that the subtree center of mass for the world
body is the center of mass of the entire model. So if a camera is defined in the world body in mode "trackcom", it
will track the entire model. "targetbody" means that the camera position is fixed in the parent body, while the
camera orientation is adjusted so that it always points towards the targeted body (which is specified with the target
attribute below). This can be used for example to model an eye that fixates a moving object; the object will be the
target, and the camera/eye will be defined in the body corresponding to the head. "targetbodycom" is the same as
"targetbody" but the camera is oriented towards the center of mass of the subtree starting at the target body.
:at:`target`: :at-val:`string, optional`
When the camera mode is "targetbody" or "targetbodycom", this attribute becomes required. It specifies which body
should be targeted by the camera. In all other modes this attribute is ignored.
:at:`fovy`: :at-val:`real, "45"`
Vertical field of view of the camera, expressed in degrees regardless of the global angle setting. The horizontal
field of view is computed automatically given the window size and the vertical field of view.
:at:`ipd`: :at-val:`real, "0.068"`
Inter-pupilary distance. This attribute only has an effect during stereoscopic rendering. It specifies the distance
between the left and right viewpoints. Each viewpoint is shifted by +/- half of the distance specified here, along
the X axis of the camera frame.
:at:`pos`: :at-val:`real(3), "0 0 0"`
Position of the camera frame.
:at:`quat`, :at:`axisangle`, :at:`xyaxes`, :at:`zaxis`, :at:`euler`
Orientation of the camera frame. See :ref:`COrientation`.
:at:`user`: :at-val:`real(nuser_cam), "0 0 ..."`
See :ref:`CUser`.
.. _light:
:el-prefix:`body/` **light** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a light, which moves with the body where it is defined. To create a fixed light, define it in the
world body. The lights created here are in addition to the default headlight which is always defined and is adjusted via
the :ref:`visual <visual>` element. MuJoCo relies on the standard lighting model in OpenGL (fixed functionality)
augmented with shadow mapping. The effects of lights are additive, thus adding a light always makes the scene brighter.
The maximum number of lights that can be active simultaneously is 8, counting the headlight. The light is shining along
the direction specified by the dir attribute. It does not have a full spatial frame with three orthogonal axes.
:at:`name`: :at-val:`string, optional`
Name of the light.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`mode`: :at-val:`[fixed, track, trackcom, targetbody, targetbodycom], "fixed"`
This is identical to the mode attribute of :ref:`camera <camera>` above. It specifies the how the light position and
orientation in world coordinates are computed in forward kinematics (which in turn determine what the light
illuminates).
:at:`target`: :at-val:`string, optional`
This is identical to the target attribute of :ref:`camera <camera>` above. It specifies which body should be targeted
in "targetbody" and "targetbodycom" modes.
:at:`directional`: :at-val:`[false, true], "false"`
The light is directional if this attribute is "true", otherwise it is a spotlight.
:at:`castshadow`: :at-val:`[false, true], "true"`
If this attribute is "true" the light will cast shadows. More precisely, the geoms illuminated by the light will cast
shadows, however this is a property of lights rather than geoms. Since each shadow-casting light causes one extra
rendering pass through all geoms, this attribute should be used with caution. Higher quality of the shadows is
achieved by increasing the value of the shadowsize attribute of :ref:`quality <quality>`, as well as positioning
spotlights closer to the surface on which shadows appear, and limiting the volume in which shadows are cast. For
spotlights this volume is a cone, whose angle is the cutoff attribute below multiplied by the shadowscale attribute
of :ref:`map <map>`. For directional lights this volume is a box, whose half-sizes in the directions orthogonal to
the light are the model extent multiplied by the shadowclip attribute of :ref:`map <map>`. The model extent is
computed by the compiler but can also be overridden by specifying the extent attribute of :ref:`statistic
<statistic>`. Internally the shadow-mapping mechanism renders the scene from the light viewpoint (as if it were a
camera) into a depth texture, and then renders again from the camera viewpoint, using the depth texture to create
shadows. The internal rendering pass uses the same near and far clipping planes as regular rendering, i.e., these
clipping planes bound the cone or box shadow volume in the light direction. As a result, some shadows (especially
those very close to the light) may be clipped.
:at:`active`: :at-val:`[false, true], "true"`
The light is active if this attribute is "true". This can be used at runtime to turn lights on and off.
:at:`pos`: :at-val:`real(3), "0 0 0"`
Position of the light. This attribute only affects the rendering for spotlights, but it should also be defined for
directional lights because we render the cameras as decorative elements.
:at:`dir`: :at-val:`real(3), "0 0 -1"`
Direction of the light.
:at:`attenuation`: :at-val:`real(3), "1 0 0"`
These are the constant, linear and quadratic attenuation coefficients in OpenGL. The default corresponds to no
attenuation. See the OpenGL documentation for more information on this and all other OpenGL-related properties.
:at:`cutoff`: :at-val:`real, "45"`
Cutoff angle for spotlights, always in degrees regardless of the global angle setting.
:at:`exponent`: :at-val:`real, "10"`
Exponent for spotlights. This setting controls the softness of the spotlight cutoff.
:at:`ambient`: :at-val:`real(3), "0 0 0"`
The ambient color of the light.
:at:`diffuse`: :at-val:`real(3), "0.7 0.7 0.7"`
The diffuse color of the light.
:at:`specular`: :at-val:`real(3), "0.3 0.3 0.3"`
The specular color of the light.
.. _composite:
:el-prefix:`body/` **composite** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This is not a model element, but rather a macro which expands into multiple model elements representing a composite
object. These elements are bodies (with their own joints, geoms and sites) that become children of the parent body
containing the macro, as well as tendons and equality constraints added to the corresponding model sections. The
automatically-generated bodies are laid out in a regular grid in 1D, 2D or 3D depending on the object type and count
attributes. The macro expansion is done by the model compiler. If the resulting model is then saved, the macro will be
replaced with the actual model elements. The defaults mechanism used in the rest of MJCF does not apply here, even if
the parent body has a childclass attribute defined. Instead there are internal defaults adjusted automatically for each
composite object type. Composite objects can only be defined if the model is in local coordinates. Using them in global
coordinates results in compiler error. See :ref:`CComposite` in the modeling guide for more detailed explanation.
:at:`prefix`: :at-val:`string, optional`
All automatically generated model elements have names indicating the element type and index. For example, the body at
coordinates (2, 0) in a 2D grid is named "B2_0" by default. If prefix="C" is specified, the same body is named
"CB2_0". The prefix is needed when multiple composite objects are used in the same model, to avoid name conflicts.
:at:`type`: :at-val:`[particle, grid, rope, loop, cloth, box, cylinder, ellipsoid], required`
This attribute determines the type of composite object. The remaining attributes and sub-elements are then
interpreted according to the type. Default settings are also adjusted depending on the type.
The **particle** type creates a 1D, 2D or 3D grid of equally-spaced bodies. Each body has a single sphere geom and 3
orthogonal sliding joints, allowing translation but not rotation. The geom condim and priority attributes are set to
1 by default. This makes the spheres have frictionless contacts with all other geoms (unless the priority of some
frictional geom is higher).
The **grid** type creates a 1D or 2D grid of bodies, each having a sphere geom, a sphere site, and 3 orthogonal
sliding joints by default. The :el:`pin` sub-element can be used to specify that some bodies should not have joints,
and instead should be pinned to the parent body. Unlike the particle type, here each two neighboring bodies are
connected with a spatial tendon whose length is equality-constrained to its initial value (the sites are needed to
define the tendons). The "main" tendons are parallel to the axes of the grid. In addition one can create diagonal
"shear" tendons, using the :el:`tendon` sub-element. This type is suitable for simulating strings as well as cloth.
The **rope** type creates a 1D grid of bodies, each having a geom with user-defined type (sphere, capsule or
ellipsoid) and 2 hinge joints with axes orthogonal to the grid, creating a universal joint with the previous body.
This corresponds to a kinematic chain which can bend but cannot stretch or twist. In addition, one can specify
stretch and twist joints (slide and hinge respectively) with the :el:`joint` sub-element. When specified, these extra
joints are equality-constrained, but the constraint is soft by default so that some stretch and twist are possible.
The rope can extend in one or both directions from the parent body. To specify the origin of the rope, the parent
body *must* be named so that it fits the automatic naming convention. For example, to make the parent be the first
body in the chain, and assuming we have prefix="C", the parent body should be named "CB0". When the parent is not at
the end, the rope consists of two kinematic chains starting at the parent and extending in opposite directions.
The **loop** type is the same as the rope type except the elements are arranged in a circle, and the first and last
elements are equality-constrained to remain connected (using the "connect" constraint type). The softness of this
equality constraint is adjusted with the attributes solrefsmooth and solimpsmooth.
The **cloth** type is a different way to model cloth, beyond type="grid". Here the elements are connected with
universal joints and form a kinematic spanning tree. The root of the tree is the parent body, and its coordinates in
the grid are inferred from its name - similar to rope but here the naming format is "CB2_0". Neighboring bodies that
are not connected with joints are then connected with equality-constrained spatial tendons. The resulting cloth is
non-homogeneous, because the kinematic constraints cannot be violated while the tendon equality constraints are soft.
One can make it more homogeneous by adding stretch and twist joints (similar to rope) and adjusting the strength of
their equality constraints. Shear tendons can also be added. In addition to the different physics, cloth can do
things that a 2D grid cannot do. This is because the elements of cloth have both position and orientation, while the
elements of grid can only translate. The geoms used in cloth can be ellipsoids and capsules in addition to spheres.
When elongated geoms are used, they are rotated and interleaved in a pattern that fills the holes, preventing objects
from penetrating the cloth. Furthermore the inertia of the cloth elements can be modified with the flatinertia
attribute, and can then be used with lift and drag forces to simulate ripple effects.
The **box** type creates a 3D arrangement of bodies forming the outer shell of a (soft) box. The parent body is at
the center of the box. Each element body has a geom (sphere, ellipsoid or capsule) and a single sliding joint
pointing away from the center of the box. The sliding joints are equality-constrained to their initial value.
Furthermore, to achieve smooth deformations of the sides of the box, each joint is equality-constrained to remain
equal to its neighbor joints. To preserve the volume of the soft box approximately, a fixed tendon is used to
constrain the sum of all joints to remain constant. When the user specifies elongated geoms (capsules or ellipsoids)
their long axis is aligned with the sliding joint axis. This makes the shell thicker for collision detection
purposes, preventing objects from penetrating the box. It is important to disable contacts between the elements of
the box. This is done by setting the default geom contype to 0. The user can change it of course, but if the geoms
comprising the soft box are allowed to contact each other the model will not work as intended.
The **cylinder** and **ellipsoid** types are the same as box, except the elements are projected on the surface of an
ellipsoid or a cylinder respectively. Thus the composite soft body shape is different, while everything else is the
same as in the box type.
:at:`count`: :at-val:`int(3), required`
The element count in each dimension of the grid. This can have 1, 2 or 3 numbers, specifying the element count along
the X, Y and Z axis of the parent body frame within. Any missing numbers default to 1. If any of these numbers is 1,
all subsequent numbers must also be 1, so that the leading dimensions of the grid are used. This means for example
that a 1D grid will always extend along the X axis. To achieve a different orientation, rotate the frame of the
parent body. Note that some types imply a grid of certain dimensionality, so the requirements for this attribute
depend on the specified type.
:at:`spacing`: :at-val:`real, required`
The spacing between the centers of the grid elements. This spacing is the same in all dimensions. It should normally
be set to a value larger than the geom size, otherwise there will be a lot of contacts in the reference model
configuration (which is allowed but rarely desirable).
:at:`offset`: :at-val:`real(3), "0 0 0"`
This attribute affects particle and grid types, and is ignored for all other types. It specifies a 3D offset from the
center of the parent body to the center of the grid of elements. The offset is expressed in the local coordinate
frame of the parent body.
:at:`flatinertia`: :at-val:`real, "0"`
This attribute affects the cloth type and is ignored for all other types. The default value 0 disables this
mechanism. When the value is positive, it specifies the ratio of the small-to-large axes of the modified diagonal
inertia. The idea is to set it to a small value, say 0.01, in which case the inertias of the body elements will
corresponds to flat boxes aligned with the cloth (which can then be used for lift forces). This will not change the
geom shapes, but instead will set the body inertias directly and disable the automatic computation of inertia from
geom shape for the composite body only.
:at:`solrefsmooth`, :at:`solimpsmooth`
These are the solref and solimp attributes of the loop-closure equality constraint for loop types, and the
smoothness-preserving equality constraint for box, cylinder and ellipsoid types. For all other types they have no
effect. They obey the same rules as all other solref and solimp attributes in MJCF, except their defaults here are
adjusted depending on the composite type. See :ref:`CSolver`.
.. _composite-joint:
:el-prefix:`body/composite/` **joint** (*)
''''''''''''''''''''''''''''''''''''''''''
Depending on the composite type, some joints are created automatically (e.g. the universal joints in rope) while other
joints are optional (e.g. the stretch and twist joints in rope). This sub-element is used to specify which optional
joints should be created, as well as to adjust the attributes of both automatic and optional joints.
:at:`kind`: :at-val:`[main, twist, stretch], required`
The joint kind here is orthogonal to the joint type in the rest of MJCF. The joint kind refers to the function of the
joint within the mechanism comprising the composite body, while the joint type (hinge or slide) is implied by the
joint kind and composite body type.
The **main** kind corresponds to the main joints forming each composite type. These joints are automatically included
in the model even if the joint sub-element is missing. The main joints are 3D sliders for particle and grid; 1D
sliders for box, cylinder and rope; universal joints for cloth, rope and loop. Even though the main joints are
included automatically, this sub-element is still useful for adjusting their attributes.
The **twist** kind corresponds to hinge joints enabling rope, loop and cloth objects to twist. These are optional
joints and are only created if this sub-element is present. This sub-element is also used to adjust the attributes of
the optional twist joints. For other composite object types this sub-element has no effect.
The **stretch** kind corresponds to slide joints enabling rope, loop and cloth objects to stretch. These are optional
joints and are only created if this sub-element is present. This sub-element is also used to adjust the attributes of
the optional stretch joints. For other composite object types this sub-element has no effect.
:at:`solreffix`, :at:`solimpfix`
These are the solref and solimp attributes used to equality-constrain the joint. Whether or not a given joint is
quality-constrained depends on the joint kind and composite object type as explained above. For joints that are not
equality-constrained, this attribute has no effect. The defaults are adjusted depending on the composite type.
Otherwise these attributes obey the same rules as all other solref and solimp attributes in MJCF. See :ref:`Solver
parameters <CSolver>`.
.. |body/composite/joint attrib list| replace::
:at:`group`, :at:`stiffness`, :at:`damping`, :at:`armature`, :at:`limited`, :at:`range`, :at:`margin`,
:at:`solreflimit`, :at:`solimplimit`, :at:`frictionloss`, :at:`solreffriction`, :at:`solimpfriction`
|body/composite/joint attrib list|
Same meaning as regular :ref:`joint <joint>` attributes.
.. _composite-tendon:
:el-prefix:`body/composite/` **tendon** (*)
'''''''''''''''''''''''''''''''''''''''''''
Tendons are treated similarly to joints in composite objects. The tendon kind specified here together with the composite
body type imply the tendon type as used in the rest of MJCF. This sub-element is used to both create optional tendons,
and adjust the attributes of automatic and optional tendons. One difference from joints is that all tendons used in
composite objects are equality-constrained.
:at:`kind`: :at-val:`[main, shear], required`
The **main** kind corresponds to tendons holding the composite body together. These are the spatial tendons that
connect neighboring bodies in grid and cloth, and the fixed tendon used to preserve the volume of box, cylinder and
ellipsoid. For other composite types this sub-element has no effect.
The **shear** kind corresponds to diagonal tendons that prevent shear (as opposed to enabling - which is the function
of optional joints). Such tendons can be created in 2D grid objects and cloth objects. For all other composite object
types this sub-element has no effect.
:at:`solreffix`, :at:`solimpfix`
These are the solref and solimp attributes used to equality-constrain the tendon. The defaults are adjusted depending
on the composite type. Otherwise these attributes obey the same rules as all other solref and solimp attributes in
MJCF. See :ref:`CSolver`.
.. |body/composite/tendon attrib list| replace::
:at:`group`, :at:`stiffness`, :at:`damping`, :at:`limited`, :at:`range`, :at:`margin`, :at:`solreflimit`,
:at:`solimplimit`, :at:`frictionloss`, :at:`solreffriction`, :at:`solimpfriction`, :at:`material`, :at:`rgba`,
:at:`width`
|body/composite/tendon attrib list|
Same meaning as regular :ref:`tendon <tendon>` attributes.
.. _composite-geom:
:el-prefix:`body/composite/` **geom** (?)
'''''''''''''''''''''''''''''''''''''''''
This sub-element adjusts the attributes of the geoms in the composite object. The default attributes are the same as in
the rest of MJCF (except that user-defined defaults have no effect here). Note that the geom sub-element can appears
only once, unlike joint and tendon sub-elements which can appear multiple times. This is because different kinds of
joints and tendons have different sets of attributes, while all geoms in the composite object are identical.
.. |body/composite/geom attrib list| replace::
:at:`type`, :at:`contype`, :at:`conaffinity`, :at:`condim`, :at:`group`, :at:`priority`, :at:`size`, :at:`material`,
:at:`rgba`, :at:`friction`, :at:`mass`, :at:`density`, :at:`solmix`, :at:`solref`, :at:`solimp`, :at:`margin`,
:at:`gap`
|body/composite/geom attrib list|
Same meaning as regular :ref:`geom <geom>` attributes.
.. _composite-site:
:el-prefix:`body/composite/` **site** (?)
'''''''''''''''''''''''''''''''''''''''''
This sub-element adjusts the attributes of the sites in the composite object. Otherwise it is the same as geom above.
:at:`group`, :at:`size`, :at:`material`, :at:`rgba`
Same meaning as regular :ref:`site <site>` attributes.
.. _composite-skin:
:el-prefix:`body/composite/` **skin** (?)
'''''''''''''''''''''''''''''''''''''''''
If this element is included, the model compiler will generate a skinned mesh asset and attach it to the element bodies
of the composite object. Skin can be attached to 2D grid, cloth, box, cylinder and ellipsoid. For other composite types
it has no effect. Note that the skin created here is equivalent to a skin specified directly in the XML, as opposed to a
skin loaded from file. So if the model is saved as XML, it will contain a large section describing the
automatically-generated skin.
:at:`texcoord`: :at-val:`[false, true], "false"`
If this is true, explicit texture coordinates will be generated, mapping the skin to the unit square in texture
space. This is needed when the material specifies a texture. If texcoord is false and the skin has texture, the
texture will appear fixed to the world instead of the skin. The reason for having this attribute in the first place
is because skins with texture coordinates upload these coordinates to the GPU even if no texture is applied later. So
this attribute should be set to false in cases where no texture will be applied via the material attribute.
:at:`material`, :at:`rgba`
Same meaning as in :ref:`geom <geom>`.
:at:`inflate`: :at-val:`real, "0"`
The default value of 0 means that the automatically-generated skin passes through the centers of the body elements
comprising the composite object. Positive values offset each skin vertex by the specified amount, in the direction
normal to the (non-inflated) skin at that vertex. This has two uses. First, in 2D objects, a small positive inflate
factor is needed to avoid aliasing artifacts. Second, collisions are done with geoms that create some thickness, even
for 2D objects. Inflating the skin with a value equal to the geom size will render the skin as a "mattress" that
better represents the actual collision geometry. The value of this attribute is copied into the corresponding
attribute of the :el:`skin` asset being created.
:at:`subgrid`: :at-val:`int, "0"`
This is only applicable to cloth and 2D grid types, and has no effect for any other composite type. The default value
of 0 means that the skin has as many vertices as the number of element bodies. A positive value causes subdivision,
with the specified number of (additional) grid lines. In this case the model compiler generates a denser skin using
bi-cubic interpolation. This increases the quality of the rendering (especially in the absence of textures) but also
slows down the renderer, so use it with caution. Values above 3 are unlikely to be needed.
.. _composite-pin:
:el-prefix:`body/composite/` **pin** (*)
''''''''''''''''''''''''''''''''''''''''
This sub-element can be used to pin some of the element bodies in grid objects (both 1D and 2D). Pinning means that the
corresponding body has no joints, and therefore it is rigidly fixed to the parent body. When the parent is the world,
this has the effect of hanging a string or a cloth in space. If the parent body is moving, this can be used to model a
handle where the composite object is attached. For other composite types this sub-element has no effect.
:at:`coord`: :at-val:`int(2), required`
The grid coordinates of the element body which should be pinned. The coordinates are zero-based. For 1D grids this
attribute can have only one number, in which case the second number is automatically set to 0.
.. _contact:
**contact** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a grouping element and does not have any attributes. It groups elements that are used to adjust the generation
of candidate contact pairs for collision checking. :ref:`Collision` was described in detail in the Computation chapter,
thus the description here is brief.
.. _pair:
:el-prefix:`contact/` **pair** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a predefined geom pair, which will be checked for collision if the collision attribute of
:ref:`option <option>` is set to "all" or "predefined". Unlike dynamically generated pairs whose properties are inferred
from the corresponding geom properties, the pairs created here specify all their properties explicitly or through
defaults, and the properties of the individual geoms are not used. Anisotropic friction can only be created with this
element.
:at:`name`: :at-val:`string, optional`
Name of this contact pair.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`geom1`: :at-val:`string, required`
The name of the first geom in the pair.
:at:`geom2`: :at-val:`string, required`
The name of the second geom in the pair. The contact force vector computed by the solver and stored in
mjData.efc_force points from the first towards the second geom by convention. The forces applied to the system are of
course equal and opposite, so the order of geoms does not affect the physics.
:at:`condim`: :at-val:`int, "3"`
The dimensionality of the contacts generated by this geom pair.
:at:`friction`: :at-val:`real(5), "1 1 0.005 0.0001 0.0001"`
The friction coefficients of the contacts generated by this geom pair. Making the first two coefficients different
results in anisotropic tangential friction. Making the last two coefficients different results in anisotropic rolling
friction. The length of this array is not enforced by the parser, and can be smaller than 5. This is because some of
the coefficients may not be used, depending on the contact dimensionality. Unspecified coefficients remain equal to
their defaults.
:at:`solref`, :at:`solimp`
Constraint solver parameters for contact simulation. See :ref:`CSolver`.
:at:`margin`: :at-val:`real, "0"`
Distance threshold below which contacts are detected and included in the global array mjData.contact.
:at:`gap`: :at-val:`real, "0"`
This attribute is used to enable the generation of inactive contacts, i.e., contacts that are ignored by the
constraint solver but are included in mjData.contact for the purpose of custom computations. When this value is
positive, geom distances between margin and margin-gap correspond to such inactive contacts.
.. _exclude:
:el-prefix:`contact/` **exclude** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element is used to exclude a pair of bodies from collision checking. Unlike all other contact-related elements
which refer to geoms, this element refers to bodies. Experience has shown that exclusion is more useful on the level of
bodies. The collision between any geom defined in the first body and any geom defined in the second body is excluded.
The exclusion rules defined here are applied only when the collision attribute of :ref:`option <option>` is set to "all"
or "dynamic". Setting this attribute to "predefined" disables the exclusion mechanism and the geom pairs defined with
the :ref:`pair <pair>` element above are checked for collisions.
:at:`name`: :at-val:`string, optional`
Name of this exclude pair.
:at:`body1`: :at-val:`string, required`
The name of the first body in the pair.
:at:`body2`: :at-val:`string, required`
The name of the second body in the pair.
.. _equality:
**equality** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a grouping element for equality constraints. It does not have attributes. See the :ref:`Equality <coEquality>`
section of the Computation chapter for a detailed description of equality constraints. Several attributes are common to
all equality constraint types, thus we document them only once, under the :ref:`connect <equality-connect>` element.
.. _equality-connect:
:el-prefix:`equality/` **connect** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates an equality constraint that connects two bodies at a point. The point is not necessarily within the
geoms volumes of either body. This constraint can be used to define ball joints outside the kinematic tree.
:at:`name`: :at-val:`string, optional`
Name of the equality constraint.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`active`: :at-val:`[false, true], "true"`
If this attribute is set to "true", the constraint is active and the constraint solver will try to enforce it. The
corresponding field in mjModel is mjData.eq_active. This field can be used at runtime to turn specific constraints on
an off.
:at:`solref`, :at:`solimp`
Constraint solver parameters for equality constraint simulation. See :ref:`CSolver`.
:at:`body1`: :at-val:`string, required`
Name of the first body participating in the constraint.
:at:`body2`: :at-val:`string, optional`
Name of the second body participating in the constraint. If this attribute is omitted, the second body is the world
body.
:at:`anchor`: :at-val:`real(3), required`
Coordinates of the 3D anchor point where the two bodies are connected. In the compiled mjModel the anchor is stored
twice, relative to the local frame of each body. At runtime this yields two global points computed by forward
kinematics; the constraint solver pushes these points towards each other. In the MJCF model however only one point is
given. We assume that the equality constraint is exactly satisfied in the configuration in which the model is defined
(this applies to all other constraint types as well). The compiler uses the single anchor specified in the MJCF model
to compute the two body-relative anchor points in mjModel. If the MJCF model is in global coordinates, as determined
by the coordinate attribute of :ref:`compiler <compiler>`, the anchor is specified in global coordinates. Otherwise
the anchor is specified relative to the local coordinate frame of the *first* body.
.. _equality-weld:
:el-prefix:`equality/` **weld** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a weld equality constraint. It attaches two bodies to each other, removing all relative degrees of
freedom between them (softly of course, like all other constraints in MuJoCo). The two bodies are not required to be
close to each other. The relative body position and orientation being enforced by the constraint solver is the one in
which the model was defined. Note that two bodies can also be welded together rigidly, by defining one body as a child
of the other body, without any joint elements in the child body.
:at:`name`, :at:`class`, :at:`active`, :at:`solref`, :at:`solimp`
Same as in :ref:`connect <equality-connect>` element.
:at:`body1`: :at-val:`string, required`
Name of the first body.
:at:`body2`: :at-val:`string, optional`
Name of the second body. If this attribute is omitted, the second body is the world body. Welding a body to the world
and changing the corresponding component of mjModel.eq_active at runtime can be used to fix the body temporarily.
:at:`relpose`: :at-val:`real(7), "0 1 0 0 0 0 0"`
This attribute specifies the relative pose (3D position followed by 4D quaternion orientation) of body2 relative to
body1. If the quaternion part (i.e., last 4 components of the vector) are all zeros, as in the default setting, this
attribute is ignored and the relative pose is the one corresponding to the model reference pose in qpos0. The unusual
default is because all equality constraint types share the same default for their numeric parameters.
:at:`anchor`: :at-val:`real(3), "0 0 0"`
Coordinates of the weld point relative to body2. If :at:`relpose` is not specified, the meaning of
this parameter is the same as for connect constraints, except that is relative to body2. If :at:`relpose` is
specified, body1 will use the pose to compute its anchor point.
:at:`torquescale`: :at-val:`real, "1"`
Relative torque-to-force ratio. This ratio is used by the weld to scale how much it "cares" about rotational
displacements vs. translational displacements. Setting this value to 0 makes the :el:`weld` behave like a
:el:`connect` constraint. Note that this value has units of length and can therefore be interpreted as follows.
Imagining that the weld is implemented by a patch of glue sticking the two bodies together, :at:`torquescale` can be
interpreted as the diameter of this glue patch.
.. _equality-joint:
:el-prefix:`equality/` **joint** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element constrains the position or angle of one joint to be a quartic polynomial of another joint. Only scalar
joint types (slide and hinge) can be used.
:at:`name`, :at:`class`, :at:`active`, :at:`solref`, :at:`solimp`
Same as in :ref:`connect <equality-connect>` element.
:at:`joint1`: :at-val:`string, required`
Name of the first joint.
:at:`joint2`: :at-val:`string, optional`
Name of the second joint. If this attribute is omitted, the first joint is fixed to a constant.
:at:`polycoef`: :at-val:`real(5), "0 1 0 0 0"`
Coefficients a0 ... a4 of the quartic polynomial. If the two joint values are y and x, and their reference positions
(corresponding to the joint values in the initial model configuration) are y0 and x0, the constraint is:
y-y0 = a0 + a1*(x-x0) + a2*(x-x0)^2 + a3*(x-x0)^3 + a4*(x-x0)^4
Omitting the second joint is equivalent to setting x = x0, in which case the constraint is y = y0 + a0.
.. _equality-tendon:
:el-prefix:`equality/` **tendon** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element constrains the length of one tendon to be a quartic polynomial of another tendon.
:at:`name`, :at:`class`, :at:`active`, :at:`solref`, :at:`solimp`
Same as in :ref:`connect <equality-connect>` element.
:at:`tendon1`: :at-val:`string, required`
Name of the first tendon.
:at:`tendon2`: :at-val:`string, optional`
Name of the second tendon. If this attribute is omitted, the first tendon is fixed to a constant.
:at:`polycoef`: :at-val:`real(5), "0 1 0 0 0"`
Same as in the equality/ :ref:`joint <equality-joint>` element above, but applied to tendon lengths instead of joint
positions.
.. _equality-distance:
:el-prefix:`equality/` **distance** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Distance equality constraints were removed in MuJoCo version 2.2.2. If you are using an earlier version, please switch
to the corresponding version of the documentation.
.. _tendon:
**tendon** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Grouping element for tendon definitions. The attributes of fixed tendons are a subset of the attributes of spatial
tendons, thus we document them only once under spatial tendons. Tendons can be used to impose length limits, simulate
spring, damping and dry friction forces, as well as attach actuators to them. When used in equality constraints, tendons
can also represent different forms of mechanical coupling.
.. _spatial:
:el-prefix:`tendon/` **spatial** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. figure:: images/modeling/tendon.png
:width: 400px
:align: right
This element creates a spatial tendon, which is a minimum-length path passing through specified via-points and
wrapping around specified obstacle geoms. The objects along the path are defined with the sub-elements
:ref:`site <spatial-site>` and :ref:`geom <spatial-geom>` below. One can also define :ref:`pulleys <spatial-pulley>`
which split the path in multiple branches. Each branch of the tendon path must start and end with a site, and if it
has multiple obstacle geoms they must be separated by sites - so as to avoid the need for an iterative solver at the
tendon level. This example illustrates a multi-branch tendon acting as a finger extensor, with a counter-weight
instead of an actuator.
MuJoCo 2.0 introduced a second form of wrapping, where the tendon is constrained to pass through a geom rather than
wrap around it. This is enabled automatically when a sidesite is specified and its position is inside the volume of
the obstacle geom.
`tendon.xml <_static/tendon.xml>`__
:at:`name`: :at-val:`string, optional`
Name of the tendon.
:at:`class`: :at-val:`string, optional`
Defaults class for setting unspecified attributes.
:at:`group`: :at-val:`int, "0"`
Integer group to which the tendon belongs. This attribute can be used for custom tags. It is also used by the
visualizer to enable and disable the rendering of entire groups of tendons.
:at:`limited`: :at-val:`[false, true, auto], "auto"`
If this attribute is "true", the length limits defined by the range attribute below are imposed by the constraint
solver. If this attribute is "auto", and :at:`autolimits` is set in :ref:`compiler <compiler>`, length limits
will be enabled if range is defined.
:at:`range`: :at-val:`real(2), "0 0"`
Range of allowed tendon lengths. Setting this attribute without specifying :at:`limited` is an error, unless
:at:`autolimits` is set in :ref:`compiler <compiler>`.
:at:`solreflimit`, :at:`solimplimit`
Constraint solver parameters for simulating tendon limits. See :ref:`CSolver`.
:at:`solreffriction`, :at:`solimpfriction`
Constraint solver parameters for simulating dry friction in the tendon. See :ref:`CSolver`.
:at:`margin`: :at-val:`real, "0"`
The limit constraint becomes active when the absolute value of the difference between the tendon length and either
limit of the specified range falls below this margin. Similar to contacts, the margin parameter is subtracted from
the difference between the range limit and the tendon length. The resulting constraint distance is always negative
when the constraint is active. This quantity is used to compute constraint impedance as a function of distance, as
explained in :ref:`CSolver`.
:at:`frictionloss`: :at-val:`real, "0"`
Friction loss caused by dry friction. To enable friction loss, set this attribute to a positive value.
:at:`width`: :at-val:`real, "0.003"`
Radius of the cross-section area of the spatial tendon, used for rendering. Parts of the tendon that wrap around geom
obstacles are rendered with reduced width.
:at:`material`: :at-val:`string, optional`
Material used to set the appearance of the tendon.
:at:`rgba`: :at-val:`real(4), "0.5 0.5 0.5 1"`
Color and transparency of the tendon. When this value is different from the internal default, it overrides the
corresponding material properties.
:at:`springlength`: :at-val:`real, "-1"`
The length of the tendon corresponding to the spring resting position. If this value is negative, the tendon resting
length is determined from the model reference configuration in qpos0.
:at:`stiffness`: :at-val:`real, "0"`
Stiffness coefficient. A positive value generates a spring force (linear in position) acting along the tendon.
:at:`damping`: :at-val:`real, "0"`
Damping coefficient. A positive value generates a damping force (linear in velocity) acting along the tendon. Unlike
joint damping which is integrated implicitly by the Euler method, tendon damping is not integrated implicitly, thus
joint damping should be used if possible.
:at:`user`: :at-val:`real(nuser_tendon), "0 0 ..."`
See :ref:`CUser`.
.. _spatial-site:
:el-prefix:`tendon/spatial/` **site** (*)
'''''''''''''''''''''''''''''''''''''''''
This attribute specifies a site that the tendon path has to pass through. Recall that sites are rigidly attached to
bodies.
:at:`site`: :at-val:`string, required`
The name of the site that the tendon must pass through.
.. _spatial-geom:
:el-prefix:`tendon/spatial/` **geom** (*)
'''''''''''''''''''''''''''''''''''''''''
This element specifies a geom that acts as an obstacle for the tendon path. If the minimum-length path does not touch
the geom it has no effect; otherwise the path wraps around the surface of the geom. Wrapping is computed analytically,
which is why we restrict the geom types allowed here to spheres and cylinders. The latter are treated as having infinite
length for tendon wrapping purposes. If a sidesite is defined, and its position is inside the geom, then the tendon is
constrained to pass through the geom instead of passing around it.
:at:`geom`: :at-val:`string, required`
The name of a geom that acts as an obstacle for the tendon path. Only sphere and cylinder geoms can be referenced
here.
:at:`sidesite`: :at-val:`string, optional`
To prevent the tendon path from snapping from one side of the geom to the other as the model configuration varies,
the user can define a preferred "side" of the geom. At runtime, the wrap that is closer to the specified site is
automatically selected. Specifying a side site is often needed in practice. If the side site is inside the geom, the
tendon is constrained to pass through the interior of the geom.
.. _spatial-pulley:
:el-prefix:`tendon/spatial/` **pulley** (*)
'''''''''''''''''''''''''''''''''''''''''''
This element starts a new branch in the tendon path. The branches are not required to be connected spatially. Similar to
the transmissions described in the :ref:`Actuation model <geActuation>` section of the Computation
chapter, the quantity that affects the simulation is the tendon length and its gradient with respect to the joint
positions. If a spatial tendon has multiple branches, the length of each branch is divided by the divisor attribute of
the pulley element that started the branch, and added up to obtain the overall tendon length. This is why the spatial
relations among branches are not relevant to the simulation. The `tendon.xml <_static/tendon.xml>`__ example above
illustrated the use of pulleys.
:at:`divisor`: :at-val:`real, required`
The length of the tendon branch started by the pulley element is divided by the value specified here. For a physical
pulley that splits a single branch into two parallel branches, the common branch would have divisor value of 1 and
the two branches following the pulley would have divisor values of 2. If one of them is further split by another
pulley, each new branch would have divisor value of 4 and so on. Note that in MJCF each branch starts with a pulley,
thus a single physical pulley is modeled with two MJCF pulleys. If no pulley elements are included in the tendon
path, the first and only branch has divisor value of 1.
.. _fixed:
:el-prefix:`tendon/` **fixed** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates an abstract tendon whose length is defined as a linear combination of joint positions. Recall that
the tendon length and its gradient are the only quantities needed for simulation. Thus we could define any scalar
function of joint positions, call it "tendon", and plug it in MuJoCo. Presently the only such function is a fixed linear
combination. The attributes of fixed tendons are a subset of the attributes of spatial tendons and have the same meaning
as above.
.. |tendon/fixed attrib list| replace::
:at:`name`, :at:`class`, :at:`group`, :at:`limited`, :at:`range`, :at:`solreflimit`, :at:`solimplimit`,
:at:`solreffriction`, :at:`solimpfriction`, :at:`frictionloss`, :at:`margin`, :at:`springlength`, :at:`stiffness`,
:at:`damping`, :at:`user`
|tendon/fixed attrib list|
Same as in the :ref:`spatial <spatial>` element.
.. _fixed-joint:
:el-prefix:`tendon/fixed/` **joint** (*)
''''''''''''''''''''''''''''''''''''''''
This element adds a joint to the computation of the fixed tendon length. The position or angle of each included joint is
multiplied by the corresponding coef value, and added up to obtain the tendon length.
:at:`joint`: :at-val:`string, required`
Name of the joint to be added to the fixed tendon. Only scalar joints (slide and hinge) can be referenced here.
:at:`coef`: :at-val:`real, required`
Scalar coefficient multiplying the position or angle of the specified joint.
.. _actuator:
**actuator** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a grouping element for actuator definitions. Recall the discussion of MuJoCo's :ref:`Actuation model
<geActuation>` in the Computation chapter, and the :ref:`Actuator shortcuts <CActuator>` discussed earlier in this
chapter. The first 13 attributes of all actuator-related elements below are the same, so we document them only once,
under the :el:`general` actuator.
.. _general:
:el-prefix:`actuator/` **general** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a general actuator, providing full access to all actuator components and allowing the user to
specify them independently.
:at:`name`: :at-val:`string, optional`
Element name. See :ref:`CName`.
:at:`class`: :at-val:`string, optional`
Active defaults class. See :ref:`CDefault`.
:at:`group`: :at-val:`int, "0"`
Integer group to which the actuator belongs. This attribute can be used for custom tags. It is also used by the
visualizer to enable and disable the rendering of entire groups of actuators.
:at:`ctrllimited`: :at-val:`[false, true, auto], "auto"`
If true, the control input to this actuator is automatically clamped to :at:`ctrlrange` at runtime. If false, control
input clamping is disabled. If "auto" and :at:`autolimits` is set in :ref:`compiler <compiler>`, control
clamping will automatically be set to true if :at:`ctrlrange` is defined without explicitly setting this attribute
to "true". Note that control input clamping can also be globally disabled with the :at:`clampctrl` attribute of
:ref:`option/flag <option-flag>`.
:at:`forcelimited`: :at-val:`[false, true, auto], "auto"`
If true, the force output of this actuator is automatically clamped to :at:`forcerange` at runtime. If false, force
clamping is disabled. If "auto" and :at:`autolimits` is set in :ref:`compiler <compiler>`, force clamping will
automatically be set to true if :at:`forcerange` is defined without explicitly setting this attribute to "true".
:at:`actlimited`: :at-val:`[false, true, auto], "auto"`
If true, the internal state (activation) associated with this actuator is automatically clamped to :at:`actrange` at
runtime. If false, activation clamping is disabled. If "auto" and :at:`autolimits` is set in
:ref:`compiler <compiler>`, activation clamping will automatically be set to true if :at:`actrange` is defined
without explicitly setting this attribute to "true". See the :ref:`Activation clamping <CActRange>` section for more
details.
:at:`ctrlrange`: :at-val:`real(2), "0 0"`
Range for clamping the control input. The compiler expects the first value to be smaller than the second value.
|br| Setting this attribute without specifying :at:`ctrllimited` is an error, unless :at:`autolimits` is set in
:ref:`compiler <compiler>`.
:at:`forcerange`: :at-val:`real(2), "0 0"`
Range for clamping the force output. The compiler expects the first value to be no greater than the second value.
|br| Setting this attribute without specifying :at:`forcelimited` is an error, unless :at:`autolimits` is set in
:ref:`compiler <compiler>`.
:at:`actrange`: :at-val:`real(2), "0 0"`
Range for clamping the activation state. The compiler expects the first value to be no greater than the second value.
See the :ref:`Activation clamping <CActRange>` section for more details.
|br| Setting this attribute without specifying :at:`actlimited` is an error, unless :at:`autolimits` is set in
:ref:`compiler <compiler>`.
:at:`lengthrange`: :at-val:`real(2), "0 0"`
Range of feasible lengths of the actuator's transmission. See :ref:`Length Range <CLengthRange>`.
:at:`gear`: :at-val:`real(6), "1 0 0 0 0 0"`
This attribute scales the length (and consequently moment arms, velocity and force) of the actuator, for all
transmission types. It is different from the gain in the force generation mechanism, because the gain only scales the
force output and does not affect the length, moment arms and velocity. For actuators with scalar transmission, only
the first element of this vector is used. The remaining elements are needed for joint, jointinparent and site
transmissions where this attribute is used to specify 3D force and torque axes.
:at:`cranklength`: :at-val:`real, "0"`
Used only for the slider-crank transmission type. Specifies the length of the connecting rod. The compiler expects
this value to be positive when a slider-crank transmission is present.
:at:`joint`: :at-val:`string, optional`
This and the next four attributes determine the type of actuator transmission. All of them are optional, and exactly
one of them must be specified. If this attribute is specified, the actuator acts on the given joint. For **hinge**
and **slide** joints, the actuator length equals the joint position/angle times the first element of :at:`gear`. For
**ball** joints, the first three elements of gear define a 3d rotation axis in the child frame around which the
actuator produces torque. The actuator length is defined as the dot-product between this gear axis and the angle-axis
representation of the joint quaternion, and is in units of radian if :at:`gear` is normalized (generally scaled by
by the norm of :at:`gear`). Note that after total rotation of more than :math:`\pi`, the length will wrap to :math:`-
\pi`, and vice-versa. Therefore :el:`position` servos for ball joints should generally use tighter limits which
prevent this wrapping. For **free** joints, gear defines a 3d translation axis in the world frame followed by a 3d
rotation axis in the child frame. The actuator generates force and torque relative to the specified axes. The
actuator length for free joints is defined as zero (so it should not be used with position servos).
:at:`jointinparent`: :at-val:`string, optional`
Identical to joint, except that for ball and free joints, the 3d rotation axis given by gear is defined in the parent
frame (which is the world frame for free joints) rather than the child frame.
:at:`site`: :at-val:`string, optional`
This transmission can apply force and torque at a site. The gear vector defines a 3d translation axis followed by a
3d rotation axis. Both are defined in the site's frame. This can be used to model jets and propellers. The effect is
similar to actuating a free joint, and the actuator length is defined as zero unless a :at:`refsite` is defined (see
below). One difference from the :at:`joint` and :at:`jointinparent` transmissions above is that here the actuator
operates on a site rather than a joint, but this difference disappears when the site is defined at the frame origin
of the free-floating body. The other difference is that for site transmissions both the translation and rotation axes
are defined in local coordinates. In contrast, translation is global and rotation is local for :at:`joint`, and both
translation and rotation are global for :at:`jointinparent`.
.. youtube:: s-0JHanqV1A
:align: right
:height: 150px
:at:`refsite`: :at-val:`string, optional`
When using a :at:`site` transmission, measure the translation and rotation w.r.t the frame of the :at:`refsite`. In
this case the actuator *does* have length and :el:`position` actuators can be used to directly control an end
effector, see `refsite.xml <https://github.com/deepmind/mujoco/tree/main/test/engine/testdata/refsite.xml>`_ example
model. As above, the length is the dot product of the :at:`gear` vector and the frame difference. So ``gear="0 1 0 0
0 0"`` means "Y-offset of :at:`site` in the :at:`refsite` frame", while ``gear="0 0 0 0 0 1"`` means rotation "Z-
rotation of :at:`site` in the :at:`refsite` frame". It is recommended to use a normalized :at:`gear` vector with
nonzeros in only the first 3 *or* the last 3 elements of :at:`gear`, so the actuator length will be in either length
units or radians, respectively. As with ball joints (see :at:`joint` above), for rotations which exceed a total angle
of :math:`\pi` will wrap around, so tighter limits are recommended.
:at:`body`: :at-val:`string, optional`
This transmission can apply linear forces at contact points in the direction of the contact normal. The set of
contacts is all those belonging to the specified :at:`body`. This can be used to model natural active adhesion
mechanisms like the feet of geckos and insects. The actuator length is again defined as zero. For more information,
see the :ref:`adhesion<adhesion>` shortcut below.
:at:`tendon`: :at-val:`string, optional`
If specified, the actuator acts on the given tendon. The actuator length equals the tendon length times the gear
ratio. Both spatial and fixed tendons can be used.
:at:`cranksite`: :at-val:`string, optional`
If specified, the actuator acts on a slider-crank mechanism which is implicitly determined by the actuator (i.e., it
is not a separate model element). The specified site corresponds to the pin joining the crank and the connecting rod.
The actuator length equals the position of the slider-crank mechanism times the gear ratio.
:at:`slidersite`: :at-val:`string, required for slider-crank transmission`
Used only for the slider-crank transmission type. The specified site is the pin joining the slider and the connecting
rod. The slider moves along the z-axis of the slidersite frame. Therefore the site should be oriented as needed when
it is defined in the kinematic tree; its orientation cannot be changed in the actuator definition.
:at:`user`: :at-val:`real(nuser_actuator), "0 ... 0"`
See :ref:`CUser`.
:at:`dyntype`: :at-val:`[none, integrator, filter, muscle, user], "none"`
Activation dynamics type for the actuator. The available dynamics types were already described in the :ref:`Actuation
model <geActuation>` section. Repeating that description in somewhat different notation (corresponding to the mjModel
and mjData fields involved) we have:
========== ==================================
Keyword Description
========== ==================================
none No internal state
integrator act_dot = ctrl
filter act_dot = (ctrl - act) / dynprm[0]
muscle act_dot = mju_muscleDynamics(...)
user act_dot = mjcb_act_dyn(...)
========== ==================================
:at:`gaintype`: :at-val:`[fixed, muscle, user], "fixed"`
The gain and bias together determine the output of the force generation mechanism, which is currently assumed to be
affine. As already explained in :ref:`Actuation model <geActuation>`, the general formula is:
scalar_force = gain_term \* (act or ctrl) + bias_term.
The formula uses the activation state when present, and the control otherwise. The keywords have the following
meaning:
======= ===============================
Keyword Description
======= ===============================
fixed gain_term = gainprm[0]
muscle gain_term = mju_muscleGain(...)
user gain_term = mjcb_act_gain(...)
======= ===============================
:at:`biastype`: :at-val:`[none, affine, muscle, user], "none"`
The keywords have the following meaning:
======= ================================================================
Keyword Description
======= ================================================================
none bias_term = 0
affine bias_term = biasprm[0] + biasprm[1]*length + biasprm[2]*velocity
muscle bias_term = mju_muscleBias(...)
user bias_term = mjcb_act_bias(...)
======= ================================================================
:at:`dynprm`: :at-val:`real(10), "1 0 ... 0"`
Activation dynamics parameters. The built-in activation types (except for muscle) use only the first parameter, but
we provide additional parameters in case user callbacks implement a more elaborate model. The length of this array is
not enforced by the parser, so the user can enter as many parameters as needed. These defaults are not compatible
with muscle actuators; see :ref:`muscle <muscle>` below.
:at:`gainprm`: :at-val:`real(10), "1 0 ... 0"`
Gain parameters. The built-in gain types (except for muscle) use only the first parameter, but we provide additional
parameters in case user callbacks implement a more elaborate model. The length of this array is not enforced by the
parser, so the user can enter as many parameters as needed. These defaults are not compatible with muscle actuators;
see :ref:`muscle <muscle>` below.
:at:`biasprm`: :at-val:`real(10), "0 ... 0"`
Bias parameters. The affine bias type uses three parameters. The length of this array is not enforced by the parser,
so the user can enter as many parameters as needed. These defaults are not compatible with muscle actuators; see
:ref:`muscle <muscle>` below.
.. _motor:
:el-prefix:`actuator/` **motor** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This and the next three elements are the :ref:`Actuator shortcuts <CActuator>` discussed earlier. When a
such shortcut is encountered, the parser creates a :el:`general` actuator and sets its dynprm, gainprm and biasprm
attributes to the internal defaults shown above, regardless of any default settings. It then adjusts dyntype, gaintype
and biastype depending on the shortcut, parses any custom attributes (beyond the common ones), and translates them
into regular attributes (i.e., attributes of the :el:`general` actuator type) as explained here.
This element creates a direct-drive actuator. The underlying :el:`general` attributes are set as follows:
========= ======= ========= =======
Attribute Setting Attribute Setting
========= ======= ========= =======
dyntype none dynprm 1 0 0
gaintype fixed gainprm 1 0 0
biastype none biasprm 0 0 0
========= ======= ========= =======
This element does not have custom attributes. It only has common attributes, which are:
.. |actuator/motor attrib list| replace::
:at:`name`, :at:`class`, :at:`group`, :at:`ctrllimited`, :at:`forcelimited`, :at:`ctrlrange`, :at:`forcerange`,
:at:`lengthrange`, :at:`gear`, :at:`cranklength`, :at:`joint`, :at:`jointinparent`, :at:`tendon`, :at:`cranksite`,
:at:`slidersite`, :at:`site`, :at:`user`
|actuator/motor attrib list|
Same as in actuator/ :ref:`general <general>`.
.. _position:
:el-prefix:`actuator/` **position** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a position servo. The underlying :el:`general` attributes are set as follows:
========= ======= ========= =======
Attribute Setting Attribute Setting
========= ======= ========= =======
dyntype none dynprm 1 0 0
gaintype fixed gainprm kp 0 0
biastype affine biasprm 0 -kp 0
========= ======= ========= =======
This element has one custom attribute in addition to the common attributes:
.. |actuator/position attrib list| replace::
:at:`name`, :at:`class`, :at:`group`, :at:`ctrllimited`, :at:`forcelimited`, :at:`ctrlrange`, :at:`forcerange`,
:at:`lengthrange`, :at:`gear`, :at:`cranklength`, :at:`joint`, :at:`jointinparent`, :at:`tendon`, :at:`cranksite`,
:at:`slidersite`, :at:`site`, :at:`user`
|actuator/position attrib list|
Same as in actuator/ :ref:`general <general>`.
:at:`kp`: :at-val:`real, "1"`
Position feedback gain.
.. _velocity:
:el-prefix:`actuator/` **velocity** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a velocity servo. Note that in order create a PD controller, one has to define two actuators: a
position servo and a velocity servo. This is because MuJoCo actuators are SISO while a PD controller takes two control
inputs (reference position and reference velocity). The underlying :el:`general` attributes are set as follows:
========= ======= ========= =======
Attribute Setting Attribute Setting
========= ======= ========= =======
dyntype none dynprm 1 0 0
gaintype fixed gainprm kv 0 0
biastype affine biasprm 0 0 -kv
========= ======= ========= =======
This element has one custom attribute in addition to the common attributes:
.. |actuator/velocity attrib list| replace::
:at:`name`, :at:`class`, :at:`group`, :at:`ctrllimited`, :at:`forcelimited`, :at:`ctrlrange`, :at:`forcerange`,
:at:`lengthrange`, :at:`gear`, :at:`cranklength`, :at:`joint`, :at:`jointinparent`, :at:`tendon`, :at:`cranksite`,
:at:`slidersite`, :at:`site`, :at:`user`
|actuator/velocity attrib list|
Same as in actuator/ :ref:`general <general>`.
:at:`kv`: :at-val:`real, "1"`
Velocity feedback gain.
.. _intvelocity:
:el-prefix:`actuator/` **intvelocity** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates an integrated-velocity servo. For more information, see the
:ref:`Activation clamping <CActRange>` section of the Modeling chapter. The underlying
:el:`general` attributes are set as follows:
========== =========== ========= =======
Attribute Setting Attribute Setting
========== =========== ========= =======
dyntype integrator dynprm 1 0 0
gaintype fixed gainprm kp 0 0
biastype affine biasprm 0 -kp 0
actlimited true
========== =========== ========= =======
This element has one custom attribute in addition to the common attributes:
.. |actuator/intvelocity attrib list| replace::
:at:`name`, :at:`class`, :at:`group`, :at:`ctrllimited`, :at:`forcelimited`, :at:`ctrlrange`, :at:`forcerange`,
:at:`lengthrange`, :at:`gear`, :at:`cranklength`, :at:`joint`, :at:`jointinparent`, :at:`tendon`, :at:`cranksite`,
:at:`slidersite`, :at:`site`, :at:`user`
|actuator/intvelocity attrib list|
Same as in actuator/ :ref:`general <general>`.
:at:`kp`: :at-val:`real, "1"`
Position feedback gain.
.. _damper:
:el-prefix:`actuator/` **damper** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element is an active damper which produces a force proportional to both velocity and control: ``F = - kv * velocity
* control``, where ``kv`` must be nonnegative. :at:`ctrlrange` is required and must also be nonnegative. The underlying
:el:`general` attributes are set as follows:
=========== ======= ========= =======
Attribute Setting Attribute Setting
=========== ======= ========= =======
dyntype none dynprm 1 0 0
gaintype affine gainprm 0 0 -kv
biastype none biasprm 0 0 0
ctrllimited true
=========== ======= ========= =======
This element has one custom attribute in addition to the common attributes:
.. |actuator/damper attrib list| replace:: :at:`name`, :at:`class`, :at:`group`, :at:`ctrllimited`, :at:`forcelimited`,
:at:`ctrlrange`, :at:`forcerange`, :at:`lengthrange`, :at:`gear`, :at:`cranklength`, :at:`joint`,
:at:`jointinparent`, :at:`tendon`, :at:`cranksite`, :at:`slidersite`, :at:`site`, :at:`user`
|actuator/damper attrib list|
Same as in actuator/ :ref:`general <general>`.
:at:`kv`: :at-val:`real, "1"`
Velocity feedback gain.
.. _cylinder:
:el-prefix:`actuator/` **cylinder** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element is suitable for modeling pneumatic or hydraulic cylinders. The underlying :el:`general` attributes are
set as follows:
========= ======= ========= =============
Attribute Setting Attribute Setting
========= ======= ========= =============
dyntype filter dynprm timeconst 0 0
gaintype fixed gainprm area 0 0
biastype affine biasprm bias(3)
========= ======= ========= =============
This element has four custom attributes in addition to the common attributes:
.. |actuator/cylinder attrib list| replace::
:at:`name`, :at:`class`, :at:`group`, :at:`ctrllimited`, :at:`forcelimited`, :at:`ctrlrange`, :at:`forcerange`,
:at:`lengthrange`, :at:`gear`, :at:`cranklength`, :at:`joint`, :at:`jointinparent`, :at:`tendon`, :at:`cranksite`,
:at:`slidersite`, :at:`site`, :at:`user`
|actuator/cylinder attrib list|
Same as in actuator/ :ref:`general <general>`.
:at:`timeconst`: :at-val:`real, "1"`
Time constant of the activation dynamics.
:at:`area`: :at-val:`real, "1"`
Area of the cylinder. This is used internally as actuator gain.
:at:`diameter`: :at-val:`real, optional`
Instead of area the user can specify diameter. If both are specified, diameter has precedence.
:at:`bias`: :at-val:`real(3), "0 0 0"`
Bias parameters, copied internally into biasprm.
.. _muscle:
:el-prefix:`actuator/` **muscle** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element is used to model a muscle actuator, as described in the :ref:`Muscles actuators <CMuscle>`
section. The underlying :el:`general` attributes are set as follows:
========= ======= ========= ======================================================
Attribute Setting Attribute Setting
========= ======= ========= ======================================================
dyntype muscle dynprm timeconst(2)
gaintype muscle gainprm range(2), force, scale, lmin, lmax, vmax, fpmax, fvmax
biastype muscle biasprm same as gainprm
========= ======= ========= ======================================================
This element has nine custom attributes in addition to the common attributes:
.. |actuator/muscle attrib list| replace::
:at:`name`, :at:`class`, :at:`group`, :at:`ctrllimited`, :at:`forcelimited`, :at:`ctrlrange`, :at:`forcerange`,
:at:`lengthrange`, :at:`gear`, :at:`cranklength`, :at:`joint`, :at:`jointinparent`, :at:`tendon`, :at:`cranksite`,
:at:`slidersite`, :at:`user`
|actuator/muscle attrib list|
Same as in actuator/ :ref:`general <general>`.
:at:`timeconst`: :at-val:`real(2), "0.01 0.04"`
Time constants for activation and de-activation dynamics.
:at:`range`: :at-val:`real(2), "0.75 1.05"`
Operating length range of the muscle, in units of L0.
:at:`force`: :at-val:`real, "-1"`
Peak active force at rest. If this value is negative, the peak force is determined automatically using the scale
attribute below.
:at:`scale`: :at-val:`real, "200"`
If the force attribute is negative, the peak active force for the muscle is set to this value divided by
mjModel.actuator_acc0. The latter is the norm of the joint-space acceleration vector caused by unit force on the
actuator's transmission in qpos0. In other words, scaling produces higher peak forces for muscles that pull more
weight.
:at:`lmin`: :at-val:`real, "0.5"`
Lower position range of the normalized FLV curve, in units of L0.
:at:`lmax`: :at-val:`real, "1.6"`
Upper position range of the normalized FLV curve, in units of L0.
:at:`vmax`: :at-val:`real, "1.5"`
Shortening velocity at which muscle force drops to zero, in units of L0 per second.
:at:`fpmax`: :at-val:`real, "1.3"`
Passive force generated at lmax, relative to the peak rest force.
:at:`fvmax`: :at-val:`real, "1.2"`
Active force generated at saturating lengthening velocity, relative to the peak rest force.
.. _adhesion:
:el-prefix:`actuator/` **adhesion** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. youtube:: BcHZ5BFeTmU
:align: right
:height: 150px
This element defines an active adhesion actuator which injects forces at contacts in the normal direction, see
illustration video. The model shown in the video can be found `here
<https://github.com/deepmind/mujoco/tree/main/model/adhesion>`_ and includes inline annotations. The transmission target
is a :el:`body`, and adhesive forces are injected into all contacts involving geoms which belong to this body. The force
is divided equally between multiple contacts. When the :at:`gap` attribute is not used, this actuator requires active
contacts and cannot apply a force at a distance, more like the active adhesion on the feet of geckos and insects rather
than an industrial vacuum gripper. In order to enable "suction at a distance", "inflate" the body's geoms by
:at:`margin` and add a corresponding :at:`gap` which activates contacts only after :at:`gap` penetration distance. This
will create a layer around the geom where contacts are detected but are inactive, and can be used for
applying the adhesive force. In the video above, such inactive contacts are blue, while active contacts are orange.
An adhesion actuator's length is always 0. :at:`ctrlrange` is required and must also be nonnegative (no repulsive forces
are allowed). The underlying :el:`general` attributes are set as follows:
=========== ======= =========== ========
Attribute Setting Attribute Setting
=========== ======= =========== ========
dyntype none dynprm 1 0 0
gaintype fixed gainprm gain 0 0
biastype none biasprm 0 0 0
trntype body ctrllimited true
=========== ======= =========== ========
This element has a subset of the common attributes and two custom attributes.
.. |actuator/adhesion attrib list| replace:: :at:`name`, :at:`class`, :at:`group`,
:at:`forcelimited`, :at:`ctrlrange`, :at:`forcerange`, :at:`user`
|actuator/adhesion attrib list|
Same as in actuator/ :ref:`general <general>`.
:at:`body`: :at-val:`string, required`
The actuator acts on all contacts involving this body's geoms.
:at:`gain`: :at-val:`real, "1"`
Gain of the adhesion actuator, in units of force. The total adhesion force applied by the actuator is the control
value multiplied by the gain. This force is distributed equally between all the contacts involving geoms belonging
to the target body.
.. _sensor:
**sensor** (*)
~~~~~~~~~~~~~~
This is a grouping element for sensor definitions. It does not have attributes. The outputs of all sensors are
concatenated in the field mjData.sensordata which has size mjModel.nsensordata. This data is not used in any internal
computations.
In addition to the sensors created with the elements below, the top-level function
:ref:`mj_step` computes the quantities mjData.cacc, mjData.cfrc_int and mjData.crfc_ext
corresponding to body accelerations and interaction forces. Some of these quantities are used to compute the output of
certain sensors (force, acceleration etc.) but even if no such sensors are defined in the model, these quantities
themselves are "features" that could be of interest to the user.
.. _sensor-touch:
:el-prefix:`sensor/` **touch** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a touch sensor. The active sensor zone is defined by a site. If a contact point falls within the
site's volume, and involves a geom attached to the same body as the site, the corresponding contact force is included in
the sensor reading. If a contact point falls outside the sensor zone, but the normal ray intersects the sensor zone, it
is also included. This re-projection feature is needed because, without it, the contact point may leave the sensor zone
from the back (due to soft contacts) and cause an erroneous force reading. The output of this sensor is non-negative
scalar. It is computed by adding up the (scalar) normal forces from all included contacts.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
Site defining the active sensor zone.
.. _sensor-accelerometer:
:el-prefix:`sensor/` **accelerometer** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a 3-axis accelerometer. The sensor is mounted at a site, and has the same position and orientation
as the site frame. This sensor outputs three numbers, which are the linear acceleration of the site (including gravity)
in local coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
Site where the sensor is mounted. The accelerometer is centered and aligned with the site local frame.
.. _sensor-velocimeter:
:el-prefix:`sensor/` **velocimeter** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a 3-axis velocimeter. The sensor is mounted at a site, and has the same position and orientation as
the site frame. This sensor outputs three numbers, which are the linear velocity of the site in local coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
Site where the sensor is mounted. The velocimeter is centered and aligned with the site local frame.
.. _sensor-gyro:
:el-prefix:`sensor/` **gyro** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a 3-axis gyroscope. The sensor is mounted at a site, and has the same position and orientation as
the site frame. This sensor outputs three numbers, which are the angular velocity of the site in local coordinates. This
sensor is often used in conjunction with an :ref:`accelerometer <sensor-accelerometer>` mounted at the same site, to
simulate an inertial measurement unit (IMU).
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
Site where the sensor is mounted. The gyroscope is centered and aligned with the site local frame.
.. _sensor-force:
:el-prefix:`sensor/` **force** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a 3-axis force sensor. The sensor outputs three numbers, which are the interaction force between a
child and a parent body, expressed in the site frame defining the sensor. The convention is that the site is attached to
the child body, and the force points from the child towards the parent. The computation here takes into account all
forces acting on the system, including contacts as well as external perturbations. Using this sensor often requires
creating a dummy body welded to its parent (i.e., having no joint elements).
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
Site where the sensor is mounted. The measured interaction force is between the body where the site is defined and
its parent body, and points from the child towards the parent. The physical sensor being modeled could of course be
attached to the parent body, in which case the sensor data would have the opposite sign. Note that each body has a
unique parent but can have multiple children, which is why we define this sensor through the child rather than the
parent body in the pair.
.. _sensor-torque:
:el-prefix:`sensor/` **torque** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a 3-axis torque sensor. This is similar to the :ref:`force <sensor-force>` sensor above, but
measures torque rather than force.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
Site where the sensor is mounted. The measured interaction torque is between the body where the site is defined and
its parent body.
.. _sensor-magnetometer:
:el-prefix:`sensor/` **magnetometer** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a magnetometer. It measures the magnetic flux at the sensor site position, expressed in the sensor
site frame. The output is a 3D vector.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
The site where the sensor is attached.
.. _sensor-rangefinder:
:el-prefix:`sensor/` **rangefinder** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a rangefinder. It measures the distance to the nearest geom surface, along the ray defined by the
positive Z-axis of the sensor site. If the ray does not intersect any geom surface, the sensor output is -1. If the
origin of the ray is inside a geom, the surface is still sensed (but not the inner volume). Geoms attached to the same
body as the sensor site are excluded. Invisible geoms, defined as geoms whose rgba (or whose material rgba) has alpha=0,
are also excluded. Note however that geoms made invisible in the visualizer by disabling their geom group are not
excluded; this is because sensor calculations are independent of the visualizer.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`site`: :at-val:`string, required`
The site where the sensor is attached.
.. _sensor-jointpos:
:el-prefix:`sensor/` **jointpos** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This and the remaining sensor elements do not involve sensor-specific computations. Instead they copy into the array
mjData.sensordata quantities that are already computed. This element creates a joint position or angle sensor. It can be
attached to scalar joints (slide or hinge). Its output is scalar.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`joint`: :at-val:`string, required`
The joint whose position or angle will be sensed. Only scalar joints can be referenced here. The sensor output is
copied from mjData.qpos.
.. _sensor-jointvel:
:el-prefix:`sensor/` **jointvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a joint velocity sensor. It can be attached to scalar joints (slide or hinge). Its output is
scalar.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`joint`: :at-val:`string, required`
The joint whose velocity will be sensed. Only scalar joints can be referenced here. The sensor output is copied from
mjData.qvel.
.. _sensor-tendonpos:
:el-prefix:`sensor/` **tendonpos** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a tendon length sensor. It can be attached to both spatial and fixed tendons. Its output is scalar.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`tendon`: :at-val:`string, required`
The tendon whose length will be sensed. The sensor output is copied from mjData.ten_length.
.. _sensor-tendonvel:
:el-prefix:`sensor/` **tendonvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a tendon velocity sensor. It can be attached to both spatial and fixed tendons. Its output is
scalar.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`tendon`: :at-val:`string, required`
The tendon whose velocity will be sensed. The sensor output is copied from mjData.ten_velocity.
.. _sensor-actuatorpos:
:el-prefix:`sensor/` **actuatorpos** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates an actuator length sensor. Recall that each actuator has a transmission which has length. This
sensor can be attached to any actuator. Its output is scalar.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`actuator`: :at-val:`string, required`
The actuator whose transmission's length will be sensed. The sensor output is copied from mjData.actuator_length.
.. _sensor-actuatorvel:
:el-prefix:`sensor/` **actuatorvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates an actuator velocity sensor. This sensor can be attached to any actuator. Its output is scalar.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`actuator`: :at-val:`string, required`
The actuator whose transmission's velocity will be sensed. The sensor output is copied from mjData.actuator_velocity.
.. _sensor-actuatorfrc:
:el-prefix:`sensor/` **actuatorfrc** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates an actuator force sensor. The quantity being sensed is the scalar actuator force, not the
generalized force contributed by the actuator (the latter is the product of the scalar force and the vector of moment
arms determined by the transmission). This sensor can be attached to any actuator. Its output is scalar.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`actuator`: :at-val:`string, required`
The actuator whose scalar force output will be sensed. The sensor output is copied from mjData.actuator_force.
.. _sensor-ballquat:
:el-prefix:`sensor/` **ballquat** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a quaternion sensor for a ball joints. It outputs 4 numbers corresponding to a unit quaternion.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`joint`: :at-val:`string, required`
The ball joint whose quaternion is sensed. The sensor output is copied from mjData.qpos.
.. _sensor-ballangvel:
:el-prefix:`sensor/` **ballangvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a ball joint angular velocity sensor. It outputs 3 numbers corresponding to the angular velocity of
the joint. The norm of that vector is the rotation speed in rad/s and the direction is the axis around which the
rotation takes place.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`joint`: :at-val:`string, required`
The ball joint whose angular velocity is sensed. The sensor output is copied from mjData.qvel.
.. _sensor-jointlimitpos:
:el-prefix:`sensor/` **jointlimitpos** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a joint limit sensor for position.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`joint`: :at-val:`string, required`
The joint whose limit is sensed. The sensor output equals mjData.efc_pos - mjData.efc_margin for the corresponding
limit constraint. Note that the result is negative if the limit is violated, regardless of which side of the limit is
violated. If both sides of the limit are violated simultaneously, only the first component is returned. If there is
no violation, the result is 0.
.. _sensor-jointlimitvel:
:el-prefix:`sensor/` **jointlimitvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a joint limit sensor for velocity.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`joint`: :at-val:`string, required`
The joint whose limit is sensed. The sensor output is copied from mjData.efc_vel. If the joint limit is not violated,
the result is 0.
.. _sensor-jointlimitfrc:
:el-prefix:`sensor/` **jointlimitfrc** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a joint limit sensor for constraint force.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`joint`: :at-val:`string, required`
The joint whose limit is sensed. The sensor output is copied from mjData.efc_force. If the joint limit is not
violated, the result is 0.
.. _sensor-tendonlimitpos:
:el-prefix:`sensor/` **tendonlimitpos** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a tendon limit sensor for position.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`tendon`: :at-val:`string, required`
The tendon whose limit is sensed. The sensor output equals mjData.efc_pos - mjData.efc_margin for the corresponding
limit constraint. If the tendon limit is not violated, the result is 0.
.. _sensor-tendonlimitvel:
:el-prefix:`sensor/` **tendonlimitvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a tendon limit sensor for velocity.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`tendon`: :at-val:`string, required`
The tendon whose limit is sensed. The sensor output is copied from mjData.efc_vel. If the tendon limit is not
violated, the result is 0.
.. _sensor-tendonlimitfrc:
:el-prefix:`sensor/` **tendonlimitfrc** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a tendon limit sensor for constraint force.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`tendon`: :at-val:`string, required`
The tendon whose limit is sensed. The sensor output is copied from mjData.efc_force. If the tendon limit is not
violated, the result is 0.
.. _sensor-framepos:
:el-prefix:`sensor/` **framepos** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D position of the spatial frame of the object, in global coordinates or
optionally with respect to a given frame-of-reference.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
The type of object to which the sensor is attached. This must be an object type that has a spatial frame. "body"
refers to the inertial frame of the body, while "xbody" refers to the regular frame of the body (usually centered at
the joint with the parent body).
:at:`objname`: :at-val:`string, required`
The name of the object to which the sensor is attached.
:at:`reftype`: :at-val:`[body, xbody, geom, site, camera]`
The type of object to which the frame-of-reference is attached. The semantics are identical to the :at:`objtype`
attribute. If :at:`reftype` and :at:`refname` are given, the sensor values will be measured with respect to this
frame. If they are not given, sensor values will be measured with respect to the global frame.
:at:`refname`: :at-val:`string`
The name of the object to which the frame-of-reference is attached.
.. _sensor-framequat:
:el-prefix:`sensor/` **framequat** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the unit quaternion specifying the orientation of the spatial frame of the
object, in global coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`reftype`: :at-val:`[body, xbody, geom, site, camera]`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`refname`: :at-val:`string`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-framexaxis:
:el-prefix:`sensor/` **framexaxis** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D unit vector corresponding to the X-axis of the spatial frame of the
object, in global coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`reftype`: :at-val:`[body, xbody, geom, site, camera]`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`refname`: :at-val:`string`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-frameyaxis:
:el-prefix:`sensor/` **frameyaxis** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D unit vector corresponding to the Y-axis of the spatial frame of the
object, in global coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`reftype`: :at-val:`[body, xbody, geom, site, camera]`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`refname`: :at-val:`string`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-framezaxis:
:el-prefix:`sensor/` **framezaxis** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D unit vector corresponding to the Z-axis of the spatial frame of the
object, in global coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`reftype`: :at-val:`[body, xbody, geom, site, camera]`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`refname`: :at-val:`string`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-framelinvel:
:el-prefix:`sensor/` **framelinvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D linear velocity of the spatial frame of the object, in global
coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`reftype`: :at-val:`[body, xbody, geom, site, camera]`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`refname`: :at-val:`string`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-frameangvel:
:el-prefix:`sensor/` **frameangvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D angular velocity of the spatial frame of the object, in global
coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`reftype`: :at-val:`[body, xbody, geom, site, camera]`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`refname`: :at-val:`string`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-framelinacc:
:el-prefix:`sensor/` **framelinacc** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D linear acceleration of the spatial frame of the object, in global
coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-frameangacc:
:el-prefix:`sensor/` **frameangacc** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a sensor that returns the 3D angular acceleration of the spatial frame of the object, in global
coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`[body, xbody, geom, site, camera], required`
See :ref:`framepos<sensor-framepos>` sensor.
:at:`objname`: :at-val:`string, required`
See :ref:`framepos<sensor-framepos>` sensor.
.. _sensor-subtreecom:
:el-prefix:`sensor/` **subtreecom** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates sensor that returns the center of mass of the kinematic subtree rooted at a specified body, in
global coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`body`: :at-val:`string, required`
Name of the body where the kinematic subtree is rooted.
.. _sensor-subtreelinvel:
:el-prefix:`sensor/` **subtreelinvel** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates sensor that returns the linear velocity of the center of mass of the kinematic subtree rooted at a
specified body, in global coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`body`: :at-val:`string, required`
Name of the body where the kinematic subtree is rooted.
.. _sensor-subtreeangmom:
:el-prefix:`sensor/` **subtreeangmom** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates sensor that returns the angular momentum around the center of mass of the kinematic subtree rooted
at a specified body, in global coordinates.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`body`: :at-val:`string, required`
Name of the body where the kinematic subtree is rooted.
.. _sensor-clock:
:el-prefix:`sensor/` **clock** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates sensor that returns the simulation time.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
.. _sensor-user:
:el-prefix:`sensor/` **user** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element creates a user sensor. MuJoCo does not know how to compute the output of this sensor. Instead the user
should install the callback :ref:`mjcb_sensor` which is expected to fill in the sensor data in mjData.sensordata. The
specification in the XML is used to allocate space for this sensor, and also determine which MuJoCo object it is
attached to and what stage of computation it needs before the data can be computed. Note that the MuJoCo object
referenced here can be a tuple, which in turn can reference a custom collection of MuJoCo objects - for example several
bodies whose center of mass is of interest.
:at:`name`, :at:`noise`, :at:`cutoff`, :at:`user`
See :ref:`CSensor`.
:at:`objtype`: :at-val:`(any element type that can be named), required`
Type of the MuJoCo object to which the sensor is attached. This together with the objname attribute determines the
actual object.
:at:`objname`: :at-val:`string, required`
Name of the MuJoCo object to which the sensor is attached.
:at:`datatype`: :at-val:`[real, positive, axis, quaternion], required`
The type of output generated by this sensor. "axis" means a unit-length 3D vector. "quat" means a unit quaternion.
These need to be declared because when MuJoCo adds noise, it must respect the vector normalization. "real" means a
generic array (or scalar) of real values to which noise can be added independently.
:at:`needstage`: :at-val:`[pos, vel, acc], required`
The MuJoCo computation stage that must be completed before the user callback mjcb_sensor() is able to evaluate the
output of this sensor.
:at:`dim`: :at-val:`int, required`
Number of scalar outputs of this sensor.
.. _keyframe:
**keyframe** (*)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a grouping element for keyframe definitions. It does not have attributes. Keyframes can be used to create a
library of states that are of interest to the user, and to initialize the simulation state to one of the states in the
library. They are not needed by any MuJoCo computations. The number of keyframes allocated in mjModel is the larger of
the nkey attribute of :ref:`size <size>`, and the number of elements defined here. If fewer than nkey elements are
defined here, the undefined keyframes have all their data set to 0, except for the qpos attribute which is set to
mjModel.qpos0.
The user can also set keyframe data in mjModel at runtime; this data will then appear in the saved MJCF model. Note that
in `simulate.cc <https://github.com/deepmind/mujoco/blob/main/sample/simulate.cc>`_ the simulation state can be copied
into a selected keyframe and vice versa.
.. _key:
:el-prefix:`keyframe/` **key** (*)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This element sets the data for one of the keyframes. They are set in the order in which they appear here.
:at:`name`: :at-val:`string, optional`
Name of this keyframe.
:at:`time`: :at-val:`real, "0"`
Simulation time, copied into mjData.time when the simulation state is set to this keyframe.
:at:`qpos`: :at-val:`real(mjModel.nq), default = mjModel.qpos0`
Vector of joint positions, copied into mjData.qpos when the simulation state is set to this keyframe.
:at:`qvel`: :at-val:`real(mjModel.nq), "0 0 ..."`
Vector of joint velocities, copied into mjData.qvel when the simulation state is set to this keyframe.
:at:`act`: :at-val:`real(mjModel.na), "0 0 ..."`
Vector of actuator activations, copied into mjData.act when the simulation state is set to this keyframe.
:at:`ctrl`: :at-val:`real(mjModel.nu), "0 0 ..."`
Vector of controls, copied into mjData.ctrl when the simulation state is set to this keyframe.
:at:`mpos`: :at-val:`real(3*mjModel.nmocap), default = mjModel.body_pos`
Vector of mocap body positions, copied into mjData.mocap_pos when the simulation state is set to this keyframe.
:at:`mquat`: :at-val:`real(4*mjModel.nmocap), default = mjModel.body_quat`
Vector of mocap body quaternions, copied into mjData.mocap_quat when the simulation state is set to this keyframe.
|
