Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetPortalPoints(PolygonId, PolygonId, out Vector3, out Vector3)

Obtains the end points of the line segment common to two adjacent NavMesh nodes.
Read time 2 minutesLast updated 13 days ago

Definition

GetPortalPoints(PolygonId, PolygonId, Vector3, Vector3)

Warning
Deprecated. The experimental NavMeshQuery struct has been deprecated. Use NavWorld instead.
public bool GetPortalPoints(PolygonId polygon, PolygonId neighbourPolygon, out Vector3 left, out Vector3 right)

Parameters

polygon

PolygonId
First NavMesh node.

neighbourPolygon

PolygonId
Second NavMesh node.

left

Vector3
One of the world points for the resulting separation edge which must be passed through when traversing between the two specified nodes. This point is the left side of the edge when traversing from the first node to the second.

right

Vector3
One of the world points for the resulting separation edge which must be passed through when traversing between the two specified nodes. This point is the right side of the edge when traversing from the first node to the second.

Returns

Type

Description

bool
True
if a connection exists between the two NavMesh nodes. 
False
if no connection exists between the two NavMesh nodes.

Remarks

For two polygons that are part of a NavMesh surface, this method returns the edge where both polygons meet. If the two polygons are in different NavMesh tiles the connected edges can be of different length or have different start and end positions from each other. If this happens the resulting separation edge is the overlapping part of the edges, which may be shorter than either of the individual edges.
When one node is a link and the other is a polygon, the returned points are placed where the link intersects the polygon.
The resulting positions are expressed in world space and can be transformed into a NavMesh's local space by the use of NavMeshQuery.PolygonWorldToLocalMatrix.
Additional Resources: NavMeshQuery.GetEdgesAndNeighbors