1. Epic GamesDeveloper
  3. FNavigationDirtyAreasController

FNavigationDirtyAreasController

API > API/Runtime > API/Runtime/NavigationSystem

   
Name FNavigationDirtyAreasController
Type struct
Header File /Engine/Source/Runtime/NavigationSystem/Public/NavigationDirtyAreasController.h
Include Path #include "NavigationDirtyAreasController.h"

Syntax

struct FNavigationDirtyAreasController

Constructors

Name Remarks Include Path Unreal Specifiers

FNavigationDirtyAreasController()

   NavigationDirtyAreasController.h  

Typedefs

Name Type Remarks Include Path
FSkipObjectSignature TBaseDelegate_OneParam< bool, const UObject & >   NavigationDirtyAreasController.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCanAccumulateDirtyAreas uint8   NavigationDirtyAreasController.h  
bDirtyAreasReportedWhileAccumulationLocked uint8   NavigationDirtyAreasController.h  
bUseWorldPartitionedDynamicMode uint8   NavigationDirtyAreasController.h  
DirtyAreas TArray< FNavigationDirtyArea > Stores areas marked as dirty throughout the frame, processes them once a frame in Tick function NavigationDirtyAreasController.h  
DirtyAreasUpdateFreq float Update frequency for dirty areas on navmesh NavigationDirtyAreasController.h  
DirtyAreasUpdateTime float Temporary cumulative time to calculate when we need to update dirty areas NavigationDirtyAreasController.h  
ShouldSkipObjectPredicate FSkipObjectSignature   NavigationDirtyAreasController.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bCanReportOversizedDirtyArea uint8   NavigationDirtyAreasController.h  
bNavigationBuildLocked uint8   NavigationDirtyAreasController.h  
DirtyAreaWarningSizeThreshold float -1 by default, if set to a positive value dirty area with bounds size over that threshold will be logged NavigationDirtyAreasController.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddArea ( const FBox& NewArea,
const int32 Flags,
const TFunction< UObject*()>& ObjectProviderFunc,
const FNavigationDirtyElement* DirtyElement,
const FName& DebugReason
)

   NavigationDirtyAreasController.h  

void AddArea ( const FBox& NewArea,
const ENavigationDirtyFlag Flags,
const TFunction< const TSharedPtr< const FNavigationElement >()>& ElementProviderFunc,
const FNavigationDirtyElement* DirtyElement,
const FName& DebugReason
)

 Add a dirty area to the queue based on the provided bounds and flags. NavigationDirtyAreasController.h  

void AddAreas ( const TConstArrayView< FBox > NewAreas,
const int32 Flags,
const TFunction< UObject*()>& ObjectProviderFunc,
const FNavigationDirtyElement* DirtyElement,
const FName& DebugReason
)

   NavigationDirtyAreasController.h  

void AddAreas ( const TConstArrayView< FBox > NewAreas,
const ENavigationDirtyFlag Flags,
const TFunction< const TSharedPtr< const FNavigationElement >()>& ElementProviderFunc,
const FNavigationDirtyElement* DirtyElement,
const FName& DebugReason
)

 Add non-empty list of dirty areas to the queue based on the provided bounds and flags. NavigationDirtyAreasController.h  

void ForceRebuildOnNextTick()

 Sets cumulative time to at least one cycle so next tick will rebuild dirty areas NavigationDirtyAreasController.h  

int32 GetNumDirtyAreas()

   NavigationDirtyAreasController.h  

bool HadDirtyAreasReportedWhileAccumulationLocked()

   NavigationDirtyAreasController.h  

bool IsDirty()

   NavigationDirtyAreasController.h  

void OnNavigationBuildLocked()

   NavigationDirtyAreasController.h  

void OnNavigationBuildUnlocked()

   NavigationDirtyAreasController.h  

void Reset()

   NavigationDirtyAreasController.h  

void SetCanReportOversizedDirtyArea ( const bool bCanReport
)

   NavigationDirtyAreasController.h  

void SetDirtyAreaWarningSizeThreshold ( const float Threshold
)

   NavigationDirtyAreasController.h  

void SetUseWorldPartitionedDynamicMode ( bool bIsWPDynamic
)

   NavigationDirtyAreasController.h  

void Tick ( float DeltaSeconds,
const TArray< ANavigationData* >& NavDataSet,
bool bForceRebuilding
)

   NavigationDirtyAreasController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page