ARFilter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
#include "UObject/SoftObjectPath.h"
#include "UObject/TopLevelAssetPath.h"
 
#include "ARFilter.generated.h"
 
class FCbField;
class FCbWriter;
struct FAssetData;
 
USTRUCT(BlueprintType, meta = (HasNativeMake = "/Script/Engine.KismetSystemLibrary.MakeARFilter", HasNativeBreak = "/Script/Engine.KismetSystemLibrary.BreakARFilter"))
struct FARFilter
{
    GENERATED_BODY()
public:
PRAGMA_DISABLE_DEPRECATION_WARNINGS // Compilers can complain about deprecated members in compiler generated code
    FARFilter() = default;
    FARFilter(FARFilter&&) = default;
    FARFilter(const FARFilter&) = default;
    FARFilter& operator=(FARFilter&&) = default;
    FARFilter& operator=(const FARFilter&) = default;
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    TArray<FName> PackageNames;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    TArray<FName> PackagePaths;
 
#if WITH_EDITORONLY_DATA
    UE_DEPRECATED(5.1, "Asset path FNames have been deprecated, use FSoftObjectPath instead.")
    UPROPERTY()
    TArray<FName> ObjectPaths;
#endif
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    TArray<FSoftObjectPath> SoftObjectPaths;
    
    UE_DEPRECATED(5.1, "Class names are now represented by path names. Please use ClassPaths.")
    UPROPERTY(BlueprintReadWrite, Category = AssetRegistry, meta=(DeprecatedProperty, DeprecationMessage="Short asset class names must be converted to full asset pathnames. Use ClassPaths instead."))
    TArray<FName> ClassNames;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    TArray<FTopLevelAssetPath> ClassPaths;
 
    TMultiMap<FName, TOptional<FString>> TagsAndValues;
 
    UE_DEPRECATED(5.1, "Class names are now represented by path names. Please use RecursiveClassPathsExclusionSet.")
    UPROPERTY(BlueprintReadWrite, Category = AssetRegistry, meta=(DeprecatedProperty, DeprecationMessage="Short asset class names must be converted to full asset pathnames. Use RecursiveClassPathsExclusionSet instead."))
    TSet<FName> RecursiveClassesExclusionSet;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    TSet<FTopLevelAssetPath> RecursiveClassPathsExclusionSet;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    bool bRecursivePaths = false;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    bool bRecursiveClasses = false;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = AssetRegistry)
    bool bIncludeOnlyOnDiskAssets = false;
 
    uint32 WithoutPackageFlags = 0;
 
    uint32 WithPackageFlags = 0;
 
    void Append(const FARFilter& Other)
    {
        PackageNames.Append(Other.PackageNames);
        PackagePaths.Append(Other.PackagePaths);
        SoftObjectPaths.Append(Other.SoftObjectPaths);
        ClassPaths.Append(Other.ClassPaths);
 
        for (auto TagIt = Other.TagsAndValues.CreateConstIterator(); TagIt; ++TagIt)
        {
            TagsAndValues.Add(TagIt.Key(), TagIt.Value());
        }
 
        RecursiveClassPathsExclusionSet.Append(Other.RecursiveClassPathsExclusionSet);
 
        bRecursivePaths |= Other.bRecursivePaths;
        bRecursiveClasses |= Other.bRecursiveClasses;
        bIncludeOnlyOnDiskAssets |= Other.bIncludeOnlyOnDiskAssets;
        WithoutPackageFlags |= Other.WithoutPackageFlags;
        WithPackageFlags |= Other.WithPackageFlags;
    }
 
    bool IsEmpty() const
    {
        return (PackageNames.Num() | PackagePaths.Num() | SoftObjectPaths.Num() | ClassPaths.Num() | TagsAndValues.Num() | WithoutPackageFlags | WithPackageFlags) == 0;
    }
 
    bool IsRecursive() const
    {
        return bRecursivePaths || bRecursiveClasses;
    }
 
    void Clear()
    {
        PackageNames.Empty();
        PackagePaths.Empty();
        SoftObjectPaths.Empty();
        ClassPaths.Empty();
        TagsAndValues.Empty();
        RecursiveClassPathsExclusionSet.Empty();
 
        bRecursivePaths = false;
        bRecursiveClasses = false;
        bIncludeOnlyOnDiskAssets = false;
        WithoutPackageFlags = 0;
        WithPackageFlags = 0;
 
        ensure(IsEmpty());
    }
 
    void PostSerialize(const FArchive& Ar);
 
    COREUOBJECT_API void SortForSaving();
    COREUOBJECT_API bool operator==(const FARFilter& Other) const;
    COREUOBJECT_API bool operator<(const FARFilter& Other) const;
 
private:
    COREUOBJECT_API void Save(FCbWriter& Writer) const;
    COREUOBJECT_API bool TryLoad(const FCbFieldView& Field);
 
    // Hidden friends for our argument-dependent lookup functions
    friend FCbWriter& operator<<(FCbWriter& Writer, const FARFilter& Filter)
    {
        Filter.Save(Writer);
        return Writer;
    }
    friend bool LoadFromCompactBinary(const FCbFieldView& Field, FARFilter& Filter)
    {
        return Filter.TryLoad(Field);
    }
};
 
template<>
struct TStructOpsTypeTraits<FARFilter> : public TStructOpsTypeTraitsBase2<FARFilter>
{
    enum
    {
        WithPostSerialize = true,
    };
};
 
struct FARCompiledFilter
{
PRAGMA_DISABLE_DEPRECATION_WARNINGS // Compilers can complain about deprecated members in compiler generated code
    FARCompiledFilter() = default;
    FARCompiledFilter(FARCompiledFilter&&) = default;
    FARCompiledFilter(const FARCompiledFilter&) = default;
    FARCompiledFilter& operator=(FARCompiledFilter&&) = default;
    FARCompiledFilter& operator=(const FARCompiledFilter&) = default;
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    TSet<FName> PackageNames;
 
    TSet<FName> PackagePaths;
 
    UE_DEPRECATED(5.1, "Object path FNames have been deprecated, use FSoftObjectPath instead.")
    TSet<FName> ObjectPaths;
 
    TSet<FSoftObjectPath> SoftObjectPaths;
 
    UE_DEPRECATED(5.1, "Class names are now represented by path names. Please use ClassPaths.")
    TSet<FName> ClassNames;
 
    TSet<FTopLevelAssetPath> ClassPaths;
 
    TMultiMap<FName, TOptional<FString>> TagsAndValues;
 
    uint32 WithoutPackageFlags = 0;
 
    uint32 WithPackageFlags = 0;
 
    bool bIncludeOnlyOnDiskAssets = false;
 
    bool IsEmpty() const
    {
        return (PackageNames.Num() | PackagePaths.Num() | SoftObjectPaths.Num() | ClassPaths.Num() | TagsAndValues.Num() | WithoutPackageFlags | WithPackageFlags) == 0;
    }
 
    void Clear()
    {
        PackageNames.Empty();
        PackagePaths.Empty();
        SoftObjectPaths.Empty();
        ClassPaths.Empty();
        TagsAndValues.Empty();
 
        bIncludeOnlyOnDiskAssets = false;
        WithoutPackageFlags = 0;
        WithPackageFlags = 0;
 
        ensure(IsEmpty());
    }
};
 
namespace UE::AssetRegistry
{
    COREUOBJECT_API uint32 GetTypeHash(const FARFilter& Filter);
 
    COREUOBJECT_API FARFilter ConvertToNonCompiledFilter(const FARCompiledFilter& CompiledFilter);
}