Heightmap Class Reference

Rendering a terrain using heightmap information. More...

#include <rendering/rendering.hh>

Public Member Functions

 Heightmap (ScenePtr _scene)
 Constructor. More...
 
virtual ~Heightmap ()
 Destructor. More...
 
double AvgHeight (const ignition::math::Vector3d &_pos, const double _brushSize) const
 Get the average height around a point. More...
 
bool Flatten (CameraPtr _camera, math::Vector2i _mousePos, double _outsideRadius, double _insideRadius, double _weight=0.1) GAZEBO_DEPRECATED(7.0)
 Flatten the terrain based on a mouse press. More...
 
bool Flatten (CameraPtr _camera, const ignition::math::Vector2i &_mousePos, const double _outsideRadius, const double _insideRadius, const double _weight=0.1)
 Flatten the terrain based on a mouse press. More...
 
double GetAvgHeight (Ogre::Vector3 _pos, double _brushSize) GAZEBO_DEPRECATED(7.0)
 Get the average height around a point. More...
 
double GetHeight (double _x, double _y, double _z=1000) GAZEBO_DEPRECATED(7.0)
 Get the height at a location. More...
 
common::Image GetImage () const GAZEBO_DEPRECATED(7.0)
 Get the heightmap as an image. More...
 
Ogre::TerrainGroup::RayResult GetMouseHit (CameraPtr _camera, math::Vector2i _mousePos) GAZEBO_DEPRECATED(7.0)
 Calculate a mouse ray hit on the terrain. More...
 
Ogre::TerrainGroup * GetOgreTerrain () const GAZEBO_DEPRECATED(7.0)
 Get a pointer to the OGRE terrain group object. More...
 
unsigned int GetTerrainSubdivisionCount () const GAZEBO_DEPRECATED(7.0)
 Get the number of subdivision the terrain will be split into. More...
 
double Height (const double _x, const double _y, const double _z=1000) const
 Get the height at a location. More...
 
common::Image Image () const
 Get the heightmap as an image. More...
 
void Load ()
 Load the heightmap. More...
 
void LoadFromMsg (ConstVisualPtr &_msg)
 Load the heightmap from a visual message. More...
 
bool Lower (CameraPtr _camera, math::Vector2i _mousePos, double _outsideRadius, double _insideRadius, double _weight=0.1) GAZEBO_DEPRECATED(7.0)
 Lower the terrain based on a mouse press. More...
 
bool Lower (CameraPtr _camera, const ignition::math::Vector2i &_mousePos, const double _outsideRadius, const double _insideRadius, const double _weight=0.1)
 Lower the terrain based on a mouse press. More...
 
Ogre::TerrainGroup::RayResult MouseHit (CameraPtr _camera, const ignition::math::Vector2i &_mousePos) const
 Calculate a mouse ray hit on the terrain. More...
 
Ogre::TerrainGroup * OgreTerrain () const
 Get a pointer to the OGRE terrain group object. More...
 
bool Raise (CameraPtr _camera, math::Vector2i _mousePos, double _outsideRadius, double _insideRadius, double _weight=0.1) GAZEBO_DEPRECATED(7.0)
 Raise the terrain based on a mouse press. More...
 
bool Raise (CameraPtr _camera, const ignition::math::Vector2i &_mousePos, const double _outsideRadius, const double _insideRadius, const double _weight=0.1)
 Raise the terrain based on a mouse press. More...
 
void SetWireframe (const bool _show)
 Set the heightmap to render in wireframe mode. More...
 
bool Smooth (CameraPtr _camera, math::Vector2i _mousePos, double _outsideRadius, double _insideRadius, double _weight=0.1) GAZEBO_DEPRECATED(7.0)
 Smooth the terrain based on a mouse press. More...
 
bool Smooth (CameraPtr _camera, const ignition::math::Vector2i &_mousePos, const double _outsideRadius, const double _insideRadius, const double _weight=0.1)
 Smooth the terrain based on a mouse press. More...
 
void SplitHeights (const std::vector< float > &_heightmap, const int _n, std::vector< std::vector< float > > &_v)
 Split a terrain into subterrains. More...
 
unsigned int TerrainSubdivisionCount () const
 Get the number of subdivision the terrain will be split into. More...
 

Detailed Description

Rendering a terrain using heightmap information.

Constructor & Destructor Documentation

§ Heightmap()

Heightmap ( ScenePtr  _scene)

Constructor.

Parameters
[in]_scenePointer to the scene that will contain the heightmap

§ ~Heightmap()

virtual ~Heightmap ( )
virtual

Destructor.

Member Function Documentation

§ AvgHeight()

double AvgHeight ( const ignition::math::Vector3d &  _pos,
const double  _brushSize 
) const

Get the average height around a point.

Parameters
[in]_posPosition in world coordinates.
[in]_brushSizeControls the radius of effect.

§ Flatten() [1/2]

bool Flatten ( CameraPtr  _camera,
math::Vector2i  _mousePos,
double  _outsideRadius,
double  _insideRadius,
double  _weight = 0.1 
)

Flatten the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified
Deprecated:
See function that accepts an ignition::math parameter.

§ Flatten() [2/2]

bool Flatten ( CameraPtr  _camera,
const ignition::math::Vector2i &  _mousePos,
const double  _outsideRadius,
const double  _insideRadius,
const double  _weight = 0.1 
)

