TutorialWindow

#include "GUI/Elements/Windows/TutorialWindow.h"

Inherits from IWindow, ITutorialRenderer, std::enable_shared_from_this< IWindow >

Public Functions

	Name
	TutorialWindow(bool show)
void	emptyTutorial()
Ptr< Tutorial >	getTutorial()
bool	hasTutorial() const
void	reloadTutorial()
virtual void	render() override<br>Renders the tutorial window using ImGui.
void	setTutorial(std::shared_ptr< Tutorial > tutorial)<br>Sets the passed tutorial as the current one.
void	setTutorial(std::shared_ptr< TutorialHeader > & header)<br>Calls load and parse for a tutorial from file and sets it as the current one to be shown.
ImGui::MarkdownConfig	createMarkdownConfig()

Additional inherited members

Public Functions inherited from IWindow

	Name
	IWindow(std::string title, bool show =false)
	IWindow(std::string title, int instanceIndex, bool show)
virtual	~IWindow() =default
virtual const char *	getID() const =0
WPtr< InputController >	getInput()<br>Returns window input controller.
const char *	getName()
bool *	getShowPtr()
const std::string &	getTitle() const
void	hide()
bool	isVisible() const
const void	setTitle(std::string title)
void	show()

Protected Functions inherited from IWindow

	Name
void	updateWindowInfo()<br>Collect information about the current window.

Public Attributes inherited from IWindow

	Name
bool	m_autoFocus <br>When true the window will get focus immediately upon hovering over it.
int	m_instanceIndex <br>Window instance identifier, for windows with multiple instances of same type, -1 default.
std::string	m_title <br>Visible window title.
bool	m_windowInfoUpdated <br>A flag indicating the updateWindowInfo() method was called.
WindowManager *	m_windowManager <br>Weak reference to a WindowManager set when this window is added to it.
glm::vec2	m_windowMax <br>Bottom right corner of the window.
glm::vec2	m_windowMin <br>Top left corner of the window, same as m_windowPos (separate variable for clarity)
glm::vec2	m_windowPos <br>Top-left corner of the window in screen coordinates.
glm::ivec2	m_windowSize <br>Window width and height dimensions.

Protected Attributes inherited from IWindow

	Name
Ptr< InputController >	m_input
std::string	m_name <br>Full ImGui window identifier.
bool	m_nameNeedsUpdate <br>Workaround to avoid setting the name in the constructor (cannot call getID there)
bool	m_show

Friends inherited from IWindow

	Name
class	WindowManager

Public Functions inherited from ITutorialRenderer

	Name
virtual	~ITutorialRenderer() =default

Public Functions Documentation

function TutorialWindow

explicit TutorialWindow(
    bool show
)

function emptyTutorial

void emptyTutorial()

function getTutorial

Ptr< Tutorial > getTutorial()

function hasTutorial

bool hasTutorial() const

function reloadTutorial

void reloadTutorial()

function render

virtual void render() override

Renders the tutorial window using ImGui.

Reimplements: IWindow::render

function setTutorial

void setTutorial(
    std::shared_ptr< Tutorial > tutorial
)

Sets the passed tutorial as the current one.

Parameters:

• tutorial Ptr to an already loaded tutorial

function setTutorial

void setTutorial(
    std::shared_ptr< TutorialHeader > & header
)

Calls load and parse for a tutorial from file and sets it as the current one to be shown.

Parameters:

• header Ptr to an already loaded tutorial header object describing a specific tutorial.

function createMarkdownConfig

static ImGui::MarkdownConfig createMarkdownConfig()

---

Updated on 2026-09-11 at 21:24:24 +0000