PCG 高级篇运用案例

蓝图自定义节点

蓝图节点可以用于处理PCG Graph中不方便操作的数据。

主要分为3个步骤：获取数据，处理数据，输出数据。

节点的输入输出的数据包装类型都是TaggedData，带标签的数据，数据可能有多种类型，可能是点类型，参数类型，设置类型等，所以需要判断到底是哪种类型。

默认输入输出的Pin 分别是 In 和 Out，但可以定义更多的Pin，所以需要用Pin的Label来获取特定的数据。

Pin、Label、Tags 在中文里都容易翻译为标签，所以很容易造成混淆。

Pin的和Tags 不是同个东西，Pin是键，Data是值，而Tags则是可选的标签。

Pin 和 Data 也不是一一对应的关系，因为节点里，一个pin可以连入多份数据，所以各种GetXX,GetInputsByXX的接口返回的都是TaggedData的数组。

cpp

// 创建TaggedData
FPCGTaggedData TaggedData;
TaggedData.Data = Data;
TaggedData.Tags = Tags;
TaggedData.Pin = Pin;

这些TaggedData 最终会被打包放进去FPCGDataCollection里面，交给蓝图节点处理。

一下Pin有默认值：

cpp

namespace PCGPinConstants
{
	const FName DefaultInputLabel = TEXT("In");
	const FName DefaultOutputLabel = TEXT("Out");
	const FName DefaultParamsLabel = TEXT("Overrides");
	//省略后续
}

获取数据

实现execute函数，获取输入数据 alt text

如果只有一个输入Pin,直接调用

输入的Input 是一个FPCGDataCollection类型，提供了一系列的接口来获取输入数据，这些方法本质都是过滤出想要的TaggedData：

FPCGDataCollection接口

cpp

/** Returns all spatial data in the collection */
	UE_DEPRECATED(5.6, "Use GetAllSpatialInputs for only spatial inputs, or use GetAllInputs.")
	UE_API TArray<FPCGTaggedData> GetInputs() const;

	/** Returns all spatial data in the collection. */
	UE_API TArray<FPCGTaggedData> GetAllSpatialInputs() const;

	/** Returns all inputs in the collection. */
	const TArray<FPCGTaggedData>& GetAllInputs() const { return TaggedData; }

	/** Returns all data on a given pin. */
	UE_API TArray<FPCGTaggedData> GetInputsByPin(const FName& InPinLabel) const;
	/** Returns all spatial data on a given pin */
	UE_API TArray<FPCGTaggedData> GetSpatialInputsByPin(const FName& InPinLabel) const;

 // 具体实现

TArray<FPCGTaggedData> FPCGDataCollection::GetTaggedInputs(const FString& InTag) const
{
	return GetTaggedTypedInputs<UPCGSpatialData>(InTag);
}

TArray<FPCGTaggedData> FPCGDataCollection::GetAllSettings() const
{
	return TaggedData.FilterByPredicate([](const FPCGTaggedData& Data) {
		return Cast<UPCGSettings>(Data.Data) != nullptr;
		});
}

TArray<FPCGTaggedData> FPCGDataCollection::GetAllParams() const
{
	return TaggedData.FilterByPredicate([](const FPCGTaggedData& Data) {
		return Cast<UPCGParamData>(Data.Data) != nullptr;
	});
}

TArray<FPCGTaggedData> FPCGDataCollection::GetParamsByPin(const FName& InPinLabel) const
{
	return TaggedData.FilterByPredicate([&InPinLabel](const FPCGTaggedData& Data) {
		return Data.Pin == InPinLabel && Cast<UPCGParamData>(Data.Data);
		});
}

TArray<FPCGTaggedData> FPCGDataCollection::GetTaggedParams(const FString& InTag) const
{
	return TaggedData.FilterByPredicate([&InTag](const FPCGTaggedData& Data) {
		return Data.Tags.Contains(InTag) && Cast<UPCGParamData>(Data.Data) != nullptr;
		});
}

骚操作：把输入的数据合并到一起（没什么意义，方便理解）： alt text 于是结果里面既有Point Data，又有Attribute Data

处理数据

如果是简单的运算，在Execute函数中，直接计算然后调用MakePCGDataCollection输出即可。需要注意，最好不能把输入的数据直接输出，而是要重新创建TaggedData一份，否则会破坏上游节点的输出数据。

给数据增加属性`Metadata`

在调试面版看到的一行行数据：

每一行就是一个Entry

如果是Point Data，每个Point都持有一个MetadataEntryKey

cpp

UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category = "Properties|Metadata")
int64 MetadataEntry = -1;

所以，对于非Point Data，需要构造 MutableMetadata, 持有Metadata, 调用 AddEntry 并持有 Entry的Key alt text

下图展示填充原本的输入数据的属性，再用上一步的EntryKey 进行默认赋值，这里是AddAttributes相当于创建表头（方法注释：Creates missing attribute from another metadata），SetAttributes就是拷贝默认值。 alt text

下图展示使用EntryKey创建具体的属性类型的例子，更好懂也很常用，Create是创建表头，Set才是赋值： alt text

对于具体的某一个Point Data，因为FPCGPoint已经持有了EntryKey，所以直接CreateXXAttribute创建表头 alt text

再使用Point作为参数的的方法，进行赋值即可： alt text

循环处理点数据

普通数据使用蓝图的For Each节点问题不大，但点数据通常非常多，PCG提供了特殊的并发循环节点，它们被设计为在后台线程中并行执行 (multi-threaded / 并行化)，以极高的效率处理大量数据。 alt text

一个最简单的例子，给全部点设置一个统一的颜色，并全部保留： alt text

下图展示启动一个PointLoop的例子，该函数立即返回Data引用，但并发完成后Data里面才会有数据： alt text

下图展示启动一个IterationLoop的例子： alt text

通常只需要用到PointLoopBody即可；其他都是补充用法。

函数 (Function)	核心思想	输入 -> 输出	类比	补充说明
`PointLoopBody`	变换 / 过滤	1 : 1 (或 1 : 0)	`map` + `filter`	用点数据来驱动，1:1是一份对一份的意思，如果存在filter，依旧当作一份。
`VariableLoopBody`	扩展 / 生成	1 : N	`flatMap` / `SelectMany`	例如对于输入的每棵树生成随机数量的果实，N在每个并发里可以不同
`NestedLoopBody`	组合 / 关系	(M x N) : 1 (或 0)	双层 `for` 循环	排列组合，笛卡尔积
`IterationLoopBody`	创造 / 迭代	0 : N	单个 `for (i=0; i<N; i++)`	用指定的数量驱动

需要注意的是，这些循环都是多线程/并发的，无法进行类似Reduce的累积、求平均操作，这些依旧要使用蓝图的For Each节点。

输出数据

输出到多个Pin： alt text

最终输出的Collection: alt text

综合案例

参数计算案例：自定义节点计算两个向量的Cross Product，并输出结果。

定义Pin

由于是都是参数类型，所以Pin的类型是UPCGParamData，蓝图这里显示了它的用于阅读的名字PCG Attribute Set，其实是别名。 alt text

取出参数类型

根据索引获取输入的参数
参数的默认EntryKey 用0即可，用它取出向量A和B（这个其实不需要用MutableMetadata，用ConstMetadata更加合适）

构建输出

创建PCGParamData,这里搜索PCGParamData是可以出现它的别名PCG Attribute Set的
作为Data输入构建出PCGTaggedData，并打包到PCGDataCollection作为最终输出

完成业务逻辑

计算Cross Product

PCG 案例

记录一些PCG的细节使用

闭合样条线判断内角外角

闭合的直线样条线，形成的凸包有时需要判断拐角使用内角还是外角，因为拐角模型也是存在“手性”的，内外需要区别判断或者使用不同模型。这个问题可以转换为，样条线的下一个点是左拐还是右拐。左右问题，可以使用Cross Product来判断。 alt text

PCG Spawn Mesh 时假装指定Pivot点

PCG Spawn Mesh的时，Mesh的的pivot点是会和PCG的Position重合。但Mesh的Pivot多种多样，有的在中心，有的在边界，有的在角落，总之乱七八糟的，重新修改Mesh又费时费力，所以应该想办法在直接在PCG中调整。

那么，只要知道Mesh的Bound 和它当前的Pivot，只要能根据目标位置，计算出一个偏移量，就能假装调整了Mesh 的Pivot

前提节点`BoundsFromMesh`

该节点可以获取到Mesh的包围盒信息，包括最小值、最大值、中心点等。有了它就能计算出Pivot点的偏移量。

Pivot 原理

默认情况下，Mesh 最原始的 Pivot点就是（0，0，0）,此时 pivot点就是包围盒的中心。假设这就是我们需要的理想状态（Pivot在BoundsBox中心）。

L o c a l C e n t e r = \vec{P i v o t} = (0, 0, 0) = (B o u n d s M a x + B o u n d s M i n) / 2

乱七八糟的Pivot点，是通过偏移量来实现的：

N e w L o c a l C e n t e r = O f f s e t + P i v o t (0, 0, 0) = P i v o t O f f s e t

所以，PCG的LocalCenter属性如果非0，就说明是被动过手脚的Pivot。

知道了原理，就可以通过减去PivotOffset来让Pivot点回到Bounds的中心，回到理想状态。

最后，因为这个偏移量是个本地向量，而PCG点的Position都是世界坐标，且都有自己的Transform属性，所以得对PivotOffset进行Transform.TransformDirection来应用方向转换。（PivotOffset是一个相对量，只需要方向变换，不需要位置变换）

任意位置的Pivot居中调整

使用$LocalCenter记录Mesh的几何中心，如果是0代表没有任何偏移，如果是其他值，说明是乱七八糟的Pivot点
由于偏移量是个本地向量，而PCG点的位置是世界位置，还不能直接减去PivotOffset，先使用Transform.TransformDirection来换算

任意位置的Pivot，调整到X方向最边界，Y方向居中

默认情况下，Mesh的Pivot点在包围盒中心，即LocalCenter = (0,0,0)。

如果我们想要将Pivot调整到X方向的最边界（可以是最左或最右），Y方向居中，Z方向保持原样，需要计算从当前Pivot位置到目标位置的偏移量。既：

目 标 向 量 = ((X m i n - X m a x) / 2, 0, 0) = 已 有 偏 移 量 (L o c a l C e n t e r) + 调 整 向 量

包围盒中心到X最左边界的向量是：

目标向量 = 左边界向量 = (Xmin - (Xmax+Xmin)/2, 0, 0) = ((Xmin - Xmax)/2, 0, 0) = -$Extents.X

如果Pivot已有偏移(LocalCenter)，我们需要计算额外的调整向量：
```
调整向量 = 目标向量 - LocalCenter
```
1
2
其中，目标向量可以是左边界向量或右边界向量，取决于我们想要将Pivot调整到哪一侧。最终，这个调整向量是本地坐标系下的，需要使用Transform.TransformDirection转换到世界坐标系，然后+到PCG点的Position。

PCG自适应铺地板

alt text 地板宽度通常是固定，所以对应输入的样条线区域，还需进行调整，有以下步骤：

获取全部楼层(poly line 类型), 传入子图，在子图执行全部逻辑

alt text

使用 `Filter data by index` 筛选出需要地板的楼层

alt text

把点映射到世界零点，方便后续计算：

alt text

创建一个原点
每个点减去原点，就映射回世界零点。
对每个点使用 abs 取绝对值，全部射到第一象限。

根据长度，计算地板数量

alt text

假如地板宽度为500，那么这里的分段可以取500的倍数，这里写1000就是每段至少2个地板
除出来后，如果2.3个地板，必须向上取整变成3，才能符合“容纳”的要求。
还原回原点。
最后一个add 把结果写入Postion，最终更新了整个样条线的大小，让其符合地板宽度的要求。

输出地板数据

alt text

创建新的，大小已经合适的Spline ，选择在内部模式且无边际必须打勾
采样距离设置为500（会报错但不影响使用，不必理会，应该是bug）

PCG 自动样条线Mesh

alt text 主要都是 Attract节点的用法， Attract的主要功能的搜索和关联

用2个Attract 配合，创建起点和终点

alt text

让球面点，搜索半径1200范围内，可以关联的点，模式为最近点
能搜索到的“关联点”的球面点，会被attract节点输出，对于关联点来说，形成了1对多的关系
把第一个 Attract节点的权重设置为0，输出的就是源点的位置（图里就是球面点）
把第二个 Attract节点的权重设置为1，输出的就是关联点的位置（图里关联点是天花板或者地面的灯柱）
第二个 Attract节点的的搜索模式，改成from index模式来获取即可，不用搜索，加快速度

计算指向终点的向量

alt text

这里的离开方向没用上，可以忽略

分别计算终点和起点对应的俯仰角度

alt text

如果某些关联点存在放大，就用reduce节点来获取放大值最大的值，作为基准。越大的点，偏转角度越大，体现“电线”越重。
因此，这里的Angle 是一个比例值，在和和定义的最大角度80相乘，让每条线都有自己的偏转角度

连接起点和终点，生成样条线Mesh

alt text

先根据关联点归组，关联点是1对多的关系，归组后，每一列输出的就是拥有共同关联点的的球面点。
由于之前合并过起点和终点，所以此时的数据，index相同的已经两两成对。（到了这里会发现其实第一步不需要也可以）
因此，再次根据index归组，归组后面跟着另一个归组，这是一个类似flatmap的操作，把每一列的产生两两成对都输出到主序列。
最后使用Spawn Spline Mesh节点生成样条线Mesh

flatmap

kotlin

val list = listOf("123", "45")
println(list.flatMap { it.toList() }) // [1, 2, 3, 4, 5]

PCG 填坑记录

结构体崩溃：如果涉及自定义结构体的修改，最好打开一张空白的地图，没有加载任何东西的时候去修改结构体才是安全的，且要分步骤进行。但最稳妥的办法还是先进行版本控制，比如commit一次临时的版本快照，等改好了再amend 一次即可。否则，可能面临编辑器崩溃，已有的默认值全部丢失。这是非常严重的事情，并且我估计这种bug是无法修复的。

具体步骤

进行一次版本控制，commit一次临时的版本快照
打开一张空白的地图，没有加载任何东西的时候去修改结构体，避免引用缓存对象未释放，否则一改就崩
新增变量一定要放在结构体的最后，不能放在中间，否则内存布局会改变，导致已有的默认值全部丢失
原理：
- 假设旧结构体是 MyStruct { float A; bool B; }。它在内存和文件中的布局可能是 [4字节的A] [1字节的B]。
- 如果在中间插入一个int C，新结构体变成 MyStruct { float A; int C; bool B; }，布局变为 [4字节的A] [4字节的C] [1字节的B]。
- 当UE尝试用新的布局去读取旧的数据 [4字节的A] [1字节的B] 时，它会把原本属于 B 的1字节数据（以及后面的垃圾数据）错误地解析成 C 的值，而 B 的值则会从更后面的内存去读取，导致数据彻底错乱。这就是默认值全部丢失的根本原因。
- 追加到末尾: 如果将 int C 加到末尾，新结构体为 MyStruct { float A; bool B; int C; }。当UE读取旧数据时，它能正确地把 [4字节的A] 赋给 A，[1字节的B] 赋给 B。由于旧数据里没有 C 的信息，UE会为 C 赋予其类型的默认值（对int来说就是0）。这个过程是**向后兼容（backward-compatible）**的。
新增好了，把涉及到的蓝图全部手动编译保存。可选：使用UCompileAllBlueprintsCommandlet工具编译全部蓝图（比较耗时）
往上上面步骤后，检查没有任何错误或者数据丢失，有丢失就关闭UE，git 重置到commit的版本。没有问题就可以进行结构体的顺序调整了,此时内存布局大小不变，可以安全的进行顺序调整，不会触发崩溃。再次重新编译保存即可。
原理：此时，结构体的总大小（sizeof）已经稳定。在这个基础上再去调整成员顺序，UE的**属性重定向（Property Redirection）**机制有更高的成功率来正确匹配新旧顺序的变量，因为它是在内存大小已经匹配的情况下进行“内部挪动”。
最后功能完成，amend 说明改动即可。

不生成，缓存错误，可以试试按住 Ctrl + 再点击重新生成。

alt text

尽量使用PCG Stamp, 而不是PCG 原始 Actor，否则可能存在潜在的崩溃问题。

alt text

PCG (编辑器时)回调内存泄露

官方的PCG回调，比如OnGenerated, 通过编辑器详情页面创建一个Event，是有问题的。会导致内存泄露，每次编译一次，都会创建一个新的Event，导致回调次数递增。

一种解决方案是：手动绑定Event，而不是通过编辑器详情页面创建。

PCG 样条线采样器的一些说明

alt text

NextDirectionDelta：是用当前点，来记录它的下一个点的方向变化增量，对比的轴是UpVector, 增量是用本地坐标系来对比（），增量被归一化为-1到1

-1表示 ForwardVector绕UpVector向右旋转90度（顺时针）

0表示 ForwardVector 和下一个点方向一致

1表示 ForwardVector绕UpVector向左旋转90度（逆时针）

（没看源码，NextDirectionDelta 极有可能是通过计算下一个点的前进向量 (NextForwardVector) 与当前点的左侧向量之间的点乘得到的）

最后一个点没有下一个点，所以NextDirectionDelta为0

Runtime PCG

大多数情况下，只需要在编辑器模式下使用PCG来构建数据，运行时使用这些构建好的数据即可。但需要和游戏环境互动的，就需要Runtime PCG了。

比如走到哪就生成到哪，需要根据玩家位置来生成数据，或者根据场景内其他动态数据来生成数据。

但运行时PCG其实BUG很多，毕竟感觉使用的人很少，很多问题要使用后才能发现，选择运行时PCG需要谨慎。

一些运行时PCG遇到的问题记录

1. 部分LevelStream 关卡重新加载，需要刷新PCG缓存，否则生成的数据会出错

alt text

2. 运行时PCG和编辑器PCG 存在不同逻辑，如运行时int32类型其实是按float类型处理的，导致精度问题。

alt text

编辑器时，显示的数据，全是int32类型： alt text

运行时，显示的数据，全是float类型，导致运行时生成结果和编辑器存在严重偏差： alt text

最终附加一个round节点，可以解决这个问题： alt text

PCG 5.6 之前创建 spline 数据丢失的问题

5.5 bug 重现如下：

创建多组数据（多张表），查看Symbol，Size 数据添加正常
从点里面创建spline，刚刚添加的自定义数据全部丢失

5.6 正常：自定义数据没有丢失，也无需复制 alt text

但下一步 Sline line to Segments，自定义数据会丢失, 使用 copy all domain 可以解决 alt text

PCG 高级篇 运用案例 ​

蓝图自定义节点 ​

获取数据 ​

处理数据 ​

给数据增加属性Metadata ​

循环处理点数据 ​

输出数据 ​

综合案例 ​

定义Pin ​

取出参数类型 ​

构建输出 ​

完成业务逻辑 ​

PCG 案例 ​

闭合样条线判断内角外角 ​

PCG Spawn Mesh 时假装指定Pivot点 ​

前提节点BoundsFromMesh ​

Pivot 原理 ​

任意位置的Pivot居中调整 ​

任意位置的Pivot，调整到X方向最边界，Y方向居中 ​

PCG自适应铺地板 ​

获取全部楼层(poly line 类型), 传入子图，在子图执行全部逻辑 ​

使用 Filter data by index 筛选出需要地板的楼层 ​

把点映射到世界零点，方便后续计算： ​

根据长度，计算地板数量 ​

输出地板数据 ​

PCG 自动样条线Mesh ​

用2个Attract 配合，创建起点和终点 ​

计算指向终点的向量 ​

分别计算终点和起点对应的俯仰角度 ​

连接起点和终点，生成样条线Mesh ​

PCG 填坑记录 ​

不生成，缓存错误，可以试试按住 Ctrl + 再点击 重新生成。 ​

尽量使用PCG Stamp, 而不是PCG 原始 Actor，否则可能存在潜在的崩溃问题。 ​

PCG (编辑器时)回调内存泄露 ​

PCG 样条线采样器的一些说明 ​

Runtime PCG ​

一些运行时PCG遇到的问题记录 ​

1. 部分LevelStream 关卡重新加载，需要刷新PCG缓存，否则生成的数据会出错 ​

2. 运行时PCG和编辑器PCG 存在不同逻辑，如运行时int32类型其实是按float类型处理的，导致精度问题。 ​

PCG 5.6 之前创建 spline 数据丢失的问题 ​

PCG 高级篇运用案例

蓝图自定义节点

获取数据

处理数据

给数据增加属性`Metadata`

循环处理点数据

输出数据

综合案例

定义Pin

取出参数类型

构建输出

完成业务逻辑

PCG 案例

闭合样条线判断内角外角

PCG Spawn Mesh 时假装指定Pivot点

前提节点`BoundsFromMesh`

Pivot 原理

任意位置的Pivot居中调整

任意位置的Pivot，调整到X方向最边界，Y方向居中

PCG自适应铺地板

获取全部楼层(poly line 类型), 传入子图，在子图执行全部逻辑

使用 `Filter data by index` 筛选出需要地板的楼层

把点映射到世界零点，方便后续计算：

根据长度，计算地板数量

输出地板数据

PCG 自动样条线Mesh

用2个Attract 配合，创建起点和终点

计算指向终点的向量

分别计算终点和起点对应的俯仰角度

连接起点和终点，生成样条线Mesh

PCG 填坑记录

不生成，缓存错误，可以试试按住 Ctrl + 再点击重新生成。

尽量使用PCG Stamp, 而不是PCG 原始 Actor，否则可能存在潜在的崩溃问题。

PCG (编辑器时)回调内存泄露

PCG 样条线采样器的一些说明

Runtime PCG

一些运行时PCG遇到的问题记录

1. 部分LevelStream 关卡重新加载，需要刷新PCG缓存，否则生成的数据会出错

2. 运行时PCG和编辑器PCG 存在不同逻辑，如运行时int32类型其实是按float类型处理的，导致精度问题。

PCG 5.6 之前创建 spline 数据丢失的问题