imgui_kit::UserInterfaceWindow Class Reference

Abstract base class for all windows rendered by the kit. More...

#include <user_interface_window.h>

Inheritance diagram for imgui_kit::UserInterfaceWindow:

Public Member Functions
	UserInterfaceWindow ()=default
virtual void	render ()=0
	Renders the window contents.
virtual	~UserInterfaceWindow ()=default
	UserInterfaceWindow (const UserInterfaceWindow &)=delete
UserInterfaceWindow &	operator= (const UserInterfaceWindow &)=delete
	UserInterfaceWindow (UserInterfaceWindow &&)=delete
UserInterfaceWindow &	operator= (UserInterfaceWindow &&)=delete

Detailed Description

Abstract base class for all windows rendered by the kit.

This is the library's extension point: derive from it, override render() with your ImGui draw calls, and register the window with UserInterface::addWindow<T>(). render() is invoked once per frame while the interface is running.

Instances are non-copyable and non-movable; they are owned by the UserInterface after registration.

See also

TemplateWindow for a minimal example, LogWindow for a full one.

Constructor & Destructor Documentation

UserInterfaceWindow() [1/3]

imgui_kit::UserInterfaceWindow::UserInterfaceWindow ( )

default

~UserInterfaceWindow()

virtual imgui_kit::UserInterfaceWindow::~UserInterfaceWindow ( )

virtualdefault

UserInterfaceWindow() [2/3]

imgui_kit::UserInterfaceWindow::UserInterfaceWindow ( const UserInterfaceWindow &  )

delete

UserInterfaceWindow() [3/3]

imgui_kit::UserInterfaceWindow::UserInterfaceWindow ( UserInterfaceWindow &&  )

delete

Member Function Documentation

operator=() [1/2]

UserInterfaceWindow & imgui_kit::UserInterfaceWindow::operator= ( const UserInterfaceWindow &  )

delete

operator=() [2/2]

UserInterfaceWindow & imgui_kit::UserInterfaceWindow::operator= ( UserInterfaceWindow &&  )

delete

render()

virtual void imgui_kit::UserInterfaceWindow::render ( )

pure virtual

Renders the window contents.

Called once per frame.

Implementations typically wrap their draw calls in ImGui::Begin()/ImGui::End().

Implemented in imgui_kit::LogWindow.

---

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

• include/user_interface_window.h