Improve in-game window positioning

1) Remember the window position set by a move and try to restore this
   position after every resize.
2) If the window is moved to a screen edge save Point::MaxElementValue
   instead, to make the window "stick" to the edge when resizing.

Author: falbrechtskirchinger

libs/s25main/Settings.cpp

@@ -347,10 +347,13 @@ void Settings::LoadIngame()
             const auto* iniWindow = static_cast<const libsiedler2::ArchivItem_Ini*>(settingsIngame.find(window.second));
             if(!iniWindow)
                 continue;
-            windows.persistentSettings[window.first].lastPos.x = iniWindow->getIntValue("pos_x");
-            windows.persistentSettings[window.first].lastPos.y = iniWindow->getIntValue("pos_y");
-            windows.persistentSettings[window.first].isOpen = iniWindow->getIntValue("is_open");
-            windows.persistentSettings[window.first].isMinimized = iniWindow->getValue("is_minimized", false);
+            auto& settings = windows.persistentSettings[window.first];
+            const auto lastPos = settings.lastPos =
+              DrawPoint(iniWindow->getIntValue("pos_x"), iniWindow->getIntValue("pos_y"));
+            settings.restorePos = DrawPoint(iniWindow->getValue("restore_pos_x", lastPos.x),
+                                            iniWindow->getValue("restore_pos_y", lastPos.y));
+            settings.isOpen = iniWindow->getIntValue("is_open");
+            settings.isMinimized = iniWindow->getValue("is_minimized", false);
         }
     } catch(std::runtime_error& e)
     {
@@ -500,10 +503,17 @@ void Settings::SaveIngame()
         auto* iniWindow = static_cast<libsiedler2::ArchivItem_Ini*>(settingsIngame.find(window.second));
         if(!iniWindow)
             continue;
-        iniWindow->setValue("pos_x", windows.persistentSettings[window.first].lastPos.x);
-        iniWindow->setValue("pos_y", windows.persistentSettings[window.first].lastPos.y);
-        iniWindow->setValue("is_open", windows.persistentSettings[window.first].isOpen);
-        iniWindow->setValue("is_minimized", windows.persistentSettings[window.first].isMinimized);
+        const auto& settings = windows.persistentSettings[window.first];
+        iniWindow->setValue("pos_x", settings.lastPos.x);
+        iniWindow->setValue("pos_y", settings.lastPos.y);
+        if(settings.restorePos != settings.lastPos)
+        {
+            // only save if different; defaults to lastPos on load
+            iniWindow->setValue("restore_pos_x", settings.restorePos.x);
+            iniWindow->setValue("restore_pos_y", settings.restorePos.y);
+        }
+        iniWindow->setValue("is_open", settings.isOpen);
+        iniWindow->setValue("is_minimized", settings.isMinimized);
     }
 
     bfs::path settingsPathIngame = RTTRCONFIG.ExpandPath(s25::resources::ingameOptions);

libs/s25main/Settings.h

@@ -25,6 +25,7 @@ bool checkPort(int port);
 struct PersistentWindowSettings
 {
     DrawPoint lastPos = DrawPoint::Invalid();
+    DrawPoint restorePos = DrawPoint::Invalid();
     bool isOpen = false;
     bool isMinimized = false;
 };

libs/s25main/ingameWindows/IngameWindow.cpp

@@ -51,25 +51,32 @@ IngameWindow::IngameWindow(unsigned id, const DrawPoint& pos, const Extent& size
     // Save to settings that window is open
     SaveOpenStatus(true);
 
-    // Restore minimized state
-    if(windowSettings_ && windowSettings_->isMinimized)
+    if(windowSettings_)
     {
-        isMinimized_ = true;
-        Extent minimizedSize(GetSize().x, contentOffset.y + contentOffsetEnd.y);
-        Window::Resize(minimizedSize);
+        // Restore minimized state
+        if(windowSettings_ && windowSettings_->isMinimized)
+        {
+            isMinimized_ = true;
+            Extent minimizedSize(GetSize().x, contentOffset.y + contentOffsetEnd.y);
+            Window::Resize(minimizedSize);
+        }
+        // Load restorePos
+        restorePos_ = windowSettings_->restorePos;
     }
 
     // Load last position or center the window
     if(pos == posLastOrCenter)
     {
         if(windowSettings_ && windowSettings_->lastPos.isValid())
-            SetPos(windowSettings_->lastPos);
+            SetPos(windowSettings_->lastPos, !restorePos_.isValid());
         else
             MoveToCenter();
     } else if(pos == posCenter)
         MoveToCenter();
     else if(pos == posAtMouse)
         MoveNextToMouse();
+    else
+        SetPos(pos); // always call SetPos() to update restorePos
 }
 
 void IngameWindow::Resize(const Extent& newSize)
