SFXCallback

コールバック関数を扱うためのクラスです。

#include <SFXCallback.h.hpp>

class SFXCallback;

SFMTYPEDEFCLASS(SFXCallback)

解説

コールバック関数に関して、パラメータの設定と取得、登録状況の取得に使います。

参照

SFXTask | SFXTimer

メンバ

コンストラクタ/デストラクタ
SFXCallback( `Void` ) SFXCallback クラスのコンストラクタです。
~SFXCallback( `Void` ) SFXCallback クラスのデストラクタです。

パブリック関数
`Void`	Cancel( `Void` ) コールバック関数のキャンセルを行います。
static `SFXCallbackConstRef`	EmptyInstance( `Void` ) 空のコールバックを取得します。
`CallbackSPP`	GetProcedure( `Void` ) 設定しているコールバック関数を取得します。
`VoidPtr`	GetReference( `Void` ) 設定しているユーザーデータを取得します。
`Bool`	IsQueued( `Void` ) コールバック関数が登録されているか判定します。
`Void`	Set( `CallbackSPP` spp , `VoidPtr` reference ) コールバックに必要な情報を設定します。
`AEECallback *`	interface_cast( `SFXCallback *` param ) SFXCallback を AEECallback に変換します。
`AEECallback const *`	interface_cast( `SFXCallback const *` param ) SFXCallback を AEECallback に変換します。

型
CallbackSPP コールバック関数の型です。

グローバル関数
`AEECallback *`	interface_cast( `SFXCallback *` param ) SFXCallback を AEECallback に変換します。
`AEECallback const *`	interface_cast( `SFXCallback const *` param ) SFXCallback を AEECallback に変換します。

SFXCallback::SFXCallback

SFXCallback クラスのコンストラクタです。

[ public, explicit ]
SFXCallback(Void);

SFXCallback::~SFXCallback

SFXCallback クラスのデストラクタです。

[ public ]
~SFXCallback(Void);

解説

デストラクタでは登録されたコールバック関数のキャンセルを行います。

参照

SFXCallback::Cancel

SFXCallback::Cancel

コールバック関数のキャンセルを行います。

[ public ]
Void Cancel(Void);

解説

コールバック関数が登録されていない場合は何も行いません。

参照

SFXCallback::Set

SFXCallback::EmptyInstance

空のコールバックを取得します。

[ public, static ]
SFXCallbackConstRef EmptyInstance(Void);

解説

空のコールバックを表すインスタンスを取得します。

SFXCallback::GetProcedure

設定しているコールバック関数を取得します。

[ public, const ]
CallbackSPP GetProcedure(Void);

戻り値

設定しているコールバック関数を返します。

参照

SFXCallback::GetReference | SFXCallback::Set

SFXCallback::GetReference

設定しているユーザーデータを取得します。

[ public, const ]
VoidPtr GetReference(Void);

戻り値

設定しているユーザーデータを返します。

参照

SFXCallback::GetReference | SFXCallback::Set

SFXCallback::IsQueued

コールバック関数が登録されているか判定します。

[ public, const ]
Bool IsQueued(Void);

戻り値

登録されているとき : true
登録されていないとき : false

SFXCallback::Set

コールバックに必要な情報を設定します。

[ public ]
Void Set(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // ユーザーデータ
);

参照

SFXCallback::GetProcedure | SFXCallback::GetReference

interface_cast

SFXCallback を AEECallback に変換します。

[ public, friend ]
AEECallback * interface_cast(
    SFXCallback * param   // キャストするコールバック
);

[ public, friend ]
AEECallback const * interface_cast(
    SFXCallback const * param   // キャストするコールバック
);

SFXCallback::CallbackSPP

コールバック関数の型です。

typedef Void(* SFXCallback::CallbackSPP)(VoidPtr reference)