Merge pull request #3056 from Eideren/ui_services

xen2 · web-flow · commit 1c6bf9c0993f · 2026-02-26T23:54:06.000+09:00
fix: Replace static FocusedElement and more proactive UI service availability
diff --git a/sources/engine/Stride.UI.Tests/Layering/EditTextTests.cs b/sources/engine/Stride.UI.Tests/Layering/EditTextTests.cs
@@ -29,7 +29,6 @@ public void TestBasicInvalidations()
             services.AddService<IGame>(new Game());
 
             var edit = new EditText();
-            edit.UIElementServices = new UIElementServices { Services = services };
 
             // - test the properties that are supposed to invalidate the object measurement
             UIElementLayeringTests.TestMeasureInvalidation(edit, () => edit.Font = new DummyFont());
diff --git a/sources/engine/Stride.UI.Tests/Regression/EditTextTest.cs b/sources/engine/Stride.UI.Tests/Regression/EditTextTest.cs
@@ -99,8 +99,6 @@ protected override async Task LoadContent()
             canvas.Children.Add(edit3);
             canvas.Children.Add(edit4);
 
-            canvas.UIElementServices = new UIElementServices { Services = this.Services };
-
             UIComponent.Page = new Engine.UIPage { RootElement = canvas };
         }
 
diff --git a/sources/engine/Stride.UI.Tests/Regression/MouseOverTest.cs b/sources/engine/Stride.UI.Tests/Regression/MouseOverTest.cs
@@ -83,8 +83,6 @@ protected override async Task LoadContent()
             canvas.MouseOverStateChanged += (sender, args) => { triggeredCanvas = true;};
             stackPanel.MouseOverStateChanged += (sender, args) => { triggeredStackPanel = true;};
 
-            canvas.UIElementServices = new UIElementServices { Services = this.Services };
-
             UIComponent.Page = new Engine.UIPage { RootElement = canvas };
         }
 
diff --git a/sources/engine/Stride.UI/Controls/EditText.Android.cs b/sources/engine/Stride.UI/Controls/EditText.Android.cs
@@ -10,7 +10,9 @@
 using Android.Text.Method;
 using Stride.Core;
 using Stride.Games;
+using Stride.Input;
 using Exception = System.Exception;
+using KeyEvent = Android.Views.KeyEvent;
 
 namespace Stride.UI.Controls
 {
@@ -228,7 +230,7 @@ private void OnMinLinesChangedImpl()
             editText.Post(editTextSetMinLinesAction);
         }
 
-        private void ActivateEditTextImpl()
+        private void ActivateEditTextImpl(InputManager inputManager)
         {
             lock (syncRoot)
             {
@@ -250,7 +252,7 @@ private void ActivateEditTextImpl()
             }
         }
 
-        private void DeactivateEditTextImpl()
+        private void DeactivateEditTextImpl(InputManager inputManager)
         {
             lock (syncRoot)
             {
@@ -265,8 +267,6 @@ private void DeactivateEditTextImpl()
                 activeEditText = null;
 
                 GetGameContext().HideEditTextPopup();
-
-                FocusedElement = null;
             }
         }
 
diff --git a/sources/engine/Stride.UI/Controls/EditText.Direct.cs b/sources/engine/Stride.UI/Controls/EditText.Direct.cs
@@ -90,18 +90,14 @@ internal override void OnTextInput(TextEventArgs args)
             }
         }
 
-        private void ActivateEditTextImpl()
+        private void ActivateEditTextImpl(InputManager inputManager)
         {
-            var input = UIElementServices.Services.GetSafeServiceAs<InputManager>();
-            input.TextInput?.EnabledTextInput();
+            inputManager.TextInput?.EnabledTextInput();
         }
