ドアを開ける

このチュートリアルでは、Engine のスターターコンテンツ で利用できるリソースを使って、C++ Timeline で接近すると開くドアの設定方法を紹介します。

Door アクタを作成する

1. 最初に、[New] > [Games] > [Blank] > [C++] プロジェクトへ進み、スターターコンテンツ を有効にした TimelineDoorActor を作成します。

2. C++ Class Wizard で DoorActor という名前の Actor クラスを新規作成します。「DoorActor.h」ファイルで以下のインクルードを宣言します。

   #include "Components/TimelineComponent.h"

3. 次に DoorActor クラス定義で以下のコードを実行します。

   protected:
   
       //MeshComponents to represent Door assets
       UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
       UStaticMeshComponent* DoorFrame;
       UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
       UStaticMeshComponent* Door;
   
       //TimelineComponent to animate Door meshes
       UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
       UTimelineComponent* DoorTimelineComp;
   
       //BoxComponent which will be used as our Proximity volume.
       UPROPERTY(EditAnywhere, BlueprintReadWrite)
       class UBoxComponent* DoorProxVolume;

4. DoorActor.cpp に移動します。以下のクラス ライブラリをインクルードして Box コンポーネントを使用します。

   #include "Components/BoxComponent.h"

5. ADoorActor::ADoorActor のコンストラクタで以下を宣言します。

   //Create our Default Components
   DoorFrame = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("DoorFrameMesh"));
   Door = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("DoorMesh"));
   DoorTimelineComp = CreateDefaultSubobject<UTimelineComponent>(TEXT("DoorTimelineComp"));
   DoorProxVolume = CreateDefaultSubobject<UBoxComponent>(TEXT("DoorProximityVolume"));
   
   //Setup our Attachments
   DoorFrame->SetupAttachment(RootComponent);
   Door->AttachToComponent(DoorFrame,FAttachmentTransformRules::KeepRelativeTransform);
   DoorProxVolume->AttachToComponent(DoorFrame, FAttachmentTransformRules::KeepRelativeTransform);

   注記：後で Door アクタnoカスタム メソッドを使って操作するために、ドアの相対トランスフォームをアタッチメント ルールとして保持します。 詳細は「FAttachmentTransformRules」を参照してください。

6. [Compile (コンパイル)] を選択して、エディタでコードを ホットリロード します。

Door Static Mesh を設定する

DoorFrame スタティックメッシュ コンポーネントと Door スタティックメッシュ コンポーネントを視覚的に表示するスタティックメッシュ アセットも設定する必要があります。

1. コンテンツ ブラウザから、C++ Classes フォルダ に移動します。

2. DoorActor クラスをダブルクリックして Create Blueprint Class based on Door Actor を選択し、ブループリント アクタに Bp_DoorActor と名前を付けます。

3. [Components] タブで DoorFrame Static Mesh コンポーネントを選択します。

4. [Details] パネルに移動し、スタティックメッシュを SM_DoorFrame に変更します。

5. [Components (コンポーネント)] パネルで DoorMesh コンポーネントを選択します。[Details] パネルに移動し、スタティックメッシュを SM_Door に変更します。

6. Transform カテゴリに移動し、Y Location 値を 45.0 に変更します。

7. [Save (保存する)] をクリックしてこれらの変更を Bp_DoorActor に保存します。

UCurveFloat トラックと Timeline イベント トラックを作成する

Timeline Component では Timeline Curve を必要とします。各カーブには時間と値を定義する複数のキーを含むことができます。カーブはこれらのキーを補間して、タイムライン中の任意のポイントの値を計算します。

ここの例では、UCurveFloat を使用します。

1. DoorActor.h の ADoorActor クラス定義へ移動し、以下の変数を宣言します。

   public:
       // Variable to hold the Curve asset
       UPROPERTY(EditAnywhere)
       UCurveFloat* DoorTimelineFloatCurve;
   
   private:
       //Float Track Signature to handle our update track event
       FOnTimelineFloat UpdateFunctionFloat;
   
       //Function which updates our Door's relative location with the timeline graph
       UFUNCTION()
       void UpdateTimelineComp(float Output);

