版权声明：本文为CSDN博主「YakSue」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。

原文链接：blog.csdn.net/u013412391/…

使用 UE4 的 TMap

TMap 是 UE4 中一个基础的容器类（在一些其他的场合也叫作 “Dictionary” ），表明了【键】-【值】一一对应的关系。

比如，我想统计一个场景中每个 Actor 出现的次数，就可以创建一个 Map 来存储信息：

TMap<AActor*, int> testMap;

尝试在 UE4 中使用自定义的结构体作为【键】，编译失败

我自定义的结构体如下：

struct TestStruct
{
	UObject* ObjA;
	UObject* ObjB;
	UObject* ObjC;
};

尝试作为【键】：

TMap<TestStruct, int> testMap;

这样会有报错：

error C2338: TMap must have a hashable KeyType unless a custom key func is provided.

提示需要一个“可哈希”的【键】类型，或者提供自定义的函数。

讨论一个类型作为 Map 的【键】的条件

抛开 UE4，单纯讨论作为一个 “Map”（或者说 Dictionary ），它的【键】的类型有什么条件？

必备：可比较（知道是否是一样的键）

作为【键】的类型，必须是可比较的。这意味，当处理一条“键-值”数据时，必须能知道这条信息中的【键】和现有数据是什么关系，是一个新的【键】吗？还是一个已存在的【键】？如果不能比较，便无法判断了。

加速：可哈希

当数据的条目变得越来越多时，用“逐个比较”的方式来查找一个【键】是否是已存的【键】会变得越来越慢。此时，如果【键】可以哈希为一个序号，则会让查找的操作变得很快。哈希的原理不必多讲。简单来说：它的内部算法完全没必要研究，只需要知道它的目的就是为了能对相同的输入会输出相同的序号，对不同的输入会输出不同的序号。

观察 UE4 源代码中的使用

我尝试观察 UE4 的源代码，企图找到一些范例。我找到了 \Engine\Source\Runtime\AssetRegistry\Public\AssetData.h 中的 FAssetIdentifier：

/** A structure defining a thing that can be reference by something else in the asset registry. Represents either a package of a primary asset id */
struct FAssetIdentifier
{
	/** The name of the package that is depended on, this is always set unless PrimaryAssetType is */
	FName PackageName;
	/** The primary asset type, if valid the ObjectName is the PrimaryAssetName */
	FPrimaryAssetType PrimaryAssetType;
	/** Specific object within a package. If empty, assumed to be the default asset */
	FName ObjectName;
	/** Name of specific value being referenced, if ObjectName specifies a type such as a UStruct */
	FName ValueName;

对它不必有太深理解，此时只需要知道它在 \Engine\Source\Runtime\AssetRegistry\Public\AssetRegistryState.h 的 FAssetRegistryState 中有被作为一个 TMap 的【键】类型：

/** A map of object names to dependency data */
TMap<FAssetIdentifier, FDependsNode*> CachedDependsNodes;

这说明它是一个合法的【键】类型。观察发现，它重载了 == 来与其他进行比较，并且实现了哈希的计算方式：

friend inline bool operator==(const FAssetIdentifier& A, const FAssetIdentifier& B)
{
	return A.PackageName == B.PackageName && A.ObjectName == B.ObjectName && A.ValueName == B.ValueName;
}

friend inline uint32 GetTypeHash(const FAssetIdentifier& Key)
{
	uint32 Hash = 0;

	// Most of the time only packagename is set
	if (Key.ObjectName.IsNone() && Key.ValueName.IsNone())
	{
		return GetTypeHash(Key.PackageName);
	}

	Hash = HashCombine(Hash, GetTypeHash(Key.PackageName));
	Hash = HashCombine(Hash, GetTypeHash(Key.PrimaryAssetType));
	Hash = HashCombine(Hash, GetTypeHash(Key.ObjectName));
	Hash = HashCombine(Hash, GetTypeHash(Key.ValueName));
	return Hash;
}

可以看到，它比较的方式说白了就是比较所有成员是否相同。而哈希的计算方式就是获得所有成员的哈希，然后使用 HashCombine 进行结合。

也就是说，只要一个类型的成员都是可哈希的，那么就可以学者类似上面的方法。

在 UE4 中使用自定义的结构体作为【键】类似上面的方法，对我自定义的结构体定义 operator== 和 GetTypeHash：

struct TestStruct
{
	UObject* ObjA;
	UObject* ObjB;
	UObject* ObjC;
	friend inline bool operator==(const TestStruct& A, const TestStruct& B)
	{
		return A.ObjA == B.ObjA && A.ObjB == B.ObjB && A.ObjC == B.ObjC;
	}

	friend inline uint32 GetTypeHash(const TestStruct& Key)
	{
		uint32 Hash = 0;

		Hash = HashCombine(Hash, GetTypeHash(Key.ObjA));
		Hash = HashCombine(Hash, GetTypeHash(Key.ObjB));
		Hash = HashCombine(Hash, GetTypeHash(Key.ObjC));
		return Hash;
	}
};

这样 TMap 便可以使用

TMap<TestStruct, int> testMap;

其他延伸

值得留意的是，在开始使用时，我得到了 TMap must have a hashable KeyType unless a custom key func is provided 这样的信息，这是一个很具提示性的信息。而达成这种提示用了 C++ 一些很复杂的关于 “模板” 的语法来检查一个类是否有 GetTypeHash 函数。这个语法未来可以研究一下。

【转载】（UE4 C++）使用自定义的结构体做 TMap 中的 Key