Work arounded crash in CEGUI/ogre open gl renderer when some entities…

… were removed

+ dehardcoded the dirt tile used as a workaround for lightning issues

fixes OpenDungeons#700

source/gamemap/GameMap.cpp

@@ -3030,6 +3030,12 @@ std::vector<Spell*> GameMap::getSpellsBySeatAndType(Seat* seat, SpellType type)
     return ret;
 }
 
+const std::string& GameMap::getMeshForDefaultTile() const
+{
+    // 0 means tile not linked to any neighboor
+    return mTileSet->getTileValues(TileVisual::dirtFull).at(0).getMeshName();
+}
+
 const TileSetValue& GameMap::getMeshForTile(const Tile* tile) const
 {
     int index = 0;

source/gamemap/GameMap.h

@@ -517,7 +517,12 @@ friend class ODServer;
     inline const std::string& getTileSetName() const
     { return mTileSetName; }
 
+    //! \brief getMeshForDefaultTile returns a mesh for some default dirt tile. This
+    //! is used as a workaround to avoid lightning issues
+    const std::string& getMeshForDefaultTile() const;
+    //! \brief get the tileset infos for the given tile
     const TileSetValue& getMeshForTile(const Tile* tile) const;
+    //! \brief get the tileset global scale
     const Ogre::Vector3& getTileSetScale() const;
 
     void playerSelects(std::vector<EntityBase*>& entities, int tileX1, int tileY1, int tileX2,

source/network/ODClient.cpp

@@ -370,7 +370,8 @@ bool ODClient::processOneClientSocketMessage()
             }
 
             // We reset the renderer
-            RenderManager::getSingleton().clearRenderer();
+            RenderManager::getSingleton().initRendererForNewGame(gameMap);
+
             // Move camera to starting position
             Ogre::Real startX = static_cast<Ogre::Real>(tempSeat->mStartingX);
             Ogre::Real startY = static_cast<Ogre::Real>(tempSeat->mStartingY);

source/render/RenderManager.cpp

@@ -105,9 +105,55 @@ RenderManager::~RenderManager()
 {
 }
 
-void RenderManager::clearRenderer()
+void RenderManager::initRendererForNewGame(GameMap* gameMap)
 {
     mCreatureTextOverlayDisplayed = false;
+
+    for(Ogre::SceneNode* dummyNode : mDummyEntities)
+    {
+        Ogre::Entity* dummyEnt = mSceneManager->getEntity(dummyNode->getName() + "Ent");
+        if(dummyEnt != nullptr)
+        {
+            dummyNode->detachObject(dummyEnt);
+            mSceneManager->destroyEntity(dummyEnt);
+        }
+        mHandKeeperNode->removeChild(dummyNode);
+        mSceneManager->destroySceneNode(dummyNode);
+    }
+    mDummyEntities.clear();
+
+    //Add a too small to be visible dummy dirt tile to the hand node
+    //so that there will always be a dirt tile "visible"
+    //This is an ugly workaround for issue where destroying some entities messes
+    //up the lighing for some of the rtshader materials.
+    Ogre::SceneNode* dummyNode;
+    Ogre::Entity* dummyEnt;
+    dummyNode = mHandKeeperNode->createChildSceneNode("DummyNodeTile");
+    dummyNode->setScale(Ogre::Vector3(0.00000001f, 0.00000001f, 0.00000001f));
+    const std::string& defaultTileMesh = gameMap->getMeshForDefaultTile();
+    dummyEnt = mSceneManager->createEntity(dummyNode->getName() + "Ent", defaultTileMesh);
+    dummyEnt->setLightMask(0);
+    dummyEnt->setCastShadows(false);
+    dummyNode->attachObject(dummyEnt);
+    mDummyEntities.push_back(dummyNode);
+
+    // We load every creature class and attach them to the keeper hand.
+    // That's an ugly workaround to avoid a crash that occurs when CEGUI refreshes
+    // ogre open gl renderer after removing some creatures
+    // Note that from what I've seen, loading only one creature like "Troll.mesh" should be
+    // enough. However, it doesn't work with other creatures (like "Kobold.mesh"). Since we
+    // don't really know why, it is safer to load every creature
+    for(uint32_t i = 0; i < gameMap->numClassDescriptions(); ++i)
+    {
+        const CreatureDefinition* def = gameMap->getClassDescription(i);
+        dummyNode = mHandKeeperNode->createChildSceneNode("Dummy_" + def->getClassName());
+        dummyNode->setScale(Ogre::Vector3(0.00000001f, 0.00000001f, 0.00000001f));
+        dummyEnt = mSceneManager->createEntity(dummyNode->getName() + "Ent", def->getMeshName());
+        dummyEnt->setLightMask(0);
+        dummyEnt->setCastShadows(false);
+        dummyNode->attachObject(dummyEnt);
+        mDummyEntities.push_back(dummyNode);
+    }
 }
 
 void RenderManager::triggerCompositor(const std::string& compositorName)
@@ -165,17 +211,6 @@ void RenderManager::createScene(Ogre::Viewport* nViewport)
     handKeeperOverlay->add3D(mHandKeeperNode);
     handKeeperOverlay->show();
 
-    //Add a too small to be visible dummy dirt tile to the hand node
-    //so that there will allways be a dirt tile "visible"
-    //This is an ugly workaround for issue where destroying some entities messes
-    //up the lighing for some of the rtshader materials.
-    Ogre::SceneNode* dummyNode = mHandKeeperNode->createChildSceneNode("Dummy_node");
-    dummyNode->setScale(Ogre::Vector3(0.00000001f, 0.00000001f, 0.00000001f));
-    Ogre::Entity* dummyEnt = mSceneManager->createEntity("Dirt_fl_0000.mesh");
-    dummyEnt->setLightMask(0);
-    dummyEnt->setCastShadows(false);
-    dummyNode->attachObject(dummyEnt);
-
     // Create the light which follows the single tile selection mesh
     mHandLight = mSceneManager->createLight("MouseLight");
     mHandLight->setType(Ogre::Light::LT_POINT);

source/render/RenderManager.h

@@ -67,8 +67,8 @@ class RenderManager: public Ogre::Singleton<RenderManager>
     //! \brief Loop through the render requests in the queue and process them
     void updateRenderAnimations(Ogre::Real timeSinceLastFrame);
 
-    //! \brief Resets the renderer
-    void clearRenderer();
+    //! \brief Initialize the renderer when a new game (Game or Editor) is launched
+    void initRendererForNewGame(GameMap* gameMap);
 
     //! \brief starts the compositor compositorName.
     void triggerCompositor(const std::string& compositorName);
@@ -181,6 +181,11 @@ class RenderManager: public Ogre::Singleton<RenderManager>
     Ogre::Real mFactorWidth;
     Ogre::Real mFactorHeight;
 
+    // As a workaround for some issues, we create dummy entities too small to be seen
+    // and attach them to the keeper hand. This vector allows to keep a track and delete
+    // them/recreate when loading a new game
+    std::vector<Ogre::SceneNode*> mDummyEntities;
+
     //! \brief True if the creatures are currently displaying their text overlay
     bool mCreatureTextOverlayDisplayed;