Class
List
Hierarchy
Modules
Common
Events
Math
Messages
Physics
Rendering
Sensors
Transport
Links
Gazebo Website
Wiki
Tutorials
Download
Report Documentation Issues
Public Member Functions | List of all members
gazebo::common::HeightmapData Class Referenceabstract
Common

Encapsulates a generic heightmap data file. More...

#include <common/common.hh>

Inheritance diagram for gazebo::common::HeightmapData:
Inheritance graph
[legend]

Public Member Functions

virtual ~HeightmapData ()
 Destructor. More...
 
virtual void FillHeightMap (int _subSampling, unsigned int _vertSize, const math::Vector3 &_size, const math::Vector3 &_scale, bool _flipY, std::vector< float > &_heights) GAZEBO_DEPRECATED(6.0)=0
 Create a lookup table of the terrain's height. More...
 
virtual void FillHeightMap (int _subSampling, unsigned int _vertSize, const ignition::math::Vector3d &_size, const ignition::math::Vector3d &_scale, bool _flipY, std::vector< float > &_heights)=0
 Create a lookup table of the terrain's height. More...
 
virtual unsigned int GetHeight () const =0
 Get the terrain's height. More...
 
virtual float GetMaxElevation () const =0
 Get the maximum terrain's elevation. More...
 
virtual unsigned int GetWidth () const =0
 Get the terrain's width. More...
 

Detailed Description

Encapsulates a generic heightmap data file.

Constructor & Destructor Documentation

virtual gazebo::common::HeightmapData::~HeightmapData ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual void gazebo::common::HeightmapData::FillHeightMap ( int  _subSampling,
unsigned int  _vertSize,
const math::Vector3 &  _size,
const math::Vector3 &  _scale,
bool  _flipY,
std::vector< float > &  _heights 
)
pure virtual

Create a lookup table of the terrain's height.

Parameters
[in]_subsamplingMultiplier used to increase the resolution. Ex: A subsampling of 2 in a terrain of 129x129 means that the height vector will be 257 * 257.
[in]_vertSizeNumber of points per row.
[in]_sizeReal dimmensions of the terrain.
[in]_scaleVector3 used to scale the height.
[in]_flipYIf true, it inverts the order in which the vector is filled.
[out]_heightsVector containing the terrain heights.
Deprecated:
See FillHeightMap() that accepts ignition::math::Vector3d objects.

Implemented in gazebo::common::Dem, and gazebo::common::ImageHeightmap.

virtual void gazebo::common::HeightmapData::FillHeightMap ( int  _subSampling,
unsigned int  _vertSize,
const ignition::math::Vector3d &  _size,
const ignition::math::Vector3d &  _scale,
bool  _flipY,
std::vector< float > &  _heights 
)
pure virtual

Create a lookup table of the terrain's height.

Parameters
[in]_subsamplingMultiplier used to increase the resolution. Ex: A subsampling of 2 in a terrain of 129x129 means that the height vector will be 257 * 257.
[in]_vertSizeNumber of points per row.
[in]_sizeReal dimmensions of the terrain.
[in]_scaleVector3 used to scale the height.
[in]_flipYIf true, it inverts the order in which the vector is filled.
[out]_heightsVector containing the terrain heights.

Implemented in gazebo::common::Dem, and gazebo::common::ImageHeightmap.

virtual unsigned int gazebo::common::HeightmapData::GetHeight ( ) const
pure virtual

Get the terrain's height.

Returns
The terrain's height.

Implemented in gazebo::common::Dem, and gazebo::common::ImageHeightmap.

virtual float gazebo::common::HeightmapData::GetMaxElevation ( ) const
pure virtual

Get the maximum terrain's elevation.

Returns
The maximum terrain's elevation.

Implemented in gazebo::common::ImageHeightmap, and gazebo::common::Dem.

virtual unsigned int gazebo::common::HeightmapData::GetWidth ( ) const
pure virtual

Get the terrain's width.

Returns
The terrain's width.

Implemented in gazebo::common::Dem, and gazebo::common::ImageHeightmap.

The documentation for this class was generated from the following file: