Unreal Editor でのカスタム アクターのアニメーション化

Unreal^® Editor でカスタム アクターをアニメーション化するには、次の手順に従います。開始する前に、Visual Studio^® 2019 と Vehicle Dynamics Blockset™ Interface for Unreal Engine^® 4 Projects サポート パッケージがマシンにインストールされていることを確認してください。詳細については、サポート パッケージのインストールと環境の構成を参照してください。

さらに、次のことを確認してください。

• Unreal Engine での C++ のコーディングを理解していること。

• Unreal Editor C++ プロジェクトに骨格となるアクターのメッシュが含まれていること。この例では二輪のメッシュを使用します。

  

この例では、二輪アクターをアニメーション化するワークフローを示します。Unreal Engine の「ビークルのユーザー ガイド」から応用した一般的なワークフローを示しています。

Simulink モデルの設定

手順 1: Simulink モデルの設定

新しい Simulink^® モデルを開き、次のブロックを追加します。

• 2 つの Ramp ブロック

• Constant ブロック

• Simulation 3D Actor Transform Set ブロック

• Simulation 3D Scene Configuration ブロック

次のようにブロックを接続して名前を付けます。

手順 2: ブロックの構成

パラメーターを次のように設定してブロックを構成します。

ブロック	パラメーター設定
Simulation 3D Scene Configuration	シーン ソース — Unreal Editor プロジェクト — インストールされているサポート パッケージのプロジェクト ファイルの名前と場所 (例: C:\Local\AutoVrtlEnv\AutoVrtlEnv.uproject)。 シーン ビュー — シーン原点
Simulation 3D Actor Transform Set	[アクターの設定] タブ: 3D シーンのアクターのタグ、ActorTag — Bike1 メモ このタグは、手順 6: 二輪アクターのインスタンス化の Unreal Editor のタグ名と一致していなければなりません。 設定するアクターあたりのパーツ数、NumberOfParts — 3 [初期値] タブ: パーツごとにアクターを並進させる初期配列値、Translation — [0 0 0;0 0 0;0 0 0] パーツごとにアクターを回転させる初期配列値、Rotation — [0 0 0;0 0 0;0 0 0] パーツごとにアクターをスケーリングさせる初期配列値、Scale — [1 1 1;1 1 1;1 1 1]
Translation Ramp	勾配 — [0.35 0 0;0 0 0;0 0 0]
Rotation Ramp	勾配 — [0 0 0;0 -pi/5 0;0 -pi/5 0]
Scale Constant	定数値 — [1 1 1;1 1 1;1 1 1]

二輪をアニメーション化するための Unreal Editor の設定

手順 3: アニメーション インスタンスの設定

1. Simulink モデルで、Simulation 3D Scene Configuration ブロックの [Open Unreal Editor] パラメーターを使用して Unreal Editor を開きます。

2. [File] 、 [New C++ Class] を選択します。[Choose Parent Class] ダイアログ ボックスで、[Show All Classes] を選択します。AnimInst を検索します。AnimInstance 親クラスを追加します。

   

3. 新しい C++ クラスに SimulinkBikeAnimInst という名前を付けます。[Public] を選択します。[Create Class] をクリックします。

   

4. Visual Studio 2019 で、C:\Local\AutoVrtlEnv\AutoVrtlEnv.sln ファイルを開きます。ソース ファイルの SimulinkBikeAnimInst.cpp と SimulinkBikeAnimInst.h に移動します。

   

   ファイルを次のように編集します。

   ヒント

   この例では、二輪の車輪の回転をアニメーション化するために FWheelRotation プロパティと RWheelRotation プロパティをコードに含めています。プロパティをさらに追加して二輪の他のパーツをアニメーション化できます。

    コード: SimulinkBikeAnimInst.h

   // Copyright 2019 The MathWorks, Inc.
   #pragma once
    
   #include "CoreMinimal.h"
   #include "Animation/AnimInstance.h"
   #include "SimulinkBikeAnimInst.generated.h"
    
   /**
   *
   */
   UCLASS(transient, Blueprintable, hideCategories = AnimInstance, BlueprintType)
   class AUTOVRTLENV_API USimulinkBikeAnimInst : public UAnimInstance
   {
       GENERATED_UCLASS_BODY()
   public:
       UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = WheelRotation)
           float FWheelRotation;
    
       UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = WheelRotation)
           float RWheelRotation;
   };

    コード: SimulinkBikeAnimInst.cpp

   // Copyright 2019 The MathWorks, Inc.
   #include "SimulinkBikeAnimInst.h"
    
   USimulinkBikeAnimInst::USimulinkBikeAnimInst(const FObjectInitializer& ObjectInitializer)
       : Super(ObjectInitializer) {
       FWheelRotation = 0.0f;
       RWheelRotation = 0.0f;
   }

