sdf::v12::Heightmap Class Reference

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. More...
void	AddBlend (const HeightmapBlend &_blend)
	Add a heightmap blend. More...
void	AddTexture (const HeightmapTexture &_texture)
	Add a heightmap texture. More...
const HeightmapBlend *	BlendByIndex (uint64_t _index) const
	Get a heightmap blend based on an index. More...
uint64_t	BlendCount () const
	Get the number of heightmap blends. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
const std::string &	FilePath () const
	The path to the file where this element was loaded from. More...
Errors	Load (ElementPtr _sdf)
	Load the heightmap geometry based on a element pointer. More...
ignition::math::Vector3d	Position () const
	Get the heightmap's position offset. More...
unsigned int	Sampling () const
	Get the heightmap's sampling per datum. More...
void	SetFilePath (const std::string &_filePath)
	Set the path to the file where this element was loaded from. More...
void	SetPosition (const ignition::math::Vector3d &_position)
	Set the heightmap's position offset. More...
void	SetSampling (unsigned int _sampling)
	Set the heightmap's sampling. More...
void	SetSize (const ignition::math::Vector3d &_size)
	Set the heightmap's scaling factor. More...
void	SetUri (const std::string &_uri)
	Set the URI to a grayscale image. More...
void	SetUseTerrainPaging (bool _use)
	Set whether the heightmap uses terrain paging. More...
ignition::math::Vector3d	Size () const
	Get the heightmap's scaling factor. More...
const HeightmapTexture *	TextureByIndex (uint64_t _index) const
	Get a heightmap texture based on an index. More...
uint64_t	TextureCount () const
	Get the number of heightmap textures. More...
sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this heightmap. More...
std::string	Uri () const
	Get the heightmap's URI. More...
bool	UseTerrainPaging () const
	Get whether the heightmap uses terrain paging. More...

Detailed Description

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

Constructor & Destructor Documentation

Heightmap()

sdf::v12::Heightmap::Heightmap

(

)

Constructor.

Member Function Documentation

AddBlend()

void sdf::v12::Heightmap::AddBlend

(

const HeightmapBlend &

_blend

)

Add a heightmap blend.

Parameters

[in]

_blend

Blend to add.

AddTexture()

void sdf::v12::Heightmap::AddTexture

(

const HeightmapTexture &

_texture

)

Add a heightmap texture.

Parameters

[in]

_texture

Texture to add.

BlendByIndex()

const HeightmapBlend* sdf::v12::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::v12::Heightmap::BlendCount

(

)

const

Get the number of heightmap blends.

Returns

Number of heightmap blends contained in this Heightmap object.

Element()

sdf::ElementPtr sdf::v12::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::v12::Heightmap::FilePath

(

)

const

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

Returns

Full path to the file on disk.

Load()

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

Position()

ignition::math::Vector3d sdf::v12::Heightmap::Position

(

)

const

Get the heightmap's position offset.

Returns

The heightmap's position offset.

Sampling()

unsigned int sdf::v12::Heightmap::Sampling

(

)

const

Get the heightmap's sampling per datum.

Returns

The heightmap's sampling.

SetFilePath()

void sdf::v12::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::v12::Heightmap::SetPosition

(

const ignition::math::Vector3d &

_position

)

Set the heightmap's position offset.

Returns

The heightmap's position offset.

SetSampling()

void sdf::v12::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::v12::Heightmap::SetSize

(

const ignition::math::Vector3d &

_size

)

Set the heightmap's scaling factor.

Defaults to 1x1x1.

Returns

The heightmap's size factor.

SetUri()

void sdf::v12::Heightmap::SetUri

(

const std::string &

_uri

)

Set the URI to a grayscale image.

Parameters

[in]

_uri

The URI of the heightmap.

SetUseTerrainPaging()

void sdf::v12::Heightmap::SetUseTerrainPaging

(

bool

_use

)

Set whether the heightmap uses terrain paging.

Defaults to false.

Parameters

[in]

_use

True to use.

Size()

ignition::math::Vector3d sdf::v12::Heightmap::Size

(

)

const

Get the heightmap's scaling factor.

Returns

The heightmap's size.

TextureByIndex()

const HeightmapTexture* sdf::v12::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::v12::Heightmap::TextureCount

(

)

const

Get the number of heightmap textures.

Returns

Number of heightmap textures contained in this Heightmap object.

ToElement()

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

Uri()

std::string sdf::v12::Heightmap::Uri

(

)

const

Get the heightmap's URI.

Returns

The URI of the heightmap data.

UseTerrainPaging()

bool sdf::v12::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