[ME,DBE] Prevent dragging window off-screen (#373)

Author: starstormhun

src/DynamicBoneEditor.Core/DynamicBoneEditor.cs

@@ -8,6 +8,7 @@
 using KKAPI.Maker;
 using MessagePack;
 using System.Collections.Generic;
+using BepInEx.Configuration;
 #if AI || HS2
 using AIChara;
 #endif
@@ -29,12 +30,16 @@ public class Plugin : BaseUnityPlugin
         internal static new ManualLogSource Logger;
         internal static Plugin PluginInstance;
 
+        public static ConfigEntry<bool> PreventDragout {get; set;}
+
         private void Start()
         {
             Logger = base.Logger;
             PluginInstance = this;
             Harmony.CreateAndPatchAll(typeof(Hooks));
 
+            PreventDragout = Config.Bind("Config", "Prevent Window Dragout", true, "Prevent dragging the DBE window outside of the game window (Requires restart to apply!)");
+
             MakerAPI.MakerBaseLoaded += MakerAPI_MakerBaseLoaded;
             MakerAPI.MakerFinishedLoading += MakerAPI_MakerFinishedLoading;
             MakerAPI.MakerExiting += MakerAPI_MakerExiting;

src/DynamicBoneEditor.Core/UI/DynamicBoneEditor.UI.cs

@@ -90,7 +90,7 @@ public static void InitUI()
             DragPanel = UIUtility.CreatePanel("Draggable", EditorMainPanel.transform);
             DragPanel.transform.SetRect(0f, 1f, 1f, 1f, 0f, -HeaderSize);
             DragPanel.color = Color.gray;
-            UIUtility.MakeObjectDraggable(DragPanel.rectTransform, EditorMainPanel.rectTransform);
+            UIUtility.MakeObjectDraggable(DragPanel.rectTransform, EditorMainPanel.rectTransform, PreventDragout.Value);
 
             var nametext = UIUtility.CreateText("Nametext", DragPanel.transform, "Dynamic Bone Editor");
             nametext.transform.SetRect();

src/MaterialEditor.Base/PluginBase.cs

@@ -79,6 +79,10 @@ public partial class MaterialEditorPluginBase : BaseUnityPlugin
         /// </summary>
         public static ConfigEntry<float> DragSensitivity { get; set; }
         /// <summary>
+        /// Prevent dragging the ME window outside of the game window
+        /// </summary>
+        public static ConfigEntry<bool> PreventDragout { get; set; }
+        /// <summary>
         /// Configuration entry for watching for file changes and reloading textures on change
         /// </summary>
         public static ConfigEntry<bool> WatchTexChanges { get; set; }
@@ -161,6 +165,7 @@ public virtual void Awake()
             UIHeight = Config.Bind("Config", "UI Height", 0.3f, new ConfigDescription("Controls the size of the window.", new AcceptableValueRange<float>(0f, 1f), new ConfigurationManagerAttributes { Order = 5, ShowRangeAsPercent = false }));
             UIListWidth = Config.Bind("Config", "UI List Width", 180f, new ConfigDescription("Controls width of the renderer/materials lists to the side of the window", new AcceptableValueRange<float>(100f, 500f), new ConfigurationManagerAttributes { Order = 4, ShowRangeAsPercent = false }));
             DragSensitivity = Config.Bind("Config", "Drag Sensitivity", 30f, new ConfigDescription("Controls the sensitivity of dragging labels to edit float values", new AcceptableValueRange<float>(1f, 100f), new ConfigurationManagerAttributes { Order = 3, ShowRangeAsPercent = false }));
+            PreventDragout = Config.Bind("Config", "Prevent Window Dragout", true, "Prevent dragging the ME window outside of the game window (Requires restart to apply!)");
             WatchTexChanges = Config.Bind("Config", "Watch File Changes", true, new ConfigDescription("Watch for file changes and reload textures on change. Can be toggled in the UI.", null, new ConfigurationManagerAttributes { Order = 2 }));
             ShaderOptimization = Config.Bind("Config", "Shader Optimization", true, new ConfigDescription("Replaces every loaded shader with the MaterialEditor copy of the shader. Reduces the number of copies of shaders loaded which reduces RAM usage and improves performance.", null, new ConfigurationManagerAttributes { Order = 1 }));
             ExportBakedMesh = Config.Bind("Config", "Export Baked Mesh", false, new ConfigDescription("When enabled, skinned meshes will be exported in their current state with all customization applied as well as in the current pose.", null, new ConfigurationManagerAttributes { Order = 1 }));

src/MaterialEditor.Base/UI/UI.cs

@@ -141,7 +141,7 @@ protected void InitUI()
             DragPanel = UIUtility.CreatePanel("Draggable", MaterialEditorMainPanel.transform);
             DragPanel.transform.SetRect(0f, 1f, 1f, 1f, 0f, -HeaderSize);
             DragPanel.color = Color.gray;
-            UIUtility.MakeObjectDraggable(DragPanel.rectTransform, MaterialEditorMainPanel.rectTransform);
+            UIUtility.MakeObjectDraggable(DragPanel.rectTransform, MaterialEditorMainPanel.rectTransform, PreventDragout.Value);
 
             var nametext = UIUtility.CreateText("Nametext", DragPanel.transform, "Material Editor");
             nametext.transform.SetRect();

src/UIUtility/MovableWindow.cs

@@ -15,6 +15,7 @@ internal class MovableWindow : UIBehaviour, IPointerDownHandler, IDragHandler, I
         public event Action<PointerEventData> OnPointerUpEvent;
 
         public RectTransform ToDrag;
+        public bool PreventDragout;
 
         public void OnPointerDown(PointerEventData eventData)
         {
@@ -28,7 +29,15 @@ public void OnDrag(PointerEventData eventData)
         {
             if (PointerDownCalled == false)
                 return;
-            ToDrag.position = CachedDragPosition + ((Vector2)Input.mousePosition - CachedMousePosition);
+            Vector3 newPos = CachedDragPosition + ((Vector2)Input.mousePosition - CachedMousePosition);
+            if (PreventDragout)
+            {
+                float height = Screen.height * (ToDrag.anchorMax.y - ToDrag.anchorMin.y) + ToDrag.sizeDelta.y;
+                float newX = Mathf.Clamp(newPos.x, 0, Screen.width);
+                float newY = Mathf.Clamp(newPos.y, height / 2, Screen.height - height / 2);
+                newPos = new Vector3(newX, newY, newPos.z);
+            }
+            ToDrag.position = newPos;
             OnDragEvent?.Invoke(eventData);
         }
 

src/UIUtility/UIUtility.cs

@@ -334,10 +334,11 @@ public static Image AddImageToObject(Transform t, Sprite sprite = null)
             return i;
         }
 
-        public static MovableWindow MakeObjectDraggable(RectTransform clickableDragZone, RectTransform draggableObject)
+        public static MovableWindow MakeObjectDraggable(RectTransform clickableDragZone, RectTransform draggableObject, bool preventDragout = false)
         {
             MovableWindow mv = clickableDragZone.gameObject.AddComponent<MovableWindow>();
             mv.ToDrag = draggableObject;
+            mv.PreventDragout = preventDragout;
             return mv;
         }
     }