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

add bounding box sensor API stubs #420

Merged
merged 10 commits into from
Sep 22, 2021
Merged

add bounding box sensor API stubs #420

merged 10 commits into from
Sep 22, 2021

Conversation

adlarkin
Copy link
Contributor

@adlarkin adlarkin commented Sep 22, 2021

Summary

I've added the public API for a bounding box sensor. Most of this is copy/pasted from #334, with a few changes:

  1. There's only one constructor for the rendering::BoundingBox struct, which takes a type and label argument
  2. The rendering::BoundingBoxCamera::DrawBoundingBox method takes the box color as an argument instead of defaulting to green

This PR just covers the breaking changes that are needed for the bounding box sensor so that we can add #334 to Fortress in a minor release. Some of the things I added here may not be breaking, but I wasn't sure, so I added whatever I thought could be ABI breaking. See #334 for an ogre2 implementation.

Test it

No tests have been added here because tests are written for this in #334

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • codecheck passed (See contributing)
  • 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

Copy link
Contributor Author

@adlarkin adlarkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like some feedback on an API decision I made before this gets merged. See my comment below.

@adlarkin adlarkin added the beta Targeting beta release of upcoming collection label Sep 22, 2021
@github-actions github-actions bot added the 🏯 fortress Ignition Fortress label Sep 22, 2021
@codecov
Copy link

codecov bot commented Sep 22, 2021

Codecov Report

Merging #420 (b10fea7) into main (5bf8dc6) will decrease coverage by 0.06%.
The diff coverage is 15.15%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #420      +/-   ##
==========================================
- Coverage   55.18%   55.12%   -0.07%     
==========================================
  Files         191      192       +1     
  Lines       19348    19381      +33     
==========================================
+ Hits        10678    10683       +5     
- Misses       8670     8698      +28     
Impacted Files Coverage Δ
include/ignition/rendering/Scene.hh 0.00% <ø> (ø)
include/ignition/rendering/base/BaseScene.hh 0.00% <0.00%> (ø)
src/PixelFormat.cc 73.33% <ø> (ø)
src/base/BaseScene.cc 73.91% <0.00%> (-1.42%) ⬇️
src/BoundingBox.cc 31.25% <31.25%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5bf8dc6...b10fea7. Read the comment docs.

Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also add the dependency on ign-math eigen. It's best not to add dependencies to stable versions.

include/ignition/rendering/BoundingBoxCamera.hh Outdated Show resolved Hide resolved
include/ignition/rendering/BoundingBoxCamera.hh Outdated Show resolved Hide resolved
@chapulina chapulina mentioned this pull request Sep 22, 2021
Signed-off-by: Ashton Larkin <[email protected]>
@adlarkin
Copy link
Contributor Author

Let's also add the dependency on ign-math eigen

Added in 98a7bf1. I'm assuming that the ogre2 component can be updated in #334 since that's a plugin, right? Here's what I am referring to in #334: https://github.com/ignitionrobotics/ign-rendering/blob/4162fd7b95969691d6ef4918d795172a66e3053a/ogre2/src/CMakeLists.txt#L38

Signed-off-by: Louise Poubel <[email protected]>
Signed-off-by: Louise Poubel <[email protected]>
Signed-off-by: Louise Poubel <[email protected]>
Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope that's all we need 🤞

@chapulina chapulina enabled auto-merge (squash) September 22, 2021 05:14
Signed-off-by: Louise Poubel <[email protected]>
Signed-off-by: Louise Poubel <[email protected]>
@chapulina chapulina enabled auto-merge (squash) September 22, 2021 05:50
@chapulina chapulina mentioned this pull request Sep 22, 2021
7 tasks
@chapulina chapulina merged commit 1d6906b into main Sep 22, 2021
@chapulina chapulina deleted the adlarkin/bbox_stubs branch September 22, 2021 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beta Targeting beta release of upcoming collection 🏯 fortress Ignition Fortress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants