【Unity】Raycast Target

RaycastTargetとは？

RaycastTargetは、ImageやTextなどのUIコンポーネントが持つプロパティです。これを有効にすると、そのUIオブジェクトがポインターのクリックやタップを受け取れるようになります。

Unityのクリック判定は以下の流れで行われます。

EventSystemが毎フレームポインターの位置を監視する
GraphicRaycasterがCanvas内のRaycastTargetが有効な全オブジェクトに対してレイキャストを行う
ヒットしたオブジェクトに対してクリックイベントが発行される

つまり、RaycastTargetが有効なオブジェクトは毎フレーム判定処理の対象になります。

UI.Graphic-raycastTarget - Unity スクリプトリファレンス

このグラフィックが Raycast のターゲットを考慮すべきかどうか

docs.unity3d.com

パフォーマンスへの影響

RaycastTargetが有効なオブジェクトが多いほど、GraphicRaycasterの処理負荷が増加します。

問題になりやすいのが、UnityのImageやTextMeshProUGUIはデフォルトでRaycastTargetがオンになっている点です。

装飾目的で配置した背景画像やラベルテキストも、何も設定しなければすべてクリック判定の対象になってしまいます。

UIが複雑になるほどRaycastTargetが有効なオブジェクトが増え、パフォーマンスに影響が出やすくなります。

RaycastTargetをオフにすべき場面

クリックやタップに反応させる必要がないオブジェクトは、RaycastTargetをオフにします。

オフにすべき例:

背景や枠線など装飾目的のImage
ボタンのラベルなど操作対象ではないText・TextMeshProUGUI
アイコンやイラストなど見た目だけのUI

オンのままにすべき例:

Buttonなど直接クリックを受け付けるUI
IPointerClickHandlerなどのイベントインターフェイスを実装したオブジェクト

InspectorのRaycast Targetチェックボックスのオン/オフで切り替えられます。

スクリプトから変更する場合は以下のように書きます。

using UnityEngine;
using UnityEngine.UI;

public class RaycastTargetSample : MonoBehaviour
{
    [SerializeField] private Image _image;

    private void Start()
    {
        // RaycastTargetをオフにする
        _image.raycastTarget = false;
    }
}

Blocks Raycastsとの違い

RaycastTargetと似た機能にCanvasGroupのBlocks Raycastsがあります。2つの違いは制御の単位です。

プロパティ	制御単位	用途
`RaycastTarget`	オブジェクト個別	特定のUIのクリック判定を恒久的にオフにする
`Blocks Raycasts`	CanvasGroup配下のグループ単位	ローディング中など状況に応じてグループごと切り替える

装飾用の画像など最初からクリック判定が不要なものはRaycastTargetをオフに、状況に応じて操作を無効化したい場合はBlocks Raycastsを使うのが基本的な使い分けです。

エディタ拡張でRaycastTargetを一括確認する

シーンが大きくなると、RaycastTargetがオンになっているオブジェクトを手動で確認するのは手間がかかります。エディタ拡張を使ってシーン内の一覧を表示するツールを作ると便利です。

以下のスクリプトをEditorフォルダ内に保存すると、メニューバーから実行できます。

using UnityEditor;
using UnityEditor.SceneManagement;
using UnityEngine;
using UnityEngine.SceneManagement;
using UnityEngine.UI;

public class RaycastTargetChecker : EditorWindow
{
    #region Fields

    private Vector2 _scrollPosition;

    #endregion

    [MenuItem("Tools/RaycastTarget Checker")]
    private static void Open()
    {
        GetWindow<RaycastTargetChecker>("RaycastTarget Checker");
    }

    private void OnGUI()
    {
        if (GUILayout.Button("シーンを検索"))
        {
            // フォーカスをシーンビューに移してリフレッシュ
            Repaint();
        }

        EditorGUILayout.Space();

        // シーン内のGraphicコンポーネントをすべて取得する
        var graphics = FindObjectsByType<Graphic>(FindObjectsSortMode.None);

        var count = 0;

        using (var scrollView = new EditorGUILayout.ScrollViewScope(_scrollPosition))
        {
            _scrollPosition = scrollView.scrollPosition;
            
            EditorGUI.BeginChangeCheck();

            foreach (var graphic in graphics)
            {
                using (new EditorGUILayout.HorizontalScope())
                {
                    // RaycastTargetの状態
                    graphic.raycastTarget = EditorGUILayout.ToggleLeft("", graphic.raycastTarget, GUILayout.Width(24));
                    
                    // オブジェクト名を表示する
                    EditorGUILayout.LabelField(graphic.gameObject.name, GUILayout.Width(200));

                    // コンポーネント名を表示する
                    EditorGUILayout.LabelField(graphic.GetType().Name, GUILayout.Width(160));

                    // クリックでオブジェクトを選択する
                    if (GUILayout.Button("選択", GUILayout.Width(60)))
                    {
                        Selection.activeGameObject = graphic.gameObject;
                        EditorGUIUtility.PingObject(graphic.gameObject);
                    }
                }
                
                if (graphic.raycastTarget)
                {
                    count++;
                }
            }

            if (EditorGUI.EndChangeCheck())
            {
                // 変更があったので、反映する
                var scene = SceneManager.GetActiveScene();
                EditorSceneManager.MarkSceneDirty(scene);
            }
        }

        EditorGUILayout.Space();
        EditorGUILayout.LabelField($"RaycastTarget が有効なオブジェクト: {count} 件");
    }
}