BlamUIWidget Class Reference

#include <ui.h>

Inheritance diagram for BlamUIWidget:

Collaboration diagram for BlamUIWidget:

Public Member Functions
	BlamUIWidget (BlamWidgetType type)
	BlamUIWidget (BlamWidgetType type, BlamUIWidget_Group *_parent)
virtual	~BlamUIWidget ()
virtual void	Draw ()
virtual void	ShowImGuiPropertyEditor ()
virtual void	UpdateMetrics ()
BlamWidgetType	GetType ()
virtual void	RefreshRelativePosition ()
void	RefreshRelativePosition (int viewport_width, int viewport_height, BlamVector2 initial_position)
void	SetSize (BlamVector2 new_size)
virtual void	SetPosition (BlamVector2 new_position)
void	SetRotation (float new_rotation)
void	SetAnchorPosition (BlamWidgetAnchor new_anchor_position)
void	MarkForUpdate ()
BlamVector2	GetAbsolutePosition ()
BlamWidgetAnchor	GetAnchorPosition ()
virtual void	SetHidden (bool new_hidden)
bool	IsHidden ()

Public Attributes
std::string	display_name = "unnamed"
std::string	description = ""
BlamVector2	position = { 0, 0 }
BlamVector2	size = { 100, 100 }
float	rotation = 0.0f
int	z_index = 0
float	z_size = 1.0f
bool	auto_update = false
Ogre::HlmsDatablock *	material = nullptr
BlamUIWidget_Group *	parent = nullptr
bool	ignore_layout = false
bool	hide_in_layout = false

Protected Member Functions
int	GetAdjustedZIndex ()

Protected Attributes
BlamVector2	position_absolute = { 0, 0 }
BlamVector2	size_absolute = { 100, 100 }
bool	update = false
bool	hidden = false

Constructor & Destructor Documentation

BlamUIWidget() [1/2]

BlamUIWidget::BlamUIWidget

(

BlamWidgetType

type

)

Here is the call graph for this function:

BlamUIWidget() [2/2]

BlamUIWidget::BlamUIWidget	(	BlamWidgetType	type,
		BlamUIWidget_Group *	_parent
	)

Here is the call graph for this function:

~BlamUIWidget()

virtual BlamUIWidget::~BlamUIWidget ( )

inlinevirtual

Member Function Documentation

Draw()

virtual void BlamUIWidget::Draw ( )

inlinevirtual

Reimplemented in BlamUIWidget_Text, BlamUIWidget_BasicTriangle, BlamUIWidget_BasicLine, BlamUIWidget_BasicEllipse, BlamUIWidget_BasicRectangle, BlamUIWidget_VLayoutGroup, BlamUIWidget_Group, BlamUIWidget_DebugMenu, BlamUIWidget_Console, BlamUIWidget_DebugMenu_Item, BlamUIWidget_UserIDCypher, BlamUIWidget_CoordinatesDisplay, and BlamUIWidget_FramerateDisplay.

GetAbsolutePosition()

BlamVector2 BlamUIWidget::GetAbsolutePosition

(

)

Here is the caller graph for this function:

GetAdjustedZIndex()

int BlamUIWidget::GetAdjustedZIndex ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

GetAnchorPosition()

BlamWidgetAnchor BlamUIWidget::GetAnchorPosition

(

)

Here is the caller graph for this function:

GetType()

BlamWidgetType BlamUIWidget::GetType

(

)

Here is the caller graph for this function:

IsHidden()

bool BlamUIWidget::IsHidden

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

MarkForUpdate()

void BlamUIWidget::MarkForUpdate

(

)

Here is the caller graph for this function:

RefreshRelativePosition() [1/2]

void BlamUIWidget::RefreshRelativePosition ( )

virtual

Reimplemented in BlamUIWidget_VLayoutGroup, BlamUIWidget_Group, BlamUIWidget_DebugMenu, BlamUIWidget_Console, BlamUIWidget_UserIDCypher, BlamUIWidget_CoordinatesDisplay, and BlamUIWidget_FramerateDisplay.

Here is the call graph for this function:

