マウスの状態を取得する

概要

マウスの現在の状態を取得します。各ボタンの操作、マウスの位置やホイールの回転量を表示しています。

動作環境

必須環境

動作確認環境

サンプルの操作方法

内容

マウスボタンの押下状態やマウスの位置を取得するには「Mouse.GetState」メソッドを使用します。これらの状態は MouseState 構造体に格納されています。

// マウスの状態を取得
this.mouseState = Mouse.GetState();

Mouse.GetState メソッド

マウスの位置やボタンの押下状態などを取得します。

今回のサンプルでは Draw メソッド内でマウスの状態を表示しているので MouseState をフィールドとして宣言しています。

/// <summary>
/// マウスの状態を記憶
/// </summary>
private MouseState mouseState = Mouse.GetState();

ボタン

マウスのボタンが押されているかは「ButtonState」列挙と比較して判断できます。押しているかを調べるには「ButtonState.Pressed」で比較し、放しているかを調べるには「ButtonState.Released」で調べられます。

// マウスの左ボタン
if (this.mouseState.LeftButton == ButtonState.Pressed)
{
    stateMessage = "Pressed";
}
else
{
    stateMessage = "Released";
}

マウスのボタンは以下のものが使用できます。

• LeftButton
• MiddleButton
• RightButton
• XButton1
• XButton2

位置

マウスの位置は「MouseState.X」「MouseState.Y」で取得できます。この値はスクリーンの左上を原点(0,0)とした値になり、右下に向かうほどプラスに、左上に向かうほどマイナスの値になります。

// マウスの位置
this.spriteBatch.DrawString(this.font,
    "Position : " + this.mouseState.X + ", " + this.mouseState.Y,
    new Vector2(40.0f, 150.0f), Color.White);

ホイール

マウスホイールのスクロール量は「MouseState.ScrollWheelValue」で取得できます。スクロール量はその時点での回転量ではなく、以前の値に対して加算減算されていきます。

// ホイールの回転量
this.spriteBatch.DrawString(this.font,
    "ScrollWheelValue : " + this.mouseState.ScrollWheelValue,
    new Vector2(40.0f, 175.0f), Color.White);

Xbox 360 ではマウス関連のプログラムを記述することはできますが、マウス自体使用することはできないため、正常な値を取得することはできません。Windows Phone では LeftButton のみシングルタッチの代わりに使用することができます。

全コード

using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Audio;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.GamerServices;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input;
using Microsoft.Xna.Framework.Media;
#if WINDOWS_PHONE
using Microsoft.Xna.Framework.Input.Touch;
#endif

namespace GetMouseState
{
    /// <summary>
    /// ゲームメインクラス
    /// </summary>
    public class GameMain : Microsoft.Xna.Framework.Game
    {
        /// <summary>
        /// グラフィックデバイス管理クラス
        /// </summary>
        private GraphicsDeviceManager graphics = null;

        /// <summary>
        /// スプライトのバッチ化クラス
        /// </summary>
        private SpriteBatch spriteBatch = null;

        /// <summary>
        /// スプライトでテキストを描画するためのフォント
        /// </summary>
        private SpriteFont font = null;

        /// <summary>
        /// マウスの状態を記憶
        /// </summary>
        private MouseState mouseState = Mouse.GetState();


        /// <summary>
        /// GameMain コンストラクタ
        /// </summary>
        public GameMain()
        {
            // グラフィックデバイス管理クラスの作成
            this.graphics = new GraphicsDeviceManager(this);

            // ゲームコンテンツのルートディレクトリを設定
            this.Content.RootDirectory = "Content";

#if WINDOWS_PHONE
            // Windows Phone のデフォルトのフレームレートは 30 FPS
            this.TargetElapsedTime = TimeSpan.FromTicks(333333);

            // バックバッファサイズの設定
            this.graphics.PreferredBackBufferWidth = 480;
            this.graphics.PreferredBackBufferHeight = 800;

            // フルスクリーン表示
            this.graphics.IsFullScreen = true;
#endif

            // ウインドウ上でマウスのポインタを表示するようにする
            this.IsMouseVisible = true;
        }

        /// <summary>
        /// ゲームが始まる前の初期化処理を行うメソッド
        /// グラフィック以外のデータの読み込み、コンポーネントの初期化を行う
        /// </summary>
        protected override void Initialize()
        {
            // TODO: ここに初期化ロジックを書いてください

            // コンポーネントの初期化などを行います
            base.Initialize();
        }

        /// <summary>
        /// ゲームが始まるときに一回だけ呼ばれ
        /// すべてのゲームコンテンツを読み込みます
        /// </summary>
        protected override void LoadContent()
        {
            // テクスチャーを描画するためのスプライトバッチクラスを作成します
            this.spriteBatch = new SpriteBatch(this.GraphicsDevice);

            // フォントをコンテンツパイプラインから読み込む
            this.font = this.Content.Load<SpriteFont>("Font");
        }

        /// <summary>
        /// ゲームが終了するときに一回だけ呼ばれ
        /// すべてのゲームコンテンツをアンロードします
        /// </summary>
        protected override void UnloadContent()
        {
            // TODO: ContentManager で管理されていないコンテンツを
            //       ここでアンロードしてください
        }

        /// <summary>
        /// 描画以外のデータ更新等の処理を行うメソッド
        /// 主に入力処理、衝突判定などの物理計算、オーディオの再生など
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Update(GameTime gameTime)
        {
            // Xbox 360 コントローラ、Windows Phone の BACK ボタンを押したときに
            // ゲームを終了させます
            if (GamePad.GetState(PlayerIndex.One).Buttons.Back == ButtonState.Pressed)
            {
                this.Exit();
            }

            // マウスの状態を取得
            this.mouseState = Mouse.GetState();

            // 登録された GameComponent を更新する
            base.Update(gameTime);
        }

        /// <summary>
        /// 描画処理を行うメソッド
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Draw(GameTime gameTime)
        {
            // 画面を指定した色でクリアします
            this.GraphicsDevice.Clear(Color.CornflowerBlue);

            // スプライトの描画準備
            this.spriteBatch.Begin();

            string stateMessage;

            // マウスの左ボタン
            if (this.mouseState.LeftButton == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "LeftButton : " + stateMessage,
                new Vector2(40.0f, 25.0f), Color.White);

            // マウスの右ボタン
            if (this.mouseState.RightButton == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "RightButton : " + stateMessage,
                new Vector2(40.0f, 50.0f), Color.White);

            // マウスの中ボタン
            if (this.mouseState.MiddleButton == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "MiddleButton : " + stateMessage,
                new Vector2(40.0f, 75.0f), Color.White);

            // マウスのXボタン1
            if (this.mouseState.XButton1 == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "XButton1 : " + stateMessage,
                new Vector2(40.0f, 100.0f), Color.White);

            // マウスのXボタン2
            if (this.mouseState.XButton2 == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "XButton2 : " + stateMessage,
                new Vector2(40.0f, 125.0f), Color.White);

            // マウスの位置
            this.spriteBatch.DrawString(this.font,
                "Position : " + this.mouseState.X + ", " + this.mouseState.Y,
                new Vector2(40.0f, 150.0f), Color.White);

            // ホイールの回転量
            this.spriteBatch.DrawString(this.font,
                "ScrollWheelValue : " + this.mouseState.ScrollWheelValue,
                new Vector2(40.0f, 175.0f), Color.White);

            // スプライトの一括描画
            this.spriteBatch.End();

            // 登録された DrawableGameComponent を描画する
            base.Draw(gameTime);
        }
    }
}