マウスサーバクラス [詳解]

#include <mgl_mouse_server.h>

MGL::Input::MouseServer の継承関係図

公開メンバ関数
	MouseServer () noexcept
	コンストラクタ

bool	Initialize (STL::unique_ptr< MouseDelegate > &delegate) noexcept
	初期化処理

bool	IsAvailable () const noexcept
	マウスサーバが有効かどうかを返す

bool	IsPressing (MouseButton button) const noexcept
	ボタンが押されているかを取得

bool	IsPressing (MouseButtonFlags buttonFlags) const noexcept
	指定したボタンが全て押されているかを取得

bool	IsPressingAny (MouseButtonFlags buttonFlags=kMouseButtonAll) const noexcept
	指定したボタンが全て押されているかを取得

bool	IsTriggered (MouseButton button) const noexcept
	ボタンが押された瞬間を取得

bool	IsReleased (MouseButton button) const noexcept
	ボタンが離された瞬間を取得

const Vector2 &	GetPosition () const noexcept
	マウスポインタの位置を取得

const Vector2 &	GetUVPosition () const noexcept
	マウスポインタの位置をUV座標で取得

const Vector2 &	GetDeltaMove () const noexcept
	マウスポインタの移動量を取得

const Vector2 &	GetUVDeltaMove () const noexcept
	マウスポインタの移動量をUV座標で取得

void	SetBounds (const Rectangle &bounds) noexcept
	マウスの入力範囲を設定

void	SetBounds (const Rectangle &bounds, const Vector2 &logicalSize) noexcept
	マウスの入力範囲を論理サイズ

bool	SetCursorMode (CursorMode cursorMode) noexcept
	カーソルモードを設定

CursorMode	GetCursorMode () const noexcept
	カーソルモードを取得

void	SetCursorVisibleMode (CursorVisibleMode visibleMode) noexcept
	カーソルの表示モードを設定

CursorVisibleMode	GetCursorVisibleMode () const noexcept
	カーソルの表示モードを取得

MGL_MAYBE_CONSTEXPR bool	IsConnecting () const noexcept
	マウスの接続状態を取得

基底クラス MGL::SharedSingleton< MouseServer > に属する継承公開メンバ関数
	SharedSingleton (const SharedSingleton &) noexcept=delete

	SharedSingleton (SharedSingleton &&) noexcept=delete

SharedSingleton &	operator= (const SharedSingleton &) noexcept=delete

SharedSingleton &	operator= (SharedSingleton &&) noexcept=delete

静的公開メンバ関数
static STL::unique_ptr< MouseServer > &	GetInstanceRef () noexcept
	インスタンスの取得

基底クラス MGL::SharedSingleton< MouseServer > に属する継承静的公開メンバ関数
static MouseServer &	CreateInstance (Args... args) noexcept
	インスタンスの生成

static MouseServer &	GetInstance () noexcept
	インスタンスの取得

static void	DestroyInstance () noexcept
	インスタンスの破棄

static bool	HasInstance () noexcept
	有効なインスタンスを保持しているかを取得

詳解

マウスサーバクラス

関数詳解

◆ GetCursorMode()

CursorMode MGL::Input::MouseServer::GetCursorMode ( ) const

nodiscardnoexcept

カーソルモードを取得

戻り値: 現在のカーソルモード

◆ GetCursorVisibleMode()

CursorVisibleMode MGL::Input::MouseServer::GetCursorVisibleMode ( ) const

nodiscardnoexcept

カーソルの表示モードを取得

戻り値: 現在のカーソルの表示モード

◆ GetDeltaMove()

const Vector2 & MGL::Input::MouseServer::GetDeltaMove ( ) const

nodiscardnoexcept

マウスポインタの移動量を取得

戻り値: マウスポインタの移動量

◆ GetInstanceRef()

STL::unique_ptr< MouseServer > & MGL::Input::MouseServer::GetInstanceRef ( )

staticnoexcept

インスタンスの取得

戻り値: インスタンスの参照

◆ GetPosition()

const Vector2 & MGL::Input::MouseServer::GetPosition ( ) const

nodiscardnoexcept

マウスポインタの位置を取得

戻り値: マウスポインタの位置

◆ GetUVDeltaMove()

const Vector2 & MGL::Input::MouseServer::GetUVDeltaMove ( ) const

nodiscardnoexcept

マウスポインタの移動量をUV座標で取得

