Gazebo Rendering

API Reference

9.0.0
List of all members | Public Member Functions
HeightmapBlend Class Reference

Blend information to be used between textures on heightmaps. More...

#include <HeightmapDescriptor.hh>

Public Member Functions

 HeightmapBlend ()
 Constructor.
 
 HeightmapBlend (const HeightmapBlend &_blend)
 Copy constructor.
 
 HeightmapBlend (HeightmapBlend &&_blend) noexcept
 Move constructor.
 
virtual ~HeightmapBlend ()
 Destructor.
 
double FadeDistance () const
 Get the heightmap blend's fade distance.
 
double MinHeight () const
 Get the heightmap blend's minimum height.
 
HeightmapBlend & operator= (const HeightmapBlend &_blend)
 Copy Assignment operator.
 
HeightmapBlend & operator= (HeightmapBlend &&_blend)
 Move assignment operator.
 
void SetFadeDistance (double _fadeDistance)
 Set the distance over which the blend occurs.
 
void SetMinHeight (double _minHeight)
 Set the minimum height of the blend in meters.
 

Detailed Description

Blend information to be used between textures on heightmaps.

Constructor & Destructor Documentation

◆ HeightmapBlend() [1/3]

HeightmapBlend ( )

Constructor.

◆ HeightmapBlend() [2/3]

HeightmapBlend ( const HeightmapBlend &  _blend)

Copy constructor.

Parameters
[in]_blendHeightmapBlend to copy.

◆ HeightmapBlend() [3/3]

HeightmapBlend ( HeightmapBlend &&  _blend)
noexcept

Move constructor.

Parameters
[in]_blendHeightmapBlend to move.

◆ ~HeightmapBlend()

virtual ~HeightmapBlend ( )
virtual

Destructor.

Member Function Documentation

◆ FadeDistance()

double FadeDistance ( ) const

Get the heightmap blend's fade distance.

Returns
The fade distance of the heightmap blend in meters.

◆ MinHeight()

double MinHeight ( ) const

Get the heightmap blend's minimum height.

Returns
The minimum height of the blend layer.

◆ operator=() [1/2]

HeightmapBlend & operator= ( const HeightmapBlend &  _blend)

Copy Assignment operator.

Parameters
[in]_blendThe heightmap blend to set values from.
Returns
*this

◆ operator=() [2/2]

HeightmapBlend & operator= ( HeightmapBlend &&  _blend)

Move assignment operator.

Parameters
[in]_blendHeightmap blend to move.
Returns
Reference to this.

◆ SetFadeDistance()

void SetFadeDistance ( double  _fadeDistance)

Set the distance over which the blend occurs.

Parameters
[in]_fadeDistanceThe distance in meters.

◆ SetMinHeight()

void SetMinHeight ( double  _minHeight)

Set the minimum height of the blend in meters.

Parameters
[in]_minHeightThe minimum height of the blend in meters.
The documentation for this class was generated from the following file: