kinugasa.inputDevice

## クラス InputState

- java.lang.Object
- - kinugasa.object.Model
  - - kinugasa.inputDevice.InputDeviceState
    - - kinugasa.inputDevice.InputState

- すべての実装されたインタフェース:
    java.io.Serializable, java.lang.Cloneable

      public final class InputState
      extends InputDeviceState

  入力デバイスの状態を格納します.
  このクラスは、プレイヤーが使用できるデバイスの状態を一元管理します。
  このクラスを使用することで、入力状態を簡単に検査できます。
  入力状態の更新には、それなりの時間的コストがかかります。
  getInstanceの使用は、1ループ中1回にとどめてください。
  ゲーム起動時の設定によって、使用しないデバイスがある場合、 そのデバイスの状態は常にnullです。
  関連項目:
    直列化された形式

- - ### メソッドのサマリー

    All Methods Static Methods Instance Methods Concrete Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `InputState` | `clone()` このモデルのクローンを返します.
    `static InputState` | `getInstance()` インスタンスを取得します.
    `KeyState` | `getKeyState()` 現在のキーボードの状態を取得します.
    `MouseState` | `getMouseState()` 前回のマウスの状態を取得します.
    `KeyState` | `getPrevKeyState()` 前回のキーボードの状態を取得します.
    `MouseState` | `getPrevMouseState()` 現在のマウスの状態を取得します.
    `boolean` | `isAnyButtonInput()` 検査時点で、何らかのボタンが押されているかを調べます.
    `boolean` | `isAnyInput()` 検査時点で、何らかの入力があるかを調べます.
    `boolean` | `isEmptyInput()` 検査時点で、何も入力されていないかを調べます.
    `boolean` | `isPressed(Keys key, InputType type)` キーボードのキーが押されているかを検査します.
    `boolean` | `isPressed(MouseButtons button, InputType type)` マウスのボタンが押されているかを検査します.
    `boolean` | `isPressedAnd(InputType type, Keys... keys)`
    `boolean` | `isPressedOr(InputType type, Keys... keys)`
    `java.lang.String` | `toString()`

    - ### クラスから継承されたメソッド kinugasa.object.Model

      `clone`

    - ### クラスから継承されたメソッド java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### メソッドの詳細

    - #### getInstance

          public static InputState getInstance()

      インスタンスを取得します. このメソッドを呼び出すと、現在の入力状態が検査されます。
      戻り値:
        InputStateのインスタンスを返します。

    - #### isAnyInput

          public boolean isAnyInput()

      クラスからコピーされた説明: `InputDeviceState`
      検査時点で、何らかの入力があるかを調べます. このメソッドによって検査される、デバイスの要素は、実装によって異なります。
      定義:
        `isAnyInput` クラス内 `InputDeviceState`
      戻り値:
        何らかの入力がある場合にtrueを返します。

    - #### isAnyButtonInput

          public boolean isAnyButtonInput()

      クラスからコピーされた説明: `InputDeviceState`
      検査時点で、何らかのボタンが押されているかを調べます. このメソッドによって検査される、デバイスの要素は、実装によって異なります。
      定義:
        `isAnyButtonInput` クラス内 `InputDeviceState`
      戻り値:
        何らかのボタンが押されている場合はtrueを返します。

    - #### isEmptyInput

          public boolean isEmptyInput()

      クラスからコピーされた説明: `InputDeviceState`
      検査時点で、何も入力されていないかを調べます. このメソッドによって検査される、デバイスの要素は、実装によって異なります。
      定義:
        `isEmptyInput` クラス内 `InputDeviceState`
      戻り値:
        何も入力されていない場合にtrueを返します。

    - #### isPressed

          public boolean isPressed(Keys key,
                                   InputType type)

      キーボードのキーが押されているかを検査します.
      パラメータ:
        `key` - 判定するキーを指定します。
        `type` - 前回の入力状態を検査するかを決定します。
      戻り値:
        指定されたキーが現在押されている場合、trueを返します。

    - #### isPressedOr

          public boolean isPressedOr(InputType type,
                                     Keys... keys)

    - #### isPressedAnd

          public boolean isPressedAnd(InputType type,
                                      Keys... keys)

    - #### isPressed

          public boolean isPressed(MouseButtons button,
                                   InputType type)

      マウスのボタンが押されているかを検査します.
      パラメータ:
        `button` - 判定するボタンを指定します。
        `type` - 前回の入力状態を検査するかを決定します。
      戻り値:
        指定されたボタンが現在押されている場合、trueを返します。

    - #### getKeyState

          public KeyState getKeyState()

      現在のキーボードの状態を取得します. キーボードが使用できない場合、nullを返します。
      戻り値:
        キーボードの状態を返します。

    - #### getPrevKeyState

          public KeyState getPrevKeyState()

      前回のキーボードの状態を取得します. キーボードが使用できない場合、nullを返します。
      戻り値:
        キーボードの状態を返します。

    - #### getPrevMouseState

          public MouseState getPrevMouseState()

      現在のマウスの状態を取得します. マウスが使用できない場合、nullを返します。
      戻り値:
        マウスの状態を返します。

    - #### getMouseState

          public MouseState getMouseState()

      前回のマウスの状態を取得します. マウスが使用できない場合、nullを返します。
      戻り値:
        マウスの状態を返します。

    - #### clone

          public InputState clone()

      クラスからコピーされた説明: `Model`
      このモデルのクローンを返します. クローンはObjectクラスの機能を使って行われます。
      全てのモデルの実装は、cloneメソッドを適切にオーバーライドする必要があります。
      オーバーライド:
        `clone` クラス内 `InputDeviceState`
      戻り値:
        このモデルと同じクラスの新しいインスタンスを返します。

    - #### toString

          public java.lang.String toString()

      オーバーライド:
        `toString` クラス内 `java.lang.Object`