NavigationRelevantData.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 "UObject/ObjectMacros.h"
#include "AI/Navigation/NavigationTypes.h"
#endif // UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
 
#include "AI/NavigationModifier.h"
#include "NavigationDirtyArea.h"
 
struct FNavigationElement;
 
struct FNavigationRelevantDataFilter 
{
    uint32 bIncludeGeometry : 1;
    uint32 bIncludeOffmeshLinks : 1;
    uint32 bIncludeAreas : 1;
    uint32 bIncludeMetaAreas : 1;
    uint32 bExcludeLoadedData : 1;
 
    FNavigationRelevantDataFilter() 
        : bIncludeGeometry(false)
        , bIncludeOffmeshLinks(false)
        , bIncludeAreas(false)
        , bIncludeMetaAreas(false)
        , bExcludeLoadedData(false)
    {}
};
 
// @todo consider optional structures that can contain a delegate instead of 
// actual copy of collision data
struct FNavigationRelevantData : public TSharedFromThis<FNavigationRelevantData, ESPMode::ThreadSafe>
{
    DECLARE_DELEGATE_RetVal_OneParam(bool, FFilterNavDataDelegate, const struct FNavDataConfig*);
 
    struct FCollisionDataHeader
    {
        int32 DataSize;
 
        static bool IsValid(const uint8* RawData, int32 RawDataSize);
    };
 
    TNavStatArray<uint8> CollisionData;
 
    TNavStatArray<uint8> VoxelData;
 
    FBox Bounds;
 
    FNavDataPerInstanceTransformDelegate NavDataPerInstanceTransformDelegate;
 
    FFilterNavDataDelegate ShouldUseGeometryDelegate;
 
    FCompositeNavModifier Modifiers;
 
#if WITH_EDITORONLY_DATA
    UE_DEPRECATED(5.5, "Use SourceElement instead.")
    TWeakObjectPtr<UObject> SourceObject;
#endif // WITH_EDITORONLY_DATA
 
    TSharedRef<const FNavigationElement> SourceElement;
 
    uint32 bPendingLazyGeometryGathering : 1;
    uint32 bPendingLazyModifiersGathering : 1;
    uint32 bPendingChildLazyModifiersGathering : 1;
 
    uint32 bSupportsGatheringGeometrySlices : 1;
 
    uint32 bShouldSkipDirtyAreaOnAddOrRemove : 1;
 
    uint32 bLoadedData : 1;
 
    FNavigationRelevantData() = delete;
 
    UE_DEPRECATED(5.5, "Use the constructor using FNavigationElement instead.")
    ENGINE_API FNavigationRelevantData(UObject& Source);
 
    explicit FNavigationRelevantData(const TSharedRef<const FNavigationElement>& Source)
        : SourceElement(Source)
        , bPendingLazyGeometryGathering(false)
        , bPendingLazyModifiersGathering(false)
        , bPendingChildLazyModifiersGathering(false)
        , bSupportsGatheringGeometrySlices(false)
        , bShouldSkipDirtyAreaOnAddOrRemove(false)
        , bLoadedData(false)
    {}
 
    ENGINE_API FNavigationRelevantData(const FNavigationRelevantData& Other);
    ENGINE_API FNavigationRelevantData(FNavigationRelevantData&& Other);
 
    ENGINE_API FNavigationRelevantData& operator=(FNavigationRelevantData&& Other);
    ENGINE_API FNavigationRelevantData& operator=(const FNavigationRelevantData& Other);
 
    inline bool HasGeometry() const { return VoxelData.Num() || CollisionData.Num(); }
    inline bool HasModifiers() const { return !Modifiers.IsEmpty(); }
    inline bool HasDynamicModifiers() const { return Modifiers.IsDynamic(); }
    inline bool IsPendingLazyGeometryGathering() const { return bPendingLazyGeometryGathering; }
    inline bool IsPendingLazyModifiersGathering() const { return bPendingLazyModifiersGathering; }
    inline bool IsPendingChildLazyModifiersGathering() const { return bPendingChildLazyModifiersGathering; }
    inline bool NeedAnyPendingLazyModifiersGathering() const { return bPendingLazyModifiersGathering || bPendingChildLazyModifiersGathering; }
    inline bool SupportsGatheringGeometrySlices() const { return bSupportsGatheringGeometrySlices; }
 
    inline bool ShouldSkipDirtyAreaOnAddOrRemove() const { return bShouldSkipDirtyAreaOnAddOrRemove; }
 
    inline bool IsEmpty() const { return !HasGeometry() && !HasModifiers(); }
    inline SIZE_T GetAllocatedSize() const { return CollisionData.GetAllocatedSize() + VoxelData.GetAllocatedSize() + Modifiers.GetAllocatedSize(); }
    inline SIZE_T GetGeometryAllocatedSize() const { return CollisionData.GetAllocatedSize() + VoxelData.GetAllocatedSize(); }
    inline ENavigationDirtyFlag GetDirtyFlag() const
    {
        const bool bSetGeometryFlag = HasGeometry() || IsPendingLazyGeometryGathering() ||
            Modifiers.GetFillCollisionUnderneathForNavmesh() || Modifiers.GetMaskFillCollisionUnderneathForNavmesh() ||
            (Modifiers.GetNavMeshResolution() != ENavigationDataResolution::Invalid);
        
        return (bSetGeometryFlag
                ? ENavigationDirtyFlag::Geometry
                : ENavigationDirtyFlag::None)
            | ((HasDynamicModifiers() || NeedAnyPendingLazyModifiersGathering())
                ? ENavigationDirtyFlag::DynamicModifier
                : ENavigationDirtyFlag::None)
            | (Modifiers.HasAgentHeightAdjust()
                ? ENavigationDirtyFlag::UseAgentHeight
                : ENavigationDirtyFlag::None);
    }
 
    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()
    {
        if (IsCollisionDataValid())
        {
            Shrink();
        }
        else
        {
            CollisionData.Empty();
        }
    }
 
    UE_DEPRECATED(5.5, "Use SourceElement instead.")
    ENGINE_API const UObject* GetOwner() const;
 
    UE_DEPRECATED(5.5, "Use SourceElement instead.")
    ENGINE_API TWeakObjectPtr<UObject> GetOwnerPtr() const;
};