NEW: Add Android backButtonLeavesApp to New Input #1914

manugildev · 2024-04-24T08:11:27Z

Description

Add backButtonLeavesApp support for New Input System.

Changes made

This PR creates a new AndroidDevice that is registered during initialization. This AndroidDevice represents a handheld device, and can be use to store device specific input functions that are not part of other input devices such as the keyboard, gamepad or sensors.

We also added SetCustomCommand and GetCustomCommand used to be able to set and get respectively a payload between the InputSystem package and runtime. This is then used to set and get backButtonLeavesApp to the native runtime. This two new commands are general purpose commands, and can be used for any other input device.

backButtonLeavesApp, is just a boolean flag needed for Predictive Back Gesture (PBG) support to work on Android. This allows users to preview the destination or other result of a back gesture before fully completing it, allowing them to decide whether to continue or stay in the current view.

Notes

This new API can be used as such:

InputSystem.settings.android.backButtonLeavesApp = true;

Checklist

Before review:

Changelog entry added.
- Explains the change in Changed, Fixed, Added sections.
- For API change contains an example snippet and/or migration example.
- FogBugz ticket attached, example ([case %number%](https://issuetracker.unity3d.com/issues/...)).
- FogBugz is marked as "Resolved" with next release version correctly set.
Tests added/changed, if applicable.
- Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
- Performance tests.
- Integration tests.
Docs for new/changed API's.
- Xmldoc cross references are set correctly.
- Added explanation how the API works.
- Usage code examples added.
- The manual is updated, if needed.

During merge:

Commit message for squash-merge is prefixed with one of the list:
- NEW: ___.
- FIX: ___.
- DOCS: ___.
- CHANGE: ___.
- RELEASE: 1.1.0-preview.3.

unity-cla-assistant · 2024-04-24T08:11:32Z

All committers have signed the CLA.

ekcoh

@manugildev Thanks for submitting this PR. Would you mind filling in the PR template to aid the review process for this new functionality and API surface being proposed? Instructions for filling in the PR template are available in the PR itself but also here: https://github.com/Unity-Technologies/InputSystem/blob/develop/.github/pull_request_template.md
Clearly describing the purpose of the PR and motivating the changes made makes it simpler to understand and review.

In addition som initial questions:

This is adding a new type of device, AndroidDevice that communicates with the native backend/run-time via IOCTL command GCC. However I do not see any Unity version dependent #ifdef checks present. Is this IOCTL command available back to Unity 2019 which the Input System package is still compliant with? If not, please guard the availability of this feature under appropriate compile-time version checks if intended to just return default if runtime is not implementing the IOCTL command and document from which Unity version this is expected to work, or guard the API under a certain UNITY version to control availability.
Noted that CHANGELOG.md do not contain an addition under ADD section describing the addition, would it be possible to get that added?

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/GetCustomCommand.cs

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/AndroidDevice.cs

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/AndroidSupport.cs

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/GetCustomCommand.cs

todi1856 · 2024-04-29T09:27:57Z

P.S you probably need to some tests to validate SetCustomCommand/GetCustomCommand works fine

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/InputSettingsAndroid.cs

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/AndroidDevice.cs

s

…nLeavesApp on device

todi1856 · 2024-05-02T06:34:26Z

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/AndroidDevice.cs

+    public class AndroidDevice : InputDevice
+    {
+        [InputControl(synthetic = true)]
+        public ButtonControl button { get; protected set; }


What's this? I see it's a public API, how would user use it ?

Not sure how to get rid of this ButtonControl. InputDevices need to have AT LEAST one control. If not they throw an exception. In our case, this controls is not needed

@manugildev Could you provide some additional context regarding what exception/trace you did get?

@ekcoh I have tried pretty much everything but I couldn't find a way to have no ButtonControl. This is the exception I am hitting (code).

Could not create a device for 'AndroidDevice (Android)' (exception: System.InvalidOperationException: Control '/AndroidDevice' with layout 'AndroidDevice' has no size set and has no children to compute size from at UnityEngine.InputSystem.Layouts.InputDeviceBuilder.ComputeStateLayout (UnityEngine.InputSystem.InputControl control) at UnityEngine.InputSystem.Layouts.InputDeviceBuilder.InstantiateLayout (UnityEngine.InputSystem.Layouts.InputControlLayout layout, UnityEngine.InputSystem.Utilities.InternedString variants, UnityEngine.InputSystem.Utilities.InternedString name, UnityEngine.InputSystem.InputControl parent) at UnityEngine.InputSystem.Layouts.InputDeviceBuilder.Setup (UnityEngine.InputSystem.Utilities.InternedString layout, UnityEngine.InputSystem.Utilities.InternedString variants, UnityEngine.InputSystem.Layouts.InputDeviceDescription deviceDescription)

There is in fact a test that check that a DeviceWithNoControls fails to be created: Controls_CanTurnControlPathIntoHumanReadableText_EvenIfLayoutCannotBeFoundOrHasErrors

ritamerkl · 2024-05-28T13:51:55Z

Add/change deprecation message to Input.bindings backButtonLeavesApp once ready to land.

ekcoh

Left another round of review comments. Generally I struggle a bit to see how this fits API-wise. It seems like we are transforming a cross-platform interface into a OS-specific here and introducing what I assume is supposed to be a non-removable device representing the system.

Thanks for updating migration doc but I also think there is some guidance needed to explain how this boolean flag is expected to be used for the preview render feature. At the moment I do not fully understand how I should reason about this setting or what I need to do differently depending on how this flag is set. Happy to follow-up via DM or have a chat and maybe a demo that helps clarify this.

Assets/Tests/InputSystem/CoreTests_Devices.cs

Assets/Tests/InputSystem/Plugins/AndroidTests.cs

Packages/com.unity.inputsystem/InputSystem/Devices/Commands/GetCustomCommand.cs

ekcoh · 2024-06-13T20:55:42Z

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/AndroidDevice.cs

+    public class AndroidDevice : InputDevice
+    {
+        [InputControl(synthetic = true)]
+        public ButtonControl button { get; protected set; }


@manugildev Could you provide some additional context regarding what exception/trace you did get?

ekcoh · 2024-06-13T21:01:57Z

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/InputSettingsAndroid.cs

+        /// Project-wide input settings for the Android platform.
+        /// </summary>
+        [Serializable]
+        public class AndroidSettings


Why would this be something Android specific when we advertise it as cross-platform on 3 operating systems for the UnityEngine.Input counterpart? https://docs.unity3d.com/ScriptReference/Input-backButtonLeavesApp.html

@ekcoh backButtonLeavesApp is a legacy input setting. It's only living on Android land now, it is needed for predictive back gesture to work (which is something we have implemented for Android 14 as per Google's request).

Even if we have the code for Windows platforms still living in unity/unity, there are no supported device that has a physical back button anymore. They only had them in Windows Phones and early Windows RT tablets, none of which are supported anymore. This has been confirmed by the windows-platform team.

So it makes sense that moving into the new Input System, we only added in the only device that still has a back button functionality, Android.

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/InputSettingsAndroid.cs

manugildev · 2024-06-21T15:07:51Z

(force push the only contains auto formatter changes)

manugildev · 2024-06-24T09:43:54Z

@ekcoh I did some new changes based on the code review. Let me know if this is ready so I can proceed with landing the unity/unity PR first.

ekcoh · 2024-06-25T10:25:32Z

Sorry for providing this feedback at this stage, but I would suggest we do not land this PR for the following reasons:

This API (backButtonLeavesApp), is a poor fit for a device representation. Only adds overhead and contains no streaming data and isn't tightly related to input.
A corresponding API backButtonLeavesApp already exists in UnityEngine.Input and seems (in native implementation) to not be tied to InputManager at all so I see no reason to have two versions of the same API?

Please let me know or DM me if there is some value you see with this additional API in addition to what already exists in Unity.Input?

seeyam-q · 2024-08-02T15:20:15Z

@ekcoh Hello I stumbled upon this thread as I was searching for the Input System's equivalent to backButtonLeavesApp. Because it is recommended to only have the new Input System enabled in the Unity project, backButtonLeavesApp in UnityEngine.Input doesn't work anymore.

It is very confusing to say "No corresponding API yet." in the Input System doc without providing a workaround to handle back button on Android, especially considering back button behavior is required by Google Play Store.

If Unity is not supporting backButtonLeavesApp in the Input System for engineering reasons, can you at least provide a work around of handling back button in the Input System in the documentation?

manugildev · 2024-08-05T08:46:26Z

@seeyam-q thanks for bringing this up! Actually, last friday we merged a change to make Input.backButtonLeavesApp work on the new Input System on Android.

We are expecting these changes to land in 6000.0.14f1, 2022.3.42f1 and 2021.3.43f1.

→ Issue Tracker Link UUM-41638

ekcoh requested changes Apr 25, 2024

View reviewed changes

todi1856 reviewed Apr 29, 2024

View reviewed changes

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/GetCustomCommand.cs Outdated Show resolved Hide resolved

todi1856 reviewed Apr 30, 2024

View reviewed changes

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/InputSettingsAndroid.cs Show resolved Hide resolved

manugildev added 8 commits April 30, 2024 15:12

NEW: Add Android backButtonLeavesApp to New Input

ec1af5c

[Android] add backButtonLeavesApp to Migration guide

d1579f0

[Android] Add backButtonLeavesApp to Changelog

e448726

[Android] Move CustomCommand to general purpose device command

a82c6bf

[Android] Add UNITY_6000_0 guard to new AndroidDevice

6d78037

Add tests for SetCustomCommand and GetCustomCommand

ce5ad83

Run formatter

c6ffc5f

[Android] Avoid calling .ApplySettings() unnecessarily

0edd9b6

manugildev force-pushed the platform/android/add-back-button-leaves-app-new-input branch from 971e6e3 to ab07662 Compare April 30, 2024 13:14

todi1856 reviewed Apr 30, 2024

View reviewed changes

Packages/com.unity.inputsystem/InputSystem/Plugins/Android/AndroidDevice.cs Show resolved Hide resolved

manugildev force-pushed the platform/android/add-back-button-leaves-app-new-input branch from a28f01d to 04e1db1 Compare April 30, 2024 14:31

[Android] Add docs generation for AndroidDevice

95dbff1

s

manugildev force-pushed the platform/android/add-back-button-leaves-app-new-input branch 3 times, most recently from 37c9174 to 6f93df2 Compare April 30, 2024 14:50

[Android] Add test for setting InputSystem.settings.android.backButto…

2dc6312

…nLeavesApp on device

manugildev force-pushed the platform/android/add-back-button-leaves-app-new-input branch from 6f93df2 to 2dc6312 Compare April 30, 2024 16:10

manugildev marked this pull request as ready for review April 30, 2024 17:05

manugildev requested a review from ekcoh April 30, 2024 17:05

todi1856 reviewed May 2, 2024

View reviewed changes

[Android] Change AndroidDevice visibility to internal

a333cae

todi1856 approved these changes May 28, 2024

View reviewed changes

ekcoh reviewed Jun 13, 2024

View reviewed changes

[Tests] Set unsafe calls instead of whole methods

84e41ff

[Android] Add example of backButton handling

d4f551d

manugildev force-pushed the platform/android/add-back-button-leaves-app-new-input branch 2 times, most recently from 6b5b8fb to fb47d36 Compare June 21, 2024 15:07

[Docs] Fix issue with docs validator

98add9b

manugildev force-pushed the platform/android/add-back-button-leaves-app-new-input branch from fb47d36 to 98add9b Compare June 24, 2024 09:01

manugildev requested a review from ekcoh June 24, 2024 09:43

manugildev closed this Aug 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NEW: Add Android backButtonLeavesApp to New Input #1914

NEW: Add Android backButtonLeavesApp to New Input #1914

manugildev commented Apr 24, 2024 •

edited

Loading

unity-cla-assistant commented Apr 24, 2024 •

edited

Loading

ekcoh left a comment

todi1856 commented Apr 29, 2024

todi1856 May 2, 2024

manugildev May 20, 2024

ekcoh Jun 13, 2024

manugildev Jun 20, 2024 •

edited

Loading

ritamerkl commented May 28, 2024

ekcoh left a comment

ekcoh Jun 13, 2024

ekcoh Jun 13, 2024

manugildev Jun 20, 2024

manugildev commented Jun 21, 2024

manugildev commented Jun 24, 2024

ekcoh commented Jun 25, 2024

seeyam-q commented Aug 2, 2024

manugildev commented Aug 5, 2024 •

edited

Loading

NEW: Add Android backButtonLeavesApp to New Input #1914

NEW: Add Android backButtonLeavesApp to New Input #1914

Conversation

manugildev commented Apr 24, 2024 • edited Loading

Description

Changes made

Notes

Checklist

unity-cla-assistant commented Apr 24, 2024 • edited Loading

ekcoh left a comment

Choose a reason for hiding this comment

todi1856 commented Apr 29, 2024

todi1856 May 2, 2024

Choose a reason for hiding this comment

manugildev May 20, 2024

Choose a reason for hiding this comment

ekcoh Jun 13, 2024

Choose a reason for hiding this comment

manugildev Jun 20, 2024 • edited Loading

Choose a reason for hiding this comment

ritamerkl commented May 28, 2024

ekcoh left a comment

Choose a reason for hiding this comment

ekcoh Jun 13, 2024

Choose a reason for hiding this comment

ekcoh Jun 13, 2024

Choose a reason for hiding this comment

manugildev Jun 20, 2024

Choose a reason for hiding this comment

manugildev commented Jun 21, 2024

manugildev commented Jun 24, 2024

ekcoh commented Jun 25, 2024

seeyam-q commented Aug 2, 2024

manugildev commented Aug 5, 2024 • edited Loading

manugildev commented Apr 24, 2024 •

edited

Loading

unity-cla-assistant commented Apr 24, 2024 •

edited

Loading

manugildev Jun 20, 2024 •

edited

Loading

manugildev commented Aug 5, 2024 •

edited

Loading