FNavigationRelevantData Struct Reference

#include <NavigationRelevantData.h>

Inheritance diagram for FNavigationRelevantData:

Classes
struct	FCollisionDataHeader

Public Member Functions
	DECLARE_DELEGATE_RetVal_OneParam (bool, FFilterNavDataDelegate, const struct FNavDataConfig *)
	FNavigationRelevantData ()=delete
ENGINE_API	FNavigationRelevantData (UObject &Source)
	FNavigationRelevantData (const TSharedRef< const FNavigationElement > &Source)
ENGINE_API	FNavigationRelevantData (const FNavigationRelevantData &Other)
ENGINE_API	FNavigationRelevantData (FNavigationRelevantData &&Other)
ENGINE_API FNavigationRelevantData &	operator= (FNavigationRelevantData &&Other)
ENGINE_API FNavigationRelevantData &	operator= (const FNavigationRelevantData &Other)
bool	HasGeometry () const
bool	HasModifiers () const
bool	HasDynamicModifiers () const
bool	IsPendingLazyGeometryGathering () const
bool	IsPendingLazyModifiersGathering () const
bool	IsPendingChildLazyModifiersGathering () const
bool	NeedAnyPendingLazyModifiersGathering () const
bool	SupportsGatheringGeometrySlices () const
bool	ShouldSkipDirtyAreaOnAddOrRemove () const
bool	IsEmpty () const
SIZE_T	GetAllocatedSize () const
SIZE_T	GetGeometryAllocatedSize () const
ENavigationDirtyFlag	GetDirtyFlag () const
ENGINE_API FCompositeNavModifier	GetModifierForAgent (const FNavAgentProperties *NavAgent=nullptr) const
ENGINE_API bool	HasPerInstanceTransforms () const
ENGINE_API bool	IsMatchingFilter (const FNavigationRelevantDataFilter &Filter) const
ENGINE_API void	Shrink ()
ENGINE_API bool	IsCollisionDataValid () const
void	ValidateAndShrink ()
ENGINE_API const UObject *	GetOwner () const
ENGINE_API TWeakObjectPtr< UObject >	GetOwnerPtr () const
Public Member Functions inherited from TSharedFromThis< FNavigationRelevantData, ESPMode::ThreadSafe >
TSharedRef< FNavigationRelevantData, Mode >	AsShared ()
TSharedRef< FNavigationRelevantData const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FNavigationRelevantData, Mode >	AsWeak ()
TWeakPtr< FNavigationRelevantData 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

Public Attributes
TNavStatArray< uint8 >	CollisionData
TNavStatArray< uint8 >	VoxelData
FBox	Bounds
FNavDataPerInstanceTransformDelegate	NavDataPerInstanceTransformDelegate
FFilterNavDataDelegate	ShouldUseGeometryDelegate
FCompositeNavModifier	Modifiers
TSharedRef< const FNavigationElement >	SourceElement
uint32	bPendingLazyGeometryGathering: 1
uint32	bPendingLazyModifiersGathering: 1
uint32	bPendingChildLazyModifiersGathering: 1
uint32	bSupportsGatheringGeometrySlices: 1
uint32	bShouldSkipDirtyAreaOnAddOrRemove: 1
uint32	bLoadedData: 1

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FNavigationRelevantData, ESPMode::ThreadSafe >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FNavigationRelevantData, 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

FNavigationRelevantData() [1/5]

FNavigationRelevantData::FNavigationRelevantData ( )

delete

FNavigationRelevantData() [2/5]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FNavigationRelevantData::FNavigationRelevantData

(

UObject &

Source

)

FNavigationRelevantData() [3/5]

FNavigationRelevantData::FNavigationRelevantData ( const TSharedRef< const FNavigationElement > &  Source )

inlineexplicit

FNavigationRelevantData() [4/5]

FNavigationRelevantData::FNavigationRelevantData

(

const FNavigationRelevantData &

Other

)

FNavigationRelevantData() [5/5]

FNavigationRelevantData::FNavigationRelevantData

(

FNavigationRelevantData &&

Other

)

Member Function Documentation

DECLARE_DELEGATE_RetVal_OneParam()

FNavigationRelevantData::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FFilterNavDataDelegate	,
		const struct FNavDataConfig *
	)

GetAllocatedSize()

SIZE_T FNavigationRelevantData::GetAllocatedSize ( ) const

inline

GetDirtyFlag()

ENavigationDirtyFlag FNavigationRelevantData::GetDirtyFlag ( ) const

inline

GetGeometryAllocatedSize()

SIZE_T FNavigationRelevantData::GetGeometryAllocatedSize ( ) const

inline

GetModifierForAgent()

FCompositeNavModifier FNavigationRelevantData::GetModifierForAgent

(

const FNavAgentProperties *

NavAgent = nullptr

)

const

GetOwner()

const UObject * FNavigationRelevantData::GetOwner

(

)

const

GetOwnerPtr()

