better tooltip positioning (so tooltips don't cover the text they're annotating)

Author: pandinocoder

Intersect.Client.Core/Core/Input.cs

@@ -374,13 +374,14 @@ MouseButton mouseButton
         return invocationList.Any(interceptor => interceptor(modifier, mouseButton));
     }
 
-    public static void OnMouseDown(Keys modifier, MouseButton mouseButton)
+    public static bool TestInterceptMouse(Keys modifier, MouseButton mouseButton, bool down)
     {
-        if (InvokeMouseButtonInterceptors(MouseDownIntercept, modifier, mouseButton))
-        {
-            return;
-        }
+        return modifier != Keys.Alt &&
+               InvokeMouseButtonInterceptors(down ? MouseDownIntercept : MouseUpIntercept, modifier, mouseButton);
+    }
 
+    public static void OnMouseDown(Keys modifier, MouseButton mouseButton)
+    {
         var key = Keys.None;
         switch (mouseButton)
         {
@@ -465,11 +466,6 @@ public static void OnMouseDown(Keys modifier, MouseButton mouseButton)
 
     public static void OnMouseUp(Keys modifier, MouseButton mouseButton)
     {
-        if (InvokeMouseButtonInterceptors(MouseUpIntercept, modifier, mouseButton))
-        {
-            return;
-        }
-
         var key = Keys.LButton;
         switch (mouseButton)
         {

Intersect.Client.Core/Interface/Debugging/DebugWindow.cs

@@ -288,6 +288,7 @@ private LabeledCheckBox CreateInfoCheckboxViewClickedNodeInDebugger(Base parent)
             Font = _defaultFont,
             IsChecked = _viewClickedNodeInDebugger,
             Text = Strings.Debug.ViewClickedNodeInDebugger,
+            TooltipText = Strings.Debug.ViewClickedNodeInDebuggerTooltip,
         };
 
         checkbox.CheckChanged += (_, _) =>

Intersect.Client.Core/Localization/Strings.cs

@@ -945,6 +945,9 @@ public partial struct Debug
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public static LocalizedString ViewClickedNodeInDebugger = @"View Clicked Node in Debugger";
 
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+        public static LocalizedString ViewClickedNodeInDebuggerTooltip = @"Hold Alt to temporarily turn this off (so you can turn off this option)";
+
         [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
         public static LocalizedString EntitiesDrawn = @"Entities Drawn";
 

Intersect.Client.Core/MonoGame/Input/MonoInput.cs

@@ -199,6 +199,11 @@ private void CheckMouseButton(Keys modifier, ButtonState bs, MouseButton mb)
 
         if (bs == ButtonState.Pressed && !MouseButtonDown(mb))
         {
+            if (Core.Input.TestInterceptMouse(modifier, mb, down: true))
+            {
+                return;
+            }
+
             Interface.Interface.GwenInput.ProcessMessage(
                 new GwenInputMessage(IntersectInput.InputEvent.MouseDown, GetMousePosition(), mb, Keys.Alt)
             );
@@ -207,6 +212,11 @@ private void CheckMouseButton(Keys modifier, ButtonState bs, MouseButton mb)
         }
         else if (bs == ButtonState.Released && MouseButtonDown(mb))
         {
+            if (Core.Input.TestInterceptMouse(modifier, mb, down: false))
+            {
+                return;
+            }
+
             Interface.Interface.GwenInput.ProcessMessage(
                 new GwenInputMessage(IntersectInput.InputEvent.MouseUp, GetMousePosition(), mb, Keys.Alt)
             );

Intersect.Client.Framework/Gwen/Control/Base.cs

@@ -717,9 +717,9 @@ public Cursor Cursor
 
     public int GlobalY => Y + (Parent?.GlobalY ?? 0);
 
-    public Point PositionGlobal => new Point(X, Y) + (Parent?.PositionGlobal ?? Point.Empty);
+    public Point PositionGlobal => new Point(X, Y) + (mActualParent?.PositionGlobal ?? Point.Empty);
 
-    public Rectangle BoundsGlobal => new Rectangle(PositionGlobal, Size);
+    public Rectangle BoundsGlobal => new(PositionGlobal, Size);
 
     /// <summary>
     ///     Indicates whether the control is tabable (can be focused by pressing Tab).
@@ -1886,6 +1886,26 @@ public virtual Base Find(Predicate<Base> predicate, bool recurse = false)
             : default;
     }
 
+    public (Base Highest, Base Closest)? FindMatchingNodes<TComponent>() where TComponent : class
+    {
+        Base? highest = null;
+        Base? closest = null;
+        Base? currentComponent = this;
+
+        while (currentComponent is not null)
+        {
+            if (currentComponent is TComponent)
+            {
+                closest ??= currentComponent;
+                highest = currentComponent;
+            }
+
+            currentComponent = currentComponent.Parent;
+        }
+
+        return (highest is null || closest is null) ? null : (highest, closest);
+    }
+
     /// <summary>
     /// Finds all children that match the predicate.
     /// </summary>

Intersect.Client.Framework/Gwen/Control/LabeledCheckBox.cs

@@ -8,7 +8,7 @@ namespace Intersect.Client.Framework.Gwen.Control;
 /// <summary>
 ///     CheckBox with label.
 /// </summary>
-public partial class LabeledCheckBox : Base
+public partial class LabeledCheckBox : Base, ITextContainer
 {
     private readonly Checkbox _checkbox;
 
@@ -129,6 +129,8 @@ public string? Text
         set => _label.Text = value;
     }
 
+    public Color? TextPaddingDebugColor { get; set; }
+
     /// <summary>
     ///     Invoked when the control has been checked.
     /// </summary>

Intersect.Client.Framework/Gwen/Control/LabeledComboBox.cs

@@ -4,7 +4,7 @@
 
 namespace Intersect.Client.Framework.Gwen.Control;
 
-public partial class LabeledComboBox : Base, IAutoSizeToContents
+public partial class LabeledComboBox : Base, IAutoSizeToContents, ITextContainer
 {
     private readonly ComboBox _comboBox;
     private readonly Label _label;
@@ -112,4 +112,12 @@ protected override void OnChildBoundsChanged(Base child, Rectangle oldChildBound
 
         Invalidate();
     }
+
+    string? ITextContainer.Text
+    {
+        get => _label.Text;
+        set => _label.Text = value;
+    }
+
+    public Color? TextPaddingDebugColor { get; set; }
 }

Intersect.Client.Framework/Gwen/Control/LabeledRadioButton.cs

@@ -7,7 +7,7 @@ namespace Intersect.Client.Framework.Gwen.Control;
 /// <summary>
 ///     RadioButton with label.
 /// </summary>
-public partial class LabeledRadioButton : Base
+public partial class LabeledRadioButton : Base, ITextContainer
 {
 
     private readonly Label mLabel;
@@ -45,12 +45,14 @@ public LabeledRadioButton(Base parent) : base(parent)
     /// <summary>
     ///     Label text.
     /// </summary>
-    public string Text
+    public string? Text
     {
         get => mLabel.Text;
         set => mLabel.Text = value;
     }
 
+    public Color? TextPaddingDebugColor { get; set; }
+
     // todo: would be nice to remove that
     internal RadioButton RadioButton => mRadioButton;
 

Intersect.Client.Framework/Gwen/Control/LabeledSlider.cs

@@ -7,7 +7,7 @@
 
 namespace Intersect.Client.Framework.Gwen.Control;
 
-public partial class LabeledSlider : Base, IAutoSizeToContents, INumericInput
+public partial class LabeledSlider : Base, IAutoSizeToContents, INumericInput, ITextContainer
 {
     private readonly Label _label;
     private readonly Slider _slider;
@@ -343,4 +343,12 @@ public override void Focus(bool moveMouse = false)
     {
         base.Focus(moveMouse);
     }
+
+    public string? Text
+    {
+        get => _label.Text;
+        set => _label.Text = value;
+    }
+
+    public Color? TextPaddingDebugColor { get; set; }
 }

Intersect.Client.Framework/Gwen/ToolTip.cs

@@ -63,12 +63,13 @@ public static void ControlDeleted(Base control)
     /// <param name="skin"></param>
     public static void RenderToolTip(Skin.Base skin)
     {
-        if (_activeTooltipParent?.Tooltip == default)
+        var activeTooltipParent = _activeTooltipParent;
+        if (activeTooltipParent?.Tooltip == default)
         {
             return;
         }
 
-        var canvas = _activeTooltipParent.Canvas;
+        var canvas = activeTooltipParent.Canvas;
         if (canvas == default)
         {
             return;
@@ -78,23 +79,47 @@ public static void RenderToolTip(Skin.Base skin)
 
         var oldRenderOffset = render.RenderOffset;
         var mousePos = Input.InputHandler.MousePosition;
-        var bounds = _activeTooltipParent.Tooltip.Bounds;
+        var tooltipBounds = activeTooltipParent.Tooltip.Bounds;
 
         var offset = Util.FloatRect(
-            mousePos.X - bounds.Width * 0.5f,
-            mousePos.Y - bounds.Height,
-            bounds.Width,
-            bounds.Height
+            mousePos.X - tooltipBounds.Width * 0.5f,
+            mousePos.Y - tooltipBounds.Height,
+            tooltipBounds.Width,
+            tooltipBounds.Height
         );
 
-        offset = Util.ClampRectToRect(offset, canvas.Bounds);
+        var textContainerMatch = activeTooltipParent.FindMatchingNodes<ITextContainer>();
+
+        if (textContainerMatch is { Highest: { } highest, Closest: { } closest })
+        {
+            var closestBounds = closest.BoundsGlobal;
+            var highestBounds = highest.BoundsGlobal;
+            if (highestBounds.Top > tooltipBounds.Height)
+            {
+                offset.Y = highestBounds.Top - tooltipBounds.Height;
+            }
+            else
+            {
+                // TODO: check if we have enough space below
+                offset.Y = highestBounds.Bottom;
+            }
+
+            offset.X = highestBounds.X + (highestBounds.Width - tooltipBounds.Width) / 2;
+            var closestBoundsX = closestBounds.X + closestBounds.Width * 0.25f;
+            if (offset.X > closestBoundsX)
+            {
+                offset.X = closestBounds.X + (closestBounds.Width - tooltipBounds.Width) / 2;
+            }
+        }
+
+        var clampedOffset = Util.ClampRectToRect(offset, canvas.Bounds);
 
         //Calculate offset on screen bounds
-        render.AddRenderOffset(offset);
+        render.AddRenderOffset(clampedOffset);
         render.EndClip();
 
-        skin.DrawToolTip(_activeTooltipParent.Tooltip);
-        _activeTooltipParent.Tooltip.DoRender(skin);
+        skin.DrawToolTip(activeTooltipParent.Tooltip);
+        activeTooltipParent.Tooltip.DoRender(skin);
 
         render.RenderOffset = oldRenderOffset;
     }