UI input refactor

sources/editor/Stride.Assets.Presentation/AssetEditors/UIEditor/Adorners/SizingAdorner.cs

@@ -27,7 +27,7 @@ public SizingAdorner(UIEditorGameAdornerService service, UIElement gameSideEleme
             ResizingDirection = resizingDirection;
 
             // support for mouse over cursor
-            Visual.MouseOverStateChanged += MouseOverStateChanged;
+            Visual.MouseOverStateChanged += PointerOverStateChanged;
         }
 
         public ResizingDirection ResizingDirection
@@ -147,12 +147,12 @@ void IResizingAdorner.OnResizingCompleted()
             isDragging = false;
         }
 
-        private void MouseOverStateChanged(object sender, PropertyChangedArgs<MouseOverState> e)
+        private void PointerOverStateChanged(object sender, PropertyChangedArgs<PointerOverState> e)
         {
             if (isDragging)
                 return;
 
-            Service.Controller.ChangeCursor(e.NewValue != MouseOverState.MouseOverNone ? GetCursor() : null);
+            Service.Controller.ChangeCursor(e.NewValue != PointerOverState.None ? GetCursor() : null);
         }
     }
 }

sources/editor/Stride.Assets.Presentation/AssetEditors/UIEditor/Game/UIEditorGameAdornerService.Events.cs

@@ -71,14 +71,14 @@ internal void ApplyChanges(Guid elementId, IReadOnlyDictionary<string, object> c
         }
 
         #region Event Handlers
-        private void PreviewTouchDown(object sender, TouchEventArgs e)
+        private void PreviewPointerPressed(object sender, PointerEventArgs e)
         {
             if (!Game.Input.IsMouseButtonDown(MouseButton.Left))
                 return;
 
             // Save the current pointer position
             originWorldPosition = currentPosition = e.WorldPosition;
-            originScreenPosition = e.ScreenPosition;
+            originScreenPosition = e.Position;
 
             // No prior selection (selection is done on TouchUp)
             if (selectedAdorners.Count == 0)
@@ -115,13 +115,13 @@ orderby hit.IntersectionPoint.Z
             isInProgress = true;
         }
 
-        private void PreviewTouchMove(object sender, TouchEventArgs e)
+        private void PreviewPointerMove(object sender, PointerEventArgs e)
         {
             var worldPosition = e.WorldPosition;
             DoHighlightingAtPosition(ref worldPosition);
         }
 
