NEW: Add generic RacingWheel class.

Assets/Tests/InputSystem/CoreTests_Devices.cs

@@ -2385,6 +2385,46 @@ public void Devices_JoysticksHaveDeadzonesOnStick()
         Assert.That(joystick.stick.ReadValue(), Is.EqualTo(Vector2.zero));
     }
 
+    [Test]
+    [Category("Devices")]
+    public void Devices_CanCreateGenericRacingWheel()
+    {
+        var wheel = InputSystem.AddDevice<RacingWheel>();
+
+        Assert.That(RacingWheel.current, Is.SameAs(wheel));
+
+        Assert.That(wheel.allControls.OfType<AxisControl>().Select(c => c.ReadValue()), Is.All.Zero);
+        Assert.That(wheel.gear.ReadValue(), Is.Zero);
+
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.DpadUp), wheel.dpad.up);
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.DpadDown), wheel.dpad.down);
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.DpadLeft), wheel.dpad.left);
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.DpadRight), wheel.dpad.right);
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.GearUp), wheel.gearUp);
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.GearDown), wheel.gearDown);
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.Menu), wheel.menu);
+        AssertButtonPress(wheel, new RacingWheelState().WithButton(RacingWheelButton.View), wheel.view);
+
+        InputSystem.QueueStateEvent(wheel,
+            new RacingWheelState
+            {
+                gear = 123,
+                throttle = 0.234f,
+                brake = 0.345f,
+                clutch = 0.456f,
+                handbrake = 0.567f,
+                wheel = 0.678f,
+            });
+        InputSystem.Update();
+
+        Assert.That(wheel.gear.ReadValue(), Is.EqualTo(123));
+        Assert.That(wheel.throttle.ReadValue(), Is.EqualTo(0.234f));
+        Assert.That(wheel.brake.ReadValue(), Is.EqualTo(0.345f));
+        Assert.That(wheel.clutch.ReadValue(), Is.EqualTo(0.456f));
+        Assert.That(wheel.handbrake.ReadValue(), Is.EqualTo(0.567f));
+        Assert.That(wheel.wheel.ReadValue(), Is.EqualTo(0.678f));
+    }
+
     [Test]
     [Category("Devices")]
     public void Devices_PointerDeltasDoNotAccumulateFromPreviousFrame()

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -33,6 +33,8 @@ however, it has to be formatted properly to pass verification tests.
 
 - Added support for PS5 DualSense controllers on Mac and Windows.
 - Improved the user experience when creating single vs multi-touch touchscreen bindings in the Input Action Asset editor by making both options visible in the input action dropdown menu. Now it's not neccessary to be aware of the touch\*/press path binding syntax ([case 1357664](https://issuetracker.unity3d.com/issues/inputsystem-touchscreens-multi-touch-doesnt-work-when-using-a-custom-inputactionasset)).
+- Added a new `RacingWheel` device class that represents a generic racing wheel.
+  * Support for specific wheels will come later.
 
 ## [1.1.1] - 2021-09-03
 

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

