-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Expand file tree
/
Copy pathparsing_doxygen.h
More file actions
1643 lines (1187 loc) · 67.9 KB
/
Copy pathparsing_doxygen.h
File metadata and controls
1643 lines (1187 loc) · 67.9 KB
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
/** @file
Doxygen-only documentation for @ref multibody_parsing. */
/**
@addtogroup multibody_parsing
@{
Drake's drake::multibody::Parser accepts model files written in a variety of
input formats. Drake's parsing of URDF, SDFormat, and MJCF (Mujoco XML) has
Drake-specific extensions and limitations.
The result of the parse is an in-memory model realized within
drake::multibody::MultibodyPlant and (optionally)
drake::geometry::SceneGraph. Note that parses that do not use a `SceneGraph`
will effectively ignore geometric model elements, especially `//visual` and
`//collision` elements. Without a `SceneGraph`, deformable models will also
be ignored.
In the reference sections below, when discussing XML formats, the relevant
usage paths for various tags are indicated using
[XPath](https://www.w3.org/TR/xpath-31/) notation.
@section multibody_parsing_dmd Drake Model Directives Support
Drake Model Directives is a Drake-native model description format, primarily
intended for combining models written in other formats into complex scenes. It
is YAML based, and follows a limited data schema. See
`multibody/parsing/README_model_directives.md` for more detail.
@section multibody_parsing_mjcf MJCF (Mujoco XML) Support
There is basic support for parsing MJCF (Mujoco XML) files. The files are
recognized by an .xml file extension. The scope of features that are actually
supported still need to be documented here, but the parser does log warnings
for any unsupported MuJoCo XML elements or attributes at runtime.
<!-- TODO(rpoyner-tri): document mujoco format support -->
@subsection mjcf_camera MuJoCo camera support
The MuJoCo camera element is supported (with any unsupported attributes
emitting the standard parser warnings). To parse cameras, you must register a
DiagramBuilder with the Parser, and the MultibodyPlant must have a registered
SceneGraph. The parser will call ApplyCameraConfig() to produce a camera named
"{model_instance_name}/{mjcf_camera_name}", where a default {mjcf_camera_name}
of "camera{i}" for the ith camera (starting from 0) will be provided if no name
is specified in the xml. Note that calling
`MultibodyPlant::RenameModelInstance` after parsing will not update the camera
name.
@subsection mjcf_ignored_silent Tags ignored silently
The following attributes are specific to the MuJoCo solver (listed here in the
order they are listed in the MuJoCo documentation); we have no plans to support
them:
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#option>`/option/`</a>
- `@apirate`
- `@impratio`
- `@jacobian`
- `@o_margin`
- `@o_solref`
- `@o_solimp`
- `@o_friction`
- `@solver`
- `@iterations`
- `@tolerance`
- `@ls_iterations`
- `@ls_tolerance`
- `@noslip_iterations`
- `@noslip_tolerance`
- `@ccd_iterations`
- `@ccd_tolerance`
- `@sdf_iterations`
- `@sdf_tolerance`
- `@sdf_initpoints`
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#compiler>`/compiler/`</a>
- `@usethread`
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#size>`/size`</a>
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#body-joint>`/body/joint/`</a>
- `@solreflimit`
- `@solimplimit`
- `@solreffriction`
- `@solimpfriction`
- `@margin`
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#body-geom>`/body/geom/`</a>
- `@priority`
- `@solmix`
- `@solref`
- `@solimp`
- `@margin`
- `@gap`
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#contact-pair>`/contact/pair/`</a>
- `@solref`
- `@solimp`
- `@solreffriction`
- `@margin`
- `@gap`
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#equality-connect>`/equality/connect/`</a>
- `@solref`
- `@solimp`
- <a href=https://mujoco.readthedocs.io/en/stable/XMLreference.html#custom>`/custom`</a>
@section multibody_parsing_sdf SDFormat Support
Drake supports SDFormat files following the specification at
http://sdformat.org/spec. As of this writing, the supported spec version is
1.9, but check also the Drake release notes for current status.
For Drake extensions to SDFormat files, see
@ref multibody_parsing_drake_extensions.
Drake's parser does not implement all of the features of SDFormat. In the
future, we intend to update this documentation to itemize what isn't supported.
@subsection model_composition SDFormat model composition
Drake's SDFormat parsing supports composing multiple models into a single
model, via lexical nesting and file inclusion. The file inclusion feature
supports both SDFormat files and URDF files. Note that included URDF files pass
through the Drake URDF parser, with all of its extensions and limitations.
For full details, see the
<a href='http://sdformat.org/tutorials?tut=composition_proposal#model-composition-proposed-behavior'>SDFormat documentation of model composition.</a>
An important feature of SDFormat model composition is the ability to
cross-reference features of other models. Cross-references are denoted by using
scoped names.
@subsubsection scoped_names Scoped names
Scoped names allow referring to an element of a model nested within the current
model. They take the form of some number of nested model names, plus the
element name, all joined by the delimiter `::`. Names not using the `::`
delimiter are not considered scoped names; they are used to define or refer to
elements of the current model. For example, suppose that model A contains model
B, which in turn contains model C. Here are some valid scoped names:
- within A:
- `some_frame_in_A`
- `B::some_frame_in_B`
- `B::C::some_frame_in_C`
- within B:
- `some_frame_in_B`
- `C::some_frame_in_C`
- within C:
- `some_frame_in_C`
Note that (deliberately) there is no way to refer to elements outward or upward
from the current model; all names are relative to the current model and can
only refer to the current or a nested model. In particular, names must not
start with `::`; there is no way to denote any "outer" or "outermost" scope.
For a detailed design discussion with examples, see the
<a href='http://sdformat.org/tutorials?tut=composition_proposal#1-3-name-scoping-and-cross-referencing'>SDFormat documentation of name scoping.</a>
@subsection tag_deformable_link_requirements Deformable link requirements
Drake supports specifying deformable bodies through SDFormat via custom tags as
an experimental feature. A `<link>` element is interpreted as a deformable body
if it contains a `<drake:deformable_properties>` element
(see @ref tag_drake_deformable_properties). In that case, there are several
requirements that must be satisfied:
- **Exactly one `<collision>` element**: The `<collision>` tag must be present,
but more than one `<collision>` tag is forbidden.
- **Geometry restriction**: the `<collision>/<geometry>` must contain a single
`<mesh>` whose URI points to a `.vtk` file that specifies a tetrahedral mesh;
primitive shapes are not yet supported. The geometry is used for both
collision and dynamics.
- **Limited proximity properties**: inside `<collision>`, the only Drake
proximity tag recognized are `<drake:mu_dynamic>`,
`<drake:hunt_crossley_dissipation>`, and `drake:relaxation_time>`.
All other tags are not allowed.
- **At most one `<visual>` element**: The default visual representation of the
deformable body is the surface of the simulated tetrahedral mesh. However,
a single `<visual>` element may be present to provide an alternative visual
representation of the deformable body. Currently, the visual geometry is
only used for rendering (and the surface of the simulated mesh is *always*
used for visualization). Therefore, it's only meaningful to specify a non-empty
`<geometry>` element if the `<drake:perception_properties>` element is not
disabled; otherwise, the geometry supplied will be ignored with a warning. The
`<geometry>` element, if non-empty, must contain a single `<mesh>` element, and
the URI of the mesh must point to a `.obj` file, and the (potentially textured)
surface described by the `.obj` file is used for rendering. More than one
`<visual>` is an error.
Violating any of these rules results in a *parsing error*.
@section multibody_parsing_urdf URDF Support
Drake supports URDF files as described here: http://wiki.ros.org/urdf/XML.
For Drake extensions to URDF format files, see
@ref multibody_parsing_drake_extensions.
@subsection multibody_parsing_urdf_unsupported URDF not supported by Drake
Drake's parser does not implement all of the features of URDF. Here is a list
of known URDF features that Drake does not use. For each, the parser applies
one of several treatments:
- Issue a warning that the tag is unused.
- Ignore silently, as documented below.
- Apply special treatment, as documented below.
@subsubsection urdf_ignored_warning Tags that provoke a warning
- `/robot/@version`
- `/robot/joint/calibration`
- `/robot/joint/safety_controller`
- `/robot/link/@type`
- `/robot/link/collision/verbose`
- `/robot/transmission/@name`
- `/robot/transmission/flexJoint`
- `/robot/transmission/gap_joint`
- `/robot/transmission/leftActuator`
- `/robot/transmission/passive_joint`
- `/robot/transmission/rightActuator`
- `/robot/transmission/rollJoint`
- `/robot/transmission/use_simulated_gripper_joint`
@subsubsection urdf_ignored_silent Tags ignored silently
- `/robot/gazebo`
- `/robot/transmission/actuator/hardwareInterface`
- `/robot/transmission/joint/hardwareInterface`
@subsubsection urdf_ignored_special Tags given special treatment.
- `/robot/transmission/actuator/mechanicalReduction`
- `/robot/transmission/mechanicalReduction`
Both versions of `mechanicalReduction` will be silently ignored if the supplied
value is 1; otherwise the they will provoke a warning that the value is being
ignored.
@section multibody_parsing_drake_extensions Drake Extensions
Drake extends both SDFormat and URDF in similar ways, to allow access to
Drake-specific features. This section provides a compact reference to all
Drake extensions and their use in both formats.
Note that in both formats, it is proper to declare the `drake:` namespace
prefix. For SDFormat, declare it like this:
<sdf xmlns:drake="http://drake.mit.edu" version="1.9">
For URDF, declare the namespace prefix like this:
<robot xmlns:drake="http://drake.mit.edu" name="test_robot">
Here is the full list of custom elements:
- @ref tag_drake_acceleration
- @ref tag_drake_accepting_renderer
- @ref tag_drake_angle
- @ref tag_drake_ball_constraint
- @ref tag_drake_ball_constraint_body_A
- @ref tag_drake_ball_constraint_body_B
- @ref tag_drake_ball_constraint_p_AP
- @ref tag_drake_ball_constraint_p_BQ
- @ref tag_drake_bushing_force_damping
- @ref tag_drake_bushing_force_stiffness
- @ref tag_drake_bushing_frameA
- @ref tag_drake_bushing_frameC
- @ref tag_drake_bushing_torque_damping
- @ref tag_drake_bushing_torque_stiffness
- @ref tag_drake_capsule
- @ref tag_drake_child
- @ref tag_drake_circular_arc
- @ref tag_drake_collision_filter_group
- @ref tag_drake_compliant_hydroelastic
- @ref tag_drake_controller_gains
- @ref tag_drake_curves
- @ref tag_drake_damping
- @ref tag_drake_declare_convex
- @ref tag_drake_deformable_properties
- @ref tag_drake_diffuse_map
- @ref tag_drake_ellipsoid
- @ref tag_drake_gear_ratio
- @ref tag_drake_hunt_crossley_dissipation
- @ref tag_drake_hydroelastic_margin
- @ref tag_drake_hydroelastic_modulus
- @ref tag_drake_ignored_collision_filter_group
- @ref tag_drake_illustration_properties
- @ref tag_drake_initial_tangent
- @ref tag_drake_is_periodic
- @ref tag_drake_joint
- @ref tag_drake_length
- @ref tag_drake_line_segment
- @ref tag_drake_linear_bushing_rpy
- @ref tag_drake_linear_spring_damper
- @ref tag_drake_linear_spring_damper_body_A
- @ref tag_drake_linear_spring_damper_p_AP
- @ref tag_drake_linear_spring_damper_body_B
- @ref tag_drake_linear_spring_damper_p_BQ
- @ref tag_drake_linear_spring_damper_free_length
- @ref tag_drake_linear_spring_damper_stiffness
- @ref tag_drake_linear_spring_damper_damping
- @ref tag_drake_mass_damping
- @ref tag_drake_mass_density
- @ref tag_drake_material_model
- @ref tag_drake_member
- @ref tag_drake_member_group
- @ref tag_drake_mesh_resolution_hint
- @ref tag_drake_mimic
- @ref tag_drake_mu_dynamic
- @ref tag_drake_mu_static
- @ref tag_drake_parent
- @ref tag_drake_perception_properties
- @ref tag_drake_plane_normal
- @ref tag_drake_point_contact_stiffness
- @ref tag_drake_poissons_ratio
- @ref tag_drake_proximity_properties
- @ref tag_drake_radius
- @ref tag_drake_relaxation_time
- @ref tag_drake_rigid_hydroelastic
- @ref tag_drake_rotor_inertia
- @ref tag_drake_screw_thread_pitch
- @ref tag_drake_stiffness_damping
- @ref tag_drake_surface_velocity_axis
- @ref tag_drake_tendon_constraint
- @ref tag_drake_tendon_constraint_joint
- @ref tag_drake_tendon_constraint_offset
- @ref tag_drake_tendon_constraint_lower_limit
- @ref tag_drake_tendon_constraint_upper_limit
- @ref tag_drake_tendon_constraint_stiffness
- @ref tag_drake_tendon_constraint_damping
- @ref tag_drake_visual
- @ref tag_drake_wall_boundary_condition
- @ref tag_drake_youngs_modulus
@subsection tag_drake_acceleration drake:acceleration
- SDFormat path: `//model/joint/axis/limit/drake:acceleration`
- URDF path: `/robot/joint/limit/@drake:acceleration`
- Syntax: One floating point value, non-negative.
@subsubsection tag_drake_acceleration_semantics Semantics
If the joint type is one of (continuous, prismatic, revolute), specifies
acceleration limits of (-VALUE, +VALUE). Units are determined by the type of
joint, either radians/sec^2 for continuous and revolute joints, or m/s^2 for
prismatic joints.
@subsection tag_drake_accepting_renderer drake:accepting_renderer
- SDFormat path: `//model/link/visual/drake:accepting_renderer`
- URDF path: `/robot/link/visual/drake:accepting_renderer/@name`
- Syntax: String.
@subsubsection tag_drake_accepting_renderer_semantics Semantics
The tag serves as a list of renderers for which this visual is targeted.
- The _value_ of the tag is the name of the renderer.
- If the _value_ is empty, that is a parsing error.
- If no instance of `<drake:accepting_renderer>` every renderer will be given
the chance to reify this visual geometry.
- Multiple instances of this tag are allowed. Each instance adds a renderer to
the list of targeted renderers.
This feature is one way to provide multiple visual representations of a body.
Specifying this tag for a visual whose perception role has been disabled will
emit a warning.
@see @ref tag_drake_perception_properties
@subsection tag_drake_angle drake:angle
- SDFormat path: `//model/drake:joint/drake:curves/drake:circular_arc/drake:angle`
- URDF path: n/a (see @ref tag_drake_circular_arc).
- Syntax: Floating point value.
@subsubsection tag_drake_angle_semantics Semantics
Specifies the angle of a circular by right-hand-rule. Units are radians.
@see @ref tag_drake_circular_arc
@subsection tag_drake_ball_constraint drake:ball_constraint
- SDFormat path: `//model/drake:ball_constraint`
- URDF path: `/robot/drake:ball_constraint`
- Syntax: Nested elements @ref tag_drake_ball_constraint_body_A, @ref
tag_drake_ball_constraint_body_B, @ref tag_drake_ball_constraint_p_AP, and @ref
tag_drake_ball_constraint_p_BQ
@subsubsection tag_drake_ball_constraint_semantics Semantics
The element adds a ball constraint to the model via
drake::multibody::MultibodyPlant::AddBallConstraint().
@subsection tag_drake_ball_constraint_body_A drake:ball_constraint_body_A
- SDFormat path: `//model/drake:ball_constraint/drake:ball_constraint_body_A`
- URDF path: `/robot/drake:ball_constraint/drake:ball_constraint_body_A/@name`
- Syntax: String.
@subsubsection tag_drake_ball_constraint_body_A_semantics Semantics
The string names a body (expected to already be defined by this model) that
will be passed to drake::multibody::MultibodyPlant::AddBallConstraint()
as the `body_A` parameter.
@see @ref tag_drake_ball_constraint,
drake::multibody::MultibodyPlant::AddBallConstraint()
@subsection tag_drake_ball_constraint_body_B drake:ball_constraint_body_B
- SDFormat path: `//model/drake:ball_constraint/drake:ball_constraint_body_B`
- URDF path: `/robot/drake:ball_constraint/drake:ball_constraint_body_B/@name`
- Syntax: String.
@subsubsection tag_drake_ball_constraint_body_B_semantics Semantics
The string names a body (expected to already be defined by this model) that
will be passed to drake::multibody::MultibodyPlant::AddBallConstraint()
as the `body_B` parameter.
@see @ref tag_drake_ball_constraint,
drake::multibody::MultibodyPlant::AddBallConstraint()
@subsection tag_drake_ball_constraint_p_AP drake:ball_constraint_p_AP
- SDFormat path: `//model/drake:ball_constraint/drake:ball_constraint_p_AP`
- URDF path: `/robot/drake:ball_constraint/drake:ball_constraint_p_AP/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_ball_constraint_p_AP_semantics Semantics
The three floating point values (units of meters) are formed into a
vector and passed into drake::multibody::MultibodyPlant::AddBallConstraint() as
the `p_AP` parameter.
@see @ref tag_drake_ball_constraint,
drake::multibody::MultibodyPlant::AddBallConstraint()
@subsection tag_drake_ball_constraint_p_BQ drake:ball_constraint_p_BQ
- SDFormat path: `//model/drake:ball_constraint/drake:ball_constraint_p_BQ`
- URDF path: `/robot/drake:ball_constraint/drake:ball_constraint_p_BQ/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_ball_constraint_p_BQ_semantics Semantics
The three floating point values (units of meters) are formed into a
vector and passed into drake::multibody::MultibodyPlant::AddBallConstraint() as
the `p_BQ` parameter.
@see @ref tag_drake_ball_constraint,
drake::multibody::MultibodyPlant::AddBallConstraint()
@subsection tag_drake_tendon_constraint drake:tendon_constraint
- SDFormat path: `//model/drake:tendon_constraint`
- URDF path: `/robot/drake:tendon_constraint`
- Syntax: Nested elements @ref tag_drake_tendon_constraint_joint,
@ref tag_drake_tendon_constraint_offset,
@ref tag_drake_tendon_constraint_lower_limit,
@ref tag_drake_tendon_constraint_upper_limit,
@ref tag_drake_tendon_constraint_stiffness,
and @ref tag_drake_tendon_constraint_damping
@subsubsection tag_drake_tendon_constraint_semantics Semantics
The element adds a tendon constraint to the model via
drake::multibody::MultibodyPlant::AddTendonConstraint().
@subsection tag_drake_tendon_constraint_joint drake:tendon_constraint_joint
- SDFormat path: `//model/drake:tendon_constraint/drake:tendon_constraint_joint`
- URDF path: `/robot/drake:tendon_constraint/drake:tendon_constraint_joint`
- Syntax: Two attributes `name` containing a string value and `a` containing a
floating point value.
@subsubsection tag_drake_tendon_constraint_joint_semantics Semantics
The string names a joint (expected to already be defined by this model and be
single-dof) and the float specifies a coefficient to be applied to the joint
configuration to determine the tendon length. These will be passed to
drake::multibody::MultibodyPlant::AddTendonConstraint() as the `joints` and `a`
parameters, respectively. The tag can be repeated to specify multiple joints.
@see @ref tag_drake_tendon_constraint,
drake::multibody::MultibodyPlant::AddTendonConstraint()
@subsection tag_drake_tendon_constraint_offset drake:tendon_constraint_offset
- SDFormat path: `//model/drake:tendon_constraint/drake:tendon_constraint_offset`
- URDF path: `/robot/drake:tendon_constraint/drake:tendon_constraint_offset/@value`
- Syntax: Floating point value.
@subsubsection tag_drake_tendon_constraint_offset_semantics Semantics
A floating point value specifying the length offset in either [m] or [rad] that
will be passed to drake::multibody::MultibodyPlant::AddTendonConstraint() as the
`offset` parameter.
@see @ref tag_drake_tendon_constraint,
drake::multibody::MultibodyPlant::AddTendonConstraint()
@subsection tag_drake_tendon_constraint_lower_limit drake:tendon_constraint_lower_limit
- SDFormat path: `//model/drake:tendon_constraint/drake:tendon_constraint_lower_limit`
- URDF path: `/robot/drake:tendon_constraint/drake:tendon_constraint_lower_limit/@value`
- Syntax: Floating point value.
@subsubsection tag_drake_tendon_constraint_lower_limit_semantics Semantics
A floating point value specifying the lower bound on the constraint in either
[m] or [rad] that will be passed to
drake::multibody::MultibodyPlant::AddTendonConstraint() as the `lower_bound`
parameter.
@see @ref tag_drake_tendon_constraint,
drake::multibody::MultibodyPlant::AddTendonConstraint()
@subsection tag_drake_tendon_constraint_upper_limit drake:tendon_constraint_upper_limit
- SDFormat path: `//model/drake:tendon_constraint/drake:tendon_constraint_upper_limit`
- URDF path: `/robot/drake:tendon_constraint/drake:tendon_constraint_upper_limit/@value`
- Syntax: Floating point value.
@subsubsection tag_drake_tendon_constraint_upper_limit_semantics Semantics
A floating point value specifying the upper bound on the constraint in either
[m] or [rad] that will be passed to
drake::multibody::MultibodyPlant::AddTendonConstraint() as the `upper_bound`
parameter.
@see @ref tag_drake_tendon_constraint,
drake::multibody::MultibodyPlant::AddTendonConstraint()
@subsection tag_drake_tendon_constraint_stiffness drake:tendon_constraint_stiffness
- SDFormat path: `//model/drake:tendon_constraint/drake:tendon_constraint_stiffness`
- URDF path: `/robot/drake:tendon_constraint/drake:tendon_constraint_stiffness/@value`
- Syntax: Floating point value.
@subsubsection tag_drake_tendon_constraint_stiffness_semantics Semantics
A floating point value specifying the constraint stiffness in either [N/m] or
[N⋅m/rad] that will be passed to
drake::multibody::MultibodyPlant::AddTendonConstraint() as the `stiffness`
parameter.
@see @ref tag_drake_tendon_constraint,
drake::multibody::MultibodyPlant::AddTendonConstraint()
@subsection tag_drake_tendon_constraint_damping drake:tendon_constraint_damping
- SDFormat path: `//model/drake:tendon_constraint/drake:tendon_constraint_damping`
- URDF path: `/robot/drake:tendon_constraint/drake:tendon_constraint_damping/@value`
- Syntax: Floating point value.
@subsubsection tag_drake_tendon_constraint_damping_semantics Semantics
A floating point value specifying the constraint damping in either [N⋅s/m] or
[N⋅m⋅rad/s] that will be passed to
drake::multibody::MultibodyPlant::AddTendonConstraint() as the `damping`
parameter.
@see @ref tag_drake_tendon_constraint,
drake::multibody::MultibodyPlant::AddTendonConstraint()
@subsection tag_drake_bushing_force_damping drake:bushing_force_damping
- SDFormat path: `//model/drake:linear_bushing_rpy/drake:bushing_force_damping`
- URDF path: `/robot/drake:linear_bushing_rpy/drake:bushing_force_damping/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_bushing_force_damping_semantics Semantics
The three floating point values (units of N⋅s/m) are formed into a vector and
passed to the constructor of drake::multibody::LinearBushingRollPitchYaw as the
`force_damping_constants` parameter.
@see @ref tag_drake_linear_bushing_rpy,
drake::multibody::LinearBushingRollPitchYaw,
@ref Basic_bushing_force_stiffness_and_damping "How to choose force stiffness and damping constants"
@subsection tag_drake_bushing_force_stiffness drake:bushing_force_stiffness
- SDFormat path: `//model/drake:linear_bushing_rpy/drake:bushing_force_stiffness`
- URDF path: `/robot/drake:linear_bushing_rpy/drake:bushing_force_stiffness/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_bushing_force_stiffness_semantics Semantics
The three floating point values (units of N/m) are formed into a vector and
passed to the constructor of drake::multibody::LinearBushingRollPitchYaw as the
`force_stiffness_constants` parameter.
@see @ref tag_drake_linear_bushing_rpy,
drake::multibody::LinearBushingRollPitchYaw,
@ref Basic_bushing_force_stiffness_and_damping "How to choose force stiffness and damping constants"
@subsection tag_drake_bushing_frameA drake:bushing_frameA
- SDFormat path: `//model/drake:linear_bushing_rpy/drake:bushing_frameA`
- URDF path: `/robot/drake:linear_bushing_rpy/drake:bushing_frameA/@name`
- Syntax: String.
@subsubsection tag_drake_bushing_frameA_semantics Semantics
The string names a frame (expected to already be defined by this model) that
will be passed to the constructor of
drake::multibody::LinearBushingRollPitchYaw as the `frameA` parameter.
@see @ref tag_drake_linear_bushing_rpy, drake::multibody::LinearBushingRollPitchYaw
@subsection tag_drake_bushing_frameC drake:bushing_frameC
- SDFormat path: `//model/drake:linear_bushing_rpy/drake:bushing_frameC`
- URDF path: `/robot/drake:linear_bushing_rpy/drake:bushing_frameC/@name`
- Syntax: String.
@subsubsection tag_drake_bushing_frameC_semantics Semantics
The string names a frame (expected to already be defined by this model) that
will be passed to the constructor of
drake::multibody::LinearBushingRollPitchYaw as the `frameC` parameter.
@see @ref tag_drake_linear_bushing_rpy, drake::multibody::LinearBushingRollPitchYaw
@subsection tag_drake_bushing_torque_damping drake:bushing_torque_damping
- SDFormat path: `//model/drake:linear_bushing_rpy/drake:bushing_torque_damping`
- URDF path: `/robot/drake:linear_bushing_rpy/drake:bushing_torque_damping/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_bushing_torque_damping_semantics Semantics
The three floating point values (units of N⋅m⋅s/rad) are formed into a vector
and passed to the constructor of drake::multibody::LinearBushingRollPitchYaw as
the `torque_damping_constants` parameter.
@see @ref tag_drake_linear_bushing_rpy,
drake::multibody::LinearBushingRollPitchYaw,
@ref Basic_bushing_torque_stiffness_and_damping "How to choose torque stiffness and damping constants"
@subsection tag_drake_bushing_torque_stiffness drake:bushing_torque_stiffness
- SDFormat path: `//model/drake:linear_bushing_rpy/drake:bushing_torque_stiffness`
- URDF path: `/robot/drake:linear_bushing_rpy/drake:bushing_torque_stiffness/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_bushing_torque_stiffness_semantics Semantics
The three floating point values (units of N⋅m/rad) are formed into a vector and
passed to the constructor of drake::multibody::LinearBushingRollPitchYaw as the
`torque_stiffness_constants` parameter.
@see @ref tag_drake_linear_bushing_rpy,
drake::multibody::LinearBushingRollPitchYaw,
@ref Basic_bushing_torque_stiffness_and_damping "How to choose torque stiffness and damping constants"
@subsection tag_drake_linear_spring_damper drake:linear_spring_damper
- SDFormat path: `//model/drake:linear_spring_damper`
- URDF path: `/robot/drake:linear_spring_damper`
- Syntax: Nested elements @ref tag_drake_linear_spring_damper_body_A,
@ref tag_drake_linear_spring_damper_p_AP,
@ref tag_drake_linear_spring_damper_body_B,
@ref tag_drake_linear_spring_damper_p_BQ,
@ref tag_drake_linear_spring_damper_free_length,
@ref tag_drake_linear_spring_damper_stiffness,
and @ref tag_drake_linear_spring_damper_damping
@subsubsection tag_drake_linear_spring_damper_semantics Semantics
The element adds a drake::multibody::LinearSpringDamper to the model.
@subsection tag_drake_linear_spring_damper_body_A drake:linear_spring_damper_body_A
- SDFormat path: `//model/drake:linear_spring_damper/drake:linear_spring_damper_body_A`
- URDF path: `/robot/drake:linear_spring_damper/drake:linear_spring_damper_body_A/@name`
- Syntax: String.
@subsubsection tag_drake_linear_spring_damper_body_A_semantics Semantics
The string names a body (expected to already be defined by this model) that will
be passed to drake::multibody::LinearSpringDamper() as the `body_A` parameter.
@see @ref tag_drake_linear_spring_damper, drake::multibody::LinearSpringDamper()
@subsection tag_drake_linear_spring_damper_p_AP drake:linear_spring_damper_p_AP
- SDFormat path: `//model/drake:linear_spring_damper/drake:linear_spring_damper_p_AP`
- URDF path: `/robot/drake:linear_spring_damper/drake:linear_spring_damper_p_AP/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_linear_spring_damper_p_AP_semantics Semantics
The three floating point values (units of meters) are formed into a vector and
passed into drake::multibody::LinearSpringDamper() as the `p_AP` parameter.
@see @ref tag_drake_linear_spring_damper, drake::multibody::LinearSpringDamper()
@subsection tag_drake_linear_spring_damper_body_B drake:linear_spring_damper_body_B
- SDFormat path: `//model/drake:linear_spring_damper/drake:linear_spring_damper_body_B`
- URDF path: `/robot/drake:linear_spring_damper/drake:linear_spring_damper_body_B/@name`
- Syntax: String.
@subsubsection tag_drake_linear_spring_damper_body_B_semantics Semantics
The string names a body (expected to already be defined by this model) that will
be passed to drake::multibody::LinearSpringDamper() as the `body_B` parameter.
@see @ref tag_drake_linear_spring_damper, drake::multibody::LinearSpringDamper()
@subsection tag_drake_linear_spring_damper_p_BQ drake:linear_spring_damper_p_BQ
- SDFormat path: `//model/drake:linear_spring_damper/drake:linear_spring_damper_p_BQ`
- URDF path: `/robot/drake:linear_spring_damper/drake:linear_spring_damper_p_BQ/@value`
- Syntax: Three floating point values.
@subsubsection tag_drake_linear_spring_damper_p_BQ_semantics Semantics
The three floating point values (units of meters) are formed into a vector and
passed into drake::multibody::LinearSpringDamper() as the `p_BQ` parameter.
@see @ref tag_drake_linear_spring_damper, drake::multibody::LinearSpringDamper()
@subsection tag_drake_linear_spring_damper_free_length drake:linear_spring_damper_free_length
- SDFormat path: `//model/drake:linear_spring_damper/drake:linear_spring_damper_free_length`
- URDF path: `/robot/drake:linear_spring_damper/drake:linear_spring_damper_free_length/@value`
- Syntax: a strictly positive floating point value.
@subsubsection tag_drake_linear_spring_damper_free_length_semantics Semantics
The floating point value (unit of meters) is passed into
drake::multibody::LinearSpringDamper() as the `free_length` parameter.
@see @ref tag_drake_linear_spring_damper, drake::multibody::LinearSpringDamper()
@subsection tag_drake_linear_spring_damper_stiffness drake:linear_spring_damper_stiffness
- SDFormat path: `//model/drake:linear_spring_damper/drake:linear_spring_damper_stiffness`
- URDF path: `/robot/drake:linear_spring_damper/drake:linear_spring_damper_stiffness/@value`
- Syntax: a non-negative floating point value.
@subsubsection tag_drake_linear_spring_damper_stiffness_semantics Semantics
The floating point value (unit of N/m) is passed into
drake::multibody::LinearSpringDamper() as the `stiffness` parameter.
@see @ref tag_drake_linear_spring_damper, drake::multibody::LinearSpringDamper()
@subsection tag_drake_linear_spring_damper_damping drake:linear_spring_damper_damping
- SDFormat path: `//model/drake:linear_spring_damper/drake:linear_spring_damper_damping`
- URDF path: `/robot/drake:linear_spring_damper/drake:linear_spring_damper_damping/@value`
- Syntax: a non-negative floating point value.
@subsubsection tag_drake_linear_spring_damper_damping_semantics Semantics
The floating point value (unit of N⋅s/m) is passed into
drake::multibody::LinearSpringDamper() as the `damping` parameter.
@see @ref tag_drake_linear_spring_damper, drake::multibody::LinearSpringDamper()
@subsection tag_drake_capsule drake:capsule
- SDFormat path: `//geometry[parent::visual|parent::collision]/drake:capsule`
- URDF path: `//geometry[parent::visual|parent::collision]/drake:capsule`
- Syntax: Two nested elements `radius` and `length`, each of which contain a
non-negative floating point value.
@subsubsection tag_drake_capsule_semantics Semantics
Constructs a drake::geometry::Capsule of the given radius (meters) and length
(meters), and adds it to either the visual or collision geometry of the model.
SDFormat note: `drake:capsule` is proposed for deprecation; see
[issue #14387](https://github.com/RobotLocomotion/drake/issues/14837).
URDF note: Drake supports both `drake:capsule`, and a non-standard
(non-prefixed) `capsule` tag with the same syntax and semantics.
@subsection tag_drake_child drake:child
- SDFormat path: `//model/drake:joint/drake:child`
- URDF path: N/A
- Syntax: String.
@subsubsection tag_drake_child_semantics Semantics
The string names a frame (defined elsewhere in the model) that is associated
with the child link of the joint being defined.
@see @ref tag_drake_joint
@subsection tag_drake_circular_arc drake:circular_arc
- SDFormat path: `//model/drake:joint/drake:curves/drake:circular_arc`
- URDF path: `/robot/drake:joint/drake:curves/drake:circular_arc`
- Syntax: Radius in meters and angle in radians, expressed as attributes for URDF
and in `drake:radius` and `drake:angle` child elements for SDF.
@subsubsection tag_drake_circular_arc_semantics Semantics
A joint-type-specific tag for drake::multibody::CurvilinearJoint, corresponding to a
`drake:joint` of `curvilinear` type.
This element specifies a circular arc along which the joint moves. The initial position
and orientation of the segment are defined by the `drake:initial_tangent` and `drake:plane_normal`
tags on the joint and previous segments in the joint's `drake:curves` list.
The circular arc rotates about the plane normal axis, with a turning angle and radius specified directly
in the tag by right hand rule.
For URDF, these values are contained in the `radius` and `angle` attributes of the element.
For SDF, `drake:radius` and `drake:angle` child elements contain the values.
@see @ref tag_drake_curves, @ref tag_drake_initial_tangent, @ref tag_drake_plane_normal,
@ref tag_drake_radius, @ref tag_drake_angle
@subsection tag_drake_collision_filter_group drake:collision_filter_group
- SDFormat path: `//model/drake:collision_filter_group`
- URDF path: `/robot/drake:collision_filter_group`
- Syntax: Attributes `name` (string) and `ignore` (boolean); nested elements
`drake:member`, `drake:member_group`, and
`drake:ignored_collision_filter_group`.
@subsubsection tag_drake_collision_filter_group_semantics Semantics
This element names a group of bodies to participate in collision filtering
rules. If the `ignore` attribute is present and true-valued, the entire element
is skipped during parsing. The nested elements must included one or more
`drake:member` or `drake:member_group` elements, and zero or more
`drake:ignored_collision_filter_group` elements.
This element defines a new group name that is only available during parsing. It
must not be a scoped name.
Collision filtering rules are only constructed with **pairs** of groups, where
both sides of the pair may name the same group. The
`drake:ignored_collision_filter_group` element establishes a pairing between
the group it names and the group within which it is nested. A pair containing
different collision groups excludes collisions between members of those groups
(see drake::geometry::CollisionFilterDeclaration::ExcludeBetween()). A pair
naming the same group twice excludes collisions within the group (see
drake::geometry::CollisionFilterDeclaration::ExcludeWithin()).
@see @ref tag_drake_member, @ref tag_drake_member_group, @ref tag_drake_ignored_collision_filter_group, @ref scoped_names
@subsection tag_drake_compliant_hydroelastic drake:compliant_hydroelastic
- SDFormat path: `//model/link/collision/drake:proximity_properties/drake:compliant_hydroelastic`
- URDF path: `/robot/link/collision/drake:proximity_properties/drake:compliant_hydroelastic`
- Syntax: Empty element.
@subsubsection tag_drake_compliant_hydroelastic_semantics Semantics
If present, this element sets the compliance type of the element being defined
to be compliant, as opposed to rigid, in hydroelastic contact models.
@see @ref tag_drake_proximity_properties, @ref creating_hydro_reps
@subsection tag_drake_controller_gains drake:controller_gains
- SDFormat path: `//model/joint/drake:controller_gains`
- URDF path: `/robot/joint/actuator/drake:controller_gains`
- Syntax: Two attributes `p` (proportional gain) containing a positive floating
point value and `d` (derivative gain) containing a non-negative
floating point value.
@subsubsection tag_drake_controller_gains_semantics Semantics
If present, this element provides proportional and derivative gains for a low
level PD controller for the drake::multibody::JointActuator associated with the
drake::multibody::Joint the element is defined under. It is stored in a
drake::multibody::PdControllerGains object in the
drake::multibody::JointActuator class. Both attributes `p` and `d` are required.
@see @ref mbp_actuation, @ref pd_controlled_joint_actuator
@subsection tag_drake_curves drake:curves
- SDFormat path: `//model/drake:joint/drake:curves`
- URDF path: `/robot/drake:joint/drake:curves`
- Syntax: List of `drake:line_segment` and `drake:circular_arc` child elements.
@subsubsection tag_drake_curves_semantics Semantics
A joint-type-specific tag for drake::multibody::CurvilinearJoint, corresponding to a
`drake:joint` of `curvilinear` type.
Curvilinear joints allow the child frame to move relative to the parent along a
planar curvilinear path, expressed in this tag as an ordered list of linear
and circular arc segments. Each segment is appended to the end of the previous
segment, so that the entire path is continuously differentiable.
The initial heading of the curve is determined by the joint's `drake:initial_tangent`
element, and remains in a plane defined by the joint's `drake:plane_normal`.
@see @ref tag_drake_initial_tangent, @ref tag_drake_plane_normal,
@ref tag_drake_line_segment, @ref tag_drake_circular_arc, @ref tag_drake_joint
@subsection tag_drake_damping drake:damping
- SDFormat path: `//model/drake:joint/drake:damping`
- URDF path: N/A
- Syntax: Three non-negative floating point values.
@subsubsection tag_drake_damping_semantics Semantics
If the parent joint type is planar, construct a vector from the values (units
of (N⋅s/m, N⋅s/m, N⋅m⋅s) respectively) and pass it to the `damping` parameter
of the constructor of drake::multibody::PlanarJoint. The first two values are
for translation; the third is for rotation. See that class for discussion of
units and detailed semantics.
URDF Note: The comparable feature in URDF is the standard
`/robot/joint/dynamics/@damping` attribute.
@subsection tag_drake_declare_convex drake:declare_convex
- SDFormat path: `//geometry[parent::visual|parent::collision]/mesh/drake:declare_convex`
- URDF path: `//geometry[parent::visual|parent::collision]/mesh/drake:declare_convex`
- Syntax: Empty element.
@subsubsection tag_drake_declare_convex_semantics Semantics
If present, this element causes Drake to use the convex hull of the named mesh
geometry. The resulting geometry in memory will be drake::geometry::Convex,
rather than drake::geometry::Mesh.
@see drake::geometry::Convex, drake::geometry::Mesh
@subsection tag_drake_deformable_properties drake:deformable_properties
- SDFormat path: `//model/link/drake:deformable_properties`
- URDF path: n/a
- Syntax: Nested elements; see below.
@subsubsection tag_drake_deformable_properties Semantics
If present, this element defines the link element as a deformable body in Drake.
Such link elements are not treated as rigid bodies, and the standard tags such as
inertia are illegal and provoke errors. The only other tags that
are allowed are under such "deformable" links are `<pose>`, `<collision>`, and
`<visual>`. Attaching frames, joints, and other elements to deformable links is
not allowed. The `<pose>` tag is interpreted as the pose of the deformable geometry
used for dynamics and collision in its reference configuration. The `<collision>`
and `<visual>` tags are *not* interpreted exactly the same way as the standard
`<collision>` and `<visual>` tags either. We explain the differences in the
@ref tag_deformable_link_requirements section.
The following nested elements may be present under `<drake:deformable_properties>`:
- `drake:youngs_modulus`
- `drake:poissons_ratio`
- `drake:mass_damping`
- `drake:stiffness_damping`
- `drake:mass_density`
- `drake:material_model`
see @ref tag_drake_youngs_modulus
@ref tag_drake_poissons_ratio
@ref tag_drake_mass_damping
@ref tag_drake_stiffness_damping
@ref tag_drake_mass_density
@ref tag_drake_material_model
@subsection tag_drake_diffuse_map drake:diffuse_map
- SDFormat path: `//model/link/visual/material/drake:diffuse_map`
- URDF path: N/A (see a note below).
- Syntax: URI.
@subsubsection tag_drake_diffuse_map_semantics Semantics
If present, this element indicates (by filename or `package:` URI) a PNG file
to use as a diffuse texture map. The resolved path name is stored in a
PerceptionProperties object under `(phong, diffuse_map)`. URDF provides a
built-in tag, i.e., `//robot/material/texture` or
`//robot/link/visual/material/texture`, to specify a diffuse texture map for a
link.
@see drake::geometry::PerceptionProperties, drake::multibody::PackageMap,
@ref render_engine_vtk_properties "Geometry perception properties"
@subsection tag_drake_ellipsoid drake:ellipsoid
- SDFormat path: `//geometry[parent::visual|parent::collision]/drake:ellipsoid`
- URDF path: `//geometry[parent::visual|parent::collision]/drake:ellipsoid`
- Syntax: Three nested elements (SDFormat) or attributes (URDF) `a`, `b`, `c`,
each of which contain a positive floating point value.
@subsubsection tag_drake_ellipsoid_semantics Semantics
Constructs a drake::geometry::Ellipsoid with the given half-axis length
parameters `a`, `b`, and `c` (all in units of meters), and adds it to either
the visual or collision geometry of the model.
@subsection tag_drake_gear_ratio drake:gear_ratio