Unigine::LandscapeMapFileCreator Class

LandscapeMapFileCreator Class

Members

LandscapeMapFileCreator ( ) #

void setResolution ( const Math::ivec2 & resolution ) #

Arguments

• const Math::ivec2 & resolution - Two-component vector (X, Y) representing new landscape map resolution along X and Y axes to be set, in pixels.

Math::ivec2 getResolution ( ) #

Return value

void setGrid ( const Math::ivec2 & grid ) #

Arguments

• const Math::ivec2 & grid - Two-component vector (X, Y) representing number of tiles of the landscape map along X and Y axes.

Math::ivec2 getGrid ( ) #

Return value

float getProgress ( ) #

Return value

double getTimeSeconds ( ) #

Return value

void setPath ( const char * path ) #

Arguments

• const char * path - New path to the .lmap file to be generated.

const char * getPath ( ) #

Return value

void setDownscaleFilter ( Landscape::TYPE_FILE_DATA file_data_type, Image::FILTER filter ) #

Arguments

• Landscape::TYPE_FILE_DATA file_data_type - File data type.
• Image::FILTER filter - Filter type to be used for downscaling. See the Unigine::Image Enumerations with FILTER_* prefixes.

Image::FILTER getDownscaleFilter ( Landscape::TYPE_FILE_DATA file_data_type ) const#

Arguments

• Landscape::TYPE_FILE_DATA file_data_type - File data type.

Return value

bool run ( bool is_empty = false, bool is_safe = true ) #

Arguments

• bool is_empty - true to create an empty .lmap file (e.g., when you create a layer map to be manually sculpted from scratch using brushes), false - to get necessary data from the sources and put them to the generated .lmap file.
• bool is_safe - true to make the Engine automatically call filesClose()/fileOpen() methods when performing operations (before modifying an .lmap file the Engine should release files via filesClose(), while after modification fileOpen() should be called), false - to call filesClose()/fileOpen() methods manually.

  The Landscape class has two overloads for the filesClose() method:

  • filesClose() - to be called in case of moving an .lmap file (no data reloading is performed as the file itself was not modified - saves time on reloading data)
  • filesClose(reload_files) - to be called in case of deleting or modifying an .lmap file.
  Notice

  When is_safe = true the Engine shall always call filesClose(reload_files) with complete data reloading.

Return value

void * addCreateCallback ( Unigine::CallbackBase4< Ptr<LandscapeMapFileCreator>, Ptr<LandscapeImages>, int, int > * func ) #

void create_callback(LandscapeMapFileCreatorPtr creator, LandscapeImages images, int x, int, y);

You can set a callback function as follows:

addCreateCallback(MakeCallback(create_callback));

Example: Setting a landscape layer map file creation callback function for a certain class:

// declaring a Landscape Map File creator
LandscapeMapFileCreatorPtr creator;

// callback function implementing certain actions to be performed on creating a landscape layer map file
void CreateFile(LandscapeMapFileCreatorPtr creator, LandscapeImages images, int x, int, y)
{
	// insert your specific landscape layer map file creation handling code here
}

// ...
virtual int AppWorldLogic::init()
{
	// setting the CreateFile() function to handle file creation
	creator->addCreateCallback(MakeCallback(&CreateFile));
}

Arguments

• Unigine::CallbackBase4< Ptr<LandscapeMapFileCreator>, Ptr<LandscapeImages>, int, int > * func - Callback pointer.

Return value

bool removeCreateCallback ( void * id ) #

Arguments

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

Return value

void clearCreateCallback ( ) #

void * addProgressCallback ( Unigine::CallbackBase1< Ptr<LandscapeMapFileCreator> > * func ) #

void progress_callback(LandscapeMapFileCreatorPtr creator);

You can set a callback function as follows:

addProgressCallback(MakeCallback(progress_callback));

Example: Setting a progress callback function for a certain class:

// declaring a Landscape Map File creator
LandscapeMapFileCreatorPtr creator;

// callback function implementing certain actions to be performed on landscape map file creation progress
void FileCreationProgress(LandscapeMapFileCreatorPtr creator)
{
	// insert your specific progress handling code here
}

// ...
virtual int AppWorldLogic::init()
{
	// setting the FileCreationProgress() function to handle landscape map file creation progress
	creator->addProgressCallback(MakeCallback(&FileCreationProgress));
}

Arguments

• Unigine::CallbackBase1< Ptr<LandscapeMapFileCreator> > * func - Callback pointer.

Return value

bool removeProgressCallback ( void * id ) #

Arguments

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

Return value

void clearProgressCallback ( ) #

void * addBeginCallback ( Unigine::CallbackBase1< Ptr<LandscapeMapFileCreator> > * func ) #

void begin_callback(LandscapeMapFileCreatorPtr creator);

You can set a callback function as follows:

addBeginCallback(MakeCallback(begin_callback));

Example: Setting a begin file creation callback function for a certain class:

// declaring a Landscape Map File creator
LandscapeMapFileCreatorPtr creator;

// callback function implementing certain actions to be performed on beginning the landscape map file creation
void FileCreationBegin(LandscapeMapFileCreatorPtr creator)
{
	// insert your specific handling code here
}

// ...
virtual int AppWorldLogic::init()
{
	// setting the FileCreationBegin() function to handle beginning of the landscape map file creation
	creator->addBeginCallback(MakeCallback(&FileCreationBegin));
}

Arguments

• Unigine::CallbackBase1< Ptr<LandscapeMapFileCreator> > * func - Callback pointer.

Return value

bool removeBeginCallback ( void * id ) #

Arguments

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

Return value

void clearBeginCallback ( ) #

void * addEndCallback ( Unigine::CallbackBase1< Ptr<LandscapeMapFileCreator> > * func ) #

void end_callback(LandscapeMapFileCreatorPtr creator);

You can set a callback function as follows:

addEndCallback(MakeCallback(end_callback));

Example: Setting a file creation completion callback function for a certain class:

// declaring a Landscape Map File creator
LandscapeMapFileCreatorPtr creator;

// callback function implementing certain actions to be performed on completion of the landscape map file creation
void FileCreationEnd(LandscapeMapFileCreatorPtr creator)
{
	// insert your specific handling code here
}

// ...
virtual int AppWorldLogic::init()
{
	// setting the FileCreationEnd() function to handle completion of the landscape map file creation
	creator->addEndCallback(MakeCallback(&FileCreationEnd));
}

Arguments

• Unigine::CallbackBase1< Ptr<LandscapeMapFileCreator> > * func - Callback pointer.

Return value

bool removeEndCallback ( void * id ) #

Arguments

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

Return value

void clearEndCallback ( ) #