Merge pull request #2161 from goaaats/feat/stabilize_window_additions

Stabilize WindowSystem additional options menu

Author: goaaats

Dalamud/Configuration/Internal/DalamudConfiguration.cs

@@ -12,6 +12,7 @@
 using Dalamud.Interface.Internal;
 using Dalamud.Interface.Internal.ReShadeHandling;
 using Dalamud.Interface.Style;
+using Dalamud.Interface.Windowing.Persistence;
 using Dalamud.IoC.Internal;
 using Dalamud.Plugin.Internal.AutoUpdate;
 using Dalamud.Plugin.Internal.Profiles;
@@ -264,8 +265,7 @@ internal sealed class DalamudConfiguration : IInternalDisposableService
     /// Gets or sets a value indicating whether or not an additional button allowing pinning and clickthrough options should be shown
     /// on plugin title bars when using the Window System.
     /// </summary>
-    [JsonProperty("EnablePluginUiAdditionalOptionsExperimental")]
-    public bool EnablePluginUiAdditionalOptions { get; set; } = false;
+    public bool EnablePluginUiAdditionalOptions { get; set; } = true;
 
     /// <summary>
     /// Gets or sets a value indicating whether viewports should always be disabled.
@@ -351,6 +351,11 @@ internal sealed class DalamudConfiguration : IInternalDisposableService
     /// </summary>
     public bool ProfilesHasSeenTutorial { get; set; } = false;
 
+    /// <summary>
+    /// Gets or sets the default UI preset.
+    /// </summary>
+    public PresetModel DefaultUiPreset { get; set; } = new();
+
     /// <summary>
     /// Gets or sets the order of DTR elements, by title.
     /// </summary>

Dalamud/Interface/Internal/InterfaceManager.cs

@@ -27,6 +27,8 @@
 using Dalamud.Interface.Style;
 using Dalamud.Interface.Utility;
 using Dalamud.Interface.Windowing;
+using Dalamud.Interface.Windowing.Persistence;
+using Dalamud.IoC.Internal;
 using Dalamud.Logging.Internal;
 using Dalamud.Utility;
 using Dalamud.Utility.Timing;
@@ -60,6 +62,7 @@ namespace Dalamud.Interface.Internal;
 /// This class manages interaction with the ImGui interface.
 /// </summary>
 [ServiceManager.EarlyLoadedService]
