目次 このページのソースコードを表示
公開日:
更新日:

nodec_game_engineで、新規にコンポーネントを追加する方法を説明します。

環境

このチュートリアルでは、以下の環境での操作を想定しています。

サンプルプロジェクト

目的

nodec_game_engineでは、ECS(Entity Component System)を採用しています。このため、ゲームオブジェクトは、コンポーネントを持つことで機能を実現します。

このチュートリアルでは、新規にコンポーネントを追加する方法を説明します。ここでは、敵を表すコンポーネント(Enemy)を追加してみましょう。

手順

1. コンポーネントクラスを作成する

プロジェクトディレクトリ内のsrc/componentsディレクトリに、enemy.hppを新しく作成し、以下の内容を記述します。

        // (1)
        #ifndef HELLO_NODEC_GAME__COMPONENTS__ENEMY_HPP_
        #define HELLO_NODEC_GAME__COMPONENTS__ENEMY_HPP_

        #include <nodec_scene_serialization/serializable_component.hpp>

        namespace hello_nodec_game {
        namespace components { // (2)

        // (3)
        struct Enemy : public nodec_scene_serialization::BaseSerializableComponent {
            // (4)
            Enemy()
                : BaseSerializableComponent(this) {}

            // (5)
            float hp{100.f}

            // (6)
            template<class Archive>
            void serialize(Archive &archive) {
                archive(cereal::make_nvp("hp", hp));
            }
        };

        } // namespace components
        } // namespace hello_nodec_game

        // (7)
        NODEC_SCENE_REGISTER_SERIALIZABLE_COMPONENT(hello_nodec_game::components::Enemy)

        #endif
説明
(1)

インクルードガードを記述します。

多くの場合、<プロジェクト名>__<名前空間パス>__<ファイル名>_という形式で、インクルードガードを記述します[注 1]

(2)

hello_nodec_game名前空間内に、components名前空間を作成します。

この名前空間内に、コンポーネントクラスを記述します。

(3)

Enemyクラスを定義します。

nodec_scene_serialization::BaseSerializableComponentを継承しています。

nodec_scene_serialization::BaseSerializableComponentは、nodec_scene_serializationライブラリによって提供される、シリアライズ可能なコンポーネントの基底クラスです。

nodec_scene_serialization::BaseSerializableComponentを継承することで、シリアライズ可能なコンポーネントとして振る舞うことができます。

シリアライズ可能なコンポーネントになることで以下のことが可能になります。

  • コンポーネントの内容をファイルに保存し、読み込むことができる
  • エディタ上やスクリプト等で動的にコンポーネントを複製することができる
  • アニメーション等でプロパティ名によって動的に値を変更することができる
(4)

nodec_scene_serialization::BaseSerializableComponentのコンストラクタに、thisを渡しています。これは、継承元のBaseSerializableComponentが派生先の型情報を取得するために必要です。

(5)

hpというメンバ変数を定義しています。Enemyコンポーネントとして持つべき情報を定義していきます。

(6)

serializeメンバ関数を定義しています。シリアライズ可能なコンポーネントとして振る舞うためには、この関数を定義する必要があります。

cereal::make_nvpマクロを使って、hpメンバ変数をシリアライズしています。cereal::make_nvpマクロの第一引数に、プロパティ名を指定し、第二引数に、シリアライズする変数を指定します。プロパティ名は、メンバー変数名と同じにすることを推奨します。

(7)

NODEC_SCENE_REGISTER_SERIALIZABLE_COMPONENTマクロを使って、Enemyクラスを登録しています。このマクロを使うことで、シリアライズ可能なコンポーネントとして振る舞うことができます。

2. コンポーネントクラスをシリアライズシステムに登録する

EnemyクラスはBaseSerializableComponentを継承しており、シリアライズ可能なクラスですが、エンジンにこのクラスがシリアライズ可能なクラスであることを伝える必要があります。

src/app.cpp内のRegister components in serialization.ブロック内で以下を追記します。

            // Register components in serialization.
            {
                scene_serialization_.register_component<Bullet>();
                scene_serialization_.register_component<PlayerControl>();
                scene_serialization_.register_component<Enemy>(); // 追記
            }

3. (オプション) エディタにコンポーネントを登録する

追加で、エディタにコンポーネントを登録することで以下のことが行えます。

  • エディタ上でコンポーネントを追加できるようになる
  • エディタ上でコンポーネントのプロパティを編集できるようになる

