Unigine::LandscapeMapFileSettings Class

LandscapeMapFileSettings Class

Members

---

static LandscapeMapFileSettingsPtr create ( ) #

The LandscapeMapFileSettings constructor.

void setHeightBlending ( Landscape::BLENDING_MODE blending ) #

Sets a new blending mode to be used for heights data of the landscape map.

Arguments

• Landscape::BLENDING_MODE blending - Blending mode to be used for heights data. One of the following values:
  • Alpha Blend
  • Additive

Landscape::BLENDING_MODE getHeightBlending ( ) const#

Returns the current blending mode used for heights data of the landscape map.

Return value

Blending mode used for heights data. One of the following values:

• Alpha Blend
• Additive

void setAlbedoBlending ( Landscape::BLENDING_MODE blending ) #

Sets a new blending mode to be used for albedo data of the landscape map.

Arguments

• Landscape::BLENDING_MODE blending - Blending mode to be used for albedo data. One of the following values:
  • Alpha Blend
  • Additive
  • Overlay
  • Multiplicative

Landscape::BLENDING_MODE getAlbedoBlending ( ) const#

Returns the current blending mode used for albedo data of the landscape map.

Return value

Blending mode used for albedo data. One of the following values:

• Alpha Blend
• Additive
• Overlay
• Multiplicative

void setMaskBlending ( int mask, Landscape::BLENDING_MODE blend ) #

Sets a new blending mode to be used for the data of the specified detail mask.

Arguments

• int mask - Detail mask number in the [0; 19] range.
• Landscape::BLENDING_MODE blend - Blending mode used for the data of the specified detail mask. One of the following values:
  • Alpha Blend
  • Additive
  • Overlay
  • Multiplicative

Landscape::BLENDING_MODE getMaskBlending ( int mask ) const#

Returns the current blending mode used for the data of the specified detail mask.

Arguments

• int mask - Detail mask number in the [0; 19] range.

Return value

Blending mode used for the data of the specified detail mask. One of the following values:

• Alpha Blend
• Additive
• Overlay
• Multiplicative

void setEnabledHeight ( bool height ) #

Sets a value indicating if heights data of the landscape layer map is to be used.

Arguments

• bool height - true to enable using heights data of the landscape layer map, false - to disable it.

bool isEnabledHeight ( ) const#

Returns a value indicating if heights data of the landscape layer map is to be used.

Return value

true if heights data of the landscape layer map is to be used; otherwise, false.

void setEnabledAlbedo ( bool albedo ) #

Sets a value indicating if albedo data of the landscape layer map is to be used.

Arguments

• bool albedo - true to enable using albedo data of the landscape layer map, false - to disable it.

bool isEnabledAlbedo ( ) const#

Returns a value indicating if albedo data of the landscape layer map is to be used.

Return value

true if albedo data of the landscape layer map is to be used; otherwise, false.

void setEnabledMask ( int mask, bool enabled ) #

Sets a value indicating if the data of the detail mask with the specified number is to be used.

Arguments

• int mask - Detail mask number in the [0; 19] range.
• bool enabled - true to enable using the data of the specified detail mask, false - to disable it.

bool isEnabledMask ( int mask ) const#

Returns a value indicating if the data of the detail mask with the specified number is to be used.

Arguments

• int mask - Detail mask number in the [0; 19] range.

Return value

true if the data of the detail mask with the specified number is to be used; otherwise, false.

void setEnabledOpacityHeight ( bool height ) #

Sets a value indicating if opacity information for heights data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.

Arguments

• bool height - true to enable using opacity information for heights data of the landscape layer map, false - to disable it.

bool isEnabledOpacityHeight ( ) const#

Returns a value indicating if opacity information for heights data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.

Return value

true if opacity information for heights data of the landscape layer map is to be used; otherwise, false.

void setEnabledOpacityAlbedo ( bool albedo ) #

Sets a value indicating if opacity information for albedo data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.

Arguments

• bool albedo - true to enable using opacity information for albedo data of the landscape layer map, false - to disable it.

bool isEnabledOpacityAlbedo ( ) const#

Returns a value indicating if opacity information for the albedo data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.

Return value

true if opacity information for the albedo data of the landscape layer map is to be used; otherwise, false.

void setEnabledOpacityMask ( int mask, bool enabled ) #

Sets a value indicating if opacity information for the heights data of the detail mask with the specified number is to be used. Opacity information is required to blend data of several landscape layer maps.

Arguments

• int mask - Detail mask number in the [0; 19] range.
• bool enabled - true to enable using opacity information for the data of the specified detail mask, false - to disable it.

bool isEnabledOpacityMask ( int mask ) const#

Returns a value indicating if opacity information for the data of the detail mask with the specified number is to be used. Opacity information is required to blend data of several landscape layer maps.

Arguments

• int mask - Detail mask number in the [0; 19] range.

Return value

true if opacity information for the data of the detail mask with the specified number is to be used; otherwise, false.

Math::ivec2 getTilesSize ( ) const#

Returns the size of the landscape map tiles.

Return value

Two-component vector (X, Y) representing the number of tiles in the landscape layer map along X and Y axes.

Math::ivec2 getResolution ( ) const#

Returns the landscape layer map resolution.

Return value

Two-component vector (X, Y) representing landscape layer map resolution along X and Y axes, in pixels.

UGUID getGUID ( ) const#

Returns a GUID of the .lmap file containing landscape map data.

Return value

GUID of the .lmap file.

bool isLoaded ( ) const#

Returns a value indicating if the landscape map file (.lmap) is loaded.

Return value

true if opacity information for the data of the detail mask with the specified number is to be used; otherwise, false.

bool load ( const UGUID & guid ) #

Loads landscape map settings from a file with the specified GUID.

Arguments

• const UGUID & guid - GUID of the .lmap file containing landscape map data.

Return value

true if landscape map settings were successfully loaded from the file with the specified GUID; otherwise, false.

bool apply ( ) #

Applies all settings stored in the landscape map file (.lmap).

Return value

true if landscape map file settings were successfully applied; otherwise, false.

void setHeightFadeAttenuation ( const Math::vec2 & attenuation ) #

Sets a new fade attenuation to be used for heights data of the landscape map. This parameter defines the distance of the transparency attenuation, starting from the edge of the map.

Arguments

• const Math::vec2 & attenuation - Two-component vector (X, Y) defining the fade attenuation of the height data along X and Y axes.

Math::vec2 getHeightFadeAttenuation ( ) const#

Returns the current fade attenuation for heights data of the landscape map. This parameter defines the distance of the transparency attenuation, starting from the edge of the map.

Return value

Two-component vector (X, Y) defining the fade attenuation of the height data along X and Y axes.

void setAlbedoFadeAttenuation ( const Math::vec2 & attenuation ) #

Sets a new fade attenuation to be used for albedo data of the landscape map. This parameter defines the distance of the transparency attenuation, starting from the edge of the map.

Arguments

• const Math::vec2 & attenuation - Two-component vector (X, Y) defining the fade attenuation of the albedo data along X and Y axes.

Math::vec2 getAlbedoFadeAttenuation ( ) const#

Returns the current fade attenuation for albedo data of the landscape map. This parameter defines the distance of the transparency attenuation, starting from the edge of the map.

Return value

Two-component vector (X, Y) defining the fade attenuation of the albedo data along X and Y axes.

void setMaskFadeAttenuation ( int mask, const Math::vec2 & fade_attenuation ) #

Sets a new fade attenuation to be used for the data of the specified detail mask. This parameter defines the distance of the transparency attenuation, starting from the edge of the map.

Arguments

• int mask - Mask number.
• const Math::vec2 & fade_attenuation - Two-component vector (X, Y) defining the fade attenuation of the detail mask data along X and Y axes.

Math::vec2 getMaskFadeAttenuation ( int mask ) const#

Returns the current fade attenuation for the data of the specified detail mask. This parameter defines the distance of the transparency attenuation, starting from the edge of the map.

Arguments

• int mask - Mask number.

Return value

Two-component vector (X, Y) defining the fade attenuation of the detail mask data along X and Y axes.

Landscape::COMPRESSOR_TYPE getHeightCompressor ( ) const#

Returns the type of compression currently used for height data.

Return value

Type of compression currently used for height data.

Landscape::COMPRESSOR_TYPE getAlbedoCompressor ( ) const#

Returns the type of compression currently used for albedo data.

Return value

Type of compression currently used for albedo data.

Landscape::COMPRESSOR_TYPE getOpacityHeightCompressor ( ) const#

Returns the type of compression currently used for opacity height data.

Return value

Type of compression currently used for opacity height data.

Landscape::COMPRESSOR_TYPE getMaskCompressor ( int mask ) #

Returns the type of compression currently used for the data of the mask with the specified number.

Arguments

• int mask - Mask number.

Return value

Type of compression currently used for the data of the mask with the specified number.

Landscape::COMPRESSOR_TYPE getMaskOpacityCompressor ( int mask ) #

Returns the type of compression currently used for the opacity data of the mask with the specified number.

Arguments

• int mask - Mask number.

Return value

Type of compression currently used for the opacity data of the mask with the specified number.

bool isCompressed ( ) const#

Returns the value indicating if the .lmap file is compressed.

Return value

true if the file is compressed; otherwise, false.

bool isEnabledAlbedoTextureCompression ( ) const#

Returns a value indicating if albedo texture compression is enabled.

Return value

true if albedo texture compression is enabled; otherwise, false.

bool isEnabledOpacityHeightTextureCompression ( ) const#

Returns a value indicating if opacity height texture compression is enabled.

Return value

true if opacity height texture compression is enabled; otherwise, false.

bool isEnabledMaskTextureCompression ( int mask ) #

Returns a value indicating if compression of the mask texture for the mask with the specified number is enabled.

Arguments

• int mask - Mask number.

Return value

true if compression of the mask texture for the mask with the specified number is enabled; otherwise, false.

bool isEnabledMaskOpacityTextureCompression ( int mask ) #

Returns a value indicating if compression of the opacity texture for the mask with the specified number is enabled.

Arguments

• int mask - Mask number.

Return value

true if compression of the opacity texture for the mask with the specified number is enabled; otherwise, false.