FPathFindingQuery Struct Reference

#include <NavigationSystemTypes.h>

Inheritance diagram for FPathFindingQuery:

Public Member Functions
	FPathFindingQuery ()
NAVIGATIONSYSTEM_API	FPathFindingQuery (const UObject *InOwner, const ANavigationData &InNavData, const FVector &Start, const FVector &End, FSharedConstNavQueryFilter SourceQueryFilter=NULL, FNavPathSharedPtr InPathInstanceToFill=NULL, const FVector::FReal CostLimit=TNumericLimits< FVector::FReal >::Max(), const bool bInRequireNavigableEndLocation=true)
NAVIGATIONSYSTEM_API	FPathFindingQuery (const INavAgentInterface &InNavAgent, const ANavigationData &InNavData, const FVector &Start, const FVector &End, FSharedConstNavQueryFilter SourceQueryFilter=NULL, FNavPathSharedPtr InPathInstanceToFill=NULL, const FVector::FReal CostLimit=TNumericLimits< FVector::FReal >::Max(), const bool bInRequireNavigableEndLocation=true)
NAVIGATIONSYSTEM_API	FPathFindingQuery (FNavPathSharedRef PathToRecalculate, const ANavigationData *NavDataOverride=NULL)
FPathFindingQuery &	SetPathInstanceToUpdate (FNavPathSharedPtr InPathInstanceToFill)
FPathFindingQuery &	SetAllowPartialPaths (const bool bAllow)
FPathFindingQuery &	SetRequireNavigableEndLocation (const bool bRequire)
FPathFindingQuery &	SetNavAgentProperties (const FNavAgentProperties &InNavAgentProperties)
Public Member Functions inherited from FPathFindingQueryData
	FPathFindingQueryData ()
	FPathFindingQueryData (const UObject *InOwner, const FVector &InStartLocation, const FVector &InEndLocation, FSharedConstNavQueryFilter InQueryFilter=nullptr, int32 InNavDataFlags=0, bool bInAllowPartialPaths=true, const FVector::FReal InCostLimit=TNumericLimits< FVector::FReal >::Max(), const bool bInRequireNavigableEndLocation=true)

Static Public Member Functions
static NAVIGATIONSYSTEM_API FVector::FReal	ComputeCostLimitFromHeuristic (const FVector &StartPos, const FVector &EndPos, const FVector::FReal HeuristicScale, const FVector::FReal CostLimitFactor, const FVector::FReal MinimumCostLimit)

Public Attributes
TWeakObjectPtr< const ANavigationData >	NavData
FNavPathSharedPtr	PathInstanceToFill
FNavAgentProperties	NavAgentProperties
Public Attributes inherited from FPathFindingQueryData
TWeakObjectPtr< const UObject >	Owner
FVector	StartLocation
FVector	EndLocation
FSharedConstNavQueryFilter	QueryFilter
FVector::FReal	CostLimit
int32	NavDataFlags
uint32	bAllowPartialPaths: 1
uint32	bRequireNavigableEndLocation: 1

Constructor & Destructor Documentation

FPathFindingQuery() [1/4]

FPathFindingQuery::FPathFindingQuery ( )

inline

FPathFindingQuery() [2/4]

FPathFindingQuery::FPathFindingQuery	(	const UObject *	InOwner,
		const ANavigationData &	InNavData,
		const FVector &	Start,
		const FVector &	End,
		FSharedConstNavQueryFilter	SourceQueryFilter = NULL,
		FNavPathSharedPtr	InPathInstanceToFill = NULL,
		const FVector::FReal	CostLimit = TNumericLimits<FVector::FReal>::Max(),
		const bool	bInRequireNavigableEndLocation = true
	)

FPathFindingQuery() [3/4]

FPathFindingQuery::FPathFindingQuery	(	const INavAgentInterface &	InNavAgent,
		const ANavigationData &	InNavData,
		const FVector &	Start,
		const FVector &	End,
		FSharedConstNavQueryFilter	SourceQueryFilter = NULL,
		FNavPathSharedPtr	InPathInstanceToFill = NULL,
		const FVector::FReal	CostLimit = TNumericLimits<FVector::FReal>::Max(),
		const bool	bInRequireNavigableEndLocation = true
	)

FPathFindingQuery() [4/4]

FPathFindingQuery::FPathFindingQuery ( FNavPathSharedRef  PathToRecalculate, const ANavigationData *  NavDataOverride = NULL  )

explicit

Member Function Documentation

ComputeCostLimitFromHeuristic()

FVector::FReal FPathFindingQuery::ComputeCostLimitFromHeuristic ( const FVector &  StartPos, const FVector &  EndPos, const FVector::FReal  HeuristicScale, const FVector::FReal  CostLimitFactor, const FVector::FReal  MinimumCostLimit  )

static

utility function to compute a cost limit using an Euclidean heuristic, an heuristic scale and a cost limit factor CostLimitFactor: multiplier used to compute the cost limit value from the initial heuristic MinimumCostLimit: minimum clamping value used to prevent low cost limit for short path query

SetAllowPartialPaths()

FPathFindingQuery & FPathFindingQuery::SetAllowPartialPaths ( const bool  bAllow )

inline

SetNavAgentProperties()

FPathFindingQuery & FPathFindingQuery::SetNavAgentProperties ( const FNavAgentProperties &  InNavAgentProperties )

inline

SetPathInstanceToUpdate()

FPathFindingQuery & FPathFindingQuery::SetPathInstanceToUpdate ( FNavPathSharedPtr  InPathInstanceToFill )

inline

SetRequireNavigableEndLocation()

FPathFindingQuery & FPathFindingQuery::SetRequireNavigableEndLocation ( const bool  bRequire )

inline

Member Data Documentation

NavAgentProperties

FNavAgentProperties FPathFindingQuery::NavAgentProperties

NavData

TWeakObjectPtr<const ANavigationData> FPathFindingQuery::NavData

PathInstanceToFill

FNavPathSharedPtr FPathFindingQuery::PathInstanceToFill

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/NavigationSystem/Public/NavigationSystemTypes.h
• Engine/Source/Runtime/NavigationSystem/Private/NavigationData.cpp