NavigationDirtyAreasController.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
#include "AI/Navigation/NavigationTypes.h"
#endif // UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
#include "Containers/Array.h"
#include "HAL/Platform.h"
#include "Logging/LogMacros.h"
#include "Math/Box.h"
#include "Templates/Function.h"
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"
 
class UObject;
class ANavigationData;
struct FNavigationDirtyElement;
struct FNavigationElement;
struct FNavigationDirtyArea;
enum class ENavigationDirtyFlag : uint8;
 
NAVIGATIONSYSTEM_API DECLARE_LOG_CATEGORY_EXTERN(LogNavigationDirtyArea, Warning, All);
 
struct FNavigationDirtyAreasController
{
    float DirtyAreasUpdateFreq = 60.f;
 
    float DirtyAreasUpdateTime = 0.f;
 
    TArray<FNavigationDirtyArea> DirtyAreas;
 
    uint8 bCanAccumulateDirtyAreas : 1;
    uint8 bUseWorldPartitionedDynamicMode : 1;
 
#if !UE_BUILD_SHIPPING
    uint8 bDirtyAreasReportedWhileAccumulationLocked : 1;
private:
    uint8 bCanReportOversizedDirtyArea : 1;
    uint8 bNavigationBuildLocked : 1;
 
    float DirtyAreaWarningSizeThreshold = -1.f;
 
    NAVIGATIONSYSTEM_API bool ShouldReportOversizedDirtyArea() const;
#endif // !UE_BUILD_SHIPPING
 
public:
    NAVIGATIONSYSTEM_API FNavigationDirtyAreasController();
 
    NAVIGATIONSYSTEM_API void Reset();
    
    NAVIGATIONSYSTEM_API void ForceRebuildOnNextTick();
 
    NAVIGATIONSYSTEM_API void Tick(float DeltaSeconds, const TArray<ANavigationData*>& NavDataSet, bool bForceRebuilding = false);
 
    NAVIGATIONSYSTEM_API void AddArea(const FBox& NewArea, const ENavigationDirtyFlag Flags, const TFunction<const TSharedPtr<const FNavigationElement>()>& ElementProviderFunc = nullptr,
        const FNavigationDirtyElement* DirtyElement = nullptr, const FName& DebugReason = NAME_None);
    UE_DEPRECATED(5.5, "Use the version taking ENavigationDirtyFlag and FNavigationElement instead.")
    NAVIGATIONSYSTEM_API void AddArea(const FBox& NewArea, const int32 Flags, const TFunction<UObject*()>& ObjectProviderFunc = nullptr,
        const FNavigationDirtyElement* DirtyElement = nullptr, const FName& DebugReason = NAME_None);
 
    NAVIGATIONSYSTEM_API void AddAreas(const TConstArrayView<FBox> NewAreas, const ENavigationDirtyFlag Flags, const TFunction<const TSharedPtr<const FNavigationElement>()>& ElementProviderFunc = nullptr,
        const FNavigationDirtyElement* DirtyElement = nullptr, const FName& DebugReason = NAME_None);
    UE_DEPRECATED(5.5, "Use the version taking ENavigationDirtyFlag and FNavigationElement instead.")
    NAVIGATIONSYSTEM_API void AddAreas(const TConstArrayView<FBox> NewAreas, const int32 Flags, const TFunction<UObject*()>& ObjectProviderFunc = nullptr,
        const FNavigationDirtyElement* DirtyElement = nullptr, const FName& DebugReason = NAME_None);
    
    bool IsDirty() const { return GetNumDirtyAreas() > 0; }
    int32 GetNumDirtyAreas() const { return DirtyAreas.Num(); }
 
    NAVIGATIONSYSTEM_API void OnNavigationBuildLocked();
    NAVIGATIONSYSTEM_API void OnNavigationBuildUnlocked();
 
    NAVIGATIONSYSTEM_API void SetUseWorldPartitionedDynamicMode(bool bIsWPDynamic);
    NAVIGATIONSYSTEM_API void SetCanReportOversizedDirtyArea(const bool bCanReport);
    NAVIGATIONSYSTEM_API void SetDirtyAreaWarningSizeThreshold(const float Threshold);
 
#if !UE_BUILD_SHIPPING
    bool HadDirtyAreasReportedWhileAccumulationLocked() const { return bCanAccumulateDirtyAreas == false && bDirtyAreasReportedWhileAccumulationLocked; }
#endif // UE_BUILD_SHIPPING
 
    DECLARE_DELEGATE_RetVal_OneParam(bool, FSkipObjectSignature, const UObject& /*Object*/);
    FSkipObjectSignature ShouldSkipObjectPredicate;
};