MGL::Input::PadState クラス

ゲームパッドステートクラス [詳解]

#include <mgl_gamepad_state.h>

公開メンバ関数
	PadState () noexcept
	コンストラクタ
void	PreUpdate () noexcept
	更新前の処理
void	PostUpdate (const RepeatSetting &repeatSetting) noexcept
	更新後の処理
constexpr void	SetUsing (bool isUsing) noexcept
	使用中フラグを設定
constexpr bool	IsUsing () const noexcept
	使用中フラグを取得
void	RequestsActivate (PadType type, PadPriority priority, const PadDeviceInfo &deviceInfo) noexcept
	アクティベート要求
void	RequestsDeactivate () noexcept
	アクティベート解除要求
bool	operator== (const PadState &rhs) const noexcept
	等価演算子のオーバーロード
bool	operator!= (const PadState &rhs) const noexcept
	不等価演算子のオーバーロード
constexpr bool	IsEnabled () const noexcept
	このパッドステートが有効かどうかを取得
constexpr void	SetPlayerIndex (int32_t playerIndex) noexcept
	プレイヤーインデックスの設定
constexpr int32_t	GetPlayerIndex () const noexcept
	プレイヤーインデックスの設定
constexpr PadType	GetType () const noexcept
	ゲームパッドの種類を取得
constexpr void	SetEntry (PadEntry entry) noexcept
	エントリー番号の設定
constexpr PadEntry	GetEntry () const noexcept
	エントリー番号の取得
constexpr bool	HasEntry () const noexcept
	エントリー済みかを取得
constexpr void	SetButton (PadButton button) noexcept
	ボタンの設定
constexpr void	SetButton (PadButtonFlags buttonFlags) noexcept
	ボタンの設定
constexpr PadButtonFlags	GetButtonFlags () const noexcept
	設定済みのボタンフラグの取得
constexpr void	SetLeftStick (const Vector2 &axisValue) noexcept
	左スティックの値を設定
constexpr void	SetRightStick (const Vector2 &axisValue) noexcept
	右スティックの値を設定
constexpr const Vector2 &	GetLeftStick () const noexcept
	左スティックの値を設定
constexpr Vector2 &	GetLeftStick () noexcept
	左スティックの値を設定（const版）
constexpr const Vector2 &	GetRightStick () const noexcept
	右スティックの値を設定
constexpr Vector2 &	GetRightStick () noexcept
	右スティックの値を設定（const版）
constexpr bool	IsPressing (PadButton button) const noexcept
	ボタンが押されているかを取得
constexpr bool	IsPressing (PadButtonFlags buttonFlags) const noexcept
	指定したボタンが全て押されているかを取得
constexpr bool	IsPressingAny (PadButtonFlags buttonFlags=kGamepadButtonAll) const noexcept
	指定したボタンのいずれかが押されているかを取得
constexpr bool	IsTriggered (PadButton button) const noexcept
	ボタンが押された瞬間を取得
constexpr bool	IsReleased (PadButton button) const noexcept
	ボタンが離された瞬間を取得
constexpr bool	HasInputButton () const noexcept
	いずれかのボタンの入力があるかを取得
constexpr bool	IsARepeat (PadButton button) const noexcept
	リピート入力を取得
constexpr void	SetPortraitMode (bool isEnabled) noexcept
	ポートレートモード（縦持ち）の設定
constexpr bool	IsPortraitMode () const noexcept
	ポートレートモード（縦持ち）の取得
constexpr PadPriority	GetPriority () const noexcept
	プライオリティを取得
constexpr void	SetDecideButton (PadButton button) noexcept
	決定ボタンに割り当てるボタンを設定
constexpr PadButton	GetDecideButton () const noexcept
	決定ボタンに割り当てるボタンを取得
constexpr void	SetCancelButton (PadButton button) noexcept
	キャンセルボタンに割り当てるボタンを設定
constexpr PadButton	GetCancelButton () const noexcept
	キャンセルボタンに割り当てるボタンを取得
constexpr const PadDeviceInfo &	GetDeviceInfo () const noexcept
	デバイス情報を取得
void	ApplyLeftStickToDPad () noexcept
	アナログスティックからD-Padを適用する
	PadState (const PadState &)=delete
PadState &	operator= (const PadState &)=delete
	PadState (PadState &&)=delete
