FNavigationQueryFilter Struct Reference

#include <NavQueryFilter.h>

Inheritance diagram for FNavigationQueryFilter:

Public Member Functions
	FNavigationQueryFilter ()
ENGINE_API void	SetAreaCost (uint8 AreaType, float Cost)
ENGINE_API void	SetFixedAreaEnteringCost (uint8 AreaType, float Cost)
ENGINE_API void	SetExcludedArea (uint8 AreaType)
ENGINE_API void	SetAllAreaCosts (const TArray< float > &CostArray)
ENGINE_API void	SetAllAreaCosts (const float *CostArray, const int32 Count)
ENGINE_API void	GetAllAreaCosts (float *CostArray, float *FixedCostArray, const int32 Count) const
ENGINE_API void	SetIncludeFlags (uint16 Flags)
ENGINE_API uint16	GetIncludeFlags () const
ENGINE_API void	SetExcludeFlags (uint16 Flags)
ENGINE_API uint16	GetExcludeFlags () const
void	SetMaxSearchNodes (const uint32 MaxNodes)
uint32	GetMaxSearchNodes () const
float	GetHeuristicScale () const
void	SetBacktrackingEnabled (const bool bBacktracking)
bool	IsBacktrackingEnabled () const
FVector	GetAdjustedEndLocation (const FVector &EndPoint) const
template<typename FilterType >
void	SetFilterType ()
void	SetFilterImplementation (const INavigationQueryFilterInterface *InQueryFilterImpl)
const INavigationQueryFilterInterface *	GetImplementation () const
INavigationQueryFilterInterface *	GetImplementation ()
void	Reset ()
ENGINE_API FSharedNavQueryFilter	GetCopy () const
bool	operator== (const FNavigationQueryFilter &Other) const
Public Member Functions inherited from TSharedFromThis< FNavigationQueryFilter, ESPMode::ThreadSafe >
TSharedRef< FNavigationQueryFilter, Mode >	AsShared ()
TSharedRef< FNavigationQueryFilter const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FNavigationQueryFilter, Mode >	AsWeak ()
TWeakPtr< FNavigationQueryFilter const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Attributes
static ENGINE_API const uint32	DefaultMaxSearchNodes = MAX_NAV_SEARCH_NODES

Protected Member Functions
ENGINE_API void	Assign (const FNavigationQueryFilter &Source)
Protected Member Functions inherited from TSharedFromThis< FNavigationQueryFilter, ESPMode::ThreadSafe >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Protected Attributes
TSharedPtr< INavigationQueryFilterInterface, ESPMode::ThreadSafe >	QueryFilterImpl
uint32	MaxSearchNodes

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< FNavigationQueryFilter, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

FNavigationQueryFilter()

FNavigationQueryFilter::FNavigationQueryFilter ( )

inline

Member Function Documentation

Assign()

void FNavigationQueryFilter::Assign ( const FNavigationQueryFilter &  Source )

protected

GetAdjustedEndLocation()

FVector FNavigationQueryFilter::GetAdjustedEndLocation ( const FVector &  EndPoint ) const

inline

post processing for pathfinding's end point

GetAllAreaCosts()

void FNavigationQueryFilter::GetAllAreaCosts	(	float *	CostArray,
		float *	FixedCostArray,
		const int32	Count
	)		const

get travel & entering costs for all areas

GetCopy()

FSharedNavQueryFilter FNavigationQueryFilter::GetCopy

(

)

const

GetExcludeFlags()

uint16 FNavigationQueryFilter::GetExcludeFlags

(

)

const

get forbidden flags of navigation nodes

GetHeuristicScale()

float FNavigationQueryFilter::GetHeuristicScale ( ) const

inline

get heuristic scaling factor

GetImplementation() [1/2]

INavigationQueryFilterInterface * FNavigationQueryFilter::GetImplementation ( )

inline

GetImplementation() [2/2]

const INavigationQueryFilterInterface * FNavigationQueryFilter::GetImplementation ( ) const

inline

GetIncludeFlags()

uint16 FNavigationQueryFilter::GetIncludeFlags

(

)

const

get required flags of navigation nodes

GetMaxSearchNodes()

uint32 FNavigationQueryFilter::GetMaxSearchNodes ( ) const

inline

get node limit for A* loop

IsBacktrackingEnabled()

bool FNavigationQueryFilter::IsBacktrackingEnabled ( ) const

inline

get backtracking status

operator==()

bool FNavigationQueryFilter::operator== ( const FNavigationQueryFilter &  Other ) const

inline

Reset()

void FNavigationQueryFilter::Reset ( )

inline

SetAllAreaCosts() [1/2]

void FNavigationQueryFilter::SetAllAreaCosts	(	const float *	CostArray,
		const int32	Count
	)

SetAllAreaCosts() [2/2]

void FNavigationQueryFilter::SetAllAreaCosts

(

const TArray< float > &

CostArray

)

set travel cost for all areas

SetAreaCost()

void FNavigationQueryFilter::SetAreaCost	(	uint8	AreaType,
		float	Cost
	)

set travel cost for area

SetBacktrackingEnabled()

void FNavigationQueryFilter::SetBacktrackingEnabled ( const bool  bBacktracking )

inline

mark filter as backtracking - parse directional links in opposite direction (find path from End to Start, but all links works like on path from Start to End)

SetExcludedArea()

void FNavigationQueryFilter::SetExcludedArea

(

uint8

AreaType

)

mark area as excluded from path finding

SetExcludeFlags()

void FNavigationQueryFilter::SetExcludeFlags

(

uint16

Flags

)

set forbidden flags of navigation nodes

SetFilterImplementation()

void FNavigationQueryFilter::SetFilterImplementation ( const INavigationQueryFilterInterface *  InQueryFilterImpl )

inline

SetFilterType()

template<typename FilterType >

void FNavigationQueryFilter::SetFilterType ( )

inline

SetFixedAreaEnteringCost()

void FNavigationQueryFilter::SetFixedAreaEnteringCost	(	uint8	AreaType,
		float	Cost
	)

set entering cost for area

SetIncludeFlags()

void FNavigationQueryFilter::SetIncludeFlags

(

uint16

Flags

)

set required flags of navigation nodes

SetMaxSearchNodes()

void FNavigationQueryFilter::SetMaxSearchNodes ( const uint32  MaxNodes )

inline

set node limit for A* loop

Member Data Documentation

DefaultMaxSearchNodes

const uint32 FNavigationQueryFilter::DefaultMaxSearchNodes = MAX_NAV_SEARCH_NODES

static

MaxSearchNodes

uint32 FNavigationQueryFilter::MaxSearchNodes

protected

QueryFilterImpl

TSharedPtr<INavigationQueryFilterInterface, ESPMode::ThreadSafe> FNavigationQueryFilter::QueryFilterImpl

protected

---

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

• Engine/Source/Runtime/Engine/Public/AI/Navigation/NavQueryFilter.h
• Engine/Source/Runtime/Engine/Private/AI/Navigation/NavigationTypes.cpp