🐭 Add mouse buttons to mouse event args (#85)

Author: tomrijnbeek

Bearded.UI.Tests/Bearded.UI.Tests.csproj

@@ -29,6 +29,5 @@
     <!-- Needed to make indexes work -->
     <PackageReference Include="IndexRange" Version="1.0.2" />
     <!-- Needed to make C#9 features work -->
-    <Compile Include="IsExternalInit.cs" />
   </ItemGroup>
 </Project>

Bearded.UI/EventArgs/MouseButtonEventArgs.cs

@@ -7,8 +7,9 @@ public sealed class MouseButtonEventArgs : MouseEventArgs
     {
         public MouseButton MouseButton { get; }
 
-        public MouseButtonEventArgs(Vector2d mousePosition, ModifierKeys modifierKeys, MouseButton mouseButton)
-            : base(mousePosition, modifierKeys)
+        public MouseButtonEventArgs(
+            Vector2d mousePosition, MouseButtons mouseButtons, ModifierKeys modifierKeys, MouseButton mouseButton)
+            : base(mousePosition, mouseButtons, modifierKeys)
         {
             MouseButton = mouseButton;
         }

Bearded.UI/EventArgs/MouseButtons.cs

@@ -0,0 +1,47 @@
+using System;
+using Bearded.Utilities.Input;
+
+namespace Bearded.UI.EventArgs
+{
+    public readonly struct MouseButtons : IEquatable<MouseButtons>
+    {
+        public bool Left { get; }
+        public bool Right { get; }
+        public bool Middle { get; }
+
+        public MouseButtons(bool left, bool right, bool middle)
+        {
+            Left = left;
+            Right = right;
+            Middle = middle;
+        }
+
+        public static MouseButtons None => new();
+
+        public static MouseButtons FromInputManager(InputManager inputManager)
+        {
+            return new MouseButtons(
+                inputManager.LeftMousePressed, inputManager.RightMousePressed, inputManager.MiddleMousePressed);
+        }
+
+        public MouseButtons WithLeft() => new(true, Right, Middle);
+        public MouseButtons WithRight() => new(Left, true, Middle);
+        public MouseButtons WithMiddle() => new(Left, Right, true);
+
+        public bool IsSupersetOf(MouseButtons other) =>
+            (Left && other.Left) == other.Left &&
+            (Right && other.Right) == other.Right &&
+            (Middle && other.Middle) == other.Middle;
+
+        public bool Equals(MouseButtons other) =>
+            Left == other.Left && Right == other.Right && Middle == other.Middle;
+
+        public override bool Equals(object? obj) => obj is MouseButtons other && Equals(other);
+
+        public override int GetHashCode() => HashCode.Combine(Left, Right, Middle);
+
+        public static bool operator ==(MouseButtons left, MouseButtons right) => Equals(left, right);
+
+        public static bool operator !=(MouseButtons left, MouseButtons right) => !Equals(left, right);
+    }
+}

Bearded.UI/EventArgs/MouseEventArgs.cs

@@ -5,11 +5,13 @@ namespace Bearded.UI.EventArgs
     public class MouseEventArgs : RoutedEventArgs
     {
         public Vector2d MousePosition { get; }
+        public MouseButtons MouseButtons { get; }
         public ModifierKeys ModifierKeys { get; }
 
-        public MouseEventArgs(Vector2d mousePosition, ModifierKeys modifierKeys)
+        public MouseEventArgs(Vector2d mousePosition, MouseButtons mouseButtons, ModifierKeys modifierKeys)
         {
             MousePosition = mousePosition;
+            MouseButtons = mouseButtons;
             ModifierKeys = modifierKeys;
         }
     }

Bearded.UI/EventArgs/MouseScrollEventArgs.cs

@@ -8,8 +8,12 @@ public sealed class MouseScrollEventArgs : MouseEventArgs
         public float DeltaScrollF { get; }
 
         public MouseScrollEventArgs(
-            Vector2d mousePosition, ModifierKeys modifierKeys, int deltaScroll, float deltaScrollF)
-            : base(mousePosition, modifierKeys)
+            Vector2d mousePosition,
+            MouseButtons mouseButtons,
+            ModifierKeys modifierKeys,
+            int deltaScroll,
+            float deltaScrollF)
+            : base(mousePosition, mouseButtons, modifierKeys)
         {
             DeltaScroll = deltaScroll;
             DeltaScrollF = deltaScrollF;

Bearded.UI/Events/MouseEventManager.cs

@@ -1,4 +1,5 @@
-using Bearded.UI.Controls;
+using System.Collections.Immutable;
+using Bearded.UI.Controls;
 using Bearded.UI.EventArgs;
 using Bearded.Utilities.Input;
 using OpenTK.Mathematics;
@@ -10,10 +11,8 @@ namespace Bearded.UI.Events
 {
     sealed class MouseEventManager
     {
-        private static readonly MouseButton[] mouseButtons =
-        {
-            MouseButton.Left, MouseButton.Middle, MouseButton.Right
-        };
+        private static readonly ImmutableArray<MouseButton> mouseButtonsWithEvents =
+            ImmutableArray.Create(MouseButton.Left, MouseButton.Middle, MouseButton.Right);
 
         private readonly RootControl root;
         private readonly InputManager inputManager;
@@ -28,7 +27,8 @@ internal MouseEventManager(RootControl root, InputManager inputManager)
 
         internal void Update()
         {
-            var mousePosition = root.TransformViewportPosToFramePos((Vector2d) inputManager.MousePosition);
+            var mousePosition = root.TransformViewportPosToFramePos(inputManager.MousePosition);
+            var mouseButtons = MouseButtons.FromInputManager(inputManager);
             var modifierKeys = ModifierKeys.FromInputManager(inputManager);
 
             var path = EventRouter.FindPropagationPath(
@@ -47,7 +47,7 @@ internal void Update()
             var (removedFromPath, addedToPath) = previousPropagationPath != null
                 ? EventPropagationPath.CalculateDeviation(previousPropagationPath, path)
                 : (EventPropagationPath.Empty, path);
-            var eventArgs = new MouseEventArgs(mousePosition, modifierKeys);
+            var eventArgs = new MouseEventArgs(mousePosition, mouseButtons, modifierKeys);
 
             // Mouse exit
             removedFromPath.PropagateEvent(
@@ -68,20 +68,20 @@ internal void Update()
                 (c, e) => c.MouseMoved(e));
 
             // Mouse clicks
-            foreach (var btn in mouseButtons)
+            foreach (var btn in mouseButtonsWithEvents)
             {
                 var action = inputManager.Actions.Mouse.FromButton(btn);
                 if (action.Hit)
                 {
                     path.PropagateEvent(
-                        new MouseButtonEventArgs(mousePosition, modifierKeys, btn),
+                        new MouseButtonEventArgs(mousePosition, mouseButtons, modifierKeys, btn),
                         (c, e) => c.PreviewMouseButtonHit(e),
                         (c, e) => c.MouseButtonHit(e));
                 }
                 if (action.Released)
                 {
                     path.PropagateEvent(
-                        new MouseButtonEventArgs(mousePosition, modifierKeys, btn),
+                        new MouseButtonEventArgs(mousePosition, mouseButtons, modifierKeys, btn),
                         (c, e) => c.PreviewMouseButtonReleased(e),
                         (c, e) => c.MouseButtonReleased(e));
                 }
@@ -93,7 +93,7 @@ internal void Update()
             {
                 path.PropagateEvent(
                     new MouseScrollEventArgs(
-                        mousePosition, modifierKeys, inputManager.DeltaScroll, inputManager.DeltaScrollF),
+                        mousePosition, mouseButtons, modifierKeys, inputManager.DeltaScroll, inputManager.DeltaScrollF),
                     (c, e) => c.PreviewMouseScrolled(e),
                     (c, e) => c.MouseScrolled(e));
             }