-        private void TouchMove(object sender, TouchEventArgs e)
+        private void PointerMove(object sender, PointerEventArgs e)
         {
             // dragging state
             if (isInProgress)
@@ -134,7 +134,7 @@ private void TouchMove(object sender, TouchEventArgs e)
                 if (!isDragging)
                 {
                     // Start dragging only if a minimum distance is reached (on the real screen, not the virtual screen).
-                    var delta = (e.ScreenPosition - originScreenPosition)*new Vector2(Game.GraphicsDevice.Presenter.BackBuffer.Width, Game.GraphicsDevice.Presenter.BackBuffer.Height);
+                    var delta = (e.Position - originScreenPosition)*new Vector2(Game.GraphicsDevice.Presenter.BackBuffer.Width, Game.GraphicsDevice.Presenter.BackBuffer.Height);
                     if (Math.Abs(delta.X) > System.Windows.SystemParameters.MinimumHorizontalDragDistance || Math.Abs(delta.Y) > System.Windows.SystemParameters.MinimumVerticalDragDistance)
                     {
                         isDragging = true;
@@ -183,7 +183,7 @@ private void TouchMove(object sender, TouchEventArgs e)
             // TODO: special case when trying to move when there is nothing selected: should select and start moving at the same time
         }
 
-        private void TouchUp(object sender, TouchEventArgs e)
+        private void PointerReleased(object sender, PointerEventArgs e)
         {
             if (!Game.Input.IsMouseButtonReleased(MouseButton.Left))
                 return;
@@ -231,7 +231,7 @@ private void TouchUp(object sender, TouchEventArgs e)
             }
 
             // Select the corresponding asset-side UIElement, if pointer did not move between down and up events
-            var delta = (e.ScreenPosition - originScreenPosition)*new Vector2(Game.GraphicsDevice.Presenter.BackBuffer.Width, Game.GraphicsDevice.Presenter.BackBuffer.Height);
+            var delta = (e.Position - originScreenPosition)*new Vector2(Game.GraphicsDevice.Presenter.BackBuffer.Width, Game.GraphicsDevice.Presenter.BackBuffer.Height);
             if (Math.Abs(delta.X) < System.Windows.SystemParameters.MinimumHorizontalDragDistance && Math.Abs(delta.Y) < System.Windows.SystemParameters.MinimumVerticalDragDistance)
             {
                 var additiveSelection = Game.Input.IsKeyDown(Keys.LeftCtrl) || Game.Input.IsKeyDown(Keys.RightCtrl);
@@ -273,7 +273,7 @@ private void DoHighlightingAtPosition(ref Vector3 worldPosition)
             DoHighlightAdorner(elementId);
         }
 
-        private ICollection<UIRenderFeature.HitTestResult> GetAdornerVisualsAtPosition(ref Vector3 worldPosition)
+        private ICollection<UISystem.HitTestResult> GetAdornerVisualsAtPosition(ref Vector3 worldPosition)
         {
             var uiComponent = Controller.GetEntityByName(UIEditorController.AdornerEntityName).Get<UIComponent>();
             if (Math.Abs(worldPosition.X) > uiComponent.Resolution.X * 0.5f ||
@@ -286,7 +286,7 @@ private void DoHighlightingAtPosition(ref Vector3 worldPosition)
 
             var ray = new Ray(new Vector3(worldPosition.X, worldPosition.Y, uiComponent.Resolution.Z + 1), -Vector3.UnitZ);
             var worldViewProj = Matrix.Identity; // All the calculation is done in UI space
-            return UIRenderFeature.GetElementsAtPosition(rootElement, ref ray, ref worldViewProj);
+            return UISystem.GetElementsAtPosition(rootElement, ref ray, ref worldViewProj);
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]

sources/editor/Stride.Assets.Presentation/AssetEditors/UIEditor/Game/UIEditorGameAdornerService.cs

@@ -524,10 +524,10 @@ private async Task Update()
                 if (adornerCanvas == null)
                     continue;
 
-                adornerCanvas.PreviewTouchDown += PreviewTouchDown;
-                adornerCanvas.PreviewTouchMove += PreviewTouchMove;
-                adornerCanvas.TouchMove += TouchMove;
-                adornerCanvas.TouchUp += TouchUp;
+                adornerCanvas.PreviewPointerPressed += PreviewPointerPressed;
+                adornerCanvas.PreviewPointerMove += PreviewPointerMove;
+                adornerCanvas.PointerMove += PointerMove;
+                adornerCanvas.PointerReleased += PointerReleased;
                 break;
             }
 

sources/engine/Stride.Input/PointerEvent.cs

@@ -8,7 +8,7 @@
 namespace Stride.Input
 {
     /// <summary>
-    /// A pointer event.
+    /// A pointer event. A pointer is a mouse, pen, finger, or other touch.
     /// </summary>
     public class PointerEvent : InputEvent
     {
@@ -23,24 +23,28 @@ public class PointerEvent : InputEvent
         /// Gets the absolute screen position of the pointer.
         /// </summary>
         /// <value>The absolute delta position.</value>
+        /// <remarks>AbsolutePosition is between [0, SurfaceSize]. (0, 0) is the left top corner, (SurfaceSize.X, SurfaceSize.Y) is the right bottom corner.</remarks>
         public Vector2 AbsolutePosition => Position * Pointer.SurfaceSize;
 
         /// <summary>
         /// Gets the normalized screen position of the pointer.
         /// </summary>
         /// <value>The position.</value>
+        /// <remarks>Position is normalized between [0,1]. (0,0) is the left top corner, (1,1) is the right bottom corner.</remarks>
         public Vector2 Position { get; internal set; }
 
         /// <summary>
         /// Gets the absolute delta position of the pointer since the previous frame.
         /// </summary>
         /// <value>The absolute delta position.</value>
+        /// <remarks>AbsoluteDeltaPosition position space is between [0, SurfaceSize]. (0, 0) is the left top corner, (SurfaceSize.X, SurfaceSize.Y) is the right bottom corner.</remarks>
         public Vector2 AbsoluteDeltaPosition => DeltaPosition * Pointer.SurfaceSize;
 
         /// <summary>
         /// Gets the delta position of the pointer since the previous frame.
         /// </summary>
         /// <value>The delta position.</value>
+        /// <remarks>DeltaPosition position space is normalized between [0,1]. (0,0) is the left top corner, (1,1) is the right bottom corner.</remarks>
         public Vector2 DeltaPosition { get; internal set; }
 
         /// <summary>

sources/engine/Stride.UI.Tests/Regression/ButtonTest.cs

@@ -40,7 +40,7 @@ protected override void RegisterTests()
 
         private void DrawTest1()
         {
-            button.RaiseTouchDownEvent(new TouchEventArgs());
+            button.RaisePointerPressedEvent(new TouchEventArgs());
         }
 
         [Fact]

sources/engine/Stride.UI.Tests/Regression/ImageButtonTest.cs

@@ -46,7 +46,7 @@ protected override void RegisterTests()
 
         private void DrawTest1()
         {
-            button.RaiseTouchDownEvent(new TouchEventArgs());
+            button.RaisePointerPressedEvent(new TouchEventArgs());
         }
 
         [Fact]

sources/engine/Stride.UI.Tests/Regression/MouseOverTest.cs

@@ -33,8 +33,8 @@ public class MouseOverTest : UITestGameBase
         private bool triggeredCanvas;
         private bool triggeredStackPanel;
 
-        private MouseOverState oldValueButton1;
-        private MouseOverState newValueButton1;
+        private PointerOverState oldValueButton1;
+        private PointerOverState newValueButton1;
 
         public MouseOverTest()
         {
@@ -119,12 +119,12 @@ private void Test1()
         {
             ResetStates();
 
-            Assert.Equal(MouseOverState.MouseOverNone, canvas.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, stackPanel.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button2.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit2.MouseOverState);
+            Assert.Equal(PointerOverState.None, canvas.PointerOverState);
+            Assert.Equal(PointerOverState.None, stackPanel.PointerOverState);
+            Assert.Equal(PointerOverState.None, button1.PointerOverState);
+            Assert.Equal(PointerOverState.None, button2.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit1.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit2.PointerOverState);
 
             Assert.False(triggeredButton1);
             Assert.False(triggeredButton2);
@@ -143,12 +143,12 @@ private void PrepareTest2()
 
         private void Test2()
         {
-            Assert.Equal(MouseOverState.MouseOverChild, canvas.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, stackPanel.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverElement, button1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button2.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit2.MouseOverState);
+            Assert.Equal(PointerOverState.Child, canvas.PointerOverState);
+            Assert.Equal(PointerOverState.None, stackPanel.PointerOverState);
+            Assert.Equal(PointerOverState.Self, button1.PointerOverState);
+            Assert.Equal(PointerOverState.None, button2.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit1.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit2.PointerOverState);
 
             Assert.True(triggeredButton1);
             Assert.True(triggeredCanvas);
@@ -157,8 +157,8 @@ private void Test2()
             Assert.False(triggeredEdit2);
             Assert.False(triggeredStackPanel);
 
-            Assert.Equal(MouseOverState.MouseOverNone, oldValueButton1);
-            Assert.Equal(MouseOverState.MouseOverElement, newValueButton1);
+            Assert.Equal(PointerOverState.None, oldValueButton1);
+            Assert.Equal(PointerOverState.Self, newValueButton1);
         }
 
         private void PrepareTest3()
@@ -170,12 +170,12 @@ private void PrepareTest3()
 
         private void Test3()
         {
-            Assert.Equal(MouseOverState.MouseOverChild, canvas.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, stackPanel.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button2.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverElement, edit1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit2.MouseOverState);
+            Assert.Equal(PointerOverState.Child, canvas.PointerOverState);
+            Assert.Equal(PointerOverState.None, stackPanel.PointerOverState);
+            Assert.Equal(PointerOverState.None, button1.PointerOverState);
+            Assert.Equal(PointerOverState.None, button2.PointerOverState);
+            Assert.Equal(PointerOverState.Self, edit1.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit2.PointerOverState);
 
             Assert.True(triggeredButton1);
             Assert.True(triggeredEdit1);
@@ -194,12 +194,12 @@ private void PrepareTest4()
 
         private void Test4()
         {
-            Assert.Equal(MouseOverState.MouseOverElement, canvas.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, stackPanel.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button2.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit2.MouseOverState);
+            Assert.Equal(PointerOverState.Self, canvas.PointerOverState);
+            Assert.Equal(PointerOverState.None, stackPanel.PointerOverState);
+            Assert.Equal(PointerOverState.None, button1.PointerOverState);
+            Assert.Equal(PointerOverState.None, button2.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit1.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit2.PointerOverState);
 
             Assert.True(triggeredEdit1);
             Assert.True(triggeredCanvas);
@@ -218,12 +218,12 @@ private void PrepareTest5()
 
         private void Test5()
         {
-            Assert.Equal(MouseOverState.MouseOverChild, canvas.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverChild, stackPanel.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverElement, button2.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit2.MouseOverState);
+            Assert.Equal(PointerOverState.Child, canvas.PointerOverState);
+            Assert.Equal(PointerOverState.Child, stackPanel.PointerOverState);
+            Assert.Equal(PointerOverState.None, button1.PointerOverState);
+            Assert.Equal(PointerOverState.Self, button2.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit1.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit2.PointerOverState);
 
             Assert.True(triggeredCanvas);
             Assert.True(triggeredButton2);
@@ -242,12 +242,12 @@ private void PrepareTest6()
 
         private void Test6()
         {
-            Assert.Equal(MouseOverState.MouseOverChild, canvas.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverChild, stackPanel.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, button2.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverNone, edit1.MouseOverState);
-            Assert.Equal(MouseOverState.MouseOverElement, edit2.MouseOverState);
+            Assert.Equal(PointerOverState.Child, canvas.PointerOverState);
+            Assert.Equal(PointerOverState.Child, stackPanel.PointerOverState);
+            Assert.Equal(PointerOverState.None, button1.PointerOverState);
+            Assert.Equal(PointerOverState.None, button2.PointerOverState);
+            Assert.Equal(PointerOverState.None, edit1.PointerOverState);
+            Assert.Equal(PointerOverState.Self, edit2.PointerOverState);
 
             Assert.True(triggeredEdit2);
             Assert.True(triggeredButton2);

sources/engine/Stride.UI/Controls/Button.cs

@@ -165,7 +165,7 @@ public bool SizeToContent
             }
         }
 
-        internal ISpriteProvider ButtonImageProvider => IsPressed ? PressedImage : (MouseOverState == MouseOverState.MouseOverElement && MouseOverImage != null ? MouseOverImage : NotPressedImage);
+        internal ISpriteProvider ButtonImageProvider => IsPressed ? PressedImage : (PointerOverState == PointerOverState.Self && MouseOverImage != null ? MouseOverImage : NotPressedImage);
 
         internal Sprite ButtonImage => ButtonImageProvider?.GetSprite();
 

sources/engine/Stride.UI/Controls/ButtonBase.cs

@@ -65,29 +65,29 @@ public event EventHandler<RoutedEventArgs> Click
             typeof(Button));
 
 
-        protected override void OnTouchDown(TouchEventArgs args)
+        protected override void OnPointerPressed(PointerEventArgs args)
         {
-            base.OnTouchDown(args);
+            base.OnPointerPressed(args);
 
             IsPressed = true;
 
             if (ClickMode == ClickMode.Press)
                 RaiseEvent(new RoutedEventArgs(ClickEvent));
         }
 
-        protected override void OnTouchUp(TouchEventArgs args)
+        protected override void OnPointerReleased(PointerEventArgs args)
         {
-            base.OnTouchUp(args);
+            base.OnPointerReleased(args);
 
             if (IsPressed && ClickMode == ClickMode.Release)
                 RaiseEvent(new RoutedEventArgs(ClickEvent));
 
             IsPressed = false;
         }
 
-        protected override void OnTouchLeave(TouchEventArgs args)
+        protected override void OnPointerLeave(PointerEventArgs args)
         {
-            base.OnTouchLeave(args);
+            base.OnPointerLeave(args);
 
             IsPressed = false;
         }

sources/engine/Stride.UI/Controls/EditText.Direct.Default.cs

@@ -47,7 +47,7 @@ private void UpdateSelectionToEditImpl()
         {
         }
 
-        private void OnTouchUpImpl(TouchEventArgs args)
+        private void OnPointerReleasedImpl(PointerEventArgs args)
         {
         }
     }

sources/engine/Stride.UI/Controls/EditText.Direct.cs

@@ -13,7 +13,7 @@ namespace Stride.UI.Controls
 {
     public partial class EditText
     {
-        private void OnTouchMoveImpl(TouchEventArgs args)
+        private void OnPointerMoveImpl(PointerEventArgs args)
         {
             var currentPosition = FindNearestCharacterIndex(new Vector2(args.WorldPosition.X - WorldMatrix.M41, args.WorldPosition.Y - WorldMatrix.M42));
 
@@ -33,7 +33,7 @@ private void OnTouchMoveImpl(TouchEventArgs args)
             }
         }
 
-        private void OnTouchDownImpl(TouchEventArgs args)
+        private void OnPointerPressedImpl(PointerEventArgs args)
         {
             // Find the appropriate position for the caret.
             CaretPosition = FindNearestCharacterIndex(new Vector2(args.WorldPosition.X - WorldMatrix.M41, args.WorldPosition.Y - WorldMatrix.M42));