FIX: uum 138143 by fixing how interactions work & extending their usage for actions that use magnitude (#2411)

Co-authored-by: Håkan Sidenvall <hakan.sidenvall@unity3d.com>
Co-authored-by: Paulius Dervinis <54306142+Pauliusd01@users.noreply.github.com>
Co-authored-by: Sue Arkin <85237015+suearkinunity@users.noreply.github.com>
Co-authored-by: Morgan Hoarau <122548697+MorganHoarau@users.noreply.github.com>

Author: 5 people

Assets/Tests/InputSystem/ActuationPressPointTests.cs

@@ -214,8 +214,8 @@ public void Controls_CanHaveStickDeadzones()
         InputSystem.RegisterLayout(json);
         var device = (Gamepad)InputSystem.AddDevice("MyDevice");
 
-        var firstState = new GamepadState {leftStick = new Vector2(0.05f, 0.05f)};
-        var secondState = new GamepadState {leftStick = new Vector2(0.5f, 0.5f)};
+        var firstState = new GamepadState { leftStick = new Vector2(0.05f, 0.05f) };
+        var secondState = new GamepadState { leftStick = new Vector2(0.5f, 0.5f) };
 
         InputSystem.QueueStateEvent(device, firstState);
         InputSystem.Update();
@@ -257,12 +257,12 @@ public void Controls_CanHaveAxisDeadzones()
         ////NOTE: Unfortunately, this relies on an internal method ATM.
         var processor = device.leftTrigger.TryGetProcessor<AxisDeadzoneProcessor>();
 
-        InputSystem.QueueStateEvent(device, new GamepadState {leftTrigger = 0.05f});
+        InputSystem.QueueStateEvent(device, new GamepadState { leftTrigger = 0.05f });
         InputSystem.Update();
 
         Assert.That(device.leftTrigger.ReadValue(), Is.Zero.Within(0.0001));
 
-        InputSystem.QueueStateEvent(device, new GamepadState {leftTrigger = 0.5f});
+        InputSystem.QueueStateEvent(device, new GamepadState { leftTrigger = 0.5f });
         InputSystem.Update();
 
         Assert.That(device.leftTrigger.ReadValue(),
@@ -284,13 +284,13 @@ public void Controls_CanChangeDefaultDeadzoneValuesOnTheFly()
         Set(gamepad.leftStick, new Vector2(0.5f, 0.5f));
 
         Assert.That(gamepad.leftStick.ReadValue(),
-            Is.EqualTo(new StickDeadzoneProcessor {min = 0.1f, max = 0.9f}.Process(new Vector2(0.5f, 0.5f))));
+            Is.EqualTo(new StickDeadzoneProcessor { min = 0.1f, max = 0.9f }.Process(new Vector2(0.5f, 0.5f))));
 
         InputSystem.settings.defaultDeadzoneMin = 0.2f;
         InputSystem.settings.defaultDeadzoneMax = 0.8f;
 
         Assert.That(gamepad.leftStick.ReadValue(),
-            Is.EqualTo(new StickDeadzoneProcessor {min = 0.2f, max = 0.8f}.Process(new Vector2(0.5f, 0.5f))));
+            Is.EqualTo(new StickDeadzoneProcessor { min = 0.2f, max = 0.8f }.Process(new Vector2(0.5f, 0.5f))));
     }
 
     [Test]