@@ -0,0 +1,248 @@
+using UnityEngine.InputSystem.Controls;
+using UnityEngine.InputSystem.Layouts;
+using UnityEngine.InputSystem.LowLevel;
+using UnityEngine.InputSystem.Utilities;
+
+namespace UnityEngine.InputSystem.LowLevel
+{
+    /// <summary>
+    /// Input state for a <see cref="RacingWheel"/>.
+    /// </summary>
+    /// <remarks>
+    /// <example>
+    /// <code>
+    /// var wheel = InputSystem.AddDevice&lt;RacingWheel&gt;();
+    ///
+    /// InputSystem.QueueStateEvent(wheel,
+    ///     new RacingWheelState
+    ///     {
+    ///         gear = 2,
+    ///         wheel = 0.5f, // Halfway right.
+    ///         throttle = 0.25f, // Quarter pressure on gas pedal.
+    ///     });
+    /// </code>
+    /// </example>
+    /// </remarks>
+    public struct RacingWheelState : IInputStateTypeInfo
+    {
+        public static FourCC Format => new FourCC('W', 'E', 'E', 'L');
+
+        [InputControl(name = "dpad", layout = "Dpad", usage = "Hatswitch", displayName = "D-Pad", format = "BIT", sizeInBits = 4, bit = 0)]
+        [InputControl(name = "dpad/up", format = "BIT", bit = (uint)RacingWheelButton.DpadUp, sizeInBits = 1)]
+        [InputControl(name = "dpad/right", format = "BIT", bit = (uint)RacingWheelButton.DpadRight, sizeInBits = 1)]
+        [InputControl(name = "dpad/down", format = "BIT", bit = (uint)RacingWheelButton.DpadDown, sizeInBits = 1)]
+        [InputControl(name = "dpad/left", format = "BIT", bit = (uint)RacingWheelButton.DpadLeft, sizeInBits = 1)]
+        [InputControl(name = "gearUp", layout = "Button", bit = (uint)RacingWheelButton.GearUp, displayName = "Next Gear")]
+        [InputControl(name = "gearDown", layout = "Button", bit = (uint)RacingWheelButton.GearDown, displayName = "Previous Gear")]
+        [InputControl(name = "menu", alias = "start", layout = "Button", bit = (uint)RacingWheelButton.Menu, displayName = "Menu")]
+        [InputControl(name = "view", alias = "select", layout = "Button", bit = (uint)RacingWheelButton.View, displayName = "View")]
+        public uint buttons;
+
+        /// <summary>
+        /// Current gear selected in gear shift.
+        /// </summary>
+        [InputControl(displayName = "Gear", layout = "Integer")]
+        public int gear;
+
+        /// <summary>
+        /// Position of wheel in [-1,1] range. -1 is all the way left, 1 is all the way right.
+        /// </summary>
+        [InputControl(displayName = "Wheel", layout = "Axis")]
+        public float wheel;
+
+        /// <summary>
+        /// Position of throttle/gas pedal in [0,1] range. 0 is fully depressed, 1 is pressed all the way down.
+        /// </summary>
+        [InputControl(displayName = "Throttle", alias = "gas", layout = "Axis")]
+        public float throttle;
+
+        /// <summary>
+        /// Position of brake pedal in [0,1] range. 0 is fully depressed, 1 is pressed all the way down.
+        /// </summary>
+        [InputControl(displayName = "Break", layout = "Axis")]
+        public float brake;
+
+        /// <summary>
+        /// Position of clutch pedal in [0,1] range. 0 is fully depressed, 1 is pressed all the way down.
+        /// </summary>
+        [InputControl(displayName = "Clutch", layout = "Axis")]
+        public float clutch;
+
+        /// <summary>
+        /// Position of handbrake in [0,1] range. 0 is fully released, 1 is engaged at maximum.
+        /// </summary>
+        [InputControl(displayName = "Handbrake", layout = "Axis")]
+        public float handbrake;
+
+        public FourCC format => Format;
+
+        /// <summary>
+        /// Set the specific buttons to be pressed or unpressed.
+        /// </summary>
+        /// <param name="button">A racing wheel button.</param>
+        /// <param name="down">Whether to set <paramref name="button"/> to be pressed or not pressed in
+        /// <see cref="buttons"/>.</param>
+        /// <returns>RacingWheelState with a modified <see cref="buttons"/> mask.</returns>
+        public RacingWheelState WithButton(RacingWheelButton button, bool down = true)
+        {
+            Debug.Assert((int)button < 32, $"Expected button < 32, so we fit into the 32 bit wide bitmask");
+            var bit = 1U << (int)button;
+            if (down)
+                buttons |= bit;
+            else
+                buttons &= ~bit;
+            return this;
+        }
+    }
+
+    /// <summary>
+    /// Buttons on a <see cref="RacingWheel"/>.
+    /// </summary>
+    public enum RacingWheelButton
+    {
+        /// <summary>
+        /// The up button on a wheel's dpad.
+        /// </summary>
+        DpadUp = 0,
+
+        /// <summary>
+        /// The down button on a wheel's dpad.
+        /// </summary>
+        DpadDown = 1,
+
+        /// <summary>
+        /// The left button on a wheel's dpad.
+        /// </summary>
+        DpadLeft = 2,
+
+        /// <summary>
+        /// The right button on a wheel's dpad.
+        /// </summary>
+        DpadRight = 3,
+
+        /// <summary>
+        /// Button to shift up.
+        /// </summary>
+        GearUp = 4,
+
+        /// <summary>
+        /// Button to shift down.
+        /// </summary>
+        GearDown = 5,
+
+        /// <summary>
+        /// The "menu" button.
+        /// </summary>
+        Menu = 6,
+
+        /// <summary>
+        /// The "view" button.
+        /// </summary>
+        View = 7,
+    }
+}
+
+namespace UnityEngine.InputSystem
+{
+    /// <summary>
+    /// Base class for racing wheels.
+    /// </summary>
+    [InputControlLayout(stateType = typeof(RacingWheelState), displayName = "Racing Wheel", isGenericTypeOfDevice = true)]
+    public class RacingWheel : InputDevice
+    {
+        /// <summary>
+        /// The D-Pad control on the wheel.
+        /// </summary>
+        public DpadControl dpad { get; protected set; }
+
+        /// <summary>
+        /// Button to shift gears up.
+        /// </summary>
+        public ButtonControl gearUp { get; protected set; }
+
+        /// <summary>
+        /// Button to shift gears down.
+        /// </summary>
+        public ButtonControl gearDown { get; protected set; }
+
+        /// <summary>
+        /// The menu/start button on the wheel.
+        /// </summary>
+        public ButtonControl menu { get; protected set; }
+
+        /// <summary>
+        /// The view/select button on the wheel.
+        /// </summary>
+        public ButtonControl view { get; protected set; }
+
+        /// <summary>
+        /// The control that represents the currently selected gear.
+        /// </summary>
+        public IntegerControl gear { get; protected set; }
+
+        /// <summary>
+        /// The position of the wheel in [-1,1] range. -1 is all the way left, 1 is all the way right, 0 is in neutral position.
+        /// </summary>
+        public AxisControl wheel { get; protected set; }
+
+        /// <summary>
+        /// The position of the gas/throttle pedal or control. In [0,1] range. 0 is fully released and 1 is pressed all the way down.
+        /// </summary>
+        public AxisControl throttle { get; protected set; }
+
+        /// <summary>
+        /// The position of the brake pedal or control. In [0,1] range. 0 is fully released and 1 is pressed all the way down.
+        /// </summary>
+        public AxisControl brake { get; protected set; }
+
+        /// <summary>
+        /// The position of the clutch pedal or control. In [0,1] range. 0 is fully released and 1 is pressed all the way down.
+        /// </summary>
+        public AxisControl clutch { get; protected set; }
+
+        /// <summary>
+        /// The position of the handbrake control. In [0,1] range. 0 is fully released and 1 is engaged at maximum.
+        /// </summary>
+        public AxisControl handbrake { get; protected set; }
+
+        /// <summary>
+        /// The currently active racing wheel or <c>null</c> if no racing wheel is present.
+        /// </summary>
+        public static RacingWheel current { get; private set; }
+
+        /// <summary>
+        /// Make this the <see cref="current"/> racing wheel. This happens automatically for a racing wheel
+        /// that receives input.
+        /// </summary>
+        public override void MakeCurrent()
+        {
+            base.MakeCurrent();
+            current = this;
+        }
+
+        protected override void OnRemoved()
+        {
+            base.OnRemoved();
+
+            if (this == current)
+                current = null;
+        }
+
+        protected override void FinishSetup()
+        {
+            base.FinishSetup();
+
+            dpad = GetChildControl<DpadControl>("dpad");
+            gearUp = GetChildControl<ButtonControl>("gearUp");
+            gearDown = GetChildControl<ButtonControl>("gearDown");
+            menu = GetChildControl<ButtonControl>("menu");
+            view = GetChildControl<ButtonControl>("view");
+            gear = GetChildControl<IntegerControl>("gear");
+            wheel = GetChildControl<AxisControl>("wheel");
+            throttle = GetChildControl<AxisControl>("throttle");
+            brake = GetChildControl<AxisControl>("brake");
+            clutch = GetChildControl<AxisControl>("clutch");
+            handbrake = GetChildControl<AxisControl>("handbrake");
+        }
+    }
+}

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

@@ -1829,6 +1829,7 @@ internal void InitializeData()
 
             RegisterControlLayout("Gamepad", typeof(Gamepad)); // Devices.
             RegisterControlLayout("Joystick", typeof(Joystick));
+            RegisterControlLayout("RacingWheel", typeof(RacingWheel));
             RegisterControlLayout("Keyboard", typeof(Keyboard));
             RegisterControlLayout("Pointer", typeof(Pointer));
             RegisterControlLayout("Mouse", typeof(Mouse));