RT Patches for UI improvements (#4841)

* fix up buttons

* wah

* ough

* huhwuhuahsdhsfdj

* loud incorrect buzzer

* wawa

* Allow XmlnsDefinition

* wawa

* Release notes.

* Expose keybind loading.

* address reviews and other things

---------

Co-authored-by: moonheart08 <moonheart08@users.noreply.github.com>
Co-authored-by: Pieter-Jan Briers <pieterjan.briers+git@gmail.com>

RELEASE-NOTES.md

@@ -39,12 +39,28 @@ END TEMPLATE-->
 
 ### New features
 
+* Controls can now hook before, after, and during rendering of their children.
+* IRenderHandle is now a public API, with the caveat that it's properties and methods are unstable.
+* ButtonGroup now exposes what buttons it contains, alongside which is currently pressed.
+* OptionButton has additional styleclasses, and has a hook for modifying it's internal buttons.
+* PanelContainer.GetStyleBox() is now protected rather than private.
+* TextureButton now uses a TextureRect instead of custom drawing code.
+* TextureRect has additional style properties exposed.
+    * A new property, TextureSizeTarget, was added, which allows specifying a size in virtual pixels that the control should attempt to draw at.
+    * Stretch mode is now a style property.
+    * Scale is now a style property.
+* Avalonia.Metadata.XmlnsDefinitionAttribute is now permitted by the sandbox.
+* Add MaxDimension property to Box2 to return the higher of the Width or Height.
+* Add GetLocalPosition to convert ScreenCoordinates to coordinates relative to the control. Ignores window.
+* Add GlobalRect and GlobalPixelRect for controls to get their UIBox2i in screen terms.
+* Add dotted line drawing to DrawingHandleScreen.
 * You can use `Subs.CVar()` from an entity systems to subscribe to CVar changes. This is more convenient than `IConfigurationManager.OnValueChanged` as it automatically unsubscribes on system shutdown.
 * There is now a built-in type serializer for `DateTime`, so you can put `DateTime`s in your data fields.
 
 ### Bugfixes
 
-*None yet*
+* UI drawing now properly accounts for a control's draw routine potentially mangling the current matrix.
+* UI roots now properly update when the global stylesheet is changed. They previously only did so if they had a dedicated stylesheet (which is the one case where they would be unaffected by a global sheet update.
 
 ### Other
 

Robust.Client/GameObjects/ClientEntityManager.Network.cs

@@ -42,6 +42,8 @@ public sealed partial class ClientEntityManager
         var pending = PendingNetEntityStates.GetOrNew(nEntity);
         pending.Add((typeof(T), callerEntity));
 
+
+
         return entity.Item1;
     }
 

Robust.Client/Graphics/IRenderHandle.cs

@@ -6,7 +6,10 @@ using Robust.Shared.Maths;
 
 namespace Robust.Client.Graphics
 {
-    internal interface IRenderHandle
+    /// <remarks>
+    ///     Unstable API. Likely to break hard during renderer rewrite if you rely on it.
+    /// </remarks>
+    public interface IRenderHandle
     {
         DrawingHandleScreen DrawingHandleScreen { get; }
         DrawingHandleWorld DrawingHandleWorld { get; }

Robust.Client/Input/InputManager.cs

@@ -126,7 +126,7 @@ namespace Robust.Client.Input
             {
                 try
                 {
-                    LoadKeyFile(path, true);
+                    LoadKeyFile(path, false, true);
                 }
                 catch (Exception e)
                 {
@@ -136,7 +136,7 @@ namespace Robust.Client.Input
 
             if (_resourceMan.ContentFileExists(path))
             {
-                LoadKeyFile(path, false);
+                LoadKeyFile(path, true);
             }
         }
 
@@ -496,7 +496,13 @@ namespace Robust.Client.Input
             return true;
         }
 
-        private void LoadKeyFile(ResPath file, bool userData)
+        /// <summary>
+        /// Loads a keybind file, configuring keybinds.
+        /// </summary>
+        /// <param name="file">File to load from the content package</param>
+        /// <param name="defaultRegistration">Whether or not this is a "default" keybind set. If it is, then it won't override the current configuration, only the defaults.</param>
+        /// <param name="userData">Whether or not to load from the user data directory instead of the content package.</param>
+        public void LoadKeyFile(ResPath file, bool defaultRegistration, bool userData = false)
         {
             TextReader reader;
             if (userData)
@@ -526,7 +532,7 @@ namespace Robust.Client.Input
                         continue;
                     }
 
-                    if (!userData)
+                    if (defaultRegistration)
                     {
                         _defaultRegistrations.Add(reg);
 
@@ -538,11 +544,11 @@ namespace Robust.Client.Input
                         }
                     }
 
-                    RegisterBinding(reg, markModified: userData);
+                    RegisterBinding(reg, markModified: defaultRegistration);
                 }
             }
 