@@ -299,7 +299,7 @@ public void Controls_SticksProvideAccessToHalfAxes()
     {
         var gamepad = InputSystem.AddDevice<Gamepad>();
 
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {leftStick = new Vector2(0.5f, 0.5f)});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { leftStick = new Vector2(0.5f, 0.5f) });
         InputSystem.Update();
 
         Assert.That(gamepad.leftStick.up.ReadValue(),
@@ -311,7 +311,7 @@ public void Controls_SticksProvideAccessToHalfAxes()
         Assert.That(gamepad.leftStick.left.ReadValue(),
             Is.EqualTo(new AxisDeadzoneProcessor().Process(0.0f)));
 
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {leftStick = new Vector2(-0.5f, -0.5f)});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { leftStick = new Vector2(-0.5f, -0.5f) });
         InputSystem.Update();
 
         Assert.That(gamepad.leftStick.up.ReadValue(),
@@ -468,7 +468,7 @@ public unsafe void Controls_ValueIsReadFromStateMemoryOnlyWhenControlHasBeenMark
         gamepad.ApplyParameterChanges();
         Assert.That(gamepad.leftTrigger.value, Is.EqualTo(0.5f));
 
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {leftTrigger = 0.75f});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { leftTrigger = 0.75f });
         InputSystem.Update();
 
         // but this time, we updated state through the system which *does* set the stale flag on controls that
@@ -611,7 +611,7 @@ public void Controls_CanReadValueFromStateEvents()
             Assert.That(gamepad.leftTrigger.ReadValueFromEventAsObject(eventPtr), Is.EqualTo(0.234f).Within(0.00001));
         };
 
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {leftTrigger = 0.234f});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { leftTrigger = 0.234f });
         InputSystem.Update();
 
         Assert.That(receivedCalls, Is.EqualTo(1));
@@ -758,7 +758,7 @@ public void Controls_DpadVectorsAreCircular()
         var gamepad = InputSystem.AddDevice<Gamepad>();
 
         // Up.
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {buttons = 1 << (int)GamepadButton.DpadUp});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { buttons = 1 << (int)GamepadButton.DpadUp });
         InputSystem.Update();
 
         Assert.That(gamepad.dpad.ReadValue(), Is.EqualTo(Vector2.up));
@@ -775,7 +775,7 @@ public void Controls_DpadVectorsAreCircular()
         Assert.That(gamepad.dpad.ReadValue().y, Is.EqualTo((Vector2.up + Vector2.left).normalized.y).Within(0.00001));
 
         // Left.
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {buttons = 1 << (int)GamepadButton.DpadLeft});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { buttons = 1 << (int)GamepadButton.DpadLeft });
         InputSystem.Update();
 
         Assert.That(gamepad.dpad.ReadValue(), Is.EqualTo(Vector2.left));
@@ -792,7 +792,7 @@ public void Controls_DpadVectorsAreCircular()
         Assert.That(gamepad.dpad.ReadValue().y, Is.EqualTo((Vector2.down + Vector2.left).normalized.y).Within(0.00001));
 
         // Down.
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {buttons = 1 << (int)GamepadButton.DpadDown});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { buttons = 1 << (int)GamepadButton.DpadDown });
         InputSystem.Update();
 
         Assert.That(gamepad.dpad.ReadValue(), Is.EqualTo(Vector2.down));
@@ -811,7 +811,7 @@ public void Controls_DpadVectorsAreCircular()
             Is.EqualTo((Vector2.down + Vector2.right).normalized.y).Within(0.00001));
 
         // Right.
-        InputSystem.QueueStateEvent(gamepad, new GamepadState {buttons = 1 << (int)GamepadButton.DpadRight});
+        InputSystem.QueueStateEvent(gamepad, new GamepadState { buttons = 1 << (int)GamepadButton.DpadRight });
         InputSystem.Update();
 
         Assert.That(gamepad.dpad.ReadValue(), Is.EqualTo(Vector2.right));
@@ -947,6 +947,7 @@ public void Controls_FindControl_FindsControlDespiteTurkishCulture()
             Assert.That(matches, Has.Count.EqualTo(1));
             Assert.That(matches, Has.Exactly(1).SameAs(gamepad.leftStick));
         }
+
         Thread.CurrentThread.CurrentCulture = culture;
     }
 
@@ -973,6 +974,7 @@ public void Controls_CanParseControlPath(string path, params string[] parts)
                     case "displayName": return a.displayName == nameAndValue[1];
                     case "wildcard": return a.isWildcard;
                 }
