Skip to content

Commit 6ecfcc2

Browse files
authored
DOC 1.9: clarify behavior of //model/model/static (#921)
These changes were applied to SDFormat 1.8 in #713 but were not propagated to 1.9 after being merged forward. This completes the merge. Signed-off-by: Steve Peters <scpeters@openrobotics.org>
1 parent 4d9f8a4 commit 6ecfcc2

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

sdf/1.9/model.sdf

+12-4
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,25 @@
1414
<attribute name="canonical_link" type="string" default="" required="0">
1515
<description>
1616
The name of the model's canonical link, to which the model's implicit
17-
coordinate frame is attached. If unset or set to an empty string,
18-
the first link element listed as a child of this model is chosen
19-
as the canonical link.
17+
coordinate frame is attached. If unset or set to an empty string, the
18+
first `/link` listed as a direct child of this model is chosen as the
19+
canonical link. If the model has no direct `/link` children, it will
20+
instead be attached to the first nested (or included) model's implicit
21+
frame.
2022
</description>
2123
</attribute>
2224
<attribute name="placement_frame" type="string" default="" required="0">
2325
<description>The frame inside this model whose pose will be set by the pose element of the model. i.e, the pose element specifies the pose of this frame instead of the model frame.</description>
2426
</attribute>
2527

2628
<element name="static" type="bool" default="false" required="0">
27-
<description>If set to true, the model is immovable. Otherwise the model is simulated in the dynamics engine.</description>
29+
<description>
30+
If set to true, the model is immovable; i.e., a dynamics engine will not
31+
update its position. This will also overwrite this model's `@canonical_link`
32+
and instead attach the model's implicit frame to the world's implicit frame.
33+
This holds even if this model is nested (or included) by another model
34+
instead of being a direct child of `//world`.
35+
</description>
2836
</element>
2937

3038
<element name="self_collide" type="bool" default="false" required="0">

0 commit comments

Comments
 (0)