API Migration

Breaking Changes#

New HashMap/HashSet#

To improve performance and reduce memory consumption we have made some refactoring and optimization regarding Hash Maps and Hash Sets for this release. They both now store data linearly similar to vectors, which requires some changes in your code is case you have used them.

The findFast() method now returns a pointer instead of a double pointer:

UNIGINE 2.19 UNIGINE 2.19.1

UNIGINE 2.19	UNIGINE 2.19.1
ValueType Hash::findFast(const KeyType &key) const Source code (C++) `Unigine::HashMap<int, int> hash_map; //... auto item = hash_map.findFast(0); if(item) Unigine::Log::message("%d\n", (*item)->data);`	ValueType Hash::findFast(const KeyType &key) const* Source code (C++) `Unigine::HashMap<int, int> hash_map; //... auto item = hash_map.findFast(0); if(item) Unigine::Log::message("%d\n", item->data);`

ValueType **Hash::findFast(const KeyType &key) const

Source code (C++)

Unigine::HashMap<int, int> hash_map;
//...
auto item = hash_map.findFast(0);
if(item)
   Unigine::Log::message("%d\n", (*item)->data);

ValueType *Hash::findFast(const KeyType &key) const

Source code (C++)

Unigine::HashMap<int, int> hash_map;
//...
auto item = hash_map.findFast(0);
if(item)
   Unigine::Log::message("%d\n", item->data);

The emplace() method now returns an Iterator instead of a value:

UNIGINE 2.19	UNIGINE 2.19.1
ValueType &Hash::emplace(const KeyType &key) Source code (C++) `Unigine::HashMap<int, int> hash_map; Unigine::Log::message("%d\n", hash_map.emplace(0));`	Iterator Hash::emplace(const KeyType &key) Source code (C++) `Unigine::HashMap<int, int> hash_map; Unigine::Log::message("%d\n", hash_map.emplace(0)->data);`

HashMap vs BucketHashMap#

We've also kept the previous hash map implementation for backward compatibility and some specific cases, it is called BucketHashMap. Here is one of such examples, where the BucketHashMap must be used instead of the new HashMap - pointers to a key/value:

UNIGINE 2.19.1 - HashMap UNIGINE 2.19.1 - BucketHashMap

UNIGINE 2.19.1 - HashMap	UNIGINE 2.19.1 - BucketHashMap
Source code (C++) `int *find(const HashMap<int, int> &hash_map, int key) { const auto &it = hash_map.find(key); if(it == hash_map.end()) return nullptr; return &it->data; //<-potentials crashes, use BucketHashMap }`	Source code (C++) `int *find(const BucketHashMap<int, int> &hash_map, int key) { const auto &it = hash_map.find(key); if(it == hash_map.end()) return nullptr; return &it->data; //<-everything is ok! }`

Source code (C++)

int *find(const HashMap<int, int> &hash_map, int key) {
	const auto &it = hash_map.find(key);
	if(it == hash_map.end()) return nullptr;
	return &it->data; //<-potentials crashes, use BucketHashMap
}

Source code (C++)

int *find(const BucketHashMap<int, int> &hash_map, int key) {
	const auto &it = hash_map.find(key);
	if(it == hash_map.end()) return nullptr;
	return &it->data; //<-everything is ok!
}

AnimationPlayback Class#

UNIGINE 2.19	UNIGINE 2.19.1
Property Time	Removed. Use the GetTime( ) method instead.

New Functions

New Properties

BootConfig Class#

New Properties

CustomSystemProxy Class#

New methods should be implemented in case you inherit from the CustomSystemProxy Class.

New Functions

Decal Class#

New Properties

CastBakedGlobalIllumination

Engine Class#

New Properties

EngineWindowGroup Class#

New Properties

CurrentTab

Input Class#

UNIGINE 2.19	UNIGINE 2.19.1
Property EventJoyPovMotion	The signature has changed: Event<int, Input.JOYSTICK_POV> → Event<int, int>

New Functions

InputJoystick Class#

New Functions

LightEnvironmentProbe Class#

New Properties

LightOmni Class#

New Properties

LightProj Class#

UNIGINE 2.19	UNIGINE 2.19.1
Property ZNear	Removed.

New Properties

Log Class#

New Properties

DialogFatalEnabled

Material Class#

