This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.TerrainDetailMask Class

This class is used to manage detail masks of the Landscape Terrain Object. Each detail mask can have an unlimited number of details, defining its appearance. Detail masks are rendered in accordance with their rendering order (the one with the highest order shall be rendered above all others).

TerrainDetailMask Class

Properties

string Name#

The Current name of the detail mask.

bool Enabled#

The true if the terrain detail mask is enabled; otherwise, false.

int RenderOrder#

The Rendering order of the detail mask in the [0; 19] range.

int NumDetails#

The Number of details of this detail mask.

int Index#

The Index of the detail mask in the [0; 19] range.

float Dithering#

The current dither amount for the detail mask of the landscape terrain. Dithering enables reduction of graphical artefacts in case of increased Mask Contrast values set for details. This value is multiplied by the global dither amount.

vec4 MaskByAlbedo#

The Albedo color currently used as a mask, as a four-component vector (R,G,B,A).

float DefaultValue#

The Value currently used for the mask as default.

Members


void SwapRenderOrder ( TerrainDetailMask mask ) #

Swap rendering order of this detail mask with the specified one.

Arguments

  • TerrainDetailMask mask - Target detail mask.

TerrainDetail AddDetail ( ) #

Adds a new detail for this mask.

Return value

New detail added for this mask.

TerrainDetail GetDetail ( int num ) #

Returns a detail by its index.

Arguments

  • int num - Detail index.

Return value

Detail with the specified index (if it exists); otherwise, an assertion failure error is reported.

int IsDetail ( TerrainDetail detail ) #

Checks if the specified detail belongs to this detail mask.

Arguments

Return value

1 if the specified terrain detail belongs to this mask; otherwise, 0.

int FindDetailIndex ( string name ) #

Returns a detail index by its name.

Arguments

  • string name - Detail name.

Return value

Index of the detail having the specified name (if it exists); otherwise, -1.

TerrainDetail FindDetail ( string name ) #

Returns a detail attached to the detail mask by its name.

Arguments

  • string name - Detail name.

Return value

Detail with the specified name (if it exists); otherwise, NULL.

void SetDetailIndex ( TerrainDetail detail, int index ) #

Replaces a detail with a given index with the specified detail.

Arguments

  • TerrainDetail detail - Detail to be set instead of the one with the given index.
  • int index - Index of the detail to be replaced with the specified one.

int GetDetailIndex ( TerrainDetail detail ) #

Returns the index of the specified detail.

Arguments

Return value

Index of the specified detail (if it exists); otherwise, -1.

void SwapDetail ( int num_0, int num_1 ) #

Swaps the two details with given indices.

Arguments

  • int num_0 - First detail index.
  • int num_1 - Second detail index.
Last update: 2022-12-14
Build: ()