5. Unreal Editor で [Compile] をクリックします。

   

手順 4: アニメーション ブループリントの作成

1. Unreal Editor の [Content Browser] タブで、[View Options] の下にある [Show Engine Content] と [Show Plugin Content] を選択します。

   

2. アニメーション メッシュを追加します。[Content Browser] タブで、[MathWorksAutomotiveContent Content] 、 [Vehicles] 、 [Bicyclist] 、 [Meshes] に移動します。

   

3. [Add/Inport] 、 [Animation] 、 [Animation Blueprint] を選択します。

   

4. [Create Animation Blueprint] ダイアログ ボックスで、次のように選択します。

   • Parent Class: SimulinkBikeAnimInst

   • Target Skeleton: SK_Bicycle_Skeleton

   

   [OK] をクリックします。

5. ブループリントに BikeAnimation という名前を付けます。右クリックして [Save] を選択します。

   

6. BikeAnimation ブループリントを開きます。次のように接続します。

   

   前輪と後輪の両方について、次のように設定されていることを確認します。

   • [Bone to Modify] が正しいボーン

   • [Rotation Mode] が [Replace Existing]

   • [Rotation Space] が [Bone Space]

   

7. ブループリントをコンパイルして保存します。

手順 5: 二輪アクターの C++ クラスの作成

1. Unreal Editor の [Content Browser] タブで、[View Options] の下にある [Show Engine Content] と [Show Plugin Content] を選択します。

   

2. MathWorksSimulation C++ Classes フォルダーから [Sim3dActor] を選択します。

   

   右クリックして [Create C++ class derived from Sim3dActor] を選択します。

   

   ヒント

   MathWorksSimulation C++ Classes フォルダーが表示されない場合は、次の手順に従って、MathWorksSimulation プラグインがインストールされて有効になっていることを確認してください。

   1. Unreal Editor のツール バーで、[Edit] 、 [Plugins] を選択します。

   2. [Plugins] ウィンドウで、インストール済みのウィンドウのリストに [MathWorks Interface] プラグインが表示されていることを確認します。プラグインがまだ有効になっていない場合は、[Enabled] チェック ボックスをオンにします。

   3. エディターを閉じて Simulink から再度開きます。

3. 新しい Sim3dActor に BicycleActor という名前を付けます。[Public] を選択します。[Create Class] をクリックします。

   