Here is the caller graph for this function:

RefreshRelativePosition() [2/2]

void BlamUIWidget::RefreshRelativePosition	(	int	viewport_width,
		int	viewport_height,
		BlamVector2	initial_position
	)

Here is the call graph for this function:

SetAnchorPosition()

void BlamUIWidget::SetAnchorPosition

(

BlamWidgetAnchor

new_anchor_position

)

Here is the call graph for this function:

Here is the caller graph for this function:

SetHidden()

void BlamUIWidget::SetHidden ( bool  new_hidden )

virtual

Reimplemented in BlamUIWidget_Text, BlamUIWidget_BasicTriangle, BlamUIWidget_BasicLine, BlamUIWidget_BasicEllipse, BlamUIWidget_BasicRectangle, BlamUIWidget_Group, BlamUIWidget_DebugMenu, BlamUIWidget_DebugMenu_Item, and BlamUIWidget_CrashScreen.

Here is the caller graph for this function:

SetPosition()

void BlamUIWidget::SetPosition ( BlamVector2  new_position )

virtual

Reimplemented in BlamUIWidget_DebugMenu_Item.

Here is the call graph for this function:

Here is the caller graph for this function:

SetRotation()

void BlamUIWidget::SetRotation

(

float

new_rotation

)

Here is the call graph for this function:

Here is the caller graph for this function:

SetSize()

void BlamUIWidget::SetSize

(

BlamVector2

new_size

)

Here is the call graph for this function:

Here is the caller graph for this function:

ShowImGuiPropertyEditor()

void BlamUIWidget::ShowImGuiPropertyEditor ( )

virtual

Reimplemented in BlamUIWidget_Text, BlamUIWidget_BasicTriangle, BlamUIWidget_BasicLine, BlamUIWidget_BasicEllipse, BlamUIWidget_BasicRectangle, BlamUIWidget_VLayoutGroup, BlamUIWidget_Group, BlamUIWidget_DebugMenu, BlamUIWidget_Console, BlamUIWidget_DebugMenu_Item, BlamUIWidget_UserIDCypher, BlamUIWidget_CoordinatesDisplay, and BlamUIWidget_FramerateDisplay.

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateMetrics()

virtual void BlamUIWidget::UpdateMetrics ( )

inlinevirtual

Reimplemented in BlamUIWidget_Text, BlamUIWidget_BasicTriangle, BlamUIWidget_BasicLine, BlamUIWidget_BasicEllipse, BlamUIWidget_BasicRectangle, BlamUIWidget_Group, BlamUIWidget_DebugMenu, BlamUIWidget_Console, BlamUIWidget_DebugMenu_Item, BlamUIWidget_UserIDCypher, BlamUIWidget_CoordinatesDisplay, and BlamUIWidget_FramerateDisplay.

Here is the caller graph for this function:

Member Data Documentation

auto_update

bool BlamUIWidget::auto_update = false

description

std::string BlamUIWidget::description = ""

display_name

std::string BlamUIWidget::display_name = "unnamed"

hidden

bool BlamUIWidget::hidden = false

protected

hide_in_layout

bool BlamUIWidget::hide_in_layout = false

ignore_layout

bool BlamUIWidget::ignore_layout = false

material

Ogre::HlmsDatablock* BlamUIWidget::material = nullptr

parent

BlamUIWidget_Group* BlamUIWidget::parent = nullptr

position

BlamVector2 BlamUIWidget::position = { 0, 0 }

position_absolute

BlamVector2 BlamUIWidget::position_absolute = { 0, 0 }

protected

rotation

float BlamUIWidget::rotation = 0.0f

size

BlamVector2 BlamUIWidget::size = { 100, 100 }

size_absolute

BlamVector2 BlamUIWidget::size_absolute = { 100, 100 }

protected

update

bool BlamUIWidget::update = false

protected

z_index

int BlamUIWidget::z_index = 0

z_size

float BlamUIWidget::z_size = 1.0f

---

The documentation for this class was generated from the following files:

• blam/components/ui/blam/ui.h
• blam/components/ui/blam/BlamUIWidget.cpp