sdf::SDF_VERSION_NAMESPACE::HeightmapTexture Class Reference

Texture to be used on heightmaps. More...

#include <Heightmap.hh>

Public Member Functions
	HeightmapTexture ()
	Constructor.
std::string	Diffuse () const
	Get the heightmap texture's diffuse map.
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load.
Errors	Load (ElementPtr _sdf)
	Load the heightmap texture geometry based on a element pointer.
Errors	Load (sdf::ElementPtr _sdf, const ParserConfig &_config)
	Load the heightmap texture geometry based on a element pointer.
std::string	Normal () const
	Get the heightmap texture's normal map.
void	SetDiffuse (const std::string &_diffuse)
	Set the filename of the diffuse map.
void	SetNormal (const std::string &_normal)
	Set the filename of the normal map.
void	SetSize (double _size)
	Set the size of the texture in meters.
double	Size () const
	Get the heightmap texture's size.

Detailed Description

Texture to be used on heightmaps.

Constructor & Destructor Documentation

HeightmapTexture()

sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::HeightmapTexture

(

)

Constructor.

Member Function Documentation

Diffuse()

std::string sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::Diffuse

(

)

const

Get the heightmap texture's diffuse map.

Returns

The diffuse map of the heightmap texture.

Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::Element

(

)

const

Get a pointer to the SDF element that was used during load.

Returns

SDF element pointer. The value will be nullptr if Load has not been called.

Load() [1/2]

Errors sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::Load

(

ElementPtr

_sdf

)

Load the heightmap texture geometry based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters

[in]

_sdf

The SDF Element pointer

Returns

Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

Load() [2/2]

Errors sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::Load	(	sdf::ElementPtr	_sdf,
		const ParserConfig &	_config
	)

Load the heightmap texture geometry based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters

[in]	_sdf	The SDF Element pointer
[in]	_config	Parser configuration

Returns

Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

Normal()

std::string sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::Normal

(

)

const

Get the heightmap texture's normal map.

Returns

The normal map of the heightmap texture.

SetDiffuse()

void sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::SetDiffuse

(

const std::string &

_diffuse

)

Set the filename of the diffuse map.

Parameters

[in]

_diffuse

The diffuse map of the heightmap texture.

SetNormal()

void sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::SetNormal

(

const std::string &

_normal

)

Set the filename of the normal map.

Parameters

[in]

_normal

The normal map of the heightmap texture.

SetSize()

void sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::SetSize

(

double

_size

)

Set the size of the texture in meters.

Parameters

[in]

_size

The size of the texture in meters.

Size()

double sdf::SDF_VERSION_NAMESPACE::HeightmapTexture::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:

• Heightmap.hh