[Unity, InputSystem] 仮想マウスの実装で詰まった点

背景

現在 Unity で制作中のゲームでコントローラーからマウスを動かすために仮想マウスを実装する際に、日本語の情報があまり存在せず詰まってしまったので、問題点と解決方法を共有します。

本記事の内容は、M1 Macbook Pro, Unity6 6000.0.42f1, Input System 1.13.1 · February 18, 2025で動作確認をしています。
異なる環境、バージョンでは動作が変わる可能性もありますのでご了承ください。

基本的な仮想マウスの実装方法

InputSystem はVirtualMouseInputというクラスを提供しており、VirtualMouseコンポーネントを任意のオブジェクトにアタッチし、いくつかの設定をすることで簡単に仮想マウスを実装することができます。

基本的な仮想マウスの実装方法は以下の記事を参考にするのがいいと思います。
https://nekojara.city/unity-input-system-virtual-mouse

VirtualMouseInput の問題点

上の記事でも触れられていますが、公式が提供しているVirtualMouseInputクラスには以下のような問題点があります。

1. CanvasScalerのUI Scale ModeがConstant Pixel以外の場合、仮想マウスの位置が正しく表示されない。

2. 仮想マウスの有効/無効化が行えない。

3. InputActionのActionTypeをPassThroughにする必要がある。

問題点の解決方法

1. CanvasScalerのUI Scale ModeがConstant Pixel以外の場合、仮想マウスの位置が正しく表示されない。

この点はUnity のフォーラムでも議論されていた内容で、VirtualMouseInput内の座標を更新する部分を修正する必要があります。

以下に変更点を示します。

VirtualMouseInput.cs

@@ class VirtualMouseInput : MonoBehaviour
        private void UpdateMotion()
        {
+            // キャンバスを取得できていない場合はキャンバスを探す
+           if (m_Canvas == null)
+               TryFindCanvas();
            if (m_VirtualMouse == null)
                return;
@@ private void UpdateMotion()
            // Update software cursor transform, if any.
            if (m_CursorTransform != null &&
                (m_CursorMode == CursorMode.SoftwareCursor ||
                    (m_CursorMode == CursorMode.HardwareCursorIfAvailable && m_SystemMouse == null)))
-               m_CursorTransform.position = newPosition;
+               {
+                   // 仮想マウスのスクリーン座標をキャンバスのローカル座標に変換
+                   Vector2 localPos;
+                   RectTransformUtility.ScreenPointToLocalPointInRectangle(
+                       m_CursorTransform.parent as RectTransform,
+                       newPosition,
+                       m_Canvas.worldCamera,
+                       out localPos);
+                   m_CursorTransform.anchoredPosition = localPos;
+               }

また、この記事の最後に、私が実際に使用しているMyVirtualMouseInputクラスのコードを載せておきますので、参考にしてください。

VirtualMouseInputをそのままコピーしても動作しない部分があったので、不要だと思われる部分を数箇所削除しています。
(チュートリアルへのリンクやエディタ専用のディレクティブなど)

2. 仮想マウスの有効/無効化が行えない。

この点も Unity のフォーラムで議論されていた内容で、色々なアプローチがあるようですが、いくつかの方法を試してもクリックやマウスホバーの判定が残ってしまっていました。
私は、VirtualMouseInputにisActiveというフィールドを追加し、isActiveがfalseの時は仮想マウスの座標を-9999, -9999に固定するようにしました。

以下に変更点を示します。

VirtualMouseInput.cs

@@ class VirtualMouseInput : MonoBehaviour
+       public bool isActive = true;

@@ class VirtualMouseInput : MonoBehaviour
        private void UpdateMotion()
        {
+            // 無効状態なら画面外に固定して早期リターンする
+            if (!isActive)
+            {
+                Vector2 offScreenPos = new Vector2(-9999, -9999);
+                InputState.Change(m_VirtualMouse.position, offScreenPos);
+                if (m_CursorTransform != null)
+                    m_CursorTransform.anchoredPosition = offScreenPos;
+                return;
+            }

実際に使用する際は、VirtualMouseInputのisActiveと、設定しているImageコンポーネントの表示/非表示を切り替えることで仮想マウスの有効/無効化を行うことができます。

3. InputActionのActionTypeをPassThroughにする必要がある。

これは私の単純な確認不足で、VirtualMouseInputに渡すInputActionのActionTypeをPassThroughにする必要があるようでした。
実際に、InputSystemを追加した際に自動生成されるInputActionAsset内の UI 関連のActionTypeはPassThroughになっていました。(新しいInputActionを作成するとValueになりますが)
この点の確認不足で仮想マウスをうまく動かすことができなかったので、困っている方は確認してみてください。

このActionTypeがPassThroughでない場合に仮想マウスを操作できないという動作は、新規プロジェクトで再現を試みたところ、再現できませんでした。
そのためこの動作は、私のプロジェクトの設定や他のスクリプトが影響している可能性があります。

MyVirtualMouseInput の内容

以下が私が実際に使用しているMyVirtualMouseInputクラスのコードです。
このクラスを任意のオブジェクトにアタッチし、通常のVirtualMouseInputと同じように設定して下さい。

MyVirtualMouseInput.cs