-        private void DeactivateEditTextImpl()
-        {
-            var input = UIElementServices.Services.GetSafeServiceAs<InputManager>();
-            input.TextInput?.DisableTextInput();
-            Composition = "";
 
-            FocusedElement = null;
+        private void DeactivateEditTextImpl(InputManager inputManager)
+        {
+            inputManager.TextInput?.DisableTextInput();
         }
 
         private void InterpretKey(Keys key, InputManager input)
diff --git a/sources/engine/Stride.UI/Controls/EditText.UWP.cs b/sources/engine/Stride.UI/Controls/EditText.UWP.cs
@@ -8,6 +8,7 @@
 using Stride.Core;
 using Stride.Core.Annotations;
 using Stride.Games;
+using Stride.Input;
 
 namespace Stride.UI.Controls
 {
@@ -42,7 +43,7 @@ private void OnMinLinesChangedImpl()
         {
         }
 
-        private void ActivateEditTextImpl()
+        private void ActivateEditTextImpl(InputManager inputManager)
         {
             // try to show the virtual keyboard if no hardward keyboard available
             Windows.UI.ViewManagement.InputPane.GetForCurrentView().TryShow();
@@ -103,7 +104,7 @@ private void EditText_TextChanged(object sender, Windows.UI.Xaml.Controls.TextCh
             UpdateSelectionFromEditImpl();
         }
 
-        private void DeactivateEditTextImpl()
+        private void DeactivateEditTextImpl(InputManager inputManager)
         {
             if (editText != null)
             {
@@ -119,7 +120,6 @@ private void DeactivateEditTextImpl()
                 editText = null;
                 activeEditText = null;
             }
-            FocusedElement = null;
         }
 
         private void UpdateTextToEditImpl()
diff --git a/sources/engine/Stride.UI/Controls/EditText.cs b/sources/engine/Stride.UI/Controls/EditText.cs
@@ -11,6 +11,7 @@
 using Stride.Engine;
 using Stride.Games;
 using Stride.Graphics;
+using Stride.Input;
 using Stride.UI.Events;
 
 namespace Stride.UI.Controls
@@ -148,20 +149,25 @@ public bool IsSelectionActive
                 if (IsReadOnly && value) // prevent selection when the Edit is read only
                     return;
 
-                isSelectionActive = value;
+                var uiSystem = UIElementServices.Services?.GetService<UISystem>();
+                var inputManager = UIElementServices.Services?.GetService<InputManager>();
+                if (inputManager is null || uiSystem is null)
+                    return;
 
-                if (IsSelectionActive)
+                isSelectionActive = value;
+                if (isSelectionActive)
                 {
-                    var previousEditText = FocusedElement as EditText;
-                    if (previousEditText != null)
+                    if (uiSystem.FocusedElement is EditText previousEditText)
                         previousEditText.IsSelectionActive = false;
 
-                    FocusedElement = this;
-                    ActivateEditTextImpl();
+                    uiSystem.FocusedElement = this;
+                    ActivateEditTextImpl(inputManager);
                 }
                 else
                 {
-                    DeactivateEditTextImpl();
+                    uiSystem.FocusedElement = null;
+                    DeactivateEditTextImpl(inputManager);
+                    Composition = "";
                 }
             }
         }
diff --git a/sources/engine/Stride.UI/Controls/EditText.iOS.cs b/sources/engine/Stride.UI/Controls/EditText.iOS.cs
@@ -10,6 +10,7 @@
 using Stride.Core;
 using Stride.Core.Annotations;
 using Stride.Games;
+using Stride.Input;
 using Stride.UI.Events;
 
 namespace Stride.UI.Controls
@@ -127,7 +128,6 @@ private static void TextFieldOnEditingDidEnd(object sender, EventArgs eventArgs)
             currentActiveEditText.IsSelectionActive = false;
             barView.Hidden = true;
             overlayView.Hidden = true;
-            FocusedElement = null;
 
             if (currentActiveEditText != null)
             {
@@ -171,7 +171,7 @@ private void OnMinLinesChangedImpl()
         {
         }
 
-        private void ActivateEditTextImpl()
+        private void ActivateEditTextImpl(InputManager inputManager)
         {
             EnsureGameContext();
 
@@ -199,7 +199,7 @@ private bool ShouldChangeCharacters(UITextField theTextField, NSRange range, str
             return replacementSize < 0 || theTextField.Text.Length + replacementSize <= MaxLength;
         }
 
-        private void DeactivateEditTextImpl()
+        private void DeactivateEditTextImpl(InputManager inputManager)
         {
             attachedTextField.EditingChanged -= TextFieldOnValueChanged;
             attachedTextField.ShouldChangeCharacters -= ShouldChangeCharacters;
diff --git a/sources/engine/Stride.UI/Engine/UIComponent.cs b/sources/engine/Stride.UI/Engine/UIComponent.cs
@@ -16,6 +16,7 @@ namespace Stride.Engine
     [DataContract("UIComponent")]
     [Display("UI", Expand = ExpandRule.Once)]
     [DefaultEntityComponentRenderer(typeof(UIRenderProcessor))]
+    [DefaultEntityComponentProcessor(typeof(UIProcessor))]
     [ComponentOrder(9800)]
     [ComponentCategory("UI")]
     public sealed class UIComponent : ActivableEntityComponent
@@ -36,7 +37,15 @@ public UIComponent()
         /// <userdoc>The UI page.</userdoc>
         [DataMember(10)]
         [Display("Page")]
-        public UIPage Page { get; set; }
+        public UIPage Page
+        {
+            get;
+            set
+            {
+                field = value;
+                field?.Services = Services;
+            }
+        }
 
         /// <summary>
         /// Specifies the sampling method to be used for this component
@@ -125,5 +134,16 @@ public UIComponent()
         /// </summary>
         [DataMemberIgnore]
         public const float FixedSizeVerticalUnit = 1;   // 100% of the vertical resolution
+
+        [DataMemberIgnore]
+        internal IServiceRegistry Services
+        {
+            get;
+            set
+            {
+                field = value;
+                Page?.Services = Services;
+            }
+        }
     }
 }
diff --git a/sources/engine/Stride.UI/Engine/UIPage.cs b/sources/engine/Stride.UI/Engine/UIPage.cs
@@ -21,6 +21,25 @@ public sealed class UIPage : ComponentBase
         /// </summary>
         /// <userdoc>The root element of the page.</userdoc>
         [DataMember]
-        public UIElement RootElement { get; set; }
+        public UIElement RootElement
+        {
+            get;
+            set
+            {
+                field = value;
+                field?.UIElementServices = new UIElementServices { Services = Services };
+            }
+        }
+
+        [DataMemberIgnore]
+        internal IServiceRegistry Services
+        {
+            get;
+            set
+            {
+                field = value;
+                RootElement?.UIElementServices = new UIElementServices { Services = Services };
+            }
+        }
     }
 }