2. DoorActor.cpp に移動し、 UpdateTimelineComp メソッドを実装します。

   void ADoorActor::UpdateTimelineComp(float Output)

   {
       // Create and set our Door's new relative location based on the output from our Timeline Curve
       FRotator DoorNewRotation = FRotator(0.0f, Output, 0.f);
       Door->SetRelativeRotation(DoorNewRotation);
   }

3. BeginPlay メソッドで以下のコードを追加します。

   //Binding our float track to our UpdateTimelineComp Function's output
   UpdateFunctionFloat.BindDynamic(this, &ADoorActor::UpdateTimelineComp);
   
   //If we have a float curve, bind it's graph to our update function
   if (DoorTimelineFloatCurve)
   {
      DoorTimelineComp->AddInterpFloat(DoorTimelineFloatCurve, UpdateFunctionFloat);
   }

Work-In-Progress Code

// Copyright 1998-2021 Epic Games, Inc.All Rights Reserved. 
#pragma once
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "Components/TimelineComponent.h"
#include "DoorActor.generated.h"

UCLASS()
class TIMELINEDOORACTOR_API ADoorActor : public AActor
{
    GENERATED_BODY()

public: 
    // Sets default values for this actor's properties
    ADoorActor();

    /*Variable to hold Curve asset*/
    UPROPERTY(EditAnywhere)
    UCurveFloat* DoorTimelineFloatCurve;

protected:
    // Called when the game starts or when spawned
    virtual void BeginPlay() override;

    //MeshComponents to represents Door assets
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UStaticMeshComponent* DoorFrame;
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UStaticMeshComponent* Door;

    //TimelineComponent to animate door meshes
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UTimelineComponent* DoorTimelineComp;

    //BoxComponent which will be used as our proximity volume.
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    class UBoxComponent* DoorProxVolume;

    //Float Track Signature to handle our update track event
    FOnTimelineFloat UpdateFunctionFloat;

    //Function which updates our Door's relative location with the timeline graph
    UFUNCTION()
    void UpdateTimelineComp(float Output);

public: 
    // Called every frame
    virtual void Tick(float DeltaTime) override;
};

//Copyright 1998-2021 Epic Games, Inc.All Rights Reserved.

#include "DoorActor.h"
#include "Components/BoxComponent.h"

// Sets default values
ADoorActor::ADoorActor()
{
    // Set this actor to call Tick() every frame.  You can turn this off to improve performance if you don't need it.
    PrimaryActorTick.bCanEverTick = true;

    //Create our Default Components
    DoorFrame = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("DoorFrameMesh"));
    Door = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("DoorMesh"));
    DoorTimelineComp = CreateDefaultSubobject<UTimelineComponent>(TEXT("DoorTimelineComp"));
    DoorProxVolume = CreateDefaultSubobject<UBoxComponent>(TEXT("DoorProximityVolume"));

    //Setup our Attachments
    DoorFrame->SetupAttachment(RootComponent);
    Door->AttachToComponent(DoorFrame,FAttachmentTransformRules::KeepRelativeTransform);
    DoorProxVolume->AttachToComponent(DoorFrame, FAttachmentTransformRules::KeepRelativeTransform); 
}

// Called when the game starts or when spawned
void ADoorActor::BeginPlay()
{
    Super::BeginPlay();

    //Binding our float track to our UpdateTimelineComp Function's output
    UpdateFunctionFloat.BindDynamic(this, &ADoorActor::UpdateTimelineComp);

    //If we have a float curve, bind it's graph to our update function
    if (DoorTimelineFloatCurve)
    {
    DoorTimelineComp->AddInterpFloat(DoorTimelineFloatCurve, UpdateFunctionFloat);

    }
}

void ADoorActor::UpdateTimelineComp(float Output)
{
    //Create and set our Door's new relative location based on the output from our Timeline Curve
    FRotator DoorNewRotation = FRotator(0.0f,Output,0.f);
    Door->SetRelativeRotation(DoorNewRotation);
}

