galaxy 1.0.0
Real-Time C++23 Game Programming Framework. Built on data-driven design principles and agile software engineering.
Loading...
Searching...
No Matches
galaxy::Editor Class Referencefinal

Ingame debug editor UI. More...

#include <Editor.hpp>

Inheritance diagram for galaxy::Editor:
Collaboration diagram for galaxy::Editor:

Public Member Functions

 Editor ()
 Constructor.
 ~Editor ()
 Destructor.
void handle_events (const SDL_Event &events) noexcept
 Process events in the editor.
void render ()
 Render the editor to the screen.
void draw () override
 Draw the ImGui widgets to ImGui buffers.
Public Member Functions inherited from galaxy::Panel
 Panel () noexcept
 Constructor.
 Panel (Panel &&) noexcept
 Move constructor.
 Panel (const Panel &) noexcept
 Copy constructor.
virtual ~Panel () noexcept
 Destructor.
void toggle () noexcept
 Toggle visibility of panel.
bool shown () const noexcept
 Check if panel is visible.
Panel & operator= (Panel &&) noexcept
 Move assignment operator.
Panel & operator= (const Panel &) noexcept
 Copy assignment operator.

Private Member Functions

void begin_dock ()
 Start rendering the editor dock.
void end_dock ()
 Finish rendering the editor dock.
void draw_menubar ()
 Draw the editor menubar.

Private Attributes

ConfigPanel m_config_panel
 Config panel for manipulating engine settings.
ScenePanel m_scene_panel
 Scene panel for managing scenes.
Popup m_hotkeys
 Hotkey info.

Additional Inherited Members

Protected Attributes inherited from galaxy::Panel
bool m_show
 Should the panel be shown.

Detailed Description

Ingame debug editor UI.

Definition at line 21 of file Editor.hpp.

Constructor & Destructor Documentation

◆ Editor()

galaxy::Editor::Editor ( )

Constructor.

Definition at line 18 of file Editor.cpp.

Here is the call graph for this function:

◆ ~Editor()

galaxy::Editor::~Editor ( )

Destructor.

Definition at line 24 of file Editor.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ handle_events()

void galaxy::Editor::handle_events ( const SDL_Event & events)
noexcept

Process events in the editor.

Parameters
eventsEvent structure.

Definition at line 29 of file Editor.cpp.

Here is the call graph for this function:

◆ render()

void galaxy::Editor::render ( )

Render the editor to the screen.

Definition at line 42 of file Editor.cpp.

Here is the call graph for this function:

◆ draw()

void galaxy::Editor::draw ( )
overridevirtual

Draw the ImGui widgets to ImGui buffers.

Implements galaxy::Panel.

Definition at line 52 of file Editor.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ begin_dock()

void galaxy::Editor::begin_dock ( )
private

Start rendering the editor dock.

Definition at line 102 of file Editor.cpp.

Here is the caller graph for this function:

◆ end_dock()

void galaxy::Editor::end_dock ( )
private

Finish rendering the editor dock.

Definition at line 107 of file Editor.cpp.

Here is the caller graph for this function:

◆ draw_menubar()

void galaxy::Editor::draw_menubar ( )
private

Draw the editor menubar.

Definition at line 117 of file Editor.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_config_panel

ConfigPanel galaxy::Editor::m_config_panel
private

Config panel for manipulating engine settings.

Definition at line 71 of file Editor.hpp.

◆ m_scene_panel

ScenePanel galaxy::Editor::m_scene_panel
private

Scene panel for managing scenes.

Definition at line 76 of file Editor.hpp.

◆ m_hotkeys

Popup galaxy::Editor::m_hotkeys
private

Hotkey info.

Definition at line 81 of file Editor.hpp.


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