Class used for the crash screen UI. More...

#include <BlamUIWidget_CrashScreen.h>

Inheritance diagram for BlamUIWidget_CrashScreen:

Collaboration diagram for BlamUIWidget_CrashScreen:

Public Member Functions
	BlamUIWidget_CrashScreen (BlamUIWidget_Group *_parent)

void	SetBasicMessage (std::string additional_info="")
	Reconfigures the crash screen text to display a basic message. More...

void	SetDetailedMessage (std::string expression, std::string file, int line, std::string details)
	Reconfigures the crash screen text to display a detailed message. More...

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

void	UpdateMetrics () override
	Updates metrics for 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...

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

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 used for the crash screen UI.

This screen is displayed to the user in the event of certain fatal errors within the engine. When possible, this screen will be displayed in order to provide additional information to the user about what went wrong.

In the future, it will also be modified to allow for the uploading of crash reports, as well as other useful data to Elaztek Studios to aid in resolving the issue.

Constructor & Destructor Documentation

◆ BlamUIWidget_CrashScreen()

BlamUIWidget_CrashScreen::BlamUIWidget_CrashScreen ( BlamUIWidget_Group * _parent )

Here is the call graph for this function:

Member Function Documentation

◆ SetBasicMessage()

void BlamUIWidget_CrashScreen::SetBasicMessage ( std::string additional_info = "" )

Reconfigures the crash screen text to display a basic message.

Parameters

additional_info - An optional message to display to the user alongside the standard information.

Here is the caller graph for this function:

◆ SetDetailedMessage()

void BlamUIWidget_CrashScreen::SetDetailedMessage	(	std::string	expression,
		std::string	file,
		int	line,
		std::string	details
	)

Reconfigures the crash screen text to display a detailed message.

This will usually be triggered by an assertion failure, however it can be used in other situations as well if needed.

Parameters

expression	- The expression that caused the crash (ie, an assertion failure).
file	- The file that caused the crash.
line	- The line number containing the code that caused the crash.
message	- A message to display to the user alongisde the other information.

Here is the caller graph for this function:

◆ SetHidden()

void BlamUIWidget_CrashScreen::SetHidden ( bool new_hidden )

overridevirtual

Sets the hidden state of the widget.

Parameters

new_hidden - Whether or not the widget should be hidden.

Reimplemented from BlamUIWidget_Group.

Here is the call graph for this function:

Here is the caller graph for this function:

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

blam/components/ui/blam/widgets/advanced/BlamUIWidget_CrashScreen.h
blam/components/ui/blam/widgets/advanced/BlamUIWidget_CrashScreen.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlamUIWidget_CrashScreen()

Member Function Documentation

◆ SetBasicMessage()

◆ SetDetailedMessage()

◆ SetHidden()