// Called every frame
void ADoorActor::Tick(float DeltaTime)
{
    Super::Tick(DeltaTime);
}

Collision Overlap イベントを作成してバインドする

アクタがコリジョン領域に出入りするときに Box コンポーネントが反応する機能が必要です。

1. 「TimelineDoorActor.h」ファイルのクラス定義から、以下を宣言します。

   // Begin and End Overlap Events for our DoorProxVolume
   UFUNCTION()
   void OnOverlapBegin(class UPrimitiveComponent* OverlappedComp, class AActor* OtherActor, class UPrimitiveComponent* OtherComp, int32 OtherBodyIndex, bool bFromSweep, const FHitResult& SweepResult);
   
   UFUNCTION()
   void OnOverlapEnd(class UPrimitiveComponent* OverlappedComp, class AActor* OtherActor, class UPrimitiveComponent* OtherComp, int32 OtherBodyIndex);

2. Next, navigate to your DoorActor.cpp file to implement your OnOverlapBegin and OnOverlapEnd class methods:

   void ADoorActor::OnOverlapBegin(UPrimitiveComponent * OverlappedComp, AActor * OtherActor, UPrimitiveComponent * OtherComp, int32 OtherBodyIndex, bool bFromSweep, const FHitResult & SweepResult)
   {
       DoorTimelineComp->Play();
   }
   
   void ADoorActor::OnOverlapEnd(UPrimitiveComponent * OverlappedComp, AActor * OtherActor, UPrimitiveComponent * OtherComp, int32 OtherBodyIndex)
   {
       DoorTimelineComp->Reverse();
   }

3. BeginPlay メソッドで以下のようにオーバーラップ関数をバインドします。

   //Binding our Proximity Box Component to our Overlap Functions
   DoorProxVolume->OnComponentBeginOverlap.AddDynamic(this, &ADoorActor::OnOverlapBegin);
   DoorProxVolume->OnComponentEndOverlap.AddDynamic(this, &ADoorActor::OnOverlapEnd);

4. コードをコンパイルします。

Unreal Editor でカーブ アセットを作成する

Timeline Actor Blueprint に割り当てるために Unreal Editor でカーブ アセットを作成する必要があります。

1. コンテンツ ブラウザ から、[Add/Import]> [Miscellaneous] > [Curve] の順に選択します。

2. [CurveFloat] を選択して CurveFloat アセットに DoorCurveFloat と名前を付けます。

3. DoorCurveFloat アセットをダブル クリックして Timeline Editor を開きます。

4. Float Curve に 2 つのキーを追加します。時間値 (0,0) と (4,90) です。

   Timeline カーブの編集に関する詳細は、「キーとカーブ」を参照してください。

5. Shift キーを押しながら 2 つのキーを選択し、それらに Auto Cubic interpolation を設定してカーブを保存します。

6. Bp_DoorActor を開いて [Components] タブで Bp_DoorActor を選択します。

7. [Details] パネルの [Door Timeline Float Curve] ドロップダウン メニューから DoorCurveFloat を選択します。

8. レベル エディタで Bp_DoorActor をシーンに配置します。

9. コンパイルして保存し、PIE を押します。

   WASD を使って、スペクテイター ポーンを制御することができます。DoorActor のコリジョン領域へ移動すると、ドアが開いた時にタイムラインがプレイするのが分かります。

完成コード

// Copyright 1998-2021 Epic Games, Inc.All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "Components/TimelineComponent.h"
#include "DoorActor.generated.h"

UCLASS()
class TIMELINEDOORACTOR_API ADoorActor : public AActor
{
    GENERATED_BODY()

public: 
    // Sets default values for this actor's properties
    ADoorActor();
    //Variable to hold Curve asset
    UPROPERTY(EditAnywhere)
    UCurveFloat* DoorTimelineFloatCurve;

protected:
    // Called when the game starts or when spawned 
    virtual void BeginPlay() override;

