UE4学习笔记[3]Components and Collision/组件和碰撞

中文官方文档
英文官方文档

第一步：1.创建和附加组件

虚幻引擎4（UE4），建议先阅读编程快速入门 tutorial。本教程中将假设已熟悉创建项目和向其添加C++代码，及在虚幻编辑器中配置输入。如对创建Pawn类或配置输入不太熟悉，建议先学习玩家输入和Pawn tutorial

编程快速入门 tutorial
玩家输入和Pawn tutorial
Programming Quick Start tutorial
Player Input and Pawns tutorial

1.1 [又是一个新的C++工程]首先使用初学者内容包新建一个C++项目，将其命名为 HowTo_Components。需向此项目添加的首个项目是自定义Pawn，其将包含组件，在关卡中移动并与固体对象碰撞。本教程中将之命名为 CollidingPawn。

1.2 在你的代码编辑器中（通常为 Visual Studio 或 Xcode），打开 CollidingPawn.h，然后在类的声明部分的底部添加以下代码：

UPROPERTY()
class UParticleSystemComponent* OurParticleSystem;

使用此变量追踪之后将创建的 粒子系统组件(Particle System Component)。可直接创建组件而无需设置追踪组件的变量，但要在代码中使用此类组件，应将其储存在类似的类成员变量中。

1.3 现在可打开CollidingPawn.cpp并编辑构造函数 ACollidingPawn::ACollidingPawn，添加将生成各种有用组件并将以层级进行安排的代码。将创建与物理场景交互的 球体组件(Sphere Component)、视觉显示碰撞形态的 静态网格体组件(Static Mesh Component)、可随意开关的粒子系统组件，及可用于附加 摄像机组件(Camera Component) 控制游戏视角的 弹簧臂组件(Spring Arm Component)。在此之前，我们应该添加最终会用到的头文件。在头文件信息所在行的下方，我们要加入：

#include "UObject/ConstructorHelpers.h"
#include "Particles/ParticleSystemComponent.h"
#include "Components/SphereComponent.h"
#include "Camera/CameraComponent.h"
#include "GameFramework/SpringArmComponent.h"

1.4 决定用作层级根节点的组件。球体组件是一种可与游戏场景交互并碰撞的物理实体，本教程将使用球体组件。注意：Actor 的层级中可拥有多个启用物理的组件，但本教程中只需要一个。

// Our root component will be a sphere that reacts to physics
    USphereComponent* SphereComponent = CreateDefaultSubobject<USphereComponent>(TEXT("RootComponent"));
    RootComponent = SphereComponent;
    SphereComponent->InitSphereRadius(40.0f);
    SphereComponent->SetCollisionProfileName(TEXT("Pawn"));

加在ACollidingPawn::ACollidingPawn中。

1.5 接下来，将从 静态网格体 资源创建并附加半径为50的可见球体。其与刚才创建的半径40的球体组件无法完全吻合，因此需将把其缩小80%。还需将其向下移动40单位，使其中心与球体组件的中心对齐。

// Create and position a mesh component so we can see where our sphere is
    UStaticMeshComponent* SphereVisual = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("VisualRepresentation"));
    SphereVisual->SetupAttachment(RootComponent);
    static ConstructorHelpers::FObjectFinder<UStaticMesh> SphereVisualAsset(TEXT("/Game/StarterContent/Shapes/Shape_Sphere.Shape_Sphere"));
    if (SphereVisualAsset.Succeeded())
    {
        SphereVisual->SetStaticMesh(SphereVisualAsset.Object);
        SphereVisual->SetRelativeLocation(FVector(0.0f, 0.0f, -40.0f));
        SphereVisual->SetWorldScale3D(FVector(0.8f));
    }

基于硬编码的资产路径一般不太推荐，例如这个示例中的球体静态网格体的路径；我们通常会在构造函数中创建组件，让它可编辑，然后在虚幻编辑器中创建一个蓝图资产并且在那里设置静态网格体资产。但你也可以直接在代码中这样操作，对于程序员而言，这样还能让调试或者开发新功能变得更快。

1.6 现可将非活跃粒子系统组件附加到层级。可在代码中操纵此组件，然后设置输入进行开关。注意：粒子系统组件直接附加到静态网格体组件，而非附加到根。其同时略微偏离网格体底部中心，以便在运行时清晰显示。

// Create a particle system that we can activate or deactivate
    OurParticleSystem = CreateDefaultSubobject<UParticleSystemComponent>(TEXT("MovementParticles"));
    OurParticleSystem->SetupAttachment(SphereVisual);
    OurParticleSystem->bAutoActivate = false;
    OurParticleSystem->SetRelativeLocation(FVector(-20.0f, 0.0f, 20.0f));
    static ConstructorHelpers::FObjectFinder<UParticleSystem> ParticleAsset(TEXT("/Game/StarterContent/Particles/P_Fire.P_Fire"));
    if (ParticleAsset.Succeeded())
    {
        OurParticleSystem->SetTemplate(ParticleAsset.Object);
    }

