Editor::Components::Console Class Reference

A panel component that provides console functionality in the editor. More...

#include <Console.h>

Inheritance diagram for Editor::Components::Console:

Collaboration diagram for Editor::Components::Console:

Public Member Functions
	Console ()
	Constructor that sets up the console.
	~Console ()
	Destructor that cleans up console resources.
void	Draw () override
	Renders the console panel interface. @override Implements the abstract method from the Panel base class.
void	AddMessage (const std::string &message, MessageType type=MessageType::Info)
	Adds a message to the console.
void	Clear ()
	Clears all messages from the console.
Public Member Functions inherited from Editor::Panel
virtual	~Panel ()=default
	Virtual destructor for proper cleanup of derived classes.

Static Public Member Functions
static Console &	GetInstance ()
	Gets the singleton instance of the console.
static void	Print (const std::string &message)
static void	PrintWarning (const std::string &message)
static void	PrintError (const std::string &message)
static void	PrintDebug (const std::string &message)
static void	PrintSuccess (const std::string &message)

Detailed Description

A panel component that provides console functionality in the editor.

Constructor & Destructor Documentation

Console()

Editor::Components::Console::Console

(

)

Constructor that sets up the console.

~Console()

Editor::Components::Console::~Console ( )

default

Destructor that cleans up console resources.

Member Function Documentation

AddMessage()

void Editor::Components::Console::AddMessage	(	const std::string &	message,
		MessageType	type = MessageType::Info
	)

Adds a message to the console.

Parameters

message	The message text
type	The type of message

Clear()

void Editor::Components::Console::Clear

(

)

Clears all messages from the console.

Draw()

void Editor::Components::Console::Draw ( )

overridevirtual

Renders the console panel interface. @override Implements the abstract method from the Panel base class.

Implements Editor::Panel.

GetInstance()

Console & Editor::Components::Console::GetInstance ( )

static

Gets the singleton instance of the console.

Returns

Reference to the console instance

Print()

void Editor::Components::Console::Print ( const std::string &  message )

static

PrintDebug()

void Editor::Components::Console::PrintDebug ( const std::string &  message )

static

PrintError()

void Editor::Components::Console::PrintError ( const std::string &  message )

static

PrintSuccess()

void Editor::Components::Console::PrintSuccess ( const std::string &  message )

static

PrintWarning()

void Editor::Components::Console::PrintWarning ( const std::string &  message )

static

---

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

• Editor/Components/Console.h
• Editor/Components/Console.cpp