kinugasa.inputDevice

## クラス MouseState

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

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

      public final class MouseState
      extends InputDeviceState

  マウスによる入力状態を格納します.
  AnyInput判定メソッドでは、マウスカーソルの位置が0,0でない場合も 入力ありと判定されます。
  関連項目:
    直列化された形式

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `boolean` | `DRAG_NOW` ドラッグ中の場合はtrueを送信します.
    `boolean` | `IN_WINDOW` ウインドウ領域内にある場合はtrueを送信します.
    `boolean` | `LEFT_BUTTON` 左ボタンの入力状態です.
    `boolean` | `RIGHT_BUTTON` 右ボタンの入力状態です.
    `boolean` | `WHEEL_BUTTON` ホイールボタンの入力状態です.
    `int` | `WHEEL_VALUE` 直前に入力されたホイールの回転量です.

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

    All Methods Instance Methods Concrete Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `MouseState` | `clone()` このモデルのクローンを返します.
    `boolean` | `contains(java.awt.Shape shape)` ウインドウ上のマウスの位置が、shape内にあるかを調べます.
    `java.awt.Point` | `getDraggedLocation()`
    `java.awt.Point` | `getLocation()` マウスのウインドウ上の位置を取得します.
    `java.awt.Point` | `getLocationOnScreen()` マウスのスクリーン上の位置を取得します.
    `int` | `getX()` ウインドウ上の座標を取得します.
    `int` | `getXOnScreen()` スクリーン上の位置を取得します.
    `int` | `getY()` ウインドウ上の座標を取得します.
    `int` | `getYOnScreen()` スクリーン上の位置を取得します.
    `boolean` | `isAnyButtonInput()` 検査時点で、何らかのボタンが押されているかを調べます.
    `boolean` | `isAnyInput()` 検査時点で、何らかの入力があるかを調べます.
    `boolean` | `isEmptyInput()` 検査時点で、何も入力されていないかを調べます.
    `boolean` | `isPressed(MouseButtons button)` マウスボタンが押されているかを検査します.
    `java.lang.String` | `toString()`

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

      `clone`

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

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

- - ### フィールドの詳細

    - #### LEFT_BUTTON

          public final boolean LEFT_BUTTON

      左ボタンの入力状態です.

    - #### RIGHT_BUTTON

          public final boolean RIGHT_BUTTON

      右ボタンの入力状態です.

    - #### WHEEL_BUTTON

          public final boolean WHEEL_BUTTON

      ホイールボタンの入力状態です.

    - #### IN_WINDOW

          public final boolean IN_WINDOW

      ウインドウ領域内にある場合はtrueを送信します.

    - #### DRAG_NOW

          public final boolean DRAG_NOW

      ドラッグ中の場合はtrueを送信します.

    - #### WHEEL_VALUE

          public final int WHEEL_VALUE

      直前に入力されたホイールの回転量です.

  - ### メソッドの詳細

    - #### isAnyInput

          public boolean isAnyInput()

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

    - #### isAnyButtonInput

          public boolean isAnyButtonInput()

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

    - #### isEmptyInput

          public boolean isEmptyInput()

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

    - #### getLocation

          public java.awt.Point getLocation()

      マウスのウインドウ上の位置を取得します. この座標はタイトルバーを含めた座標となりますので、実際にはその補正が必要です。
      補正は、Game.gerWindowから行います。
      戻り値:
        ウインドウ上の位置のクローンです。

    - #### getX

          public int getX()

      ウインドウ上の座標を取得します.
      戻り値:
        ウインドウの位置からのX位置を返します。

    - #### getY

          public int getY()

      ウインドウ上の座標を取得します.
      戻り値:
        ウインドウの位置からのY置を返します。

    - #### getLocationOnScreen

          public java.awt.Point getLocationOnScreen()

      マウスのスクリーン上の位置を取得します.
      戻り値:
        スクリーン上の位置のクローンです。

    - #### getXOnScreen

          public int getXOnScreen()

      スクリーン上の位置を取得します.
      戻り値:
        スクリーンの左上からのX位置を返します。

    - #### getYOnScreen

          public int getYOnScreen()

      スクリーン上の位置を取得します.
      戻り値:
        スクリーンの左上からのY位置を返します。

    - #### contains

          public boolean contains(java.awt.Shape shape)

      ウインドウ上のマウスの位置が、shape内にあるかを調べます.
      パラメータ:
        `shape` - 判定する領域を送信します。
      戻り値:
        ウインドウ上のカーソル位置がshape内にある場合はtrueを返します。

    - #### isPressed

          public boolean isPressed(MouseButtons button)

      マウスボタンが押されているかを検査します.
      パラメータ:
        `button` - 検査するボタンを指定します。
      戻り値:
        指定されたボタンが押されている場合にtrueを返します。

    - #### getDraggedLocation

          public java.awt.Point getDraggedLocation()

    - #### toString

          public java.lang.String toString()

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

    - #### clone

          public MouseState clone()

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