NEW: Support StepCounter on iOS (#1253).

Author: todi1856

Assets/Tests/InputSystem/APIVerificationTests.cs

@@ -15,6 +15,7 @@
 using UnityEngine.InputSystem.DualShock;
 using UnityEngine.InputSystem.Editor;
 using UnityEngine;
+using UnityEngine.InputSystem.iOS.LowLevel;
 using UnityEngine.InputSystem.Utilities;
 using Object = System.Object;
 using TypeAttributes = Mono.Cecil.TypeAttributes;
@@ -424,7 +425,12 @@ private bool IgnoreTypeWithoutPreserveAttribute(Type type)
         if (type == typeof(FastKeyboard)
             || type == typeof(FastMouse)
             || type == typeof(FastTouchscreen)
-            || type == typeof(FastDualShock4GamepadHID))
+            || type == typeof(FastDualShock4GamepadHID)
+#if UNITY_EDITOR || UNITY_IOS || UNITY_TVOS
+            // iOS Step Counter is created from C# code
+            || type == typeof(iOSStepCounter)
+#endif
+        )
             return true;
 
         return false;
@@ -447,7 +453,7 @@ public void API_DoesNotHaveUndocumentedPublicTypes()
     {
         var docsFolder = GenerateDocsDirectory();
         var undocumentedTypes = GetInputSystemPublicTypes().Where(type => !IgnoreTypeForDocs(type) && string.IsNullOrEmpty(TypeSummary(type, docsFolder)));
-        Assert.That(undocumentedTypes, Is.Empty, $"Got {undocumentedTypes.Count()} undocumented types.");
+        Assert.That(undocumentedTypes, Is.Empty, $"Got {undocumentedTypes.Count()} undocumented types, the docs are generated in {docsFolder}");
     }
 
     [Test]

Assets/Tests/InputSystem/Plugins/iOSTests.cs

@@ -7,8 +7,11 @@
 using UnityEngine.InputSystem.Layouts;
 using UnityEngine.InputSystem.iOS;
 using UnityEngine.InputSystem.iOS.LowLevel;
+using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.InputSystem.Processors;
 using UnityEngine.InputSystem.XInput;
+using UnityEngine.TestTools;
+using UnityEngine.TestTools.Utils;
 
 internal class iOSTests : InputTestFixture
 {
@@ -79,5 +82,20 @@ public void Devices_SupportsiOSSensors(string deviceClass, Type sensorType)
         Assert.That(InputSystem.devices[0].description.interfaceName, Is.EqualTo("iOS"));
         Assert.That(InputSystem.devices[0].description.deviceClass, Is.EqualTo(deviceClass));
     }
