CHANGE: Move XR layouts (except Magic Leap) back into input system (#910).

Author: Rene Damm

Assets/Tests/InputSystem/APIVerificationTests.cs

@@ -19,6 +19,12 @@ private bool IsValidNameForConstant(string name)
 
     private bool TypeHasValidNamespace(TypeReference type)
     {
+        // The XR stuff is putting some things in Unity.XR and UnityEngine.XR. While we still have
+        // these in the input system itself, accept that namespace. Remove it when
+        // the XR layouts are removed.
+        if (type.Namespace.StartsWith("Unity.XR") || type.Namespace.StartsWith("UnityEngine.XR"))
+            return true;
+
         // The compiler generates a <Module> type which we want to ignore
         return type.Namespace.StartsWith("UnityEngine.InputSystem") || type.Name == "<Module>";
     }
@@ -398,6 +404,8 @@ bool IgnoreTypeForDocs(TypeDefinition type)
             type.FullName == typeof(UnityEngine.InputSystem.Processors.EditorWindowSpaceProcessor).FullName ||
             // All our XR stuff completely lacks docs. Get XR team to fix this.
             type.Namespace.StartsWith("UnityEngine.InputSystem.XR") ||
+            type.Namespace.StartsWith("UnityEngine.XR") ||
+            type.Namespace.StartsWith("Unity.XR") ||
             false;
     }
 

Assets/Tests/InputSystem/Plugins/XRTests.cs

@@ -133,9 +133,9 @@ public void Layouts_XRLayoutFeatures_OnlyContainAllowedCharacters()
 
         var generatedLayout = InputSystem.LoadLayout(createdDevice.layout);
         Assert.That(generatedLayout, Is.Not.Null);
-        Assert.That(generatedLayout.controls.Count, Is.EqualTo(1));
+        Assert.That(generatedLayout.controls.Count, Is.EqualTo(kNumBaseHMDControls + 1));
 
-        var childControl = generatedLayout.controls[0];
+        var childControl = generatedLayout["SimpleFeature1"];
         Assert.That(childControl.name, Is.EqualTo(new InternedString("SimpleFeature1")));
     }
 
@@ -226,44 +226,44 @@ public void Layouts_AllFeatureTypes_AreRepresentedInTheGeneratedLayout()
 
         var generatedLayout = InputSystem.LoadLayout("XRInputV1::XRManufacturer::XRDevice");
         Assert.That(generatedLayout, Is.Not.Null);
-        Assert.That(generatedLayout.controls.Count, Is.EqualTo(7));
+        Assert.That(generatedLayout.controls.Count, Is.EqualTo(kNumBaseHMDControls + 7));
 
-        var binaryControl = generatedLayout.controls[0];
+        var binaryControl = generatedLayout["Button"];
         Assert.That(binaryControl.name, Is.EqualTo(new InternedString("Button")));
         Assert.That(binaryControl.offset, Is.EqualTo(0));
         Assert.That(binaryControl.layout, Is.EqualTo(new InternedString("Button")));
         Assert.That(binaryControl.usages.Count, Is.EqualTo(1));
         Assert.That(binaryControl.usages[0], Is.EqualTo(new InternedString("ButtonUsage")));
 
-        var discreteControl = generatedLayout.controls[1];
+        var discreteControl = generatedLayout["DiscreteState"];
         Assert.That(discreteControl.name, Is.EqualTo(new InternedString("DiscreteState")));
         Assert.That(discreteControl.offset, Is.EqualTo(4));
         Assert.That(discreteControl.layout, Is.EqualTo(new InternedString("Integer")));
         Assert.That(discreteControl.usages.Count, Is.EqualTo(1));
         Assert.That(discreteControl.usages[0], Is.EqualTo(new InternedString("DiscreteStateUsage")));
 
-        var axisControl = generatedLayout.controls[2];
+        var axisControl = generatedLayout["Axis"];
         Assert.That(axisControl.name, Is.EqualTo(new InternedString("Axis")));
         Assert.That(axisControl.offset, Is.EqualTo(8));
         Assert.That(axisControl.layout, Is.EqualTo(new InternedString("Analog")));
         Assert.That(axisControl.usages.Count, Is.EqualTo(1));
         Assert.That(axisControl.usages[0], Is.EqualTo(new InternedString("Axis1DUsage")));
 
-        var vec2Control = generatedLayout.controls[3];
+        var vec2Control = generatedLayout["Vector2"];
         Assert.That(vec2Control.name, Is.EqualTo(new InternedString("Vector2")));
         Assert.That(vec2Control.offset, Is.EqualTo(12));
         Assert.That(vec2Control.layout, Is.EqualTo(new InternedString("Vector2")));
         Assert.That(vec2Control.usages.Count, Is.EqualTo(1));
         Assert.That(vec2Control.usages[0], Is.EqualTo(new InternedString("Axis2DUsage")));
 
