Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Navmesh > Detour > dtNavMeshQuery > dtNavMeshQuery::findNearestPoly

Light Theme

Dark Theme

dtNavMeshQuery::findNearestPoly

Finds the polygon nearest to the specified center point.

Windows

MacOS

Linux

Warnings

This function is not suitable for large area searches. If the search extents overlaps more than 128 polygons it may return an invalid result.

References

Module	Navmesh
Header	/Engine/Source/Runtime/Navmesh/Public/Detour/DetourNavMeshQuery.h
Include	#include "Detour/DetourNavMeshQuery.h"
Source	/Engine/Source/Runtime/Navmesh/Private/Detour/DetourNavMeshQuery.cpp

Syntax

dtStatus findNearestPoly
(
    const float * center,
    const float * extents,
    const dtQueryFilter * filter,
    dtPolyRef * nearestRef,
    float * nearestPt,
    const float * referencePt
) const

Remarks

Finds the polygon nearest to the specified center point.

If the search box does not intersect any polygons the search will return #DT_SUCCESS, but nearestRef_ will be zero. So if in doubt, check nearestRef before using `nearestPt.

This function is not suitable for large area searches. If the search extents overlaps more than 128 polygons it may return an invalid result.

Returns

The status flags for the query.

Parameters

Parameter	Description
center	The center of the search box. [(x, y, z)]
extents	The search distance along each axis. [(x, y, z)]
filter	The polygon filter to apply to the query.
nearestRef	The reference id of the nearest polygon.
nearestPt	The nearest point on the polygon. [opt] [(x, y, z)]
referencePt	If supplied replaces
center	in terms of distance measurements. [opt] [(x, y, z)]

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss