Pure User Interface Manager class. More...

Detailed Description

Pure User Interface Manager class.

Definition at line 30 of file PureUiManager.h.

#include <PureUiManager.h>

Inheritance diagram for PureUiManager:

Public Member Functions
CConsole &	getConsole () const
	Returns access to console preset with logger module name as this class.

virtual void	Initialize (HWND wnd_handle, HDC wnd_dc)=0
	Sets members to real values within the singleton instance.

virtual void	Deinitialize ()=0
	This deletes all UI elements and allocated resources, Initialize() can be called again later.

virtual TPureBool	isInitialized () const =0
	Gets whether we are initialized.

virtual const std::function< void()> &	getGuiDrawCallback () const =0
	Returns the previously set GUI callback function.

virtual void	setGuiDrawCallback (const std::function< void()> &cb)=0
	Sets the given GUI draw callback function to be invoked by the renderer in every frame.

virtual PureUiText *	textPermanentLegacy (const std::string &txt, int x, int y, const std::string &fontface, int height, bool bold, bool italic, bool underline, bool strikeout)=0
	Adds permanent text to the UI.

virtual PureUiText *	textPermanentLegacy (const std::string &txt, int x, int y)=0
	Adds permanent text to the UI with default properties.

virtual void	removeTextPermanentLegacy (const std::string &text, int x, int y, int height)=0
	Deletes permanent text from the UI that was previously added by textPermanentLegacy().

virtual void	removeAllTextPermanentLegacy ()=0
	Deletes all permanent texts from the UI that were previously added by textPermanentLegacy().

virtual PureUiText *	textTemporalLegacy (const std::string &txt, int x, int y, const std::string &fontface, int height, bool bold, bool italic, bool underline, bool strikeout)=0
	Adds temporary text to the UI.

virtual PureUiText *	textTemporalLegacy (const std::string &txt, int x, int y)=0
	Adds temporary text to the UI.

virtual const std::string &	getDefaultFontFaceLegacy () const =0
	Gets the default font face used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual void	setDefaultFontFaceLegacy (const std::string &face)=0
	Sets the default font face used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual int	getDefaultFontSizeLegacy () const =0
	Gets the default font size used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual void	setDefaultFontSizeLegacy (int size)=0
	Sets the default font size used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual bool	getDefaultFontBoldLegacy () const =0
	Gets the default font bold property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual void	setDefaultFontBoldLegacy (bool bold)=0
	Sets the default font bold property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual bool	getDefaultFontItalicLegacy () const =0
	Gets the default font italic property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual void	setDefaultFontItalicLegacy (bool italic)=0
	Sets the default font italic property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual bool	getDefaultFontUnderlineLegacy () const =0
	Gets the default font underlined property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual void	setDefaultFontUnderlineLegacy (bool underline)=0
	Sets the default font underlined property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual bool	getDefaultFontStrikeoutLegacy () const =0
	Gets the default font strikeout property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual void	setDefaultFontStrikeoutLegacy (bool strikeout)=0
	Sets the default font strikeout property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

virtual const PureColor &	getDefaultColorLegacy () const =0
	Returns reference to default color used by legacy functions textPermanentLegacy() and textTemporalLegacy() This default color is black by default.

virtual PureColor &	getDefaultColorLegacy ()=0
	Returns reference to default color used by legacy functions textPermanentLegacy() and textTemporalLegacy() This default color is black by default.

virtual void	render ()=0

Static Public Member Functions
static PureUiManager &	createAndGet ()
	Creates and gets the singleton instance.

static const char *	getLoggerModuleName ()
	Returns the logger module name of this class.

Member Function Documentation

◆ createAndGet()

PureUiManager & PureUiManager::createAndGet ( )

static

Creates and gets the singleton instance.

Definition at line 565 of file PureUiManager.cpp.

◆ Deinitialize()

virtual void PureUiManager::Deinitialize ( )

pure virtual

This deletes all UI elements and allocated resources, Initialize() can be called again later.

Application doesn't need to call this, PURE shutdown takes care of this.

Implemented in PureUiManagerImpl.

◆ getConsole()

CConsole & PureUiManager::getConsole ( ) const

Returns access to console preset with logger module name as this class.

Intentionally not virtual, so the getConsole() in derived class should hide this instead of overriding.

Returns: Console instance used by this class.

Definition at line 571 of file PureUiManager.cpp.

◆ getDefaultColorLegacy() [1/2]

virtual const PureColor & PureUiManager::getDefaultColorLegacy ( ) const

pure virtual

Returns reference to default color used by legacy functions textPermanentLegacy() and textTemporalLegacy() This default color is black by default.

Implemented in PureUiManagerImpl.

◆ getDefaultColorLegacy() [2/2]

virtual PureColor & PureUiManager::getDefaultColorLegacy ( )

pure virtual

