SFXEvent

イベントを表すクラスです。

#include <SFXEvent.h.hpp>

class SFXEvent;

SFMTYPEDEFCLASS(SFXEvent)

解説

SFXEvent クラスは、イベントハンドラに送信する、イベントタイプ (＝ AEEEvent 型のイベントコード) と 2 つのイベントパラメーター( P16 パラメーターと P32 パラメーター ) からなるイベントをカプセル化しています。

例 724. SFXEvent クラスの使い方 1

// レスポンダ破棄イベントを表す
SFXEvent event(SREVT_RESPONDER_TERMINATE, SRP16_TERMINATE_INVOKE, true);

// レスポンダにイベントを送信して破棄する
responder->Invoke(event);

例 725. イベントクラスの使い方 2

SFXEvent event;

// ユーザー定義イベントを設定する場合
event.Set(SFEVT_USER + 0x01, 0, 0);

SFBShellSmp shell = SFBShell::GetInstance();

// 自分自身にユーザー定義イベントを送信する
shell->PostEvent(GetClassID(), event);

参照

SFXEventRange | SFCEventEnum

メンバ

コンストラクタ/デストラクタ
SFXEvent( `Void` ) SFXEvent( `SFXEventConstRef` param ) SFXEvent( `AEEEvent` type , `UInt16` p16 , `UInt32` p32 ) SFXEvent クラスのコンストラクタです。

パブリック関数
`Bool`	Equals( `SFXEventConstRef` param ) Equals( `AEEEvent` type , `UInt16` p16 , `UInt32` p32 ) 2 つの SFXEvent が等しいか判定します。
`Bool`	EqualsTypeP16( `SFXEventConstRef` param ) EqualsTypeP16( `AEEEvent` type , `UInt16` p16 ) イベントタイプと P16 パラメーターが指定した値と一致しているか判定します。
`UInt16`	GetP16( `Void` ) P16 パラメーターを取得します。
`UInt32`	GetP32( `Void` ) 32 ビットパラメーターを取得します。
`AEEEvent`	GetType( `Void` ) イベントタイプを取得します。
static `SFXEventConstRef`	NoneInstance( `Void` ) SFEVT_NONE を表すインスタンスを返します。
`Void`	Set( `SFXEventConstRef` param ) Set( `AEEEvent` type , `UInt16` p16 , `UInt32` p32 ) イベントの値を設定します。
`Void`	SetP16( `UInt16` param ) P16 パラメーターを設定します。
`Void`	SetP32( `UInt32` param ) 32 ビットパラメーターを設定します。
`Void`	SetType( `AEEEvent` param ) イベントタイプを設定します。
`Void`	SetTypeP16( `AEEEvent` type , `UInt16` p16 ) イベントタイプと P16 パラメーターを設定します。
`SFXEventRef`	operator=( `SFXEventConstRef` param ) SFXEvent を代入します。
`SFXEvent::AtomRec *`	atomic_cast( `SFXEvent *` param ) SFXEvent を SFXEvent::AtomRec に変換します。
`SFXEvent::AtomRec const *`	atomic_cast( `SFXEvent const *` param ) SFXEvent を SFXEvent::AtomRec に変換します。
`Bool`	operator==( `SFXEventConstRef` left , `SFXEventConstRef` right ) == の関係を判定します。
`Bool`	operator!=( `SFXEventConstRef` left , `SFXEventConstRef` right ) != の関係を判定します。

型
AtomRec イベントを表す構造体です。

グローバル関数
`SFXEvent::AtomRec *`	atomic_cast( `SFXEvent *` param ) SFXEvent を SFXEvent::AtomRec に変換します。
`SFXEvent::AtomRec const *`	atomic_cast( `SFXEvent const *` param ) SFXEvent を SFXEvent::AtomRec に変換します。
`Bool`	operator==( `SFXEventConstRef` left , `SFXEventConstRef` right ) == の関係を判定します。
`Bool`	operator!=( `SFXEventConstRef` left , `SFXEventConstRef` right ) != の関係を判定します。

SFXEvent::SFXEvent

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

[ public, explicit ]
SFXEvent(Void);

[ public ]
SFXEvent(
    SFXEventConstRef param   // コピーする SFXEvent
);

[ public, explicit ]
SFXEvent(
    AEEEvent type   // イベント タイプ
    UInt16 p16      // P16 パラメーター
    UInt32 p32      // 32 ビット パラメーター
);

参照

SFXEvent::Set

SFXEvent::Equals

2 つの SFXEvent が等しいか判定します。

[ public, const ]
Bool Equals(
    SFXEventConstRef param   // 比較対象となる SFXEvent
);

