Unigine.Landscape Class

Landscape Class

Enums

TYPE_DATA#

FLAGS_DATA#

TYPE_FILE_DATA#

FLAGS_FILE_DATA#

Properties

bool IsFilesClosed#

Members

LandscapeTextures GetTemporaryTexture ( ivec2 resolution ) #

Arguments

• ivec2 resolution - Resolution of a temporary texture to be obtained.

Return value

void ReleaseTemporaryTexture ( LandscapeTextures texture ) #

Arguments

• LandscapeTextures texture - Temporary landscape texture to be released.

bool TerrainLoad ( WorldBoundBox bb ) #

Arguments

• WorldBoundBox bb - Bounding box, defining landscape layer maps for which the data is to be loaded.

Return value

bool Render ( LandscapeTextures buffers, mat4 transform, Scalar texel_size ) #

Arguments

• LandscapeTextures buffers - Target texture buffers to which the specified landscape layer maps are to be rendered.
• mat4 transform - Transformation of the landscape terrain area to be rendered (Z-coordinate is ignored).
• Scalar texel_size - Texel size to be used. Defines the size of the area depending on the buffers resolution.

Return value

bool Render ( LandscapeTextures buffers, mat4 transform, Scalar texel_size, int padding ) #

Arguments

• LandscapeTextures buffers - Target texture buffers to which the specified landscape layer maps are to be rendered.
• mat4 transform - Transformation of the landscape terrain area to be rendered (Z-coordinate is ignored).
• Scalar texel_size - Texel size to be used. Defines the size of the area depending on the buffers resolution.
• int padding - Inner padding size for the area to be rendered (if necessary).

Return value

bool Render ( LandscapeLayerMap[] maps, LandscapeTextures buffers, mat4 transform, Scalar texel_size ) #

Arguments

• LandscapeLayerMap[] maps - List of the landscape layer maps to be rendered.
• LandscapeTextures buffers - Target texture buffers to which the specified landscape layer maps are to be rendered.
• mat4 transform - Transformation of the landscape terrain area to be rendered (Z-coordinate is ignored).
• Scalar texel_size - Texel size to be used. Defines the size of the area depending on the buffers resolution.

Return value

bool Render ( LandscapeLayerMap[] maps, LandscapeTextures buffers, mat4 transform, Scalar texel_size, int padding ) #

Arguments

• LandscapeLayerMap[] maps - List of the landscape layer maps to be rendered.
• LandscapeTextures buffers - Target texture buffers to which the specified landscape layer maps are to be rendered.
• mat4 transform - Transformation of the landscape terrain area to be rendered (Z-coordinate is ignored).
• Scalar texel_size - Texel size to be used. Defines the size of the area depending on the buffers resolution.
• int padding - Inner padding size for the area to be rendered.

Return value

void AsyncTextureDraw ( int operation_id, UGUID guid, ivec2 coord, ivec2 resolution, int flags_file_data, WorldBoundBox[] bounds_preload ) #

Arguments

• int operation_id - Draw operation ID.
• UGUID guid - GUIGUID of the landscape layer map file to be modified.
• ivec2 coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• ivec2 resolution - Resolution of the landscape layer map data segment to be modified along the X and Y axes.
• int flags_file_data - Data layer mask. A combination of FLAGS_FILE_DATA_* flags indicating data layers to be affected (heights, albedo, certain masks).
• WorldBoundBox[] bounds_preload - Bounding box (world) specifying the area containing terrain tiles (all landscape layer maps) to be loaded to memory prior to making modifications.

void AsyncTextureDraw ( int operation_id, UGUID guid, ivec2 coord, ivec2 resolution, int flags_file_data ) #

Arguments

• int operation_id - Draw operation ID.
• UGUID guid - GUID of the landscape layer map file to be modified.
• ivec2 coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• ivec2 resolution - Resolution of the landscape layer map data segment to be modified along the X and Y axes.
• int flags_file_data - Data layer mask. A combination of FLAGS_FILE_DATA_* flags indicating data layers to be affected (heights, albedo, certain masks).

void AsyncTextureDraw ( int operation_id, UGUID guid, ivec2 coord, ivec2 resolution ) #

Arguments

