Dxlibのウィンドウのボタンの処理・描画を管理するクラス. [詳解]

#include <simple_button.h>

designlab::SimpleButton の継承関係図

[凡例]

designlab::SimpleButton 連携図

[凡例]

公開メンバ関数
	SimpleButton ()=delete
	デフォルトコンストラクタは生成できない.

	SimpleButton (const std::string &text, int x_pos, int y_pos, int x_size, int y_size, bool fit_size=false)
	コンストラクタでボタンのテキスト,座標,サイズを受け取る.

	~SimpleButton ()=default

void	SetActivateFunction (const std::function< void()> &func)
	ボタンがクリックされたときに実行される関数を設定する.

void	SetPos (int pos_x, int pos_y, unsigned int option=kDxlibGuiAnchorLeftTop)
	ボタンの座標を設定する.

constexpr int	GetPosMiddleX () const noexcept
	ボタンのx座標を取得する.

constexpr int	GetPosMiddleY () const noexcept
	ボタンのy座標を取得する.

void	Update () override
	GUIの更新,毎フレーム実行すること.

void	Draw () const override
	GUIの描画.

void	SetVisible (bool visible) override
	GUIの表示を行うかどうかを設定する.

bool	IsVisible () const override
	GUIの表示を行うかどうかを返す.

void	ClickedAction (const DxlibMouseState &state) override
	GUIがクリックされたときに実行される関数. CursorOnGuiが true を返すときに呼び出される. 複数のGUIが重なっている場合は,優先度の高いものから順に呼び出される.

bool	CursorOnGui (int cursor_x, int cursor_y) const noexcept override
	GUIの上にカーソルがあるかどうかを返す.

基底クラス designlab::IDxlibGui に属する継承公開メンバ関数
virtual	~IDxlibGui ()=default

基底クラス designlab::IDxlibClickable に属する継承公開メンバ関数
virtual	~IDxlibClickable ()=default

詳解

Dxlibのウィンドウのボタンの処理・描画を管理するクラス.

simple_button.h の 24 行目に定義があります。

構築子と解体子

◆ SimpleButton() [1/2]

designlab::SimpleButton::SimpleButton ( )

delete

デフォルトコンストラクタは生成できない.

◆ SimpleButton() [2/2]

designlab::SimpleButton::SimpleButton	(	const std::string &	text,
		int	x_pos,
		int	y_pos,
		int	x_size,
		int	y_size,
		bool	fit_size = `false`
	)

コンストラクタでボタンのテキスト,座標,サイズを受け取る.

引数

[in]	text	ボタンに書かれるテキスト.
[in]	x_pos	ボタンのx座標.ボタンの中心座標.
[in]	y_pos	ボタンのy座標.ボタンの中心座標.
[in]	x_size	ボタンの横幅.
[in]	y_size	ボタンの縦幅.
[in]	fit_size	ボタンのサイズをテキストに合わせるかどうか. defaultでは false.

simple_button.cpp の 23 行目に定義があります。

◆ ~SimpleButton()

designlab::SimpleButton::~SimpleButton ( )

default

関数詳解

◆ ClickedAction()

void designlab::SimpleButton::ClickedAction ( const DxlibMouseState & state )

overridevirtual

GUIがクリックされたときに実行される関数.
CursorOnGuiが true を返すときに呼び出される. 複数のGUIが重なっている場合は,優先度の高いものから順に呼び出される.

引数

[in] state マウスの状態.

designlab::IDxlibClickableを実装しています。

simple_button.cpp の 125 行目に定義があります。

◆ CursorOnGui()

bool designlab::SimpleButton::CursorOnGui	(	int	cursor_x,
		int	cursor_y
	)		const

overridevirtualnoexcept

GUIの上にカーソルがあるかどうかを返す.

引数

[in]	cursor_x	マウスカーソルのX座標.左端を0とし,右に正の値をとる.
[in]	cursor_y	マウスカーソルのY座標.上端を0とし,下に正の値をとる.

戻り値: GUIの上にカーソルがあるならば trueを返す.

designlab::IDxlibClickableを実装しています。

simple_button.cpp の 139 行目に定義があります。

◆ Draw()

void designlab::SimpleButton::Draw ( ) const

overridevirtual

GUIの描画.

designlab::IDxlibGuiを実装しています。

simple_button.cpp の 77 行目に定義があります。

呼び出し関係図:

◆ GetPosMiddleX()

constexpr int designlab::SimpleButton::GetPosMiddleX ( ) const

inlineconstexprnoexcept

ボタンのx座標を取得する.

戻り値: ボタンのx座標.ボタンの中心座標.

simple_button.h の 59 行目に定義があります。

◆ GetPosMiddleY()

constexpr int designlab::SimpleButton::GetPosMiddleY ( ) const

inlineconstexprnoexcept

ボタンのy座標を取得する.

戻り値: ボタンのy座標.ボタンの中心座標.

simple_button.h の 66 行目に定義があります。

◆ IsVisible()

bool designlab::SimpleButton::IsVisible ( ) const

inlineoverridevirtual

GUIの表示を行うかどうかを返す.

戻り値: GUIの表示を行うかどうか.

designlab::IDxlibGuiを実装しています。

simple_button.h の 80 行目に定義があります。

◆ SetActivateFunction()

void designlab::SimpleButton::SetActivateFunction ( const std::function< void()> & func )

inline

ボタンがクリックされたときに実行される関数を設定する.

引数

[in] func ボタンがクリックされたときに実行される関数.

simple_button.h の 45 行目に定義があります。

◆ SetPos()

void designlab::SimpleButton::SetPos	(	int	pos_x,
		int	pos_y,
		unsigned int	option = `kDxlibGuiAnchorLeftTop`
	)

ボタンの座標を設定する.

引数

[in]	pos_x	ボタンのx座標.
[in]	pos_y	ボタンのy座標.
[in]	option	ボタンのどの地点を起点に座標を設定するかを指定する. defaultでは左上を起点とする.

simple_button.cpp の 37 行目に定義があります。

◆ SetVisible()

void designlab::SimpleButton::SetVisible ( bool visible )

inlineoverridevirtual

GUIの表示を行うかどうかを設定する.

引数

[in] visible GUIの表示を行うかどうか.

designlab::IDxlibGuiを実装しています。

simple_button.h の 75 行目に定義があります。

◆ Update()

void designlab::SimpleButton::Update ( )

overridevirtual

GUIの更新,毎フレーム実行すること.

designlab::IDxlibGuiを実装しています。

simple_button.cpp の 67 行目に定義があります。

呼び出し関係図:

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

DesignLab/simple_button.h
DesignLab/simple_button.cpp

公開メンバ関数

詳解

構築子と解体子

◆ SimpleButton() [1/2]

◆ SimpleButton() [2/2]

◆ ~SimpleButton()

関数詳解

◆ ClickedAction()

◆ CursorOnGui()

◆ Draw()

◆ GetPosMiddleX()

◆ GetPosMiddleY()

◆ IsVisible()

◆ SetActivateFunction()

◆ SetPos()

◆ SetVisible()

◆ Update()