Palette: added saving / loading window position and moving it to a free space (#4982)

* added saving / loading window position and moving it to a free space

* fix

* added separated method to beginning window

* added struct for parameters

Author: ABSitf

source/MRViewer/ImGuiHelpers.cpp

@@ -551,32 +551,23 @@ float GetTitleBarHeght( float menuScaling )
     return 2 * MR::cRibbonItemInterval * menuScaling + ImGui::GetTextLineHeight() + 2 * ImGui::GetStyle().WindowBorderSize * menuScaling;
 }
 
-bool BeginCustomStatePlugin( const char* label, bool* open, const CustomStatePluginWindowParameters& params )
+std::pair<ImVec2, bool> LoadSavedWindowPos( const char* label, ImGuiWindow* window, float width, const ImVec2* position /*= nullptr*/ )
 {
-    const auto& style = ImGui::GetStyle();
-
-    const float borderSize = style.WindowBorderSize * params.menuScaling;
-    const float titleBarHeight = GetTitleBarHeght( params.menuScaling );
-    auto height = params.height;
-    if ( params.collapsed && *params.collapsed )
-        height = titleBarHeight;
-
-    ImGui::PushStyleVar( ImGuiStyleVar_ItemSpacing, ImVec2( 12 * params.menuScaling, 8 * params.menuScaling ) );
+    bool haveSavedWindowPos = false;
+    ImVec2 initialWindowPos;
 
-    ImGuiWindow* window = FindWindowByName( label );
     auto menu = ImGuiMenu::instance();
-    ImVec2 initialWindowPos;
-    bool haveSavedWindowPos = false;
     bool windowIsInactive = window && !window->WasActive;
+
     if ( !window || windowIsInactive )
     {
-        auto ribMenu = std::dynamic_pointer_cast<MR::RibbonMenu>( menu );
-        float xPos = GetIO().DisplaySize.x - params.width;
+        auto ribMenu = std::dynamic_pointer_cast< MR::RibbonMenu >( menu );
+        float xPos = GetIO().DisplaySize.x - width;
         float yPos = 0.0f;
-        if ( params.position )
+        if ( position )
         {
-            xPos = params.position->x;
-            yPos = params.position->y;
+            xPos = position->x;
+            yPos = position->y;
         }
         else if ( ribMenu )
             yPos = ( ribMenu->getTopPanelOpenedHeight() - 1.0f ) * menu->menu_scaling();
@@ -600,7 +591,46 @@ bool BeginCustomStatePlugin( const char* label, bool* open, const CustomStatePlu
             initialWindowPos = ImVec2( xPos, yPos );
         }
     }
+    return { initialWindowPos, haveSavedWindowPos };
+}
 
