Unigine::Landscape Class

Landscape Class

Enums

TYPE_DATA#

FLAGS_DATA#

TYPE_FILE_DATA#

FLAGS_FILE_DATA#

Members

Ptr<LandscapeTextures> getTemporaryTexture ( const Math::ivec2 & resolution ) #

Arguments

• const Math::ivec2 & resolution - Resolution of a temporary texture to be obtained.

Return value

void releaseTemporaryTexture ( const Ptr<LandscapeTextures> & texture ) #

Arguments

• const Ptr<LandscapeTextures> & texture - Temporary landscape texture to be released.

bool terrainLoad ( const UNIGINE_BOUND_BOX & bb ) #

Arguments

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

Return value

bool render ( const Ptr<LandscapeTextures> & buffers, const Math::Mat4 & transform, Math::Scalar texel_size ) #

Arguments

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

Return value

bool render ( const Ptr<LandscapeTextures> & buffers, const Math::Mat4 & transform, Math::Scalar texel_size, int padding ) #

Arguments

• const Ptr<LandscapeTextures> & buffers - Target texture buffers to which the specified landscape layer maps are to be rendered.
• const Math::Mat4 & transform - Transformation of the landscape terrain area to be rendered (Z-coordinate is ignored).
• Math::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 ( const Vector< Ptr<LandscapeLayerMap> > & maps, const Ptr<LandscapeTextures> & buffers, const Math::Mat4 & transform, Math::Scalar texel_size ) #

Arguments

• const Vector< Ptr<LandscapeLayerMap> > & maps - List of the landscape layer maps to be rendered.
• const Ptr<LandscapeTextures> & buffers - Target texture buffers to which the specified landscape layer maps are to be rendered.
• const Math::Mat4 & transform - Transformation of the landscape terrain area to be rendered (Z-coordinate is ignored).
• Math::Scalar texel_size - Texel size to be used. Defines the size of the area depending on the buffers resolution.

Return value

bool render ( const Vector< Ptr<LandscapeLayerMap> > & maps, const Ptr<LandscapeTextures> & buffers, const Math::Mat4 & transform, Math::Scalar texel_size, int padding ) #

Arguments

• const Vector< Ptr<LandscapeLayerMap> > & maps - List of the landscape layer maps to be rendered.
• const Ptr<LandscapeTextures> & buffers - Target texture buffers to which the specified landscape layer maps are to be rendered.
• const Math::Mat4 & transform - Transformation of the landscape terrain area to be rendered (Z-coordinate is ignored).
• Math::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

int asyncTextureDraw ( const UGUID & guid, const Math::ivec2 & coord, const Math::ivec2 & resolution, int flags_file_data, const Vector< UNIGINE_BOUND_BOX > & bounds_preload ) #

Arguments

• const UGUID & guid - GUIGUID of the landscape layer map file to be modified.
• const Math::ivec2 & coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• const Math::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).
• const Vector< UNIGINE_BOUND_BOX > & bounds_preload - Bounding box (world) specifying the area containing terrain tiles (all landscape layer maps) to be loaded to memory prior to making modifications.

Return value

int asyncTextureDraw ( const UGUID & guid, const Math::ivec2 & coord, const Math::ivec2 & resolution, int flags_file_data ) #

Arguments

• const UGUID & guid - GUID of the landscape layer map file to be modified.
• const Math::ivec2 & coord - Coordinates of the upper left corner of the landscape layer map data segment to be modified along the X and Y axes.
• const Math::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).

Return value

int asyncTextureDraw ( const UGUID & guid, const Math::ivec2 & coord, const Math::ivec2 & resolution ) #

Arguments

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

Return value

int asyncImageDraw ( const UGUID & guid, const Math::ivec2 & coord, const Math::ivec2 & resolution, int flags_file_data ) #

Arguments

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

Return value

int asyncImageDraw ( const UGUID & guid, const Math::ivec2 & coord, const Math::ivec2 & resolution ) #

Arguments

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

Return value

int asyncApplyDiff ( const UGUID & guid, const char * path ) #

Arguments

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

Return value

int asyncSaveFile ( const UGUID & file_guid ) #

Arguments

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

Return value

int asyncSaveFile ( const UGUID & guid, const char * path_new_state, const char * path_old_state ) #

UGUID lmap_file_guid;	// .lmap file GUID
String cache_path;		// path to some cache directory

String new_filepath;	// path to store a new state
String old_filepath;	// path to store an old state

// method implementing the "apply" operation
void apply() override
{
	// generating necessary paths to save states (generate_filepath - some abstract method)
	new_filepath = generate_filepath(cache_path);
	old_filepath_ = generate_filepath(cache_path);

	// applying changes and saving current and previous states
	Landscape::asyncSaveFile(lmap_file_guid, new_filepath, old_filepath);
}