PadState &	operator= (PadState &&)=delete

詳解

ゲームパッドステートクラス

関数詳解

GetButtonFlags()

PadButtonFlags MGL::Input::PadState::GetButtonFlags ( ) const

inlinenodiscardconstexprnoexcept

設定済みのボタンフラグの取得

戻り値

設定済みのボタンフラグ

GetCancelButton()

PadButton MGL::Input::PadState::GetCancelButton ( ) const

inlinenodiscardconstexprnoexcept

キャンセルボタンに割り当てるボタンを取得

戻り値

キャンセルボタンに割り当てるボタン

GetDecideButton()

PadButton MGL::Input::PadState::GetDecideButton ( ) const

inlinenodiscardconstexprnoexcept

決定ボタンに割り当てるボタンを取得

戻り値

決定ボタンに割り当てるボタン

GetDeviceInfo()

const PadDeviceInfo & MGL::Input::PadState::GetDeviceInfo ( ) const

inlinenodiscardconstexprnoexcept

デバイス情報を取得

戻り値

デバイス情報

GetEntry()

PadEntry MGL::Input::PadState::GetEntry ( ) const

inlinenodiscardconstexprnoexcept

エントリー番号の取得

戻り値

設定済みのエントリー番号

GetLeftStick() [1/2]

const Vector2 & MGL::Input::PadState::GetLeftStick ( ) const

inlinenodiscardconstexprnoexcept

左スティックの値を設定

戻り値

左スティックの軸の値

GetLeftStick() [2/2]

Vector2 & MGL::Input::PadState::GetLeftStick ( )

inlinenodiscardconstexprnoexcept

左スティックの値を設定（const版）

戻り値

左スティックの軸の値

GetPlayerIndex()

int32_t MGL::Input::PadState::GetPlayerIndex ( ) const

inlinenodiscardconstexprnoexcept

プレイヤーインデックスの設定

戻り値

設定済みのプレイヤーインデックス

GetPriority()

PadPriority MGL::Input::PadState::GetPriority ( ) const

inlinenodiscardconstexprnoexcept

プライオリティを取得

戻り値

プライオリティ

GetRightStick() [1/2]

const Vector2 & MGL::Input::PadState::GetRightStick ( ) const

inlinenodiscardconstexprnoexcept

右スティックの値を設定

戻り値

右スティックの軸の値

GetRightStick() [2/2]

Vector2 & MGL::Input::PadState::GetRightStick ( )

inlinenodiscardconstexprnoexcept

右スティックの値を設定（const版）

戻り値

右スティックの軸の値

GetType()

PadType MGL::Input::PadState::GetType ( ) const

inlinenodiscardconstexprnoexcept

ゲームパッドの種類を取得

戻り値

設定済みのゲームパッドの種類

HasEntry()

bool MGL::Input::PadState::HasEntry ( ) const

inlinenodiscardconstexprnoexcept

エントリー済みかを取得

戻り値

true	エントリー済み
false	エントリーしていない

HasInputButton()

bool MGL::Input::PadState::HasInputButton ( ) const

inlinenodiscardconstexprnoexcept

いずれかのボタンの入力があるかを取得

戻り値

true	入力がある
false	入力がない

IsARepeat()

bool MGL::Input::PadState::IsARepeat ( PadButton button ) const

inlinenodiscardconstexprnoexcept

リピート入力を取得

引数

[in]

button

チェックするボタン

戻り値

true	リピート入力がある
false	リピート入力がない

IsEnabled()

bool MGL::Input::PadState::IsEnabled ( ) const

inlinenodiscardconstexprnoexcept

このパッドステートが有効かどうかを取得

戻り値

true	有効
false	無効

IsPortraitMode()

bool MGL::Input::PadState::IsPortraitMode ( ) const

inlinenodiscardconstexprnoexcept

ポートレートモード（縦持ち）の取得

戻り値

true	有効
false	無効

IsPressing() [1/2]

bool MGL::Input::PadState::IsPressing ( PadButton button ) const

inlinenodiscardconstexprnoexcept

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

引数

[in]

button

チェックするボタン

戻り値

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

IsPressing() [2/2]

bool MGL::Input::PadState::IsPressing ( PadButtonFlags buttonFlags ) const

inlinenodiscardconstexprnoexcept

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

引数

[in]

buttonFlags

