FNavCorridor

Navigation corridor defines free space around path.

API > API/Plugins > API/Plugins/NavCorridor

Inheritance Hierarchy

References

   
Module NavCorridor
Header /Engine/Plugins/Runtime/NavCorridor/Source/NavCorridor/Public/NavCorridor.h
Include #include "NavCorridor.h"

Syntax

struct FNavCorridor : public TSharedFromThis< FNavCorridor >

Remarks

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.

Variables

  Type Name Description
Public variable TArray< FNavCorridorPortal > Portals Portal points defining the corridor.

Functions

  Type Name Description
Public function Const FNavCorridorLocation

AdvancePathLocation ( const FNavCorridorLocation& PathLocation,
const FVector::FReal AdvanceDistance
)

 Advances path location along the path that goes through the corridor.
Public function void

BuildFromPath ( const FNavigationPath& Path,
FSharedConstNavQueryFilter NavQueryFilter,
const FNavCorridorParams& Params
)

 Builds the corridor from a given Path.
Public function 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
Public function Const FVector

ConstrainVisibility ( const FNavCorridorLocation& PathLocation,
const FVector Source,
const FVector Target,
const float ForceLookAheadDistance
)

  
Public function Const FNavCorridorLocation

FindNearestLocationOnPath ( const FVector Location
)

 Finds nearest location on path going through the corridor.
Public function Const FVector::FReal  
Public function Const FVector

GetPathDirection ( const FNavCorridorLocation& PathLocation
)

  
Public function bool

HitTest ( const FVector SegmentStart,
const FVector SegmentEnd,
double& HitT
)

  
Public function Const bool

IsValid ()

  
Public function void

OffsetPathLocationsFromWalls ( const float Offset,
bool bOffsetFirst,
bool bOffsetLast
)

 Offsets the path locations away from walls.
Public function void

Reset ()

 Resets and empties the corridor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page