Heightmap represents a shape defined by a 2D field, and is usually accessed through a Geometry. More...

#include <Heightmap.hh>

Public Member Functions
	Heightmap ()
	Constructor.

void	AddBlend (const HeightmapBlend &_blend)
	Add a heightmap blend.

void	AddTexture (const HeightmapTexture &_texture)
	Add a heightmap texture.

const HeightmapBlend *	BlendByIndex (uint64_t _index) const
	Get a heightmap blend based on an index.

uint64_t	BlendCount () const
	Get the number of heightmap blends.

sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load.

const std::string &	FilePath () const
	The path to the file where this element was loaded from.

Errors	Load (ElementPtr _sdf)
	Load the heightmap geometry based on a element pointer.

Errors	Load (ElementPtr _sdf, const ParserConfig &_config)
	Load the heightmap geometry based on a element pointer.

gz::math::Vector3d	Position () const
	Get the heightmap's position offset.

unsigned int	Sampling () const
	Get the heightmap's sampling per datum.

void	SetFilePath (const std::string &_filePath)
	Set the path to the file where this element was loaded from.

void	SetPosition (const gz::math::Vector3d &_position)
	Set the heightmap's position offset.

void	SetSampling (unsigned int _sampling)
	Set the heightmap's sampling.

void	SetSize (const gz::math::Vector3d &_size)
	Set the heightmap's scaling factor.

void	SetUri (const std::string &_uri)
	Set the URI to a grayscale image.

void	SetUseTerrainPaging (bool _use)
	Set whether the heightmap uses terrain paging.

gz::math::Vector3d	Size () const
	Get the heightmap's scaling factor.

const HeightmapTexture *	TextureByIndex (uint64_t _index) const
	Get a heightmap texture based on an index.

uint64_t	TextureCount () const
	Get the number of heightmap textures.

sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this heightmap.

sdf::ElementPtr	ToElement (sdf::Errors &_errors) const
	Create and return an SDF element filled with data from this heightmap.

std::string	Uri () const
	Get the heightmap's URI.

bool	UseTerrainPaging () const
	Get whether the heightmap uses terrain paging.

Detailed Description

Heightmap represents a shape defined by a 2D field, and is usually accessed through a Geometry.

Constructor & Destructor Documentation

◆ Heightmap()

sdf::SDF_VERSION_NAMESPACE::Heightmap::Heightmap ( )

Constructor.

Member Function Documentation

◆ AddBlend()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::AddBlend ( const HeightmapBlend & _blend )

Add a heightmap blend.

Parameters

[in] _blend Blend to add.

◆ AddTexture()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::AddTexture ( const HeightmapTexture & _texture )

Add a heightmap texture.

Parameters

[in] _texture Texture to add.

◆ BlendByIndex()

const HeightmapBlend * sdf::SDF_VERSION_NAMESPACE::Heightmap::BlendByIndex ( uint64_t _index ) const

Get a heightmap blend based on an index.

Parameters

[in] _index Index of the heightmap blend. The index should be in the range [0..BlendCount()).

Returns: Pointer to the heightmap blend. Nullptr if the index does not exist.

See also: uint64_t BlendCount() const

◆ BlendCount()

uint64_t sdf::SDF_VERSION_NAMESPACE::Heightmap::BlendCount ( ) const

Get the number of heightmap blends.

Returns: Number of heightmap blends contained in this Heightmap object.

◆ Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Heightmap::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.

◆ FilePath()

const std::string & sdf::SDF_VERSION_NAMESPACE::Heightmap::FilePath ( ) const

The path to the file where this element was loaded from.

Returns: Full path to the file on disk.

◆ Load() [1/2]

Errors sdf::SDF_VERSION_NAMESPACE::Heightmap::Load ( ElementPtr _sdf )

Load the heightmap 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::Heightmap::Load	(	ElementPtr	_sdf,
		const ParserConfig &	_config
	)

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

◆ Position()