[ public, const ]
Bool Equals(
    AEEEvent type   // イベント タイプ
    UInt16 p16      // 16 ビット イベント パラメーター
    UInt32 p32      // 32 ビット イベント パラメーター
);

戻り値

等しいとき: true
異なるとき : false

参照

SFXEvent::EqualsTypeP16 | operator==

SFXEvent::EqualsTypeP16

イベントタイプと P16 パラメーターが指定した値と一致しているか判定します。

[ public, const ]
Bool EqualsTypeP16(
    SFXEventConstRef param   // 比較対象となるイベント
);

[ public, const ]
Bool EqualsTypeP16(
    AEEEvent type   // 比較対象となるイベント タイプ
    UInt16 p16      // 比較対象となる P16 パラメーター
);

戻り値

一致しているとき : true
そうでないとき : false

参照

SFXEvent::GetP16 | SFXEvent::SetP16 | SFXEvent::GetType | SFXEvent::SetType

SFXEvent::GetP16

P16 パラメーターを取得します。

[ public, const ]
UInt16 GetP16(Void);

参照

SFXEvent::SetP16

SFXEvent::GetP32

32 ビットパラメーターを取得します。

[ public, const ]
UInt32 GetP32(Void);

参照

SFXEvent::SetP32

SFXEvent::GetType

イベントタイプを取得します。

[ public, const ]
AEEEvent GetType(Void);

参照

SFXEvent::SetType

SFXEvent::NoneInstance

SFEVT_NONE を表すインスタンスを返します。

[ public, static ]
SFXEventConstRef NoneInstance(Void);

解説

コンストラクタの SFXEvent(SFEVT_NONE, 0, 0) と同じ結果を返しますが、NoneInstance 関数の方がより高速に動作します。

SFXEvent::Set

イベントの値を設定します。

[ public ]
Void Set(
    SFXEventConstRef param   // コピーする SFXEvent
);

[ public ]
Void Set(
    AEEEvent type   // イベント タイプ
    UInt16 p16      // P16 パラメーター
    UInt32 p32      // 32 ビット パラメーター
);

参照

SFXEvent::SFXEvent | SFXEvent::SetP16 | SFXEvent::SetP32 | SFXEvent::SetType

SFXEvent::SetP16

P16 パラメーターを設定します。

[ public ]
Void SetP16(
    UInt16 param   // 設定する P16 パラメーター
);

参照

SFXEvent::GetP16

SFXEvent::SetP32

32 ビットパラメーターを設定します。

[ public ]
Void SetP32(
    UInt32 param   // 設定する 32 ビット パラメーター
);

参照

SFXEvent::GetP32

SFXEvent::SetType

イベントタイプを設定します。

[ public ]
Void SetType(
    AEEEvent param   // 設定するイベント タイプ
);

参照

SFXEvent::GetType

SFXEvent::SetTypeP16

イベントタイプと P16 パラメーターを設定します。

[ public ]
Void SetTypeP16(
    AEEEvent type   // 設定するイベント タイプ
    UInt16 p16      // 設定する P16 パラメーター
);

参照

SFXEvent::EqualsTypeP16 | SFXEvent::SetType | SFXEvent::SetP16

atomic_cast

SFXEvent を SFXEvent::AtomRec に変換します。

[ public, friend ]
SFXEvent::AtomRec * atomic_cast(
    SFXEvent * param   // キャストするイベント
);

[ public, friend ]
SFXEvent::AtomRec const * atomic_cast(
    SFXEvent const * param   // キャストするイベント
);

参照

SFXEvent::AtomRec

SFXEvent::operator=

SFXEvent を代入します。

[ public ]
SFXEventRef operator=(
    SFXEventConstRef param   // コピーする SFXEvent
);

参照

SFXEvent::SFXEvent | SFXEvent::Set

operator==

== の関係を判定します。

[ public, friend ]
Bool operator==(
    SFXEventConstRef left    // 比較する SFXEvent
    SFXEventConstRef right   // 比較する SFXEvent
);

戻り値

等しいとき : true
異なるとき : false

参照

SFXEvent::Equals | operator!=

operator!=

!= の関係を判定します。

[ public, friend ]
Bool operator!=(
    SFXEventConstRef left    // 比較する SFXEvent
    SFXEventConstRef right   // 比較する SFXEvent
);

戻り値

異なるとき : true
等しいとき : false

参照

SFXEvent::Equals | operator==

SFXEvent::AtomRec

イベントを表す構造体です。

[ public ]
struct AtomRec {
    AEEEvent     type;  // イベント タイプ
    UInt16       p16;   // P16 パラメーター
    UInt32       p32;   // 32 ビット パラメーター
};