通过Niagara系统在虚幻5中生成向量场

本文系用户投稿，不代表机核网观点
前言
写这篇文章其实和一次失败的求职经历有关——尽管最后没有去，还是在家里把和公司技术人员聊下来的小项目给做了。部分原因是因为想找个东西练练手，部分原因也是想证明自己虚幻引擎的技术没有完全荒疏——自从拿到了相关的硕士学位以后，我就迫不及待地卸载了虚幻引擎，再也不想碰它。
这次前后花了几天时间实现了公司技术人员想要的效果。既然没有去上班，那也就把摸索的过程在这儿分享一下，不涉及任何商业机密。如果有人能从这篇文章中学到些什么，也算是积累一点小小的功德。
目标
如标题所言，这个小项目的最终目的是在虚幻引擎中利用其特效系统 Niagara 生成一个三维的、能够动态更新的向量场。实现的结果大概如下图所示：

具体的向量数据当然和业务有关，这里用到的示例只是随便用系统运行时间算出来的。
求索
之所以想到使用虚幻引擎做这个项目，是因为相关的技术人员在B站上找到了一个人魔改地图插件 Cesium 的一系列投稿。并且给我分享了一份相关的项目代码。
看了一下作者的实现是实现了一个 Niagara DataInterface 类。相关的文档可以在这里找到。这里就不得不提我讨厌虚幻引擎的第一个原因：极为糟糕的文档系统。如果浏览了这个网站，就会发现它基本什么也没有写，只是有一个示例项目在虚幻引擎的文件夹里。
自然，下一步就是看看这个示例项目是怎么做的：
virtual bool GetFunctionHLSL(const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo, int FunctionInstanceIndex, FString& OutHLSL) override;
virtual void GetParameterDefinitionHLSL(const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, FString& OutHLSL) override;
#endif
virtual void BuildShaderParameters(FNiagaraShaderParametersBuilder& ShaderParametersBuilder) const override;
virtual void SetShaderParameters(const FNiagaraDataInterfaceSetShaderParametersContext& Context) const override;

virtual bool InitPerInstanceData(void* PerInstanceData, FNiagaraSystemInstance* SystemInstance) override;
virtual void DestroyPerInstanceData(void* PerInstanceData, FNiagaraSystemInstance* SystemInstance) override;
virtual int32 PerInstanceDataSize() const override;
virtual bool HasPreSimulateTick() const override { return true; }
virtual bool PerInstanceTick(void* PerInstanceData, FNiagaraSystemInstance* SystemInstance, float DeltaSeconds) override;
virtual void ProvidePerInstanceDataForRenderThread(void* DataForRenderThread, void* PerInstanceData, const FNiagaraSystemInstanceID& SystemInstance) override;
这里节选了它的头文件里的部分定义。可以看到重载了多个函数。但是这个工作量还是挺恐怖的。依靠知乎上的一篇文章，能够知道大概是需要重载几个函数来定义粒子生成的函数。具体需要重载的函数大概长这样：
void UNiagaraDataInterfaceMousePosition::GetFunctionsInternal(TArray<FNiagaraFunctionSignature>& OutFunctions) const
{
	FNiagaraFunctionSignature Sig;
	Sig.Name = GetMousePositionName;
	Sig.Description = LOCTEXT("GetMousePositionNameFunctionDescription", "Returns the mouse position in screen space.");
	Sig.bMemberFunction = true;
	Sig.AddInput(FNiagaraVariable(FNiagaraTypeDefinition(GetClass()), TEXT("MousePosition interface")));
	Sig.AddInput(FNiagaraVariable(FNiagaraTypeDefinition::GetBoolDef(), TEXT("Normalized")));
	Sig.AddOutput(FNiagaraVariable(FNiagaraTypeDefinition::GetFloatDef(), TEXT("PosX")), LOCTEXT("MousePosXDescription", "Returns the x coordinates in pixels or 0-1 range if normalized"));
	Sig.AddOutput(FNiagaraVariable(FNiagaraTypeDefinition::GetFloatDef(), TEXT("PosY")), LOCTEXT("MousePosYDescription", "Returns the y coordinates in pixels or 0-1 range if normalized"));
	OutFunctions.Add(Sig);
}
这里似乎定义了一个用于 Niagara 系统的函数。定义了它的参数类型和输出类型。
——我大概是在看到这里时失去耐心的。整个函数没有一个明白的定义，没有注释，且 IDE 提供的自动补全工具很有限，如果我想定义一个不同的参数类型，那我估计还得先找到 FNiagaraTypeDefinition 的定义再去一个个找合适的类型。总而言之，工程量太大，而且摸黑工作，感觉完全不实际。
转折
在搜寻解决方案的过程中，偶然找到一篇外国人写的博客文章。开头就写得很符合我的心境：
Niagara Data Interfaces: These sound perfect, except that the docs only tell you how to define them, not how to actually hook them up to a Niagara system. As it turns out, you don’t need to use these directly at all, but you can spend a long time crawling down the APIs without knowing that, squinting in the dark looking for a crack of daylight that tells you how to link these things together.
（段落大意：没必要去研究这个 Data Interfaces。）
作者给出的解决方案其实相对简单，首先在 Niagara 系统中的 User Interface 定义一个数组，然后往里面填数据就行。当然了，既然是虚幻引擎，必然需要把操作复杂化。例如，根据一个数组来初始位置数据的设置是这样的（顺带一提，这里引擎的语言设置为中文）：

