Recognize the moment you press the mouse button

Page update date :
Page creation date :

summary

It allows you to detect the moment when you press the left mouse button. In the sample, the number of times the button is pressed is displayed.

マウスのボタンを押した瞬間を認識させる

Operating environment

Prerequisites

Supported XNA Versions
  • 3.0
  • 3.1
  • 4.0
Supported Platforms
  • Windows (XP SP2 or later, Vista, 7)
  • Xbox 360
  • Windows Phone 7
Windows Required Vertex Shader Version 2.0
Windows Required Pixel Shader Version 2.0

Operating environment

platform
  • Windows 7
  • Xbox 360
  • Windows Phone 7 Emulator

How to work with the sample

Works keyboardXbox 360 controllermouse touch
Pressing check - - Left Button -

substance

The standard functionality of the XNA Framework is not to get the moment when a mouse button is pressed, so you must implement it yourself. As an implementation method, the press information of the previous button is retained, compared with the current press state, and if it was not pressed last time and is currently pressed, it is recognized as the moment of pressing.

The example is illustrated with the example of the left mouse button. The field is declared with bool so that it can hold the previous and current pressed states. There is also a counter for counting the number of times you press it.

/// <summary>
/// 現在マウスの左ボタンを押しているか
/// </summary>
private bool nowMouseButtonPushed = false;

/// <summary>
/// 前回マウスの左ボタンを押しているか
/// </summary>
private bool previousMouseButtonPushed = false;

/// <summary>
/// ボタンが押された回数
/// </summary>
private int pushedCount = 0;

In the Update method, we remember the press state of the button that we obtained last time and get the current button state. If it was not pressed last time and is currently pressed, it is judged to be the moment the button is pressed and counted.

// 前回のマウスボタンの押下状態を記憶
this.previousMouseButtonPushed = this.nowMouseButtonPushed;

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

// 現在のマウスボタンの押下状態を記憶
this.nowMouseButtonPushed = mouseState.LeftButton == ButtonState.Pressed;

// ボタンが押された瞬間ならカウントする
if (this.nowMouseButtonPushed && !this.previousMouseButtonPushed)
{
    this.pushedCount++;
}

You can write mouse-related programs on Xbox 360, but you can't use the mouse itself, so you won't be able to get a good value. On Windows Phone, only the LeftButton can be used instead of single-touch.

By the way, in this sample, the previous keypress state is only used in the Update method, so it can be written as a local variable instead of having it in the field.

All Codes

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 JustPushedMouseButton
{
    /// <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 bool nowMouseButtonPushed = false;

        /// <summary>
        /// 前回マウスの左ボタンを押しているか
        /// </summary>
        private bool previousMouseButtonPushed = false;

        /// <summary>
        /// ボタンが押された回数
        /// </summary>
        private int pushedCount = 0;


        /// <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.previousMouseButtonPushed = this.nowMouseButtonPushed;

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

            // 現在のマウスボタンの押下状態を記憶
            this.nowMouseButtonPushed = mouseState.LeftButton == ButtonState.Pressed;

            // ボタンが押された瞬間ならカウントする
            if (this.nowMouseButtonPushed && !this.previousMouseButtonPushed)
            {
                this.pushedCount++;
            }

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

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

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

            this.spriteBatch.DrawString(this.font,
                "Please press a left button" + Environment.NewLine +
                "of the mouse.",
                new Vector2(20.0f, 50.0f), Color.White);

            // ボタンが押された回数を表示
            this.spriteBatch.DrawString(this.font,
                "Pushed Count : " + this.pushedCount.ToString(),
                new Vector2(20.0f, 120.0f), Color.White);

            // マウスの左ボタンが押されている場合は文字を表示する
            if (this.nowMouseButtonPushed)
            {
                this.spriteBatch.DrawString(this.font,
                    "The left button of the mouse" + Environment.NewLine +
                    "is pressed.",
                    new Vector2(20.0f, 150.0f), Color.Yellow);
            }

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

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