最小構成でのタスクリスト

考え方

ドローンのようなアバター
重力とかなし
障害物との干渉は一旦なしで
シミュレーション開始するだけ（停止、リセットはなし）

タスクリスト

[x] Unreal Engineのインストール
[x] Unreal Engineエディタを起動して、保存できるようになる
[x] #16
[x] #17
[x] #18
[x] シミュレーションの状態遷移の把握
[x] #19
[x] #20

以降は、こちらで対応します。

https://github.com/toppers/hakoniwa-unreal-simasset-plugin/issues/1

Unreal Engine をインストールする

https://docs.unrealengine.com/4.27/ja/Basics/InstallingUnrealEngine/

version

スクリーンショット 2024-01-14 15 36 35

起動方法

Epic GamesというアプリがUnity Hubに対応していると思われる。

起動ボタンをクリック（バージョン選択できる）

起動ボタンを押下すると、Epic Gamesアプリが落ちて、プロジェクトブラウザが開く。

Unreal Engineエディタを起動して、保存できるようになる

ゴール

プリミティブなオブジェクトをシーンに配置して、シミュレーション実行できるようになる

新規プロジェクト作成方法

プロジェクトブラウザで、ゲーム タブを選択して、「ブランク」を選んで、プロジェクトデフォルトを C++ にする。スターターコンテンツのチェックは外す。

カテゴリは、「シミュレーション」にすること！

XCodeが起動し、コンパイルが走り出す。

起動した！

保存方法

画面左上のタブの名前が、最初、「名称未設定」とあったが、保存ボタンをクリックして、名前を入れたら変わった。初期プロジェクトでは、マップの新規作成まではやってくれるけれど、永続化されない状態なんだな。

スクリーンショット 2024-01-15 6 31 31

シミュレーションの状態遷移の把握

追加の注意点：

Unreal EngineのTick:
- Tickは毎フレーム呼び出されますが、フレームレートに依存します。固定された時間間隔での更新（UnityのFixedUpdateに似た）は、Tick内でデルタタイムを使って管理するか、独立したタイマーを使って実現することができます。
初期化関数:
- Unreal EngineのBeginPlayはUnityのStartに似ていますが、いくつかの違いがあります。例えば、Unreal EngineではアクタのコンストラクタやPostInitializeComponentsも初期化のために重要です。
物理更新:
- Unreal Engineでは物理シミュレーションは自動的に管理されますが、必要に応じてTick関数内で時間間隔を制御することにより、固定された更新レートを実現することが可能です。

Q

シミュレーションを停止させた場合、UE側のシミュレーションも一時停止させて時間も進まなくしたいのですが、可能でしょうか

A

はい、Unreal Engineでシミュレーションを一時停止させることは可能です。一時停止中は、ゲームの時間も進行しなくなります。これを実現するには、主にゲームの世界（UWorldオブジェクト）を操作することになります。

シミュレーションの一時停止方法

SetPause関数の使用:
- UWorldクラスのSetPause関数を使用してゲームを一時停止させることができます。
- 一時停止を有効にするには、以下のようにコードを記述します：
```
GetWorld()->SetPause(true);
```
- シミュレーションを再開するには、falseを引数として渡します：
```
GetWorld()->SetPause(false);
```
ブループリントでの実装:
- ブループリントでも同様の機能を使用してゲームを一時停止および再開することができます。
- 「Set Game Paused」というノードを使用して一時停止の状態を切り替えます。

シミュレーション時間の挙動

ゲームが一時停止されると、Tick関数は呼び出されなくなり、ゲーム時間も進行しません。
GetTimeSecondsなどの時間関数も一時停止中は時間を進めません。

注意点

ゲームを一時停止すると、ゲーム内のすべての動作が停止します。ただし、一部のシステムやコンポーネントは、一時停止の状態を特別に扱うように設計する必要があるかもしれません。
一時停止中もユーザーインターフェースや特定のシステムが動作し続けるようにしたい場合は、追加のロジックが必要になることがあります。

これにより、外部シミュレーションの状態に応じてUnreal Engineのシミュレーションを一時停止および再開することが可能になります。また、この機能を使って、ユーザーによる手動の一時停止/再開操作も実装できます。

Q

シミュレーション時間として適切なのは、GetTimeSecondsですね。シミュレーション停止させたときに、連動して時間が停止するので。

A

はい、正確にはその通りです。GetTimeSeconds関数は、Unreal EngineのUWorldクラスが提供するメソッドで、ゲームが開始してからの総経過時間（秒）を返します。この関数はゲームが一時停止された際にも時間の進行を停止するため、シミュレーション時間として適切です。

`GetTimeSeconds`関数の特徴

シミュレーション時間の追跡:
- ゲームの実行開始からの経過時間を追跡します。ゲームの一時停止時には、この時間も停止します。
ゲームの状態との連動:
- ゲームの一時停止や再開が、GetTimeSecondsで得られる時間に直接反映されます。

シミュレーションの一時停止と再開

