10. マウス¶

この章では、マウスの入力を処理する方法を学びます。

10.1 マウスカーソルの座標を取得する¶

マウスカーソルの座標は Cursor::Pos() を使うと Point 型で取得できます。シーンが実ウィンドウサイズと異なる (チュートリアル 15 参照) 場合、Cursor::PosF() を使うと Vec2 型で小数点数以下の座標も取得できます。

Cursor::Pos() で取得できるマウスカーソル座標は、最後の System::Update() の呼び出し時点での座標のため、実際画面に見えているマウスカーソルよりも古い座標を示す場合があります。

# include <Siv3D.hpp>

void Main()
{
	while (System::Update())
	{
		ClearPrint();
		Print << Cursor::Pos();
		Print << Cursor::PosF();

		Circle{ Cursor::Pos(), 50 }.draw(Palette::Skyblue);
	}
}

10.2 マウスカーソルの移動量を取得する¶

1 フレーム前のマウスカーソル座標は Cursor::PreviousPos() / Cursor::PreviousPosF() で取得できます。1 フレーム前からのマウスカーソルの移動量は Cursor::Delta() / Cursor::DeltaF() で取得できます。

Cursor::Delta() == (Cursor::Pos() - Cursor::PreviousPos()) です。

# include <Siv3D.hpp>

void Main()
{
	// 円をつかんでいるか
	bool grab = false;

	Circle circle{ Scene::Center(), 50 };

	while (System::Update())
	{
		if (grab)
		{
			// 移動量分だけ円を移動
			circle.moveBy(Cursor::Delta());
		}

		if (circle.leftClicked()) // 円を左クリックしたら
		{
			grab = true;
		}
		else if (MouseL.up()) // マウスの左ボタンが離されたら
		{
			grab = false;
		}

		if (grab || circle.mouseOver())
		{
			Cursor::RequestStyle(CursorStyle::Hand);
		}

		circle.draw(Palette::Skyblue);
	}
}

10.3 マウスカーソルのスクリーン座標を取得する¶

マウスカーソルがデスクトップ上のどの位置にあるか、スクリーン座標で取得するには Cursor::ScreenPos() を使います。

# include <Siv3D.hpp>

void Main()
{
	while (System::Update())
	{
		ClearPrint();

		// マウスカーソルの位置をスクリーン座標で表示
		Print << Cursor::ScreenPos();
	}
}

10.4 マウスのボタンの入力状態を調べる¶

マウスのボタンには、以下の Input 型の値が割り当てられています。

定数	対応するボタン
`MouseL`	左ボタン
`MouseR`	右ボタン
`MouseM`	中央ボタン
`MouseX1`	拡張ボタン 1
`MouseX2`	拡張ボタン 2
`MouseX3`	拡張ボタン 3
`MouseX4`	拡張ボタン 4
`MouseX5`	拡張ボタン 5

チュートリアル 16 のキーボードと同様に、押した瞬間であるかを .down(), 押し続けているかを .pressed(), 離した瞬間であるかを .up() を使って bool 値で取得できます。

関数	押していないとき	押した瞬間	押し続けている	離した瞬間	離し続けている
`.down()`	false	✔ true	false	false	false
`.pressed()`	false	✔ true	✔ true	false	false
`.up()`	false	false	false	✔ true	false

# include <Siv3D.hpp>

void Main()
{
	while (System::Update())
	{
		ClearPrint();
		Print << MouseL.pressed();
		Print << MouseM.pressed();
		Print << MouseR.pressed();
	}
}

10.5 ボタンが押されていた時間を調べる¶

Input の .pressedDuration() は、その入力が押され続けている時間を Duration 型の値で返します。

押され続けている時間は .up() が true になるフレームまで有効です。.up() されたときに .pressedDuration() を調べると、そのボタンが離されるまで何秒間押され続けていたかを取得できます。

# include <Siv3D.hpp>

void Main()
{
    while (System::Update())
    {
        ClearPrint();
        Print << MouseL.pressedDuration();
		Print << MouseM.pressedDuration();
		Print << MouseR.pressedDuration();
    }
}

10.6 すべてのマウス入力を取得する¶

Mouse::GetAllInputs() は、.down(), .pressed(), .up() のいずれかが true になっている、アクティブなマウスボタンの一覧を Array<Input> で返します。

# include <Siv3D.hpp>

void Main()
{
	while (System::Update())
	{
		ClearPrint();

		// down() / pressed() / up() のいずれかが true になっているマウスボタン一覧を取得
		const Array<Input> buttons = Mouse::GetAllInputs();

		for (const auto& button : buttons)
		{
			Print << button.name() << (button.pressed() ? U" pressed" : U" up");
		}
	}
}

10.7 マウスホイールの回転量を取得する¶

直前のフレームからのマウスホイールのスクロール量は、Mouse::Wheel() によって double 型で取得できます。水平ホイールのスクロール量は、Mouse::WheelH() によって double 型で取得できます。

マウスホイールのスクロール量はフレームレートに依存しないため、Scene::Delta() で調整する必要はありません。

# include <Siv3D.hpp>

void Main()
{
	Vec2 pos = Scene::Center();

	while (System::Update())
	{
		ClearPrint();

		// マウスホイールのスクロール量
		Print << Mouse::Wheel();

		// マウスの水平ホイールのスクロール量
		Print << Mouse::WheelH();

		pos.y -= (Mouse::Wheel() * 10);
		pos.x += (Mouse::WheelH() * 10);

		RectF{ Arg::center = pos, 200 }.draw();
	}
}

10.8 マウスカーソルがクライアント領域にあるかを調べる¶

Cursor::OnClientRect() は、マウスカーソルがウィンドウのクライアント領域上にある場合 true を、それ以外の場合は false を返します。

# include <Siv3D.hpp>

void Main()
{
	while (System::Update())
	{
		ClearPrint();

		// マウスカーソルがウィンドウのクライアント領域上にあるかを表示
		Print << Cursor::OnClientRect();

		if (Cursor::OnClientRect())
		{
			Scene::SetBackground(ColorF{ 0.4 });
		}
		else
		{
			Scene::SetBackground(ColorF{ 0.2 });
		}
	}
}

10.9 マウスカーソルを指定した位置に移動させる¶

Cursor::SetPos() を使うと、指定した位置にマウスカーソルを移動できます。

# include <Siv3D.hpp>

void Main()
{
	while (System::Update())
	{
		ClearPrint();
		Print << Cursor::Pos();

		if (SimpleGUI::Button(U"center", Vec2{ 100, 20 }))
		{
			// マウスカーソルをシーンの中心に移動
			Cursor::SetPos(Scene::Center());
		}
	}
}

10.10 (Windows 版) マウスカーソルの移動を制限する¶

Windows 版では、Cursor::ClipToWindow(true) を呼ぶとマウスカーソルが移動できる領域をウィンドウのクライアント領域上に制限できます。制限を解除するには Cursor::ClipToWindow(false) を呼びます。

# include <Siv3D.hpp>

void Main()
{
	bool clip = false;

	while (System::Update())
	{
		ClearPrint();
		Print << Cursor::Pos();

		if (SimpleGUI::CheckBox(clip, U"clip", Vec2{ 100, 20 }))
		{
			if (clip)
			{
				// マウスカーソルの移動をウィンドウのクライアント領域上に制限
				Cursor::ClipToWindow(true);
			}
			else
			{
				// 制限を解除
				Cursor::ClipToWindow(false);
			}
		}
	}
}