UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FNavDataGenerator Class Reference

#include <NavDataGenerator.h>

+ Inheritance diagram for FNavDataGenerator:

Public Member Functions

virtual ~FNavDataGenerator ()
 
virtual bool RebuildAll ()
 
virtual void EnsureBuildCompletion ()
 
virtual void CancelBuild ()
 
virtual void TickAsyncBuild (float DeltaSeconds)
 
virtual void OnNavigationBoundsChanged ()
 
virtual void RebuildDirtyAreas (const TArray< FNavigationDirtyArea > &DirtyAreas)
 
virtual bool IsBuildInProgressCheckDirty () const
 
virtual bool GetTimeSliceData (int32 &OutNumRemainingBuildTasks, double &OutCurrentBuildTaskDuration) const
 
virtual int32 GetNumRemaningBuildTasks () const
 
virtual int32 GetNumRunningBuildTasks () const
 
virtual uint32 LogMemUsed () const
 
- Public Member Functions inherited from TSharedFromThis< FNavDataGenerator, ESPMode::ThreadSafe >
TSharedRef< FNavDataGenerator, Mode > AsShared ()
 
TSharedRef< FNavDataGenerator const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FNavDataGenerator, Mode > AsWeak ()
 
TWeakPtr< FNavDataGenerator 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
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< FNavDataGenerator, ESPMode::ThreadSafe >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FNavDataGenerator, 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

◆ ~FNavDataGenerator()

virtual FNavDataGenerator::~FNavDataGenerator ( )
inlinevirtual

Member Function Documentation

◆ CancelBuild()

virtual void FNavDataGenerator::CancelBuild ( )
inlinevirtual

Cancels build, may block until current running async tasks are finished

◆ EnsureBuildCompletion()

virtual void FNavDataGenerator::EnsureBuildCompletion ( )
inlinevirtual

Blocks until build is complete

◆ GetNumRemaningBuildTasks()

virtual int32 FNavDataGenerator::GetNumRemaningBuildTasks ( ) const
inlinevirtual

Returns number of remaining tasks till build is complete

◆ GetNumRunningBuildTasks()

virtual int32 FNavDataGenerator::GetNumRunningBuildTasks ( ) const
inlinevirtual

Returns number of currently running tasks

◆ GetTimeSliceData()

virtual bool FNavDataGenerator::GetTimeSliceData ( int32 OutNumRemainingBuildTasks,
double OutCurrentBuildTaskDuration 
) const
inlinevirtual

◆ IsBuildInProgressCheckDirty()

virtual bool FNavDataGenerator::IsBuildInProgressCheckDirty ( ) const
inlinevirtual

determines whether this generator is performing navigation building actions at the moment, dirty areas are also checked

◆ LogMemUsed()

virtual uint32 FNavDataGenerator::LogMemUsed ( ) const
inlinevirtual

◆ OnNavigationBoundsChanged()

virtual void FNavDataGenerator::OnNavigationBoundsChanged ( )
inlinevirtual

◆ RebuildAll()

virtual bool FNavDataGenerator::RebuildAll ( )
inlinevirtual

Rebuilds all known navigation data

◆ RebuildDirtyAreas()

virtual void FNavDataGenerator::RebuildDirtyAreas ( const TArray< FNavigationDirtyArea > &  DirtyAreas)
inlinevirtual

Asks generator to update navigation affected by DirtyAreas

◆ TickAsyncBuild()

virtual void FNavDataGenerator::TickAsyncBuild ( float  DeltaSeconds)
inlinevirtual

Ticks navigation build If the generator is set to time sliced rebuild then this function will only get called when there is sufficient time (effectively roughly once in n frames where n is the number of time sliced nav data / generators currently building)


The documentation for this class was generated from the following file: