Class used for the coordinates display UI. More...

#include <BlamUIWidget_CoordinatesDisplay.h>

Inheritance diagram for BlamUIWidget_CoordinatesDisplay:

Collaboration diagram for BlamUIWidget_CoordinatesDisplay:

Public Member Functions
	BlamUIWidget_CoordinatesDisplay (BlamUIWidget_Group *_parent)

	~BlamUIWidget_CoordinatesDisplay ()

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

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

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

void	RefreshRelativePosition () override
	Updates the relative position of the widget, relative to its parent. More...

void	OnTickEvent (TickEvent *event) override

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...

	BlamUIWidget (std::string type)
	Constructs a new UI widget. More...

	BlamUIWidget (std::string 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...

bool	IsMarkedForUpdate ()

void	SetMarkedForUpdate (bool _update)

BlamVector2	GetAbsolutePosition ()
	Retrieves the absolute position of the widget. More...

BlamWidgetAnchor	GetAnchorPosition ()
	Retrieves the anchor position of the widget. More...

virtual void	SetHidden (bool new_hidden)
	Sets the hidden state of the widget. More...

bool	IsHidden ()
	Checks whether or not the widget is hidden. More...

std::string	GetCustomType ()
	Retrieves the custom type name of this widget. More...

Additional Inherited Members
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...

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...

Detailed Description

Class used for the coordinates display UI.

This widget is used to display the current camera coordinates in the top-left of the screen. It displays position and rotation coordinates, as well as the camera mode and speed.

Constructor & Destructor Documentation

◆ BlamUIWidget_CoordinatesDisplay()

BlamUIWidget_CoordinatesDisplay::BlamUIWidget_CoordinatesDisplay ( BlamUIWidget_Group * _parent )

Here is the call graph for this function:

◆ ~BlamUIWidget_CoordinatesDisplay()

BlamUIWidget_CoordinatesDisplay::~BlamUIWidget_CoordinatesDisplay ( )

Member Function Documentation

◆ Draw()

void BlamUIWidget_CoordinatesDisplay::Draw ( )

overridevirtual

Draws the widget on-screen.

Reimplemented from BlamUIWidget.

Here is the call graph for this function:

◆ OnTickEvent()

void BlamUIWidget_CoordinatesDisplay::OnTickEvent ( TickEvent * event )

override

Here is the call graph for this function:

◆ RefreshRelativePosition()

void BlamUIWidget_CoordinatesDisplay::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.

Here is the call graph for this function:

◆ ShowImGuiPropertyEditor()

void BlamUIWidget_CoordinatesDisplay::ShowImGuiPropertyEditor ( )

overridevirtual

Displays an ImGUI-based property editor.

Used in conjunction with the UI Editor window.

Reimplemented from BlamUIWidget.

Here is the call graph for this function:

◆ UpdateMetrics()

void BlamUIWidget_CoordinatesDisplay::UpdateMetrics ( )

overridevirtual

Updates metrics for the widget.

The term "metrics" as used in this method is generally up to an individual widget class to decide. However, in most cases, it will include position, size, rotation, and color.

Note: This should NOT be called from threads besides the rendering thread. To update metrics from other threads, use MarkForUpdate.

Reimplemented from BlamUIWidget.

Here is the call graph for this function:

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

blam/components/ui/blam/widgets/builtin/coordinates_display/BlamUIWidget_CoordinatesDisplay.h
blam/components/ui/blam/widgets/builtin/coordinates_display/BlamUIWidget_CoordinatesDisplay.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlamUIWidget_CoordinatesDisplay()

◆ ~BlamUIWidget_CoordinatesDisplay()

Member Function Documentation

◆ Draw()

◆ OnTickEvent()

◆ RefreshRelativePosition()

◆ ShowImGuiPropertyEditor()

◆ UpdateMetrics()