dtNavMeshQuery::getPolyWallSegments

Returns the segments for the specified polygon, optionally including portals.

Windows
MacOS
Linux

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 getPolyWallSegments
(
    dtPolyRef ref,
    const dtQueryFilter * filter,
    float * segmentVerts,
    dtPolyRef * segmentRefs,
    int * segmentCount,
    const int maxSegments
) const

Remarks

Returns the segments for the specified polygon, optionally including portals.

If the `segmentRefs_ parameter is provided, then all polygon segments will be returned. Otherwise only the wall segments are returned.

A segment that is normally a portal will be included in the result set as a wall if the `filter_ results in the neighbor polygon becoomming impassable.

The segmentVerts_ and segmentRefs_ buffers should normally be sized for the maximum segments per polygon of the source navigation mesh.

Returns

The status flags for the query.

Parameters

Parameter

Description

ref

The reference id of the polygon.

filter

The polygon filter to apply to the query.

segmentVerts

The segments. [(ax, ay, az, bx, by, bz) * segmentCount]

segmentRefs

The reference ids of each segment's neighbor polygon. Or zero if the segment is a wall. [opt] [(parentRef) * segmentCount]

segmentCount

The number of segments returned.

maxSegments

The maximum number of segments the result arrays can hold.

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