• int operation_id - Draw operation ID.
• UGUID guid - GUID of the landscape layer map file to be modified.
• ivec2 coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• ivec2 resolution - Resolution of the landscape layer map data segment to be modified along the X and Y axes.

void AsyncTextureDraw ( UGUID guid, ivec2 coord, ivec2 resolution, int flags_file_data, WorldBoundBox[] bounds_preload ) #

Arguments

• UGUID guid - GUIGUID of the landscape layer map file to be modified.
• ivec2 coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• ivec2 resolution - Resolution of the landscape layer map data segment to be modified along the X and Y axes.
• int flags_file_data - Data layer mask. A combination of FLAGS_FILE_DATA_* flags indicating data layers to be affected (heights, albedo, certain masks).
• WorldBoundBox[] bounds_preload - Bounding box (world) specifying the area containing terrain tiles (all landscape layer maps) to be loaded to memory prior to making modifications.

void AsyncTextureDraw ( UGUID guid, ivec2 coord, ivec2 resolution, int flags_file_data ) #

Arguments

• UGUID guid - GUID of the landscape layer map file to be modified.
• ivec2 coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• ivec2 resolution - Resolution of the landscape layer map data segment to be modified along the X and Y axes.
• int flags_file_data - Data layer mask. A combination of FLAGS_FILE_DATA_* flags indicating data layers to be affected (heights, albedo, certain masks).

void AsyncTextureDraw ( UGUID guid, ivec2 coord, ivec2 resolution ) #

Arguments

• UGUID guid - GUID of the landscape layer map file to be modified.
• ivec2 coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• ivec2 resolution - Resolution of the landscape layer map data segment to be modified along the X and Y axes.

void AsyncApplyDiff ( int operation_id, UGUID guid, string path ) #

Arguments

• int operation_id - Operation ID.
• UGUID guid - GUID of the landscape layer map file to which a state stored at the specified path is to be applied.
• string path - Path to a file where the current landscape map modification state is stored.

void AsyncApplyDiff ( UGUID guid, string path ) #

Arguments

• UGUID guid - GUID of the landscape layer map file to which a state stored at the specified path is to be applied.
• string path - Path to a file where the current landscape map modification state is stored.

void AsyncSaveFile ( int operation_id, UGUID file_guid ) #

Arguments

• int operation_id - Operation ID.
• UGUID file_guid - GUID of the landscape layer map file.

void AsyncSaveFile ( UGUID file_guid ) #

Arguments

• UGUID file_guid - GUID of the landscape layer map file.

void AsyncSaveFile ( int operation_id, UGUID guid, string path_new_state, string path_old_state ) #

Arguments

• int operation_id - Operation ID.
• UGUID guid - GUID of the landscape layer map file.
• string path_new_state - Path to a file to store the new landscape layer map state.
• string path_old_state - Path to a file to store the old landscape layer map state.

void AsyncSaveFile ( UGUID guid, string path_new_state, string path_old_state ) #

Arguments

• UGUID guid - GUID of the landscape layer map file.
• string path_new_state - Path to a file to store the new landscape layer map state.
• string path_old_state - Path to a file to store the old landscape layer map state.

void FilesClose ( UGUID[] reload_files ) #

Arguments

• UGUID[] reload_files - List of GUIDs of .lmap files to be reloaded. This list should contain .lmap files, that were deleted or having their data changed (albedo, heights, masks). If there are no such files, you can simply call the filesClose() method.

void FilesClose ( ) #

void FilesOpen ( ) #

ObjectLandscapeTerrain GetActiveTerrain ( ) #

Return value

IntPtr AddTextureDrawCallback ( TextureDrawDelegate func ) #

void texture_draw_callback(UGUID guid, int id, LandscapeTextures buffer, ivec2 coord, int data_mask);

You can set a callback function as follows:

AddTextureDrawCallback((guid, id, buffer, coord, data_mask) 
						=> texture_draw_callback(guid, id, buffer, coord, data_mask));

Example: Setting a texture draw callback function:

class AppWorldLogic : WorldLogic
{

	/*...*/

