趣味プロダクトのDebug用途でUnity Input Systemを使ってみた（GamePad入力）

Unity Input Systemとは

ゲームパッド・キーボード・マウス・センサー等の各種入力デバイスからの入力を汎用的・統合的に取り扱うために導入されたUnityの新しい入力システムです

公式の引用
以前までは、Input Managerを利用して入力を受け取っていましたが、Input Systemの勉強も兼ねて試してみました。なぜInput Managerではなく、Input Systemを利用するのかについてはこちらのドキュメントがわかりやすいかと思います。

環境

Unity 2021.3.15f1

導入

UnityのプロジェクトにInput Systemを導入する方法はPackageManagerからインストールを行います。こちらのInstall guideがわかりやすいかと思います。

実際に行ったこと

趣味で作成しているVRコンテンツにおいてXR Interaction Toolkitを試している最中にDebug用途として、GamePadを用いても動かせるようにしたいと思いGamePadでの入力周りの実装を行いました。

実装

左スティックでの移動

GamePadLeftController.cs

using UnityEngine;
using UnityEngine.InputSystem;

public class GamePadLeftController : MonoBehaviour
{
    [SerializeField] private GameObject XROrigin;
    [SerializeField] private GameObject mainCamera;
    private float speed = 0.05f;

    private InputAction movement;
    private void OnEnable()
    {
        movement = new InputAction(binding: "<Gamepad>/leftStick");
        movement.Enable();
    }

    private void OnDisable()
    {
        movement.Disable();
    }

    // Update is called once per frame
    void Update()
    
        Vector2 movementInput = movement.ReadValue<Vector2>();
        
        switch (movementInput)
        {
            case Vector2 _ when movementInput.y > 0.3f:
                XROrigin.transform.position +=  XZPlaneMoveVector3(mainCamera.transform.forward) * speed;
                break;
            
            case Vector2 _ when movementInput.y < -0.3f:
                XROrigin.transform.position += XZPlaneMoveVector3(mainCamera.transform.forward) * speed * -1;
                break;
            
            case Vector2 _ when movementInput.x > 0.3f:
                XROrigin.transform.position += XZPlaneMoveVector3(mainCamera.transform.right) * speed;
                break;
            
            case Vector2 _ when movementInput.x < -0.3f:
                XROrigin.transform.position += XZPlaneMoveVector3(mainCamera.transform.right) * speed * -1;
                break;
        }
    }

    //xz平面での移動をさせるためにz座標を0にする関数
    public Vector3 XZPlaneMoveVector3(Vector3 a)
    {
        return new Vector3(a.x * 1, a.y * 0, a.z * 1);
    }
    
    // 入力されている情報を確認するために表示
    private void OnGUI()
    {
        if (Gamepad.current == null) return;
        
        GUILayout.Label($"leftStick: {Gamepad.current.leftStick.ReadValue()}");
        GUILayout.Label($"buttonNorth: {Gamepad.current.buttonNorth.isPressed}");
        GUILayout.Label($"buttonSouth: {Gamepad.current.buttonSouth.isPressed}");
        GUILayout.Label($"buttonEast: {Gamepad.current.buttonEast.isPressed}");
        GUILayout.Label($"buttonWest: {Gamepad.current.buttonWest.isPressed}");
        GUILayout.Label($"leftShoulder: {Gamepad.current.leftShoulder.ReadValue()}");
        GUILayout.Label($"leftTrigger: {Gamepad.current.leftTrigger.ReadValue()}");
        GUILayout.Label($"rightShoulder: {Gamepad.current.rightShoulder.ReadValue()}");
        GUILayout.Label($"rightTrigger: {Gamepad.current.rightTrigger.ReadValue()}");
        
    }
}

ボタンの処理

GamePadButton.cs

using System;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.InputSystem;

public class GamePadButton : MonoBehaviour
{
    private Dictionary<CustomButton, InputAction> buttonActions = new Dictionary<CustomButton, InputAction>();
    private float speed = 1;
    [SerializeField] private GameObject XROrigin;
    [SerializeField] private GameObject mainCamera;
    
