Gazebo Common

API Reference

3.17.0
gz/common/ImageHeightmap.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef GZ_COMMON_IMAGEHEIGHTMAPDATA_HH_
18 #define GZ_COMMON_IMAGEHEIGHTMAPDATA_HH_
19 
20 #include <string>
21 #include <vector>
22 #include <gz/math/Vector3.hh>
23 
24 #include <gz/common/graphics/Export.hh>
26 #include <gz/common/Image.hh>
27 
28 namespace ignition
29 {
30  namespace common
31  {
33  class IGNITION_COMMON_GRAPHICS_VISIBLE ImageHeightmap
34  : public gz::common::HeightmapData
35  {
38  public: ImageHeightmap();
39 
43  public: int Load(const std::string &_filename = "");
44 
45  // Documentation inherited.
46  public: void FillHeightMap(int _subSampling, unsigned int _vertSize,
47  const gz::math::Vector3d &_size,
48  const gz::math::Vector3d &_scale, bool _flipY,
49  std::vector<float> &_heights);
50 
53  public: std::string Filename() const;
54 
55  // Documentation inherited.
56  public: unsigned int Height() const;
57 
58  // Documentation inherited.
59  public: unsigned int Width() const;
60 
61  // Documentation inherited.
62  public: float MaxElevation() const;
63 
65  private: gz::common::Image img;
66  };
67  }
68 }
69 #endif
Forward declarations for the common classes.
STL class.
STL class.
Encapsulates an image that will be interpreted as a heightmap.
Definition: gz/common/ImageHeightmap.hh:33
Encapsulates a generic heightmap data file.
Definition: gz/common/HeightmapData.hh:29
Encapsulates an image.
Definition: gz/common/Image.hh:64