1.7 利用弹簧臂组件，可将摄像机以低于其追踪Pawn的速度加速和减速，从而获得更平滑的摄像机附加点。其同时拥有内置功能，可防止摄像机穿过固体对象，用于处理如玩家在第三人称游戏里退到角落时等情况。虽然弹簧臂组件并非必要的组件，但它能够轻松让摄像机在游戏中移动时变得更加平滑。

// Use a spring arm to give the camera smooth, natural-feeling motion.
    USpringArmComponent* SpringArm = CreateDefaultSubobject<USpringArmComponent>(TEXT("CameraAttachmentArm"));
    SpringArm->SetupAttachment(RootComponent);
    SpringArm->SetRelativeRotation(FRotator(-45.f, 0.f, 0.f));
    SpringArm->TargetArmLength = 400.0f;
    SpringArm->bEnableCameraLag = true;
    SpringArm->CameraLagSpeed = 3.0f;

1.8 组件已创建并附加，现在应将此Pawn设为受默认玩家控制。只需下列代码即可：

// Create a camera and attach to our spring arm
    UCameraComponent* Camera = CreateDefaultSubobject<UCameraComponent>(TEXT("ActualCamera"));
    Camera->SetupAttachment(SpringArm, USpringArmComponent::SocketName);

新Pawn已附加一系列有用组件，可开始用户控制配置。现在回到虚幻编辑器。

第二步：2.配置输入和创建Pawn移动组件

2.1回到 虚幻编辑器(Unreal Editor)，开始配置项目输入设置。可在 编辑(Edit) 下拉菜单中的 项目设置(Project Settings) 下找到相关设置。

进入该菜单后，可在左侧面板中的 引擎(Engine) 部分中选择 输入(Input)。同时需要设置粒子系统切换的 操作映射(Action Mapping ) 、移动 Pawn 的两个 轴映射，和转动 Pawn 的一个 轴映射(Axis Mapping )。

Action Mapping
ParticleToggle	Space Bar

Axis Mapping
MoveForward	W	1.0
	S	-1.0
MoveRight	A	-1.0
	D	1.0

Turn	Mouse X	1.0

2.2将创建 移动组件(Movement Component) 管理移动，而非直接在Pawn类中处理所有移动。本教程中将扩展 Pawn移动组件(Pawn Movement Component ) 类。首先在 文件 下拉菜单中选择 将代码添加到项目（Add Code to Project） 命令。与Pawn类不同的，Pawn移动组件类默认为不可见。要找到该组件，需选中 显示所有类（Show All Classes） 选项。在搜索栏中输入"movement"，以便快速缩小列表范围。

Pawn移动组件拥有部分强大内置功能，以便使用常见物理功能，同时便于在大量Pawn类型间共享移动代码。使用组件分隔不同功能是上佳方法，可在项目增大、Pawn越加复杂时减少杂乱。

由于已将Pawn类命名为 CollidingPawn，则将该类命名为 CollidingPawnMovementComponent。刚才已对输入配置进行了定义，并创建了自定义Pawn移动组件。现在让我们回到代码编辑器，继续编写代码，定义Pawn移动组件使用时Pawn的移动方式。

第三步：3.为Pawn移动组件的行为编写代码

3.1现在回到代码编辑器中，为自定义Pawn移动组件编写代码。只需编写 TickComponent 函数（类似Actor的 Tick 函数）告知逐帧移动方式。在 CollidingPawnMovementComponent.h 中，需在类定义中覆盖 TickComponent：

public:
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override;  

在 CollidingPawnMovementComponent.cpp 中定义此函数：

void UCollidingPawnMovementComponent::TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction)
{
    Super::TickComponent(DeltaTime, TickType, ThisTickFunction);

    // Make sure that everything is still valid, and that we are allowed to move.
    if (!PawnOwner || !UpdatedComponent || ShouldSkipUpdate(DeltaTime))
    {
        return;
    }

    // Get (and then clear) the movement vector that we set in ACollidingPawn::Tick
    FVector DesiredMovementThisFrame = ConsumeInputVector().GetClampedToMaxSize(1.0f) * DeltaTime * 150.0f;
    if (!DesiredMovementThisFrame.IsNearlyZero())
    {
        FHitResult Hit;
        SafeMoveUpdatedComponent(DesiredMovementThisFrame, UpdatedComponent->GetComponentRotation(), true, Hit);

        // If we bumped into something, try to slide along it
        if (Hit.IsValidBlockingHit())
        {
            SlideAlongSurface(DesiredMovementThisFrame, 1.f - Hit.Time, Hit.Normal, Hit);
        }
    }
};

