AbyssLib 1.301
あびす謹製ノベルゲームフレームワークライブラリ

クラス BaseInputManager

ユーザー入力用デバイスの基底クラスです。 [詳細]

#include <InputManager.h>

BaseInputManagerに対する継承グラフ
IInputManager NullInputManager

すべてのメンバ一覧

Public メソッド

 BaseInputManager ()
 デフォルトコンストラクタです。
virtual ~BaseInputManager ()
 仮想デストラクタです。
virtual void Flush ()=0
 入力情報を更新します。
virtual bool OnCallBackLog () const
 各種イベントの入力検知です。
virtual bool OnCallConfig () const
 各種イベントの入力検知です。
virtual bool OnCallMenu () const
 各種イベントの入力検知です。
virtual bool OnCallSave () const
 各種イベントの入力検知です。
virtual bool OnCallLoad () const
 各種イベントの入力検知です。
virtual bool OnCallSuspend () const
 各種イベントの入力検知です。
virtual bool OnCallEndApp () const
 各種イベントの入力検知です。
virtual bool OnReturnBackLog () const
 各種イベントの入力検知です。
virtual bool OnReturnConfig () const
 各種イベントの入力検知です。
virtual bool OnReturnMenu () const
 各種イベントの入力検知です。
virtual bool OnReturnSave () const
 各種イベントの入力検知です。
virtual bool OnReturnLoad () const
 各種イベントの入力検知です。
virtual bool OnAutoOn () const
 各種イベントの入力検知です。
virtual bool OnAutoOff () const
 各種イベントの入力検知です。
virtual bool OnSkipOn () const
 各種イベントの入力検知です。
virtual bool OnSkipOff () const
 各種イベントの入力検知です。
virtual bool OnClickText () const
 各種イベントの入力検知です。
virtual bool OnEraseTextWindow () const
 各種イベントの入力検知です。
virtual bool OnRollUpLog () const
 各種イベントの入力検知です。
virtual bool OnRollDownLog () const
 各種イベントの入力検知です。
virtual bool OnHoldSelect () const
 各種イベントの入力検知です。
virtual bool OnPushSelect () const
 各種イベントの入力検知です。
virtual bool OnClickSelect () const
 各種イベントの入力検知です。
virtual bool OnHoldButton () const
 各種イベントの入力検知です。
virtual bool OnPushButton () const
 各種イベントの入力検知です。
virtual bool OnClickButton () const
 各種イベントの入力検知です。
virtual bool OnHoldUIButton () const
 各種イベントの入力検知です。
virtual bool OnPushUIButton () const
 各種イベントの入力検知です。
virtual bool OnClickUIButton () const
 各種イベントの入力検知です。
void DecGuardTime ()
 ガードタイムを1減少させます。
bool IsGuardTime () const
 ガードタイム中かを判断します。
void SetGuardTime (unsigned int Time)
 ガードタイムを設定します。

説明

ユーザー入力用デバイスの基底クラスです。

実装する場合は本クラスから継承するようにしてください。


コンストラクタとデストラクタ

デフォルトコンストラクタです。

virtual ~BaseInputManager ( ) [inline, virtual]

仮想デストラクタです。


関数

virtual void Flush ( ) [pure virtual]

入力情報を更新します。

本メソッドが実行されるまで入力情報を更新しないように実装してください。

NullInputManagerで実装されています。

