SamplePosition
Finds the nearest point based on the NavMesh within a specified range.
Read time 3 minutesLast updated 10 days ago
Definition
- Type: Method
- Namespace: UnityEngine.AI
- Assembly: UnityEngine.AIModule
SamplePosition(Vector3, NavMeshHit, float, int)
Finds the nearest point based on the NavMesh within a specified range.
public static bool SamplePosition(Vector3 sourcePosition, out NavMeshHit hit, float maxDistance, int areaMask)
Parameters
The origin of the sample query.
Holds the properties of the resulting location. The value of is never computed. It is always (0,0,0).
hit.normalSample within this distance from sourcePosition.
A mask that specifies the NavMesh areas allowed when finding the nearest point.
Returns
Type | Description |
|---|---|
| bool | True if the nearest point is found. |
Remarks
The nearest point is found by projecting the input point onto nearby NavMesh instances along the vertical axis. This vertical axis has been chosen for each instance at the time of creation. If this step does not find a projected point within the specified distance, then sampling is extended to surrounding NavMesh positions.
Finds the nearest point based on the distance to the query point. This function does not consider obstructions. For example, in a two-story structure, if the sourcePosition is set to a point on the ceiling on the first floor, the nearest point might be found on the second floor rather than the first floor. The ceiling is not considered as an obstruction.
This function may reduce the frame rate if a large search radius is specified. To avoid frame rate issues, it is recommended that you specify a maxDistance of twice the agent height.
If you are trying to find a random point on the NavMesh, you should use the recommended radius and perform the find multiple times instead of using a very large radius.
Examples
using UnityEngine;using UnityEngine.AI;public class RandomPointOnNavMesh : MonoBehaviour{ public float range = 10.0f; bool RandomPoint(Vector3 center, float range, out Vector3 result) { for (int i = 0; i < 30; i++) { Vector3 randomPoint = center + Random.insideUnitSphere * range; NavMeshHit hit; if (NavMesh.SamplePosition(randomPoint, out hit, 1.0f, NavMesh.AllAreas)) { result = hit.position; return true; } } result = Vector3.zero; return false; } void Update() { Vector3 point; if (RandomPoint(transform.position, range, out point)) { Debug.DrawRay(point, Vector3.up, Color.blue, 1.0f); } }}
SamplePosition(Vector3, NavMeshHit, float, NavMeshQueryFilter)
Samples the position nearest the sourcePosition on any NavMesh built for the agent type specified by the filter.
public static bool SamplePosition(Vector3 sourcePosition, out NavMeshHit hit, float maxDistance, NavMeshQueryFilter filter)
Parameters
The origin of the sample query.
Holds the properties of the resulting location. The value of is never computed. It is always (0,0,0).
hit.normalSample within this distance from sourcePosition.
A filter specifying which NavMesh areas are allowed when finding the nearest point.
Returns
Type | Description |
|---|---|
| bool | True if the nearest point is found. |
Remarks
Consider only positions on areas defined in the _areaMask. A maximum search radius is set by maxDistance. The information of any found position is returned in the hit argument.