Flatten the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified

§ GetAvgHeight()

double GetAvgHeight ( Ogre::Vector3  _pos,
double  _brushSize 
)

Get the average height around a point.

Parameters
[in]_posPosition in world coordinates.
[in]_brushSizeControls the radius of effect.
Deprecated:
See AvgHeight()

§ GetHeight()

double GetHeight ( double  _x,
double  _y,
double  _z = 1000 
)

Get the height at a location.

Parameters
[in]_xX location
[in]_yY location
[in]_zZ location
Returns
The height at the specified location
Deprecated:
See Height()

§ GetImage()

common::Image GetImage ( ) const

Get the heightmap as an image.

Returns
An image that contains the terrain data.
Deprecated:
See Image()

§ GetMouseHit()

Ogre::TerrainGroup::RayResult GetMouseHit ( CameraPtr  _camera,
math::Vector2i  _mousePos 
)

Calculate a mouse ray hit on the terrain.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
Returns
The result of the mouse ray hit.
Deprecated:
See MouseHit()

§ GetOgreTerrain()

Ogre::TerrainGroup* GetOgreTerrain ( ) const

Get a pointer to the OGRE terrain group object.

Returns
Pointer to the OGRE terrain.
Deprecated:
See OgreTerrain()

§ GetTerrainSubdivisionCount()

unsigned int GetTerrainSubdivisionCount ( ) const

Get the number of subdivision the terrain will be split into.

Returns
Number of terrain subdivisions
Deprecated:
See TerrainSubdivisionCount()

§ Height()

double Height ( const double  _x,
const double  _y,
const double  _z = 1000 
) const

Get the height at a location.

Parameters
[in]_xX location
[in]_yY location
[in]_zZ location
Returns
The height at the specified location

§ Image()

common::Image Image ( ) const

Get the heightmap as an image.

Returns
An image that contains the terrain data.

§ Load()

void Load ( )

Load the heightmap.

§ LoadFromMsg()

void LoadFromMsg ( ConstVisualPtr &  _msg)

Load the heightmap from a visual message.

Parameters
[in]_msgThe visual message containing heightmap info

§ Lower() [1/2]

bool Lower ( CameraPtr  _camera,
math::Vector2i  _mousePos,
double  _outsideRadius,
double  _insideRadius,
double  _weight = 0.1 
)

Lower the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified
Deprecated:
See function that accepts an ignition::math parameter.

§ Lower() [2/2]

bool Lower ( CameraPtr  _camera,
const ignition::math::Vector2i &  _mousePos,
const double  _outsideRadius,
const double  _insideRadius,
const double  _weight = 0.1 
)

Lower the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified

§ MouseHit()

Ogre::TerrainGroup::RayResult MouseHit ( CameraPtr  _camera,
const ignition::math::Vector2i &  _mousePos 
) const

Calculate a mouse ray hit on the terrain.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
Returns
The result of the mouse ray hit.

§ OgreTerrain()

Ogre::TerrainGroup* OgreTerrain ( ) const

Get a pointer to the OGRE terrain group object.

Returns
Pointer to the OGRE terrain.

§ Raise() [1/2]

bool Raise ( CameraPtr  _camera,
math::Vector2i  _mousePos,
double  _outsideRadius,
double  _insideRadius,
double  _weight = 0.1 
)

Raise the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified
Deprecated:
See function that accepts an ignition::math parameter.

§ Raise() [2/2]

bool Raise ( CameraPtr  _camera,
const ignition::math::Vector2i &  _mousePos,
const double  _outsideRadius,
const double  _insideRadius,
const double  _weight = 0.1 
)

Raise the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified

§ SetWireframe()

void SetWireframe ( const bool  _show)

Set the heightmap to render in wireframe mode.

Parameters
[in]_showTrue to render wireframe, false to render solid.

§ Smooth() [1/2]

bool Smooth ( CameraPtr  _camera,
math::Vector2i  _mousePos,
double  _outsideRadius,
double  _insideRadius,
double  _weight = 0.1 
)

Smooth the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified
Deprecated:
See function that accepts an ignition::math parameter.

§ Smooth() [2/2]

bool Smooth ( CameraPtr  _camera,
const ignition::math::Vector2i &  _mousePos,
const double  _outsideRadius,
const double  _insideRadius,
const double  _weight = 0.1 
)

Smooth the terrain based on a mouse press.

Parameters
[in]_cameraCamera associated with the mouse press.
[in]_mousePosPosition of the mouse in viewport coordinates.
[in]_outsideRadiusControls the radius of effect.
[in]_insideRadiusControls the size of the radius with the maximum effect (value between 0 and 1).
[in]_weightControls modification magnitude.
Returns
True if the terrain was modified

§ SplitHeights()

void SplitHeights ( const std::vector< float > &  _heightmap,
const int  _n,
std::vector< std::vector< float > > &  _v 
)

Split a terrain into subterrains.

Parameters
[in]_heightmapSource vector of floats with the heights.
[in]_nNumber of subterrains.
[out]_vDestination vector with the subterrains.

§ TerrainSubdivisionCount()

unsigned int TerrainSubdivisionCount ( ) const

Get the number of subdivision the terrain will be split into.

Returns
Number of terrain subdivisions

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