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.ObjectLandscapeTerrain Class

Inherits from: Object

This class is used to create and manage Landscape Terrain object and its detail masks.

ObjectLandscapeTerrain Class

Properties

float IntersectionPrecision#

The Precision for intersection detection as a fraction of maximum precision in the [0; 1] range. The default value is 0.5f. Maximum precision is determined by the Engine on the basis of the data of your Landscape Terrain.

int NumDetailMasks#

The total number of detail masks of the landscape terrain.

bool ActiveTerrain#

The A value indicating if the landscape terrain is active.

long LastStreamingFrame#

The number of the frame when the last commit to the Virtual Texture was performed. This method enables you to check if the Landscape Terrain data is loaded completely at the moment (the Virtual Texture is created and the last commit to it is already applied).
Source code (C++)
// AppWorldLogic.cpp
//...

using namespace Unigine;
ObjectLandscapeTerrainPtr terrain;

int AppWorldLogic::init()
{
	terrain = checked_ptr_cast<ObjectLandscapeTerrain>(World::getNodeByName("ObjectLandscapeTerrain"));
	return 1;
}

int AppWorldLogic::update()
{
	if (!terrain.isValid())
		return 1;
	int64_t last_commit_frame = terrain->getLastStreamingFrame();
	if (value == -1)
	{
		Log::message("The Virtual Texture is not created yet\n");
		return 1;
        // not ready
	}
	if ((Game::getFrame() - last_commit_frame) > 45)
	{
		Log::message("Virtual Texture update is completed (all commits are applied)\n");
		// ...
	} else
	{
		Log::message("Virtual Texture update is pending (commit_frame = %d)\n", last_commit_frame);
        // ...
	}
	return 1;
}

Members


ObjectLandscapeTerrain ( ) #

The ObjectLandscapeTerrain constructor.

TerrainDetailMask GetDetailMask ( int num ) #

Returns the detail mask by its index. The number of detail masks is fixed and is equal to 20.

Arguments

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

Return value

Detail mask having the specified index.

TerrainDetailMask GetDetailMaskSortRender ( int num ) #

Returns the detail mask by its rendering order. The number of detail masks is fixed and is equal to 20, masks rendering order is back to front.

Arguments

  • int num - Detail mask rendering order, in the [0; 19] range.

Return value

Detail mask having the specified rendering order.

TerrainDetailMask FindChild ( string name ) #

Returns a child detail's number by its name. The search is performed among the immediate children only.

Arguments

  • string name - Detail mask name.

Return value

Detail mask having the specified name (if it exists); otherwise, nullptr.

void GetDetailMasks ( TerrainDetailMask[] masks ) #

Builds the list of all detail masks of the landscape terrain and puts them to the specified buffer. The number of detail masks is fixed and is equal to 20.

Arguments

void GetDetailMasksSortRender ( TerrainDetailMask[] masks ) #

Builds the list of all detail masks of the landscape terrain according to their rendering order (back to front) and puts them to the specified buffer. The number of detail masks is fixed and is equal to 20.

Arguments

long GetLastStreamingFrame ( ) #

Returns the number of the frame when the last commit to the Virtual Texture was performed. This method enables you to check if the Landscape Terrain data is loaded completely at the moment (the Virtual Texture is created and the last commit to it is already applied).
Source code (C++)
// AppWorldLogic.cpp
//...

using namespace Unigine;
ObjectLandscapeTerrainPtr terrain;

int AppWorldLogic::init()
{
	terrain = checked_ptr_cast<ObjectLandscapeTerrain>(World::getNodeByName("ObjectLandscapeTerrain"));
	return 1;
}

int AppWorldLogic::update()
{
	if (!terrain.isValid())
		return 1;
	int64_t last_commit_frame = terrain->getLastStreamingFrame();
	if (value == -1)
	{
		Log::message("The Virtual Texture is not created yet\n");
		return 1;
        // not ready
	}
	if ((Game::getFrame() - last_commit_frame) > 0)
	{
		Log::message("Virtual Texture update is completed (all commits are applied)\n");
		// ...
	} else
	{
		Log::message("Virtual Texture update is pending (commit_frame = %d)\n", last_commit_frame);
        // ...
	}
	return 1;
}

Return value

Number of the last streaming frame.

static int type ( ) #

Returns the type of the node.

Return value

ObjectLandscapeTerrain type identifier.
Last update: 2022-12-14
Build: ()