Blam::DebugUI Namespace Reference

Namespace containing things relating to ImGUI, and the ImGUI draw list. More...

Namespaces
	Widgets
	Namespace containing general-purpose widgets used in multiple ImGUI drawing groups/windows.
	Windows
	Legacy namespace to contain data for the legacy ImGUI console.

Classes
class	ImGUIDrawingGroup
	Class representing an ImGUI drawing group/draw list item. More...

Functions
BLAM bool *	GetVisibility (std::string key)
	Retrieves the visibility of the specified draw list item. More...
BLAM void	AddToDrawList (std::string key, ImGUIDrawingGroup *group)
	Adds a new item to the ImGUI draw list. More...
BLAM ImGUIDrawingGroup *	GetDrawListItem (std::string key)
	Retrieves a drawing group with the specified ID. More...
BLAM void	ShowErrorDialog (const char *title, const char *message)
	Shows a simple error dialog created using ImGUI. More...
BLAM std::map< std::string, Blam::DebugUI::ImGUIDrawingGroup * > *	GetDrawList ()
	Retrieves the current ImGUI drawing list. More...

Detailed Description

Namespace containing things relating to ImGUI, and the ImGUI draw list.

Function Documentation

AddToDrawList()

void Blam::DebugUI::AddToDrawList	(	std::string	key,
		ImGUIDrawingGroup *	group
	)

Adds a new item to the ImGUI draw list.

Parameters

key	- The ID of the draw list item.
group	- Pointer to the drawing group to add.

GetDrawList()

std::map< std::string, Blam::DebugUI::ImGUIDrawingGroup * > * Blam::DebugUI::GetDrawList

(

)

Retrieves the current ImGUI drawing list.

The key is the ID of the drawing group. The value is a pointer to the drawing group.

GetDrawListItem()

Blam::DebugUI::ImGUIDrawingGroup * Blam::DebugUI::GetDrawListItem

(

std::string

key

)

Retrieves a drawing group with the specified ID.

Parameters

key	- The ID of the draw list item to retrieve.

Returns

A pointer to the specified drawing group if it exists, otherwise returns nullptr.

GetVisibility()

bool * Blam::DebugUI::GetVisibility

(

std::string

key

)

Retrieves the visibility of the specified draw list item.

See Blam::DebugUI::ImGUIDrawingGroup::Show for details.

Parameters

key	- The ID of the group to retrieve visibility of.

Returns

Pointer to the value indicating whether or not this group should be drawn onscreen if the window exists, otherwise returns nullptr.

ShowErrorDialog()

void Blam::DebugUI::ShowErrorDialog	(	const char *	title,
		const char *	message
	)

Shows a simple error dialog created using ImGUI.

Parameters

title	- The title of the dialog box.
message	- The message to show within the dialog box.