-        var vec3Control = generatedLayout.controls[4];
+        var vec3Control = generatedLayout["Vector3"];
         Assert.That(vec3Control.name, Is.EqualTo(new InternedString("Vector3")));
         Assert.That(vec3Control.offset, Is.EqualTo(20));
         Assert.That(vec3Control.layout, Is.EqualTo(new InternedString("Vector3")));
         Assert.That(vec3Control.usages.Count, Is.EqualTo(1));
         Assert.That(vec3Control.usages[0], Is.EqualTo(new InternedString("Axis3DUsage")));
 
-        var rotationControl = generatedLayout.controls[5];
+        var rotationControl = generatedLayout["Rotation"];
         Assert.That(rotationControl.name, Is.EqualTo(new InternedString("Rotation")));
         Assert.That(rotationControl.offset, Is.EqualTo(32));
         Assert.That(rotationControl.layout, Is.EqualTo(new InternedString("Quaternion")));
@@ -272,7 +272,7 @@ public void Layouts_AllFeatureTypes_AreRepresentedInTheGeneratedLayout()
 
         // Custom element is skipped, but occupies 256 bytes
 
-        var lastControl = generatedLayout.controls[6];
+        var lastControl = generatedLayout["Last"];
         Assert.That(lastControl.name, Is.EqualTo(new InternedString("Last")));
         Assert.That(lastControl.offset, Is.EqualTo(304));
         Assert.That(lastControl.layout, Is.EqualTo(new InternedString("Button")));
@@ -291,37 +291,37 @@ public void Layouts_ButtonsArePackedByTheByte_WhileLargerStructuresAreFourByteAl
 
         var generatedLayout = InputSystem.LoadLayout("XRInputV1::XRManufacturer::XRDevice");
         Assert.That(generatedLayout, Is.Not.Null);
-        Assert.That(generatedLayout.controls.Count, Is.EqualTo(8));
+        Assert.That(generatedLayout.controls.Count, Is.EqualTo(kNumBaseHMDControls + 8));
 
-        var currentControl = generatedLayout.controls[0];
+        var currentControl = generatedLayout["Button1"];
         Assert.That(currentControl.offset, Is.EqualTo(0));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Button")));
 
-        currentControl = generatedLayout.controls[1];
+        currentControl = generatedLayout["Button2"];
         Assert.That(currentControl.offset, Is.EqualTo(1));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Button")));
 
-        currentControl = generatedLayout.controls[2];
+        currentControl = generatedLayout["Button3"];
         Assert.That(currentControl.offset, Is.EqualTo(2));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Button")));
 
-        currentControl = generatedLayout.controls[3];
+        currentControl = generatedLayout["Button4"];
         Assert.That(currentControl.offset, Is.EqualTo(3));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Button")));
 
-        currentControl = generatedLayout.controls[4];
+        currentControl = generatedLayout["Button5"];
         Assert.That(currentControl.offset, Is.EqualTo(4));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Button")));
 
-        currentControl = generatedLayout.controls[5];
+        currentControl = generatedLayout["Button6"];
         Assert.That(currentControl.offset, Is.EqualTo(5));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Button")));
 
-        currentControl = generatedLayout.controls[6];
+        currentControl = generatedLayout["Axis1"];
         Assert.That(currentControl.offset, Is.EqualTo(8));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Analog")));
 
-        currentControl = generatedLayout.controls[7];
+        currentControl = generatedLayout["Button7"];
         Assert.That(currentControl.offset, Is.EqualTo(12));
         Assert.That(currentControl.layout, Is.EqualTo(new InternedString("Button")));
     }
@@ -430,6 +430,8 @@ public void Components_CanUpdateGameObjectTransformThroughTrackedPoseDriver()
         }
     }
 
+    private const int kNumBaseHMDControls = 10;
+
     private static InputDeviceDescription CreateSimpleDeviceDescriptionByRole(InputDeviceRole role)
     {
         return new InputDeviceDescription
@@ -550,10 +552,7 @@ public static InputDeviceDescription CreateDeviceDescription()
             };
         }
 
-        public FourCC format
-        {
-            get { return new FourCC('X', 'R', 'S', '0'); }
-        }
+        public FourCC format => new FourCC('X', 'R', 'S', '0');
     }
 
     [StructLayout(LayoutKind.Explicit)]

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -9,13 +9,21 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [1.0.0-preview.1] - 2999-9-20
 
