UIウィジットクラス [詳解]

#include <mgl_ui_widget.h>

MGL::UI::Widget の継承関係図

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

void	Update (const MGL::Vector2 &offset=MGL::Vector2(0.0f, 0.0f), bool updateEvent=true) noexcept
	更新処理

void	Render (const MGL::Vector2 &offset=MGL::Vector2(0.0f, 0.0f)) noexcept
	描画処理

void	Update (bool updateEvent) noexcept
	更新処理（オフセットなし）

virtual MGL::Rectangle	GetRectangle () const noexcept=0
	矩形の取得

constexpr uint32_t	GetTypeIdentifier () const noexcept
	ウィジットの種類の識別子を取得

void	SetVisible (bool isVisible) noexcept
	可視状態の設定

bool	IsVisible () const noexcept
	可視状態の取得

constexpr bool	GetLocalVisibleFlag () const noexcept
	このウィジットに設定された可視状態のフラグを取得

constexpr void	SetTransparency (float transparency) noexcept
	透過値の設定

constexpr float	GetLocalTransparency () const noexcept
	このウィジットに設定された透過値の設定

float	GetTransparency () const noexcept
	透過値の取得

MGL::Vector2	GetPosition () const noexcept
	位置を取得

constexpr MGL::Vector2	GetSize () const noexcept
	サイズを取得

MGL::Vector2	GetParentSize () const noexcept
	親のサイズを取得

bool	AddChild (Widget *child) noexcept
	子ウィジットの追加

bool	RemoveChild (Widget *child) noexcept
	子ウィジットの削除

const Widget *	GetParent () const noexcept
	親ウィジットの取得

const MGL::STL::list< Widget * > &	GetChildren () const noexcept
	子ウィジットの取得

bool	ActivateEventContext (EventListener listener, EventDelegate delegate) noexcept
	イベントコンテキストのアクティベート

bool	ActivateEventContext (EventListener *listener) noexcept
	イベントコンテキストのアクティベート

constexpr void	SetEventIdentifier (EventID identifier) noexcept
	イベントIDを設定

constexpr EventID	GetEventIdentifier () const noexcept
	イベントIDを取得

constexpr void	SetPivot (const MGL::Alignment &pivotAlignment) noexcept
	ウィジットの中心アライメントを設定

constexpr const MGL::Alignment &	GetPivot () const noexcept
	ウィジットの中心アライメントを取得

constexpr void	SetAnchor (const MGL::Alignment &anchorAlignment) noexcept
	ウィジットのアンカーを設定

constexpr const MGL::Alignment &	GetAnchor () const noexcept
	ウィジットのアンカー取得

constexpr EventState	GetEventState () const noexcept
	イベントのステートを取得

constexpr MGL::Input::TouchID	GetEventTouchID () const noexcept
	イベントのタッチIDを取得

限定公開メンバ関数
virtual void	OnUpdate (const MGL::Vector2 &position) noexcept
	更新処理

virtual void	OnRender (const MGL::Vector2 &position) noexcept
	描画処理

virtual void	OnNotifiedEvent (EventType eventType, uint32_t argument) noexcept
	イベント通知後の処理

詳解

UIウィジットクラス

関数詳解

◆ ActivateEventContext() [1/2]

bool MGL::UI::Widget::ActivateEventContext ( EventListener * listener )

noexcept

イベントコンテキストのアクティベート

引数

[in] listener イベントリスナー

戻り値

true	成功
false	失敗

◆ ActivateEventContext() [2/2]

bool MGL::UI::Widget::ActivateEventContext	(	EventListener *	listener,
		EventDelegate *	delegate )

noexcept

イベントコンテキストのアクティベート

引数

[in]	listener	イベントリスナー
[in]	delegate	イベントデリゲート

戻り値

true	成功
false	失敗

◆ AddChild()

bool MGL::UI::Widget::AddChild ( Widget * child )

noexcept

子ウィジットの追加

引数

[in] child 子ウィジット

◆ GetAnchor()

const MGL::Alignment & MGL::UI::Widget::GetAnchor ( ) const

inlinenodiscardconstexprnoexcept

ウィジットのアンカー取得

戻り値: アンカー設定

◆ GetChildren()

const MGL::STL::list< Widget * > & MGL::UI::Widget::GetChildren ( ) const

inlinenodiscardnoexcept

子ウィジットの取得

戻り値: 子ウィジットのリスト

◆ GetEventIdentifier()

EventID MGL::UI::Widget::GetEventIdentifier ( ) const

inlinenodiscardconstexprnoexcept

イベントIDを取得

戻り値: イベントID

◆ GetEventState()

EventState MGL::UI::Widget::GetEventState ( ) const

inlinenodiscardconstexprnoexcept

イベントのステートを取得

戻り値: イベントのステート

◆ GetEventTouchID()

MGL::Input::TouchID MGL::UI::Widget::GetEventTouchID ( ) const

inlinenodiscardconstexprnoexcept

イベントのタッチIDを取得

戻り値: イベントのタッチID

◆ GetLocalTransparency()

float MGL::UI::Widget::GetLocalTransparency ( ) const

inlinenodiscardconstexprnoexcept

このウィジットに設定された透過値の設定

戻り値: このウィジットの透過値

◆ GetLocalVisibleFlag()

bool MGL::UI::Widget::GetLocalVisibleFlag ( ) const

inlinenodiscardconstexprnoexcept

このウィジットに設定された可視状態のフラグを取得

戻り値: 可視状態のフラグ

◆ GetParent()

const Widget * MGL::UI::Widget::GetParent ( ) const

inlinenodiscardnoexcept

