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

クラス IInputManager

ユーザー入力用デバイスのインターフェースです。 [詳細]

#include <InputManager.h>

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

すべてのメンバ一覧

Public メソッド

virtual bool LButton () const =0
 左ボタンが押下状態かを取得します。
virtual bool PushLButton () const =0
 左ボタンが押されたばかりか?を取得します。
virtual bool PushUpLButton () const =0
 左ボタンが離されたばかりか?を取得します。
virtual bool MButton () const =0
 中ボタンが押下状態かを取得します。
virtual bool PushMButton () const =0
 中ボタンが押されたばかりか?を取得します。
virtual bool PushUpMButton () const =0
 中ボタンが離されたばかりか?を取得します。
virtual bool RButton () const =0
 右ボタンが押下状態かを取得します。
virtual bool PushRButton () const =0
 右ボタンが押されたばかりか?を取得します。
virtual bool PushUpRButton () const =0
 右ボタンが離されたばかりか?を取得します。
virtual void GetXY (int &x, int &y) const =0
 マウスカーソルのXY座標を取得します。
virtual void GetZ (int &z) const =0
 マウスホイールの回転量を取得します。
virtual bool OnCallBackLog () const =0
 各種イベントの入力検知です。
virtual bool OnCallConfig () const =0
 各種イベントの入力検知です。
virtual bool OnCallMenu () const =0
 各種イベントの入力検知です。
virtual bool OnCallSave () const =0
 各種イベントの入力検知です。
virtual bool OnCallLoad () const =0
 各種イベントの入力検知です。
virtual bool OnCallSuspend () const =0
 各種イベントの入力検知です。
virtual bool OnCallEndApp () const =0
 各種イベントの入力検知です。
virtual bool OnReturnBackLog () const =0
 各種イベントの入力検知です。
virtual bool OnReturnConfig () const =0
 各種イベントの入力検知です。
virtual bool OnReturnMenu () const =0
 各種イベントの入力検知です。
virtual bool OnReturnSave () const =0
 各種イベントの入力検知です。
virtual bool OnReturnLoad () const =0
 各種イベントの入力検知です。
virtual bool OnAutoOn () const =0
 各種イベントの入力検知です。
virtual bool OnAutoOff () const =0
 各種イベントの入力検知です。
virtual bool OnSkipOn () const =0
 各種イベントの入力検知です。
virtual bool OnSkipOff () const =0
 各種イベントの入力検知です。
virtual bool OnClickText () const =0
 各種イベントの入力検知です。
virtual bool OnEraseTextWindow () const =0
 各種イベントの入力検知です。
virtual bool OnRollUpLog () const =0
 各種イベントの入力検知です。
virtual bool OnRollDownLog () const =0
 各種イベントの入力検知です。
virtual bool OnHoldSelect () const =0
 各種イベントの入力検知です。
virtual bool OnPushSelect () const =0
 各種イベントの入力検知です。
virtual bool OnClickSelect () const =0
 各種イベントの入力検知です。
virtual bool OnHoldButton () const =0
 各種イベントの入力検知です。
virtual bool OnPushButton () const =0
 各種イベントの入力検知です。
virtual bool OnClickButton () const =0
 各種イベントの入力検知です。
virtual bool OnHoldUIButton () const =0
 各種イベントの入力検知です。
virtual bool OnPushUIButton () const =0
 各種イベントの入力検知です。
virtual bool OnClickUIButton () const =0
 各種イベントの入力検知です。
virtual void DecGuardTime ()=0
 ガードタイムを1減少させます。
virtual bool IsGuardTime () const =0
 ガードタイム中かを判断します。
virtual void SetGuardTime (unsigned int Time)=0
 ガードタイムを設定します。

説明

ユーザー入力用デバイスのインターフェースです。

本クラスはユーザー入力全ての受け皿となります。
各メソッドの説明を参考に、BaseInputManagerクラスを継承して具象クラスを作成してください。
また、AbyssLib内の入力検知のほとんどはOn〜メソッド(各種イベント検知メソッド)で行っています。
入力検知をオーバーライドで手軽に変更できるよう、AbyssLib内で新たな入力検知を行う場合はOn〜メソッドを新規作成してください。


関数

virtual bool LButton ( ) const [pure virtual]

左ボタンが押下状態かを取得します。

取得するように実装してください。

