MxEngine::GraphicConsole Class Reference

#include <GraphicConsole.h>

Public Member Functions
	GraphicConsole ()
	GraphicConsole (const GraphicConsole &)=delete
void	SetEventCallback (EventCallback &&callback)
void	PrintHistory ()
void	ClearLog ()
void	PrintLog (const char *fmt,...)
void	Draw (const char *title)
ImVec2	GetSize () const
void	SetSize (ImVec2 size)

Friends
int	TextEditCallbackStub (ImGuiInputTextCallbackData *)

Detailed Description

graphic console is modified console from ImGui demo example. It features text input, search, history and logging

Constructor & Destructor Documentation

GraphicConsole()

MxEngine::GraphicConsole::GraphicConsole

(

)

Constructs default console sized (450, 500)

Member Function Documentation

ClearLog()

void MxEngine::GraphicConsole::ClearLog

(

)

clears console

Draw()

void MxEngine::GraphicConsole::Draw

(

const char *

title

)

calls ImGui code to draw console in a new personal window

Parameters

title

title of window in which console is drawn

GetSize()

ImVec2 MxEngine::GraphicConsole::GetSize

(

)

const

size getter

Returns

console size in pixels

PrintHistory()

void MxEngine::GraphicConsole::PrintHistory

(

)

prints all unique lines inputted by user to console

PrintLog()

void MxEngine::GraphicConsole::PrintLog	(	const char *	fmt,
			...
	)

prints message in a C-style to a console windows

Parameters

fmt	C-style formatting string
args	variadic argument list

SetEventCallback()

void MxEngine::GraphicConsole::SetEventCallback

(

EventCallback &&

callback

)

sets event callback which activates when text line is submitted by user

Parameters

callback

functor to call on line input

SetSize()

void MxEngine::GraphicConsole::SetSize

(

ImVec2

size

)

size setter

Parameters

size	new console size in pixels

Friends And Related Function Documentation

TextEditCallbackStub

int TextEditCallbackStub ( ImGuiInputTextCallbackData *  data )

friend

called internally by console. this function is callback forwarder (acquires console object to forward event)

---

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

• src/Utilities/ImGui/GraphicConsole.h
• src/Utilities/ImGui/GraphicConsole.cpp