该代码将在场景中平滑移动Pawn，适当时在表面滑动。未对Pawn应用重力，其最大速度被硬编码为每秒150 虚幻单位。

此 TickComponent 函数使用 UPawnMovementComponent 类提供的几种强大功能。 ConsumeInputVector 报告并清空用于存储移动输入的内置变量值。 SafeMoveUpdatedComponent 利用虚幻引擎物理移动Pawn移动组件，同时考虑固体障碍。 移动导致碰撞时， SlideAlongSurface 会处理沿墙壁和斜坡等碰撞表面平滑滑动所涉及的计算和物理，而非直接停留原地，粘在墙壁或斜坡上。 Pawn移动组件中还包含众多值得探究的功能，但本教程范围中暂时无需使用。可查看如 浮动Pawn移动、旁观者Pawn移动 或 **角色移动组件**等其他类，了解额外使用范例和方法。

定义Pawn移动组件的行为后，可编写代码将其全部关联。

第四步：4.同时使用Pawn和组件

4.1要使用自定义 Pawn移动组件，首先需将变量添加到 Pawn 类进行追踪。在CollidingPawn.h中的类定义底部，添加"OurParticleSystem"变量的位置旁，添加：

UPROPERTY()
class UCollidingPawnMovementComponent* OurMovementComponent;

4.2拥有可用于追踪其的位置后，需创建存储在新变量中的 碰撞Pawn移动组件。因此打开 CollidingPawn.cpp ，在文件顶部 "CollidingPawn.h"所在一行的下方添加下列行，以便代码引用新类：

#include "CollidingPawnMovementComponent.h"

创建Pawn移动组件并将其与Pawn关联的方法非常简单。在 ACollidingPawn::ACollidingPawn 底部，添加此代码：

组件 不同，无需将此组件附加到自己的组件层级。这是因为其他组件均属于 场景组件 类型，本身需要物理位置。但 运动控制器

4.3拥有可用于追踪其的位置后，需创建存储在新变量中的 碰撞Pawn移动组件。因此打开 CollidingPawn.cpp ，在文件顶部 "CollidingPawn.h"所在一行的下方添加下列行，以便代码引用新类：

virtual UPawnMovementComponent* GetMovementComponent() const override;

而在 CollidingPawn.cpp 中，需按以下所示，添加覆盖函数的定义：

UPawnMovementComponent* ACollidingPawn::GetMovementComponent() const
{
    return OurMovementComponent;
}

4.4设置新的Pawn移动组件后，可创建代码处理Pawn会接收的输入。首先在 CollidingPawn.h 中的类定义内声明以下函数：

void MoveForward(float AxisValue);
void MoveRight(float AxisValue);
void Turn(float AxisValue);
void ParticleToggle();

在 CollidingPawn.cpp 中，按以下所示，添加此类函数的定义：

void ACollidingPawn::MoveForward(float AxisValue)
    {
        if (OurMovementComponent && (OurMovementComponent->UpdatedComponent == RootComponent))
        {
            OurMovementComponent->AddInputVector(GetActorForwardVector() * AxisValue);
        }
    }

    void ACollidingPawn::MoveRight(float AxisValue)
    {
        if (OurMovementComponent && (OurMovementComponent->UpdatedComponent == RootComponent))
        {
            OurMovementComponent->AddInputVector(GetActorRightVector() * AxisValue);
        }
    }

    void ACollidingPawn::Turn(float AxisValue)
    {
        FRotator NewRotation = GetActorRotation();
        NewRotation.Yaw += AxisValue;
        SetActorRotation(NewRotation);
    }

    void ACollidingPawn::ParticleToggle()
    {
        if (OurParticleSystem && OurParticleSystem->Template)
        {
            OurParticleSystem->ToggleActive();
        }
    }

4.5现在只需将函数绑定到输入事件。将下列代码添加到 ACollidingPawn::SetupPlayerInputComponent：

InInputComponent->BindAction("ParticleToggle", IE_Pressed, this, &ACollidingPawn::ParticleToggle);

InInputComponent->BindAxis("MoveForward", this, &ACollidingPawn::MoveForward);
InInputComponent->BindAxis("MoveRight", this, &ACollidingPawn::MoveRight);
InInputComponent->BindAxis("Turn", this, &ACollidingPawn::Turn);

4.6现已完成编程，可返回 虚幻编辑器 并按 编译 按钮加载更改。

第五步：5.在编辑器中运行

5.1在 虚幻编辑器 中，可按 编译 按钮加载代码更改。

5.2需将 CollidingPawn 实例放入场景。可在 内容浏览器 的"C++ Classes/HowTo_Components/CollidingPawn"下找到该类。

5.3按 运行，球体便会随WASD移动，随鼠标转动，并在场景中的物体（如桌子和椅子）上碰撞和滑动，或需要放入场景的任何物理对象。还可使用空格键向自己点火（或扑灭）！