Class representing a basic rectangle widget. More...

#include <ui.h>

Inheritance diagram for BlamUIWidget_BasicRectangle:

Collaboration diagram for BlamUIWidget_BasicRectangle:

Public Member Functions
	BlamUIWidget_BasicRectangle (BlamUIWidget_Group *_parent)

void	ShowImGuiPropertyEditor () override
	Displays an ImGUI-based property editor. More...

void	GenerateManualObject () override
	Virtual method used to generate the manual object. More...

Public Member Functions inherited from BlamUIWidget_2DPrimitive
	BlamUIWidget_2DPrimitive (BlamWidgetType _type, BlamUIWidget_Group *_parent)
	Constructs a new 2D Primitive widget. More...

	~BlamUIWidget_2DPrimitive ()

void	Draw () override
	Draws the widget on-screen. More...

void	UpdateMetrics () override
	Updates metrics for the widget. More...

void	SetHidden (bool new_hidden) override
	Sets the hidden state of the widget. 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...

virtual void	RefreshRelativePosition ()
	Updates the relative position of the widget, relative to its parent. 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
bool	solid = true
	Whether or not this primitive is solid, or an outline. More...

int	thickness = 1
	The thickness of the primitive. Only used when `solid` is set to `false`. More...

Public Attributes inherited from BlamUIWidget_2DPrimitive
BlamColor	color = BlamColor(255, 255, 255)
	The color of the 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_2DPrimitive
Ogre::ManualObject *	manual_object = nullptr
	The manual object associated with this widget. More...

Ogre::HlmsUnlitDatablock *	datablock = nullptr
	The datablock associated with this widget. More...

Ogre::SceneNode *	node = nullptr
	The scene node associated with this widget. More...

bool	last_hide_state = false
	The last known hidden state. Used to automatically update the widget visibility. More...

bool	needs_regen = true
	Whether or not the manual object needs to be regenerated. 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 basic rectangle widget.

This widget allows for the displaying of a generic colored rectangle on-screen, which can be displayed either as an outline or as a solid box.

Constructor & Destructor Documentation

◆ BlamUIWidget_BasicRectangle()

BlamUIWidget_BasicRectangle::BlamUIWidget_BasicRectangle ( BlamUIWidget_Group * _parent )

Member Function Documentation

◆ GenerateManualObject()

void BlamUIWidget_BasicRectangle::GenerateManualObject ( )

overridevirtual

Virtual method used to generate the manual object.

This method is overridden by any classes which inherit from this one, and is used to populate the vertices, triangles, and/or lines within the manual object as needed.

Reimplemented from BlamUIWidget_2DPrimitive.

Here is the call graph for this function:

◆ ShowImGuiPropertyEditor()

void BlamUIWidget_BasicRectangle::ShowImGuiPropertyEditor ( )

overridevirtual

Displays an ImGUI-based property editor.

Used in conjunction with the UI Editor window.

Reimplemented from BlamUIWidget_2DPrimitive.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ solid

bool BlamUIWidget_BasicRectangle::solid = true

Whether or not this primitive is solid, or an outline.

◆ thickness

int BlamUIWidget_BasicRectangle::thickness = 1

The thickness of the primitive. Only used when solid is set to false.

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

blam/components/ui/blam/ui.h
blam/components/ui/blam/widgets/basic/rectangle.cpp

Public Member Functions

Public Attributes

Additional Inherited Members