Public Member Functions | List of all members
sdf::v10::HeightmapBlend Class Reference

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

#include <Heightmap.hh>

Public Member Functions

 HeightmapBlend ()
 Constructor. More...
 
 HeightmapBlend (const HeightmapBlend &_blend)
 Copy constructor. More...
 
 HeightmapBlend (HeightmapBlend &&_blend) noexcept
 Move constructor. More...
 
virtual ~HeightmapBlend ()
 Destructor. 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...
 
HeightmapBlendoperator= (HeightmapBlend &&_blend)
 Move assignment operator. More...
 
HeightmapBlendoperator= (const HeightmapBlend &_blend)
 Copy Assignment operator. 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() [1/3]

sdf::v10::HeightmapBlend::HeightmapBlend ( )

Constructor.

◆ HeightmapBlend() [2/3]

sdf::v10::HeightmapBlend::HeightmapBlend ( const HeightmapBlend _blend)

Copy constructor.

Parameters
[in]_blendHeightmapBlend to copy.

◆ HeightmapBlend() [3/3]

sdf::v10::HeightmapBlend::HeightmapBlend ( HeightmapBlend &&  _blend)
noexcept

Move constructor.

Parameters
[in]_blendHeightmapBlend to move.

◆ ~HeightmapBlend()

virtual sdf::v10::HeightmapBlend::~HeightmapBlend ( )
virtual

Destructor.

Member Function Documentation

◆ Element()

sdf::ElementPtr sdf::v10::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::v10::HeightmapBlend::FadeDistance ( ) const

Get the heightmap blend's fade distance.

Returns
The fade distance of the heightmap blend in meters.

◆ Load()

Errors sdf::v10::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]_sdfThe 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::v10::HeightmapBlend::MinHeight ( ) const

Get the heightmap blend's minimum height.

Returns
The minimum height of the blend layer.

◆ operator=() [1/2]

HeightmapBlend& sdf::v10::HeightmapBlend::operator= ( HeightmapBlend &&  _blend)

Move assignment operator.

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

◆ operator=() [2/2]

HeightmapBlend& sdf::v10::HeightmapBlend::operator= ( const HeightmapBlend _blend)

Copy Assignment operator.

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

◆ SetFadeDistance()

void sdf::v10::HeightmapBlend::SetFadeDistance ( double  _fadeDistance)

Set the distance over which the blend occurs.

Parameters
[in]_uriThe distance in meters.

◆ SetMinHeight()

void sdf::v10::HeightmapBlend::SetMinHeight ( double  _minHeight)

Set the minimum height of the blend in meters.

Parameters
[in]_uriThe minimum height of the blend in meters.

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