##

HeightmapData Class Referenceabstract
Common

Encapsulates a generic heightmap data file. More...

`#include <common/common.hh>`

Inherited by Dem, and ImageHeightmap.

## Public Member Functions

virtual | ~HeightmapData ()
| Destructor. 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

## ~HeightmapData()

virtual ~HeightmapData | ( |  | ) |

inline virtual

Destructor.

## Member Function Documentation

## FillHeightMap()

virtual void 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] | _subsampling | Multiplier 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] | _vertSize | Number of points per row.
  [in] | _size | Real dimmensions of the terrain.
  [in] | _scale | Vector3 used to scale the height.
  [in] | _flipY | If true, it inverts the order in which the vector is filled.
  [out] | _heights | Vector containing the terrain heights.

Implemented in ImageHeightmap, and Dem.

## GetHeight()

virtual unsigned int GetHeight | ( |  | ) | const

pure virtual

Get the terrain's height.

Returns
  The terrain's height.

Implemented in Dem, and ImageHeightmap.

## GetMaxElevation()

virtual float GetMaxElevation | ( |  | ) | const

pure virtual

Get the maximum terrain's elevation.

Returns
  The maximum terrain's elevation.

Implemented in Dem, and ImageHeightmap.

## GetWidth()

virtual unsigned int GetWidth | ( |  | ) | const

pure virtual

Get the terrain's width.

Returns
  The terrain's width.

Implemented in Dem, and ImageHeightmap.

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

- HeightmapData.hh