Skip to content

Commit

Permalink
adding more comments for the tutorials for clarification
Browse files Browse the repository at this point in the history
Signed-off-by: Liam Han <liamhan0905@gmail.com>
  • Loading branch information
liamhan0905 committed May 24, 2023
1 parent 31e3fe7 commit 2ff8f52
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
6 changes: 3 additions & 3 deletions examples/worlds/detachable_joint.sdf
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
To monitor the state of each breadcrumbs
ign topic -e -t /B1/detached_state
ign topic -e -t /B2/detached_state
ign topic -e -t /B3/detached_state
ign topic -e -t /B1/state
ign topic -e -t /B2/state
ign topic -e -t /B3/state
-->

<sdf version="1.6">
Expand Down
8 changes: 8 additions & 0 deletions tutorials/detachable_joints.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ kinematic topology has to be a tree, i.e., kinematic loops are not currently
supported. This affects the choice of the parent link, and therefore, the
parent model, which is the model that contains the `DetachableJoint` system.
Once detached, the joint can be re-attached by publishing to a topic.
When reattaching, the child model will be attached to the parent model at its
current pose/configuration. To achieve reattachment at a specific pose, the
child model can be positioned accordingly through a set_pose service call prior
to reattaching the joint.

For example, [detachable_joint.sdf](https://github.com/ignitionrobotics/ign-gazebo/blob/ign-gazebo2/examples/worlds/detachable_joint.sdf)
demonstrates a four wheel vehicle that holds three objects that are later
Expand Down Expand Up @@ -37,6 +41,10 @@ need to collide with a parent model or other detached models that have the same
parent, the parent model needs to have `<self_collide>` set to true. However,
due to an issue in DART, the default physics engine, it is important that none of the parent
or child models be in collision in their initial (attached) state.
Furthermore, it is important to note that reattaching a child model is not
currently supported while the child model and parent model are in contact.
Therefore, it is imperative to ensure that there is no collision between the
child and parent model when attempting to perform the reattachment process.

The system has the following parameters:

Expand Down

0 comments on commit 2ff8f52

Please sign in to comment.