戻り値:
左ボタンが押下状態かを返します。
押下されている場合はtrue、押下されていない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool PushLButton ( ) const [pure virtual]

左ボタンが押されたばかりか?を取得します。

取得するように実装してください。
「押されたばかり」とは、前回呼び出し時に押されておらず今回呼出時に押されている状態を意味します。

戻り値:
左ボタンが押されたばかりか?を返します。
押されたばかりの場合はtrue、そうでない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool PushUpLButton ( ) const [pure virtual]

左ボタンが離されたばかりか?を取得します。

取得するように実装してください。
「離されたばかり」とは、前回呼び出し時に押されており今回呼出時に押されていない状態を意味します。

戻り値:
左ボタンが離されたばかりか?を返します。
離されたばかりの場合はtrue、そうでない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool MButton ( ) const [pure virtual]

中ボタンが押下状態かを取得します。

取得するように実装してください。
中ボタンとは、マウスホイールのことです。

戻り値:
中ボタンが押下状態かを返します。
押下されている場合はtrue、押下されていない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool PushMButton ( ) const [pure virtual]

中ボタンが押されたばかりか?を取得します。

取得するように実装してください。
中ボタンとは、マウスホイールのことです。
「押されたばかり」とは、前回呼び出し時に押されておらず今回呼出時に押されている状態を意味します。

戻り値:
中ボタンが押されたばかりか?を返します。
押されたばかりの場合はtrue、そうでない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool PushUpMButton ( ) const [pure virtual]

中ボタンが離されたばかりか?を取得します。

取得するように実装してください。
中ボタンとは、マウスホイールのことです。
「離されたばかり」とは、前回呼び出し時に押されており今回呼出時に押されていない状態を意味します。

戻り値:
中ボタンが離されたばかりか?を返します。
離されたばかりの場合はtrue、そうでない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool RButton ( ) const [pure virtual]

右ボタンが押下状態かを取得します。

取得するように実装してください。

戻り値:
右ボタンが押下状態かを返します。
押下されている場合はtrue、押下されていない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool PushRButton ( ) const [pure virtual]

右ボタンが押されたばかりか?を取得します。

取得するように実装してください。
「押されたばかり」とは、前回呼び出し時に押されておらず今回呼出時に押されている状態を意味します。

戻り値:
右ボタンが押されたばかりか?を返します。
押されたばかりの場合はtrue、そうでない場合はfalseを返します。

NullInputManagerで実装されています。

virtual bool PushUpRButton ( ) const [pure virtual]

右ボタンが離されたばかりか?を取得します。

取得するように実装してください。
「離されたばかり」とは、前回呼び出し時に押されており今回呼出時に押されていない状態を意味します。

戻り値:
右ボタンが離されたばかりか?を返します。
離されたばかりの場合はtrue、そうでない場合はfalseを返します。

NullInputManagerで実装されています。

virtual void GetXY ( int &  x,
int &  y 
) const [pure virtual]

マウスカーソルのXY座標を取得します。

取得するように実装してください。

引数:
x[out]クライアントX座標を返します。
y[out]クライアントY座標を返します。

NullInputManagerで実装されています。

virtual void GetZ ( int &  z) const [pure virtual]

マウスホイールの回転量を取得します。

取得するように実装してください。

引数:
z[out]回転量を返します。
正数の場合は上(奥)に回転、0の場合は不動(回転せず)、負数の場合は下(手前)に回転となります。

NullInputManagerで実装されています。

virtual bool OnCallBackLog ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnCallConfig ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnCallMenu ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnCallSave ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnCallLoad ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnCallSuspend ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnCallEndApp ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnReturnBackLog ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnReturnConfig ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnReturnMenu ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnReturnSave ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnReturnLoad ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnAutoOn ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnAutoOff ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnSkipOn ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnSkipOff ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnClickText ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnEraseTextWindow ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnRollUpLog ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnRollDownLog ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnHoldSelect ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnPushSelect ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnClickSelect ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnHoldButton ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnPushButton ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnClickButton ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnHoldUIButton ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnPushUIButton ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual bool OnClickUIButton ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual void DecGuardTime ( ) [pure virtual]

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

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

BaseInputManagerで実装されています。

virtual bool IsGuardTime ( ) const [pure virtual]

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

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

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

BaseInputManagerで実装されています。

virtual void SetGuardTime ( unsigned int  Time) [pure virtual]

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

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

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

BaseInputManagerで実装されています。


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