Changeset 3355

Timestamp:

Jul 26, 2009, 2:15:08 PM (15 years ago)

Author:

rgrieder

Message:

Loading and unloading graphics automatically: As soon as a GameState requires graphics (defined at the GameState declaration with a bool) it gets loaded. And vice versa.

Location:

code/branches/resource/src

Files:

• core/Core.cc (modified) (2 diffs)
• core/CorePrereqs.h (modified) (1 diff)
• core/Game.cc (modified) (7 diffs)
• core/Game.h (modified) (5 diffs)
• core/GameMode.h (modified) (2 diffs)
• core/GameState.cc (modified) (4 diffs)
• core/GameState.h (modified) (3 diffs)
• orxonox/gamestates/GSClient.cc (modified) (1 diff)
• orxonox/gamestates/GSClient.h (modified) (1 diff)
• orxonox/gamestates/GSDedicated.cc (modified) (1 diff)
• orxonox/gamestates/GSDedicated.h (modified) (1 diff)
• orxonox/gamestates/GSGraphics.cc (modified) (3 diffs)
• orxonox/gamestates/GSGraphics.h (modified) (1 diff)
• orxonox/gamestates/GSIOConsole.cc (modified) (1 diff)
• orxonox/gamestates/GSIOConsole.h (modified) (1 diff)
• orxonox/gamestates/GSLevel.cc (modified) (1 diff)
• orxonox/gamestates/GSLevel.h (modified) (1 diff)
• orxonox/gamestates/GSMainMenu.cc (modified) (1 diff)
• orxonox/gamestates/GSMainMenu.h (modified) (1 diff)
• orxonox/gamestates/GSRoot.cc (modified) (2 diffs)
• orxonox/gamestates/GSRoot.h (modified) (1 diff)
• orxonox/gamestates/GSServer.cc (modified) (1 diff)
• orxonox/gamestates/GSServer.h (modified) (1 diff)
• orxonox/gamestates/GSStandalone.cc (modified) (1 diff)
• orxonox/gamestates/GSStandalone.h (modified) (1 diff)

code/branches/resource/src/core/Core.cc

@@ -364 +364 @@
         guiManager_ = new GUIManager(renderWindow);
 
-        GameMode::setShowsGraphics(true);
         bGraphicsLoaded_ = true;
     }
@@ -378 +377 @@
 
         bGraphicsLoaded_ = false;
-        GameMode::setShowsGraphics(false);
     }
 

code/branches/resource/src/core/CorePrereqs.h

@@ -170 +170 @@
     // game states
     class Game;
-    struct GameStateConstrParams;
     class GameState;
+    struct GameStateInfo;
     struct GameStateTreeNode;
 

code/branches/resource/src/core/Game.cc

@@ -48 +48 @@
 #include "CoreIncludes.h"
 #include "ConfigValueIncludes.h"
+#include "GameMode.h"
 #include "GameState.h"
 
@@ -59 +60 @@
     SetConsoleCommandShortcutExternAlias(stop_game, "exit");
 
-    std::map<std::string, Game::GameStateInfo> Game::gameStateDeclarations_s;
+    std::map<std::string, GameStateInfo> Game::gameStateDeclarations_s;
     Game* Game::singletonRef_s = 0;
 
@@ -143 +144 @@
             // Only create the states appropriate for the game mode
             //if (GameMode::showsGraphics || !it->second.bGraphicsMode)
-            GameStateConstrParams params = { it->second.stateName, it->second.bIgnoreTickTime };
-            gameStates_[getLowercase(it->second.stateName)] = GameStateFactory::fabricate(it->second.className, params);
+            gameStates_[getLowercase(it->second.stateName)] = GameStateFactory::fabricate(it->second);
         }
 
@@ -292 +292 @@
                 // Add tick time for most of the states
                 uint64_t timeBeforeTick;
-                if ((*it)->ignoreTickTime())
+                if ((*it)->getInfo().bIgnoreTickTime)
                     timeBeforeTick = this->gameClock_->getRealMicroseconds();
                 (*it)->update(*this->gameClock_);
-                if ((*it)->ignoreTickTime())
+                if ((*it)->getInfo().bIgnoreTickTime)
                     this->subtractTickTime(static_cast<int32_t>(this->gameClock_->getRealMicroseconds() - timeBeforeTick));
             }
@@ -517 +517 @@
     /*** Internal ***/
 
