Skip to content

Latest commit

 

History

History
138 lines (100 loc) · 5.36 KB

README.md

File metadata and controls

138 lines (100 loc) · 5.36 KB
Raw

Build Status Coverage Status MIT License

GTFramework

Goluah Task Framework ver1.50a

「Goluah!」から流用したゲーム開発向け汎用タスクシステム

タスクのリスト式管理・検索・優先度つきの描画などが高速に行えます。

導入方法

src/systemフォルダ以下をプロジェクト内にコピーして使用してください。

ライブラリをbuildするMakefile等は今のところありません。

簡単な使い方

タスク用クラスの定義

タスク用の基礎クラスを継承することで、GTFrameworkで管理することの出来るタスククラスを生成することが出来ます。

#include "task.h"

class NewTask : gtf::TaskBase
{
    virtual void Initialize() override                   // 初期化時の処理
    {
        // タスク追加処理など
    }
    
    virtual bool Execute(double elapsedTime) override    // 実行時の処理
    {
        // do something
        return true;
    }
    
    virtual unsigned int GetID() const override
    {
        return 12;
    }
};

GTFrameworkには3種類の基礎クラスがあります。

  • gtf::TaskBase 通常タスク（下記の排他タスクに依存して（子タスクとして）振る舞う。　親排他タスクが実行中の時のみ実行される。　シーン中のオブジェクトなど。）
  • gtf::ExclusiveTaskBase 排他タスク（他の排他タスクと同時に実行されない。　スタック可能。　シーン遷移などに。）
  • gtf::BackgroundTaskBase 常駐タスク（タスク階層に依存せずに常時実行されるタスク）

これらの使い分けの詳細については，下記のリファレンスをご参照ください。

タスクが初期化され、実行可能な状態になるとInitializeメソッドが実行されます。 排他タスクの場合、生成直後にはタスクがアクティブにならないため、子タスクの生成処理などはこの関数の内部で行うようにしてください。

タスクが実行されるとExecuteメソッドが実行され、falseを返すとそのタスクは破棄されます。

GetIDメソッドは、タスクに個別のIDを付けたいときに使えます（0にすると未設定扱いとなりますのでご注意ください。）

初期化・実行

    gtf::TaskManager taskManager;
    
    taskManager.AddNewTask<NewTask>();

gtf::TaskManagerクラスをインスタンス化するとタスクを管理できるようになります。

gtf::TaskManager::AddNewTaskメソッドにテンプレート引数としてクラスをわたすと、タスクが自動で生成されます。 括弧の中に引数を記述すると、タスクのコンストラクタ引数として初期化時に渡すことが出来ます。

    taskManager.AddNewTask<NewArgumentTask>(12, 2, "String");

タスクをすべて実行するにはgtf::TaskManager::Executeメソッドを使います。

    taskManager.Execute(0);

検索

    auto p = taskManager.FindTask<NewTask>(12);

gtf::TaskManager::FindTaskメソッドを使用すると、指定したIDのタスクのスマートポインタが手に入ります。 テンプレート引数としてタスクのクラス型を指定すると、動的キャストを行い、指定された型のshared_ptrを返します。 ただし排他タスクの検索は出来ません。

描画(優先度付き)

#include "task.h"

class NewTask : gtf::TaskBase
{
    virtual void Draw() override    // Draw実行時の処理
    {
        // do something
    }
    
    virtual int GetDrawPriority() const override
    {
        return 0;    // 描画の優先度。数値の大きいものから先に処理される。-1で無効。
    }
};

Drawメソッドを使うには、GetDrawPriorityメソッドをオーバーライドして、 あらかじめ優先度を定義しておく必要があります。

描画は(別に描画処理でなくてもいいのですが)優先度の数値が大きい順に処理され、-1のものは処理されません。

すべてのタスクのDrawメソッドを実行するには、gtf::TaskManagerクラスのDrawメソッドを使います。

    taskManager.Draw();

排他タスクの生成時、コンストラクタ引数fallthroughDrawにtrueを指定して生成すると、Draw処理のフォールスルーが行われるようになります。 この状態でDraw処理がコールされると、一つ下の階層のタスクも含めて描画することが出来ます。

class NewExTask : gtf::ExcusiveTaskBase
{
    NewExTask() : gtf::ExcusiveTaskBase(true)
    {
        // do something
        return true;
    }
};

リファレンス：

http://at-sushi.github.io/GTFramework/

詳しいことはこちらをご参照ください。