TWeakObjectPtr< UObject > FNavigationRelevantData::GetOwnerPtr

(

)

const

HasDynamicModifiers()

bool FNavigationRelevantData::HasDynamicModifiers ( ) const

inline

HasGeometry()

bool FNavigationRelevantData::HasGeometry ( ) const

inline

HasModifiers()

bool FNavigationRelevantData::HasModifiers ( ) const

inline

HasPerInstanceTransforms()

bool FNavigationRelevantData::HasPerInstanceTransforms

(

)

const

IsCollisionDataValid()

bool FNavigationRelevantData::IsCollisionDataValid

(

)

const

IsEmpty()

bool FNavigationRelevantData::IsEmpty ( ) const

inline

IsMatchingFilter()

bool FNavigationRelevantData::IsMatchingFilter

(

const FNavigationRelevantDataFilter &

Filter

)

const

IsPendingChildLazyModifiersGathering()

bool FNavigationRelevantData::IsPendingChildLazyModifiersGathering ( ) const

inline

IsPendingLazyGeometryGathering()

bool FNavigationRelevantData::IsPendingLazyGeometryGathering ( ) const

inline

IsPendingLazyModifiersGathering()

bool FNavigationRelevantData::IsPendingLazyModifiersGathering ( ) const

inline

NeedAnyPendingLazyModifiersGathering()

bool FNavigationRelevantData::NeedAnyPendingLazyModifiersGathering ( ) const

inline

operator=() [1/2]

FNavigationRelevantData & FNavigationRelevantData::operator=

(

const FNavigationRelevantData &

Other

)

operator=() [2/2]

FNavigationRelevantData & FNavigationRelevantData::operator=

(

FNavigationRelevantData &&

Other

)

ShouldSkipDirtyAreaOnAddOrRemove()

bool FNavigationRelevantData::ShouldSkipDirtyAreaOnAddOrRemove ( ) const

inline

Indicates that this object will not dirty the navmesh when added or removed from the octree. In this case we expect it to manually dirty areas (e.g. using OnObjectBoundsChanged).

Shrink()

void FNavigationRelevantData::Shrink

(

)

SupportsGatheringGeometrySlices()

bool FNavigationRelevantData::SupportsGatheringGeometrySlices ( ) const

inline

ValidateAndShrink()

void FNavigationRelevantData::ValidateAndShrink ( )

inline

Member Data Documentation

bLoadedData

uint32 FNavigationRelevantData::bLoadedData

From level loading (only valid in WP dynamic mode)

Bounds

FBox FNavigationRelevantData::Bounds

bounds of geometry (unreal coords)

bPendingChildLazyModifiersGathering

uint32 FNavigationRelevantData::bPendingChildLazyModifiersGathering

bPendingLazyGeometryGathering

uint32 FNavigationRelevantData::bPendingLazyGeometryGathering

get set to true when lazy navigation exporting is enabled and this navigation data has "potential" of containing geometry data. First access will result in gathering the data and setting this flag back to false. Mind that this flag can go back to 'true' if related data gets cleared out.

bPendingLazyModifiersGathering

uint32 FNavigationRelevantData::bPendingLazyModifiersGathering

bShouldSkipDirtyAreaOnAddOrRemove

uint32 FNavigationRelevantData::bShouldSkipDirtyAreaOnAddOrRemove

Indicates that this data will not dirty the navmesh when added or removed from the octree.

bSupportsGatheringGeometrySlices

uint32 FNavigationRelevantData::bSupportsGatheringGeometrySlices

CollisionData

TNavStatArray<uint8> FNavigationRelevantData::CollisionData

exported geometry (used by recast navmesh as FRecastGeometryCache)

Modifiers

FCompositeNavModifier FNavigationRelevantData::Modifiers

additional modifiers: areas and external links

NavDataPerInstanceTransformDelegate

FNavDataPerInstanceTransformDelegate FNavigationRelevantData::NavDataPerInstanceTransformDelegate

Gathers per instance data for navigation geometry in a specified area box

ShouldUseGeometryDelegate

FFilterNavDataDelegate FNavigationRelevantData::ShouldUseGeometryDelegate

called to check if hosted geometry should be used for given FNavDataConfig. If not set then "true" is assumed. Might want to set bUseVirtualGeometryFilteringAndDirtying to true in the Navmesh class you are excluding geometry from. This will improve cpu performance by stopping the navmesh from dirtying tiles requested by actors being excluded by this delegate.

SourceElement

TSharedRef<const FNavigationElement> FNavigationRelevantData::SourceElement

Navigation element this data represents

VoxelData

TNavStatArray<uint8> FNavigationRelevantData::VoxelData

cached voxels (used by recast navmesh as FRecastVoxelCache)

---

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

• Engine/Source/Runtime/Engine/Classes/AI/Navigation/NavigationRelevantData.h
• Engine/Source/Runtime/Engine/Private/AI/Navigation/NavigationTypes.cpp