FNavCorridor | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/NavCorridor

Navigation corridor defines free space around path. It is expanded from a string pulled path. The corridor is represented as an array of portals, which leaves convex sectors in between them.


Name	FNavCorridor
Type	struct
Header File	/Engine/Plugins/Runtime/NavCorridor/Source/NavCorridor/Public/NavCorridor.h
Include Path	#include "NavCorridor.h"

Syntax

struct FNavCorridor : public TSharedFromThis< FNavCorridor >

Inheritance Hierarchy

FSharedFromThisBase → TSharedFromThis → FNavCorridor

Constants

Name	Type	Remarks	Include Path
OverlappingPointTolerance	const FVector	Tolerance used to remove overlappint points in path before building the corridor (arbitrary value used to fix common cases).	NavCorridor.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Portals	TArray< FNavCorridorPortal >	Portal points defining the corridor.	NavCorridor.h

Functions

Public

Name	Remarks	Include Path
FNavCorridorLocation AdvancePathLocation ( const FNavCorridorLocation& PathLocation, const FVector::FReal AdvanceDistance ) const	Advances path location along the path that goes through the corridor.	NavCorridor.h
void BuildFromPath ( const FNavigationPath& Path, FSharedConstNavQueryFilter NavQueryFilter, const FNavCorridorParams& Params )	Builds the corridor from a given Path.	NavCorridor.h
void BuildFromPathPoints ( const FNavigationPath& Path, TConstArrayView< FNavPathPoint > PathPoints, const int32 PathPointBaseIndex, FSharedConstNavQueryFilter NavQueryFilter, const FNavCorridorParams& Params )	Builds the corridor from a given array of Path points	NavCorridor.h
FVector ConstrainVisibility ( const FNavCorridorLocation& PathLocation, const FVector Source, const FVector Target, const float ForceLookAheadDistance ) const		NavCorridor.h
FNavCorridorLocation FindNearestLocationOnPath ( const FVector Location ) const	Finds nearest location on path going through the corridor.	NavCorridor.h
FVector::FReal GetDistanceToEndOfPath ( const FNavCorridorLocation& PathLocation ) const		NavCorridor.h
FVector GetPathDirection ( const FNavCorridorLocation& PathLocation ) const		NavCorridor.h
bool HitTest ( const FVector SegmentStart, const FVector SegmentEnd, double& HitT )		NavCorridor.h
bool IsValid()		NavCorridor.h
void OffsetPathLocationsFromWalls ( const float Offset, bool bOffsetFirst, bool bOffsetLast )	Offsets the path locations away from walls.	NavCorridor.h
void Reset()	Resets and empties the corridor.	NavCorridor.h