+
                 return false;
             });
         }), Has.All.True);
@@ -1153,100 +1155,6 @@ public void Controls_CanFindControlsUsingWildcards_InMiddleOfNames()
         }
     }
 
-    [Test]
-    [Category("Controls")]
-    public void Controls_CanDetermineIfControlIsPressed()
-    {
-        InputSystem.settings.defaultButtonPressPoint = 0.5f;
-
-        var gamepad = InputSystem.AddDevice<Gamepad>();
-
-        Set(gamepad.leftStick, Vector2.one);
-        Set(gamepad.leftTrigger, 0.6f);
-        Press(gamepad.buttonSouth);
-
-        //// https://jira.unity3d.com/browse/ISX-926
-        ////REVIEW: IsPressed() should probably be renamed. As is apparent from the calls here, it's not always
-        ////        readily apparent that the way it is defined ("actuation level at least at button press threshold")
-        ////        does not always connect to what it intuitively means for the specific control.
-
-        Assert.That(gamepad.leftTrigger.IsPressed(), Is.True);
-        Assert.That(gamepad.rightTrigger.IsPressed(), Is.False);
-        Assert.That(gamepad.buttonSouth.IsPressed(), Is.True);
-        Assert.That(gamepad.buttonNorth.IsPressed(), Is.False);
-        Assert.That(gamepad.leftStick.IsPressed(), Is.True); // Note how this diverges from the actual meaning of "is the left stick pressed?"
-        Assert.That(gamepad.rightStick.IsPressed(), Is.False);
-
-        // https://fogbugz.unity3d.com/f/cases/1374024/
-        // Calling it on the entire device should be false.
-        Assert.That(gamepad.IsPressed(), Is.False);
-    }
-
-    [Test]
-    [Category("Controls")]
-    public void Controls_CanCustomizeDefaultButtonPressPoint()
-    {
-        var gamepad = InputSystem.AddDevice<Gamepad>();
-
-        InputSystem.settings.defaultButtonPressPoint = 0.4f;
-
-        Set(gamepad.leftTrigger, 0.39f);
-
-        Assert.That(gamepad.leftTrigger.isPressed, Is.False);
-
-        Set(gamepad.leftTrigger, 0.4f);
-
-        Assert.That(gamepad.leftTrigger.isPressed, Is.True);
-
-        InputSystem.settings.defaultButtonPressPoint = 0.5f;
-
-        Assert.That(gamepad.leftTrigger.isPressed, Is.False);
-
-        InputSystem.settings.defaultButtonPressPoint = 0;
-
-        Assert.That(gamepad.leftTrigger.isPressed, Is.True);
-
-        // Setting the trigger to 0 requires the system to be "smart" enough to
-        // figure out that 0 as a default button press point doesn't make sense
-        // and that instead the press point should clamp off at some low, non-zero value.
-        // https://fogbugz.unity3d.com/f/cases/1349002/
-        Set(gamepad.leftTrigger, 0f);
-
-        Assert.That(gamepad.leftTrigger.isPressed, Is.False);
-
-        Set(gamepad.leftTrigger, 0.001f);
-
-        Assert.That(gamepad.leftTrigger.isPressed, Is.True);
-
-        InputSystem.settings.defaultButtonPressPoint = -1;
-        Set(gamepad.leftTrigger, 0f);
-
-        Assert.That(gamepad.leftTrigger.isPressed, Is.False);
-    }
-
-    [Test]
-    [Category("Controls")]
-    public void Controls_CanCustomizePressPointOfGamepadTriggers()
-    {
-        var json = @"
-            {
-                ""name"" : ""CustomGamepad"",
-                ""extend"" : ""Gamepad"",
-                ""controls"" : [
-                    {
-                        ""name"" : ""rightTrigger"",
-                        ""parameters"" : ""pressPoint=0.2""
-                    }
-                ]
-            }
-        ";
-
-        InputSystem.RegisterLayout(json);
-        var gamepad = InputDevice.Build<Gamepad>("CustomGamepad");
-
-        Assert.That(gamepad.rightTrigger.pressPoint, Is.EqualTo(0.2f).Within(0.0001f));
-    }
-
     [Test]
     [Category("Controls")]
     public void Controls_DisplayNameDefaultsToControlName()