Returns reference to default color used by legacy functions textPermanentLegacy() and textTemporalLegacy() This default color is black by default.

Implemented in PureUiManagerImpl.

◆ getDefaultFontBoldLegacy()

virtual bool PureUiManager::getDefaultFontBoldLegacy ( ) const

pure virtual

Gets the default font bold property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ getDefaultFontFaceLegacy()

virtual const std::string & PureUiManager::getDefaultFontFaceLegacy ( ) const

pure virtual

Gets the default font face used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ getDefaultFontItalicLegacy()

virtual bool PureUiManager::getDefaultFontItalicLegacy ( ) const

pure virtual

Gets the default font italic property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ getDefaultFontSizeLegacy()

virtual int PureUiManager::getDefaultFontSizeLegacy ( ) const

pure virtual

Gets the default font size used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ getDefaultFontStrikeoutLegacy()

virtual bool PureUiManager::getDefaultFontStrikeoutLegacy ( ) const

pure virtual

Gets the default font strikeout property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ getDefaultFontUnderlineLegacy()

virtual bool PureUiManager::getDefaultFontUnderlineLegacy ( ) const

pure virtual

Gets the default font underlined property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ getGuiDrawCallback()

virtual const std::function< void()> & PureUiManager::getGuiDrawCallback ( ) const

pure virtual

Returns the previously set GUI callback function.

Implemented in PureUiManagerImpl.

◆ getLoggerModuleName()

const char * PureUiManager::getLoggerModuleName ( )

static

Returns the logger module name of this class.

Intentionally not virtual, so derived class should hide this instead of overriding. Not even private, so user can also access this from outside, for any reason like controlling log filtering per logger module name.

Returns: The logger module name of this class.

Definition at line 577 of file PureUiManager.cpp.

◆ Initialize()

virtual void PureUiManager::Initialize	(	HWND	wnd_handle,
		HDC	wnd_dc )

pure virtual

Sets members to real values within the singleton instance.

Does nothing if wnd_handle or wnd_dc is NULL.

Application doesn't need to call this, PURE initialization takes care of this.

Implemented in PureUiManagerImpl.

◆ isInitialized()

virtual TPureBool PureUiManager::isInitialized ( ) const

pure virtual

Gets whether we are initialized.

Implemented in PureUiManagerImpl.

◆ removeAllTextPermanentLegacy()

virtual void PureUiManager::removeAllTextPermanentLegacy ( )

pure virtual

Deletes all permanent texts from the UI that were previously added by textPermanentLegacy().

This command is not needed to be used on temporary texts added by textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ removeTextPermanentLegacy()

virtual void PureUiManager::removeTextPermanentLegacy	(	const std::string &	text,
		int	x,
		int	y,
		int	height )

pure virtual

Deletes permanent text from the UI that was previously added by textPermanentLegacy().

This command is not needed to be used on temporary texts added by textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ render()

virtual void PureUiManager::render ( )

pure virtual

Implemented in PureUiManagerImpl.

◆ setDefaultFontBoldLegacy()

virtual void PureUiManager::setDefaultFontBoldLegacy ( bool bold )

pure virtual

Sets the default font bold property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ setDefaultFontFaceLegacy()

virtual void PureUiManager::setDefaultFontFaceLegacy ( const std::string & face )

pure virtual

Sets the default font face used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ setDefaultFontItalicLegacy()

virtual void PureUiManager::setDefaultFontItalicLegacy ( bool italic )

pure virtual

Sets the default font italic property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ setDefaultFontSizeLegacy()

virtual void PureUiManager::setDefaultFontSizeLegacy ( int size )

pure virtual

Sets the default font size used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ setDefaultFontStrikeoutLegacy()

virtual void PureUiManager::setDefaultFontStrikeoutLegacy ( bool strikeout )

pure virtual

Sets the default font strikeout property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ setDefaultFontUnderlineLegacy()

virtual void PureUiManager::setDefaultFontUnderlineLegacy ( bool underline )

pure virtual

Sets the default font underlined property used by legacy functions textPermanentLegacy() and textTemporalLegacy().

Implemented in PureUiManagerImpl.

◆ setGuiDrawCallback()

virtual void PureUiManager::setGuiDrawCallback ( const std::function< void()> & cb )

pure virtual

Sets the given GUI draw callback function to be invoked by the renderer in every frame.

This callback should invoke Dear ImGui (https://github.com/ocornut/imgui) functions to draw GUI. The caller is not responsible for compiling or initializing Dear ImGui, PURE is in charge for that. PURE is already built with Dear ImGui code. Only the platform-agnostic, actual GUI drawing functions should be invoked that are listed in imgui.h. This header file is in the external include directory of PURE. None of these should be called either:

For an example on how to use this function, see a real-life game project: https://github.com/proof88/PRooFPS-dd .

Note: this function is invoked every frame, AFTER rendering the 2D sticked-to-screen objects (PureObject3D::SetStickedToScreen()). Thus, if you also do calculations in the specified callback function that have effect on those PURE sticked-to-screen objects, the visible effects will be delayed to the next frame. So in general it is highly recommended to do ONLY Dear ImGui-specific stuff in the specified callback function.

Implemented in PureUiManagerImpl.

◆ textPermanentLegacy() [1/2]

virtual PureUiText * PureUiManager::textPermanentLegacy	(	const std::string &	txt,
		int	x,
		int	y )

pure virtual

Adds permanent text to the UI with default properties.

Basically this has the same effect as calling the other textPermanentLegacy() with default font properties.

Implemented in PureUiManagerImpl.

◆ textPermanentLegacy() [2/2]

virtual PureUiText * PureUiManager::textPermanentLegacy	(	const std::string &	txt,
		int	x,
		int	y,
		const std::string &	fontface,
		int	height,
		bool	bold,
		bool	italic,
		bool	underline,
		bool	strikeout )

pure virtual

Adds permanent text to the UI.

Permanent texts live until explicit deletion. This means that after you add a permanent text to the UI, it will be displayed in all next rendered frames.

This function is considered as legacy now because it uses an old technique to render text, however it is still being used here and there (including the original PR00FPS thru the gfxcore2 wrapper library) thus I'm not planning to delete it soon. It depends on the platform-specific PureUiFontWin class and I'm not planning to create something similar for Linux, so multiplatform support is not possible now with this legacy way.

Another way of text rendering can be done using Dear ImGui text-rendering functions that you can invoke in your own function that you pass to PURE using setGuiDrawCallback().

This function has nothing to do with Dear ImGui. You can add text using this function or with Dear ImGui API, they can be rendered on-screen at the same time too.

Implemented in PureUiManagerImpl.

◆ textTemporalLegacy() [1/2]

virtual PureUiText * PureUiManager::textTemporalLegacy	(	const std::string &	txt,
		int	x,
		int	y )

pure virtual

Adds temporary text to the UI.

Basically this has the same effect as calling the other textTemporalLegacy() with default font properties.

Implemented in PureUiManagerImpl.

◆ textTemporalLegacy() [2/2]

virtual PureUiText * PureUiManager::textTemporalLegacy	(	const std::string &	txt,
		int	x,
		int	y,
		const std::string &	fontface,
		int	height,
		bool	bold,
		bool	italic,
		bool	underline,
		bool	strikeout )

pure virtual

Adds temporary text to the UI.

Temporary texts live only in the next rendered frame. This means that in order to display the same temporary text for more than 1 frame, you have to issue this command before rendering every single frame.

If you want to display the same text in multiple frame, from performance perspective it is better to add permanent text using textPermanentLegacy() instead.

This function is considered as legacy now because it uses an old technique to render text, however it is still being used here and there (including the original PR00FPS thru the gfxcore2 wrapper library) thus I'm not planning to delete it soon. It depends on the platform-specific PureUiFontWin class and I'm not planning to create something similar for Linux, so multiplatform support is not possible now with this legacy way.

Another way of text rendering can be done using Dear ImGui text-rendering functions that you can invoke in your own function that you pass to PURE using setGuiDrawCallback().

This function has nothing to do with Dear ImGui. You can add text using this function or with Dear ImGui API, they can be rendered on-screen at the same time too.

Implemented in PureUiManagerImpl.

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

C:/__PR00F__/___developing___/projects/PGE/PGE/PURE/include/external/PureUiManager.h
C:/__PR00F__/___developing___/projects/PGE/PGE/PURE/source/PureUiManager.cpp

Detailed Description

Public Member Functions

Static Public Member Functions

Member Function Documentation

◆ createAndGet()

◆ Deinitialize()

◆ getConsole()

◆ getDefaultColorLegacy() [1/2]

◆ getDefaultColorLegacy() [2/2]

◆ getDefaultFontBoldLegacy()

◆ getDefaultFontFaceLegacy()

◆ getDefaultFontItalicLegacy()

◆ getDefaultFontSizeLegacy()

◆ getDefaultFontStrikeoutLegacy()

◆ getDefaultFontUnderlineLegacy()

◆ getGuiDrawCallback()

◆ getLoggerModuleName()

◆ Initialize()

◆ isInitialized()

◆ removeAllTextPermanentLegacy()

◆ removeTextPermanentLegacy()

◆ render()

◆ setDefaultFontBoldLegacy()

◆ setDefaultFontFaceLegacy()

◆ setDefaultFontItalicLegacy()

◆ setDefaultFontSizeLegacy()

◆ setDefaultFontStrikeoutLegacy()

◆ setDefaultFontUnderlineLegacy()

◆ setGuiDrawCallback()

◆ textPermanentLegacy() [1/2]

◆ textPermanentLegacy() [2/2]

◆ textTemporalLegacy() [1/2]

◆ textTemporalLegacy() [2/2]