	// callback function implementing modification of the buffer
	private void TextureDraw(UGUID guid, int id, LandscapeTextures buffer, ivec2 coord, int data_mask)
	{
		// insert your buffer modification code here (the following lines can be used as an example)
		
		// getting a brush material to be used (e.g., built-in "cirle_soft" Editor's brush)
		Material mat = Materials.findMaterial("circle_soft");
		
		if (mat) {
			// setting necessary textures to be modified by the brush
			mat.setTexture("terrain_albedo", buffer.getAlbedo());
			mat.setTexture("terrain_height", buffer.getHeight());

			// setting up brush material parameters
			mat.setParameterFloat("size", 100.0f);
			mat.setParameterFloat("height", 10.0f);
			mat.setParameterFloat4("color", vec4.RED);
			mat.setParameterInt("data_mask", Landscape.FLAGS_DATA_ALBEDO | Landscape.FLAGS_DATA_HEIGHT);

			// running material's "brush" expression
			mat.runExpression("brush", buffer.getResolution().x, buffer.getResolution().y);
			
			// resetting material textures
			mat.setTexture("terrain_albedo", null);
			mat.setTexture("terrain_height", null);
		}
	}

	/*...*/

	public override bool Init()
	{
		// setting the TextureDraw() function to handle texture drawing
		Landscape.AddTextureDrawCallback((guid, id, buffer, coord, data_mask) 
						=> TextureDraw(guid, id, buffer, coord, data_mask));

		return true;
		}
	/*...*/
}

Arguments

• TextureDrawDelegate func - Callback function with the following signature:
  void TextureDrawDelegate(UGUID guid, int id, LandscapeTextures buffer, ivec2 coord, int data_mask)

Return value

bool RemoveTextureDrawCallback ( IntPtr id ) #

Arguments

• IntPtr id - Texture draw callback ID obtained when adding it.

Return value

void ClearTextureDrawCallback ( ) #

IntPtr AddApplyDiffCallback ( ApplyDiffDelegate func ) #

void apply_diff_callback(UGUID guid, int id, String path);

You can set a callback function as follows:

AddApplyDiffCallback((guid, id, path) 
						=> apply_diff_callback(guid, id, path));

Example: Setting an apply diff callback function:

class AppWorldLogic : WorldLogic
{

	/*...*/

	// callback function implementing certain actions to be performed on applying a diff
	private void ApplyDiff(UGUID guid, int id, String path)
	{
		// insert your specific handling code here
	}

	/*...*/

	public override bool Init()
	{
		// setting the ApplyDiff() function to handle an apply diff event
		Landscape.AddApplyDiffCallback((guid, id, path) 
						=> ApplyDiff(guid, id, path));

		return true;
		}
	/*...*/
}

Arguments

• ApplyDiffDelegate func - Callback function with the following signature:
  void ApplyDiffDelegate(UGUID guid, int id, String path)

Return value

bool RemoveApplyDiffCallback ( IntPtr id ) #

Arguments

• IntPtr id - Apply diff callback ID obtained when adding it.

Return value

void ClearApplyDiffCallback ( ) #

IntPtr AddSaveFileCallback ( SaveFileDelegate func ) #

void save_file_callback(UGUID guid, int id, String path_new_state, String path_old_state);

You can set a callback function as follows:

AddSaveFileCallback((guid, id, path_new_state, path_old_state) 
						=> save_file_callback(guid, id, path_new_state, path_old_state));

Example: Setting a save file callback function:

class AppWorldLogic : WorldLogic
{

	/*...*/

	// callback function
	private void SaveFile(UGUID guid, int id, String path, String path_new_state, String path_old_state)
	{
		// insert your specific handling code here
	}

	/*...*/

	public override bool Init()
	{
		// setting the SaveFile() function to handle file saving
		Landscape.AddSaveFileCallback((guid, id, path_new_state, path_old_state) 
						=> SaveFile(guid, id, path_new_state, path_old_state));

		return true;
		}
	/*...*/
}

Arguments

• SaveFileDelegate func - Callback function with the following signature:
  void SaveFileDelegate(UGUID guid, int id, String path_new_state, String path_old_state)

Return value

bool RemoveSaveFileCallback ( IntPtr id ) #

Arguments

• IntPtr id - Save file callback ID obtained when adding it.

Return value

void ClearSaveFileCallback ( ) #

int GenerateOperationID ( ) #

int id = Landscape::generateOperationID();
// user's code (bounding to ID)
Landscape::asyncTextureDraw(id, file_guid, coord, resolution, flags_file_data);

Return value