4. Visual Studio で、BicycleActor.h と BicycleActor.cpp に移動します。

   

   ファイルを次のように編集します。

   ヒント

   この例では、車体 (BIKE_BODY)、前輪 (FRONT_WHEEL)、および後輪 (REAR_WHEEL) をアニメーション化するためのロジックをコードに含めています。ロジックをさらに追加して二輪の他のパーツをアニメーション化できます。

    コード: BicycleActor.h

   // Copyright 2019 The MathWorks, Inc.
   #pragma once
    
   #include "CoreMinimal.h"
   #include "Sim3dActor.h"
   #include "BicycleActor.generated.h"
    
    
   UCLASS()
   class AUTOVRTLENV_API ABicycleActor : public ASim3dActor
   {
       GENERATED_BODY()
    
       // Reference to animation blueprint and skeletal mesh
       UClass* BicycleAnimation;
       USkeletalMesh* BicycleMesh;
    
       //Enum for parts that we want to control from simulink
       enum {
           BIKE_BODY = 0,
           FRONT_WHEEL = 1,
           REAR_WHEEL =2,
           NumberOfParts = 3
       };
       enum {
           X = 0,
           Y = 1,
           Z = 2
       };
       enum {
           PITCH = 0,
           ROLL = 1,
           YAW = 2
       };
    
   public:
       //Containers to receive data from Simulink
       float Translation[NumberOfParts][3];
       float Rotation[NumberOfParts][3];
       float Scale[NumberOfParts][3];
    
       ABicycleActor();
    
       //Override functions for enabling Simulink to control this actor
       virtual void Sim3dInit() override;
       virtual void Sim3dSetup() override;
       virtual void Sim3dStep(float DeltaSeconds) override;
       virtual void Sim3dRelease() override;
    
       //Some helper functions
       void SetMesh(FString MeshRef);
       void SetAnim(FString AnimRef);
    
       //Function to update position/orientation of actor at each step
       virtual void Transform();
    
       // Returns Mesh subobject
       class USkeletalMeshComponent* GetMesh() const;
    
       //Reference to skeletal mesh component
       UPROPERTY(Category = Bicyclist,
           VisibleDefaultsOnly,
           BlueprintReadOnly,
           meta = (AllowPrivateAccess = "true"))
           class USkeletalMeshComponent* Mesh;
    
   protected:
       virtual int GetNumberOfParts() { return (NumberOfParts); }
    
   };
    
   // Returns Mesh subobject
   FORCEINLINE USkeletalMeshComponent* ABicycleActor::GetMesh() const {
       return Mesh;
   }

    コード: BicycleActor.cpp

   // Copyright 2019-2021 The MathWorks, Inc.
   #include "BicycleActor.h"
   #include "SimulinkBikeAnimInst.h"
   #include "Math/UnrealMathUtility.h"
   
   ABicycleActor::ABicycleActor() {
   
   	//Create mesh component
   	Mesh = CreateOptionalDefaultSubobject<USkeletalMeshComponent>(TEXT("ABicycleMesh"));
   	RootComponent = Mesh;
   }
   
   void ABicycleActor::Sim3dInit() {
   	Super::Sim3dInit();
   }
   
   void ABicycleActor::Sim3dSetup() {
   	SetMesh(TEXT("/MathWorksAutomotiveContent/Vehicles/Bicyclist/Meshes/SK_Bicycle"));
   	SetAnim(TEXT("/MathWorksAutomotiveContent/Vehicles/Bicyclist/Meshes/BikeAnimation.BikeAnimation_C"));
   
   	GetMesh()->SetSkeletalMesh(BicycleMesh);
   	GetMesh()->SetAnimationMode(EAnimationMode::AnimationBlueprint);
   	GetMesh()->SetAnimInstanceClass(BicycleAnimation);
   	Transform();
   }
   
   void ABicycleActor::Sim3dStep(float DeltaTime) {
   	Transform();
   }
   
   void ABicycleActor::Sim3dRelease() {
   	Super::Sim3dRelease();
   }
   
   void ABicycleActor::Transform() {
   	//Initialize
   	int status = 0;
   	FVector ActorLocation;
   	FRotator ActorRotation;
   	FVector ActorScale;
   	USimulinkBikeAnimInst* Animation = NULL;
   	Animation = Cast<USimulinkBikeAnimInst>(GetMesh()->GetAnimInstance());
   
   	//Read data from simulink
   	status = ReadSimulation3DActorTransform(readerTransform, Translation, Rotation, Scale);
   
   	//Set bicycle position and orientation
   	ActorLocation.Set(Translation[BIKE_BODY][X], Translation[BIKE_BODY][Y], Translation[BIKE_BODY][Z]);
   	ActorRotation.Pitch = Rotation[BIKE_BODY][PITCH];
   	ActorRotation.Roll = Rotation[BIKE_BODY][ROLL];
   	ActorRotation.Yaw = Rotation[BIKE_BODY][YAW];
   
   	//Unit conversion from simulink to UE, meteres to cm and radians to degrees
   	ActorLocation = ActorLocation * 100.0f;
   	ActorRotation = FMath::RadiansToDegrees(ActorRotation);
   	ActorScale.Set(Scale[BIKE_BODY][X], Scale[BIKE_BODY][Y], Scale[BIKE_BODY][Z]);
   
   	SetActorLocation(ActorLocation);
   	SetActorRotation(ActorRotation);
   	SetActorScale3D(ActorScale);
   
   	//Set properies in animation blueprint
   	Animation->FWheelRotation = FMath::RadiansToDegrees(Rotation[FRONT_WHEEL][ROLL]);
   	Animation->RWheelRotation = FMath::RadiansToDegrees(Rotation[REAR_WHEEL][ROLL]);
   
   	//Unit conversion from UE to simulink
   	ActorLocation = GetActorLocation();
   	ActorLocation = ActorLocation * .01f;           // cm -> m
   	ActorRotation = GetActorRotation();
   	ActorRotation = FMath::DegreesToRadians(ActorRotation);
   	ActorScale = GetActorScale3D();
   	Translation[BIKE_BODY][X] = ActorLocation.X;
   	Translation[BIKE_BODY][Y] = ActorLocation.Y;
   	Translation[BIKE_BODY][Z] = ActorLocation.Z;
   	Rotation[BIKE_BODY][X] = ActorRotation.Pitch;
   	Rotation[BIKE_BODY][Y] = ActorRotation.Roll;
   	Rotation[BIKE_BODY][Z] = ActorRotation.Yaw;
   	Scale[BIKE_BODY][X] = ActorScale.X;
   	Scale[BIKE_BODY][Y] = ActorScale.Y;
   	Scale[BIKE_BODY][Z] = ActorScale.Z;
   
   	Translation[FRONT_WHEEL][X] = 0.0f;
   	Translation[FRONT_WHEEL][Y] = 0.0f;
   	Translation[FRONT_WHEEL][Z] = 0.0f;
   	Translation[REAR_WHEEL][X] = 0.0f;
   	Translation[REAR_WHEEL][Y] = 0.0f;
   	Translation[REAR_WHEEL][Z] = 0.0f;
   
   	Rotation[FRONT_WHEEL][PITCH] = 0.0f;
   	Rotation[FRONT_WHEEL][ROLL] = FMath::DegreesToRadians(Animation->FWheelRotation);
   	Rotation[FRONT_WHEEL][YAW] = 0.0f;
   	Rotation[REAR_WHEEL][PITCH] = 0.0f;
   	Rotation[REAR_WHEEL][ROLL] = FMath::DegreesToRadians(Animation->RWheelRotation);
   	Rotation[REAR_WHEEL][YAW] = 0.0f;
   
   	Scale[FRONT_WHEEL][X] = 1.0f;
   	Scale[FRONT_WHEEL][Y] = 1.0f;
   	Scale[FRONT_WHEEL][Z] = 1.0f;
   	Scale[REAR_WHEEL][X] = 1.0f;
   	Scale[REAR_WHEEL][Y] = 1.0f;
   	Scale[REAR_WHEEL][Z] = 1.0f;
   
   	//Write data back to simulink
   	WriteSimulation3DActorTransform(writerTransform, Translation, Rotation, Scale);
   }
   
   void ABicycleActor::SetMesh(FString MeshPath) {
   	BicycleMesh =
   		Cast<USkeletalMesh>(StaticLoadObject(USkeletalMesh::StaticClass(), NULL, *MeshPath));
   }
   
   void ABicycleActor::SetAnim(FString AnimPath) {
   	BicycleAnimation = StaticLoadClass(USimulinkBikeAnimInst::StaticClass(), NULL, *AnimPath);
   }

   ヒント

   コードでメッシュやアニメーション アセットの場所を指定するときは、必ず相対パスを使用してください。

   void ABicycleActor::Sim3dSetup() {
   	SetMesh(TEXT("/MathWorksAutomotiveContent/Vehicles/Bicyclist/Meshes/SK_Bicycle"));
   	SetAnim(TEXT("/MathWorksAutomotiveContent/Vehicles/Bicyclist/Meshes/BikeAnimation.BikeAnimation_C"));
   
   	GetMesh()->SetSkeletalMesh(BicycleMesh);
   	GetMesh()->SetAnimationMode(EAnimationMode::AnimationBlueprint);
   	GetMesh()->SetAnimInstanceClass(BicycleAnimation);
   	Transform();
   }

