Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs of collision_bitmask. #521

Merged
merged 2 commits into from
Mar 19, 2021
Merged

Improve docs of collision_bitmask. #521

merged 2 commits into from
Mar 19, 2021

Conversation

peci1
Copy link
Contributor

@peci1 peci1 commented Mar 19, 2021

🎉 New feature

Summary

It was confusing for me reading sdformat docs to figure out what is the allowed range for <collision_bitmask> and <category_bitmask>. So I improved the text to clearly state they are treated as 16-bit unsigned ints.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Code check passed (In source directory, run sh tools/code_check.sh)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review
    another open pull request
    to support the maintainers

Note to maintainers: Remember to use Squash-Merge

@github-actions github-actions bot added the 🔮 dome Ignition Dome label Mar 19, 2021
@azeey
Copy link
Collaborator

azeey commented Mar 19, 2021

Thanks @peci1. This looks good. Do you mind targetting the sdf9 branch instead since the PR that add the DOM API for Surface was added in sdf9?

@peci1 peci1 changed the base branch from sdf10 to sdf9 March 19, 2021 14:21
Signed-off-by: Martin Pecka <peckama2@fel.cvut.cz>
@peci1
Copy link
Contributor Author

peci1 commented Mar 19, 2021

Okay, retargeted.

@azeey azeey added 🏰 citadel Ignition Citadel and removed 🔮 dome Ignition Dome labels Mar 19, 2021
@azeey azeey merged commit 066b2fe into gazebosim:sdf9 Mar 19, 2021
@scpeters scpeters mentioned this pull request May 17, 2021
7 tasks
scpeters added a commit to scpeters/sdformat that referenced this pull request May 17, 2021
* added to sdf 1.7 in gazebosim#521

Signed-off-by: Martin Pecka <peckama2@fel.cvut.cz>
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
scpeters added a commit that referenced this pull request May 19, 2021
* sdf 1.8: Add <double_sided> to material from #410
* sdf 1.8: Add lightmap to 1.8 spec from #429
* sdf 1.8: document Add L16 camera pixel format from #487

Signed-off-by: Ian Chen <ichen@osrfoundation.org>

* sdf 1.8: Decrease far clip lower bound from #435

Signed-off-by: Nate Koenig <nate@openrobotics.org>

* sdf 1.8: Added render_order to material from #446

Signed-off-by: ahcorde <ahcorde@gmail.com>

* sdf 1.8: Add camera type aliases to docs. from #514
* sdf 1.8: Improve docs of collision_bitmask from #521

Signed-off-by: Martin Pecka <peckama2@fel.cvut.cz>

* sdf 1.8: support nested models in @attached_to from #316

Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants