Unigine::ObjectTerrainGlobal 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
| Header: | #include <UnigineObjects.h> |
| Inherits from: | Object |
This class is used to create a global terrain object representing a certain fragment of Earth's surface on the basis of available GIS data (elevation and imagery). The global terrain is rendered using pre-generated tilesets which represent LODs for different data layers (heights, albedo, normals, and masks). Tilesets are managed via the TileSet class. Tileset data is stored in tileset files on the disk, these files are managed via the TileSetFile class
See Also#
- A TerrainGlobalDetail class to manage global terrain via C++, C# or UnigineScript API.
- A TerrainGlobalLod class to manage a global terrain LOD via C++, C# or UnigineScript API.
- A TerrainGlobalLodHeight class to manage a global terrain height LOD via C++, C# or UnigineScript API.
- A TerrainGlobalLods class to manage a group of global terrain LODs via C++, C# or UnigineScript API.
- A Tileset class to manage tileset data of of the ObjectTerrainGlobal via C++, C# or UnigineScript API.
- A TilesetFile class to manage tileset files of the ObjectTerrainGlobal via C++, C# or UnigineScript API.
- A UnigineScript API sample <UnigineSDK>/data/samples/objects/terrain_global_00
ObjectTerrainGlobal Class
Members
static ObjectTerrainGlobalPtr create ( ) #
Constructor. Creates a new empty global terrain object with default properties.void clear ( ) #
Clears all terrain data (lods, textures, details, masks etc.).static int type ( ) #
Returns the type of the object.Return value
ObjectTerrainGlobal type identifier.Ptr<TerrainGlobalLods> getAlbedoLods ( ) #
Returns the group of terrain albedo LODs.Return value
Terrain albedo LODs group.Ptr<Texture> getAlbedoTextureArray ( ) const#
Returns the albedo textures array.Return value
Albedo textures array.void setAlbedoTextureArrayName ( const char * name ) #
Sets the name of the albedo textures array.Arguments
- const char * name - Name of the albedo textures array.
const char * getAlbedoTextureArrayName ( ) const#
Returns the name of the albedo textures array.Return value
Name of the albedo textures array.int addDetail ( const char * name ) #
Adds a new detail to the vector of terrain details.Arguments
- const char * name - Detail name.
Return value
Number of the new detail.int cloneDetail ( int num ) #
Clones the detail with the specified number.Arguments
- int num - Detail number.
Return value
Number of the new cloned terrain detail.Ptr<TerrainGlobalDetail> getDetail ( int num ) #
Returns the terrain detail with the specified number.Arguments
- int num - Detail number.
Return value
Terrain detail.void removeDetail ( int num ) #
Removes the detail with the specified number.Arguments
- int num - Detail number.
void swapDetail ( int num_0, int num_1 ) #
Swaps two details of the terrain.Arguments
- int num_0 - Number of the first detail.
- int num_1 - Number of the second detail.
void resizeDetails ( int size ) #
Resizes the vector of terrain details.Arguments
- int size - New size.
int getNumDetails ( ) const#
Returns the total number of details.Return value
Number of details.void setForceIntersection ( bool intersection ) #
Enables or disables forced loading of necessary terrain tiles to ensure correct intersection detection.
Notice
- When enabled, this option may significantly reduce performance. Thus, it is recommended to enable it, perform intersection check, and disable it again.
- It is recommended to make two or more intersection requests to make sure you get the required result when necessary, as in some rare cases forced loading of tiles may not give you a 100% guarantee.
Arguments
- bool intersection - true to load necessary terrain tiles for intersection detection; otherwise, false. The default value is false.
bool isForceIntersection ( ) const#
Returns a value indicating if forced loading of terrain tiles for intersection detection is enabled.Notice
This option is used to enable force loading of terrain tiles to ensure correct intersection detection.
Return value
false if forced loading of terrain tiles for intersection detection is enabled; otherwise, false.int addMask ( const char * name ) #
Adds a new mask to the vector of masks.Arguments
- const char * name - Mask name.
Return value
Number of the new mask, if the mask was added successfully; otherwise, -1.int cloneMask ( int num ) #
Clones the mask with the specified number.Arguments
- int num - Mask number.
Return value
Number of the new cloned mask.void removeMask ( int num ) #
Removes the mask with the specified number from the vector of masks.Arguments
- int num - Mask number.
void swapMask ( int num_0, int num_1 ) #
Swaps two masks.Arguments
- int num_0 - Number of the first mask.
- int num_1 - Number of the second mask.
void replaceMasks ( const Vector< String > & names ) #
Replaces the list of masks with a given one.Notice
If a mask used by some detail is missing in the new list, such detail will be considered as having no mask assigned, otherwise it will keep its mask.
Arguments
void resizeMasks ( int size ) #
Resizes the vector of masks.Arguments
- int size - New size.
int getNumMasks ( ) const#
Returns the total number of masks.Return value
Number of masks.Ptr<TerrainGlobalLods> getMaskLods ( ) #
Returns the group of terrain mask LODs.Return value
Terrain mask LODs group.void setMaskName ( int num, const char * name ) #
Sets the name of the mask with the specified number.Arguments
- int num - Mask number.
- const char * name - New mask name.
const char * getMaskName ( int num ) const#
Returns the name for of mask with the specified number.Arguments
- int num - Mask number.
Return value
Mask name.Ptr<TerrainGlobalLods> getHeightLods ( ) #
Returns the group of terrain height LODs.Return value
Terrain height LODs group.Ptr<Texture> getHeightTextureArray ( ) const#
Returns the height textures array.Return value
Height textures array.void setHeightTextureArrayName ( const char * name ) #
Sets the name of the height textures array.Arguments
- const char * name - Name of the height textures array.
const char * getHeightTextureArrayName ( ) const#
Returns the name of the height textures array.Return value
Name of the height textures array.Ptr<TerrainGlobalLods> getNormalLods ( ) #
Returns the group of terrain normal LODs.Return value
Terrain normal LODs group.Ptr<Texture> getNormalTextureArray ( ) const#
Returns the normal textures array.Return value
Normal textures array.void setNormalTextureArrayName ( const char * name ) #
Sets the name of the normal textures array.Arguments
- const char * name - Name of the normal textures array.
const char * getNormalTextureArrayName ( ) const#
Returns the name of the normal textures array.Return value
Name of the normal textures array.int fetchTopologyData ( double x, double y, Math::Vec3 & ret_point, Math::vec3 & ret_normal, Math::vec3 & ret_up, int force = 0 ) #
Returns topology data for a given terrain point.Arguments
- double x - X coordinate of the point.
- double y - Y coordinate of the point.
- Math::Vec3 & ret_point - World coordinates of the point.
- Math::vec3 & ret_normal - Normal coordinates.
- Math::vec3 & ret_up - "Up" vector coordinates.
- int force - Force flag. Use 1 to load files in any case; otherwise, 0. The default value is 0.
Return value
1 if the topology data was fetched successfully; otherwise, 0.Last update:
2022-04-06
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)