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.

Sign up for GitHub

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
Merged

Move geospatial headers to subfolder #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c996e5c
Move geospatial headers to subfolder
scpeters Jan 19, 2022
92e2c7e
Update Migration guide
scpeters Jan 19, 2022
c3d6053
Use HeightmapData.hh as example in migration guide
scpeters Jan 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/HeightmapData.hh>`)

## Ignition Common 3.X to 4.X

Expand Down
10 changes: 5 additions & 5 deletions geospatial/include/ignition/common/Dem.hh → ...include/ignition/common/geospatial/Dem.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
* limitations under the License.
*
*/
#ifndef IGNITION_COMMON_DEM_HH_
#define IGNITION_COMMON_DEM_HH_
#ifndef IGNITION_COMMON_GEOSPATIAL_DEM_HH_
#define IGNITION_COMMON_GEOSPATIAL_DEM_HH_

#include <memory>
#include <string>
Expand All @@ -24,8 +24,8 @@
#include <ignition/math/Vector3.hh>
#include <ignition/math/Angle.hh>

#include <ignition/common/HeightmapData.hh>
#include <ignition/common/graphics/Export.hh>
#include <ignition/common/geospatial/Export.hh>
#include <ignition/common/geospatial/HeightmapData.hh>

#include <ignition/utils/ImplPtr.hh>

Expand All @@ -36,7 +36,7 @@ namespace ignition
{
/// \class DEM DEM.hh common/common.hh
/// \brief Encapsulates a DEM (Digital Elevation Model) file.
class IGNITION_COMMON_GRAPHICS_VISIBLE Dem : public HeightmapData
class IGNITION_COMMON_GEOSPATIAL_VISIBLE Dem : public HeightmapData
{
/// \brief Constructor.
public: Dem();
Expand Down
8 changes: 4 additions & 4 deletions .../include/ignition/common/HeightmapData.hh → ...nition/common/geospatial/HeightmapData.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@
* limitations under the License.
*
*/
#ifndef IGNITION_COMMON_HEIGHTMAPDATA_HH_
#define IGNITION_COMMON_HEIGHTMAPDATA_HH_
#ifndef IGNITION_COMMON_GEOSPATIAL_HEIGHTMAPDATA_HH_
#define IGNITION_COMMON_GEOSPATIAL_HEIGHTMAPDATA_HH_

#include <string>
#include <vector>
#include <ignition/math/Vector3.hh>
#include <ignition/common/graphics/Export.hh>
#include <ignition/common/geospatial/Export.hh>

namespace ignition
{
namespace common
{
/// \brief Encapsulates a generic heightmap data file.
class IGNITION_COMMON_GRAPHICS_VISIBLE HeightmapData
class IGNITION_COMMON_GEOSPATIAL_VISIBLE HeightmapData
{
/// \brief Destructor.
public: virtual ~HeightmapData() = default;
Expand Down
10 changes: 5 additions & 5 deletions ...include/ignition/common/ImageHeightmap.hh → ...ition/common/geospatial/ImageHeightmap.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@
* limitations under the License.
*
*/
#ifndef IGNITION_COMMON_IMAGEHEIGHTMAPDATA_HH_
#define IGNITION_COMMON_IMAGEHEIGHTMAPDATA_HH_
#ifndef IGNITION_COMMON_GEOSPATIAL_IMAGEHEIGHTMAPDATA_HH_
#define IGNITION_COMMON_GEOSPATIAL_IMAGEHEIGHTMAPDATA_HH_

#include <limits>
#include <string>
#include <vector>
#include <ignition/math/Vector3.hh>

#include <ignition/common/graphics/Export.hh>
#include <ignition/common/HeightmapData.hh>
#include <ignition/common/geospatial/Export.hh>
#include <ignition/common/geospatial/HeightmapData.hh>
#include <ignition/common/Image.hh>

namespace ignition
{
namespace common
{
/// \brief Encapsulates an image that will be interpreted as a heightmap.
class IGNITION_COMMON_GRAPHICS_VISIBLE ImageHeightmap
class IGNITION_COMMON_GEOSPATIAL_VISIBLE ImageHeightmap
: public ignition::common::HeightmapData
{
/// \brief Constructor
Expand Down
2 changes: 1 addition & 1 deletion geospatial/src/Dem.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#include <ogr_spatialref.h>

#include "ignition/common/Console.hh"
#include "ignition/common/Dem.hh"
#include "ignition/common/geospatial/Dem.hh"
#include "ignition/math/SphericalCoordinates.hh"

using namespace ignition;
Expand Down
2 changes: 1 addition & 1 deletion geospatial/src/Dem_TEST.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#include <ignition/math/Angle.hh>
#include <ignition/math/Vector3.hh>

#include "ignition/common/Dem.hh"
#include "ignition/common/geospatial/Dem.hh"
#include "test_config.h"

using namespace ignition;
Expand Down
2 changes: 1 addition & 1 deletion geospatial/src/ImageHeightmap.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*
*/
#include "ignition/common/Console.hh"
#include "ignition/common/ImageHeightmap.hh"
#include "ignition/common/geospatial/ImageHeightmap.hh"

using namespace ignition;
using namespace common;
Expand Down
2 changes: 1 addition & 1 deletion geospatial/src/ImageHeightmap_TEST.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/
#include <gtest/gtest.h>

#include "ignition/common/ImageHeightmap.hh"
#include "ignition/common/geospatial/ImageHeightmap.hh"
#include "test_config.h"

#define ELEVATION_TOL 1e-8
Expand Down