NavigationQueryFilter.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_4
#include "CoreMinimal.h"
#endif
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Templates/SubclassOf.h"
#include "NavAreas/NavArea.h"
#include "AI/Navigation/NavQueryFilter.h"
#include "NavigationQueryFilter.generated.h"
 
class ANavigationData;
 
USTRUCT()
struct FNavigationFilterArea
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Area)
    TSubclassOf<UNavArea> AreaClass;
 
    UPROPERTY(EditAnywhere, Category=Area, meta=(EditCondition="bOverrideTravelCost",ClampMin=0.001))
    float TravelCostOverride;
 
    UPROPERTY(EditAnywhere, Category=Area, meta=(EditCondition="bOverrideEnteringCost",ClampMin=0))
    float EnteringCostOverride;
 
    UPROPERTY(EditAnywhere, Category=Area)
    uint32 bIsExcluded : 1;
 
    UPROPERTY(EditAnywhere, Category=Area, meta=(InlineEditConditionToggle))
    uint32 bOverrideTravelCost : 1;
 
    UPROPERTY(EditAnywhere, Category=Area, meta=(InlineEditConditionToggle))
    uint32 bOverrideEnteringCost : 1;
 
    FNavigationFilterArea()
    {
        FMemory::Memzero(*this);
        TravelCostOverride = 1.f;
    }
};
 
// 
// Use UNavigationSystemV1.DescribeFilterFlags() to setup user friendly names of flags
// 
USTRUCT()
struct FNavigationFilterFlags
{
    GENERATED_USTRUCT_BODY()
 
#if CPP
    union
    {
        struct
        {
#endif
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag0 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag1 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag2 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag3 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag4 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag5 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag6 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag7 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag8 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag9 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag10 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag11 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag12 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag13 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag14 : 1;
    UPROPERTY(EditAnywhere, Category=Flags)
    uint32 bNavFlag15 : 1;
#if CPP
        };
        uint16 Packed = 0;
    };
#endif
};
 
UCLASS(Abstract, Blueprintable, MinimalAPI)
class UNavigationQueryFilter : public UObject
{
    GENERATED_UCLASS_BODY()
    
    
    UPROPERTY(EditAnywhere, Category=Filter, meta = (TitleProperty = "AreaClass"))
    TArray<FNavigationFilterArea> Areas;
 
    UPROPERTY(EditAnywhere, Category=Filter)
    FNavigationFilterFlags IncludeFlags;
 
    UPROPERTY(EditAnywhere, Category=Filter)
    FNavigationFilterFlags ExcludeFlags;
 
    NAVIGATIONSYSTEM_API FSharedConstNavQueryFilter GetQueryFilter(const ANavigationData& NavData, const UObject* Querier) const;
    
    static NAVIGATIONSYSTEM_API FSharedConstNavQueryFilter GetQueryFilter(const ANavigationData& NavData, TSubclassOf<UNavigationQueryFilter> FilterClass);
    static NAVIGATIONSYSTEM_API FSharedConstNavQueryFilter GetQueryFilter(const ANavigationData& NavData, const UObject* Querier, TSubclassOf<UNavigationQueryFilter> FilterClass);
 
    template<class T>
    static FSharedConstNavQueryFilter GetQueryFilter(const ANavigationData& NavData, TSubclassOf<UNavigationQueryFilter> FilterClass = T::StaticClass())
    {
        return GetQueryFilter(NavData, FilterClass);
    }
 
#if WITH_EDITOR
    NAVIGATIONSYSTEM_API virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
protected:
 
    uint32 bInstantiateForQuerier : 1;
 
    uint32 bIsMetaFilter : 1;
 
    NAVIGATIONSYSTEM_API void AddTravelCostOverride(TSubclassOf<UNavArea> AreaClass, float TravelCost);
    NAVIGATIONSYSTEM_API void AddEnteringCostOverride(TSubclassOf<UNavArea> AreaClass, float EnteringCost);
    NAVIGATIONSYSTEM_API void AddExcludedArea(TSubclassOf<UNavArea> AreaClass);
 
    NAVIGATIONSYSTEM_API int32 FindAreaOverride(TSubclassOf<UNavArea> AreaClass) const;
    
    NAVIGATIONSYSTEM_API virtual void InitializeFilter(const ANavigationData& NavData, const UObject* Querier, FNavigationQueryFilter& Filter) const;
 
    virtual TSubclassOf<UNavigationQueryFilter> GetSimpleFilterForAgent(const UObject& Querier) const { return nullptr; }
};