5. Unreal Editor で [Compile] をクリックします。

   

手順 6: 二輪アクターのインスタンス化

1. Simulink モデルで、Simulation 3D Scene Configuration ブロックの [Open Unreal Editor] パラメーターを使用して Unreal Editor を開きます。

2. シーン内に二輪アクターを配置します。

   

3. タグを Simulation 3D Actor Transform Set ブロックの [3D シーンのアクターのタグ、ActorTag] と同じ値に設定します。この例では、値を Bike1 に設定します。

   

カメラ ビューの設定 (オプション)

必要に応じて、カメラ ビューを設定して既定のビューをオーバーライドします。カメラ ビューは Simulink またはレベル ブループリントを使用して設定できます。推奨されるオプションは、Simulink を使用する方法です。

手順 7: Simulink の使用 (推奨)

二輪を追従するカメラ ビューを設定するには、次を行います。

1. モデルに次のブロックを追加します。

   • 1 つの Ramp ブロック

   • 1 つの Add ブロック

   • 3 つの Constant ブロック

   • Simulation 3D Actor Transform Set ブロック

   次のようにブロックを接続して名前を付けます。

   

2. ブロック パラメーターを次のように設定します。

   ブロック	パラメーター設定
   Simulation 3D Actor Transform Set: Camera Control	3D シーンのアクターのタグ、ActorTag — MainCamera1
   CamTranslation	定数値 — [0 -5.1 0.56] ベクトル パラメーターを 1 次元として解釈 — off
   CamRotation	定数値 — [0 0 deg2rad(85)] ベクトル パラメーターを 1 次元として解釈 — off
   CamScale	定数値 — [1 1 1] ベクトル パラメーターを 1 次元として解釈 — off

