sdf::v12::HeightmapBlend Class Reference

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

#include <Heightmap.hh>

Public Member Functions
	HeightmapBlend ()
	Constructor. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
double	FadeDistance () const
	Get the heightmap blend's fade distance. More...
Errors	Load (ElementPtr _sdf)
	Load the heightmap blend geometry based on a element pointer. More...
double	MinHeight () const
	Get the heightmap blend's minimum height. More...
void	SetFadeDistance (double _fadeDistance)
	Set the distance over which the blend occurs. More...
void	SetMinHeight (double _minHeight)
	Set the minimum height of the blend in meters. More...

Detailed Description

Blend information to be used between textures on heightmaps.

Constructor & Destructor Documentation

HeightmapBlend()

sdf::v12::HeightmapBlend::HeightmapBlend

(

)

Constructor.

Member Function Documentation

Element()

sdf::ElementPtr sdf::v12::HeightmapBlend::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.

FadeDistance()

double sdf::v12::HeightmapBlend::FadeDistance

(

)

const

Get the heightmap blend's fade distance.

Returns

The fade distance of the heightmap blend in meters.

Load()

Errors sdf::v12::HeightmapBlend::Load

(

ElementPtr

_sdf

)

Load the heightmap blend 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.

MinHeight()

double sdf::v12::HeightmapBlend::MinHeight

(

)

const

Get the heightmap blend's minimum height.

Returns

The minimum height of the blend layer.

SetFadeDistance()

void sdf::v12::HeightmapBlend::SetFadeDistance

(

double

_fadeDistance

)

Set the distance over which the blend occurs.

Parameters

[in]

_uri

The distance in meters.

SetMinHeight()

void sdf::v12::HeightmapBlend::SetMinHeight

(

double

_minHeight

)

Set the minimum height of the blend in meters.

Parameters

[in]

_uri

The minimum height of the blend in meters.

---

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

• Heightmap.hh