+### Changed
+
+- Generated action wrappers now won't `Destroy` the generated Asset in a finalizer, but instead implement `IDisposable`.
+- Added back XR layouts (except for Magic Leap) that were removed for `1.0-preview`.
+  * We removed these layouts under the assumption that they would almost concurrently become available in the respective device-specific XR packages. However, this did not work out as expected and the gap here turned out to be more than what we anticipated.
+  * To deal with this gap, we have moved the bulk of the XR layouts back and will transition things gradually as support in device-specific packages becomes publicly available.
+
 ### Fixed
 
 - Fixed a bug where the Input Settings Window might throw exceptions after assembly reload.
 - Correctly implemented `IsPointerOverGameObject` method for `InputSystemUIInputModule`.
 - Several bugs with layout overrides registered with (`InputSystem.RegisterLayoutOverrides`).
   * In `1.0-preview`, layout overrides could lead to corruption of the layout state and would also not be handled correctly by the various editor UIs.
 - Selecting a layout in the input debugger no longer selects its first child item, too.
+- Fixed XR devices reporting noise as valid user input (should fix problem of control schemes involving VR devices always activating when using `PlayerInput`).
 - Fixed tap/swipe gesture detection in touch samples.
 
 ### Actions
@@ -29,14 +37,11 @@ however, it has to be formatted properly to pass verification tests.
 - Fixed `Invoke CSharp Events` when selected in `PlayerInput` not triggering `PlayerInput.onActionTriggered`.
 - Fixed duplicating multiple items at the same time in the action editor duplicating them repeatedly.
 
-### Changed
-
-- Generated action wrappers now won't `Destroy` the generated Asset in a finalizer, but instead implement `IDisposable`.
-
 ### Added
 
 - Will now recognize Xbox One and PS4 controllers connected to iOS devices correctly as Xbox One and PS4 controllers.
 - Added a new sample called "Custom Device Usages" that shows how to use a layout override on `Gamepad` to allow distinguishing two gamepads in bindings based on which player the gamepad is assigned to.
+- Added abstract `TrackedDevice` input device class as the basis for various kinds of tracked devices.
 
 ## [1.0.0-preview] - 2019-9-20
 

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

@@ -0,0 +1,37 @@
+using UnityEngine.InputSystem.Controls;
+using UnityEngine.InputSystem.Layouts;
+using UnityEngine.Scripting;
+
+namespace UnityEngine.InputSystem
+{
+    /// <summary>
+    /// An input device that has its orientation and position in space tracked.
+    /// </summary>
+    [InputControlLayout(displayName = "Tracked Device", isGenericTypeOfDevice = true)]
+    [Preserve]
+    public class TrackedDevice : InputDevice
+    {
+        [InputControl(noisy = true)]
+        [Preserve]
+        public IntegerControl trackingState { get; private set; }
+        [InputControl(noisy = true)]
+        [Preserve]
+        public ButtonControl isTracked { get; private set; }
+        [InputControl(noisy = true)]
+        [Preserve]
+        public Vector3Control devicePosition { get; private set; }
+        [InputControl(noisy = true)]
+        [Preserve]
+        public QuaternionControl deviceRotation { get; private set; }
+
+        protected override void FinishSetup()
+        {
+            base.FinishSetup();
+
+            trackingState = GetChildControl<IntegerControl>("trackingState");
+            isTracked = GetChildControl<ButtonControl>("isTracked");
+            devicePosition = GetChildControl<Vector3Control>("devicePosition");
+            deviceRotation = GetChildControl<QuaternionControl>("deviceRotation");
+        }
+    }
+}

Packages/com.unity.inputsystem/InputSystem/Devices/TrackedDevice.cs.meta

@@ -173,11 +173,8 @@ private void AddDeviceTreeItemRecursive(InputControlLayout layout, AdvancedDropd
             }
 
             // Add controls.
