[UE4][UE5] AnimationRecorderを使って、アニメーションの録画（ベイク）処理をBP・C++から行う方法について

はじめに

UnrealEngineにはレベル上のActorの動きをLevel Sequenceとして記録できるTake RecorderとSequence Recorder（UE5では非推奨）という機能があります。そして、Skeletal Mesh Componentを持つActorをその記録対象にすると、記録中の動きをAnimation Sequenceアセットとして保存してくれます。

ブログ記事用：TakeRecorderで記録すると、キャラの動きがアニメーションアセットとして保存される様子 pic.twitter.com/qPc2litlkG

— おかず (@pafuhana1213) July 8, 2022

また、Persona（アニメーションエディタ）の録画機能とデバッグ機能を併用することで、こちらでも実行中のキャラのアニメーションを録画することができます。

ブログ記事用：PersonaのAttach, 録画機能を使って、実行中のキャラのアニメーションを記録している様子 pic.twitter.com/vz6lnjTn5R

— おかず (@pafuhana1213) July 8, 2022

上記の機能により、Sequencer上で調整したアニメーションやAnim BPによる物理制御・補正込みの結果をAnimationSequenceアセットに保存（ベイク）することができます。

しかし、ただアニメーションをベイクしたいだけなのに機能が多すぎたり、下準備がある程度必要だったりします。一応TakeRecorderに関するノードはいくつかあるので下準備を自動化はできますが、痒い所に少し手が届かないというお話を先日いただきました。

そういった方に便利なのが、今日紹介する Animation Recorder です！
これをEditorUtility機能と併用することで、自作のアニメーション録画ツールをかんたんに作ることができます！

自動的にSequencerエディタ再生 & アニメーション録画開始して、再生終了したら自動的に録画終了するEUW

ABPによる物理骨付きの挙動をベイクしたいけど、SequenceRecorder, Take Recorderだと少し複雑・準備が大変という話を聞いて作ってみました～。需要あれば少し整えて公開します#UE5 #UEE5Study pic.twitter.com/ZdQPF6JX63

— おかず (@pafuhana1213) July 5, 2022

Animation Recorderとは

その名の通りアニメーションを録画するための機能で、Take Recorder、Sequence Recorder、Personaの録画機能で使われています。なので、決して怪しい機能ではありませんし、録画対象のSkeletalMeshComponentをAnimation Recorderに渡すだけで良いという非常な便利な機能です！

ただ…C++は必須です。でも凄くかんたんです。

Animation Recorderのつかいかた

エディタモジュールの準備

Animation Recorderはエディタ専用機能なので、エディタ用モジュールでAnimation Recorderにアクセスする処理を実装した方が安全です。たぶんランタイムモジュールでも動作しますが、パッケージ作成時に問題になるはずです。

エディタモジュールの作成方法については下記記事を参考にするか、

こちらの無料プラグインを使うのがオススメです。サクッとモジュールを追加できるので重宝してます。

Animation Recorderによる録画開始・終了処理を実装

作成したエディタモジュールにBlueprintFunctionLibraryを追加し、下記のように録画開始・終了をリクエストする処理を組みます。それぞれ一行コードを呼ぶだけなので超かんたんです。

UMyBlueprintFunctionLibrary

// Build.cs
PublicDependencyModuleNames に "SequenceRecorder" 追加

// h
UFUNCTION(BlueprintCallable)
static bool RecordAnimation(USkeletalMeshComponent* Component, const FString& AssetPath, const FString& AssetName);

UFUNCTION(BlueprintCallable)
static void StopRecordingAllAnimations();

UFUNCTION(BlueprintCallable)
static void StopRecordingAnimation(USkeletalMeshComponent* Component, bool bShowMessage = true);

// cpp
#include "AnimationRecorder.h"

bool UMyBlueprintFunctionLibrary::RecordAnimation(USkeletalMeshComponent* Component, const FString& AssetPath, const FString& AssetName)
{
   return FAnimationRecorderManager::Get().RecordAnimation(Component, AssetPath, AssetName, GetDefault<USequenceRecorderSettings>()->DefaultAnimationSettings);
}

void UMyBlueprintFunctionLibrary::StopRecordingAllAnimations()
{
	FAnimationRecorderManager::Get().StopRecordingAllAnimations(); 
}

