2024年10月8日

NavMesh.SamplePosition について

UnityのNavMeshは、キャラクターを3D空間で自動的に動かすために使われる便利なツールです。その中でも NavMesh.SamplePosition は、指定した位置から一番近いNavMesh上のポイントを見つけるために使われます。この資料では、 NavMesh.SamplePosition の使い方や例をわかりやすく説明します。

NavMesh.SamplePositionの概要

NavMesh.SamplePosition メソッドは、指定した位置から最も近いNavMesh上のポイントを見つけるために使います。このメソッドを使うと、オブジェクトがNavMesh上に正しく配置されているか確認したり、目的の位置をNavMesh内に修正できます。

メソッドのシグネチャは次の通りです：

public static bool SamplePosition(Vector3 sourcePosition, out NavMeshHit hit, float maxDistance, int areaMask);

• sourcePosition：基準とする位置（探したいワールド空間の座標）。
• hit：見つかった位置の情報が返される NavMeshHit オブジェクト。
• maxDistance：探索する最大距離。
• areaMask：探索するエリアの種類。全てのエリアを対象にする場合は NavMesh.AllAreas を使います。

使い方の例

例えば、クリックした場所にキャラクターを移動させたいとき、クリックした場所がNavMeshの外だとキャラクターが移動できません。この場合、 NavMesh.SamplePosition を使ってクリックした位置に一番近いNavMesh上のポイントを探し、キャラクターをそこに移動させます。

以下はその具体的なコード例です：

using UnityEngine;
using UnityEngine.AI;

public class NavMeshSamplePositionExample : MonoBehaviour
{
    public Transform target; // 移動させたいターゲット
    public float maxDistance = 2.0f; // 探索する最大距離

    void Update()
    {
        if (Input.GetMouseButtonDown(0))
        {
            Ray ray = Camera.main.ScreenPointToRay(Input.mousePosition);
            if (Physics.Raycast(ray, out RaycastHit hitInfo))
            {
                NavMeshHit navMeshHit;
                if (NavMesh.SamplePosition(hitInfo.point, out navMeshHit, maxDistance, NavMesh.AllAreas))
                {
                    target.position = navMeshHit.position;
                    Debug.Log("NavMesh上の位置を見つけました: " + navMeshHit.position);
                }
                else
                {
                    Debug.Log("NavMesh上に有効な位置が見つかりませんでした。");
                }
            }
        }
    }
}

コードの解説

1. クリックした位置を取得: Ray を使って、クリックした画面位置からワールド空間にレイキャストします。
2. NavMesh.SamplePosition を呼び出す: クリックした位置（hitInfo.point）から一番近いNavMesh上の位置を探します。探索の範囲は maxDistance で指定し、全てのエリアを対象にします。
3. ターゲットを移動: 見つけたNavMesh上の位置（navMeshHit.position）にターゲットを移動させます。

追加のサンプルコード

以下は、特定のオブジェクトをNavMesh上にスポーンさせる例です。

using UnityEngine;
using UnityEngine.AI;

public class NavMeshSpawner : MonoBehaviour
{
    public GameObject objectToSpawn; // スポーンさせたいオブジェクト
    public float maxDistance = 5.0f; // NavMeshを探索する最大距離

    void Start()
    {
        Vector3 randomPosition = new Vector3(Random.Range(-10f, 10f), 0, Random.Range(-10f, 10f));
        NavMeshHit navMeshHit;
        if (NavMesh.SamplePosition(randomPosition, out navMeshHit, maxDistance, NavMesh.AllAreas))
        {
            Instantiate(objectToSpawn, navMeshHit.position, Quaternion.identity);
            Debug.Log("オブジェクトをNavMesh上にスポーンしました: " + navMeshHit.position);
        }
        else
        {
            Debug.Log("NavMesh上に有効なスポーン位置が見つかりませんでした。");
        }
    }
}

サンプルコードの解説

1. ランダムな位置の生成: Random.Range を使って、NavMesh上にオブジェクトをスポーンさせるためのランダムな位置を生成します。
2. NavMesh.SamplePosition を使って位置を修正: 生成したランダム位置から最も近いNavMesh上の位置を探します。
3. オブジェクトのスポーン: 見つけた位置にオブジェクトをスポーンさせます。もしNavMesh上の適切な位置が見つからなかった場合はエラーメッセージを表示します。

実際の使用シーン

• キャラクターの移動修正: ユーザーがクリックした位置がNavMeshの外の場合、その近くの移動可能な位置を見つけてキャラクターを移動させます。
• アイテムの配置: オブジェクト（例えばアイテムや敵）をNavMesh上に正しく配置する際に使います。
• ランダムスポーン: ゲーム内でランダムにアイテムや敵を配置する際に、NavMesh上に正確にスポーンさせるために使用します。

注意点

• maxDistance の設定: 探索する距離が大きすぎると、意図しない位置が見つかることがあります。適切な範囲を設定しましょう。
• パフォーマンス: このメソッドを頻繁に呼び出すと、パフォーマンスに影響が出ることがあります。必要に応じて結果をキャッシュするなどの工夫が必要です。

まとめ

NavMesh.SamplePosition は、オブジェクトをNavMesh上に正確に配置するための便利なメソッドです。このメソッドを使うことで、キャラクターやオブジェクトがNavMesh上で正しく動けるようになります。この資料で紹介したサンプルコードを参考にして、色々なシーンで NavMesh.SamplePosition を試してみましょう。