Util模块技术文档

目录

• 1. 概述
• 1.1 Util模块与其它模块的调用关系图
• 1.2 Util模块关键流程图
• 1.3 Util模块关键类表
• 2. Util核心功能类
• 2.1 UActorAttacher：Actor 附加器
  • 2.1.1 概要
  • 2.1.2 关键方法详解
• 2.2 AActorWithRandomEngine：随机引擎注入器
  • 2.2.1 概要
  • 2.2.2 关键方法详解
  • 2.2.3 使用示例
• 2.3 BoundingBox相关类
  • 2.3.1 FBoundingBox：边界框结构
  • 2.3.2 UBoundingBoxCalculator：边界框计算器
• 2.4 FDebugShapeDrawer：调试形状绘制器
  • 2.4.1 概要
  • 2.4.2 使用场景
  • 2.4.3 关键方法详解
• 2.5 FNavigationMesh：导航网格管理器
  • 2.5.1 概要
  • 2.5.2 关键方法详解
  • 2.5.3 使用示例
  • 2.5.4 注意事项
  • 2.5.5 扩展功能

1. 概述

CARLA的Util模块提供了一系列底层的C++工具类，用于简化对Unreal世界中各种对象、集合体、导航、随机数以及调试绘制等功能的操作。Util模块位于源码路径Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Util下，包含29个源文件和头文件，涵盖从附件管理、随机引擎到导航网络、文件解析、调试绘制等多方面工具。

1.1 Util模块与其它模块的调用关系图

flowchart LR
  subgraph Util 模块
    A[UActorAttacher] -->|Attach| B[Game/Vehicle]
    C[UBoundingBoxCalculator] -->|Calc BB| D[RPC Server]
    E[FDebugShapeDrawer] -->|Draw| F[UWorld]
    G[ProceduralCustomMesh] -->|Mesh| H[OpenDriveGenerator]
    I[FIniFile] -->|Config| J[Plugin Settings]
  end
  subgraph 其他模块
    B -->|Spawn Sensor| K[Sensor Module]
    D -->|Serialize| L[Client Python]
    H -->|Render Road| M[Traffic Module]
  end

1.2 Util模块关键流程图

flowchart TD
  subgraph 模块初始化
    A1[FIniFile: 读取 .ini 配置]
    A2[ObjectRegister: 注册全局管理对象]
    A1 --> A2
    A3[RandomEngine: 初始化随机数引擎]
    A2 --> A3
    A4[NoWorldOffsetSceneComponent: 设置世界坐标稳定]
    A3 --> A4
  end

  subgraph 仿真执行循环
    B1[FCarlaEngine Tick]
    B1 --> B2[UActorAttacher: 附加传感器至车辆]
    B2 --> B3[RandomEngine: 生成随机参数]
    B3 --> B4[UBoundingBoxCalculator: 计算各 Actor 包围盒]
    B4 --> B5[FDebugShapeDrawer: 绘制调试形状]
    B5 --> B6[ProceduralCustomMesh: 动态生成自定义网格]
    B6 --> B7[NavigationMesh: 更新/重构导航网格]
    B7 --> B8[RayTracer: 执行射线检测]
    B8 --> B9[FCarlaServer: 聚合 & RPC 序列化]
  end

1.3 Util模块关键类表

2. Util核心功能类

2.1 UActorAttacher：Actor 附加器

2.1.1 概要

UActorAttacher是 CARLA Unreal 插件中用于在运行时将“子” Actor（如传感器、摄像头等）附加到“父” Actor（如车辆、建筑物等）上的静态工具类，支持三种常用的附加模式： - 刚性附加（Rigid）：调用 Child->AttachToActor(Parent, FAttachmentTransformRules::KeepRelativeTransform)； - 弹簧臂附加（SpringArm）：调用UActorAttacher_AttachActorsWithSpringArm(Child, Parent)； - “幽灵”弹簧臂附加（SpringArmGhost）：调用UActorAttacher_AttachActorsWithSpringArmGhost(Child, Parent)。

在内部，AttachActors 会根据传入的 EAttachmentType 枚举选择不同的实现分支，或调用 Unreal 原生的 AttachToActor，或动态创建并配置 USpringArmComponent 和 UChildActorComponent，实现带碰撞测试或不带碰撞测试的带臂附加效果。 最后将子 Actor 的所有者（Owner）设置为父 Actor，以便后续的生命周期和 RPC 权限管理

2.1.2 关键方法详解

1. AttachActors

   UFUNCTION(BlueprintCallable, Category="CARLA|Actor Attacher")
   static void AttachActors(AActor *Child, AActor *Parent, EAttachmentType AttachmentType);
   