ゲームを一時停止する際には、UWorldオブジェクトのSetPause関数を使用します。
ゲームを再開する場合は、同じくSetPause関数にfalseを渡して再開します。

注意点

シミュレーションの一時停止と再開は、Tick関数の呼び出しにも影響します。一時停止中はTick関数は実行されません。
一時停止中にも更新が必要なシステムやコンポーネントがある場合は、追加のロジックを実装する必要があります。

GetTimeSecondsを使用することで、ゲーム内のシミュレーション時間を正確に追跡し、外部シミュレーションシステムとの時間同期を行うことが可能になります。これにより、ゲームのビジュアライズと外部シミュレーションのデータを効果的に組み合わせることができます。

Q

シミュレーション再開させるには、独立して駆動するスレッドかイベントコールバックが必要ですよね。

A

シミュレーションを再開させるためには、確かに独立して駆動するスレッドやイベントコールバックが必要になる場合があります。Unreal Engineにおけるシミュレーションの一時停止と再開の実装は、ゲームの具体的な要件や設計によって異なりますが、以下の方法が考えられます。

スレッドによる実装

独立したスレッド:
- Unreal Engineでは、C++を使用して独立したスレッドを作成し、そのスレッドでシミュレーションの制御を行うことが可能です。
- スレッドは、シミュレーションの状態を監視し、必要に応じてメインゲームスレッドにシミュレーションの一時停止や再開の命令を送ることができます。

イベントコールバックによる実装

イベント駆動のアプローチ:
- ゲーム内の特定のイベント（例えばユーザー入力、特定のゲーム状態の変更など）に応じて、シミュレーションの一時停止や再開をトリガーすることができます。
- これはブループリントやC++コードで実装でき、特定のイベントが発生した際にSetPause関数を呼び出してゲームの状態を制御します。

カスタムコントローラーまたはマネージャーの使用

シミュレーションコントローラー:
- シミュレーションを管理するカスタムのコントローラーやマネージャークラスを作成することもできます。
- このコントローラーは、シミュレーションの状態を追跡し、外部システムとの通信を通じて一時停止や再開のコマンドを処理します。

注意点

マルチスレッドの複雑さ:
- マルチスレッドの実装は非常に複雑であり、データの競合や同期の問題に注意が必要です。
イベントの適切な管理:
- シミュレーションを制御するためのイベントやトリガーを正確に管理し、ゲームの他の部分との干渉を避ける必要があります。

ゲームの具体的な要件に応じて、これらの方法を組み合わせることで、シミュレーションの一時停止と再開を効果的に制御できます。また、Unreal Engineの機能を最大限に活用し、パフォーマンスと安定性を確保することが重要です。

つぶやき

うーん、外部から不定期にくるイベントを監視するとなると、スレッドしかないですね。

A

外部から不定期に来るイベントを監視する場合、確かに独立したスレッドを使用するのが一つの有効な解決策です。Unreal Engineでマルチスレッディングを実装する際には、特に同期やデータ共有における安全性に注意を払う必要があります。

スレッドを使用したイベント監視の実装

独立した監視スレッドの作成:
- 外部イベントをリッスンするために専用のスレッドを作成します。
- このスレッドは、外部ソースからのイベントやデータを継続的に監視し、それに応じてゲームエンジン内でのアクションをトリガーします。
スレッド間通信:
- Unreal Engineのメインゲームスレッドと監視スレッド間で適切にデータを共有し、コマンドを伝達するための安全なスレッド間通信メカニズムを実装します。
- 例えば、スレッドセーフなキューやイベント通知システムを利用できます。
エラーハンドリングと同期:
- マルチスレッディングでは、エラーハンドリングとデータの競合を防ぐための適切な同期メカニズムが必要です。
- Unreal Engineにはスレッドセーフなクラスや機能が提供されていますが、それらを正確に理解し使用する必要があります。

注意点

パフォーマンスとリソース管理:
- スレッドを多用すると、パフォーマンスに影響を与える可能性があります。リソースの使用状況とパフォーマンスを常に監視することが重要です。
デッドロックと競合の防止:
- スレッド間でデータを共有する際は、デッドロックやデータの競合を防ぐために注意が必要です。
スレッドのライフサイクル管理:
- スレッドの生成と破棄を適切に管理し、メモリリークやリソースの不適切な使用を避ける必要があります。

マルチスレッディングは強力なツールですが、複雑さとリスクも伴います。実装には慎重さと適切なプログラミング手法が求められます。Unreal Engineのドキュメントやコミュニティのリソースを活用して、最適な実装方法を探求してください。

Q

UEは、マルチスレッド対応に特化した適切なライブラリ群を用意しているのではないでしょうか？

A

はい、Unreal Engineはマルチスレッディングに関連するいくつかの特化したライブラリやフレームワークを提供しています。これらは、マルチスレッド処理のための安全で効率的な機能を開発者に提供することを目的としています。

Unreal Engineのマルチスレッディング関連の主な機能

