UnrealEngine　アニメーション設計①　スレッドセーフなクラス設計

環境：UE4.27、UE5.0

# はじめに
さあ、UEでアニメーションのプログラムを始めましょう。何からやったらいいでしょう？
まずは軽くUEのアニメーションシステムについて説明します。

# アニメーション関係のアセット

||||
|-|-|-|
|![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/9b12cb26-c17a-a006-f943-6ebfaf385932.png)|Skeletonアセット|骨構造、リターゲット|
|![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/63c00b4e-a42f-7452-afd5-d75f04f364bb.png)|SkeletalMeshアセット|メッシュ、リファレンスポーズ、PostProcessAnimBP|
|![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/e2ffd69f-4b10-e47e-65c6-b32c8410471c.png)|AnimBlueprintアセット|Update処理、ブレンドツリー、StateMachine|
|![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/629d3b28-b45a-816e-da0e-3eb8a1c082d7.png)|AnimSequenceアセット|キーフレームアニメーション、Additive設定、ルートモーション|
|![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/932cdc89-f8c8-042a-ca5c-1702868cd13d.png)|AnimMontageアセット|複数のAnimSequence、ループ、ブレンド設定|

これらアニメーション関係のアセットのほとんどはSkeletonに依存しています。
同じSkeletonを共有していないと再生することができないようになっています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/5fe6576d-e224-5c1d-5170-8997c57e1b32.png)

# アニメーション関係のクラス、構造体
|||
|-|-|
|USkeletalMeshComponentクラス|メッシュを表示してくれる、UAnimInstanceを保持している|
|UAnimInstanceクラス|AnimBlueprintの親クラス、アニメーションの再生などの基本機能|
|FAnimInstanceProxy構造体|AnimationNodeが参照するデータの置き場所|

それぞれの関係は以下のようになっていて、
SkeletalMesh、AnimBPアセットはSkeletalMeshComponentに
AnimSequence、AnimMontageアセットはAniminstaceにセットして使います。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/5e728434-3952-439b-068a-9c1b13cdf603.png)

# アニメーションのブレンドやロジックを組めるAnimBlueprint
AnimBlueprintには「イベントグラフ」と「AnimGraph」という編集タブがあり、ここに処理を書いていくことができそうです。
このあたりに機能を追加していけばいい感じにカスタムされたアニメーションシステムにできそうです。
このあたりを詳しく見ていきましょう。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/bdfb5a28-ae2c-a29d-ea69-e16f53590fab.png)

# その前に、設計の方針
- 処理負荷を優先する。なのでAnimBPのイベントグラフは使わずC++に書く
- 補助骨や揺れ物などの処理はメッシュごとに変わるのでPostProcessAnimBPに書く
- UE4はStateMachineを複数のSkeletonで共有できないので使わない（UE5はAnimtionBlueprintTemplateが実装されてできるようになった）
- ブレンドツリー（AnimGraph）はなるべくシンプルに

# クラスを用意しよう
イベントグラフ（BP）は使わないという方針なので、AnimBlueprintの親クラスをC++で用意します。
（名前は適当）
- UMyAnimInstance
- UMyAnimInstancePostProcess

メイン用とPostProcess用に２つ作ります。

```cpp
UCLASS()
class UMyAnimInstance : public UAnimInstance
{
	GENERATED_BODY()

public:
	UMyAnimInstance();
};
```
UMyAnimInstancePostProcessも同じ感じで作ります。

後はAnimBPを作るときにSkeletonと先ほど作ったクラスを選択します。
AnimBPも２つ作ります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/dd3faab7-6b2d-34fe-7f01-6e5087d6dbad.png)

メインのAnimBPはSkeletalMeshにセットします。
CharacterBPのSkeletalMeshComponentを選択すると
「詳細」のAnimationカテゴリーにセットするところが見つかると思います。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/48212a08-fa55-e015-e79b-ec2b128ea9c7.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/4d6eaf50-89b2-dd0e-c4c5-aea164689df5.png)

PostProcess用のAnimBPはスケルタルメッシュアセットにセットします。
スケルタルメッシュカテゴリーにセットするところがあります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/262c70fe-004d-17e4-e038-be81a5db76e2.png)

これで準備はできました。

# AnimBPへ変数を公開する
このままではまだ何も変わらないのでブレンドツリー（AnimGraph）にパラメータを伝えるために先程作ったクラスに変数を用意します。

