Dxlibを使ったGUIの抽象クラス． [詳解]

#include <abstract_dxlib_gui.h>

designlab::AbstractDxlibGui の継承関係図

[凡例]

designlab::AbstractDxlibGui 連携図

[凡例]

公開メンバ関数
	AbstractDxlibGui ()=delete

	AbstractDxlibGui (int width, int height)

virtual	~AbstractDxlibGui ()=default

void	SetPos (int pos_x, int pos_y, unsigned int option=kDxlibGuiAnchorLeftTop, bool this_is_first_time=false)
	GUIの位置を設定する． Dxlibの画面の座標は左上を原点とし，右下に行くほど値が大きくなる．横方向にx軸，縦方向にy軸をとる．

virtual void	Update ()=0
	GUIの更新，毎フレーム実行すること．

virtual void	Draw () const =0
	GUIの描画．

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

constexpr 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の上にカーソルがあるかどうかを返す．

bool	IsDraggable (int cursor_x, int cursor_y) const override
	ドラッグ可能な位置にあるかを判定する．

bool	IsDragged () const override
	ドラッグ中かどうかを取得する．

void	SetDragged (const bool is_dragged) override
	ドラッグ中かどうかを設定する．

void	DraggedAction (int cursor_dif_x, int cursor_dif_y, unsigned int mouse_key_bit) override
	ドラッグ中の処理を行う．カーソルは上にあるけど，ドラッグ中ではない場合でも呼び出される．

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

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

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

限定公開メンバ関数
void	DrawBackground (const std::string &str) const

限定公開変数類
std::vector< std::unique_ptr< SimpleButton > >	button_
	ボタンのリスト．

const int	width_
	GUIの横幅．

const int	height_
	GUIの縦幅．

bool	visible_ { true }
	GUIが表示されているかどうかのフラグ．

bool	is_dragging_ { false }

int	gui_left_pos_x_ { 0 }
	GUIの左端の位置．

int	gui_top_pos_y_ { 0 }
	GUIの上端の位置．

int	init_pos_x_ { 0 }
	SetされたGUIの左上のX座標．

int	init_pos_y_ { 0 }
	SetされたGUIの左上のY座標．

int	font_handle_ { -1 }
	フォントハンドル．

静的限定公開変数類
static constexpr int	kTitleBarHeight { 32 }
	タイトルバーの高さ．

詳解

Dxlibを使ったGUIの抽象クラス．

このクラスは，Dxlibを使ったGUIの抽象クラスである．このクラスを継承して，GUIを作成する．

abstract_dxlib_gui.h の 28 行目に定義があります。

構築子と解体子

◆ AbstractDxlibGui() [1/2]

designlab::AbstractDxlibGui::AbstractDxlibGui ( )

delete

◆ AbstractDxlibGui() [2/2]

designlab::AbstractDxlibGui::AbstractDxlibGui	(	int	width,
		int	height
	)

abstract_dxlib_gui.cpp の 20 行目に定義があります。

◆ ~AbstractDxlibGui()

virtual designlab::AbstractDxlibGui::~AbstractDxlibGui ( )

virtualdefault

関数詳解

◆ ClickedAction()

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

overridevirtual

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

引数

[in] state マウスの状態．

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

abstract_dxlib_gui.cpp の 92 行目に定義があります。

◆ CursorOnGui()

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

overridevirtualnoexcept

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

引数

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

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

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

abstract_dxlib_gui.cpp の 104 行目に定義があります。

被呼び出し関係図:

◆ DraggedAction()

void designlab::AbstractDxlibGui::DraggedAction	(	int	cursor_dif_x,
		int	cursor_dif_y,
		unsigned int	mouse_key_bit
	)

overridevirtual

ドラッグ中の処理を行う．
カーソルは上にあるけど，ドラッグ中ではない場合でも呼び出される．

引数

[in]	cursor_dif_x	前回のフレームからのマウスカーソルのX座標の差分．
[in]	cursor_dif_y	前回のフレームからのマウスカーソルのY座標の差分．
[in]	mouse_key_bit	押されているマウスのボタン，Dxlib の定数， MOUSE_INPUT_LEFT などで指定する．

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

abstract_dxlib_gui.cpp の 126 行目に定義があります。

呼び出し関係図:

◆ Draw()

virtual void designlab::AbstractDxlibGui::Draw ( ) const

pure virtual

GUIの描画．

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

designlab::DxlibGuiCamera, designlab::DxlibGuiCameraParameterDisplayer, designlab::DxlibGuiDisplayNodeSwitcher, designlab::DxlibGuiNodeDisplayer, designlab::DxlibGuiRobotControlで実装されています。

◆ DrawBackground()

void designlab::AbstractDxlibGui::DrawBackground ( const std::string & str ) const

protected

abstract_dxlib_gui.cpp の 140 行目に定義があります。

被呼び出し関係図:

◆ IsDraggable()

bool designlab::AbstractDxlibGui::IsDraggable	(	int	cursor_x,
		int	cursor_y
	)		const

overridevirtual

ドラッグ可能な位置にあるかを判定する．

引数

[in]	cursor_x	マウスカーソルのX座標．左端が0．右方向に正．
[in]	cursor_y	マウスカーソルのY座標．上端が0．下方向に正．

戻り値: GUI状にマウスカーネルがあって，ドラッグ可能であるならば true．

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

abstract_dxlib_gui.cpp の 116 行目に定義があります。

呼び出し関係図:

◆ IsDragged()