親ウィジットの取得

戻り値: 親ウィジット

◆ GetParentSize()

MGL::Vector2 MGL::UI::Widget::GetParentSize ( ) const

nodiscardnoexcept

親のサイズを取得

戻り値: 親のサイズ．親がいない場合はレンダーターゲットのサイズ

◆ GetPivot()

const MGL::Alignment & MGL::UI::Widget::GetPivot ( ) const

inlinenodiscardconstexprnoexcept

ウィジットの中心アライメントを取得

戻り値: 中心位置のアライメント

◆ GetPosition()

MGL::Vector2 MGL::UI::Widget::GetPosition ( ) const

nodiscardnoexcept

位置を取得

戻り値: ウィジットの位置

◆ GetRectangle()

virtual MGL::Rectangle MGL::UI::Widget::GetRectangle ( ) const

nodiscardpure virtualnoexcept

矩形の取得

戻り値: このウィジットの矩形

◆ GetSize()

MGL::Vector2 MGL::UI::Widget::GetSize ( ) const

inlinenodiscardconstexprnoexcept

サイズを取得

戻り値: サイズ

◆ GetTransparency()

float MGL::UI::Widget::GetTransparency ( ) const

nodiscardnoexcept

透過値の取得

戻り値: 透過値

◆ GetTypeIdentifier()

uint32_t MGL::UI::Widget::GetTypeIdentifier ( ) const

inlinenodiscardconstexprnoexcept

ウィジットの種類の識別子を取得

戻り値: 識別子

◆ IsVisible()

bool MGL::UI::Widget::IsVisible ( ) const

nodiscardnoexcept

可視状態の取得

戻り値

true	可視
false	不可視

◆ OnNotifiedEvent()

virtual void MGL::UI::Widget::OnNotifiedEvent	(	EventType	eventType,
		uint32_t	argument )

inlineprotectedvirtualnoexcept

イベント通知後の処理

引数

[in] eventType 通知したイベントの種類

◆ OnRender()

virtual void MGL::UI::Widget::OnRender ( const MGL::Vector2 & position )

inlineprotectedvirtualnoexcept

描画処理

引数

[in] position このウィジットの位置

◆ OnUpdate()

virtual void MGL::UI::Widget::OnUpdate ( const MGL::Vector2 & position )

inlineprotectedvirtualnoexcept

更新処理

引数

[in] position このウィジットの位置

◆ RemoveChild()

bool MGL::UI::Widget::RemoveChild ( Widget * child )

noexcept

子ウィジットの削除

引数

[in] child 削除するウィジット

戻り値

true	成功
false	失敗

◆ Render()

void MGL::UI::Widget::Render ( const MGL::Vector2 & offset = MGL::Vector2(0.0f, 0.0f) )

noexcept

描画処理

引数

[in] offset オフセット

◆ SetAnchor()

void MGL::UI::Widget::SetAnchor ( const MGL::Alignment & anchorAlignment )

inlineconstexprnoexcept

ウィジットのアンカーを設定

引数

[in] anchorAlignment アンカー設定

◆ SetEventIdentifier()

void MGL::UI::Widget::SetEventIdentifier ( EventID identifier )

inlineconstexprnoexcept

イベントIDを設定

引数

[in] identifier 設定するイベントID

◆ SetPivot()

void MGL::UI::Widget::SetPivot ( const MGL::Alignment & pivotAlignment )

inlineconstexprnoexcept

ウィジットの中心アライメントを設定

引数

[in] pivotAlignment 中心位置のアライメント

◆ SetTransparency()

void MGL::UI::Widget::SetTransparency ( float transparency )

inlineconstexprnoexcept

透過値の設定

引数

[in] transparency 設定する透過値

◆ SetVisible()

void MGL::UI::Widget::SetVisible ( bool isVisible )

noexcept

可視状態の設定

引数

[in] isVisible 設定する可視状態．trueで可視

◆ Update() [1/2]

void MGL::UI::Widget::Update ( bool updateEvent )

inlinenoexcept

更新処理（オフセットなし）

引数

[in] updateEvent イベント更新を行うかのフラグ

◆ Update() [2/2]

void MGL::UI::Widget::Update	(	const MGL::Vector2 &	offset = MGL::Vector2(0.0f, 0.0f),
		bool	updateEvent = true )

noexcept

更新処理

引数

[in]	offset	オフセット
[in]	updateEvent	イベント更新フラグ

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

/Users/acerola/work/mgl-work/mgl/include/mgl/ui/mgl_ui_widget.h
/Users/acerola/work/mgl-work/mgl/src/ui/mgl_ui_widget.cc

公開メンバ関数

限定公開メンバ関数

詳解

関数詳解

◆ ActivateEventContext() [1/2]

◆ ActivateEventContext() [2/2]

◆ AddChild()

◆ GetAnchor()

◆ GetChildren()

◆ GetEventIdentifier()

◆ GetEventState()

◆ GetEventTouchID()

◆ GetLocalTransparency()

◆ GetLocalVisibleFlag()

◆ GetParent()

◆ GetParentSize()

◆ GetPivot()

◆ GetPosition()

◆ GetRectangle()

◆ GetSize()

◆ GetTransparency()

◆ GetTypeIdentifier()

◆ IsVisible()

◆ OnNotifiedEvent()

◆ OnRender()

◆ OnUpdate()

◆ RemoveChild()

◆ Render()

◆ SetAnchor()

◆ SetEventIdentifier()

◆ SetPivot()

◆ SetTransparency()

◆ SetVisible()

◆ Update() [1/2]

◆ Update() [2/2]