Refactor the unholy mess that is WindowManager::updateVisible

GUI modes are now defined in a general and extensible way. The next commits are going to take advantage of this.

apps/openmw/mwgui/journalwindow.cpp

@@ -44,7 +44,7 @@ namespace
     static char const LeftTopicIndex [] = "LeftTopicIndex";
     static char const RightTopicIndex [] = "RightTopicIndex";
 
-    struct JournalWindowImpl : MWGui::WindowBase, MWGui::JournalBooks, MWGui::JournalWindow
+    struct JournalWindowImpl : MWGui::JournalBooks, MWGui::JournalWindow
     {
         struct DisplayState
         {
@@ -94,7 +94,7 @@ namespace
         }
 
         JournalWindowImpl (MWGui::JournalViewModel::Ptr Model, bool questList)
-            : WindowBase("openmw_journal.layout"), JournalBooks (Model)
+            : JournalBooks (Model), JournalWindow()
         {
             mMainWidget->setVisible(false);
             center();
@@ -603,3 +603,9 @@ MWGui::JournalWindow * MWGui::JournalWindow::create (JournalViewModel::Ptr Model
 {
     return new JournalWindowImpl (Model, questList);
 }
+
+MWGui::JournalWindow::JournalWindow()
+    :WindowBase("openmw_journal.layout")
+{
+
+}

apps/openmw/mwgui/journalwindow.hpp

@@ -1,6 +1,8 @@
 #ifndef MWGUI_JOURNAL_H
 #define MWGUI_JOURNAL_H
 
+#include "windowbase.hpp"
+
 #include <memory>
 
 namespace MWBase { class WindowManager; }
@@ -9,8 +11,10 @@ namespace MWGui
 {
     struct JournalViewModel;
 
-    struct JournalWindow
+    struct JournalWindow : public WindowBase
     {
+        JournalWindow();
+
         /// construct a new instance of the one JournalWindow implementation
         static JournalWindow * create (std::shared_ptr <JournalViewModel> Model, bool questList);
 

apps/openmw/mwgui/mainmenu.cpp

@@ -22,7 +22,7 @@ namespace MWGui
 {
 
     MainMenu::MainMenu(int w, int h, const VFS::Manager* vfs, const std::string& versionDescription)
-        : Layout("openmw_mainmenu.layout")
+        : WindowBase("openmw_mainmenu.layout")
         , mWidth (w), mHeight (h)
         , mVFS(vfs), mButtonBox(0)
         , mBackground(NULL)

apps/openmw/mwgui/mainmenu.hpp

@@ -1,7 +1,7 @@
 #ifndef OPENMW_GAME_MWGUI_MAINMENU_H
 #define OPENMW_GAME_MWGUI_MAINMENU_H
 
-#include "layout.hpp"
+#include "windowbase.hpp"
 
 namespace Gui
 {
@@ -20,7 +20,7 @@ namespace MWGui
     class SaveGameDialog;
     class VideoWidget;
 
-    class MainMenu : public Layout
+    class MainMenu : public WindowBase
     {
             int mWidth;
             int mHeight;

apps/openmw/mwgui/messagebox.cpp

@@ -77,6 +77,7 @@ namespace MWGui
 
         if(mInterMessageBoxe != NULL && mInterMessageBoxe->mMarkedToDelete) {
             mLastButtonPressed = mInterMessageBoxe->readPressedButton();
+            mInterMessageBoxe->setVisible(false);
             delete mInterMessageBoxe;
             mInterMessageBoxe = NULL;
             MWBase::Environment::get().getInputManager()->changeInputMode(
@@ -200,7 +201,7 @@ namespace MWGui
       , mMessageBoxManager(parMessageBoxManager)
       , mButtonPressed(-1)
     {
-        WindowModal::onOpen();
+        setVisible(true);
 
         int textPadding = 10; // padding between text-widget and main-widget
         int textButtonPadding = 10; // padding between the text-widget und the button-widget

apps/openmw/mwgui/windowbase.cpp

@@ -15,6 +15,7 @@ using namespace MWGui;
 WindowBase::WindowBase(const std::string& parLayout)
   : Layout(parLayout)
 {
+    mMainWidget->setVisible(false);
 }
 
 void WindowBase::setVisible(bool visible)

apps/openmw/mwgui/windowmanagerimp.cpp

@@ -320,51 +320,103 @@ namespace MWGui
         mDragAndDrop = new DragAndDrop();
 
         mRecharge = new Recharge();
+        mGuiModeStates[GM_Recharge] = GuiModeState(mRecharge);
+
         mMenu = new MainMenu(w, h, mResourceSystem->getVFS(), mVersionDescription);
+        mGuiModeStates[GM_MainMenu] = GuiModeState(mMenu);
+
         mLocalMapRender = new MWRender::LocalMap(mViewer->getSceneData()->asGroup());
         mMap = new MapWindow(mCustomMarkers, mDragAndDrop, mLocalMapRender, mWorkQueue);
         mMap->renderGlobalMap();
         trackWindow(mMap, "map");
         mStatsWindow = new StatsWindow(mDragAndDrop);
         trackWindow(mStatsWindow, "stats");
+        mInventoryWindow = new InventoryWindow(mDragAndDrop, mViewer->getSceneData()->asGroup(), mResourceSystem);
+        mSpellWindow = new SpellWindow(mDragAndDrop);
+        trackWindow(mSpellWindow, "spells");
+
+        mGuiModeStates[GM_Inventory] = GuiModeState({mMap, mInventoryWindow, mSpellWindow, mStatsWindow});
+        mGuiModeStates[GM_None] = GuiModeState({mMap, mInventoryWindow, mSpellWindow, mStatsWindow});
+
+        mTradeWindow = new TradeWindow();
+        trackWindow(mTradeWindow, "barter");
+
+        mGuiModeStates[GM_Barter] = GuiModeState({mInventoryWindow, mTradeWindow});
+
         mConsole = new Console(w,h, mConsoleOnlyScripts);
         trackWindow(mConsole, "console");
+        mGuiModeStates[GM_Console] = GuiModeState(mConsole);
 
         bool questList = mResourceSystem->getVFS()->exists("textures/tx_menubook_options_over.dds");
         mJournal = JournalWindow::create(JournalViewModel::create (), questList);
+        mGuiModeStates[GM_Journal] = GuiModeState(mJournal);
+
         mMessageBoxManager = new MessageBoxManager(mStore->get<ESM::GameSetting>().find("fMessageTimePerChar")->getFloat());
-        mInventoryWindow = new InventoryWindow(mDragAndDrop, mViewer->getSceneData()->asGroup(), mResourceSystem);
-        mTradeWindow = new TradeWindow();
-        trackWindow(mTradeWindow, "barter");
         mSpellBuyingWindow = new SpellBuyingWindow();
+        mGuiModeStates[GM_SpellBuying] = GuiModeState(mSpellBuyingWindow);
+
         mTravelWindow = new TravelWindow();
+        mGuiModeStates[GM_Travel] = GuiModeState(mTravelWindow);
+
         mDialogueWindow = new DialogueWindow();
         trackWindow(mDialogueWindow, "dialogue");
+        mGuiModeStates[GM_Dialogue] = GuiModeState(mDialogueWindow);
+
         mContainerWindow = new ContainerWindow(mDragAndDrop);
         trackWindow(mContainerWindow, "container");
+        mGuiModeStates[GM_Container] = GuiModeState({mContainerWindow, mInventoryWindow});
+
         mHud = new HUD(mCustomMarkers, mDragAndDrop, mLocalMapRender);
         mToolTips = new ToolTips();
         mScrollWindow = new ScrollWindow();
+        mGuiModeStates[GM_Scroll] = GuiModeState(mScrollWindow);
+
         mBookWindow = new BookWindow();
+        mGuiModeStates[GM_Book] = GuiModeState(mBookWindow);
+
         mCountDialog = new CountDialog();
         mSettingsWindow = new SettingsWindow();
+        mGuiModeStates[GM_Settings] = GuiModeState(mSettingsWindow);
+
         mConfirmationDialog = new ConfirmationDialog();
+
         mAlchemyWindow = new AlchemyWindow();
         trackWindow(mAlchemyWindow, "alchemy");
-        mSpellWindow = new SpellWindow(mDragAndDrop);
+        mGuiModeStates[GM_Alchemy] = GuiModeState(mAlchemyWindow);
-        trackWindow(mSpellWindow, "spells");
+
         mQuickKeysMenu = new QuickKeysMenu();
+        mGuiModeStates[GM_QuickKeysMenu] = GuiModeState(mQuickKeysMenu);
+
         mLevelupDialog = new LevelupDialog();
+        mGuiModeStates[GM_Levelup] = GuiModeState(mLevelupDialog);
+
         mWaitDialog = new WaitDialog();
+        mGuiModeStates[GM_Rest] = GuiModeState(mWaitDialog);
+        mGuiModeStates[GM_RestBed] = GuiModeState(mWaitDialog);
+
         mSpellCreationDialog = new SpellCreationDialog();
+        mGuiModeStates[GM_SpellCreation] = GuiModeState(mSpellCreationDialog);
+
         mEnchantingDialog = new EnchantingDialog();
+        mGuiModeStates[GM_Enchanting] = GuiModeState(mEnchantingDialog);
+
         mTrainingWindow = new TrainingWindow();
+        mGuiModeStates[GM_Training] = GuiModeState(mTrainingWindow);
+
         mMerchantRepair = new MerchantRepair();
+        mGuiModeStates[GM_MerchantRepair] = GuiModeState(mMerchantRepair);
+
         mRepair = new Repair();
+        mGuiModeStates[GM_Repair] = GuiModeState(mRepair);
+
         mSoulgemDialog = new SoulgemDialog(mMessageBoxManager);
+
         mCompanionWindow = new CompanionWindow(mDragAndDrop, mMessageBoxManager);
         trackWindow(mCompanionWindow, "companion");
+        mGuiModeStates[GM_Companion] = GuiModeState({mInventoryWindow, mCompanionWindow});
+
         mJailScreen = new JailScreen();
+        mGuiModeStates[GM_Jail] = GuiModeState(mJailScreen);
 
         std::string werewolfFaderTex = "textures\\werewolfoverlay.dds";
         if (mResourceSystem->getVFS()->exists(werewolfFaderTex))
@@ -531,109 +583,61 @@ namespace MWGui
     {
         if (!mMap)
             return; // UI not created yet
-        // Start out by hiding everything except the HUD
-        mMap->setVisible(false);
-        mMenu->setVisible(false);
-        mStatsWindow->setVisible(false);
-        mConsole->setVisible(false);
-        mJournal->setVisible(false);
-        mDialogueWindow->setVisible(false);
-        mContainerWindow->setVisible(false);
-        mInventoryWindow->setVisible(false);
-        mScrollWindow->setVisible(false);
-        mBookWindow->setVisible(false);
-        mTradeWindow->setVisible(false);
-        mSpellBuyingWindow->setVisible(false);
-        mTravelWindow->setVisible(false);
-        mSettingsWindow->setVisible(false);
-        mAlchemyWindow->setVisible(false);
-        mSpellWindow->setVisible(false);
-        mQuickKeysMenu->setVisible(false);
-        mLevelupDialog->setVisible(false);
-        mWaitDialog->setVisible(false);
-        mSpellCreationDialog->setVisible(false);
-        mEnchantingDialog->setVisible(false);
-        mTrainingWindow->setVisible(false);
-        mMerchantRepair->setVisible(false);
-        mRepair->setVisible(false);
-        mCompanionWindow->setVisible(false);
-        mInventoryWindow->setTrading(false);
-        mRecharge->setVisible(false);
-        mVideoBackground->setVisible(false);
-        mJailScreen->setVisible(false);
 
-        mHud->setVisible(mHudEnabled && mGuiEnabled);
+        bool loading = (getMode() == GM_Loading || getMode() == GM_LoadingWallpaper);
-        mToolTips->setVisible(mGuiEnabled);
+
+        mHud->setVisible(mHudEnabled && mGuiEnabled && !loading);
+        mToolTips->setVisible(mGuiEnabled && !loading);
 
         bool gameMode = !isGuiMode();
 
         mInputBlocker->setVisible (gameMode);
+
+        if (loading)
+            setCursorVisible(mMessageBoxManager && mMessageBoxManager->isInteractiveMessageBox());
+        else
             setCursorVisible(!gameMode);
 
         if (gameMode)
             setKeyFocusWidget (NULL);
 
-        if (!mGuiEnabled)
-        {
-            if (containsMode(GM_Console))
-                mConsole->setVisible(true);
-            return;
-        }
-
         // Icons of forced hidden windows are displayed
         setMinimapVisibility((mAllowed & GW_Map) && (!mMap->pinned() || (mForceHidden & GW_Map)));
         setWeaponVisibility((mAllowed & GW_Inventory) && (!mInventoryWindow->pinned() || (mForceHidden & GW_Inventory)));
         setSpellVisibility((mAllowed & GW_Magic) && (!mSpellWindow->pinned() || (mForceHidden & GW_Magic)));
         setHMSVisibility((mAllowed & GW_Stats) && (!mStatsWindow->pinned() || (mForceHidden & GW_Stats)));
 
-        // If in game mode (or interactive messagebox), show only the pinned windows
+        // If in game mode (or interactive messagebox), show the pinned windows
         if (mGuiModes.empty())
         {
-            mInventoryWindow->setGuiMode(GM_None);
             mMap->setVisible(mMap->pinned() && !(mForceHidden & GW_Map) && (mAllowed & GW_Map));
             mStatsWindow->setVisible(mStatsWindow->pinned() && !(mForceHidden & GW_Stats) && (mAllowed & GW_Stats));
             mInventoryWindow->setVisible(mInventoryWindow->pinned() && !(mForceHidden & GW_Inventory) && (mAllowed & GW_Inventory));
             mSpellWindow->setVisible(mSpellWindow->pinned() && !(mForceHidden & GW_Magic) && (mAllowed & GW_Magic));
-
             return;
         }
 
-        if(mGuiModes.size() != 0)
-        {
         GuiMode mode = mGuiModes.back();
 
-            switch(mode) {
+        mInventoryWindow->setTrading(mode == GM_Barter);
-                case GM_QuickKeysMenu:
+        mInventoryWindow->setGuiMode(mode);
-                    mQuickKeysMenu->setVisible (true);
+
-                    break;
+        // For the inventory mode, compute the effective set of windows to show.
-                case GM_MainMenu:
+        // This is controlled both by what windows the
-                    mMenu->setVisible(true);
+        // user has opened/closed (the 'shown' variable) and by what
-                    break;
+        // windows we are allowed to show (the 'allowed' var.)
-                case GM_Settings:
+        int eff = mShown & mAllowed & ~mForceHidden;
-                    mSettingsWindow->setVisible(true);
+        mGuiModeStates[GM_Inventory].mVisibilityMask.resize(4);
-                    break;
+        mGuiModeStates[GM_Inventory].mVisibilityMask[0] = eff & GW_Map;
-                case GM_Console:
+        mGuiModeStates[GM_Inventory].mVisibilityMask[1] = eff & GW_Inventory;
-                    mConsole->setVisible(true);
+        mGuiModeStates[GM_Inventory].mVisibilityMask[2] = eff & GW_Magic;
-                    break;
+        mGuiModeStates[GM_Inventory].mVisibilityMask[3] = eff & GW_Stats;
-                case GM_Scroll:
+        if (getMode() == GM_Inventory)
-                    mScrollWindow->setVisible(true);
+            mGuiModeStates[GM_Inventory].update(true);
-                    break;
+
-                case GM_Book:
+        switch (mode)
-                    mBookWindow->setVisible(true);
+        {
-                    break;
+        // FIXME: refactor chargen windows to use modes properly (or not use them at all)
-                case GM_Alchemy:
-                    mAlchemyWindow->setVisible(true);
-                    break;
-                case GM_Rest:
-                    mWaitDialog->setVisible(true);
-                    break;
-                case GM_RestBed:
-                    mWaitDialog->setVisible(true);
-                    mWaitDialog->bedActivated();
-                    break;
-                case GM_Levelup:
-                    mLevelupDialog->setVisible(true);
-                    break;
         case GM_Name:
         case GM_Race:
         case GM_Class:
@@ -644,85 +648,14 @@ namespace MWGui
         case GM_Review:
             mCharGen->spawnDialog(mode);
             break;
-                case GM_Inventory:
+        case GM_RestBed:
-                {
+            // FIXME: use GM_Rest and push the 'bed' argument in some other way
-                    // First, compute the effective set of windows to show.
+            mWaitDialog->bedActivated();
-                    // This is controlled both by what windows the
-                    // user has opened/closed (the 'shown' variable) and by what
-                    // windows we are allowed to show (the 'allowed' var.)
-                    int eff = mShown & mAllowed & ~mForceHidden;
-
-                    // Show the windows we want
-                    mMap            ->setVisible((eff & GW_Map) != 0);
-                    mStatsWindow    ->setVisible((eff & GW_Stats) != 0);
-                    mInventoryWindow->setVisible((eff & GW_Inventory) != 0);
-                    mInventoryWindow->setGuiMode(mode);
-                    mSpellWindow    ->setVisible((eff & GW_Magic) != 0);
-                    break;
-                }
-                case GM_Container:
-                    mContainerWindow->setVisible(true);
-                    mInventoryWindow->setVisible(true);
-                    mInventoryWindow->setGuiMode(mode);
-                    break;
-                case GM_Companion:
-                    mCompanionWindow->setVisible(true);
-                    mInventoryWindow->setVisible(true);
-                    mInventoryWindow->setGuiMode(mode);
-                    break;
-                case GM_Dialogue:
-                    mDialogueWindow->setVisible(true);
-                    break;
-                case GM_Barter:
-                    mInventoryWindow->setVisible(true);
-                    mInventoryWindow->setTrading(true);
-                    mInventoryWindow->setGuiMode(mode);
-                    mTradeWindow->setVisible(true);
-                    break;
-                case GM_SpellBuying:
-                    mSpellBuyingWindow->setVisible(true);
-                    break;
-                case GM_Travel:
-                    mTravelWindow->setVisible(true);
-                    break;
-                case GM_SpellCreation:
-                    mSpellCreationDialog->setVisible(true);
-                    break;
-                case GM_Recharge:
-                    mRecharge->setVisible(true);
-                    break;
-                case GM_Enchanting:
-                    mEnchantingDialog->setVisible(true);
-                    break;
-                case GM_Training:
-                    mTrainingWindow->setVisible(true);
-                    break;
-                case GM_MerchantRepair:
-                    mMerchantRepair->setVisible(true);
-                    break;
-                case GM_Repair:
-                    mRepair->setVisible(true);
-                    break;
-                case GM_Journal:
-                    mJournal->setVisible(true);
-                    break;
-                case GM_Jail:
-                    mJailScreen->setVisible(true);
-                    break;
-                case GM_LoadingWallpaper:
-                case GM_Loading:
-                    // Don't need to show anything here - GM_LoadingWallpaper covers everything else anyway,
-                    // GM_Loading uses a texture of the last rendered frame so everything previously visible will be rendered.
-                    mHud->setVisible(false);
-                    mToolTips->setVisible(false);
-                    setCursorVisible(mMessageBoxManager && mMessageBoxManager->isInteractiveMessageBox());
             break;
         default:
-                    // Unsupported mode, switch back to game
             break;
         }
     }
-    }
 
     void WindowManager::setValue (const std::string& id, const MWMechanics::AttributeValue& value)
     {
@@ -1267,11 +1200,18 @@ namespace MWGui
         mSpellBuyingWindow->center();
     }
 
+    void WindowManager::onCursorChange(const std::string &name)
+    {
+        mCursorManager->cursorChanged(name);
+    }
+
     void WindowManager::pushGuiMode(GuiMode mode)
     {
         if (mode==GM_Inventory && mAllowed==GW_None)
             return;
 
+        if (!mGuiModes.empty() && mGuiModes.back() == mode)
+            return;
 
         // If this mode already exists somewhere in the stack, just bring it to the front.
         if (std::find(mGuiModes.begin(), mGuiModes.end(), mode) != mGuiModes.end())
@@ -1279,23 +1219,29 @@ namespace MWGui
             mGuiModes.erase(std::find(mGuiModes.begin(), mGuiModes.end(), mode));
         }
 
+        if (!mGuiModes.empty())
+            mGuiModeStates[mGuiModes.back()].update(false);
+
         mGuiModes.push_back(mode);
 
+        mGuiModeStates[mode].update(true);
+
         bool gameMode = !isGuiMode();
         MWBase::Environment::get().getInputManager()->changeInputMode(!gameMode);
 
         updateVisible();
     }
 
-    void WindowManager::onCursorChange(const std::string &name)
-    {
-        mCursorManager->cursorChanged(name);
-    }
-
     void WindowManager::popGuiMode()
     {
         if (!mGuiModes.empty())
+        {
+            mGuiModeStates[mGuiModes.back()].update(false);
             mGuiModes.pop_back();
+        }
+
+        if (!mGuiModes.empty())
+            mGuiModeStates[mGuiModes.back()].update(true);
 
         bool gameMode = !isGuiMode();
         MWBase::Environment::get().getInputManager()->changeInputMode(!gameMode);
@@ -1305,6 +1251,12 @@ namespace MWGui
 
     void WindowManager::removeGuiMode(GuiMode mode)
     {
+        if (!mGuiModes.empty() && mGuiModes.back() == mode)
+        {
+            popGuiMode();
+            return;
+        }
+
         std::vector<GuiMode>::iterator it = mGuiModes.begin();
         while (it != mGuiModes.end())
         {
@@ -2214,4 +2166,16 @@ namespace MWGui
         else
             return true;
     }
+
+    void WindowManager::GuiModeState::update(bool visible)
+    {
+        for (unsigned int i=0; i<mWindows.size(); ++i)
+        {
+            bool visibilityMask = true;
+            if (i < mVisibilityMask.size())
+                visibilityMask = mVisibilityMask[i];
+            mWindows[i]->setVisible(visible && visibilityMask);
+        }
+    }
+
 }

apps/openmw/mwgui/windowmanagerimp.hpp

@@ -494,6 +494,25 @@ namespace MWGui
     std::map<int, MWMechanics::SkillValue > mPlayerSkillValues;
 
     MyGUI::Gui *mGui; // Gui
+
+    struct GuiModeState
+    {
+        GuiModeState(WindowBase* window)
+        {
+            mWindows.push_back(window);
+        }
+        GuiModeState(const std::vector<WindowBase*>& windows)
+            : mWindows(windows) {}
+        GuiModeState() {}
+
+        void update(bool visible);
+
+        std::vector<WindowBase*> mWindows;
+        std::vector<bool> mVisibilityMask; // optional, may be used to temporarily exclude windows from this mode.
+    };
+    // Defines the windows that should be shown in a particular GUI mode.
+    std::map<GuiMode, GuiModeState> mGuiModeStates;
+    // The currently active stack of GUI modes (top mode is the one we are in).
     std::vector<GuiMode> mGuiModes;
 
     SDLUtil::SDLCursorManager* mCursorManager;