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

Move geospatial headers to subfolder #289

Merged
merged 3 commits into from
Jan 19, 2022

Conversation

scpeters
Copy link
Member

🦟 Bug fix

Follow-up to #267, connected to gazebo-release/gz-common5-release#4

Summary

This simplifies the logic required for packaging by putting all the geospatial header files in a subfolder. We haven't done this for the other ing-common components, but now is an easy time to do it for geospatial since we are already breaking things with this component.

Checklist

  • Signed all commits for DCO
  • Added tests
  • 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 and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

This simplifies the logic required for packaging.

Signed-off-by: Steve Peters <[email protected]>
Signed-off-by: Steve Peters <[email protected]>
@github-actions github-actions bot added the 🌱 garden Ignition Garden label Jan 19, 2022
@scpeters scpeters changed the title Scpeters/geospatial include subfolder Move geospatial headers to subfolder Jan 19, 2022
@codecov
Copy link

codecov bot commented Jan 19, 2022

Codecov Report

Merging #289 (c3d6053) into main (28eb6c7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #289   +/-   ##
=======================================
  Coverage   76.69%   76.69%           
=======================================
  Files          76       76           
  Lines       10647    10647           
=======================================
  Hits         8166     8166           
  Misses       2481     2481           
Impacted Files Coverage Δ
...nclude/ignition/common/geospatial/HeightmapData.hh 33.33% <ø> (ø)
...clude/ignition/common/geospatial/ImageHeightmap.hh 88.88% <ø> (ø)
geospatial/src/Dem.cc 86.41% <ø> (ø)
geospatial/src/ImageHeightmap.cc 60.00% <ø> (ø)

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 28eb6c7...c3d6053. Read the comment docs.

Copy link
Contributor

@jennuine jennuine left a comment

Choose a reason for hiding this comment

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

LGTM, left a minor suggestion

Migration.md Outdated
@@ -17,7 +17,8 @@ release will remove the deprecated code.
1. `HeightmapData.hh` and `ImageHeightmap.hh` have been moved out of the
`graphics` component and into the new `geospatial` component
+ To use the heightmap features, users must add the `geospatial` component
to the `find_package` call
to the `find_package` call and update the include paths to use
the geospatial subfolder (`#include <ignition/common/geospatial/Dem.hh>`)
Copy link
Contributor

Choose a reason for hiding this comment

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

Since Dem is a new feature, how about we use ImageHeightmap.hh as an example instead?

Suggested change
the geospatial subfolder (`#include <ignition/common/geospatial/Dem.hh>`)
the geospatial subfolder (e.g., `#include <ignition/common/geospatial/ImageHeightmap.hh>`)

Copy link
Member Author

Choose a reason for hiding this comment

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

I used HeightmapData.hh in c3d6053

@scpeters scpeters merged commit e0a5490 into main Jan 19, 2022
@scpeters scpeters deleted the scpeters/geospatial_include_subfolder branch January 19, 2022 17:47
@scpeters
Copy link
Member Author

the homebrew CI didn't build the geospatial component and I didn't realize it

scpeters added a commit to scpeters/ign-common that referenced this pull request Jan 19, 2022
@scpeters scpeters mentioned this pull request Jan 19, 2022
7 tasks
mjcarroll pushed a commit that referenced this pull request Jan 19, 2022
* Revert "Move geospatial headers to subfolder (#289)"

This reverts commit e0a5490.

Signed-off-by: Steve Peters <[email protected]>

* Revert "Geospatial component for heightmap & DEMs (#267)"

This reverts commit 28eb6c7.

Signed-off-by: Steve Peters <[email protected]>
scpeters added a commit that referenced this pull request Jan 21, 2022
This simplifies the logic required for packaging.
Update Migration guide

Signed-off-by: Steve Peters <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants