UPBGE: Refactor scene converter.

Previously the converter was using to store the data of the scenes and the links
to them during a scene conversion. These two goals could be split into two classes
to avoid update the links and clear the code by avoiding access data that are dangling.

Also in case of two lib loading in asynchronous the links are written and read by
two conversion task at the same time, which involved unstable behavior.

To avoid the issues described before the scene converter is distinguished of the
scene data store. The converter keep is name as KX_BlenderSceneConverter but its goal
is restricted.

The scene converter is temporary for the scene conversion, it is passed as reference
to ensure to not store a pointer to it. It contains the map between the blender data
and the game engine data like: objects, meshes, material, actuators and controllers.
To access and register these data the functions follow the patterns:
RegisterGEDataType(BlenderType, GEDataType)
FindGEDataType(BlenderType)

The scene converter also store a list of the game engine data types registered during
the scene conversion. These are poly material and mesh objects.

Once the conversion is over, the scene converter is deleted but the list of materials
and meshes in it are copied into the KX_BlenderConverter.

This new class has the goal of launching the scene conversion and storing data slots
per scenes. These slots contains approximately the same data than the list stored in
the scene converter excepted for the action interpolators which are converted dynamically
after the scene conversion.

These scene slots own the materials and meshes in they. A scene slot can be created
using a scene converter or merged with an other scene slot in case of scene lib loading
conversion.

Other than that the new KX_BlenderConverter is keeping the functions in the previous
KX_BlenderSceneConverter without the one used for data linking.

Note: MSVC doesn't support using a type without destructor in a std::map even if the
destructor are all defined in .cpp, to solve this issue we need to add extra includes.

Author: panzergame

source/gameengine/Converter/BL_ArmatureObject.cpp

@@ -247,7 +247,7 @@ BL_ArmatureObject::~BL_ArmatureObject()
 	}
 }
 
-void BL_ArmatureObject::LoadConstraints(KX_BlenderSceneConverter *converter)
+void BL_ArmatureObject::LoadConstraints(KX_BlenderSceneConverter& converter)
 {
 	// first delete any existing constraint (should not have any)
 	m_controlledConstraints->ReleaseAndRemoveAll();
@@ -288,14 +288,14 @@ void BL_ArmatureObject::LoadConstraints(KX_BlenderSceneConverter *converter)
 							bConstraintTarget *target = (bConstraintTarget *)listb.first;
 							if (target->tar && target->tar != m_objArma) {
 								// only remember external objects, self target is handled automatically
-								gametarget = converter->FindGameObject(target->tar);
+								gametarget = converter.FindGameObject(target->tar);
 							}
 							if (target->next != nullptr) {
 								// secondary target
 								target = target->next;
 								if (target->tar && target->tar != m_objArma) {
 									// only track external object
-									gamesubtarget = converter->FindGameObject(target->tar);
+									gamesubtarget = converter.FindGameObject(target->tar);
 								}
 							}
 						}

source/gameengine/Converter/BL_ArmatureObject.h

@@ -111,7 +111,7 @@ class BL_ArmatureObject : public KX_GameObject
 	void DrawDebug(RAS_DebugDraw& debugDraw);
 
 	// for constraint python API
-	void LoadConstraints(KX_BlenderSceneConverter *converter);
+	void LoadConstraints(KX_BlenderSceneConverter& converter);
 	size_t GetConstraintNumber() const;
 	BL_ArmatureConstraint *GetConstraint(const std::string& posechannel, const std::string& constraint);
 	BL_ArmatureConstraint *GetConstraint(const std::string& posechannelconstraint);

source/gameengine/Converter/BL_BlenderDataConversion.cpp