UNIGINE 2.19	UNIGINE 2.19.1
CheckShaderCache( )	Removed. Use ShaderCacheExist( Render.PASS, Node.TYPE ) instead.
CheckShaderCache( Render.PASS, Node.TYPE )	Removed. Use NeedCreateShaderCache( Render.PASS, Node.TYPE ) instead.
CompileShader( Render.PASS, Node.TYPE )	Removed. Use CreateShaderAsync( Render.PASS, Node.TYPE ) or CreateShaderForce( Render.PASS, Node.TYPE ) instead.
CompileShaders( bool )	Removed. Use CreateShaderCache( bool ) instead.

New Functions

Materials Class#

UNIGINE 2.19	UNIGINE 2.19.1
CompileShaders( )	Removed. Use CreateShaderCache( bool ) instead.

New Functions

New Properties

IsShadersCompiling

ObjectParticles Class#

UNIGINE 2.19	UNIGINE 2.19.1
Property LinearDamping	Removed. Use LinearDampingOverTimeModifier( ) instead.

New Properties

LinearDampingOverTimeModifier

Profiler Class#

New Functions

New Properties

NumCounters

Render Class#

UNIGINE 2.19	UNIGINE 2.19.1
Property QuadroSync	Removed.
GetTemporaryTexture( Texture )	Removed. Use GetTemporaryTexture( Texture, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool ) instead.
GetTemporaryTexture( Texture, string )	Removed. Use GetTemporaryTexture( Texture, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool ) instead.
GetTemporaryTexture( Texture, string, int )	Removed. Use GetTemporaryTexture( Texture, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool ) instead.
GetTemporaryTexture( int, int, int, int, int, int, string )	Removed. Use GetTemporaryTexture( int, int, int, int, int, int, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool ) instead.
GetTemporaryTexture( int, int, int, int, int, int )	Removed. Use GetTemporaryTexture( int, int, int, int, int, int, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool ) instead.
GetTemporaryTexture( int, int, int, int, int, int, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool )	Set of arguments changed.
GetTemporaryTexture2D( int, int, int, int, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool )	Set of arguments changed.
GetTemporaryTexture2DArray( int, int, int, int, int, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool )	Set of arguments changed.
GetTemporaryTexture3D( int, int, int, int, int, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool )	Set of arguments changed.
GetTemporaryTextureCube( int, int, int, int, string, Render.TEXTURE_ACCESSORY, Render.TEXTURE_LIFETIME, bool )	Set of arguments changed.
GetTemporaryOldTexture( Material, int, int, int, int, int, int, int, string )	Removed. Use GetTemporaryOldTexture( Material, int, Texture, string, Render.TEXTURE_ACCESSORY ) instead.
GetTemporaryOldTexture( Material, int, int, int, int, int, int, int )	Removed. Use GetTemporaryOldTexture( Material, int, Texture, string, Render.TEXTURE_ACCESSORY ) instead.
GetTemporaryOldTexture( Material, int, Texture, string )	Removed. Use GetTemporaryOldTexture( Material, int, Texture, string, Render.TEXTURE_ACCESSORY ) instead.
GetTemporaryOldTexture( Material, int, Texture )	Removed. Use GetTemporaryOldTexture( Material, int, Texture, string, Render.TEXTURE_ACCESSORY ) instead.

New Properties

FSRAutoReactiveEnabled

New Functions

WallGroupData Class#

New Properties

AutoArrange

World Class#

UNIGINE 2.19	UNIGINE 2.19.1
ClearNode( string )	Removed. Use ReloadNodeFile( string ) instead.

New Functions

Manager Class (IG)#

New Functions

Entity Class (IG)#

New Properties

AutoTypeMatchEnabled

Last update: 2024-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

API Migration

In This Article:

Breaking Changes#

New HashMap/HashSet#

HashMap vs BucketHashMap#

AnimationPlayback Class#

New Functions

New Properties

BootConfig Class#

New Properties

CustomSystemProxy Class#

New Functions

Decal Class#

New Properties

Engine Class#

New Properties

EngineWindowGroup Class#

New Properties

Input Class#

New Functions

InputJoystick Class#

New Functions

LightEnvironmentProbe Class#

New Properties

LightOmni Class#

New Properties

LightProj Class#

New Properties

Log Class#

New Properties

Material Class#

New Functions

Materials Class#

New Functions

New Properties

ObjectParticles Class#

New Properties

Profiler Class#

New Functions

New Properties

Render Class#

New Properties

New Functions

WallGroupData Class#

New Properties

World Class#

New Functions

Manager Class (IG)#

New Functions

Entity Class (IG)#

New Properties