-            var haveControls = false;
             if (shouldIncludeDeviceLayout && m_Mode != InputControlPicker.Mode.PickDevice)
             {
-                var childCountBefore = deviceItem.children.Count();
-
                 // The keyboard is special in that we want to allow binding by display name (i.e. character
                 // generated by a key) instead of only by physical key location. Also, we want to give an indication
                 // of which specific key an entry refers to by taking the current keyboard layout into account.
@@ -206,8 +203,6 @@ private void AddDeviceTreeItemRecursive(InputControlLayout layout, AdvancedDropd
                 {
                     AddControlTreeItemsRecursive(layout, deviceItem, layout.name, null, searchable);
                 }
-
-                haveControls = deviceItem.children.Count() != childCountBefore;
             }
 
             // Add child items.
@@ -217,7 +212,7 @@ private void AddDeviceTreeItemRecursive(InputControlLayout layout, AdvancedDropd
                 if (!ShouldIncludeDeviceLayout(childLayout))
                     continue;
 
-                if (isFirstChild && haveControls)
+                if (isFirstChild)
                     deviceItem.AddSeparator("More Specific " + deviceItem.name.GetPlural());
                 isFirstChild = false;
 
@@ -367,7 +362,8 @@ private bool ShouldIncludeDeviceLayout(InputControlLayout layout)
 
             // By default, if a device has no (usable) controls, we don't want it listed in the control picker
             // except if we're picking devices.
-            if (!layout.controls.Any(x => LayoutMatchesExpectedControlLayoutFilter(x.layout)) && m_Mode != InputControlPicker.Mode.PickDevice)
+            if (!layout.controls.Any(x => LayoutMatchesExpectedControlLayoutFilter(x.layout)) && layout.controls.Any(x => true) &&
+                m_Mode != InputControlPicker.Mode.PickDevice)
                 return false;
 
             // If we have a device filter, see if we should ignore the device.

Packages/com.unity.inputsystem/InputSystem/Editor/ControlPicker/InputControlPickerDropdown.cs

@@ -1502,6 +1502,7 @@ internal void InitializeData()
             RegisterControlLayout("HumiditySensor", typeof(HumiditySensor));
             RegisterControlLayout("AmbientTemperatureSensor", typeof(AmbientTemperatureSensor));
             RegisterControlLayout("StepCounter", typeof(StepCounter));
+            RegisterControlLayout("Tracked Device", typeof(TrackedDevice));
 
             // Register processors.
             processors.AddTypeRegistration("Invert", typeof(InvertProcessor));

Packages/com.unity.inputsystem/InputSystem/InputManager.cs

@@ -2895,7 +2895,7 @@ private static void PerformDefaultPluginInitialization()
             Switch.SwitchSupportHID.Initialize();
             #endif
 
-            #if (UNITY_EDITOR || UNITY_STANDALONE || UNITY_ANDROID || UNITY_IOS || UNITY_WSA || UNITY_LUMIN) && UNITY_INPUT_SYSTEM_ENABLE_XR
+            #if (UNITY_EDITOR || UNITY_STANDALONE || UNITY_ANDROID || UNITY_IOS || UNITY_WSA) && ENABLE_VR
             XR.XRSupport.Initialize();
             #endif
 

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

@@ -0,0 +1,77 @@
+#if ENABLE_VR && !DISABLE_BUILTIN_INPUT_SYSTEM_GOOGLEVR && !PACKAGE_DOCS_GENERATION
+using UnityEngine.InputSystem.Controls;
+using UnityEngine.InputSystem.Layouts;
+using UnityEngine.InputSystem.XR;
+using UnityEngine.Scripting;
+
+namespace Unity.XR.GoogleVr
+{
+    /// <summary>
+    /// A head-mounted display powered by Google Daydream.
+    /// </summary>
+    [InputControlLayout]
+    [Preserve]
+    public class DaydreamHMD : XRHMD
+    {
+    }
+
+    /// <summary>
+    /// An XR controller powered by Google Daydream.
+    /// </summary>
+    [InputControlLayout(commonUsages = new[] { "LeftHand", "RightHand" })]
+    [Preserve]
+    public class DaydreamController : XRController
+    {
+        [InputControl]
+        [Preserve]
+        public Vector2Control touchpad { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl volumeUp { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl recentered { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl volumeDown { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl recentering { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl app { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl home { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl touchpadClicked { get; private set; }
+        [InputControl]
+        [Preserve]
+        public ButtonControl touchpadTouched { get; private set; }
+        [InputControl(noisy = true)]
+        [Preserve]
+        public Vector3Control deviceVelocity { get; private set; }
+        [InputControl(noisy = true)]
+        [Preserve]
+        public Vector3Control deviceAcceleration { get; private set; }
+
+        protected override void FinishSetup()
+        {
+            base.FinishSetup();
+
+            touchpad = GetChildControl<Vector2Control>("touchpad");
+            volumeUp = GetChildControl<ButtonControl>("volumeUp");
+            recentered = GetChildControl<ButtonControl>("recentered");
+            volumeDown = GetChildControl<ButtonControl>("volumeDown");
+            recentering = GetChildControl<ButtonControl>("recentering");
+            app = GetChildControl<ButtonControl>("app");
+            home = GetChildControl<ButtonControl>("home");
+            touchpadClicked = GetChildControl<ButtonControl>("touchpadClicked");
+            touchpadTouched = GetChildControl<ButtonControl>("touchpadTouched");
+            deviceVelocity = GetChildControl<Vector3Control>("deviceVelocity");
+            deviceAcceleration = GetChildControl<Vector3Control>("deviceAcceleration");
+        }
+    }
+}
+#endif