2. 作用：根据传入的AttachmentType分发到三种附加实现方式，最后执行Child->SetOwner(Parent)，将子 Actor 的所有者设为父 Actor
3. 关键变量：
4. Child、Parent：要附加的子/父 Actor 指针：
5. AttachmentType：枚举值决定调用哪种附加方式。

6. 使用场景：在仿真初始化或 BeginPlay 阶段将传感器、摄像头等以不同跟随模式挂载到车辆或其他移动 Actor 上。

7. UActorAttacher_AttachActorsWithSpringArm

   static void UActorAttacher_AttachActorsWithSpringArm(AActor *Child, AActor *Parent)
   {
     // 1. 动态创建 SpringArmComponent
     auto SpringArm = NewObject<USpringArmComponent>(Parent);
     // 2. 计算子 Actor 相对位置并重置位置
     const auto ChildLocation = -Child->GetActorLocation();
     Child->SetActorLocation(FVector::ZeroVector);
     // 3. 配置弹簧臂属性
     SpringArm->TargetOffset = FVector(0,0,30.0f);
     SpringArm->bDoCollisionTest = true;
     SpringArm->SetRelativeRotation(FRotationMatrix::MakeFromX(ChildLocation).Rotator());
     SpringArm->SetupAttachment(Parent->GetRootComponent());
     SpringArm->TargetArmLength = ChildLocation.Size();
     SpringArm->bEnableCameraRotationLag = true;
     SpringArm->CameraRotationLagSpeed = 8.0f;
     SpringArm->bInheritPitch = false;
     SpringArm->bInheritRoll  = false;
     SpringArm->bInheritYaw   = true;
     SpringArm->AttachToComponent(
         Parent->GetRootComponent(),
         FAttachmentTransformRules::KeepRelativeTransform);
     SpringArm->RegisterComponent();
     // 4. 创建并附加 ChildActorComponent
     auto ChildComp = NewObject<UChildActorComponent>(Parent);
     ChildComp->SetupAttachment(
         SpringArm,
         USpringArmComponent::SocketName);
     Child->AttachToComponent(
         ChildComp,
         FAttachmentTransformRules::KeepRelativeTransform);
     ChildComp->RegisterComponent();
   }
   

8. 作用：利用 USpringArmComponent 自动实现带碰撞测试的“弹簧臂”跟随，使子 Actor 始终保持与父 Actor 之间的指定距离和方向
9. 关键变量：
10. ChildLocation：用于计算臂长和设置旋转方向；
11. TargetOffset、bDoCollisionTest、TargetArmLength、CameraRotationLagSpeed：分别决定臂的偏移、高度、碰撞行为及旋转滞后。
12. 使用场景：驾驶视角摄像头或第三人称摄像机跟随，需保持一定距离并对地形碰撞自动校正。

2.2 AActorWithRandomEngine：随机引擎注入器

2.2.1 概要

AActorWithRandomEngine 是 CARLA 插件中用于支持确定性随机行为的抽象 Actor 基类， 位于 CarlaUE4/Plugins/Carla/Source/Carla/Util/ActorWithRandomEngine.*。该类内置了一个 URandomEngine 实例，并通过固定或可配置的种子（Seed）初始化，从而实现可重现的随机数序列。并在 Blueprint/C++ 中通过GetRandomEngine、GetSeed、SetSeed 提供访问与修改接口。

该类支持在编辑器中配置种子值，或启用自动生成随机种子。在构造阶段（Construction）或属性变更时，内部的随机引擎会根据当前种子重新初始化，确保每次仿真运行的随机行为可控且可复现。

2.2.2 关键方法详解

1. OnConstruction

   void AActorWithRandomEngine::OnConstruction(const FTransform &Transform)
   {
     Super::OnConstruction(Transform);
     if (bGenerateRandomSeed)
     {
       Seed = FMath::Rand();
     }
     if (RandomEngine)
     {
       RandomEngine->Initialize(Seed);
     }
   }
   

2. 作用：在 Actor 被放置或属性变更后调用，用于根据当前配置的种子值初始化随机引擎，确保每次 Actor 构建时，随机引擎的状态与当前种子一致，从而实现可控的随机行为。
3. 关键变量：

4. Transform：Actor 在编辑器或运行时“放置”时的世界变换信息，包含位置、旋转、缩放，通常用于根据初始位置执行额外逻辑。

5. SetSeed

   void AActorWithRandomEngine::SetSeed(int32 InSeed)
   {
     Seed = InSeed;
     if (RandomEngine)
     {
       RandomEngine->Initialize(Seed);
     }
   }
   