diff --git a/sources/engine/Stride.UI/Rendering/UI/UIProcessor.cs b/sources/engine/Stride.UI/Rendering/UI/UIProcessor.cs
@@ -0,0 +1,19 @@
+// Copyright (c) .NET Foundation and Contributors (https://dotnetfoundation.org/ & https://stride3d.net)
+// Distributed under the MIT license. See the LICENSE.md file in the project root for more information.
+
+using Stride.Engine;
+
+namespace Stride.Rendering.UI
+{
+    public class UIProcessor : EntityProcessor<UIComponent>
+    {
+        protected override void OnEntityComponentAdding(Entity entity, UIComponent uiComponent, UIComponent _)
+        {
+            uiComponent.Services = Services;
+        }
+
+        protected override void OnEntityComponentRemoved(Entity entity, UIComponent uiComponent, UIComponent _)
+        {
+        }
+    }
+}
diff --git a/sources/engine/Stride.UI/Rendering/UI/UIRenderFeature.Picking.cs b/sources/engine/Stride.UI/Rendering/UI/UIRenderFeature.Picking.cs
@@ -290,7 +290,7 @@ private UIElement UpdateMouseOver(ref Viewport viewport, ref Matrix worldViewPro
                 }
             }
 
-            UIElementUnderMouseCursor = mouseOverElement;
+            uiSystem.UIElementUnderMouseCursor = mouseOverElement;
 
             // update cached values
             state.LastMouseOverElement = mouseOverElement;
diff --git a/sources/engine/Stride.UI/Rendering/UI/UIRenderFeature.cs b/sources/engine/Stride.UI/Rendering/UI/UIRenderFeature.cs
@@ -37,11 +37,11 @@ public partial class UIRenderFeature : RootRenderFeature
         public override Type SupportedRenderObjectType => typeof(RenderUIElement);
 
         /// <summary>
-        /// Represents the UI-element thats currently under the mouse cursor.
+        /// Represents the UI-element currently under the mouse cursor.
         /// Only elements with CanBeHitByUser == true are taken into account.
         /// Last processed element_state / ?UIComponent? with a valid element will be used.
         /// </summary>
-        public UIElement UIElementUnderMouseCursor { get; private set; }
+        public UIElement UIElementUnderMouseCursor => uiSystem.UIElementUnderMouseCursor;
 
         public UIRenderFeature()
         {
@@ -172,7 +172,8 @@ private void DrawInternal(RenderDrawContext context, RenderView renderView, Rend
                         elementUnderMouseCursor = loopedElementUnderMouseCursor;
                 }
             }
-            UIElementUnderMouseCursor = elementUnderMouseCursor;
+            
+            uiSystem.UIElementUnderMouseCursor = elementUnderMouseCursor;
 
             // render the UI elements of all the entities
             foreach (var uiElementState in uiElementStates)