void UMyBlueprintFunctionLibrary::StopRecordingAnimation(USkeletalMeshComponent* Component, bool bShowMessage)
{
	FAnimationRecorderManager::Get().StopRecordingAnimation(Component, bShowMessage);
}

Animation Recorderによる録画開始・終了処理を呼び出し

あとは実装した各ノードを呼び出すだけです。今回はEditorUtilityWidgetにボタンを追加して、押すと録画開始・終了処理を呼ぶようにしました（説明用なのでSkeletalMeshComponentの取得がすっごく雑です）。

ブログ記事用：エンジン標準のアニメーション録画機能をEUWから直接呼び出している様子 pic.twitter.com/LUJ8nPR9K4

— おかず (@pafuhana1213) July 8, 2022

かんたんですね！
ただ、いくつか注意点があります。

• エディタ専用機能なので、EditorUtility系のBPで実装するのがオススメです。また、エディタ専用なのでパッケージでは使えません。
• 「Content/Record」に「RecordTest」というアセット名で保存したい場合、RecordAnimationに指定するAssetPathは「/Game/Record/RecordTest」、AssetNameは「RecordTest」になります。もし連番でアセット名を自動生成したい場合はAssetToolsのCreateUniqueAssetNameノードがべんりです。

使用例（FolderPath =/Game/Record、AssetNameBase = RecordTest と指定する感じ ）

• 録画フレームレート、録画最大時間などの録画設定のデフォルトは、PersonaのRecording Settingsで設定可能です。
  
  もしプログラム側で制御したい場合は、RecordAnimationに渡すFAnimationRecordingSettingsを生成・設定する必要があります。なおFAnimationRecordingSettingsはBPに対応していないので、FAnimationRecordingSettingsをBPノードの引数ピンとして使うことはできません。ので、よく似た構成の構造体などを用意する必要があります。

UMyBlueprintFunctionLibrary

bool UMyBlueprintFunctionLibrary::RecordAnimation(USkeletalMeshComponent* Component, const FString& AssetPath, const FString& AssetName)
{
   FAnimationRecordingSettings Settings = GetDefault<USequenceRecorderSettings>()->DefaultAnimationSettings;
   Settings.SampleFrameRate = XXX;
   Settings.Length = YYY;

   return FAnimationRecorderManager::Get().RecordAnimation(Component, AssetPath, AssetName, Settings);
}

ちなみに、Length（単位は秒）は最大録画時間なので決められた時間・範囲だけ録画したいというケースで非常に有用です。

• アニメーション録画は複数同時に実行することができます。また、アニメーション録画を終了してアセットが生成される際にヒッチ（処理が重くてカクつく）が発生します。そして、そのタイミングで別のアニメーション録画処理が走っているとその録画処理が正常に行われない場合があります。そのため、「複数のアニメーションを同時に録画したい」「Sequencerで実装したアニメーションをサブシーケンス毎に録画したい」といったケースでは、StopRecording~は全録画対象のアニメーションが再生し終わってから呼ぶ方が安定する印象です。なお、その際は上述の最大録画時間を設定しないと録画時間が無駄に伸びてしまうので注意です。

さいごに

これで自作のアニメーション録画ツールを作れるようになります。ただ前半で紹介した例のように、アニメーション録画とSequencerと組み合わせる場合はもう少し機能が必要です。具体的には現在開いているSequencerエディタに干渉したり、LevelSequenceの各TrackやSecitonの情報を取ってくる必要があります。
この辺りに関しても質問をいただくことが多くなってきたので、次回以降はその辺りについてご紹介できればと思います。

おしまい

追記

今回紹介した機能などを使ったサンプルを公開しました

以前にツイートした、自作アニメーション録画ツールをサンプルとしてGithubに公開しました！https://t.co/lZLCMN1jq3

たぶん映像系のプロジェクトで役に立つ気がします。あと、EditorUtility機能を使ってSequencer作業を楽したい人にも参考になると思います。詳細はGithubのページで#UE5 #UE5Study https://t.co/fhnf33ccDJ pic.twitter.com/ANDIEyPMfX

— おかず (@pafuhana1213) July 22, 2022