6. 作用：设置新的种子值，并重新初始化随机引擎，以改变随机行为的序列。
7. 关键变量：
8. InSeed：从外部传入的新种子值，用于替换当前的 Seed;
9. `RandomEngine：内部使用的随机引擎实例，调用随机引擎的初始化方法，将其内部状态重置为基于新 Seed 的起始状态。
10. seed：当前使用的种子值，默认值为 123456789。

#### 2.2.3 使用示例

class AMyRandomActor : public AActorWithRandomEngine
{
    GENERATED_BODY()

public:
    virtual void BeginPlay() override
    {
        Super::BeginPlay();

        // 使用随机引擎生成一个 0 到 100 之间的整数
        int32 RandomValue = GetRandomEngine()->GetUniformIntInRange(0, 100);
        UE_LOG(LogTemp, Log, TEXT("Generated Random Value: %d"), RandomValue);
    }
};
// 创建一个继承自 AActorWithRandomEngine 的自定义 Actor

2.3 BoundingBox相关类

2.3.1 FBoundingBox：边界框结构

概要

FBoundingBox是一个BlueprintType的USTRUCT，用于在C++与BluePrint间传递和操作三维边界框信息。CARLA 中所有 Actor（车辆、行人、交通标志、静态网格等）均可通过该结构表示其局部边界框，方便后续在世界或摄像机坐标下进行投影、碰撞检测或可视化渲染。

成员详解

USTRUCT(BlueprintType)
struct CARLA_API FBoundingBox
{
  GENERATED_BODY()

  /// 边界框相对于其所有者的原点
  UPROPERTY(EditAnywhere, BlueprintReadWrite)
  FVector Origin = {0.0f, 0.0f, 0.0f};

  /// 边界框的半径范围（沿 X/Y/Z 方向的一半长度）
  UPROPERTY(EditAnywhere, BlueprintReadWrite)
  FVector Extent = {0.0f, 0.0f, 0.0f};

  /// 边界框的旋转（相对于父 Actor 的局部旋转）
  UPROPERTY(EditAnywhere, BlueprintReadWrite)
  FRotator Rotation = {0.0f, 0.0f, 0.0f};
};

2.3.2 UBoundingBoxCalculator：边界框计算器

概要

UBoundingBoxCalculator 是一个派生自 UBlueprintFunctionLibrary 的静态函数集，负责根据不同 Actor 或网格类型，提取或合成对应的 FBoundingBox 信息。

关键方法详解

小结

• FBoundingBox 提供了统一的包围盒数据结构；
• UBoundingBoxCalculator 则围绕不同 Actor/组件类型提供了从局部到世界空间的包围盒提取、批量和合并能力；
• 组合该工具链，可支持 CARLA 中传感器感知、HUD 渲染、碰撞检测及数据采集等多种场景。

2.4 FDebugShapeDrawer：调试形状绘制器

2.4.1 概要

FDebugShapeDrawer 是 CARLA 中用于在 Unreal Engine 世界 (UWorld) 中绘制调试形状的工具类。它通过访问 carla::rpc::DebugShape 对象，根据其定义的形状类型（如点、线、箭头、盒子、字符串等）在世界或 HUD 上进行可视化展示。该类内部使用了 FShapeVisitor 结构体，通过访问者模式处理不同的形状类型，实现了灵活且可扩展的调试绘制机制。

2.4.2 使用场景

• 在仿真过程中实时可视化调试信息，如传感器检测结果、路径规划轨迹等。
• 在 HUD 上展示关键调试信息，辅助开发和测试。
• 在大型地图中，通过 ALargeMapManager 进行坐标转换，确保绘制位置的准确性。

2.4.3 关键方法详解

1.FDebugShapeDrawer::Draw

void FDebugShapeDrawer::Draw(const carla::rpc::DebugShape &Shape) {
  auto Visitor = FShapeVisitor(World, Shape.color, Shape.life_time, Shape.persistent_lines);
  boost::variant2::visit(Visitor, Shape.primitive);
}

2.FShapeVisitor::operator() (Arrow)

void FShapeVisitor::operator()(const Shape::Arrow &Arrow) const {
  FVector Begin = FVector(Arrow.line.begin);
  FVector End   = FVector(Arrow.line.end);
  // 坐标转换
  ALargeMapManager* LargeMap = UCarlaStatics::GetLargeMapManager(World);
  if (LargeMap) {
    Begin = LargeMap->GlobalToLocalLocation(Begin);
    End   = LargeMap->GlobalToLocalLocation(End);
  }
  // 箭头向量与变换
  const auto Diff = End - Begin;
  const FRotator LookAt = FRotationMatrix::MakeFromX(Diff).Rotator();
  const FTransform Transform{LookAt, Begin};

  // 绘制主干与箭头头部
  const float ArrowSize     = 1e2f * Arrow.arrow_size;
  const float ArrowTipDist  = Diff.Size() - ArrowSize;
  const float Thickness     = 1e2f * Arrow.line.thickness;
  World->PersistentLineBatcher->DrawLines({
    FBatchedLine(Begin, End, Color, LifeTime, Thickness, DepthPriority),
    FBatchedLine(
      Transform.TransformPosition(FVector(ArrowTipDist, +ArrowSize, +ArrowSize)),
      End, Color, LifeTime, Thickness, DepthPriority),
    // ... 其他箭头分支
  });
}

2.5 FNavigationMesh：导航网格管理器

2.5.1 概要

FNavigationMesh 是 CARLA 中用于与 Unreal 导航网格系统交互的工具类，位于 CarlaUE4/Plugins/Carla/Source/Carla/Util/NavigationMesh.*。其主要功能是加载与指定地图名称相关联的导航网格数据，支持路径查询和导航功能。该类通过读取存储为 .bin 文件的导航网格数据，为仿真中的路径规划和智能体导航提供支持。

2.5.2 关键方法详解

Load 方法

static TArray<uint8> Load(FString MapName);

• 作用：根据传入的地图名称加载对应的导航网格二进制数据文件。
• 参数：
• MapName：指定地图的名称，用于定位对应的导航网格文件。
• 返回值：返回一个 TArray<uint8> 类型的数组，包含导航网格文件的二进制内容。如果加载失败，则返回空数组。
• 实现逻辑：
• 编辑器模式处理：
  • 如果在编辑器中运行，地图名称可能会有一个额外的前缀（如 UEDPIE_0_）。代码会移除这个前缀，以确保文件查找的正确性。
  • 例如，原始地图名称为 UEDPIE_0_Town01，校正后变为 Town01。
• 构建文件名：
  • 根据地图名称构建导航网格文件的完整名称，假设文件后缀为 .bin。例如，地图名称为 Town01，则文件名为 Town01.bin。
• 查找文件：
  • 使用 IFileManager::Get().FindFilesRecursive 方法在项目内容目录（FPaths::ProjectContentDir()）中递归查找与导航网格文件名匹配的文件。
• 加载文件内容：
  • 如果找到文件，尝试使用 FFileHelper::LoadFileToArray 方法将文件内容加载到 Content 数组中。
  • 如果加载成功，输出日志信息，提示正在加载的文件名。
  • 如果加载失败，输出错误信息，提示加载失败的文件名。
• 返回结果：
  • 返回加载到的导航网格文件内容（可能为空，如果加载失败）。

2.5.3 使用示例

#include "Carla/Util/NavigationMesh.h"

void LoadNavigationMeshData(FString MapName)
{
    // 调用 FNavigationMesh::Load 方法加载导航网格数据
    TArray<uint8> MeshData = FNavigationMesh::Load(MapName);

    // 检查加载结果
    if (MeshData.Num() > 0)
    {
        UE_LOG(LogTemp, Log, TEXT("Navigation Mesh data loaded successfully for map '%s'"), *MapName);
        // 进一步处理加载的导航网格数据
    }
    else
    {
        UE_LOG(LogTemp, Error, TEXT("Failed to load Navigation Mesh data for map '%s'"), *MapName);
    }
}

• 说明：此示例展示了如何在 CARLA 仿真中加载指定地图的导航网格数据。通过调用 FNavigationMesh::Load 方法，可以获取导航网格的二进制数据，用于后续的路径规划和导航功能。

2.5.4 注意事项

1. 文件路径：
2. 确保导航网格文件存储在项目的 Content 目录下，并且文件名与地图名称匹配。
3. 编辑器模式：
4. 如果在编辑器中运行，需要处理地图名称的前缀问题，以确保文件查找的正确性。
5. 错误处理：
6. 在实际使用中，应添加适当的错误处理逻辑，以应对文件未找到或加载失败的情况。

2.5.5 扩展功能

• 路径查询：
• FNavigationMesh 类可以进一步扩展，提供路径查询功能，例如通过调用 Unreal 的导航系统接口，实现从起点到终点的路径规划。
• 动态更新：
• 支持在运行时动态更新导航网格，以适应场景中动态变化的障碍物或路径。

通过 FNavigationMesh 类，CARLA 仿真系统能够高效地加载和管理导航网格数据，为智能体的路径规划和导航功能提供坚实的基础。