Merging for Composition: Proposed behavior#55
Merging for Composition: Proposed behavior#55EricCousineau-TRI wants to merge 10 commits intogazebosim:masterfrom
Conversation
EricCousineau-TRI
left a comment
There was a problem hiding this comment.
Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on @EricCousineau-TRI)
composition/merge_proposal.md, line 54 at r1 (raw file):
## Proposed changes TBD
Working: Will fill these out pending draft PR for implementation.
Signed-off-by: Eric Cousineau <eric.cousineau@tri.global>
c9428ab to
0d264d7
Compare
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
0a7888e to
cc578e7
Compare
|
I've started on this by updating the introduction and adding a bit to the motivation section: cc578e7 |
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Copied text from gazebosim/sdformat#659. Left a placeholder for an example of decomposing an existing model into separate model files using merge-include. Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Add abridged version of husky with sensors on a pan-tilt gimbal and show how to decompose it. Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
|
I've updated this quite a bit. The only thing I can think to add still is how to handle placement frames when doing a merge-include. What do you think? @EricCousineau-TRI @azeey |
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
I've added discussion of the placement frame in 1f663c0 |
EricCousineau-TRI
left a comment
There was a problem hiding this comment.
Do you want to make alt. PR so you have primary authorship? (I'm fine either way)
Reviewable status: 0 of 2 files reviewed, 2 unresolved discussions (waiting on @scpeters)
composition/merge_proposal.md line 120 at r5 (raw file):
~~~ <?xml version="1.0" ?>
nit Other snippets do not contain this header.
Consider removing here?
composition/merge_proposal.md line 225 at r5 (raw file):
<pose>0.424 0 0.460 0 0 0</pose> <!-- Based on Intel realsense D435 (intrinsics and distortion not modeled)--> <sensor name="camera_pan_tilt" type="rgbd_camera">
nit Consider removing additional elements for now?
Or perhaps empty out contents and replace with ellipsis?
azeey
left a comment
There was a problem hiding this comment.
Reviewed 1 of 1 files at r2.
Reviewable status: 1 of 2 files reviewed, 3 unresolved discussions (waiting on @EricCousineau-TRI and @scpeters)
composition/merge_proposal.md line 108 at r5 (raw file):
For the entities to be merged, any explicit references to the implicit `__model__` frame are replaced with references to the proxy frame. Additionally, the name of the proxy frame is inserted anywhere the is an
nit: anywhere the -> anywhere there
composition/merge_proposal.md line 487 at r5 (raw file):
<parent>base_link</parent> <axis> <xyz expressed_in="_merged__pan_tilt_sensors_3__model__">0 0 1</xyz>
hmm, it's not ideal to have to reference the proxy frame explicitly. It's more of an implementation detail, I think, and the naming pattern could change. Ideally, we would just reference the name of the included model corresponding to pan_tile_sensor3.sdf here, but I'm not sure that would actually work. I don't want to block this, but it might be good to create an issue for it.
EricCousineau-TRI
left a comment
There was a problem hiding this comment.
Reviewable status: 1 of 2 files reviewed, 3 unresolved discussions (waiting on @EricCousineau-TRI and @scpeters)
composition/merge_proposal.md line 487 at r5 (raw file):
Previously, azeey (Addisu Z. Taddese) wrote…
hmm, it's not ideal to have to reference the proxy frame explicitly. It's more of an implementation detail, I think, and the naming pattern could change. Ideally, we would just reference the name of the included model corresponding to
pan_tile_sensor3.sdfhere, but I'm not sure that would actually work. I don't want to block this, but it might be good to create an issue for it.
Per VC, we should actually leave it, but:
- Warn that it's an implementation detail
- Suggest two options if a user needs to explicitly reference the included model frame
- (a) Make their own explicit alias frame in the included model, e.g.
arm_frame - (b) Use
experimental:paramsto inject the alias frame via//include
- (a) Make their own explicit alias frame in the included model, e.g.
scpeters
left a comment
There was a problem hiding this comment.
sure, I'll open a separate pull request so it will make more sense for you and Addisu to review it
Reviewed all commit messages.
Reviewable status: 1 of 2 files reviewed, 4 unresolved discussions (waiting on @EricCousineau-TRI and @scpeters)
scpeters
left a comment
There was a problem hiding this comment.
see #74
Reviewable status: 1 of 2 files reviewed, 4 unresolved discussions (waiting on @azeey, @EricCousineau-TRI, and @scpeters)
composition/merge_proposal.md line 108 at r5 (raw file):
Previously, azeey (Addisu Z. Taddese) wrote…
nit: anywhere the -> anywhere there
composition/merge_proposal.md line 120 at r5 (raw file):
Previously, EricCousineau-TRI (Eric Cousineau) wrote…
nit Other snippets do not contain this header.
Consider removing here?
composition/merge_proposal.md line 225 at r5 (raw file):
Previously, EricCousineau-TRI (Eric Cousineau) wrote…
nit Consider removing additional elements for now?
Or perhaps empty out contents and replace with ellipsis?
composition/merge_proposal.md line 487 at r5 (raw file):
Previously, EricCousineau-TRI (Eric Cousineau) wrote…
Per VC, we should actually leave it, but:
- Warn that it's an implementation detail
- Suggest two options if a user needs to explicitly reference the included model frame
- (a) Make their own explicit alias frame in the included model, e.g.
arm_frame- (b) Use
experimental:paramsto inject the alias frame via//include
|
all changes look good, closing this in lieu of #74 |
🎉 New feature
Merging for Composition: Proposed behavior
Towards gazebosim/sdformat#658
Draft implementation: gazebosim/sdformat#659
Summary
See proposal text.
Test it
See preview: via sdformat.org
Checklist
Added testsUpdated migration guide (as needed)codecheckpassed~All tests passedNote to maintainers: Remember to use Squash-Merge
This change is