// method implementing the "undo" operation by applying the previous saved state
void undo() override
{
	if (!old_filepath.empty())
		Landscape::asyncApplyDiff(lmap_file_guid, old_filepath);
}

// method implementing the "redo" operation by applying the new saved state
void redo() override
{
	if (!new_filepath.empty())
		Landscape::asyncApplyDiff(lmap_file_guid, new_filepath);
}

Arguments

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

Return value

bool isFilesClosed ( ) #

Return value

void filesClose ( const Vector< UGUID > & reload_files ) #

Arguments

• const Vector< 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 ( ) #

Ptr<ObjectLandscapeTerrain> getActiveTerrain ( ) #

Return value

void * addTextureDrawCallback ( Unigine::CallbackBase5< UGUID, int, Ptr<LandscapeTextures>, Math::ivec2, int > * func ) #

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

You can set a callback function as follows:

addTextureDrawCallback(MakeCallback(texture_draw_callback));

Example: Setting a texture draw callback function for a certain class:

// callback function implementing modification of the buffer
void SomeClass::textureDraw(UGUID guid, int id, LandscapeTexturesPtr 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)
	MaterialPtr 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", nullptr);
		mat->setTexture("terrain_height", nullptr);
	}
}

// ...
virtual int AppWorldLogic::init()
{
	// setting the textureDraw() function to handle texture drawing
	Landscape::addTextureDrawCallback(MakeCallback(SomeClass::textureDraw));
}

Arguments

• Unigine::CallbackBase5< UGUID, int, Ptr<LandscapeTextures>, Math::ivec2, int > * func - Callback pointer.

Return value

bool removeTextureDrawCallback ( void * id ) #

Arguments

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

Return value

void clearTextureDrawCallback ( ) #

void * addImageDrawCallback ( Unigine::CallbackBase5< UGUID, int, Ptr<LandscapeImages>, Math::ivec2, int > * func ) #

void image_draw_callback(UGUID guid, int id, LandscapeImagesPtr buffer, ivec2 coord, int data_mask);

You can set a callback function as follows:

addImageDrawCallback(MakeCallback(image_draw_callback));

Example: Setting an image draw callback function for a certain class:

// callback function implementing modification of the buffer
void SomeClass::imageDraw(UGUID guid, int id, LandscapeImagesPtr buffer, ivec2 coord, int data_mask)
{
	// insert your buffer modification code here (the following lines can be used as an example)
	
	// setting all pixels of the albedo layer of the image buffer to white
	buffer->getAlbedo()->set(0, 255);	// R-channel
	buffer->getAlbedo()->set(1, 255);	// G-channel
	buffer->getAlbedo()->set(2, 255);	// B-channel
}

// ...
virtual int AppWorldLogic::init()
{
	// setting the imageDraw() function to handle image drawing
	Landscape::addImageDrawCallback(MakeCallback(SomeClass::imageDraw));
}

Arguments

• Unigine::CallbackBase5< UGUID, int, Ptr<LandscapeImages>, Math::ivec2, int > * func - Callback pointer.

Return value

bool removeImageDrawCallback ( void * id ) #

Arguments

• void * id - Image draw callback ID obtained when adding it.

Return value

void clearImageDrawCallback ( ) #

void * addApplyDiffCallback ( Unigine::CallbackBase3< UGUID, int, const char* > * func ) #

void apply_diff_callback(UGUID guid, int id, const char*);

You can set a callback function as follows:

addApplyDiffCallback(MakeCallback(apply_diff_callback));

Example: Setting an apply diff callback function for a certain class:

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

// ...
virtual int AppWorldLogic::init()
{
	// setting the applyDiff() function to handle an apply diff event
	Landscape::addApplyDiffCallback(MakeCallback(&applyDiff));
}

Arguments

• Unigine::CallbackBase3< UGUID, int, const char* > * func - Callback pointer.

Return value

bool removeApplyDiffCallback ( void * id ) #

Arguments

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

Return value

void clearApplyDiffCallback ( ) #

void * addSaveFileCallback ( Unigine::CallbackBase4< UGUID, int, const char*, const char* > * func ) #

void save_file_callback(UGUID guid, int id, const char*, const char*);

You can set a callback function as follows:

addFileSaveCallback(MakeCallback(save_file_callback));

Example: Setting an apply diff callback function for a certain class:

// callback function implementing certain actions to be performed on applying a certain state
void saveFile(UGUID guid, int id, const char* path_new_state, const char* path_old_state)
{
	// insert your specific handling code here
}

// ...
virtual int AppWorldLogic::init()
{
	// setting the saveFile() function to handle file saving
	Landscape::addSaveFileCallback(MakeCallback(&saveFile));
}

Arguments

• Unigine::CallbackBase4< UGUID, int, const char*, const char* > * func - Callback pointer.

Return value

bool removeSaveFileCallback ( void * id ) #

Arguments

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

Return value

void clearSaveFileCallback ( ) #