Enemyコンポーネント用のエディタクラスを定義します。src/editors/ディレクトリ内に、enemy_editor.hppを新しく作成し、以下の内容を記述します。

            #ifndef HELLO_NODEC_GAME__EDITORS__ENEMY_EDITOR_HPP_
            #define HELLO_NODEC_GAME__EDITORS__ENEMY_EDITOR_HPP_

            // (1)
            #include <imgui.h>

            // (2)
            #include <nodec_scene_editor/component_editor.hpp>

            // (3)
            #include "../components/enemy.hpp"

            namespace hello_nodec_game {
            namespace editors {

            // (4)
            class EnemyEditor
                : public nodec_scene_editor::BasicComponentEditor<components::Enemy> {
            public:
                // (5)
                void on_inspector_gui(components::Enemy &enemy,
                                    const nodec_scene_editor::InspectorGuiContext &context) override {
                    // (6)
                    ImGui::DragFloat("Hp", &enemy.hp);
                }
            };

            } // namespace editors
            } // namespace hello_nodec_game
            #endif
説明
(1)

imguiライブラリをインクルードします。

imguiライブラリは、エディタのGUIを構築するためのライブラリです。

(2)

nodec_scene_editor/component_editor.hppをインクルードします。

component_editor.hppには、コンポーネントエディタの基底クラスが定義されています。

(3)

Enemyコンポーネントをインクルードします。

(4)

EnemyEditorクラスを定義します。

nodec_scene_editor::BasicComponentEditorを継承しています。

nodec_scene_editor::BasicComponentEditorは、nodec_scene_editorライブラリによって提供される、コンポーネントエディタの基底クラスです。

nodec_scene_editor::BasicComponentEditorを継承することで、コンポーネントエディタとして振る舞うことができます。

(5)

on_inspector_guiメンバ関数を定義しています。

nodec_scene_editor::BasicComponentEditorの仮想関数です。

この関数をオーバーライドすることで、コンポーネントのプロパティを編集するGUIを構築することができます。GUIは、Entity Inspectorウィンドウに表示されます。

この関数の第一引数には、編集するコンポーネントの参照が渡されます。この関数の第二引数には、エディタのGUI構築に必要な情報が渡されます。

この関数内で、imguiライブラリを使ってGUIを構築します。imguiライブラリの使い方については、公式ドキュメントを参照してください。

(6)

imguiライブラリを使って、hpメンバ変数を編集するGUIを構築しています。

エディタ上で表示されるプロパティ名は、単語始まりを大文字にし、境界をスペースで区切ることを推奨します。

最後に、エディタにEnemyEditorクラスを登録します。src/app.cpp内で以下を追記します。

        // ...

        #ifdef EDITOR_MODE
        #    include "editors/player_editor.hpp"
        #    include "editors/enemy_editor.hpp" // 追記(1)
        #endif

        // ...

        // (HelloNodecGameApplicationコンストラクタ内)
        #ifdef EDITOR_MODE
                // Set up systems if editor mode enabled.
                {
                    using namespace nodec_scene_editor;
                    using namespace editors;
                    auto &editor = app.get_service<SceneEditor>();

                    editor.component_registry().register_component<PlayerControl, PlayerControlEditor>("Player Control");
                    editor.component_registry().register_component<Bullet>("Bullet");
                    editor.component_registry().register_component<Enemy, EnemyEditor>("Enemy"); // 追記(2)
                }
        #endif

        // ...
説明
(1)

EnemyEditorクラスをインクルードします。

ゲームリリース時には、多くの場合エディタ機能が不要のため、EDITOR_MODEマクロが定義されている(ゲーム開発中)場合のみ、このファイルをインクルードします。

(2)

EnemyEditorクラスを登録します。

EnemyEditorクラスを登録することで、エディタ上でEnemyコンポーネントを編集することができるようになります。register_component関数の第一引数には、編集するコンポーネントの表示名を指定します。名前は、単語始まりを大文字にし、境界をスペースで区切ることを推奨します。

注釈

  1. ^ GoogleのC++コーディングガイドラインをもとにしています。単語間の区切りは、アンダースコア2つで表しています。単語内境界と区別するためです。
「https://contentsviewer.work/Master/nodec-game-engine/scripting/add_component/docs」から取得