@@ -450,9 +450,9 @@ static KX_BlenderMaterial *ConvertMaterial(
 static RAS_MaterialBucket *material_from_mesh(
 	Material *ma, MFace *mface, MTFace *tface, const RAS_MeshObject::LayerList& layers, int lightlayer,
 	unsigned int rgb[4][RAS_ITexVert::MAX_UNIT], MT_Vector2 uvs[4][RAS_ITexVert::MAX_UNIT],
-	KX_Scene* scene, KX_BlenderSceneConverter *converter)
+	KX_Scene* scene, KX_BlenderSceneConverter& converter)
 {
-	RAS_IPolyMaterial* polymat = converter->FindCachedPolyMaterial(scene, ma);
+	RAS_IPolyMaterial* polymat = converter.FindPolyMaterial(ma);
 
 	if (mface) {
 		GetRGB(mface, layers, rgb);
@@ -462,31 +462,27 @@ static RAS_MaterialBucket *material_from_mesh(
 
 	if (!polymat) {
 		polymat = ConvertMaterial(ma, tface, lightlayer, scene);
-		converter->CachePolyMaterial(scene, ma, polymat);
+		// this is needed to free up memory afterwards.
+		converter.RegisterPolyMaterial(polymat, ma);
 	}
-	
+
 	// see if a bucket was reused or a new one was created
 	// this way only one KX_BlenderMaterial object has to exist per bucket
 	bool bucketCreated; 
 	RAS_MaterialBucket* bucket = scene->FindBucket(polymat, bucketCreated);
 
-	// this is needed to free up memory afterwards.
-	// the converter will also prevent duplicates from being registered,
-	// so just register everything.
-	converter->RegisterPolyMaterial(scene, polymat);
-
 	return bucket;
 }
 
 /* blenderobj can be nullptr, make sure its checked for */
-RAS_MeshObject* BL_ConvertMesh(Mesh* mesh, Object* blenderobj, KX_Scene* scene, KX_BlenderSceneConverter *converter, bool libloading)
+RAS_MeshObject* BL_ConvertMesh(Mesh* mesh, Object* blenderobj, KX_Scene* scene, KX_BlenderSceneConverter& converter, bool libloading)
 {
 	RAS_MeshObject *meshobj;
 	int lightlayer = blenderobj ? blenderobj->lay:(1<<20)-1; // all layers if no object.
 
 	// Without checking names, we get some reuse we don't want that can cause
 	// problems with material LoDs.
-	if (blenderobj && ((meshobj = converter->FindGameMesh(mesh/*, ob->lay*/)) != nullptr)) {
+	if (blenderobj && ((meshobj = converter.FindGameMesh(mesh/*, ob->lay*/)) != nullptr)) {
 		const std::string bge_name = meshobj->GetName();
 		const std::string blender_name = ((ID *)blenderobj->data)->name + 2;
 		if (bge_name == blender_name) {
@@ -744,7 +740,7 @@ RAS_MeshObject* BL_ConvertMesh(Mesh* mesh, Object* blenderobj, KX_Scene* scene,
 
 	dm->release(dm);
 
-	converter->RegisterGameMesh(scene, meshobj, mesh);
+	converter.RegisterGameMesh(meshobj, mesh);
 	return meshobj;
 }
 
@@ -839,7 +835,7 @@ static void BL_CreatePhysicsObjectNew(KX_GameObject* gameobj,
                                       RAS_MeshObject* meshobj,
                                       KX_Scene* kxscene,
                                       int activeLayerBitInfo,
-                                      KX_BlenderSceneConverter *converter,
+                                      KX_BlenderSceneConverter& converter,
                                       bool processCompoundChildren
                                       )
 
@@ -889,7 +885,7 @@ static void BL_CreatePhysicsObjectNew(KX_GameObject* gameobj,
 
 	class PHY_IMotionState* motionstate = new KX_MotionState(gameobj->GetSGNode());
 
-	kxscene->GetPhysicsEnvironment()->ConvertObject(gameobj, meshobj, dm, kxscene, shapeprops, motionstate, activeLayerBitInfo, isCompoundChild, hasCompoundChildren);
+	kxscene->GetPhysicsEnvironment()->ConvertObject(converter, gameobj, meshobj, dm, kxscene, shapeprops, motionstate, activeLayerBitInfo, isCompoundChild, hasCompoundChildren);
 
 	bool isActor = (blenderobject->gameflag & OB_ACTOR)!=0;
 	bool isSensor = (blenderobject->gameflag & OB_SENSOR) != 0;
@@ -904,7 +900,7 @@ static void BL_CreatePhysicsObjectNew(KX_GameObject* gameobj,
 	}
 }
 
-static KX_LodManager *lodmanager_from_blenderobject(Object *ob, KX_Scene *scene, KX_BlenderSceneConverter *converter, bool libloading)
+static KX_LodManager *lodmanager_from_blenderobject(Object *ob, KX_Scene *scene, KX_BlenderSceneConverter& converter, bool libloading)
 {
 	if (BLI_listbase_count_ex(&ob->lodlevels, 2) <= 1) {
 		return nullptr;
@@ -920,7 +916,7 @@ static KX_LodManager *lodmanager_from_blenderobject(Object *ob, KX_Scene *scene,
 	return lodManager;
 }
 
-static KX_LightObject *gamelight_from_blamp(Object *ob, Lamp *la, unsigned int layerflag, KX_Scene *kxscene, RAS_Rasterizer *rasterizer, KX_BlenderSceneConverter *converter)
+static KX_LightObject *gamelight_from_blamp(Object *ob, Lamp *la, unsigned int layerflag, KX_Scene *kxscene, RAS_Rasterizer *rasterizer, KX_BlenderSceneConverter& converter)
 {
 	RAS_ILightObject *lightobj = rasterizer->CreateLight();
 	KX_LightObject *gamelight;
@@ -974,7 +970,7 @@ static KX_LightObject *gamelight_from_blamp(Object *ob, Lamp *la, unsigned int l
 	return gamelight;
 }
 
-static KX_Camera *gamecamera_from_bcamera(Object *ob, KX_Scene *kxscene, KX_BlenderSceneConverter *converter)
+static KX_Camera *gamecamera_from_bcamera(Object *ob, KX_Scene *kxscene, KX_BlenderSceneConverter& converter)
 {
 	Camera* ca = static_cast<Camera*>(ob->data);
 	RAS_CameraData camdata(ca->lens, ca->ortho_scale, ca->sensor_x, ca->sensor_y, ca->sensor_fit, ca->shiftx, ca->shifty, ca->clipsta, ca->clipend, ca->type == CAM_PERSP, ca->YF_dofdist);
@@ -993,7 +989,7 @@ static KX_GameObject *gameobject_from_blenderobject(
 								Object *ob, 
 								KX_Scene *kxscene, 
 								RAS_Rasterizer *rendertools,
-								KX_BlenderSceneConverter *converter,
+								KX_BlenderSceneConverter& converter,
 								bool libloading) 
 {
 	KX_GameObject *gameobj = nullptr;
@@ -1307,7 +1303,7 @@ static void BL_ConvertComponentsObject(KX_GameObject *gameobj, Object *blenderob
 /* helper for BL_ConvertBlenderObjects, avoids code duplication
  * note: all var names match args are passed from the caller */
 static void bl_ConvertBlenderObject_Single(
-        KX_BlenderSceneConverter *converter,
+        KX_BlenderSceneConverter& converter,
        Object *blenderobject,
         std::vector<parentChildLink> &vec_parent_child,
         CListValue* logicbrick_conversionlist,
@@ -1395,7 +1391,7 @@ static void bl_ConvertBlenderObject_Single(
 	for (int i = 0; i < gameobj->GetMeshCount(); i++)
 		logicmgr->RegisterGameMeshName(gameobj->GetMesh(i)->GetName(), blenderobject);
 
-	converter->RegisterGameObject(gameobj, blenderobject);
+	converter.RegisterGameObject(gameobj, blenderobject);
 	// this was put in rapidly, needs to be looked at more closely
 	// only draw/use objects in active 'blender' layers
 
@@ -1425,7 +1421,7 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 							  e_PhysicsEngine	physics_engine,
 							  RAS_Rasterizer* rendertools,
 							  RAS_ICanvas* canvas,
-							  KX_BlenderSceneConverter* converter,
+							  KX_BlenderSceneConverter& converter,
 							  bool alwaysUseExpandFraming,
 							  bool libloading
 							  )
@@ -1597,7 +1593,7 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 				for (go=(GroupObject*)group->gobject.first; go; go=(GroupObject*)go->next)
 				{
 					Object* blenderobject = go->ob;
-					if (converter->FindGameObject(blenderobject) == nullptr)
+					if (converter.FindGameObject(blenderobject) == nullptr)
 					{
 						allblobj.insert(blenderobject);
 						groupobj.insert(blenderobject);
@@ -1637,7 +1633,7 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 
 	// non-camera objects not supported as camera currently
 	if (blenderscene->camera && blenderscene->camera->type == OB_CAMERA) {
-		KX_Camera *gamecamera= (KX_Camera*) converter->FindGameObject(blenderscene->camera);
+		KX_Camera *gamecamera= (KX_Camera*) converter.FindGameObject(blenderscene->camera);
 
 		if (gamecamera)
 			kxscene->SetActiveCamera(gamecamera);
@@ -1652,10 +1648,10 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 			Mesh *me = (Mesh*)blenderobj->data;
 
 			if (me->dvert) {
-				BL_DeformableGameObject *obj = (BL_DeformableGameObject*)converter->FindGameObject(blenderobj);
+				BL_DeformableGameObject *obj = (BL_DeformableGameObject*)converter.FindGameObject(blenderobj);
 
 				if (obj && BL_ModifierDeformer::HasArmatureDeformer(blenderobj) && blenderobj->parent && blenderobj->parent->type==OB_ARMATURE) {
-					KX_GameObject *par = converter->FindGameObject(blenderobj->parent);
+					KX_GameObject *par = converter.FindGameObject(blenderobj->parent);
 					if (par && obj->GetDeformer())
 						((BL_SkinDeformer*)obj->GetDeformer())->SetArmature((BL_ArmatureObject*) par);
 				}
@@ -1671,8 +1667,8 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 
 		struct Object* blenderchild = pcit->m_blenderchild;
 		struct Object* blenderparent = blenderchild->parent;
-		KX_GameObject* parentobj = converter->FindGameObject(blenderparent);
-		KX_GameObject* childobj = converter->FindGameObject(blenderchild);
+		KX_GameObject* parentobj = converter.FindGameObject(blenderparent);
+		KX_GameObject* childobj = converter.FindGameObject(blenderchild);
 
 		BLI_assert(childobj);
 
@@ -1703,7 +1699,7 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 			childrenlist->Release();
 
 			// now destroy recursively
-			converter->UnregisterGameObject(childobj); // removing objects during conversion make sure this runs too
+			converter.UnregisterGameObject(childobj); // removing objects during conversion make sure this runs too
 			kxscene->RemoveObject(childobj);
 
 			continue;
@@ -1862,7 +1858,7 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 
 					KX_GameObject *viewpoint = gameobj;
 					if (env->object) {
-						KX_GameObject *obj = converter->FindGameObject(env->object);
+						KX_GameObject *obj = converter.FindGameObject(env->object);
 						if (obj) {
 							viewpoint = obj;
 						}
@@ -1882,7 +1878,7 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 		Mesh *predifinedBoundMesh = blenderobject->gamePredefinedBound;
 
 		if (predifinedBoundMesh) {
-			RAS_MeshObject *meshobj = converter->FindGameMesh(predifinedBoundMesh);
+			RAS_MeshObject *meshobj = converter.FindGameMesh(predifinedBoundMesh);
 			// In case of mesh taken in a other scene.
 			if (!meshobj) {
 				continue;

source/gameengine/Converter/BL_BlenderDataConversion.h

@@ -37,15 +37,15 @@
 #include "KX_PhysicsEngineEnums.h"
 #include "SCA_IInputDevice.h"
 
-class RAS_MeshObject* BL_ConvertMesh(struct Mesh* mesh,struct Object* lightobj,class KX_Scene* scene, class KX_BlenderSceneConverter *converter, bool libloading);
+class RAS_MeshObject* BL_ConvertMesh(struct Mesh* mesh,struct Object* lightobj,class KX_Scene* scene, class KX_BlenderSceneConverter& converter, bool libloading);
 
 void BL_ConvertBlenderObjects(struct Main* maggie,
 							  class KX_Scene* kxscene,
 							  class KX_KetsjiEngine* ketsjiEngine,
 							  e_PhysicsEngine	physics_engine,
 							  class RAS_Rasterizer* rendertools,
-							  class RAS_ICanvas* canvas, 
-							  class KX_BlenderSceneConverter* sceneconverter, 
+							  class RAS_ICanvas* canvas,
+							  class KX_BlenderSceneConverter& sceneconverter,
 							  bool alwaysUseExpandFraming,
 							  bool libloading=false
 							  );

source/gameengine/Converter/CMakeLists.txt

@@ -75,6 +75,7 @@ set(SRC
 	BL_ModifierDeformer.cpp
 	BL_ShapeDeformer.cpp
 	BL_SkinDeformer.cpp
+	KX_BlenderConverter.cpp
 	KX_BlenderScalarInterpolator.cpp
 	KX_BlenderSceneConverter.cpp
 	KX_ConvertActuators.cpp
@@ -96,6 +97,7 @@ set(SRC
 	BL_ModifierDeformer.h
 	BL_ShapeDeformer.h
 	BL_SkinDeformer.h
+	KX_BlenderConverter.h
 	KX_BlenderScalarInterpolator.h
 	KX_BlenderSceneConverter.h
 	KX_ConvertActuators.h