bool designlab::AbstractDxlibGui::IsDragged ( ) const

inlineoverridevirtual

ドラッグ中かどうかを取得する．

戻り値: ドラッグ中ならば true．

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

abstract_dxlib_gui.h の 71 行目に定義があります。

◆ IsVisible()

constexpr bool designlab::AbstractDxlibGui::IsVisible ( ) const

inlineconstexproverridevirtual

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

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

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

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

被呼び出し関係図:

◆ SetDragged()

void designlab::AbstractDxlibGui::SetDragged ( const bool is_dragged )

inlineoverridevirtual

ドラッグ中かどうかを設定する．

引数

[in] is_dragged ドラッグ中にしたいなら true．

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

abstract_dxlib_gui.h の 76 行目に定義があります。

◆ SetPos()

void designlab::AbstractDxlibGui::SetPos	(	int	pos_x,
		int	pos_y,
		unsigned int	option = `kDxlibGuiAnchorLeftTop`,
		bool	this_is_first_time = `false`
	)

GUIの位置を設定する．
Dxlibの画面の座標は左上を原点とし，右下に行くほど値が大きくなる．
横方向にx軸，縦方向にy軸をとる．

引数

[in]	pos_x	GUIのx座標．
[in]	pos_y	GUIのy座標．
[in]	option	GUIのどの地点を起点に座標を設定するかを指定する． defaultでは左上を起点とする．
[in]	this_is_first_time	この呼び出しが初めてかどうかを指定する． defaultでは false．trueを指定すると，GUIの位置を設定するだけでなく， GUIの初期位置を更新する．

abstract_dxlib_gui.cpp の 27 行目に定義があります。

被呼び出し関係図:

◆ SetVisible()

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

overridevirtual

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

引数

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

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

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

呼び出し関係図:

被呼び出し関係図:

◆ Update()

virtual void designlab::AbstractDxlibGui::Update ( )

pure virtual

GUIの更新，毎フレーム実行すること．

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

designlab::DxlibGuiCamera, designlab::DxlibGuiCameraParameterDisplayer, designlab::DxlibGuiDisplayNodeSwitcher, designlab::DxlibGuiNodeDisplayer, designlab::DxlibGuiRobotControlで実装されています。

被呼び出し関係図:

メンバ詳解

◆ button_

std::vector<std::unique_ptr<SimpleButton> > designlab::AbstractDxlibGui::button_

protected

ボタンのリスト．

abstract_dxlib_gui.h の 87 行目に定義があります。

◆ font_handle_

int designlab::AbstractDxlibGui::font_handle_ { -1 }

protected

フォントハンドル．

abstract_dxlib_gui.h の 106 行目に定義があります。

◆ gui_left_pos_x_

int designlab::AbstractDxlibGui::gui_left_pos_x_ { 0 }

protected

GUIの左端の位置．

abstract_dxlib_gui.h の 100 行目に定義があります。

◆ gui_top_pos_y_

int designlab::AbstractDxlibGui::gui_top_pos_y_ { 0 }

protected

GUIの上端の位置．

abstract_dxlib_gui.h の 101 行目に定義があります。

◆ height_

const int designlab::AbstractDxlibGui::height_

protected

GUIの縦幅．

abstract_dxlib_gui.h の 92 行目に定義があります。

◆ init_pos_x_

int designlab::AbstractDxlibGui::init_pos_x_ { 0 }

protected

SetされたGUIの左上のX座標．

abstract_dxlib_gui.h の 103 行目に定義があります。

◆ init_pos_y_

int designlab::AbstractDxlibGui::init_pos_y_ { 0 }

protected

SetされたGUIの左上のY座標．

abstract_dxlib_gui.h の 104 行目に定義があります。

◆ is_dragging_

bool designlab::AbstractDxlibGui::is_dragging_ { false }

protected

abstract_dxlib_gui.h の 98 行目に定義があります。

◆ kTitleBarHeight

constexpr int designlab::AbstractDxlibGui::kTitleBarHeight { 32 }

staticconstexprprotected

タイトルバーの高さ．

abstract_dxlib_gui.h の 89 行目に定義があります。

◆ visible_

bool designlab::AbstractDxlibGui::visible_ { true }

protected

GUIが表示されているかどうかのフラグ．

ドラッグ中かどうかのフラグ．

abstract_dxlib_gui.h の 95 行目に定義があります。

◆ width_

const int designlab::AbstractDxlibGui::width_

protected

GUIの横幅．

abstract_dxlib_gui.h の 91 行目に定義があります。

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

DesignLab/abstract_dxlib_gui.h
DesignLab/abstract_dxlib_gui.cpp

公開メンバ関数

限定公開メンバ関数

限定公開変数類

静的限定公開変数類

詳解

構築子と解体子

◆ AbstractDxlibGui() [1/2]

◆ AbstractDxlibGui() [2/2]

◆ ~AbstractDxlibGui()

関数詳解

◆ ClickedAction()

◆ CursorOnGui()

◆ DraggedAction()

◆ Draw()

◆ DrawBackground()

◆ IsDraggable()

◆ IsDragged()

◆ IsVisible()

◆ SetDragged()

◆ SetPos()

◆ SetVisible()

◆ Update()

メンバ詳解

◆ button_

◆ font_handle_

◆ gui_left_pos_x_

◆ gui_top_pos_y_

◆ height_

◆ init_pos_x_

◆ init_pos_y_

◆ is_dragging_

◆ kTitleBarHeight

◆ visible_

◆ width_