+    void Game::loadGraphics()
+    {
+        if (!GameMode::bShowsGraphics_s)
+        {
+            core_->loadGraphics();
+            GameMode::bShowsGraphics_s = true;
+        }
+    }
+
+    void Game::unloadGraphics()
+    {
+        if (GameMode::bShowsGraphics_s)
+        {
+            core_->unloadGraphics();
+            GameMode::bShowsGraphics_s = false;
+        }
+    }
+
     void Game::loadState(GameState* state)
     {
         this->bChangingState_ = true;
+        // If state requires graphics, load it
+        if (state->getInfo().bGraphicsMode)
+            this->loadGraphics();
         state->activate();
         if (!this->activeStates_.empty())
@@ -538 +559 @@
         {
             state->deactivate();
+            // Check if graphis is still required
+            bool graphicsRequired = false;
+            for (unsigned i = 0; i < activeStates_.size(); ++i)
+                graphicsRequired |= activeStates_[i]->getInfo().bGraphicsMode;
+            if (!graphicsRequired)
+                this->unloadGraphics();
         }
         catch (const std::exception& ex)
@@ -549 +576 @@
     std::map<std::string, Game::GameStateFactory*> Game::GameStateFactory::factories_s;
 
-    /*static*/ GameState* Game::GameStateFactory::fabricate(const std::string& className, const GameStateConstrParams& params)
-    {
-        std::map<std::string, GameStateFactory*>::const_iterator it = factories_s.find(className);
+    /*static*/ GameState* Game::GameStateFactory::fabricate(const GameStateInfo& info)
+    {
+        std::map<std::string, GameStateFactory*>::const_iterator it = factories_s.find(info.className);
         assert(it != factories_s.end());
-        return it->second->fabricate(params);
+        return it->second->fabricateInternal(info);
     }
 

code/branches/resource/src/core/Game.h

@@ -61 +61 @@
     class GameConfiguration;
 
+    //! Helper object required before GameStates are being constructed
+    struct GameStateInfo
+    {
+        std::string stateName;
+        std::string className;
+        bool bIgnoreTickTime;
+        bool bGraphicsMode;
+    };
+
     /**
     @brief
@@ -97 +106 @@
         public:
             virtual ~GameStateFactory() { }
-            static GameState* fabricate(const std::string& className, const GameStateConstrParams& params);
+            static GameState* fabricate(const GameStateInfo& info);
             template <class T>
             static void createFactory(const std::string& className)
@@ -103 +112 @@
             static void destroyFactories();
         private:
-            virtual GameState* fabricate(const GameStateConstrParams& params) = 0;
+            virtual GameState* fabricateInternal(const GameStateInfo& info) = 0;
             static std::map<std::string, GameStateFactory*> factories_s;
         };
@@ -110 +119 @@
         {
         public:
-            GameState* fabricate(const GameStateConstrParams& params)
-                { return new T(params); }
-        };
-
-        struct GameStateInfo
-        {
-            std::string stateName;
-            std::string className;
-            bool bIgnoreTickTime;
-            bool bGraphicsMode;
+            GameState* fabricateInternal(const GameStateInfo& info)
+                { return new T(info); }
         };
 
@@ -129 +130 @@
 
         Game(Game&); // don't mess with singletons
+
+        void loadGraphics();
+        void unloadGraphics();
 
         void loadState(GameState* state);

code/branches/resource/src/core/GameMode.h

@@ -41 +41 @@
     class _CoreExport GameMode
     {
-        friend class Core;
+        friend class Game;
 
         public:
@@ -59 +59 @@
             ~GameMode();
 
-            static void setShowsGraphics(bool val) { bShowsGraphics_s = val; updateIsMaster(); }
-            static void updateIsMaster  ()         { bIsMaster_s      = (bHasServer_s || bIsStandalone_s); }
+            static void updateIsMaster()
+            {
+                bIsMaster_s = (bHasServer_s || bIsStandalone_s);
+            }
 
             static bool bShowsGraphics_s;                   //!< global variable that tells whether to show graphics

code/branches/resource/src/core/GameState.cc

@@ -38 +38 @@
 #include "util/Exception.h"
 #include "util/OrxAssert.h"
+#include "Game.h"
 
 namespace orxonox
@@ -45 +46 @@
         Constructor only initialises variables and sets the name permanently.
     */
-    GameState::GameState(const GameStateConstrParams& params)
-        : name_(params.name)
-        , bIgnoreTickTime_(params.bIgnoreTickTime)
+    GameState::GameState(const GameStateInfo& info)
+        : info_(info)
         , parent_(0)
     {
@@ -65 +65 @@
     {
         OrxAssert(this->activity_.active == false, "Deleting an active GameState is a very bad idea..");
+    }
+
+    const std::string& GameState::getName() const
+    {
+        return info_.stateName;
     }
 
@@ -107 +112 @@
         else
         {
-            ThrowException(GameState, "Game state '" + name_ + "' doesn't have a child named '"
+            ThrowException(GameState, "Game state '" + this->getName() + "' doesn't have a child named '"
                 + state->getName() + "'.");
         }

code/branches/resource/src/core/GameState.h

@@ -45 +45 @@
     /**
     @brief
-        Helper class to group construction parameters for better genericity.
-    */
-    struct GameStateConstrParams
-    {
-        std::string name;
-        bool bIgnoreTickTime;
-    };
-
-    /**
-    @brief
         An implementation of a tree to manage game states.
         This leads to a certain hierarchy that is created at runtime.
@@ -87 +77 @@
 
     public:
-        GameState(const GameStateConstrParams& params);
+        GameState(const GameStateInfo& info);
         virtual ~GameState();
 
-        const std::string& getName() const { return name_; }
-        State getActivity()          const { return this->activity_; }
-        GameState* getParent()       const { return this->parent_; }
-
-        bool ignoreTickTime()        const { return this->bIgnoreTickTime_; }
+        const std::string& getName()   const;
+        State getActivity()            const { return activity_; }
+        GameState* getParent()         const { return parent_; }
+        const GameStateInfo& getInfo() const { return info_; }
 
         void addChild(GameState* state);
@@ -111 +100 @@
         void updateInternal(const Clock& time);
 
-        const std::string                        name_;
+        const GameStateInfo&                     info_;
         State                                    activity_;
-        const bool                               bIgnoreTickTime_;
         GameState*                               parent_;
         std::map<std::string, GameState*>        children_;

code/branches/resource/src/orxonox/gamestates/GSClient.cc

@@ -42 +42 @@
     SetCommandLineArgument(ip, "127.0.0.1").information("Sever IP as strin in the form #.#.#.#");
 
-    GSClient::GSClient(const GameStateConstrParams& params)
-        : GameState(params)
+    GSClient::GSClient(const GameStateInfo& info)
+        : GameState(info)
         , client_(0)
     {

code/branches/resource/src/orxonox/gamestates/GSClient.h

@@ -40 +40 @@
     {
     public:
-        GSClient(const GameStateConstrParams& params);
+        GSClient(const GameStateInfo& info);
         ~GSClient();
 

code/branches/resource/src/orxonox/gamestates/GSDedicated.cc

@@ -55 +55 @@
     termios* GSDedicated::originalTerminalSettings_;
 
-    GSDedicated::GSDedicated(const GameStateConstrParams& params)
-        : GameState(params)
+    GSDedicated::GSDedicated(const GameStateInfo& info)
+        : GameState(info)
         , server_(0)
         , closeThread_(false)

code/branches/resource/src/orxonox/gamestates/GSDedicated.h

@@ -48 +48 @@
     {
     public:
-        GSDedicated(const GameStateConstrParams& params);
+        GSDedicated(const GameStateInfo& info);
         ~GSDedicated();
 

code/branches/resource/src/orxonox/gamestates/GSGraphics.cc

@@ -57 +57 @@
     DeclareGameState(GSGraphics, "graphics", false, true);
 
-    GSGraphics::GSGraphics(const GameStateConstrParams& params)
-        : GameState(params)
+    GSGraphics::GSGraphics(const GameStateInfo& info)
+        : GameState(info)
         , console_(0)
         , soundManager_(0)
@@ -88 +88 @@
     void GSGraphics::activate()
     {
-        // Load OGRE, CEGUI and OIS
-        Core::getInstance().loadGraphics();
-
         // load debug overlay
         COUT(3) << "Loading Debug Overlay..." << std::endl;
@@ -147 +144 @@
         // HACK: (destroys a resource smart pointer)
         Map::hackDestroyMap();
-
-        // Unload OGRE, CEGUI and OIS
-        Core::getInstance().loadGraphics();
     }
 

code/branches/resource/src/orxonox/gamestates/GSGraphics.h

@@ -50 +50 @@
     {
     public:
-        GSGraphics(const GameStateConstrParams& params);
+        GSGraphics(const GameStateInfo& info);
         ~GSGraphics();
 

code/branches/resource/src/orxonox/gamestates/GSIOConsole.cc

@@ -38 +38 @@
     DeclareGameState(GSIOConsole, "ioConsole", false, false);
 
-    GSIOConsole::GSIOConsole(const GameStateConstrParams& params)
-        : GameState(params)
+    GSIOConsole::GSIOConsole(const GameStateInfo& info)
+        : GameState(info)
     {
     }

code/branches/resource/src/orxonox/gamestates/GSIOConsole.h

@@ -38 +38 @@
     {
     public:
-        GSIOConsole(const GameStateConstrParams& params);
+        GSIOConsole(const GameStateInfo& info);
         ~GSIOConsole();
 

code/branches/resource/src/orxonox/gamestates/GSLevel.cc

@@ -60 +60 @@
     XMLFile* GSLevel::startFile_s = NULL;
 
-    GSLevel::GSLevel(const GameStateConstrParams& params)
-        : GameState(params)
+    GSLevel::GSLevel(const GameStateInfo& info)
+        : GameState(info)
         , keyBinder_(0)
         , gameInputState_(0)

code/branches/resource/src/orxonox/gamestates/GSLevel.h

@@ -41 +41 @@
     {
     public:
-        GSLevel(const GameStateConstrParams& params);
+        GSLevel(const GameStateInfo& info);
         ~GSLevel();
         void setConfigValues();

code/branches/resource/src/orxonox/gamestates/GSMainMenu.cc

@@ -45 +45 @@
     DeclareGameState(GSMainMenu, "mainMenu", false, true);
 
-    GSMainMenu::GSMainMenu(const GameStateConstrParams& params)
-        : GameState(params)
+    GSMainMenu::GSMainMenu(const GameStateInfo& info)
+        : GameState(info)
         , inputState_(0)
     {

code/branches/resource/src/orxonox/gamestates/GSMainMenu.h

@@ -40 +40 @@
     {
     public:
-        GSMainMenu(const GameStateConstrParams& params);
+        GSMainMenu(const GameStateInfo& info);
         ~GSMainMenu();
 

code/branches/resource/src/orxonox/gamestates/GSRoot.cc

@@ -53 +53 @@
     SetCommandLineSwitch(standalone).information("Start in standalone mode");
 
-    GSRoot::GSRoot(const GameStateConstrParams& params)
-        : GameState(params)
+    GSRoot::GSRoot(const GameStateInfo& info)
+        : GameState(info)
         , timeFactor_(1.0f)
         , bPaused_(false)
@@ -174 +174 @@
     @brief
         Changes the speed of Orxonox
+    @remark
+        This function is a hack when placed here!
+        Timefactor should be related to the scene (level or so), not the game
     */
     void GSRoot::setTimeFactor(float factor)

code/branches/resource/src/orxonox/gamestates/GSRoot.h

@@ -38 +38 @@
     {
     public:
-        GSRoot(const GameStateConstrParams& params);
+        GSRoot(const GameStateInfo& info);
         ~GSRoot();
 

code/branches/resource/src/orxonox/gamestates/GSServer.cc

@@ -41 +41 @@
     SetCommandLineArgument(port, 55556).shortcut("p").information("Network communication port to be used 0-65535 (default: 55556)");
 
-    GSServer::GSServer(const GameStateConstrParams& params)
-        : GameState(params)
+    GSServer::GSServer(const GameStateInfo& info)
+        : GameState(info)
         , server_(0)
     {

code/branches/resource/src/orxonox/gamestates/GSServer.h

@@ -40 +40 @@
     {
     public:
-        GSServer(const GameStateConstrParams& params);
+        GSServer(const GameStateInfo& info);
         ~GSServer();
 

code/branches/resource/src/orxonox/gamestates/GSStandalone.cc

@@ -36 +36 @@
     DeclareGameState(GSStandalone, "standalone", false, true);
 
-    GSStandalone::GSStandalone(const GameStateConstrParams& params)
-        : GameState(params)
+    GSStandalone::GSStandalone(const GameStateInfo& info)
+        : GameState(info)
     {
     }

code/branches/resource/src/orxonox/gamestates/GSStandalone.h

@@ -38 +38 @@
     {
     public:
-        GSStandalone(const GameStateConstrParams& params);
+        GSStandalone(const GameStateInfo& info);
         ~GSStandalone();