+[InherentDependency<WindowSystemPersistence>] // Used by window system windows to restore state from the configuration
 internal partial class InterfaceManager : IInternalDisposableService
 {
     /// <summary>

Dalamud/Interface/Internal/Windows/Settings/Tabs/SettingsTabExperimental.cs

@@ -39,18 +39,6 @@ public class SettingsTabExperimental : SettingsTab
 
         new GapSettingsEntry(5),
 
-        new SettingsEntry<bool>(
-            Loc.Localize(
-                "DalamudSettingEnablePluginUIAdditionalOptions",
-                "Add a button to the title bar of plugin windows to open additional options"),
-            Loc.Localize(
-                "DalamudSettingEnablePluginUIAdditionalOptionsHint",
-                "This will allow you to pin certain plugin windows, make them clickthrough or adjust their opacity.\nThis may not be supported by all of your plugins. Contact the plugin author if you want them to support this feature."),
-            c => c.EnablePluginUiAdditionalOptions,
-            (v, c) => c.EnablePluginUiAdditionalOptions = v),
-
-        new GapSettingsEntry(5),
-
         new ButtonSettingsEntry(
             Loc.Localize("DalamudSettingsClearHidden", "Clear hidden plugins"),
             Loc.Localize(
@@ -65,7 +53,7 @@ public class SettingsTabExperimental : SettingsTab
         new GapSettingsEntry(5, true),
 
         new DevPluginsSettingsEntry(),
-        
+
         new SettingsEntry<bool>(
             Loc.Localize(
                 "DalamudSettingEnableImGuiAsserts",
@@ -75,7 +63,7 @@ public class SettingsTabExperimental : SettingsTab
                 "If this setting is enabled, a window containing further details will be shown when an internal assertion in ImGui fails.\nWe recommend enabling this when developing plugins."),
             c => Service<InterfaceManager>.Get().ShowAsserts,
             (v, _) => Service<InterfaceManager>.Get().ShowAsserts = v),
-        
+
         new SettingsEntry<bool>(
             Loc.Localize(
                 "DalamudSettingEnableImGuiAssertsAtStartup",

Dalamud/Interface/Internal/Windows/Settings/Tabs/SettingsTabLook.cs

@@ -24,7 +24,7 @@ namespace Dalamud.Interface.Internal.Windows.Settings.Tabs;
 [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "Internals")]
 public class SettingsTabLook : SettingsTab
 {
-    private static readonly (string, float)[] GlobalUiScalePresets = 
+    private static readonly (string, float)[] GlobalUiScalePresets =
     {
         ("80%##DalamudSettingsGlobalUiScaleReset96", 0.8f),
         ("100%##DalamudSettingsGlobalUiScaleReset12", 1f),
@@ -107,7 +107,17 @@ private static readonly (string, float)[] GlobalUiScalePresets =
             Loc.Localize("DalamudSettingToggleDockingHint", "This will allow you to fuse and tab plugin windows."),
             c => c.IsDocking,
             (v, c) => c.IsDocking = v),
-        
+
+        new SettingsEntry<bool>(
+            Loc.Localize(
+                "DalamudSettingEnablePluginUIAdditionalOptions",
+                "Add a button to the title bar of plugin windows to open additional options"),
+            Loc.Localize(
+                "DalamudSettingEnablePluginUIAdditionalOptionsHint",
+                "This will allow you to pin certain plugin windows, make them clickthrough or adjust their opacity.\nThis may not be supported by all of your plugins. Contact the plugin author if you want them to support this feature."),
+            c => c.EnablePluginUiAdditionalOptions,
+            (v, c) => c.EnablePluginUiAdditionalOptions = v),
+
         new SettingsEntry<bool>(
             Loc.Localize("DalamudSettingEnablePluginUISoundEffects", "Enable sound effects for plugin windows"),
             Loc.Localize("DalamudSettingEnablePluginUISoundEffectsHint", "This will allow you to enable or disable sound effects generated by plugin user interfaces.\nThis is affected by your in-game `System Sounds` volume settings."),
@@ -125,19 +135,19 @@ private static readonly (string, float)[] GlobalUiScalePresets =
             Loc.Localize("DalamudSettingToggleTsmHint", "This will allow you to access certain Dalamud and Plugin functionality from the title screen.\nDisabling this will also hide the Dalamud version text on the title screen."),
             c => c.ShowTsm,
             (v, c) => c.ShowTsm = v),
-        
+
         new SettingsEntry<bool>(
             Loc.Localize("DalamudSettingInstallerOpenDefault", "Open the Plugin Installer to the \"Installed Plugins\" tab by default"),
             Loc.Localize("DalamudSettingInstallerOpenDefaultHint", "This will allow you to open the Plugin Installer to the \"Installed Plugins\" tab by default, instead of the \"Available Plugins\" tab."),
             c => c.PluginInstallerOpen == PluginInstallerOpenKind.InstalledPlugins,
             (v, c) => c.PluginInstallerOpen = v ? PluginInstallerOpenKind.InstalledPlugins : PluginInstallerOpenKind.AllPlugins),
-        
+
         new SettingsEntry<bool>(
             Loc.Localize("DalamudSettingReducedMotion", "Reduce motions"),
             Loc.Localize("DalamudSettingReducedMotionHint", "This will suppress certain animations from Dalamud, such as the notification popup."),
             c => c.ReduceMotions ?? false,
             (v, c) => c.ReduceMotions = v),
-        
+
         new SettingsEntry<float>(
             Loc.Localize("DalamudSettingImeStateIndicatorOpacity", "IME State Indicator Opacity (CJK only)"),
             Loc.Localize("DalamudSettingImeStateIndicatorOpacityHint", "When any of CJK IMEs is in use, the state of IME will be shown with the opacity specified here."),

Dalamud/Interface/Windowing/Persistence/PresetModel.cs

@@ -0,0 +1,53 @@
+using System.Collections.Generic;
+
+using Newtonsoft.Json;
+
+namespace Dalamud.Interface.Windowing.Persistence;
+
+/// <summary>
+/// Class representing a Window System preset.
+/// </summary>
+internal class PresetModel
+{
+    /// <summary>
+    /// Gets or sets the ID of this preset.
+    /// </summary>
+    [JsonProperty("id")]
+    public Guid Id { get; set; }
+
+    /// <summary>
+    /// Gets or sets the name of this preset.
+    /// </summary>
+    [JsonProperty("n")]
+    public string Name { get; set; } = "New Preset";
+
+    /// <summary>
+    /// Gets or sets a dictionary containing the windows in the preset, mapping their ID to the preset.
+    /// </summary>
+    [JsonProperty("w")]
+    public Dictionary<uint, PresetWindow> Windows { get; set; } = new();
+
+    /// <summary>
+    /// Class representing a window in a preset.
+    /// </summary>
+    internal class PresetWindow
+    {
+        /// <summary>
+        /// Gets or sets a value indicating whether the window is pinned.
+        /// </summary>
+        [JsonProperty("p")]
+        public bool IsPinned { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the window is clickthrough.
+        /// </summary>
+        [JsonProperty("ct")]
+        public bool IsClickThrough { get; set; }
+
+        /// <summary>
+        /// Gets or sets the window's opacity override.
+        /// </summary>
+        [JsonProperty("a")]
+        public float? Alpha { get; set; }
+    }
+}

Dalamud/Interface/Windowing/Persistence/WindowSystemPersistence.cs

@@ -0,0 +1,47 @@
+using Dalamud.Configuration.Internal;
+
+namespace Dalamud.Interface.Windowing.Persistence;
+
+/// <summary>
+/// Class handling persistence for window system windows.
+/// </summary>
+[ServiceManager.EarlyLoadedService]
+internal class WindowSystemPersistence : IServiceType
+{
+    [ServiceManager.ServiceDependency]
+    private readonly DalamudConfiguration config = Service<DalamudConfiguration>.Get();
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="WindowSystemPersistence"/> class.
+    /// </summary>
+    [ServiceManager.ServiceConstructor]
+    public WindowSystemPersistence()
+    {
+    }
+
+    /// <summary>
+    /// Gets the active window system preset.
+    /// </summary>
+    public PresetModel ActivePreset => this.config.DefaultUiPreset;
+
+    /// <summary>
+    /// Get or add a window to the active preset.
+    /// </summary>
+    /// <param name="id">The ID of the window.</param>
+    /// <returns>The preset window instance, or null if the preset does not contain this window.</returns>
+    public PresetModel.PresetWindow? GetWindow(uint id)
+    {
+        return this.ActivePreset.Windows.TryGetValue(id, out var window) ? window : null;
+    }
+
+    /// <summary>
+    /// Persist the state of a window to the active preset.
+    /// </summary>
+    /// <param name="id">The ID of the window.</param>
+    /// <param name="window">The preset window instance.</param>
+    public void SaveWindow(uint id, PresetModel.PresetWindow window)
+    {
+        this.ActivePreset.Windows[id] = window;
+        this.config.QueueSave();
+    }
+}