手順 7: レベル ブループリントの使用

既定のカメラ ビューをオーバーライドするには、次を行います。

1. カメラ アクターを追加します。BicycleActor の子として割り当てます。

2. [Transform] の設定を使用して、位置と視点角度を指定します。

   

3. レベル ブループリントを開きます。

   

4. レベル ブループリントで、次のように接続します。[Event Graph] で右クリックしてノードを検索する場合は、[Context Sensitive] をオフにしてください。CameraActor がある場合は、エディターの [World Outliner] ビューから [Event Graph] にドラッグできます。

   

5. ブループリントとプロジェクトを保存します。Unreal Editor を閉じます。

シミュレーションの実行

Simulink モデルと Unreal Editor 環境を構成したら、シミュレーションを実行します。

1. Simulink モデルで、Simulation 3D Scene Configuration のパラメーターの値が次のように設定されていることを確認します。

   • シーン ソース — Unreal Editor

   • プロジェクト — インストールされているサポート パッケージのプロジェクト ファイルの名前と場所 (例: C:\Local\AutoVrtlEnv\AutoVrtlEnv.uproject)。

   • シーン ビュー — シーン原点

2. Simulation 3D Scene Configuration ブロックの [Open Unreal Editor] パラメーターを使用して Unreal Editor を開きます。

3. シミュレーションを実行します。

   1. Simulink モデルで [実行] をクリックします。

      Unreal Editor で開かれるプロジェクトがシーンのソースであるため、シミュレーションは開始されません。

   2. Simulink の [診断ビューアー] ウィンドウに次のメッセージが表示されていることを確認します。

      In the Simulation 3D Scene Configuration block, you set the scene source to 'Unreal Editor'. In Unreal Editor, select 'Play' to view the scene.

      これは、Simulink が Unreal Engine 3D 環境で車両および他のアセットをインスタンス化したことを示す確認のメッセージです。

   3. Unreal Editor で [Play] をクリックします。Unreal Editor で現在開いているシーンでシミュレーションが実行されます。

参考

Simulation 3D Actor Transform Set | Simulation 3D Scene Configuration

関連するトピック

• Unreal Engine 可視化環境との通信の開始
• Unreal Editor でのアクターへのカメラの配置

外部の Web サイト

• Unreal Engine