-            if (userData && mapping.TryGet("leaveEmpty", out var node))
+            if (!defaultRegistration && mapping.TryGet("leaveEmpty", out var node))
             {
                 var leaveEmpty = _serialization.Read<BoundKeyFunction[]>(node, notNullableOverride: true);
 

Robust.Client/UserInterface/Control.cs

@@ -545,6 +545,36 @@ namespace Robust.Client.UserInterface
             Draw(renderHandle.DrawingHandleScreen);
         }
 
+        protected internal virtual void PreRenderChildren(ref ControlRenderArguments args)
+        {
+
+        }
+
+        protected internal virtual void PostRenderChildren(ref ControlRenderArguments args)
+        {
+
+        }
+
+        protected internal virtual void RenderChildOverride(ref ControlRenderArguments args, int childIndex, Vector2i position)
+        {
+            RenderControl(ref args, childIndex, position);
+        }
+
+        public ref struct ControlRenderArguments
+        {
+            public IRenderHandle Handle;
+            public ref int Total;
+            public Vector2i Position;
+            public Color Modulate;
+            public UIBox2i? ScissorBox;
+            public ref Matrix3 CoordinateTransform;
+        }
+
+        protected void RenderControl(ref ControlRenderArguments args, int childIndex, Vector2i position)
+        {
+            UserInterfaceManagerInternal.RenderControl(args.Handle, ref args.Total, GetChild(childIndex), position, args.Modulate, args.ScissorBox, args.CoordinateTransform);
+        }
+
         public void UpdateDraw()
         {
         }

Robust.Client/UserInterface/Controls/BaseButton.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using Robust.Client.Audio;
 using Robust.Client.ResourceManagement;
 using Robust.Shared.ContentPack;
@@ -37,8 +38,10 @@ namespace Robust.Client.UserInterface.Controls
             get => _group;
             set
             {
+                if (value?.InternalButtons.Contains(this) ?? false)
+                    return; // No work to do.
                 // Remove from old group.
-                _group?.Buttons.Remove(this);
+                _group?.InternalButtons.Remove(this);
 
                 _group = value;
 
@@ -47,11 +50,12 @@ namespace Robust.Client.UserInterface.Controls
                     return;
                 }
 
-                value.Buttons.Add(this);
+                value.InternalButtons.Add(this);
                 ToggleMode = true;
 
-                // Set us to pressed if we're the first button.
-                Pressed = value.Buttons.Count == 0;
+                // Set us to pressed if we're the first button. Doesn't go through the setter to avoid setting off our own error check.
+                _pressed = value.InternalButtons.Count == 1;
+                DrawModeChanged();
             }
         }
 
@@ -326,7 +330,7 @@ namespace Robust.Client.UserInterface.Controls
                 return;
             }
 
-            foreach (var button in _group.Buttons)
+            foreach (var button in _group.InternalButtons)
             {
                 if (button != this && button.Pressed)
                 {
@@ -440,6 +444,9 @@ namespace Robust.Client.UserInterface.Controls
     /// </remarks>
     public sealed class ButtonGroup
     {
-        internal readonly List<BaseButton> Buttons = new();
+        internal readonly List<BaseButton> InternalButtons = new();
+        public IReadOnlyList<BaseButton> Buttons => InternalButtons;
+
+        public BaseButton? Pressed => InternalButtons.FirstOrDefault(x => x.Pressed);
     }
 }

Robust.Client/UserInterface/Controls/OptionButton.cs

@@ -12,6 +12,7 @@ namespace Robust.Client.UserInterface.Controls
     public class OptionButton : ContainerButton
     {
         public const string StyleClassOptionButton = "optionButton";
+        public const string StyleClassPopup = "optionButtonPopup";
         public const string StyleClassOptionTriangle = "optionTriangle";
         public readonly ScrollContainer OptionsScroll;
 
@@ -74,7 +75,8 @@ namespace Robust.Client.UserInterface.Controls
 
             _popup = new Popup()
             {
-                Children = { OptionsScroll }
+                Children = { new PanelContainer(), OptionsScroll },
+                StyleClasses = { StyleClassPopup }
             };
             _popup.OnPopupHide += OnPopupHide;
 
@@ -99,6 +101,11 @@ namespace Robust.Client.UserInterface.Controls
             AddItem(label, id);
         }
 
+        public virtual void ButtonOverride(Button button)
+        {
+
+        }
+
         public void AddItem(string label, int? id = null)
         {
             if (id == null)
@@ -132,6 +139,8 @@ namespace Robust.Client.UserInterface.Controls
             {
                 Select(0);
             }
+
+            ButtonOverride(button);
         }
 
         private void TogglePopup(bool show)
@@ -139,6 +148,8 @@ namespace Robust.Client.UserInterface.Controls
             if (show)
             {
                 var globalPos = GlobalPosition;
+                globalPos.Y += Size.Y + 1; // Place it below us, with a safety margin.
+                globalPos.Y -= Margin.SumVertical;
                 OptionsScroll.Measure(Window?.Size ?? Vector2Helpers.Infinity);
                 var (minX, minY) = OptionsScroll.DesiredSize;
                 var box = UIBox2.FromDimensions(globalPos, new Vector2(Math.Max(minX, Width), minY));

Robust.Client/UserInterface/Controls/PanelContainer.cs

@@ -15,13 +15,13 @@ namespace Robust.Client.UserInterface.Controls
         {
             base.Draw(handle);
 
-            var style = _getStyleBox();
+            var style = GetStyleBox();
             style?.Draw(handle, PixelSizeBox, UIScale);
         }
 
         protected override Vector2 MeasureOverride(Vector2 availableSize)
         {
-            var styleSize = _getStyleBox()?.MinimumSize ?? Vector2.Zero;
+            var styleSize = GetStyleBox()?.MinimumSize ?? Vector2.Zero;
             var measureSize = Vector2.Max(availableSize - styleSize, Vector2.Zero);
             var childSize = Vector2.Zero;
             foreach (var child in Children)
@@ -36,7 +36,7 @@ namespace Robust.Client.UserInterface.Controls
         protected override Vector2 ArrangeOverride(Vector2 finalSize)
         {
             var ourSize = UIBox2.FromDimensions(Vector2.Zero, finalSize);
-            var contentBox = _getStyleBox()?.GetContentBox(ourSize, 1) ?? ourSize;
+            var contentBox = GetStyleBox()?.GetContentBox(ourSize, 1) ?? ourSize;
 
             foreach (var child in Children)
             {
@@ -47,7 +47,7 @@ namespace Robust.Client.UserInterface.Controls
         }
 
         [System.Diagnostics.Contracts.Pure]
-        private StyleBox? _getStyleBox()
+        protected StyleBox? GetStyleBox()
         {
             if (PanelOverride != null)
             {

Robust.Client/UserInterface/Controls/TextureButton.cs

@@ -21,9 +21,11 @@ namespace Robust.Client.UserInterface.Controls
         public const string StylePseudoClassPressed = "pressed";
         private string? _texturePath;
 
+        private TextureRect _rect = new();
 
         public TextureButton()
         {
+            AddChild(_rect);
             DrawModeChanged();
         }
 
@@ -38,6 +40,15 @@ namespace Robust.Client.UserInterface.Controls
             }
         }
 
+        protected override void StylePropertiesChanged()
+        {
+            base.StylePropertiesChanged();
+            var texture = TextureNormal;
+
+            _rect.ForceRunStyleUpdate();
+            _rect.Texture = texture;
+        }
+
         protected override void OnThemeUpdated()
         {
             if (_texturePath != null) TextureNormal = Theme.ResolveTexture(_texturePath);
@@ -83,33 +94,5 @@ namespace Robust.Client.UserInterface.Controls
                     throw new ArgumentOutOfRangeException();
             }
         }
-
-        protected internal override void Draw(DrawingHandleScreen handle)
-        {
-            var texture = TextureNormal;
-
-            if (texture == null)
-            {
-                TryGetStyleProperty(StylePropertyTexture, out texture);
-                if (texture == null)
-                {
-                    return;
-                }
-            }
-
-            handle.DrawTextureRectRegion(texture, PixelSizeBox);
-        }
-
-        protected override Vector2 MeasureOverride(Vector2 availableSize)
-        {
-            var texture = TextureNormal;
-
-            if (texture == null)
-            {
-                TryGetStyleProperty(StylePropertyTexture, out texture);
-            }
-
-            return Scale * (texture?.Size ?? Vector2.Zero);
-        }
     }
 }

Robust.Client/UserInterface/Controls/TextureRect.cs

@@ -17,6 +17,9 @@ namespace Robust.Client.UserInterface.Controls
     {
         public const string StylePropertyTexture = "texture";
         public const string StylePropertyShader = "shader";
+        public const string StylePropertyTextureStretch = "texture-stretch";
+        public const string StylePropertyTextureScale = "texture-scale";
+        public const string StylePropertyTextureSizeTarget = "texture-size-target";
 
         private bool _canShrink;
         private Texture? _texture;
@@ -29,7 +32,18 @@ namespace Robust.Client.UserInterface.Controls
         /// </summary>
         public Texture? Texture
         {
-            get => _texture;
+            get
+            {
+                if (_texture is null)
+                {
+                    if (TryGetStyleProperty(StylePropertyTexture, out Texture? texture))
+                    {
+                        return texture;
+                    }
+                }
+
+                return _texture;
+            }
             set
             {
                 var oldSize = _texture?.Size;
@@ -43,6 +57,7 @@ namespace Robust.Client.UserInterface.Controls
         }
 
         private string? _texturePath;
+        private StretchMode _stretch = StretchMode.Keep;
 
         public string TexturePath
         {
@@ -54,21 +69,45 @@ namespace Robust.Client.UserInterface.Controls
 
         }
 
+        protected override void StylePropertiesChanged()
+        {
+            base.StylePropertiesChanged();
+            InvalidateMeasure();
+        }
+
         protected override void OnThemeUpdated()
         {
             if (_texturePath != null) Texture = Theme.ResolveTexture(_texturePath);
             base.OnThemeUpdated();
         }
 
+        public Vector2 TextureSizeTarget
+        {
+            get
+            {
+                if (!TryGetStyleProperty(StylePropertyTextureSizeTarget, out Vector2 target))
+                    target = _textureScale * Texture?.Size ?? Vector2.Zero;
+
+                return target;
+            }
+        }
+
         /// <summary>
         ///     Scales the texture displayed.
         /// </summary>
         /// <remarks>
         ///     This does not apply to the following stretch modes: <see cref="StretchMode.Scale"/>.
+        ///     This additionally does not apply if a size target is set.
         /// </remarks>
         public Vector2 TextureScale
         {
-            get => _textureScale;
+            get
+            {
+                if (!TryGetStyleProperty(StylePropertyTextureScale, out Vector2 scale))
+                    scale = _textureScale;
+
+                return scale;
+            }
             set
             {
                 _textureScale = value;
@@ -96,23 +135,27 @@ namespace Robust.Client.UserInterface.Controls
         /// <summary>
         ///     Controls how the texture should be drawn if the control is larger than the size of the texture.
         /// </summary>
-        public StretchMode Stretch { get; set; } = StretchMode.Keep;
+        public StretchMode Stretch
+        {
+            get
+            {
+                if (!TryGetStyleProperty(StylePropertyTextureStretch, out StretchMode stretch))
+                    stretch = _stretch;
+                return stretch;
+            }
+            set => _stretch = value;
+        }
 
         protected internal override void Draw(DrawingHandleScreen handle)
         {
             base.Draw(handle);
 
-            var texture = _texture;
-            ShaderInstance? shader = null;
+            var texture = Texture;
 
-            if (texture == null)
-            {
-                TryGetStyleProperty(StylePropertyTexture, out texture);
-                if (texture == null)
-                {
-                    return;
-                }
-            }
+            if (texture is null)
+                return;
+
+            ShaderInstance? shader = null;
 
             if (ShaderOverride != null)
             {
@@ -167,17 +210,17 @@ namespace Robust.Client.UserInterface.Controls
                 case StretchMode.Tile:
                 // TODO: Implement Tile.
                 case StretchMode.Keep:
-                    return UIBox2.FromDimensions(Vector2.Zero, texture.Size * _textureScale * UIScale);
+                    return UIBox2.FromDimensions(Vector2.Zero, TextureSizeTarget).Scale(UIScale);
                 case StretchMode.KeepCentered:
                 {
-                    var position = (PixelSize - texture.Size * _textureScale * UIScale) / 2;
-                    return UIBox2.FromDimensions(position, texture.Size * _textureScale * UIScale);
+                    var position = (PixelSize - TextureSizeTarget) / 2;
+                    return UIBox2.FromDimensions(position, TextureSizeTarget).Scale(UIScale);
                 }
 
                 case StretchMode.KeepAspect:
                 case StretchMode.KeepAspectCentered:
                 {
-                    var (texWidth, texHeight) = texture.Size * _textureScale;
+                    var (texWidth, texHeight) = TextureSizeTarget;
                     var width = texWidth * (PixelSize.Y / texHeight);
                     var height = (float)PixelSize.Y;
                     if (width > PixelSize.X)
@@ -193,11 +236,11 @@ namespace Robust.Client.UserInterface.Controls
                         position = (PixelSize - size) / 2;
                     }
 
-                    return UIBox2.FromDimensions(position, size);
+                    return UIBox2.FromDimensions(position, size).Scale(UIScale);
                 }
 
                 case StretchMode.KeepAspectCovered:
-                    var texSize = texture.Size * _textureScale;
+                    var texSize = TextureSizeTarget;
                     // Calculate the scale necessary to fit width and height to control size.
                     var (scaleX, scaleY) = PixelSize / texSize;
                     // Use whichever scale is greater.
@@ -205,7 +248,7 @@ namespace Robust.Client.UserInterface.Controls
                     // Offset inside the actual texture.
                     var texDrawSize = texSize * scale;
                     var offset = (PixelSize - texDrawSize) / 2f;
-                    return UIBox2.FromDimensions(offset, texDrawSize);
+                    return UIBox2.FromDimensions(offset, texDrawSize).Scale(UIScale);
                 default:
                     throw new ArgumentOutOfRangeException();
             }
@@ -259,19 +302,10 @@ namespace Robust.Client.UserInterface.Controls
 
         protected override Vector2 MeasureOverride(Vector2 availableSize)
         {
-            var texture = _texture;
-
-            if (texture == null)
-            {
-                TryGetStyleProperty(StylePropertyTexture, out texture);
-            }
-
-            if (texture == null || CanShrink)
-            {
+            if (CanShrink || Texture == null)
                 return Vector2.Zero;
-            }
 
-            return texture.Size * TextureScale;
+            return TextureSizeTarget;
         }
     }
 }

Robust.Client/UserInterface/IUserInterfaceManagerInternal.cs

@@ -61,6 +61,9 @@ namespace Robust.Client.UserInterface
         Vector2? CalcRelativeMousePositionFor(Control control, ScreenCoordinates mousePos);
 
         Color GetMainClearColor();
+
+        void RenderControl(IRenderHandle renderHandle, ref int total, Control control, Vector2i position, Color modulate,
+            UIBox2i? scissorBox, Matrix3 coordinateTransform);
     }
 }
 

Robust.Client/UserInterface/UserInterfaceManager.Layout.cs

@@ -132,9 +132,10 @@ internal sealed partial class UserInterfaceManager
             try
             {
                 var total = 0;
-                _render(renderHandle, ref total, root, Vector2i.Zero, Color.White, null);
                 var drawingHandle = renderHandle.DrawingHandleScreen;
-                drawingHandle.SetTransform(Vector2.Zero, Angle.Zero, Vector2.One);
+                drawingHandle.SetTransform(Matrix3.Identity);
+                RenderControl(renderHandle, ref total, root, Vector2i.Zero, Color.White, null, Matrix3.Identity);
+                drawingHandle.SetTransform(Matrix3.Identity);
                 OnPostDrawUIRoot?.Invoke(new PostDrawUIRootEventArgs(root, drawingHandle));
 
                 _prof.WriteValue("Controls rendered", ProfData.Int32(total));

Robust.Client/UserInterface/UserInterfaceManager.cs

@@ -75,7 +75,7 @@ namespace Robust.Client.UserInterface
 
                 foreach (var root in _roots)
                 {
-                    if (root.Stylesheet != null)
+                    if (root.Stylesheet == null)
                     {
                         root.StylesheetUpdateRecursive();
                     }
@@ -329,8 +329,8 @@ namespace Robust.Client.UserInterface
             }
         }
 
-        private void _render(IRenderHandle renderHandle, ref int total, Control control, Vector2i position, Color modulate,
-            UIBox2i? scissorBox)
+        public void RenderControl(IRenderHandle renderHandle, ref int total, Control control, Vector2i position, Color modulate,
+            UIBox2i? scissorBox, Matrix3 coordinateTransform)
         {
             if (!control.Visible)
             {
@@ -377,7 +377,10 @@ namespace Robust.Client.UserInterface
             total += 1;
 
             var handle = renderHandle.DrawingHandleScreen;
-            handle.SetTransform(position, Angle.Zero, Vector2.One);
+            var oldXform = handle.GetTransform();
+            var xform = oldXform;
+            xform.Multiply(Matrix3.CreateTransform(position, Angle.Zero, Vector2.One));
+            handle.SetTransform(xform);
             modulate *= control.Modulate;
 
             if (_rendering || control.AlwaysRender)
@@ -389,16 +392,32 @@ namespace Robust.Client.UserInterface
                 handle.Modulate = oldMod;
                 handle.UseShader(null);
             }
+            handle.SetTransform(oldXform);
+            var args = new Control.ControlRenderArguments()
+            {
+                Handle = renderHandle,
+                Total = ref total,
+                Modulate = modulate,
+                ScissorBox = scissorRegion,
+                CoordinateTransform = ref coordinateTransform
+            };
+
+            control.PreRenderChildren(ref args);
 
             foreach (var child in control.Children)
             {
-                _render(renderHandle, ref total, child, position + child.PixelPosition, modulate, scissorRegion);
+                var pos = position + (Vector2i) coordinateTransform.Transform(child.PixelPosition);
+                control.RenderChildOverride(ref args, child.GetPositionInParent(), pos);
             }
 
+            control.PostRenderChildren(ref args);
+
             if (clip)
             {
                 renderHandle.SetScissor(scissorBox);
             }
+
+            handle.SetTransform(oldXform);
         }
 
         public Color GetMainClearColor() => RootControl.ActualBgColor;

Robust.Shared/ContentPack/Sandbox.yml

@@ -73,6 +73,9 @@ WhitelistedNamespaces:
 # * The API is not *relevant* to content. e.g. System.Type.IsAnsiClass.
 # * I am lazy these API lists are huge dude.
 Types:
+  Avalonia.Metadata:
+    XmlnsDefinitionAttribute:
+      All: True
   NetSerializer:
     NetListAsArray`1:
       Fields: