UE4 中的 Edit Layer 原理

发表于

在 ue4 中，地形 paint 的时候可以选择 material 上设置好的 layer，如下所示：

按照文档可以对 landscape 开启 Edit Layer

Landscape Edit Layers | Unreal Engine Documentation

开启后，在对地形 paint 的时候，可以先选择使用的 target layer，同时还可以指定当前 brush 使用哪一个 Edit Layer

当我们将 Edit Layer 设置为 visible 或者 hide 的时候，其所使用的 brush 的内容也会被取消掉。

在代码中，Edit Layer 对应的类是

1
2
3
4
5
6
struct FLandscapeLayer
{
    ...
    TArray<FLandscapeLayerBrush> Brushes;    
    ...
}

编辑时 brush 信息储存在 Brushes 变量中。

class ALandscape 类中有一个 FLandscapeLayer 数组，就是为了保存 Edit Layer 刷子信息的。

1
2
3
4
5
6
class ALandscape : public ALandscapeProxy
{
...
    TArray<FLandscapeLayer> LandscapeLayers;
...
}

当我们修改了 Edit Layer 的属性后，比如 set visible 或者刷了新的数据，会触发

1
int32 ALandscape::RegenerateLayersWeightmaps(...)

在这个函数中，会用 Computer Shader 将 brush 中的数据拷贝到实际的 Target Layer 的数据中。

1
2
3
4
5
6
7
8
9
PrepareComponentDataToExtractMaterialLayersCS(
    InLandscapeComponentsToRender, 
    Layer, 
    CurrentWeightmapToProcessIndex, 
    LandscapeExtent.Min, 
    OutputDebugName, 
    WeightmapScratchExtractLayerTextureResource, 
    ComponentsData, 
    LayerInfoObjects);

从 Edit Layer 中读取数据的地方就在这个函数的这里：

1
2
3
4
5
6
7
8
for (ULandscapeComponent* Component : InLandscapeComponents)
{
    FLandscapeLayerComponentData* ComponentLayerData = Component->GetLayerData(InLayer.Guid);
    if (ComponentLayerData != nullptr)
    {
        if (ComponentLayerData->WeightmapData.Textures.IsValidIndex(InCurrentWeightmapToProcessIndex) && ComponentLayerData->WeightmapData.TextureUsages.IsValidIndex(InCurrentWeightmapToProcessIndex))
        {
            UTexture2D* LayerWeightmap = ComponentLayerData->WeightmapData.Textures[InCurrentWeightmapToProcessIndex];

LayerWeightmap 就是在 Edit Layer 中刷的数据。

再来看一下刷地形的时候，数据是怎么被写入到 Edit Layer 中的。

下面是使用地形刷子的时候的调用堆栈：

1
2
3
4
5
6
7
8
9
10
11
FLandscapeBrushCircle::ApplyBrush(const TArray<FLandscapeToolInteractorPosition,TSizedDefaultAllocator<32>> & InInteractorPositions) 行 250	C++
FLandscapeToolStrokeSculpt::Apply(FEditorViewportClient * ViewportClient, FLandscapeBrush * Brush, const ULandscapeEditorObject * UISettings, const TArray<FLandscapeToolInteractorPosition,TSizedDefaultAllocator<32>> & InteractorPositions) 行 399	C++
FLandscapeToolBase<FLandscapeToolStrokeSculpt>::BeginTool(FEditorViewportClient * ViewportClient, const FLandscapeToolTarget & InTarget, const FVector & InHitLocation) 行 1411	C++
FEdModeLandscape::InputKey(FEditorViewportClient * ViewportClient, FViewport * Viewport, FKey Key, EInputEvent Event) 行 1893	C++
ULegacyEdModeWrapper::InputKey(FEditorViewportClient * ViewportClient, FViewport * Viewport, FKey Key, EInputEvent Event) 行 194	C++
FEditorModeTools::InputKey(FEditorViewportClient * InViewportClient, FViewport * Viewport, FKey Key, EInputEvent Event) 行 1344	C++
FEditorViewportClient::InputKey(FViewport * InViewport, int ControllerId, FKey Key, EInputEvent Event, float __formal, bool __formal) 行 2773	C++
FLevelEditorViewportClient::InputKey(FViewport * InViewport, int ControllerId, FKey Key, EInputEvent Event, float AmountDepressed, bool bGamepad) 行 2865	C++
FViewportClient::InputKey(const FInputKeyEventArgs & EventArgs) 行 814	C++
FSceneViewport::OnMouseButtonDown(const FGeometry & InGeometry, const FPointerEvent & InMouseEvent) 行 482	C++

其中的 FLandscapeToolStrokeSculpt::Apply 会调用

1
    this->Cache.SetCachedData(X1, Y1, X2, Y2, Data);

SetCachedData 最终会调用到：

1
2
3
FLandscapeEditDataInterface::SetHeightData(int X1, int Y1, int X2, int Y2, const unsigned short * InData, int InStride, bool InCalcNormals, const unsigned short * InNormalData, const unsigned short * InHeightAlphaBlendData, const unsigned char * InHeightFlagsData, bool InCreateComponents, UTexture2D * InHeightmap, UTexture2D * InXYOffsetmapTexture, bool InUpdateBounds, bool InUpdateCollision, bool InGenerateMips) 行 467	C++


我们会看到，这里的代码对 Edit Layer 进行了判断处理：

1
2
3
4
5
6
7
8
9
if (!Component->GetLandscapeProxy()->HasLayersContent())
      {
            ...
  	}
else 
      {
          // In Layer, cumulate dirty collision region (will be used next time UpdateCollisionHeightData is called)
          Component->UpdateDirtyCollisionHeightData(FIntRect(ComponentX1, ComponentY1, ComponentX2, ComponentY2));
      }

只要搜索 HasLayersContent() 这个函数的引用，就会发现 UE4 中很多地方针对 Edit Layer 进行了判断处理。