トップへ戻る Cdrom || Color || Cursors || Display || Draw || Event || Examples || Font || Gfxdraw || Image || Joystick || Key || Locals || Mask || Mixer || Mouse || Movie || Music || Overlay || Pixelarray || Pygame || Rect || Scrap || Sndarray || Sprite || Surface || Surfarray || Tests || Time || Transform
pygame.mouse
    マウス処理を行うpygameモジュールです

    このマウス処理命令は、現在のマウス操作状態を調べるために使用できます。またマウスカーソルの外観を変更することもできます。

    ディスプレイモードが設定された時、マウスイベントからの情報を受け取るためのイベントキューが開始されます。マウスボタンが押された時にはpygame.MOUSEBUTTONDOWNイベントが発生し、マウスボタンが離された時にはpygame.MOUSEBUTTONUPイベントが発生します。これらのイベントには、どのボタンが押されたかを表すボタン情報も含まれています。マウスホイールをスクロールするのはボタンが押されたと判断されるので、pygame.MOUSEBUTTONDOWNイベントが発生します。マウスホイールを上にスクロールした場合はMOUSEBUTTONDOWNイベントのボタン情報には4が設定され、マウスホイールを下にスクロールした場合のボタン情報には5が設定されます。マウスを動かす際には常時pygame.MOUSEMOTIONイベントが発生します。マウスが動くと、その移動情報は細かく精密に分けられてイベントが発生するので、マウスが動く度に大量のマウス動作イベントがキューに取得されます。マウス動作イベントがイベントキューから適切に削除されないと、イベントビューが満杯になってしまいます。

    マウスカーソルが非表示状態でなおかつウィンドウがパソコンの入力処理を占有している場合、マウスはバーチャルインプットモードに切り替わります。このモードで、マウスはウィンドウの枠内に制限されることなく動くことができます。カーソル非表示やウィンドウの入力処理占有についての設定は、pygame.mouse.set_visible命令とpygame.event.set_grab命令を参照してください。



    pygame.mouse.get_pressed
      マウスボタンの状態を取得します。
      pygame.mouse.get_pressed(): return (button1, button2, button3) ※原文のpygame.moouse.get_pressed()を修正しています。

      全てのマウスボタンの入力状態を表すboolean型の配列を戻り値として返します。戻り値がtrueの場合は、命令実行時にそのボタンが押されていたということです。

      マウスの全ての動作を取得する場合には、この命令を使うのではなくpygame.event.wait()やpygame.event.get()命令を使用して得られたイベントの状態をMOUSEBUTTONDOWNMOUSEBUTTONUPMOUSEMOTION定数を使って確認するほうがよいでしょう。

      X Window System環境おいて、マウスの真ん中ボタンのクリック処理を擬似的に実行することができるXServerもあります。左クリック(button1)と右クリック(buttons3)を同時にクリックすると、真ん中ボタン(button2)のクリックイベントを発生させることができます。

      この命令を実行する際には、事前に pygame.event.get命令を実行するようにしてください。実行しておかないとこの命令は機能しない仕様となっています。



    pygame.mouse.get_pos
      マウスカーソルの位置情報を取得します。
      pygame.mouse.get_pos(): return (x, y)

      マウスカーソルのX位置とY位置の値を戻り値として返します。ここで取得できる位置情報は、ディスプレイの左上を基準とした相対位置です。マウスカーソルはウィンドウの枠外にも移動させることはできますが、カーソルの位置情報についてはウィンドウの枠内に制限された値となります。



    pygame.mouse.get_rel
      マウスの移動した距離を取得します。
      pygame.mouse.get_rel(): return (x, y)

      前回この命令が実行された時のマウス位置から、マウスの移動したX距離とY距離を戻り値として返します。マウスの移動する距離はウィンドウの枠内に制限されますが、この制限を回避する方法についてはマウスはバーチャルインプットモードを参照してください。バーチャルインプットモードについてはこのページの最初の項目に詳細が記載されています。



    pygame.mouse.set_pos
      マウスカーソルの位置を設定します。
      pygame.mouse.set_pos([x, y]): return None

      引数として設定した位置にマウスの位置を移動させます。マウスが表示状態の場合はカーソルが設定した位置までジャンプします。この命令でマウスが移動するとpygaqme.MOUSEMOTIONイベントが発生します。



    pygame.mouse.set_visible
      マウスカーソルの表示・非表示設定を切り替えます。
      pygame.mouse.set_visible(bool): return bool

      bool引数にtrueを設定した場合、マウスカーソルは表示状態になります。この命令で設定を変更する前のカーソル表示状態が、戻り値として返されます。



    pygame.mouse.get_focused
      ウィンドウがマウスからの入力情報を受け取れる状態か確認します。
      pygame.mouse.get_focused(): return bool

      pagameがマウスからの入力イベントを受け取れる状態であればtrueが戻り値として返されます。 (この状態のことをWinodws界隈の専門用語では「アクティブ状態になっている」、もしくは「フォーカスを得ている」と言います)。

      この命令はウィンドウ表示での処理を行う際に役に立ちます。一方フルスクリーン表示の場合はプログラムがマウス入力処理を占有しているため、この命令では常に戻り値がtrueとなるのであまり使う意味がありません。

      Note:Windows環境においては、ウィンドウがマウス入力処理を受け取れる状態の場合は、同時にキーボードの入力処理も受け取れる状態になります。しかしX-Windows環境では、ウィンドウがマウス入力処理イベントとキーボードの入力処理イベントを別々に持つことができます。pygame.mouse.get_focusedはpygameのウィンドウがマウスイベントを受け取れるかどうかを示します。



    pygame.mouse.set_cursor
      マウスカーソルのシステム画像を設定します。
      pygame.mouse.set_cursor(size, hotspot, xormasks, andmasks): return None

      マウスカーソルが表示状態の場合、カーソルはビットマスクの配列を使用した白黒のビットマップ画像で表示されます。size引数にはカーソルの横幅と縦幅のタプル値を設定します。 Hotspot引数にはカーソル画像内のクリック対象となる位置を設定します。 xormasks引数にはカーソルのxorデータマスクを設定します。最後に、andmasks引数にはカーソルのビットマスクデータを設定します。

      カーソルの横幅は8の倍数でなければならず、またマスクとして設定する二次元配列のサイズは、size引数に設定した横幅と縦幅の各数値と一致していなければなりません。そうしないと例外が発生してしまいます。

      システムカーソルを描写するための既定のマスクを作成したり、編集したりする方法についてはpygame.cursorモジュールを参照してください。



    pygame.mouse.get_cursor
      マウスカーソルのシステム画像を取得します。
      pygame.mouse.get_cursor(): return (size, hotspot, xormasks, andmasks)

      マウスカーソルのシステム情報を取得します。pygame.mouse.set_cursor命令で設定した引数と同じ値が戻り値として返されます。



トップへ戻る Cdrom || Color || Cursors || Display || Draw || Event || Examples || Font || Gfxdraw || Image || Joystick || Key || Locals || Mask || Mixer || Mouse || Movie || Music || Overlay || Pixelarray || Pygame || Rect || Scrap || Sndarray || Sprite || Surface || Surfarray || Tests || Time || Transform