MapKey.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "Misc/TVariant.h"
#include "Templates/UniquePtr.h"
#include "UObject/NameTypes.h"
#include "UObject/SoftObjectPath.h"
 
class UObject;
 
namespace UE::Editor::DataStorage
{
    class FMapKeyView;
 
    class FMapKey
    {
        friend class FMapKeyView;
        friend struct FKeyComparer;
        friend struct FKeyCopy;
        friend struct FKeyMove;
 
    public:
        FMapKey() = default;
        
        TYPEDELEMENTFRAMEWORK_API FMapKey(FMapKey&& Rhs);
        TYPEDELEMENTFRAMEWORK_API FMapKey& operator=(FMapKey&& Rhs);
        
        TYPEDELEMENTFRAMEWORK_API FMapKey(const FMapKey& Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(const void* Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(const UObject* Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(int64 Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(uint64 Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(float Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(double Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(FString Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(FName Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKey(FSoftObjectPath Key);
 
        TYPEDELEMENTFRAMEWORK_API FMapKey& operator=(const FMapKey& Rhs);
 
        TYPEDELEMENTFRAMEWORK_API bool operator==(const FMapKey& Rhs) const;
        TYPEDELEMENTFRAMEWORK_API bool operator==(const FMapKeyView& Rhs) const;
        TYPEDELEMENTFRAMEWORK_API bool operator!=(const FMapKey& Rhs) const;
        TYPEDELEMENTFRAMEWORK_API bool operator!=(const FMapKeyView& Rhs) const;
 
        TYPEDELEMENTFRAMEWORK_API uint64 CalculateHash() const;
        TYPEDELEMENTFRAMEWORK_API bool IsSet() const;
        TYPEDELEMENTFRAMEWORK_API void Clear();
        TYPEDELEMENTFRAMEWORK_API FString ToString() const;
 
    private:
        using KeyType = TVariant<FEmptyVariantState, const void*, const UObject*, int64, uint64, float, double, FString, FName, TUniquePtr<FSoftObjectPath>>;
 
        KeyType Key;
    };
 
    class FMapKeyView
    {
        friend struct FKeyToKeyViewConverter;
        friend struct FKeyViewComparer;
 
    public:
        FMapKeyView() = default;
        TYPEDELEMENTFRAMEWORK_API FMapKeyView(const FMapKey& InKey);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(const void* Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(const UObject* Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(int64 Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(uint64 Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(float Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(double Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(const FString& Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(FStringView Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(const FName& Key);
        TYPEDELEMENTFRAMEWORK_API explicit FMapKeyView(const FSoftObjectPath& Key);
 
        TYPEDELEMENTFRAMEWORK_API FMapKeyView& operator=(const FMapKey& InKey);
 
        TYPEDELEMENTFRAMEWORK_API FMapKey CreateKey() const;
 
        TYPEDELEMENTFRAMEWORK_API bool operator==(const FMapKey& Rhs) const;
        TYPEDELEMENTFRAMEWORK_API bool operator==(const FMapKeyView& Rhs) const;
        TYPEDELEMENTFRAMEWORK_API bool operator!=(const FMapKey& Rhs) const;
        TYPEDELEMENTFRAMEWORK_API bool operator!=(const FMapKeyView& Rhs) const;
 
        TYPEDELEMENTFRAMEWORK_API uint64 CalculateHash() const;
        TYPEDELEMENTFRAMEWORK_API FString ToString() const;
 
    private:
        using KeyViewType = TVariant<FEmptyVariantState, const void*, const UObject*, int64, uint64, float, double, FStringView, const FName*, const FSoftObjectPath*>;
 
        KeyViewType Key;
    };
}
// namespace UE::Editor::DataStorage