+
+    [Test]
+    [Category("Devices")]
+    public void Devices_SupportsiOSStepCounter()
+    {
+        var device = InputSystem.AddDevice<iOSStepCounter>();
+        LogAssert.Expect(LogType.Error, "Please enable Motion Usage in Input Settings before using Step Counter.");
+        InputSystem.EnableDevice(device);
+
+        InputSystem.settings.iOS.motionUsage.enabled = true;
+        InputSystem.EnableDevice(device);
+        InputSystem.QueueStateEvent(device, new iOSStepCounterState(){stepCounter = 5});
+        InputSystem.Update();
+        Assert.That(device.stepCounter.ReadValue(), Is.EqualTo(5));
+    }
 }
 #endif // UNITY_EDITOR || UNITY_ANDROID

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -76,6 +76,8 @@ however, it has to be formatted properly to pass verification tests.
                   Debug.Log($"Button {button} was pressed");
       }
   ```
+  - Added support for Step Counter sensors for iOS.
+    * You need to enable **Motion Usage** under Input System settings before using the sensor. You can also manually add **Privacy - Motion Usage Description** to your application's Info.plist file.
 
 ## [1.1.0-preview.2] - 2020-10-23
 

Packages/com.unity.inputsystem/Documentation~/Images/InputSettings.png

@@ -1,5 +1,19 @@
 # Sensor support
 
+* [Sampling Frequency](#sampling-frequency)
+* [Accelerometer](#accelerometer)
+* [Gyroscope](#gyroscope)
+* [GravitySensor](#gravitysensor)
+* [AttitudeSensor](#attitudesensor)
+* [LinearAccelerationSensor](#linearaccelerationsensor)
+* [MagneticFieldSensor](#magneticfieldsensor)
+* [LightSensor](#lightsensor)
+* [PressureSensor](#pressuresensor)
+* [ProximitySensor](#proximitysensor)
+* [HumiditySensor](#humiditysensor)
+* [AmbientTemperatureSensor](#ambienttemperaturesensor)
+* [StepCounter](#stepcounter)
+
 Sensors are [`InputDevices`](Devices.md) that measure environmental characteristics of the device that the content is running on. Unity currently supports sensors on iOS and Android. Android supports a wider range of sensors than iOS.
 
 Unlike other devices, sensors are disabled by default. To enable a sensor, call [`InputSystem.EnableDevice()`](../api/UnityEngine.InputSystem.InputSystem.html#UnityEngine_InputSystem_InputSystem_EnableDevice_UnityEngine_InputSystem_InputDevice_)).
@@ -36,7 +50,7 @@ Each sensor Device implements a single Control which represents the data read by
 |[`ProximitySensor`](#proximitysensor)|Yes|No|[`distance`](../api/UnityEngine.InputSystem.ProximitySensor.html#UnityEngine_InputSystem_ProximitySensor_distance)|[`AxisControl`](../api/UnityEngine.InputSystem.Controls.AxisControl.html)|
 |[`HumiditySensor`](#humiditysensor)|Yes|No|[`relativeHumidity`](../api/UnityEngine.InputSystem.HumiditySensor.html#UnityEngine_InputSystem_HumiditySensor_relativeHumidity)|[`AxisControl`](../api/UnityEngine.InputSystem.Controls.AxisControl.html)|
 |[`AmbientTemperatureSensor`](#ambienttemperaturesensor)|Yes|No|[`ambientTemperature`](../api/UnityEngine.InputSystem.AmbientTemperatureSensor.html#UnityEngine_InputSystem_AmbientTemperatureSensor_ambientTemperature)|[`AxisControl`](../api/UnityEngine.InputSystem.Controls.AxisControl.html)|
-|[`StepCounter`](#stepcounter)|Yes|No|[`stepCounter`](../api/UnityEngine.InputSystem.StepCounter.html#UnityEngine_InputSystem_StepCounter_stepCounter)|[`IntegerControl`](../api/UnityEngine.InputSystem.Controls.IntegerControl.html)|
+|[`StepCounter`](#stepcounter)|Yes|Yes|[`stepCounter`](../api/UnityEngine.InputSystem.StepCounter.html#UnityEngine_InputSystem_StepCounter_stepCounter)|[`IntegerControl`](../api/UnityEngine.InputSystem.Controls.IntegerControl.html)|
 
 ## Sampling frequency
 
@@ -97,3 +111,5 @@ This Input Device represents the ambient air temperature measured by the device
 ## <a name="stepcounter"></a>[`StepCounter`](../api/UnityEngine.InputSystem.StepCounter.html)
 
 This Input Device represents the user's footstep count as measured by the device which is running the content.
+
+>NOTE: To access the pedometer on iOS/tvOS devices, you need to enable the [__Motion Usage__ setting](Settings.md#iostvos) in the [Input Settings](Settings.md).

Packages/com.unity.inputsystem/Documentation~/Images/iOSSettings.png

@@ -98,3 +98,12 @@ To force the Editor to add all locally available Devices, even if they're not in
 ![Add Devices Not Listed In Supported Devices](Images/AddDevicesNotListedInSupportedDevices.png)
 
 This setting is stored as a user setting (that is, other users who open the same Project can't see the setting).
+
+## Platform-specific settings
+
+### iOS/tvOS
+
+![iOSSettings](Images/iOSSettings.png)
+
+* __Motion Usage__<br>
+  Governs access to the [pedometer](Sensors.md# on the device. If enabled, the __Description__ string supplied in the settings will be added to the application's Info.plist

Packages/com.unity.inputsystem/Documentation~/Sensors.md

@@ -522,17 +522,23 @@ protected virtual void OnRemoved()
         public unsafe long ExecuteCommand<TCommand>(ref TCommand command)
             where TCommand : struct, IInputDeviceCommandInfo
         {
+            var commandPtr = (InputDeviceCommand*)UnsafeUtility.AddressOf(ref command);
             // Give callbacks first shot.
             var manager = InputSystem.s_Manager;
             var callbacks = manager.m_DeviceCommandCallbacks;
             for (var i = 0; i < callbacks.length; ++i)
             {
-                var result = callbacks[i](this, (InputDeviceCommand*)UnsafeUtility.AddressOf(ref command));
+                var result = callbacks[i](this, commandPtr);
                 if (result.HasValue)
                     return result.Value;
             }
 
-            return InputRuntime.s_Instance.DeviceCommand(deviceId, ref command);
+            return ExecuteCommand((InputDeviceCommand*)UnsafeUtility.AddressOf(ref command));
+        }
+
+        protected virtual unsafe long ExecuteCommand(InputDeviceCommand* commandPtr)
+        {
+            return InputRuntime.s_Instance.DeviceCommand(deviceId, commandPtr);
         }
 
         [Flags]

Packages/com.unity.inputsystem/Documentation~/Settings.md

@@ -623,6 +623,9 @@ protected override void FinishSetup()
     /// <summary>
     /// Input device representing the foot steps taken by the user as measured by the device playing the content.
     /// </summary>
+    /// <remarks>
+    /// On iOS, access to the step counter must be enabled via <see cref="InputSettings.iOSSettings.motionUsage"/>.
+    /// </remarks>
     [InputControlLayout(displayName = "Step Counter")]
     [Scripting.Preserve]
     public class StepCounter : Sensor

Packages/com.unity.inputsystem/InputSystem/Devices/InputDevice.cs

@@ -126,11 +126,20 @@ public override void OnGUI(string searchContext)
 
                 m_SupportedDevices.DoLayoutList();
 
+                EditorGUILayout.LabelField("iOS", EditorStyles.boldLabel);
+                EditorGUILayout.Space();
+                m_iOSProvider.OnGUI();
+
                 if (EditorGUI.EndChangeCheck())
                     Apply();
             }
         }
 
+        private static void ShowPlatformSettings()
+        {
+            // Would be nice to get BuildTargetDiscovery.GetBuildTargetInfoList since that contains information about icons etc
+        }
+
         private static void CreateNewSettingsAsset(string relativePath)
         {
             // Create settings file.
@@ -301,6 +310,8 @@ private void InitializeWithCurrentSettings()
                     EditorGUI.LabelField(rect, m_Settings.supportedDevices[index]);
                 }
             };
+
+            m_iOSProvider = new InputSettingsiOSProvider(m_SettingsObject);
         }
 
         private void Apply()
@@ -368,6 +379,8 @@ private static string[] FindInputSettingsInProject()
         GUIContent m_TapRadiusContent;
         GUIContent m_MultiTapDelayTimeContent;
 
+        [NonSerialized] private InputSettingsiOSProvider m_iOSProvider;
+
         private static InputSettingsProvider s_Instance;
 
         internal static void ForceReload()