@@ -208,9 +209,6 @@ private void DrawInternal(RenderDrawContext context, RenderView renderView, Rend
                 var projectedVirtualWidth = viewportSize * (transformedVirtualWidth.XY() / transformedVirtualWidth.W - projectedOrigin);
                 var projectedVirtualHeight = viewportSize * (transformedVirtualHeight.XY() / transformedVirtualHeight.W - projectedOrigin);
 
-                // Set default services
-                rootElement.UIElementServices = new UIElementServices { Services = RenderSystem.Services };
-
                 // set default resource dictionary
 
                 // update layouting context.
diff --git a/sources/engine/Stride.UI/UIElement.cs b/sources/engine/Stride.UI/UIElement.cs
@@ -80,11 +80,6 @@ protected UIElement()
             VisualChildrenCollection = new UIElementCollection();
         }
 
-        /// <summary>
-        /// The <see cref="UIElement"/> that currently has the focus.
-        /// </summary>
-        internal static UIElement FocusedElement { get; set; }
-
         /// <summary>
         /// A unique ID defining the UI element.
         /// </summary>
diff --git a/sources/engine/Stride.UI/UISystem.cs b/sources/engine/Stride.UI/UISystem.cs

Original file line number	Diff line number	Diff line change
`@@ -99,8 +99,6 @@ protected override async Task LoadContent()`
`99`	`99`	`canvas.Children.Add(edit3);`
`100`	`100`	`canvas.Children.Add(edit4);`
`101`	`101`
`102`		`- canvas.UIElementServices = new UIElementServices { Services = this.Services };`
`103`		`-`
`104`	`102`	`UIComponent.Page = new Engine.UIPage { RootElement = canvas };`
`105`	`103`	`}`
`106`	`104`
Original file line number	Diff line number	Diff line change
`@@ -83,8 +83,6 @@ protected override async Task LoadContent()`
`83`	`83`	`canvas.MouseOverStateChanged += (sender, args) => { triggeredCanvas = true;};`
`84`	`84`	`stackPanel.MouseOverStateChanged += (sender, args) => { triggeredStackPanel = true;};`
`85`	`85`
`86`		`- canvas.UIElementServices = new UIElementServices { Services = this.Services };`
`87`		`-`
`88`	`86`	`UIComponent.Page = new Engine.UIPage { RootElement = canvas };`
`89`	`87`	`}`
`90`	`88`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,9 @@`
`10`	`10`	`using Android.Text.Method;`
`11`	`11`	`using Stride.Core;`
`12`	`12`	`using Stride.Games;`
	`13`	`+using Stride.Input;`
`13`	`14`	`using Exception = System.Exception;`
	`15`	`+using KeyEvent = Android.Views.KeyEvent;`
`14`	`16`
`15`	`17`	`namespace Stride.UI.Controls`
`16`	`18`	`{`
`@@ -228,7 +230,7 @@ private void OnMinLinesChangedImpl()`
`228`	`230`	`editText.Post(editTextSetMinLinesAction);`
`229`	`231`	`}`
`230`	`232`
`231`		`- private void ActivateEditTextImpl()`
	`233`	`+ private void ActivateEditTextImpl(InputManager inputManager)`
`232`	`234`	`{`
`233`	`235`	`lock (syncRoot)`
`234`	`236`	`{`
`@@ -250,7 +252,7 @@ private void ActivateEditTextImpl()`
`250`	`252`	`}`
`251`	`253`	`}`
`252`	`254`
`253`		`- private void DeactivateEditTextImpl()`
	`255`	`+ private void DeactivateEditTextImpl(InputManager inputManager)`
`254`	`256`	`{`
`255`	`257`	`lock (syncRoot)`
`256`	`258`	`{`
`@@ -265,8 +267,6 @@ private void DeactivateEditTextImpl()`
`265`	`267`	`activeEditText = null;`
`266`	`268`
`267`	`269`	`GetGameContext().HideEditTextPopup();`
`268`		`-`
`269`		`- FocusedElement = null;`
`270`	`270`	`}`
`271`	`271`	`}`
`272`	`272`
Original file line number	Diff line number	Diff line change
`@@ -90,18 +90,14 @@ internal override void OnTextInput(TextEventArgs args)`
`90`	`90`	`}`
`91`	`91`	`}`
`92`	`92`
`93`		`- private void ActivateEditTextImpl()`
	`93`	`+ private void ActivateEditTextImpl(InputManager inputManager)`
`94`	`94`	`{`
`95`		`- var input = UIElementServices.Services.GetSafeServiceAs<InputManager>();`
`96`		`- input.TextInput?.EnabledTextInput();`
	`95`	`+ inputManager.TextInput?.EnabledTextInput();`
`97`	`96`	`}`
`98`		`- private void DeactivateEditTextImpl()`
`99`		`- {`
`100`		`- var input = UIElementServices.Services.GetSafeServiceAs<InputManager>();`
`101`		`- input.TextInput?.DisableTextInput();`
`102`		`- Composition = "";`
`103`	`97`
`104`		`- FocusedElement = null;`
	`98`	`+ private void DeactivateEditTextImpl(InputManager inputManager)`
	`99`	`+ {`
	`100`	`+ inputManager.TextInput?.DisableTextInput();`
`105`	`101`	`}`
`106`	`102`
`107`	`103`	`private void InterpretKey(Keys key, InputManager input)`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`using Stride.Core;`
`9`	`9`	`using Stride.Core.Annotations;`
`10`	`10`	`using Stride.Games;`
	`11`	`+using Stride.Input;`
`11`	`12`
`12`	`13`	`namespace Stride.UI.Controls`
`13`	`14`	`{`
`@@ -42,7 +43,7 @@ private void OnMinLinesChangedImpl()`
`42`	`43`	`{`
`43`	`44`	`}`
`44`	`45`
`45`		`- private void ActivateEditTextImpl()`
	`46`	`+ private void ActivateEditTextImpl(InputManager inputManager)`
`46`	`47`	`{`
`47`	`48`	`// try to show the virtual keyboard if no hardward keyboard available`
`48`	`49`	`Windows.UI.ViewManagement.InputPane.GetForCurrentView().TryShow();`
`@@ -103,7 +104,7 @@ private void EditText_TextChanged(object sender, Windows.UI.Xaml.Controls.TextCh`
`103`	`104`	`UpdateSelectionFromEditImpl();`
`104`	`105`	`}`
`105`	`106`
`106`		`- private void DeactivateEditTextImpl()`
	`107`	`+ private void DeactivateEditTextImpl(InputManager inputManager)`
`107`	`108`	`{`
`108`	`109`	`if (editText != null)`
`109`	`110`	`{`
`@@ -119,7 +120,6 @@ private void DeactivateEditTextImpl()`
`119`	`120`	`editText = null;`
`120`	`121`	`activeEditText = null;`
`121`	`122`	`}`
`122`		`- FocusedElement = null;`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`private void UpdateTextToEditImpl()`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`using Stride.Core;`
`11`	`11`	`using Stride.Core.Annotations;`
`12`	`12`	`using Stride.Games;`
	`13`	`+using Stride.Input;`
`13`	`14`	`using Stride.UI.Events;`
`14`	`15`
`15`	`16`	`namespace Stride.UI.Controls`
`@@ -127,7 +128,6 @@ private static void TextFieldOnEditingDidEnd(object sender, EventArgs eventArgs)`
`127`	`128`	`currentActiveEditText.IsSelectionActive = false;`
`128`	`129`	`barView.Hidden = true;`
`129`	`130`	`overlayView.Hidden = true;`
`130`		`- FocusedElement = null;`
`131`	`131`
`132`	`132`	`if (currentActiveEditText != null)`
`133`	`133`	`{`
`@@ -171,7 +171,7 @@ private void OnMinLinesChangedImpl()`
`171`	`171`	`{`
`172`	`172`	`}`
`173`	`173`
`174`		`- private void ActivateEditTextImpl()`
	`174`	`+ private void ActivateEditTextImpl(InputManager inputManager)`
`175`	`175`	`{`
`176`	`176`	`EnsureGameContext();`
`177`	`177`
`@@ -199,7 +199,7 @@ private bool ShouldChangeCharacters(UITextField theTextField, NSRange range, str`
`199`	`199`	`return replacementSize < 0 \|\| theTextField.Text.Length + replacementSize <= MaxLength;`
`200`	`200`	`}`
`201`	`201`
`202`		`- private void DeactivateEditTextImpl()`
	`202`	`+ private void DeactivateEditTextImpl(InputManager inputManager)`
`203`	`203`	`{`
`204`	`204`	`attachedTextField.EditingChanged -= TextFieldOnValueChanged;`
`205`	`205`	`attachedTextField.ShouldChangeCharacters -= ShouldChangeCharacters;`