ボタンフラグ

戻り値

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

IsPressingAny()

bool MGL::Input::PadState::IsPressingAny ( PadButtonFlags buttonFlags = kGamepadButtonAll ) const

inlinenodiscardconstexprnoexcept

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

引数

[in]

buttonFlags

ボタンフラグ

戻り値

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

IsReleased()

bool MGL::Input::PadState::IsReleased ( PadButton button ) const

inlinenodiscardconstexprnoexcept

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

引数

[in]

button

チェックするボタン

戻り値

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

IsTriggered()

bool MGL::Input::PadState::IsTriggered ( PadButton button ) const

inlinenodiscardconstexprnoexcept

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

引数

[in]

button

チェックするボタン

戻り値

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

IsUsing()

bool MGL::Input::PadState::IsUsing ( ) const

inlinenodiscardconstexprnoexcept

使用中フラグを取得

戻り値

true	使用中
false	未使用

operator!=()

bool MGL::Input::PadState::operator!= ( const PadState & rhs ) const

inlinenoexcept

不等価演算子のオーバーロード

引数

[in]

rhs

右辺

戻り値

不等価演算の結果

operator==()

bool MGL::Input::PadState::operator== ( const PadState & rhs ) const

inlinenoexcept

等価演算子のオーバーロード

引数

[in]

rhs

右辺

戻り値

等価演算の結果

PostUpdate()

void MGL::Input::PadState::PostUpdate ( const RepeatSetting & repeatSetting )

noexcept

更新後の処理

引数

[in]

repeatSetting

リピート入力設定

RequestsActivate()

void MGL::Input::PadState::RequestsActivate ( PadType type, PadPriority priority, const PadDeviceInfo & deviceInfo )

inlinenoexcept

アクティベート要求

引数

[in]	type	パッドの種類
[in]	priority	パッドのプライオリティ
[in]	deviceInfo	デバイス情報

SetButton() [1/2]

void MGL::Input::PadState::SetButton ( PadButton button )

inlineconstexprnoexcept

ボタンの設定

引数

[in]

button

設定するボタン

SetButton() [2/2]

void MGL::Input::PadState::SetButton ( PadButtonFlags buttonFlags )

inlineconstexprnoexcept

ボタンの設定

引数

[in]

buttonFlags

設定するボタンフラグ

SetCancelButton()

void MGL::Input::PadState::SetCancelButton ( PadButton button )

inlineconstexprnoexcept

キャンセルボタンに割り当てるボタンを設定

引数

[in]

button

キャンセルボタンに割り当てるボタン

SetDecideButton()

void MGL::Input::PadState::SetDecideButton ( PadButton button )

inlineconstexprnoexcept

決定ボタンに割り当てるボタンを設定

引数

[in]

button

決定ボタンに割り当てるボタン

SetEntry()

void MGL::Input::PadState::SetEntry ( PadEntry entry )

inlineconstexprnoexcept

エントリー番号の設定

引数

[in]

entry

設定するエントリー番号

SetLeftStick()

void MGL::Input::PadState::SetLeftStick ( const Vector2 & axisValue )

inlineconstexprnoexcept

左スティックの値を設定

引数

[in]

axisValue

左スティックの軸の値

SetPlayerIndex()

void MGL::Input::PadState::SetPlayerIndex ( int32_t playerIndex )

inlineconstexprnoexcept

プレイヤーインデックスの設定

引数

[in]

playerIndex

設定するプレイヤーインデックス

SetPortraitMode()

void MGL::Input::PadState::SetPortraitMode ( bool isEnabled )

inlineconstexprnoexcept

ポートレートモード（縦持ち）の設定

引数

[in]

isEnabled

有効フラグ

SetRightStick()

void MGL::Input::PadState::SetRightStick ( const Vector2 & axisValue )

inlineconstexprnoexcept

右スティックの値を設定

引数

[in]

axisValue

右スティックの軸の値

SetUsing()

void MGL::Input::PadState::SetUsing ( bool isUsing )

inlineconstexprnoexcept

使用中フラグを設定

引数

[in]

isUsing

使用中フラグ

---

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

• /Users/acerola/work/mgl-work/mgl/include/mgl/input/gamepad/mgl_gamepad_state.h
• /Users/acerola/work/mgl-work/mgl/src/input/gamepad/mgl_gamepad_state.cc