gz::math::Vector3d sdf::SDF_VERSION_NAMESPACE::Heightmap::Position ( ) const

Get the heightmap's position offset.

Returns: The heightmap's position offset.

◆ Sampling()

unsigned int sdf::SDF_VERSION_NAMESPACE::Heightmap::Sampling ( ) const

Get the heightmap's sampling per datum.

Returns: The heightmap's sampling.

◆ SetFilePath()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::SetFilePath ( const std::string & _filePath )

Set the path to the file where this element was loaded from.

\paramp[in] _filePath Full path to the file on disk.

◆ SetPosition()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::SetPosition ( const gz::math::Vector3d & _position )

Set the heightmap's position offset.

Returns: The heightmap's position offset.

◆ SetSampling()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::SetSampling ( unsigned int _sampling )

Set the heightmap's sampling.

Defaults to 1.

Parameters

[in] _sampling The heightmap's sampling per datum.

◆ SetSize()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::SetSize ( const gz::math::Vector3d & _size )

Set the heightmap's scaling factor.

Defaults to 1x1x1.

Returns: The heightmap's size factor.

◆ SetUri()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::SetUri ( const std::string & _uri )

Set the URI to a grayscale image.

Parameters

[in] _uri The URI of the heightmap.

◆ SetUseTerrainPaging()

void sdf::SDF_VERSION_NAMESPACE::Heightmap::SetUseTerrainPaging ( bool _use )

Set whether the heightmap uses terrain paging.

Defaults to false.

Parameters

[in] _use True to use.

◆ Size()

gz::math::Vector3d sdf::SDF_VERSION_NAMESPACE::Heightmap::Size ( ) const

Get the heightmap's scaling factor.

Returns: The heightmap's size.

◆ TextureByIndex()

const HeightmapTexture * sdf::SDF_VERSION_NAMESPACE::Heightmap::TextureByIndex ( uint64_t _index ) const

Get a heightmap texture based on an index.

Parameters

[in] _index Index of the heightmap texture. The index should be in the range [0..TextureCount()).

Returns: Pointer to the heightmap texture. Nullptr if the index does not exist.

See also: uint64_t TextureCount() const

◆ TextureCount()

uint64_t sdf::SDF_VERSION_NAMESPACE::Heightmap::TextureCount ( ) const

Get the number of heightmap textures.

Returns: Number of heightmap textures contained in this Heightmap object.

◆ ToElement() [1/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Heightmap::ToElement ( ) const

Create and return an SDF element filled with data from this heightmap.

Note that parameter passing functionality is not captured with this function.

Returns: SDF element pointer with updated heightmap values.

◆ ToElement() [2/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Heightmap::ToElement ( sdf::Errors & _errors ) const

Create and return an SDF element filled with data from this heightmap.

Note that parameter passing functionality is not captured with this function.

Parameters

[out] _errors Vector of errors.

Returns: SDF element pointer with updated heightmap values.

◆ Uri()

std::string sdf::SDF_VERSION_NAMESPACE::Heightmap::Uri ( ) const

Get the heightmap's URI.

Returns: The URI of the heightmap data.

◆ UseTerrainPaging()

bool sdf::SDF_VERSION_NAMESPACE::Heightmap::UseTerrainPaging ( ) const

Get whether the heightmap uses terrain paging.

Returns: True if the heightmap uses terrain paging.

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

Heightmap.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Heightmap()

Member Function Documentation

◆ AddBlend()

◆ AddTexture()

◆ BlendByIndex()

◆ BlendCount()

◆ Element()

◆ FilePath()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Position()

◆ Sampling()

◆ SetFilePath()

◆ SetPosition()

◆ SetSampling()

◆ SetSize()

◆ SetUri()

◆ SetUseTerrainPaging()

◆ Size()

◆ TextureByIndex()

◆ TextureCount()

◆ ToElement() [1/2]

◆ ToElement() [2/2]

◆ Uri()

◆ UseTerrainPaging()