@@ -1419,7 +1327,7 @@ public void Controls_CanKeepListsOfControls_WithoutAllocatingGCMemory()
             Assert.That(list[3], Is.SameAs(keyboard));
             Assert.That(() => list[4], Throws.TypeOf<ArgumentOutOfRangeException>());
             Assert.That(list.ToArray(),
-                Is.EquivalentTo(new InputControl[] {gamepad.leftStick, null, keyboard.spaceKey, keyboard}));
+                Is.EquivalentTo(new InputControl[] { gamepad.leftStick, null, keyboard.spaceKey, keyboard }));
             Assert.That(list.Contains(gamepad.leftStick));
             Assert.That(list.Contains(null));
             Assert.That(list.Contains(keyboard.spaceKey));
@@ -1436,27 +1344,27 @@ public void Controls_CanKeepListsOfControls_WithoutAllocatingGCMemory()
             Assert.That(list[0], Is.SameAs(gamepad.leftStick));
             Assert.That(list[1], Is.SameAs(keyboard.spaceKey));
             Assert.That(() => list[2], Throws.TypeOf<ArgumentOutOfRangeException>());
-            Assert.That(list.ToArray(), Is.EquivalentTo(new InputControl[] {gamepad.leftStick, keyboard.spaceKey}));
+            Assert.That(list.ToArray(), Is.EquivalentTo(new InputControl[] { gamepad.leftStick, keyboard.spaceKey }));
             Assert.That(list.Contains(gamepad.leftStick));
             Assert.That(!list.Contains(null));
             Assert.That(list.Contains(keyboard.spaceKey));
             Assert.That(!list.Contains(keyboard));
 
-            list.AddRange(new InputControl[] {keyboard.aKey, keyboard.bKey}, count: 1, destinationIndex: 0);
+            list.AddRange(new InputControl[] { keyboard.aKey, keyboard.bKey }, count: 1, destinationIndex: 0);
 
             Assert.That(list.Count, Is.EqualTo(3));
             Assert.That(list.Capacity, Is.EqualTo(4));
             Assert.That(list,
                 Is.EquivalentTo(new InputControl[]
-                    {keyboard.aKey, gamepad.leftStick, keyboard.spaceKey}));
+                    { keyboard.aKey, gamepad.leftStick, keyboard.spaceKey }));
 
-            list.AddRange(new InputControl[] {keyboard.bKey, keyboard.cKey});
+            list.AddRange(new InputControl[] { keyboard.bKey, keyboard.cKey });
 
             Assert.That(list.Count, Is.EqualTo(5));
             Assert.That(list.Capacity, Is.EqualTo(10));
             Assert.That(list,
                 Is.EquivalentTo(new InputControl[]
-                    {keyboard.aKey, gamepad.leftStick, keyboard.spaceKey, keyboard.bKey, keyboard.cKey}));
+                    { keyboard.aKey, gamepad.leftStick, keyboard.spaceKey, keyboard.bKey, keyboard.cKey }));
 
             using (var toAdd = new InputControlList<InputControl>(gamepad.buttonNorth, gamepad.buttonEast, gamepad.buttonWest))
                 list.AddSlice(toAdd, count: 1, destinationIndex: 1, sourceIndex: 2);