```cpp
protected:
	// これらBlueprintReadOnlyの変数はワーカースレッドから参照されるためNativeUpdateAnimation以外から変更してはいけません
	UPROPERTY(BlueprintReadOnly, meta = (AllowPrivateAccess = "true"))
	float WalkDirection;
```
AnimGraphで使えるようになりました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/c4063c43-4e6a-134f-6d8c-2c974f05f4fc.png)
LocomotionのBlendSpaceとかに使えそうですね。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2778561/a1822a85-27c3-8369-d8e4-9eb2504ef9bc.png)

ところで、こんなコメントが書かれていたと思います。
「これらBlueprintReadOnlyの変数はワーカースレッドから参照されるためNativeUpdateAnimation以外から変更してはいけません」

これについて説明します。

# スレッドセーフな作りにする
AnimGraphは並列で動作するようになっています。なので変数はスレッドセーフでなければいけません。
並列処理は複数のCPUで同時に処理ができるため高速に処理できますが、同じメモリ領域に複数のスレッドが同時にアクセスするとバグったり最悪クラッシュすることになります。

例えば、配列のサイズを取得してfor文で処理していたらいつの間にか配列のサイズが変わっていて配列外参照でクラッシュ。とかが考えられます
```cpp
	int32 arrayNum = array.Num();
	for(int32 i = 0; i < arrayNum; ++i)
	{
		array[i] = 0;
	}
```

どのタイミングで書き換えればよいかと言うと、UAnimInstance::NativeUpdateAnimationです。この関数はAnimGraphの処理が走る前にGameThreadで実行されるので安全に書き換えることができます。

わかった、じゃあNativeUpdateAnimationでいろんな情報を取得して変数に突っ込めばいいのね。となるのですが。
そうしてしまうとUAnimInstanceがいろんなコンポーネントに依存してしまって再利用性が著しく悪い設計になってしまいます。

なのでそれを受け止める新しいクラスを作ります。
ActorComponentを継承したクラスです。このクラスの変数はいつでも自由に変更してOKなので、キャラクターアクターに持たせてこのクラスの関数を呼び出すようにしてもらいます。
```cpp
UCLASS()
class GAMEMODULE_API UMyAnimationComponent : public UActorComponent
{
	GENERATED_BODY()

protected:
	virtual void Update(float DeltaSeconds);

protected:
	UPROPERTY()
	UMyAnimInstance* AnimInstance;
}
```
パラメータをUMyAnimationComponentに一旦貯めておき、Update()関数内で安全にUMyAnimInstanceを書き換えるという戦略です。
そのために、NativeUpdateAnimationのタイミングでUpdateが呼び出されるようにしましょう。

UMyAnimInstanceにイベントを用意してNativeUpdateAnimationからBroadcastしてやります。
UMyAnimationComponentは初期化時にOnUpdateAnimation()を使ってUpdate関数にバインドしてあげればいいですね。

あと、protectedの変数にアクセスできるようにフレンドにしておきます。
```cpp
UCLASS()
class UMyAnimInstance : public UAnimInstance
{
	friend class UMyAnimationComponent;

	省略

public:
	/// ポーズの更新前に呼び出されるイベント、このタイミングなら安全に変数を書き換えられる
	DECLARE_EVENT_OneParam(UAnimInstanceGame, FUpdateAnimationEvent, float /*DeltaSeconds*/);
	FUpdateAnimationEvent& OnUpdateAnimation() { return UpdateAnimationEvent; }

private:
	// イベント
	FUpdateAnimationEvent UpdateAnimationEvent;
};

void UMyAnimInstance::NativeUpdateAnimation(float DeltaSeconds)
{
	UpdateAnimationEvent.Broadcast(DeltaSeconds);
}

```

こうすることで、安全に外から値をセットしてもらうことができるのでAnimationシステムは他のコンポーネントを参照しな
くてすみます。依存関係も最低限に抑えられ再利用性も保たれていいですね。

UMyAnimationComponent::Update()には変数をコピーする以外にも顔向けやIK、ブレンド率、エイミングなどの処理を書いていくことになります。次回以降で説明していこうと思います。

# 今回新規に作成したクラス
|||
|-|-|
|UMyAnimInstance|AnimBlueprintの親クラス|
|UMyAnimInstancePostProcess|PostProcessAnimBPの親クラス|
|UMyAnimationComponent|Characterシステムなどから直接アクセスするクラス|

# 次回
次回はUE5のLyraStarterではどうやっているか見てみましょう。

---
[UnrealEngine　アニメーション設計②　UE5のLyraStarterGameのAnimationシステムを見てみよう](https://qiita.com/okqi/items/9617f8abf5a9d0de26b3)