virtual bool OnCallBackLog ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「既読履歴を呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスホイールの回転量が正数の場合にtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnCallConfig ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「環境設定を呼び出したか?」の入力検知を行います。
デフォルト動作は「常にfalseを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnCallMenu ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「メニューを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの中ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnCallSave ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「セーブを呼び出したか?」の入力検知を行います。
デフォルト動作は「常にfalseを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnCallLoad ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ロードを呼び出したか?」の入力検知を行います。
デフォルト動作は「常にfalseを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnCallSuspend ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「一時停止を呼び出したか?」の入力検知を行います。
デフォルト動作は「常にfalseを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnCallEndApp ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「終了を呼び出したか?」の入力検知を行います。
デフォルト動作は「常にfalseを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnReturnBackLog ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「既読履歴から戻るを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの右ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnReturnConfig ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「環境設定から戻るを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの右ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnReturnMenu ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「メニューから戻るを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの右ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnReturnSave ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「セーブから戻るを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの右ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnReturnLoad ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ロードから戻るを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの右ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnAutoOn ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「オートモードをオンにを呼び出したか?」の入力検知を行います。
デフォルト動作は「常にfalseを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnAutoOff ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「オートモードをオフにを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnSkipOn ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「スキップをオンにを呼び出したか?」の入力検知を行います。
デフォルト動作は「常にfalseを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnSkipOff ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「スキップをオフにを呼び出したか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnClickText ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「テキストを進めようとしたか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnEraseTextWindow ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「テキストウインドウを消去しようとしたか?」の入力検知を行います。
デフォルト動作は「マウスの右ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnRollUpLog ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「既読履歴ログの上方を参照しようとしたか?」の入力検知を行います。
デフォルト動作は「マウスホイールの回転量が正数の場合にtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnRollDownLog ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「既読履歴ログの下方を参照しようとしたか?」の入力検知を行います。
デフォルト動作は「マウスホイールの回転量が負数の場合にtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnHoldSelect ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「選択肢の上でボタンを押し込んでいるか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンを押下してるとtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnPushSelect ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「選択肢の上でボタンが押されたか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnClickSelect ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「選択肢の上でボタンが離されたか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが離されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnHoldButton ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ボタン(オブジェクト)の上でボタンを押し込んでいるか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンを押下してるとtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnPushButton ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ボタン(オブジェクト)の上でボタンが押されたか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnClickButton ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ボタン(オブジェクト)の上でボタンが離されたか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが離されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnHoldUIButton ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ボタン(コンポーネント)の上でボタンを押し込んでいるか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンを押下してるとtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnPushUIButton ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ボタン(コンポーネント)の上でボタンが押されたか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが押されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

virtual bool OnClickUIButton ( ) const [virtual]

各種イベントの入力検知です。

本メソッドでは「ボタン(コンポーネント)の上でボタンが離されたか?」の入力検知を行います。
デフォルト動作は「マウスの左ボタンが離されたばかりでtrueを返す」です。
必要に応じてオーバーライドしてください。

戻り値:
入力が検知された場合はtrueを、検知されなかった場合はfalseを返します。

IInputManagerを実装しています。

void DecGuardTime ( ) [virtual]

ガードタイムを1減少させます。

ガードタイムとは、入力検知をブロックする仕組みです。
「Aの為に入力→次に続くBにも入力が検知されてしまう」といった現象を防ぎます。
デフォルトで実装されているため、オーバーライドする必要はありません(する場合は影響に注意してください)

IInputManagerを実装しています。

bool IsGuardTime ( ) const [virtual]

ガードタイム中かを判断します。

ガードタイムとは、入力検知をブロックする仕組みです。
「Aの為に入力→次に続くBにも入力が検知されてしまう」といった現象を防ぎます。
デフォルトで実装されているため、オーバーライドする必要はありません(する場合は影響に注意してください)

戻り値:
ガードタイム中の場合はtrueを、そうでない場合はfalseを返します。

IInputManagerを実装しています。

void SetGuardTime ( unsigned int  Time) [virtual]

ガードタイムを設定します。

ガードタイムとは、入力検知をブロックする仕組みです。
「Aの為に入力→次に続くBにも入力が検知されてしまう」といった現象を防ぎます。
デフォルトで実装されているため、オーバーライドする必要はありません(する場合は影響に注意してください)

引数:
Time[in]ガードタイムを指定します。
ガードタイムはDecGuardTimeメソッド実行毎に1ずつ減少します。

IInputManagerを実装しています。


このクラスの説明は次のファイルから生成されました:
 全て クラス ネームスペース ファイル 関数 変数 型定義 列挙型 列挙型の値 フレンド マクロ定義