+void SaveWindowPosition( const char* label, ImGuiWindow* window )
+{
+    if ( window )
+    {
+        auto& config = Config::instance();
+        auto dpJson = config.getJsonValue( "DialogPositions" );
+        serializeToJson( Vector2i{ int( window->Pos.x ), int( window->Pos.y ) }, dpJson[label] );
+        config.setJsonValue( "DialogPositions", dpJson );
+    }
+}
+
+bool BeginSavedWindowPos( const std::string& name, bool* open, const SavedWindowPosParams& params )
+{
+    ImGuiWindow* window = ImGui::FindWindowByName( name.c_str() );
+    auto [initialWindowPos, haveSavedWindowPos] = LoadSavedWindowPos( name.c_str(), window, params.size.y, params.pos );
+    UI::getDefaultWindowRectAllocator().setFreeNextWindowPos( name.c_str(), initialWindowPos, haveSavedWindowPos ? ImGuiCond_FirstUseEver : ImGuiCond_Appearing, ImVec2( 0, 0 ) );
+    ImGui::SetNextWindowSize( params.size, ImGuiCond_Appearing );
+    const bool res = Begin( name.c_str(), open, params.flags );
+    SaveWindowPosition( name.c_str(), window);
+    return res;
+}
+
+bool BeginCustomStatePlugin( const char* label, bool* open, const CustomStatePluginWindowParameters& params )
+{
+    const auto& style = ImGui::GetStyle();
+
+    const float borderSize = style.WindowBorderSize * params.menuScaling;
+    const float titleBarHeight = GetTitleBarHeght( params.menuScaling );
+    auto height = params.height;
+    if ( params.collapsed && *params.collapsed )
+        height = titleBarHeight;
+
+    ImGui::PushStyleVar( ImGuiStyleVar_ItemSpacing, ImVec2( 12 * params.menuScaling, 8 * params.menuScaling ) );
+
+    ImGuiWindow* window = FindWindowByName( label );
+    auto menu = ImGuiMenu::instance();
+    auto [initialWindowPos, haveSavedWindowPos] = LoadSavedWindowPos( label, params.width, params.position );
     UI::getDefaultWindowRectAllocator().setFreeNextWindowPos( label, initialWindowPos, haveSavedWindowPos ? ImGuiCond_FirstUseEver : ImGuiCond_Appearing, haveSavedWindowPos ? ImVec2( 0, 0 ) : params.pivot );
 
     if ( params.changedSize )

source/MRViewer/ImGuiHelpers.h

@@ -205,8 +205,43 @@ struct CustomStatePluginWindowParameters
 /// for a value pivot = ( 0.0f, 1.0f )
 MRVIEWER_API ImVec2 GetDownPosition( const float width );
 
-// Calculate and return the height of the window title
+/// Calculate and return the height of the window title
 MRVIEWER_API float GetTitleBarHeght( float menuScaling );
+
+/// Load saved window position, if possible
+/// \details if can't load - get \p position (if setted) or default (upper-right viewport corner)
+/// see also \ref SaveWindowPosition
+/// \param label window label
+/// \param width window width
+/// \param position (optional) preliminary window position
+/// \return pair of the final position of the window and flag whether the position was loaded
+MRVIEWER_API std::pair<ImVec2, bool> LoadSavedWindowPos( const char* label, ImGuiWindow* window, float width, const ImVec2* position = nullptr );
+inline std::pair<ImVec2, bool> LoadSavedWindowPos( const char* label, float width, const ImVec2* position = nullptr )
+{
+    return LoadSavedWindowPos( label, FindWindowByName( label ), width, position );
+}
+/// Save window position
+/// \details saved only if window exist
+/// see also \ref LoadSavedWindowPos
+MRVIEWER_API void SaveWindowPosition( const char* label, ImGuiWindow* window );
+inline void SaveWindowPosition( const char* label )
+{
+    SaveWindowPosition( label, FindWindowByName( label ) );
+}
+
+/// Parameters drawing classic ImGui::Begin with loading / saving window position
+struct SavedWindowPosParams
+{
+    /// window size
+    ImVec2 size = { -1, -1 };
+    /// (optional) preliminary window position
+    const ImVec2* pos = 0;
+    ImGuiWindowFlags flags = 0;
+};
+/// Same as ImGui::Begin, but with loading and saving the window position
+/// \details see also \ref LoadSavedWindowPos and \ref SaveWindowPosition
+MRVIEWER_API bool BeginSavedWindowPos( const std::string& name, bool* open, const SavedWindowPosParams& params );
+
 /// begin state plugin window with custom style.  if you use this function, you must call EndCustomStatePlugin to close the plugin correctly.
 /// the flags ImGuiWindowFlags_NoScrollbar and ImGuiWindow_NoScrollingWithMouse are forced in the function.
 MRVIEWER_API bool BeginCustomStatePlugin( const char* label, bool* open, const CustomStatePluginWindowParameters& params = {} );

source/MRViewer/MRPalette.cpp

@@ -5,6 +5,8 @@
 #include "MRViewer/MRViewer.h"
 #include "imgui_internal.h"
 #include "MRViewport.h"
+#include "MRUIRectAllocator.h"
+#include "MRMesh/MRConfig.h"
 #include "MRMesh/MRSerializer.h"
 #include "MRMesh/MRSceneColors.h"
 #include "MRMesh/MRSystem.h"
@@ -376,9 +378,6 @@ void Palette::draw( const std::string& windowName, const ImVec2& pose, const ImV
     const auto menu = ImGuiMenu::instance();
     const auto& viewportSize = Viewport::get().getViewportRect();
 
-    ImGui::SetNextWindowPos( pose, ImGuiCond_Appearing );
-    ImGui::SetNextWindowSize( size, ImGuiCond_Appearing );
-
     const auto style = getStyleVariables_( menu->menu_scaling() );
     const auto maxLabelWidth = getMaxLabelWidth_( onlyTopHalf );
     const ImVec2 windowSizeMin {
@@ -421,9 +420,7 @@ void Palette::draw( const std::string& windowName, const ImVec2& pose, const ImV
             prevMaxLabelWidth_ = maxLabelWidth;
         }
     }
-
-    ImGui::Begin( windowName.c_str(), &isWindowOpen_,
-        ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoBackground );
+    ImGui::BeginSavedWindowPos( windowName, &isWindowOpen_, { size, &pose, ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoBackground } );
 
     MR_FINALLY{ ImGui::End(); };