シーンとライフサイクル — ドキュメント

シーンの契約

シーンは EngineContext を参照で受け取り、開始、更新、描画の方法を定義します。基準リビジョンには次の契約があります。

class Scene {
protected:
  EngineContext &ctx;

public:
  Scene(EngineContext &context) : ctx(context) {}
  virtual ~Scene() = default;

  virtual void Start() = 0;
  virtual void Update() = 0;
  virtual void Render() const = 0;

  virtual void OnEvent(const sf::Event &) {};
  virtual void OnPause(bool /* pausa */) {};
  virtual void OnCleanup() {};
};

Start、Update、Render は必須です。そのほかのコールバックには空の実装があり、ゲームが必要とするときだけオーバーライドします。

各段階の責務

段階	実行されるタイミング	ゲームでの用途
コンストラクター	最初のシーン登録表を作るとき。	インスタンスのオブジェクトとリソースを準備します。
`Start`	シーンを有効化または再開始するとき。	ゲームをリセットし、操作を登録します。
`OnEvent`	オーバーレイが非表示の状態でイベントを受け取るとき。	ゲームの個別イベントを処理します。
`Update`	フォーカスがあり、オーバーレイが非表示の各フレーム。	ロジック、移動、状態を進めます。
`Render`	アクティブなシーンのフレームを描くとき。	オブジェクトを `ctx.renderer` に渡します。
`OnPause`	一時停止状態が変わったとき。	シーンが管理する要素を停止または再開します。
`OnCleanup`	シーンを離れる、または再開始する前。	音声を止め、引き継ぐべきでない状態を片付けます。

コンストラクターと Start は同じではありません。インスタンスは登録表に残り、Start が何度も呼ばれることがあります。

ゲームの登録

SceneFactory::Scenes は、名前と unique_ptr<Scene> を対応付ける unordered_map です。ファクトリーは 7 つのインスタンスを登録します。

scenes.emplace("Bounce", std::make_unique<Bounce::Game>(context));
scenes.emplace("Clicker", std::make_unique<Clicker::Game>(context));
scenes.emplace("MemoryCard", std::make_unique<MemoryCard::Game>(context));
scenes.emplace("TicTacToe", std::make_unique<TicTacToe::Game>(context));
scenes.emplace("MineSweeper", std::make_unique<MineSweeper::Game>(context));
scenes.emplace("Runner", std::make_unique<Runner::Game>(context));
scenes.emplace("Tetris", std::make_unique<Tetris::Game>(context));

対象リビジョンは Engine のコンストラクターで Tetris を要求します。名前は登録表の正確なキーです。不明なシーン名に対する復旧処理は実装されていません。

遅延遷移

SceneManager::ChangeScene は、ほかの切り替えがまだ保留されていなければ要求された名前を保存します。Engine は次のイベント処理の開始時に、その要求を取り出します。

ChangeScene(名前)
     ↓
保留中の要求
     ↓
次の ProcessEvent
     ↓
前のシーンの OnCleanup
     ↓
パーティクルと入力バインディングを消去
     ↓
アクティブなポインターを切り替え
     ↓
要求されたシーンの Start
     ↓
一時停止状態を同期

RestartCurrentScene は現在の名前で同じ仕組みを使います。オブジェクトを破棄して作り直すのではありません。そのため Start は、繰り返し呼ばれてもゲームを有効な状態に戻す必要があります。

実際の実装を調べる

Bounce は、ゲームクラスがコンテキストを受け取り、パドルと統計値を準備し、効果音と音楽を要求して、シーンのコールバックを利用する方法を示しています。

自分のコピーにシーンを追加するには、既存の分離方法に従います。宣言は Games/Include、実装は Games/Source、明示的な登録は SceneFactory.cpp に置きます。CMake は GLOB_RECURSE CONFIGURE_DEPENDS でこれらのフォルダーの .cpp を検出します。実行時に読み込むシーンプラグインはありません。

メニューへのアクセス制限

オーバーレイには Menu ボタンがあり、ショートカット M も同じ処理を呼び出します。Engine は Menu というシーンを要求しますが、このリビジョンのファクトリーには登録されていません。このバージョンを調べる際は、その操作を避けてください。存在しないキーによってアサーションや例外が発生する可能性があります。

このドキュメントでは、その制限を明示しています。利用可能なゲーム選択メニューとしては紹介していません。