BlamUIWidget_VLayoutGroup Class Reference

Class representing a Vertical Layout Group widget. More...

#include <ui.h>

Inheritance diagram for BlamUIWidget_VLayoutGroup:

Collaboration diagram for BlamUIWidget_VLayoutGroup:

Public Member Functions
	BlamUIWidget_VLayoutGroup (BlamUIWidget_Group *_parent)
	~BlamUIWidget_VLayoutGroup ()
void	Draw () override
	Draws the widget on-screen. More...
void	ShowImGuiPropertyEditor () override
	Displays an ImGUI-based property editor. More...
void	RefreshRelativePosition () override
	Updates the relative position of the widget, relative to its parent. More...
Public Member Functions inherited from BlamUIWidget_Group
	BlamUIWidget_Group (BlamUIWidget_Group *_parent)
	Constructs a new group widget. More...
	BlamUIWidget_Group (BlamWidgetType _type, BlamUIWidget_Group *_parent)
	Constructs a new group widget. More...
	~BlamUIWidget_Group ()
void	UpdateMetrics () override
	Updates metrics for the widget. More...
void	SetHidden (bool new_hidden) override
	Sets the hidden state of the widget. More...
void	ShowImGuiEditorWindow ()
	Displays the separate ImGUI editor window for this group. More...
void	ClearChildren ()
	Clears and destroys all child widgets within the group. More...
Public Member Functions inherited from BlamUIWidget
	BlamUIWidget (BlamWidgetType type)
	Constructs a new UI widget. More...
	BlamUIWidget (BlamWidgetType type, BlamUIWidget_Group *_parent)
	Constructs a new UI widget. More...
virtual	~BlamUIWidget ()
BlamWidgetType	GetType ()
	Retrieves the type of this widget. More...
void	RefreshRelativePosition (int viewport_width, int viewport_height, BlamVector2 initial_position)
	Updates the relative position of the widget. More...
void	SetSize (BlamVector2 new_size)
	Sets the size of the widget. More...
virtual void	SetPosition (BlamVector2 new_position)
	Sets the position of the widget. More...
void	SetRotation (float new_rotation)
	Sets the rotation of the widget. More...
void	SetAnchorPosition (BlamWidgetAnchor new_anchor_position)
	Sets the anchor position of the widget. More...
void	MarkForUpdate ()
	Marks the widget as needing to be updated on the next draw call. More...
BlamVector2	GetAbsolutePosition ()
	Retrieves the absolute position of the widget. More...
BlamWidgetAnchor	GetAnchorPosition ()
	Retrieves the anchor position of the widget. More...
bool	IsHidden ()
	Checks whether or not the widget is hidden. More...

Public Attributes
BlamVector4	padding = { 0, 0, 0, 0 }
	The padding around the layout group. Padding order is top, right, bottom, left. More...
int	item_spacing = 0
	The amount of space to display between items, in pixels. More...
bool	auto_height = false
	Whether or not to automatically adjust the layout height to match its children. More...
Public Attributes inherited from BlamUIWidget_Group
std::vector< BlamUIWidget * >	children = std::vector<BlamUIWidget*>()
	The list of child widgets within this group. More...
bool	show_bounds = false
	Whether or not to display the debug bounding box around this widget. More...
Public Attributes inherited from BlamUIWidget
std::string	display_name = "unnamed"
	The display name of the widget. More...
std::string	description = ""
	An optional description of the widget. More...
BlamVector2	position = { 0, 0 }
	The position of the widget, relative to its parent. More...
BlamVector2	size = { 100, 100 }
	The size of the widget, relative to its parent. More...
float	rotation = 0.0f
	The rotation of the widget, in degrees. More...
int	z_index = 0
	The Z index of the widget, where higher Z orders are drawn on top. More...
float	z_size = 1.0f
	The Z size of the widget. Mostly unused. More...
bool	auto_update = false
	Whether or not the widget should always update every frame. More...
Ogre::HlmsDatablock *	material = nullptr
	The datablock used by the widget, if applicable. More...
BlamUIWidget_Group *	parent = nullptr
	The parent group of this widget, if applicable. More...
bool	ignore_layout = false
	Whether or not this widget should ignore any layout positioning. More...
bool	hide_in_layout = false
	Whether or not this widget should be hidden within its layout. More...
bool	ignore_scale_factor = false
	Whether or not this widget should ignore the UI scale factor settings. More...

Additional Inherited Members
Protected Member Functions inherited from BlamUIWidget
int	GetAdjustedZIndex ()
	Retrieves the adjusted Z-index of the widget. More...
Protected Attributes inherited from BlamUIWidget
BlamVector2	position_absolute = { 0, 0 }
	The absolute position of the widget on-screen. More...
BlamVector2	size_absolute = { 100, 100 }
	The absolute size of the widget on-screen. More...
bool	update = false
	Whether or not the widget needs to be updated before the next draw call. More...
bool	hidden = false
	Whether or not the widget is hidden. More...

Detailed Description

Class representing a Vertical Layout Group widget.

Vertical layout groups behave similarly to Groups, with the additional feature of automatically laying out all items vertically. Items within a layout can choose to be ignored in the layout, however - if desired.

Constructor & Destructor Documentation

BlamUIWidget_VLayoutGroup()

BlamUIWidget_VLayoutGroup::BlamUIWidget_VLayoutGroup

(

BlamUIWidget_Group *

_parent

)

~BlamUIWidget_VLayoutGroup()

BlamUIWidget_VLayoutGroup::~BlamUIWidget_VLayoutGroup

(

)

Here is the call graph for this function:

Member Function Documentation

Draw()

void BlamUIWidget_VLayoutGroup::Draw ( )

overridevirtual

Draws the widget on-screen.

Reimplemented from BlamUIWidget_Group.

Here is the call graph for this function:

Here is the caller graph for this function:

RefreshRelativePosition()

void BlamUIWidget_VLayoutGroup::RefreshRelativePosition ( )

overridevirtual

Updates the relative position of the widget, relative to its parent.

If the widget has no parent, then it will refresh relative to the viewport instead.

Reimplemented from BlamUIWidget_Group.

Here is the call graph for this function:

Here is the caller graph for this function:

ShowImGuiPropertyEditor()

void BlamUIWidget_VLayoutGroup::ShowImGuiPropertyEditor ( )

overridevirtual

Displays an ImGUI-based property editor.

Used in conjunction with the UI Editor window.

Reimplemented from BlamUIWidget_Group.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

auto_height

bool BlamUIWidget_VLayoutGroup::auto_height = false

Whether or not to automatically adjust the layout height to match its children.

item_spacing

int BlamUIWidget_VLayoutGroup::item_spacing = 0

The amount of space to display between items, in pixels.

padding

BlamVector4 BlamUIWidget_VLayoutGroup::padding = { 0, 0, 0, 0 }

The padding around the layout group. Padding order is top, right, bottom, left.

---

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

• blam/components/ui/blam/ui.h
• blam/components/ui/blam/widgets/basic/vlayout.cpp