Editor::Components::Dockspace Class Reference

Manages the dockable layout system for the editor interface. More...

#include <Dockspace.h>

Public Types
enum class	Region {   Left = 0 , Right , Bottom , Top ,   Center }

Static Public Member Functions
static void	RegisterPanel (const char *name, Editor::Panel *panel, Region defaultRegion)
	Register a panel to be managed by the dockspace.
static void	Begin ()
	Initialize and begin a new dockspace frame.
static void	End ()
	Finalize the dockspace for the current frame.
static void	SaveLayout (const char *filename)
	Save the current dockspace layout configuration to a file.
static void	LoadLayout (const char *filename)
	Load a previously saved dockspace layout configuration from a file.
static void	Reset ()
	Reset the dockspace layout to default settings on the next Begin() call.

Detailed Description

Manages the dockable layout system for the editor interface.

The Dockspace class provides functionality to organize and manage editor panels in a dockable interface. It allows panels to be registered, arranged in specific regions, and handles saving/loading of layout configurations.

Member Enumeration Documentation

Region

enum class Editor::Components::Dockspace::Region

strong

Enumerator
Left	Left side of the editor interface
Right	Right side of the editor interface
Bottom	Bottom area of the editor interface
Top	Top area of the editor interface
Center	Central area of the editor interface

Member Function Documentation

Begin()

void Editor::Components::Dockspace::Begin ( )

static

Initialize and begin a new dockspace frame.

Must be called at the beginning of each frame before rendering any panels.

End()

void Editor::Components::Dockspace::End ( )

static

Finalize the dockspace for the current frame.

Must be called at the end of each frame after all panels have been rendered.

LoadLayout()

void Editor::Components::Dockspace::LoadLayout ( const char *  filename )

static

Load a previously saved dockspace layout configuration from a file.

Parameters

filename

Path to the file containing layout settings to load

RegisterPanel()

void Editor::Components::Dockspace::RegisterPanel ( const char *  name, Editor::Panel *  panel, Region  defaultRegion  )

static

Register a panel to be managed by the dockspace.

Parameters

name	The display name of the panel
panel	Pointer to the panel to register
defaultRegion	The default region where the panel should be docked

Reset()

void Editor::Components::Dockspace::Reset ( )

static

Reset the dockspace layout to default settings on the next Begin() call.

This will clear all current panel arrangements and force a rebuild of the default layout on the next Begin() call.

SaveLayout()

void Editor::Components::Dockspace::SaveLayout ( const char *  filename )

static

Save the current dockspace layout configuration to a file.

Parameters

filename

Path to the file where layout settings will be saved

---

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

• Editor/Components/Dockspace.h
• Editor/Components/Dockspace.cpp