@@ -1465,13 +1373,17 @@ public void Controls_CanKeepListsOfControls_WithoutAllocatingGCMemory()
             Assert.That(list.Capacity, Is.EqualTo(10));
             Assert.That(list,
                 Is.EquivalentTo(new InputControl[]
-                    {keyboard.aKey, gamepad.buttonWest, gamepad.leftStick, keyboard.spaceKey, keyboard.bKey, keyboard.cKey}));
+                {
+                    keyboard.aKey, gamepad.buttonWest, gamepad.leftStick, keyboard.spaceKey, keyboard.bKey, keyboard.cKey
+                }));
 
             list[0] = keyboard.zKey;
 
             Assert.That(list,
                 Is.EquivalentTo(new InputControl[]
-                    {keyboard.zKey, gamepad.buttonWest, gamepad.leftStick, keyboard.spaceKey, keyboard.bKey, keyboard.cKey}));
+                {
+                    keyboard.zKey, gamepad.buttonWest, gamepad.leftStick, keyboard.spaceKey, keyboard.bKey, keyboard.cKey
+                }));
 
             list.Clear();
 

Assets/Tests/InputSystem/ActuationPressPointTests.cs.meta

@@ -28,8 +28,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Fixed an issue where `UIToolkit` `ClickEvent` could be fired on Android after device rotation due to inactive touch state being replayed during action initial state checks [UUM-100125](https://jira.unity3d.com/browse/UUM-100125).
 - Fixed InputSystem.onAnyButtonPress fails to trigger when the device receives a touch [UUM-137930](https://issuetracker.unity3d.com/product/unity/issues/guid/UUM-137930).
 - Fixed an incorrect ArraysHelper.HaveDuplicateReferences implementation that didn't use its arguments right [ISXB-1792] (https://github.com/Unity-Technologies/InputSystem/pull/2376)
+- Fixed `InputAction.IsPressed`, `WasPressedThisFrame`, and `WasReleasedThisFrame` using a `ButtonControl`'s `pressPoint` when a binding also had an explicit `PressInteraction` with its own `pressPoint`, which could make those APIs disagree with the interaction's press and release behavior. Action-level press APIs now follow the interaction threshold when both are set explicitly.
 
 ### Changed
+- Action-level `IsPressed`, `WasPressedThisFrame`, and `WasReleasedThisFrame` for bindings to `Vector2Control` / `StickControl` no longer consult a per-control `pressPoint` on the vector (that field was removed). Use a `Press` interaction to set a custom threshold, or rely on `defaultButtonPressPoint`.
 - Removed 32-bit compilation check for HID on Windows players, which had no impact anymore. (ISX-2543)
 - Migrated sample scenes to use Universal Render Pipeline (URP) with Built-in Render Pipeline fallback shaders. The URP package is now required to run the samples. (ISX-2343)
 - Changed the UI for `Actions.inputactions` asset to use UI Toolkit framework.

Assets/Tests/InputSystem/CoreTests_Actions.cs

@@ -172,6 +172,8 @@ If you haven't specifically added an Interaction to a Binding or its Action, the
 
 You can use a [`PressInteraction`](xref:UnityEngine.InputSystem.Interactions.PressInteraction) to explicitly force button-like interactions. Use the [`behavior`](xref:UnityEngine.InputSystem.Interactions.PressInteraction.behavior) parameter to select if the Interaction should trigger on button press, release, or both.
 
+If you stack several `Press` interactions on the same binding, each still runs with its own parameters. Separately, [`IsPressed`](xref:UnityEngine.InputSystem.InputAction.IsPressed), [`WasPressedThisFrame`](xref:UnityEngine.InputSystem.InputAction.WasPressedThisFrame), and [`WasReleasedThisFrame`](xref:UnityEngine.InputSystem.InputAction.WasReleasedThisFrame) pick a single actuation threshold by scanning interactions in list order and using the `pressPoint` from the first `Press` interaction whose `pressPoint` is greater than zero.
+
 |__Parameters__|Type|Default value|
 |---|---|---|
 |[`pressPoint`](xref:UnityEngine.InputSystem.Interactions.PressInteraction.pressPoint)|`float`|[`InputSettings.defaultButtonPressPoint`](xref:UnityEngine.InputSystem.InputSettings.defaultButtonPressPoint)|