Refactor to have new SwitchProController Gamepad with remapped ABXY buttons

Author: vallerieknight-unity

Assets/Tests/InputSystem/Plugins/iOSTests.cs

@@ -80,6 +80,7 @@ public void Devices_SupportsSwitchProControlleriOS()
                 product = "Pro Controller"
             });
         Assert.That(device, Is.TypeOf(typeof(SwitchProControlleriOS)));
+        Assert.That(device, Is.InstanceOf(typeof(SwitchProController)));
         Assert.That(device, Is.InstanceOf(typeof(Gamepad)));
 
         var gamepad = (SwitchProControlleriOS)device;

Assets/Tests/InputSystem/SwitchTests.cs

@@ -172,6 +172,7 @@ public void Devices_SupportsSwitchLikeControllers(int vendorId, int productId)
             });
 
         Assert.That(device, Is.TypeOf<SwitchProControllerHID>());
+        Assert.That(device, Is.InstanceOf(typeof(SwitchProController)));
     }
 
 #endif

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

@@ -806,4 +806,39 @@ public virtual void SetMotorSpeeds(float lowFrequency, float highFrequency)
         private static int s_GamepadCount;
         private static Gamepad[] s_Gamepads;
     }
+
+    /// <summary>
+    /// Base class for Nintendo Switch Pro Controllers that provides the correct button mappings for Nintendo's face button layout where A is east, B is south, X is north, and Y is west.
+    /// If you use InputSystem.GetDevice and the ABXY properties to represent the labels on the device, you must query for this class
+    /// </summary>
+    public abstract class SwitchProController : Gamepad
+    {
+        /// <summary>
+        /// A Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to a Switch Pro Controller class, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonSouth, whereas this class returns the state of buttonEast
+        /// </summary>
+        public new ButtonControl aButton => buttonEast;
+
+        /// <summary>
+        /// B Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to a Switch Pro Controller class, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonEast, whereas this class returns the state of buttonSouth
+        /// </summary>
+        public new ButtonControl bButton => buttonSouth;
+
+        /// <summary>
+        /// Y Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to a Switch Pro Controller class, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonNorth, whereas this class returns the state of buttonWest
+        /// </summary>
+        public new ButtonControl yButton => buttonWest;
+
+        /// <summary>
+        /// X Button for a Nintendo Switch Pro Controller.
+        /// If querying via script, ensure you cast the device to a Switch Pro Controller class, rather than using the Gamepad class.
+        /// The gamepad class will return the state of buttonWest, whereas this class returns the state of buttonNorth
+        /// </summary>
+        public new ButtonControl xButton => buttonNorth;
+    }
 }

Packages/com.unity.inputsystem/InputSystem/Plugins/Switch/SwitchProControllerHID.cs

@@ -147,42 +147,14 @@ namespace UnityEngine.InputSystem.Switch
     /// A Nintendo Switch Pro controller connected to a desktop mac/windows PC using the HID interface.
     /// </summary>
     [InputControlLayout(stateType = typeof(SwitchProControllerHIDInputState), displayName = "Switch Pro Controller")]
-    public class SwitchProControllerHID : Gamepad, IInputStateCallbackReceiver, IEventPreProcessor
+    public class SwitchProControllerHID : SwitchProController, IInputStateCallbackReceiver, IEventPreProcessor
     {
         [InputControl(name = "capture", displayName = "Capture")]
         public ButtonControl captureButton { get; protected set; }
 
         [InputControl(name = "home", displayName = "Home")]
         public ButtonControl homeButton { get; protected set; }
 
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControllerHID, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonSouth, whereas this class returns the state of buttonEast
-        /// </summary>
-        public new ButtonControl aButton => buttonEast;
-
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControllerHID, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonEast, whereas this class returns the state of buttonSouth
-        /// </summary>
-        public new ButtonControl bButton => buttonSouth;
-
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControllerHID, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonNorth, whereas this class returns the state of buttonWest
-        /// </summary>
-        public new ButtonControl yButton => buttonWest;
-
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControllerHID, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonWest, whereas this class returns the state of buttonNorth
-        /// </summary>
-        public new ButtonControl xButton => buttonNorth;
-
         protected override void OnAdded()
         {
             base.OnAdded();

Packages/com.unity.inputsystem/InputSystem/Plugins/iOS/IOSGameController.cs

@@ -198,38 +198,11 @@ public class DualSenseGampadiOS : DualShockGamepad
 
     /// <summary>
     /// A Switch Pro Controller connected to an iOS device.
-    /// If you use InputSystem.GetDevice, you must query for this class rather than Gamepad in order for aButton, bButton, yButton and xButton to be correct
+    /// If you use InputSystem.GetDevice, you must query for SwitchProControlleriOS rather than Gamepad in order for aButton, bButton, yButton and xButton to be correct
     /// </summary>
     [InputControlLayout(stateType = typeof(iOSGameControllerStateSwappedFaceButtons), displayName = "iOS Switch Pro Controller Gamepad")]
-    public class SwitchProControlleriOS : Gamepad
+    public class SwitchProControlleriOS : SwitchProController
     {
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonSouth, whereas this class returns the state of buttonEast
-        /// </summary>
-        public new ButtonControl aButton => buttonEast;
-
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonEast, whereas this class returns the state of buttonSouth
-        /// </summary>
-        public new ButtonControl bButton => buttonSouth;
-
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonNorth, whereas this class returns the state of buttonWest
-        /// </summary>
-        public new ButtonControl yButton => buttonWest;
-
-        /// <summary>
-        /// A Button for a Nintendo Switch Pro Controller.
-        /// If querying via script, ensure you cast the device to SwitchProControlleriOS, rather than using the Gamepad class.
-        /// The gamepad class will return the state of buttonWest, whereas this class returns the state of buttonNorth
-        /// </summary>
-        public new ButtonControl xButton => buttonNorth;
     }
 }
 #endif // UNITY_EDITOR || UNITY_IOS || UNITY_TVOS || UNITY_VISIONOS