Ignition Rendering

API Reference

6.3.1
HeightmapTexture Class Reference

Texture to be used on heightmaps. More...

#include <HeightmapDescriptor.hh>

Public Member Functions

 HeightmapTexture ()
 Constructor. More...
 
 HeightmapTexture (const HeightmapTexture &_texture)
 Copy constructor. More...
 
 HeightmapTexture (HeightmapTexture &&_texture) noexcept
 Move constructor. More...
 
virtual ~HeightmapTexture ()
 Destructor. More...
 
std::string Diffuse () const
 Get the heightmap texture's diffuse map. More...
 
std::string Normal () const
 Get the heightmap texture's normal map. More...
 
HeightmapTextureoperator= (HeightmapTexture &&_texture)
 Move assignment operator. More...
 
HeightmapTextureoperator= (const HeightmapTexture &_texture)
 Copy Assignment operator. More...
 
void SetDiffuse (const std::string &_diffuse)
 Set the filename of the diffuse map. More...
 
void SetNormal (const std::string &_normal)
 Set the filename of the normal map. More...
 
void SetSize (double _size)
 Set the size of the texture in meters. More...
 
double Size () const
 Get the heightmap texture's size. More...
 

Detailed Description

Texture to be used on heightmaps.

Constructor & Destructor Documentation

◆ HeightmapTexture() [1/3]

Constructor.

◆ HeightmapTexture() [2/3]

HeightmapTexture ( const HeightmapTexture _texture)

Copy constructor.

Parameters
[in]_textureHeightmapTexture to copy.

◆ HeightmapTexture() [3/3]

HeightmapTexture ( HeightmapTexture &&  _texture)
noexcept

Move constructor.

Parameters
[in]_textureHeightmapTexture to move.

◆ ~HeightmapTexture()

virtual ~HeightmapTexture ( )
virtual

Destructor.

Member Function Documentation

◆ Diffuse()

std::string Diffuse ( ) const

Get the heightmap texture's diffuse map.

Returns
The diffuse map of the heightmap texture.

◆ Normal()

std::string Normal ( ) const

Get the heightmap texture's normal map.

Returns
The normal map of the heightmap texture.

◆ operator=() [1/2]

HeightmapTexture& operator= ( HeightmapTexture &&  _texture)

Move assignment operator.

Parameters
[in]_textureHeightmap texture to move.
Returns
Reference to this.

◆ operator=() [2/2]

HeightmapTexture& operator= ( const HeightmapTexture _texture)

Copy Assignment operator.

Parameters
[in]_textureThe heightmap texture to set values from.
Returns
*this

◆ SetDiffuse()

void SetDiffuse ( const std::string _diffuse)

Set the filename of the diffuse map.

Parameters
[in]_diffuseThe diffuse map of the heightmap texture.

◆ SetNormal()

void SetNormal ( const std::string _normal)

Set the filename of the normal map.

Parameters
[in]_normalThe normal map of the heightmap texture.

◆ SetSize()

void SetSize ( double  _size)

Set the size of the texture in meters.

Parameters
[in]_sizeThe size of the texture in meters.

◆ Size()

double Size ( ) const

Get the heightmap texture's size.

Returns
The size of the heightmap texture in meters.

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