    private void OnEnable()
    {
        foreach (CustomButton button in Enum.GetValues(typeof(CustomButton)))
        {
            var buttonAction = new InputAction(binding: $"<Gamepad>/button{GetButtonIndex(button)}");
            buttonAction.Enable();
            
            buttonActions.Add(button, buttonAction);

            buttonAction.started += ctx => HandleButtonPress(button);
        }
    }

    private void OnDisable()
    {
        foreach (var buttonAction in buttonActions.Values)
        {
            buttonAction.Disable();
        }
    }

    private void HandleButtonPress(CustomButton button)
    {
        switch (button)
        {
            case CustomButton.North:
                XROrigin.transform.position += XZPlaneMoveVector3(mainCamera.transform.forward) * speed;
                break;
            case CustomButton.South:
                XROrigin.transform.position += XZPlaneMoveVector3(mainCamera.transform.forward) * speed * -1;
                break;
            case CustomButton.East:
                XROrigin.transform.position += XZPlaneMoveVector3(mainCamera.transform.right) * speed;
                break;
            case CustomButton.West:
                XROrigin.transform.position += XZPlaneMoveVector3(mainCamera.transform.right) * speed * -1;
                break;
            default:
                return ;
        }
    }

    private String GetButtonIndex(CustomButton button)
    {
        switch (button)
        {
            case CustomButton.North:
                return "North";
            case CustomButton.South:
                return "South";
            case CustomButton.East:
                return "East";
            case CustomButton.West:
                return "West";
            default:
                return "North";
        }
    }
    
    //xz平面での移動をさせるためにy座標を0にする関数
    public Vector3 XZPlaneMoveVector3(Vector3 a)
    {
        return new Vector3(a.x * 1, a.y * 0, a.z * 1);
    }
}

public enum CustomButton
{
    North,
    South,
    East,
    West
}

今後別のボタンを追加したい際に同じ実装をする必要がないように、enumを利用してButtonの種類を定義するようにしました。しかし、ボタンの名称がbutton以外から始まる場合もあるため、その部分は修正が必要になるかと思います。

.cs

var buttonAction = new InputAction(binding: $"<Gamepad>/button{GetButtonIndex(button)}");

上記の実装の"button"部分含めて名称を取得する必要が出てくると思います。そして名称すべてを含めるようにして、enumで定義をしておく必要があります。それに伴ってGetButtonIndexとHandleButtonPressの中でCustomButtonを利用している箇所も修正が必要になります。

右スティックでの視点変更

GamePadRotation.cs

using UnityEngine;
using UnityEngine.InputSystem;

public class GamePadRotation : MonoBehaviour
{
    private float rotationSpeed = 10f;

    private InputAction horizontalInput;
    private InputAction verticalInput;

    [SerializeField] private GameObject XROrigin;
    [SerializeField] private GameObject mainCamera;
    private void OnEnable()
    {
        horizontalInput = new InputAction(binding: "<Gamepad>/rightStick/x");
        horizontalInput.Enable();
        verticalInput = new InputAction(binding: "<Gamepad>/rightStick/y");
        verticalInput.Enable();
    }

    private void OnDisable()
    {
        horizontalInput.Disable();
        verticalInput.Disable();
    }

    private void Update()
    {
        RotateCamera(horizontalInput.ReadValue<float>(), verticalInput.ReadValue<float>());
    }

    private void RotateCamera(float horizontalRotation, float verticalRotation)
    {
        XROrigin.transform.Rotate(mainCamera.transform.up, horizontalRotation * rotationSpeed * Time.deltaTime);
        XROrigin.transform.Rotate(mainCamera.transform.right, verticalRotation * rotationSpeed * Time.deltaTime * -1);
    }
}

回転部分の実装について

今回は簡易的な視点の回転を実装しました。おそらくHMDを付けて動くとおかしな方向に回転してしまう可能性もあるかもしれないです。今回はDebugで複雑な動きをしない想定で実装しました。

まとめ

今回Input Systemを利用してDebug用にGamepadの入力を制御する実装をしました。今回の実装では確認のためにわかりやすくXROriginの移動にしていますが、Unityの中でテストしたい関数などをボタン一つで実行できるようにすると便利かと思っています。Debug用の隠しコマンドのような物も作成しようと思えば出来るかと思うので、今後は試していきたいと思います。また今回Actionを利用出来ていないので、今後はActionを利用した方法も試していきたいです。

参考資料