タスクベースのマルチスレッディング:
- Unreal Engineでは、FTaskGraphInterfaceを使用してタスクベースのマルチスレッディングがサポートされています。
- これにより、開発者は個々のタスクを定義し、エンジンによって管理されるスレッドプールで実行させることができます。
スレッドセーフなコンテナ:
- Unreal Engineにはスレッドセーフなコンテナクラス（例：TQueue, TArray, etc.）があります。
- これらのコンテナは、データのスレッド間共有時に発生する競合を防ぐために設計されています。
スレッドセーフなプリミティブ:
- スレッド間の同期や排他制御のために、FCriticalSection, FEvent, FMutex などのスレッドセーフなプリミティブが提供されています。
非同期処理:
- FAsyncTaskやFRunnableインターフェイスを使用することで、独立したスレッドでの非同期処理が可能です。
Async や Future の使用:
- C++11のstd::futureやstd::asyncのような、非同期タスクを管理するための機能も提供されています。

パフォーマンスと安全性

Unreal Engineのマルチスレッド機能は、パフォーマンスと安全性を考慮して設計されています。
スレッドセーフな設計を行うことで、データの競合やデッドロックのリスクを低減できます。

注意点

Unreal Engineのマルチスレッド機能は、そのAPIの特定の側面や制限に精通している必要があります。
Unreal Engineのメインスレッドでのみ安全に実行できるAPIもあるため、マルチスレッド実装時はこれらの点に注意が必要です。

これらのマルチスレッド機能を適切に使用することで、効率的かつ安全なマルチスレッド処理をUnreal Engine内で実現できるでしょう。Linuxカーネル開発のご経験を活かして、これらの高度な機能を効果的に利用されることをお勧めします。

箱庭のUE対応設計について

大体、全体設計が見えてきました。

UEでは、各アクターが独立してTickタイミングで動作します。箱庭としては、箱庭管理のアクターをちゃんと管理したいので、ルートアクターを用意します。そして、ルートアクターのtickから、各アクターの制御を行います。

各アクターは、箱庭の外部データ通信をします。

そして、箱庭のシミュレーションイベント監視は、専用スレッドを用意して、イベント監視させます。箱庭からのシミュレーション開始や停止イベントです。これらのイベント通知を受けたら、UE側のシミュレーションの開始や停止させます。

こんな感じで行けますか？

A

お考えの設計はUnreal Engineのフレームワーク内で実現可能であり、効率的なアプローチのようです。以下は、提案された設計の各要素に関するいくつかの具体的な考慮事項です。

ルートアクターの使用

ルートアクターを使用して他のアクターを管理することは、ゲームロジックの中心点を作成する効果的な方法です。
ルートアクターのTick関数で、他のアクターの状態を更新したり、特定のロジックを実行したりすることができます。
この中央集権的なアプローチは、シミュレーションの全体的な制御と調整に有用です。

各アクターの外部データ通信

各アクターが外部と通信する設計は、分散型のデータ処理に適しています。
外部システムとのインターフェースは、ネットワーキングやデータ同期の観点から注意深く設計する必要があります。
スレッドセーフなデータアクセスとエラーハンドリングに特に注意が必要です。

専用イベント監視スレッド

イベント監視用の専用スレッドは、シミュレーションの状態変更を監視するのに適しています。
このスレッドは、シミュレーションの開始、停止、その他の重要なイベントを監視し、適切なアクションをトリガーする責務を持ちます。
スレッド間通信と同期のための適切なメカニズムを設計する必要があります。

UEのシミュレーション制御

Unreal Engineのシミュレーションの一時停止や再開は、イベント監視スレッドから適切にトリガーされるべきです。
ゲームの一時停止や再開は、SetPause関数などを使用して実装できます。

総合的な考慮事項

このような設計では、パフォーマンス、リソース管理、スレッドの安全性が重要な要素になります。
Unreal Engineの各種APIとの互換性も考慮し、エンジンの機能を最大限活用することが重要です。

全体的に、ご提案された設計は、シミュレーションの中央集権的な制御と各アクターの分散型の動作を適切に組み合わせています。これにより、複雑なシミュレーションを効果的に管理し、Unreal Engineの強力な

ビジュアライゼーション機能を活用することができるでしょう。また、専用のイベント監視スレッドを使用することで、シミュレーションの状態管理をより効果的に行えます。

ただし、各アクターが外部データと通信する際や、専用イベント監視スレッドを使用する際には、スレッドセーフなプログラミングや効率的なリソース管理に注意を払う必要があります。また、シミュレーションの一時停止や再開に関連するUnreal EngineのAPIを適切に利用することで、シミュレーションの制御を柔軟に行うことができます。

全体的な設計がUnreal Engineのフレームワーク内で実装可能であることを考えると、プロジェクトの目的に合わせた効率的で柔軟なシミュレーション環境を構築することができそうです。

toppers / hakoniwa-base

Unreal Engine対応をしたい #14