Unigine.TerrainGlobalLod Class
Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Engineering / Sim
SDK edition to use it.
You should upgrade to
This class is used to manage a single LOD (level of detail) of the global terrain object.
TerrainGlobalLod Class
Enums
TYPE#
| Name | Description |
|---|---|
| TERRAIN_GLOBAL_LOD = 0 | Albedo, normal or detail mask LOD of the global terrain object. |
| TERRAIN_GLOBAL_LOD_HEIGHT = 1 | Height LOD of the global terrain object. This type of LOD is used for collision and intersection detection. |
| NUM_TERRAIN_GLOBAL_LODS = 2 | Total number of LOD types of the global terrain objectю |
Properties
float ClearDistance#
The clear distance of the lod. starting from this distance the tiles of the lod are removed from memory.
set
Sets the clear distance of the LOD. Starting from this distance the tiles of the LOD are removed from memory.
set value -
Clear distance, in units.
float LoadDistance#
The current load distance for the lod. starting from this distance the tiles of the lod are loaded into memory.
set
Sets the load distance for the LOD. Starting from this distance the tiles of the LOD are loaded into memory.
set value -
Load distance, in units.
float VisibleDistance#
The current visibility distance. starting from this distance the tiles of the lod become visible.
set
Sets the visibility distance. Starting from this distance the tiles of the LOD become visible.
set value -
Visibility distance, in units.
int ViewportMask#
The current bit mask for rendering into the viewport. the lod is rendered, if its mask matches the player's one.
set
Sets the bit mask for rendering into the viewport. The LOD is rendered, if its mask matches the player's one.
set value -
Viewport mask, an integer value each bit of which is a mask.
float TileDensity#
The current density of lod tiles.
set
Sets the density of LOD tiles.
set value -
LOD tile density, in meters per pixel.
string Path#
The path to the folder where the lod is stored.
set
Sets the path to the folder where the LOD is stored.
set value -
Path to the folder where the LOD is stored.
bool IsEnabled#
A value indicating if the lod is enabled.
set
Enables or disables the LOD.
set value -
1 to enable the LOD, 0 to disable it.
string TypeName#
Name of the terrain global LOD type.
TerrainGlobalLod.TYPE Type#
LOD type.
Members
Tileset GetTileset ( ) #
Returns the tileset for the LOD.Return value
LOD tileset.int RenamePath ( string new_path ) #
Sets a new path to the folder where the LOD is stored.Arguments
- string new_path - New path to be set.
Return value
1 if the new path was set successfully; otherwise, 0.void Reload ( ) #
Reloads the LOD.TerrainGlobalLod.TYPE GetType ( ) #
Returns the type of the LOD. This method is used to define whether it is a height LOD used for collision and intersection detection or an ordinary albedo, normal or detail mask LOD.Return value
LOD type, one of the TYPE values.string GetTypeName ( ) #
Returns the name of the terrain global LOD type. This method is used to define whether it is a height LOD used for collision and intersection detection or an ordinary albedo, normal or detail mask LOD.Return value
Name of the terrain global LOD type. One of the following values:- TerrainGlobalLod
- TerrainGlobalLodHeight
Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)