戻り値: マウスポインタの移動量

◆ GetUVPosition()

const Vector2 & MGL::Input::MouseServer::GetUVPosition ( ) const

nodiscardnoexcept

マウスポインタの位置をUV座標で取得

戻り値: マウスポインタの位置

◆ Initialize()

bool MGL::Input::MouseServer::Initialize ( STL::unique_ptr< MouseDelegate > & delegate )

noexcept

初期化処理

引数

[in] delegate マウス入力デリゲート

戻り値

true	成功
false	失敗

◆ IsAvailable()

bool MGL::Input::MouseServer::IsAvailable ( ) const

inlinenodiscardnoexcept

マウスサーバが有効かどうかを返す

戻り値

true	有効
false	無効

◆ IsConnecting()

MGL_MAYBE_CONSTEXPR bool MGL::Input::MouseServer::IsConnecting ( ) const

inlinenodiscardnoexcept

マウスの接続状態を取得

戻り値

true	接続されている
false	接続されていない

◆ IsPressing() [1/2]

bool MGL::Input::MouseServer::IsPressing ( MouseButton button ) const

nodiscardnoexcept

ボタンが押されているかを取得

引数

[in] button チェックするボタン

戻り値

true	押されている
false	押されていない

◆ IsPressing() [2/2]

bool MGL::Input::MouseServer::IsPressing ( MouseButtonFlags buttonFlags ) const

nodiscardnoexcept

指定したボタンが全て押されているかを取得

引数

[in] buttonFlags チェックするボタンフラグ

戻り値

true	押されている
false	押されていない

◆ IsPressingAny()

bool MGL::Input::MouseServer::IsPressingAny ( MouseButtonFlags buttonFlags = kMouseButtonAll ) const

nodiscardnoexcept

指定したボタンが全て押されているかを取得

引数

[in] buttonFlags チェックするボタンフラグ

戻り値

true	押されている
false	押されていない

◆ IsReleased()

bool MGL::Input::MouseServer::IsReleased ( MouseButton button ) const

nodiscardnoexcept

ボタンが離された瞬間を取得

引数

[in] button チェックするボタン

戻り値

true	離された瞬間である
false	離された瞬間ではない

◆ IsTriggered()

bool MGL::Input::MouseServer::IsTriggered ( MouseButton button ) const

nodiscardnoexcept

ボタンが押された瞬間を取得

引数

[in] button チェックするボタン

戻り値

true	押された瞬間である
false	押された瞬間ではない

◆ SetBounds() [1/2]

void MGL::Input::MouseServer::SetBounds ( const Rectangle & bounds )

noexcept

マウスの入力範囲を設定

引数

[in] bounds 入力範囲

◆ SetBounds() [2/2]

void MGL::Input::MouseServer::SetBounds	(	const Rectangle &	bounds,
		const Vector2 &	logicalSize )

noexcept

マウスの入力範囲を論理サイズ

引数

[in]	bounds	入力範囲
[in]	logicalSize	論理サイズ

◆ SetCursorMode()

bool MGL::Input::MouseServer::SetCursorMode ( CursorMode cursorMode )

noexcept

カーソルモードを設定

引数

[in] cursorMode 設定するカーソルモード

戻り値

true	成功
false	失敗

◆ SetCursorVisibleMode()

void MGL::Input::MouseServer::SetCursorVisibleMode ( CursorVisibleMode visibleMode )

noexcept

カーソルの表示モードを設定

引数

[in] visibleMode 設定する表示モード

このクラス詳解は次のファイルから抽出されました:

/Users/acerola/x/mgl/include/mgl/input/mouse/mgl_mouse_server.h
/Users/acerola/x/mgl/src/input/mouse/mgl_mouse_server.cc

公開メンバ関数

静的公開メンバ関数

詳解

関数詳解

◆ GetCursorMode()

◆ GetCursorVisibleMode()

◆ GetDeltaMove()

◆ GetInstanceRef()

◆ GetPosition()

◆ GetUVDeltaMove()

◆ GetUVPosition()

◆ Initialize()

◆ IsAvailable()

◆ IsConnecting()

◆ IsPressing() [1/2]

◆ IsPressing() [2/2]

◆ IsPressingAny()

◆ IsReleased()

◆ IsTriggered()

◆ SetBounds() [1/2]

◆ SetBounds() [2/2]

◆ SetCursorMode()

◆ SetCursorVisibleMode()