    /*MeshComponents to represents Door assets*/
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UStaticMeshComponent* DoorFrame;
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UStaticMeshComponent* Door;

    //TimelineComponent to animate door meshes
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UTimelineComponent* DoorTimelineComp;

    //BoxComponent which will be used as our proximity volume.
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    class UBoxComponent* DoorProxVolume;

    //Float Track Signature to handle our update track event
    FOnTimelineFloat UpdateFunctionFloat;

    //Function which updates our Door's relative location with the timeline graph
    UFUNCTION()
    void UpdateTimelineComp(float Output);

    /*Begin and End Overlap Events for our DoorProxVolume*/
    UFUNCTION()
    void OnOverlapBegin(class UPrimitiveComponent* OverlappedComp, class AActor* OtherActor, class UPrimitiveComponent* OtherComp, int32 OtherBodyIndex, bool bFromSweep, const FHitResult& SweepResult);
    UFUNCTION()
    void OnOverlapEnd(class UPrimitiveComponent* OverlappedComp, class AActor* OtherActor, class UPrimitiveComponent* OtherComp, int32 OtherBodyIndex);

public: 
    // Called every frame
    virtual void Tick(float DeltaTime) override;
};

// Copyright 1998-2021 Epic Games, Inc.All Rights Reserved.

#include "DoorActor.h"
#include "Components/BoxComponent.h"

// Sets default values
ADoorActor::ADoorActor()
{
    // Set this actor to call Tick() every frame.You can turn this off to improve performance if you don't need it.
    PrimaryActorTick.bCanEverTick = true;

    //Create our Default Components
    DoorFrame = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("DoorFrameMesh"));
    Door = CreateDefaultSubobject<UStaticMeshComponent>(TEXT("DoorMesh"));
    DoorTimelineComp = CreateDefaultSubobject<UTimelineComponent>(TEXT("DoorTimelineComp"));
    DoorProxVolume = CreateDefaultSubobject<UBoxComponent>(TEXT("DoorProximityVolume"));

    //Setup our Attachments
    DoorFrame->SetupAttachment(RootComponent);
    Door->AttachToComponent(DoorFrame,FAttachmentTransformRules::KeepRelativeTransform);
    DoorProxVolume->AttachToComponent(DoorFrame, FAttachmentTransformRules::KeepRelativeTransform); 
}

// Called when the game starts or when spawned
void ADoorActor::BeginPlay()
{
    Super::BeginPlay();

    UpdateFunctionFloat.BindDynamic(this, &ADoorActor::UpdateTimelineComp);

    //If we have a float curve, bind it's graph to our update function
    if (DoorTimelineFloatCurve)
    {
        DoorTimelineComp->AddInterpFloat(DoorTimelineFloatCurve, UpdateFunctionFloat);
    }

    //Binding our Proximity Box Component to our Overlap Functions
    DoorProxVolume->OnComponentBeginOverlap.AddDynamic(this, &ADoorActor::OnOverlapBegin);
    DoorProxVolume->OnComponentEndOverlap.AddDynamic(this, &ADoorActor::OnOverlapEnd);
}

void ADoorActor::UpdateTimelineComp(float Output)
{
    FRotator DoorNewRotation = FRotator(0.0f,Output,0.f);
    Door->SetRelativeRotation(DoorNewRotation);
}

void ADoorActor::OnOverlapBegin(UPrimitiveComponent * OverlappedComp, AActor * OtherActor, UPrimitiveComponent * OtherComp, int32 OtherBodyIndex, bool bFromSweep, const FHitResult & SweepResult)
{
    DoorTimelineComp->Play();
}

void ADoorActor::OnOverlapEnd(UPrimitiveComponent * OverlappedComp, AActor * OtherActor, UPrimitiveComponent * OtherComp, int32 OtherBodyIndex)
{
    DoorTimelineComp->Reverse();
}

// Called every frame
void ADoorActor::Tick(float DeltaTime)
{
    Super::Tick(DeltaTime);
}