@@ -81,15 +88,23 @@ void IngameWindow::Resize(const Extent& newSize)
 
 void IngameWindow::SetIwSize(const Extent& newSize)
 {
+    // Is the window connecting with the bottom screen edge?
+    const auto atBottom = (GetPos().y + GetSize().y) >= VIDEODRIVER.GetRenderSize().y;
+
     iwHeight = newSize.y;
     Extent wndSize = newSize;
     if(isMinimized_)
         wndSize.y = 0;
     wndSize += contentOffset + contentOffsetEnd;
     Window::Resize(wndSize);
 
-    // Reset the position to check if parts of the window are out of the visible area
-    SetPos(GetPos());
+    // Adjust restorePos if the window was connecting with the bottom screen edge before being minimized
+    const auto pos = (atBottom && isMinimized_) ? DrawPoint(restorePos_.x, DrawPoint::MaxElementValue) : restorePos_;
+
+    // Reset the position
+    // 1) to check if parts of the window are out of the visible area
+    // 2) to re-connect the window with the bottom screen edge, if needed
+    SetPos(pos, false);
 }
 
 Extent IngameWindow::GetIwSize() const
@@ -102,24 +117,38 @@ DrawPoint IngameWindow::GetRightBottomBoundary()
     return DrawPoint(GetSize() - contentOffsetEnd);
 }
 
-void IngameWindow::SetPos(DrawPoint newPos)
+void IngameWindow::SetPos(DrawPoint newPos, bool saveRestorePos)
 {
     const Extent screenSize = VIDEODRIVER.GetRenderSize();
+    DrawPoint newRestorePos = newPos;
     // Too far left or right?
     if(newPos.x < 0)
-        newPos.x = 0;
-    else if(newPos.x + GetSize().x > screenSize.x)
+        newRestorePos.x = newPos.x = 0;
+    else if(newPos.x + GetSize().x >= screenSize.x)
+    {
         newPos.x = screenSize.x - GetSize().x;
+        newRestorePos.x = DrawPoint::MaxElementValue; // make window stick to the right
+    }
 
     // Too high or low?
     if(newPos.y < 0)
-        newPos.y = 0;
-    else if(newPos.y + GetSize().y > screenSize.y)
+        newRestorePos.y = newPos.y = 0;
+    else if(newPos.y + GetSize().y >= screenSize.y)
+    {
         newPos.y = screenSize.y - GetSize().y;
+        newRestorePos.y = DrawPoint::MaxElementValue; // make window stick to the bottom
+    }
 
-    // if possible save the position to settings
+    if(saveRestorePos)
+        restorePos_ = newRestorePos;
+
+    // if possible save the positions to settings
     if(windowSettings_)
+    {
         windowSettings_->lastPos = newPos;
+        if(saveRestorePos)
+            windowSettings_->restorePos = newRestorePos;
+    }
 
     Window::SetPos(newPos);
 }

libs/s25main/ingameWindows/IngameWindow.h

@@ -4,6 +4,7 @@
 
 #pragma once
 
+#include "DrawPoint.h"
 #include "Window.h"
 #include "helpers/EnumArray.h"
 #include "gameData/const_gui_ids.h"
@@ -71,7 +72,7 @@ class IngameWindow : public Window
     DrawPoint GetRightBottomBoundary();
 
     /// Set the position for the window after adjusting newPos so the window is in the visible area
-    void SetPos(DrawPoint newPos);
+    void SetPos(DrawPoint newPos, bool saveRestorePos = true);
 
     /// merkt das Fenster zum Schließen vor.
     virtual void Close();
@@ -128,4 +129,5 @@ class IngameWindow : public Window
     CloseBehavior closeBehavior_;
     helpers::EnumArray<ButtonState, IwButton> buttonStates_;
     PersistentWindowSettings* windowSettings_;
+    DrawPoint restorePos_;
 };

libs/s25main/ingameWindows/iwObservate.cpp

@@ -143,11 +143,6 @@ void iwObservate::Msg_ButtonClick(const unsigned ctrl_id)
             for(unsigned i = 1; i <= 4; ++i)
                 GetCtrl<ctrlImageButton>(i)->SetPos(
                   DrawPoint(GetCtrl<ctrlImageButton>(i)->GetPos().x - diff, GetSize().y - 50));
-
-            DrawPoint maxPos(VIDEODRIVER.GetRenderSize() - GetSize() - Extent::all(1));
-            DrawPoint newPos = elMin(maxPos, GetPos());
-            if(newPos != GetPos())
-                SetPos(newPos);
     }
 }