Draws the UI to the screen. More...

#include <UIManager.hxx>

Inheritance diagram for UIManager:

Collaboration diagram for UIManager:

Public Member Functions
void	init ()
	Parses the UiLayout.json files and creates UI Elements. More...

struct ImFont *	loadFont (const std::string &name, uint32_t size)

void	initializeImGuiFonts ()

void	loadSettings (json &uiLayout)

void	parseLayouts (const json &uiLayout)

void	drawUI ()
	Renders all UI Widgets. More...

void	toggleDebugMenu ()
	Toggle Visibility of Debug Menu. More...

void	setFPSCounterText (const std::string &fps)
	Helper function to update the FPS Counter. More...

std::unordered_map< std::string, LayoutData > &	getLayouts ()
	Get the LayoutGroup container. More...

void	setTooltip (const std::string &tooltipText)

void	clearTooltip ()
	Hides and resets the active tooltip. More...

void	closeOpenMenus ()
	Close all open menus but the build menu. More...

void	openMenu (GameMenu::Ptr menuOption)

template<class Menu >
void	openMenu ()

void	closeMenu ()

bool	isAnyMenuOpen () const

void	addPersistentMenu (GameMenu::Ptr menu)

bool	isMouseHovered () const

template<class Menu >
GameMenu::Ptr	findMenu () const

template<class Menu >
void	addPersistentMenu ()

BUILDMENU_LAYOUT	buildMenuLayout () const

void	setBuildMenuLayout (BUILDMENU_LAYOUT l)

Public Attributes
friend	Singleton< UIManager >

Private Member Functions
	UIManager ()=default

	~UIManager ()=default

Private Attributes
std::unordered_map< std::string, LayoutData >	m_layouts
	map holding layput groups, accessible via the layoutgroup ID More...

std::string	m_tooltip

std::unordered_map< std::string, ImFont * >	m_loadedFonts

std::vector< GameMenu::Ptr >	m_menuStack

std::vector< GameMenu::Ptr >	m_persistentMenu

bool	m_showDebugMenu = false
	visibility of the debug menu More...

std::string	m_fpsCounter

bool	m_showFpsCounter = true

struct ImFont *	fontDefault = nullptr
	pointer to the default font used for in-game text More...

BUILDMENU_LAYOUT	m_buildMenuLayout = BUILDMENU_LAYOUT::BOTTOM

Additional Inherited Members
Static Public Member Functions inherited from Singleton< UIManager >
static UIManager &	instance (void)
	Get an instance of the singleton. More...

Protected Member Functions inherited from Singleton< UIManager >
	Singleton () noexcept=default

	~Singleton () noexcept=default

Detailed Description

Draws the UI to the screen.

Parses UiLayout.json file and instantiates UI widgets accordingly. Also takes care of layouting

Definition at line 39 of file UIManager.hxx.

Constructor & Destructor Documentation

◆ UIManager()

UIManager::UIManager ( )

privatedefault

◆ ~UIManager()

UIManager::~UIManager ( )

privatedefault

Member Function Documentation

◆ addPersistentMenu() [1/2]

template<class Menu >

void UIManager::addPersistentMenu ( )

inline

Definition at line 126 of file UIManager.hxx.

126 { addPersistentMenu(std::make_shared<Menu>()); }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPersistentMenu() [2/2]

void UIManager::addPersistentMenu ( GameMenu::Ptr menu )

Definition at line 174 of file UIManager.cxx.

 {
   if (std::none_of(std::begin(m_persistentMenu), std::end(m_persistentMenu), [&](const auto &m) { return m == menu; }))
   {
     m_persistentMenu.push_back(menu);
   }
 }

Here is the caller graph for this function:

◆ buildMenuLayout()

BUILDMENU_LAYOUT UIManager::buildMenuLayout ( ) const

inline

Definition at line 128 of file UIManager.hxx.

128 { return m_buildMenuLayout; }

◆ clearTooltip()

void UIManager::clearTooltip ( )

Hides and resets the active tooltip.

See also: Tooltip::reset

Definition at line 224 of file UIManager.cxx.

224 { m_tooltip.clear(); }

◆ closeMenu()

void UIManager::closeMenu ( )

Definition at line 163 of file UIManager.cxx.

 {
   if (m_menuStack.empty())
     return;
  
   m_menuStack.pop_back();
  
   Camera::instance().canScale(m_menuStack.empty());
   Camera::instance().canMove(m_menuStack.empty());
 }

Here is the call graph for this function:

◆ closeOpenMenus()

void UIManager::closeOpenMenus ( )

Close all open menus but the build menu.

Definition at line 144 of file UIManager.cxx.

 {
   for (auto &m : m_persistentMenu)
   {
     m->closeSubmenus();
   }
 }

◆ drawUI()

void UIManager::drawUI ( )

Renders all UI Widgets.

Definition at line 184 of file UIManager.cxx.

 {
 #ifdef MICROPROFILE_ENABLED
   MICROPROFILE_SCOPEI("UI", "draw UI", MP_BLUE);
 #endif
   if (!m_menuStack.empty())
   {
     m_menuStack.back()->draw();
   }
  
   for (const auto &m : m_persistentMenu)
   {
     m->draw();
   }
  
   if (!m_tooltip.empty())
   {
     ImVec2 pos = ui::GetMousePos();
     ui::SetCursorScreenPos(pos);
     ui::Text(m_tooltip.c_str());
   }
  
   if (m_showFpsCounter)
   {
     ui::SetNextWindowPos(ImVec2(0, 0));
     ui::SetNextWindowSize(ImVec2(140, 20));
  
     bool open = true;
     ui::Begin("##fpswindow", &open,
               ImGuiWindowFlags_NoBackground | ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_NoScrollbar |
                   ImGuiWindowFlags_NoScrollWithMouse);
     ui::Text(m_fpsCounter.c_str());
     ui::SameLine();
     ui::Checkbox("debug", &m_showDebugMenu);
     ui::End();
   }
 }

Here is the caller graph for this function:

◆ findMenu()

template<class Menu >

GameMenu::Ptr UIManager::findMenu ( ) const

inline

Definition at line 105 of file UIManager.hxx.

   {
     for (const auto &m : m_menuStack)
     {
       if (dynamic_cast<Menu *>(m.get()))
       {
         return m;
       }
     }
  
     for (const auto &m : m_persistentMenu)
     {
       if (dynamic_cast<Menu *>(m.get()))
       {
         return m;
       }
     }
  
     return nullptr;
   }

◆ getLayouts()

std::unordered_map<std::string, LayoutData>& UIManager::getLayouts ( )

inline

Get the LayoutGroup container.

Returns the container that holds LayoutGroups

Returns: std::unordered_map<std::string, LayoutGroup>&

Definition at line 79 of file UIManager.hxx.

79 { return m_layouts; }

Here is the caller graph for this function:

◆ init()

void UIManager::init ( )

Parses the UiLayout.json files and creates UI Elements.

Here is the caller graph for this function:

◆ initializeImGuiFonts()

void UIManager::initializeImGuiFonts ( )

Definition at line 69 of file UIManager.cxx.

 {
   std::string fontPath = fs::getBasePath() + Settings::instance().fontFileName.get(); // fix for macos, need to use abs path
  
   const auto names = {"MainMenuButtons", "PauseMenuButtons", "LoadDialogButtons", "BuildMenuButtons"};
   for (const auto &name : names)
   {
     if (const auto it = m_layouts.find(name); it != m_layouts.end())
     {
       auto &layout = it->second;
       layout.font = loadFont(fontPath, layout.fontSize);
     }
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAnyMenuOpen()

bool UIManager::isAnyMenuOpen ( ) const

inline

Definition at line 99 of file UIManager.hxx.

99 { return !m_menuStack.empty(); }

◆ isMouseHovered()

bool UIManager::isMouseHovered ( ) const

Definition at line 182 of file UIManager.cxx.

182 { return ImGui::IsAnyItemHovered(); }

◆ loadFont()

ImFont * UIManager::loadFont	(	const std::string &	name,
		uint32_t	size
	)

Definition at line 51 of file UIManager.cxx.

 {
   auto *uiFonts = ImGui::GetIO().Fonts;
   if (!fontDefault)
     fontDefault = uiFonts->AddFontDefault();
  
   std::string hashName = fontPath;
   hashName.append(std::to_string(size));
   if (const auto it = m_loadedFonts.find(hashName); it != m_loadedFonts.end())
     return it->second;
  
   ImFont *newFont = uiFonts->AddFontFromFileTTF(fontPath.c_str(), (float)size);
   m_loadedFonts[hashName] = newFont;
   uiFonts->Build();
  
   return newFont;
 }

Here is the caller graph for this function:

◆ loadSettings()

void UIManager::loadSettings ( json & uiLayout )

Definition at line 84 of file UIManager.cxx.

 {
   std::string jsonFileContent = fs::readFileAsString(Settings::instance().uiLayoutJSONFile.get());
   uiLayout = json::parse(jsonFileContent, nullptr, false);
  
   // check if json file can be parsed
   if (uiLayout.is_discarded())
     throw ConfigurationError(TRACE_INFO "Error parsing JSON File " + Settings::instance().uiLayoutJSONFile.get());
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openMenu() [1/2]

template<class Menu >

void UIManager::openMenu ( )

inline

Definition at line 96 of file UIManager.hxx.

96 { openMenu(std::make_shared<Menu>()); }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openMenu() [2/2]

void UIManager::openMenu ( GameMenu::Ptr menuOption )

Definition at line 152 of file UIManager.cxx.

 {
   if (std::none_of(std::begin(m_menuStack), std::end(m_menuStack), [&](const auto &m) { return m == menu; }))
   {
     m_menuStack.push_back(menu);
  
     Camera::instance().canScale(false);
     Camera::instance().canMove(false);
   }
 }

Here is the call graph for this function:

◆ parseLayouts()

void UIManager::parseLayouts ( const json & uiLayout )

Definition at line 94 of file UIManager.cxx.

 {
   // parse Layout
   for (const auto &it : uiLayout["LayoutGroups"].items())
   {
     std::string layoutGroupName;
  
     // prepare empty layout groups with layout information from json
     for (size_t id = 0; id < uiLayout["LayoutGroups"][it.key()].size(); id++)
     {
       layoutGroupName = uiLayout["LayoutGroups"][it.key()][id].value("GroupName", "");
  
       if (!layoutGroupName.empty())
       {
         LayoutData layout;
         layout.layoutType = uiLayout["LayoutGroups"][it.key()][id].value("LayoutType", "");
         layout.alignment = uiLayout["LayoutGroups"][it.key()][id].value("Alignment", "");
  
         if (layout.layoutType.empty())
         {
           LOG(LOG_WARNING) << "Skipping LayoutGroup " << layoutGroupName
                            << " because it has no parameter \"LayoutType\" set. Check your UiLayout.json file.";
           continue;
         }
  
         if (layout.alignment.empty())
         {
           LOG(LOG_WARNING) << "Skipping LayoutGroup " << layoutGroupName
                            << " because it has no parameter \"Alignment\" set. Check your UiLayout.json file.";
           continue;
         }
  
         layout.fontSize = uiLayout["LayoutGroups"][it.key()][id].value("FontSize", Settings::instance().defaultFontSize);
         layout.padding = uiLayout["LayoutGroups"][it.key()][id].value("Padding", 0);
         layout.paddingToParent = uiLayout["LayoutGroups"][it.key()][id].value("PaddingToParent", 0);
         layout.alignmentOffset = uiLayout["LayoutGroups"][it.key()][id].value("AlignmentOffset", 0.0F);
  
         // add layout group information to container
         m_layouts[layoutGroupName] = layout;
       }
       else
       {
         LOG(LOG_WARNING) << "Cannot add a Layout Group without a name. Check your UiLayout.json file.";
       }
     }
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBuildMenuLayout()

void UIManager::setBuildMenuLayout ( BUILDMENU_LAYOUT l )

inline

Definition at line 129 of file UIManager.hxx.

129 { m_buildMenuLayout = l; }

◆ setFPSCounterText()

void UIManager::setFPSCounterText ( const std::string & fps )

Helper function to update the FPS Counter.

Parameters

fps

Definition at line 142 of file UIManager.cxx.

142 { m_fpsCounter = fps; }

Here is the caller graph for this function:

◆ setTooltip()

void UIManager::setTooltip ( const std::string & tooltipText )

Definition at line 222 of file UIManager.cxx.

222 { m_tooltip = tooltipText; }

◆ toggleDebugMenu()

void UIManager::toggleDebugMenu ( )

inline

Toggle Visibility of Debug Menu.

Definition at line 65 of file UIManager.hxx.

65 { m_showDebugMenu = !m_showDebugMenu; };

Member Data Documentation

◆ fontDefault

struct ImFont* UIManager::fontDefault = nullptr

private

pointer to the default font used for in-game text

Definition at line 151 of file UIManager.hxx.

◆ m_buildMenuLayout

BUILDMENU_LAYOUT UIManager::m_buildMenuLayout = BUILDMENU_LAYOUT::BOTTOM

private

Definition at line 152 of file UIManager.hxx.

◆ m_fpsCounter

std::string UIManager::m_fpsCounter

private

Definition at line 147 of file UIManager.hxx.

◆ m_layouts

std::unordered_map<std::string, LayoutData> UIManager::m_layouts

private

map holding layput groups, accessible via the layoutgroup ID

Definition at line 136 of file UIManager.hxx.

◆ m_loadedFonts

std::unordered_map<std::string, ImFont *> UIManager::m_loadedFonts

private

Definition at line 140 of file UIManager.hxx.

◆ m_menuStack

std::vector<GameMenu::Ptr> UIManager::m_menuStack

private

Definition at line 141 of file UIManager.hxx.

◆ m_persistentMenu

std::vector<GameMenu::Ptr> UIManager::m_persistentMenu

private

Definition at line 142 of file UIManager.hxx.

◆ m_showDebugMenu

bool UIManager::m_showDebugMenu = false

private

visibility of the debug menu

Definition at line 145 of file UIManager.hxx.

◆ m_showFpsCounter

bool UIManager::m_showFpsCounter = true

private

Definition at line 148 of file UIManager.hxx.

◆ m_tooltip

std::string UIManager::m_tooltip

private

Definition at line 138 of file UIManager.hxx.

◆ Singleton< UIManager >

friend UIManager::Singleton< UIManager >

Definition at line 42 of file UIManager.hxx.

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

src/engine/UIManager.hxx
src/engine/UIManager.cxx

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UIManager()

◆ ~UIManager()

Member Function Documentation

◆ addPersistentMenu() [1/2]

◆ addPersistentMenu() [2/2]

◆ buildMenuLayout()

◆ clearTooltip()

◆ closeMenu()

◆ closeOpenMenus()

◆ drawUI()

◆ findMenu()

◆ getLayouts()

◆ init()

◆ initializeImGuiFonts()

◆ isAnyMenuOpen()

◆ isMouseHovered()

◆ loadFont()

◆ loadSettings()

◆ openMenu() [1/2]

◆ openMenu() [2/2]

◆ parseLayouts()

◆ setBuildMenuLayout()

◆ setFPSCounterText()

◆ setTooltip()

◆ toggleDebugMenu()

Member Data Documentation

◆ fontDefault

◆ m_buildMenuLayout

◆ m_fpsCounter

◆ m_layouts

◆ m_loadedFonts

◆ m_menuStack

◆ m_persistentMenu

◆ m_showDebugMenu

◆ m_showFpsCounter

◆ m_tooltip

◆ Singleton< UIManager >