根据这个教程很快完成了粒子位置和方向的设置。再通过引擎自带的资产找到了一个3D箭头的静态网格体 S_Arrow，在修改了它的贴图之后能够正常切换颜色。
加载数据
完成了 Niagara 系统的设置以后还需要处理加载数据的问题。这里终于用到了当年上课学到的基本功。先创建一个 C++ 类，再根据它创造一个对应的蓝图类来读取数据。
UFUNCTION(BlueprintCallable, Category = "Weather")
bool loadData(TArray<FVector> &data);

UFUNCTION(BlueprintCallable, Category = "Weather")
bool initGridData(int x, int y, int z, float magnification, TArray<FVector> &data);
具体实现略，生成粒子坐标三层嵌套完事，大概十行代码。每个粒子的方向和具体业务相关，这里写的示例随便选了一个值。
然后创建对应的蓝图类。这里创建蓝图类主要是考虑到实在不想和 Niagara 的 C++ 库斗智斗勇（文档太差）。还好对应的蓝图函数写得还是挺清楚的：

这里用了 Niagara Set XXX 函数把蓝图中的变量赋给 Niagara 系统中的对应变量。
完成了定义以后把整个函数连接到蓝图的 Event Begin，在启动系统的时候加载数据。
更新系统
刚才这套实现里面没有实现数值的更新。更新数据同样用到蓝图系统。这一次是定义函数连接到 Event Tick，在每一帧的时候更新。
如果是实际业务应该在之前的 C++ 类实现正确的更新逻辑。甚至可能牵涉到异步的数据更新。这里作为示例就简单做一个随系统启动时间运动的参数方程。当然还需要再次将数据加载到 Niagara 系统中。这里每一帧加载一次的操作肯定是对性能有影响的，但是偷懒就不优化了。优化应该也不会特别困难，一次性加载多个数据到 Niagara 系统再每一帧根据 tick 计算对应的序数就行。

总结
到此完成了在 Niagara 系统中显示向量场的操作。前后在电脑前坐了大概20小时，最后大概写了50行代码，平均一小时2.5行。这也是我讨厌虚幻引擎，或者扩大来说，任何游戏引擎的原因。绝大多数的时候作为“开发者”不是在进行任何形式的智力活动，而是在和工具斗智斗勇。（尽管可以说是因为我没能啃下相关的没注释的 C++ 代码，但是我实在不觉得读三百行没注释的代码和三千行同样缺乏注释的相关定义是一般人做得到的。）虚幻引擎确实是很强大的工具，然而其极高的复杂度和相当不友好的文档让相关的工作十分痛苦。在刚毕业那会儿，我曾经想写一篇文章《游戏引擎是一种技术债务》。最后自觉才疏学浅没有动笔，但我的看法确实差不多是这样。