Code/Editor/EditorFramework/Actions/Implementation/WindowLayoutActions.cpp - dev - redgpu/ezEngine

Code/Editor/EditorFramework/Actions/Implementation/WindowLayoutActions.cpp
414 строк14 KB
Jan Krassnigg
Fixes #1828: Allow to save and restore different window layouts (#1831)
28 фев 2026, 21:57
28 фев 2026, 21:571fa42f5
#include <EditorFramework/EditorFrameworkPCH.h>

#include <EditorFramework/Actions/WindowLayoutActions.h>
#include <GuiFoundation/Action/ActionManager.h>
#include <GuiFoundation/Action/ActionMapManager.h>
#include <GuiFoundation/ContainerWindow/ContainerWindow.moc.h>
#include <GuiFoundation/DockPanels/ApplicationPanel.moc.h>
#include <GuiFoundation/DocumentWindow/DocumentWindow.moc.h>

#include <EditorFramework/Panels/AssetBrowserPanel/AssetBrowserPanel.moc.h>
#include <EditorFramework/Panels/AssetCuratorPanel/AssetCuratorPanel.moc.h>
#include <EditorFramework/Panels/CVarPanel/CVarPanel.moc.h>
#include <EditorFramework/Panels/LogPanel/LogPanel.moc.h>
#include <EditorFramework/Panels/LongOpsPanel/LongOpsPanel.moc.h>
#include <QInputDialog>
#include <QSettings>
#include <ads/DockManager.h>

ezActionDescriptorHandle ezWindowLayoutActions::s_hCatWindowLayout;
ezActionDescriptorHandle ezWindowLayoutActions::s_hSetToDefaultPinned;
ezActionDescriptorHandle ezWindowLayoutActions::s_hSetToDefaultUnpinned;
ezActionDescriptorHandle ezWindowLayoutActions::s_hSetToAbBottom;
ezActionDescriptorHandle ezWindowLayoutActions::s_hSaveLayout;
ezActionDescriptorHandle ezWindowLayoutActions::s_hLoadLayout;

static const char* s_szDefaultLayoutName = "Default";
static const char* s_szSettingsGroup = "EditorWindowLayouts";
static const int s_iNumUserLayoutSlots = 3;

static QByteArray s_DefaultLayoutState;

void ezWindowLayoutActions::RegisterActions()
{
  s_hCatWindowLayout = EZ_REGISTER_MENU("WindowLayout");
  s_hSetToDefaultPinned = EZ_REGISTER_ACTION_1("Layout.DefaultPinned", ezActionScope::Global, "Layout", "", ezWindowLayoutAction, ezWindowLayoutAction::ButtonType::SetToDefaultPinned);
  s_hSetToDefaultUnpinned = EZ_REGISTER_ACTION_1("Layout.DefaultUnpinned", ezActionScope::Global, "Layout", "", ezWindowLayoutAction, ezWindowLayoutAction::ButtonType::SetToDefaultUnpinned);
  s_hSetToAbBottom = EZ_REGISTER_ACTION_1("Layout.AbBottom", ezActionScope::Global, "Layout", "", ezWindowLayoutAction, ezWindowLayoutAction::ButtonType::SetToAbBottom);
  s_hSaveLayout = EZ_REGISTER_DYNAMIC_MENU("Layout.SaveLayout", ezSaveLayoutMenuAction, "Save Layout");
  s_hLoadLayout = EZ_REGISTER_DYNAMIC_MENU("Layout.LoadLayout", ezLoadLayoutMenuAction, "Load Layout");
}

void ezWindowLayoutActions::UnregisterActions()
{
  ezActionManager::UnregisterAction(s_hCatWindowLayout);
  ezActionManager::UnregisterAction(s_hSetToDefaultPinned);
  ezActionManager::UnregisterAction(s_hSetToDefaultUnpinned);
  ezActionManager::UnregisterAction(s_hSetToAbBottom);
  ezActionManager::UnregisterAction(s_hSaveLayout);
  ezActionManager::UnregisterAction(s_hLoadLayout);
}

void ezWindowLayoutActions::MapActions(ezStringView sMapping)
{
  ezActionMap* pMap = ezActionMapManager::GetActionMap(sMapping);
  EZ_ASSERT_DEV(pMap != nullptr, "The given mapping ('{0}') does not exist, mapping the actions failed!", sMapping);

  pMap->MapAction(s_hCatWindowLayout, "G.Panels", 2.0f);
  pMap->MapAction(s_hSetToDefaultPinned, "WindowLayout", 1.0f);
  pMap->MapAction(s_hSetToDefaultUnpinned, "WindowLayout", 2.0f);
  pMap->MapAction(s_hSetToAbBottom, "WindowLayout", 3.0f);
  pMap->MapAction(s_hSaveLayout, "G.Panels", 3.0f);
  pMap->MapAction(s_hLoadLayout, "G.Panels", 4.0f);
}

void ezWindowLayoutActions::RestoreUserLayout()
{
  ezQtContainerWindow* pContainer = ezQtContainerWindow::GetContainerWindow();
  if (pContainer == nullptr)
    return;

  ads::CDockManager* pDockManager = pContainer->GetDockManager();
  if (pDockManager == nullptr)
    return;

  QSettings settings;
  settings.beginGroup(s_szSettingsGroup);
  pDockManager->loadPerspectives(settings);
  settings.endGroup();

  pDockManager->openPerspective(s_szDefaultLayoutName);
}

void ezWindowLayoutActions::SaveUserLayout()
{
  ezQtContainerWindow* pContainer = ezQtContainerWindow::GetContainerWindow();
  if (pContainer == nullptr)
    return;

  ads::CDockManager* pDockManager = pContainer->GetDockManager();
  if (pDockManager == nullptr)
    return;

  pDockManager->addPerspective(s_szDefaultLayoutName);

  QSettings settings;
  settings.beginGroup(s_szSettingsGroup);
  pDockManager->savePerspectives(settings);
  settings.endGroup();
}

//////////////////////////////////////////////////////////////////////////
// ezWindowLayoutAction
//////////////////////////////////////////////////////////////////////////

EZ_BEGIN_DYNAMIC_REFLECTED_TYPE(ezWindowLayoutAction, 1, ezRTTINoAllocator)
EZ_END_DYNAMIC_REFLECTED_TYPE;

ezWindowLayoutAction::ezWindowLayoutAction(const ezActionContext& context, const char* szName, ButtonType button)
  : ezButtonAction(context, szName, false, "")
{
  m_ButtonType = button;

  switch (m_ButtonType)
  {
    case ButtonType::SetToDefaultPinned:
    case ButtonType::SetToDefaultUnpinned:
    case ButtonType::SetToAbBottom:
      break;
  }
}

void ezWindowLayoutAction::Execute(const ezVariant& value)
{
  ezQtContainerWindow* pContainer = ezQtContainerWindow::GetContainerWindow();
  if (pContainer == nullptr)
    return;

  ads::CDockManager* pDockManager = pContainer->GetDockManager();
  if (pDockManager == nullptr)
    return;

  // Get all application panels
  const ezDynamicArray<ezQtApplicationPanel*>& allPanels = ezQtApplicationPanel::GetAllApplicationPanels();

  // Find the specific panels we need
  ezQtApplicationPanel* pAssetBrowserPanel = ezQtAssetBrowserPanel::GetSingleton();
  ezQtApplicationPanel* pAssetCuratorPanel = ezQtAssetCuratorPanel::GetSingleton();
  ezQtApplicationPanel* pLogPanel = ezQtLogPanel::GetSingleton();
  ezQtApplicationPanel* pCVarPanel = ezQtCVarPanel::GetSingleton();
  ezQtApplicationPanel* pLongOpsPanel = ezQtLongOpsPanel::GetSingleton();

  switch (m_ButtonType)
  {
    case ButtonType::SetToDefaultPinned:
    {
      // Arrange panels the same way as in ezQtEditorApp::CreatePanels()
      if (pAssetBrowserPanel)
      {
        pDockManager->removeDockWidget(pAssetBrowserPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pAssetBrowserPanel);
      }
      if (pAssetCuratorPanel)
      {
        pDockManager->removeDockWidget(pAssetCuratorPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pAssetCuratorPanel);
      }
      if (pLogPanel)
      {
        pDockManager->removeDockWidget(pLogPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pLogPanel);
      }
      if (pCVarPanel)
      {
        pDockManager->removeDockWidget(pCVarPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pCVarPanel);
      }
      if (pLongOpsPanel)
      {
        pDockManager->removeDockWidget(pLongOpsPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pLongOpsPanel);
      }

      break;
    }

    case ButtonType::SetToDefaultUnpinned:
    {
      // Arrange panels the same way as in ezQtEditorApp::CreatePanels()
      // but set them all to unpinned (auto hide)
      if (pAssetBrowserPanel)
      {
        pDockManager->removeDockWidget(pAssetBrowserPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pAssetBrowserPanel);
        pAssetBrowserPanel->setAutoHide(true, ads::SideBarRight);
      }
      if (pAssetCuratorPanel)
      {
        pDockManager->removeDockWidget(pAssetCuratorPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pAssetCuratorPanel);
        pAssetCuratorPanel->setAutoHide(true, ads::SideBarRight);
      }
      if (pLogPanel)
      {
        pDockManager->removeDockWidget(pLogPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pLogPanel);
        pLogPanel->setAutoHide(true, ads::SideBarRight);
      }
      if (pCVarPanel)
      {
        pDockManager->removeDockWidget(pCVarPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pCVarPanel);
        pCVarPanel->setAutoHide(true, ads::SideBarRight);
      }
      if (pLongOpsPanel)
      {
        pDockManager->removeDockWidget(pLongOpsPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pLongOpsPanel);
        pLongOpsPanel->setAutoHide(true, ads::SideBarRight);
      }
      break;
    }

    case ButtonType::SetToAbBottom:
    {
      // Arrange most panels as in ezQtEditorApp::CreatePanels()
      // but dock the asset browser at the bottom of the screen (pinned / not auto-hide)
      if (pAssetBrowserPanel)
      {
        pDockManager->removeDockWidget(pAssetBrowserPanel);
        pDockManager->addDockWidget(ads::BottomDockWidgetArea, pAssetBrowserPanel);
      }
      if (pAssetCuratorPanel)
      {
        pDockManager->removeDockWidget(pAssetCuratorPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pAssetCuratorPanel);
        pAssetCuratorPanel->setAutoHide(true, ads::SideBarRight);
      }
      if (pLogPanel)
      {
        pDockManager->removeDockWidget(pLogPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pLogPanel);
        pLogPanel->setAutoHide(true, ads::SideBarRight);
      }
      if (pCVarPanel)
      {
        pDockManager->removeDockWidget(pCVarPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pCVarPanel);
        pCVarPanel->setAutoHide(true, ads::SideBarRight);
      }
      if (pLongOpsPanel)
      {
        pDockManager->removeDockWidget(pLongOpsPanel);
        pDockManager->addDockWidgetTab(ads::RightDockWidgetArea, pLongOpsPanel);
        pLongOpsPanel->setAutoHide(true, ads::SideBarRight);
      }

      break;
    }
  }

  // Hide panels that are hidden by default
  if (pCVarPanel)
  {
    pCVarPanel->toggleView(false);
  }

  if (pLongOpsPanel)
  {
    pLongOpsPanel->toggleView(false);
  }

  // Raise the asset browser to front
  if (pAssetBrowserPanel)
  {
    pAssetBrowserPanel->EnsureVisible();
  }
}

//////////////////////////////////////////////////////////////////////////
// ezSaveLayoutMenuAction
//////////////////////////////////////////////////////////////////////////

EZ_BEGIN_DYNAMIC_REFLECTED_TYPE(ezSaveLayoutMenuAction, 1, ezRTTINoAllocator)
EZ_END_DYNAMIC_REFLECTED_TYPE;

ezSaveLayoutMenuAction::ezSaveLayoutMenuAction(const ezActionContext& context, const char* szName, const char* szIconPath)
  : ezDynamicMenuAction(context, szName, szIconPath)
{
}

void ezSaveLayoutMenuAction::GetEntries(ezDynamicArray<Item>& out_entries)
{
  out_entries.Clear();

  QSettings settings;
  settings.beginGroup(s_szSettingsGroup);

  ezStringBuilder sDisplay;
  for (int i = 0; i < s_iNumUserLayoutSlots; ++i)
  {
    const QString sNameKey = QString("UserSlot_%1_Name").arg(i);
    const QString sSlotName = settings.value(sNameKey, QString()).toString();

    Item item;
    if (sSlotName.isEmpty())
    {
      sDisplay.SetFormat("Slot {0}: [Empty]", i + 1);
    }
    else
    {
      sDisplay.SetFormat("Slot {0}: {1}", i + 1, sSlotName.toUtf8().constData());
    }
    item.m_sDisplay = sDisplay;
    item.m_UserValue = i;
    out_entries.PushBack(item);
  }

  settings.endGroup();
}

void ezSaveLayoutMenuAction::Execute(const ezVariant& value)
{
  ezQtContainerWindow* pContainer = ezQtContainerWindow::GetContainerWindow();
  if (pContainer == nullptr)
    return;

  ads::CDockManager* pDockManager = pContainer->GetDockManager();
  if (pDockManager == nullptr)
    return;

  const int iSlot = value.ConvertTo<int>();

  QSettings settings;
  settings.beginGroup(s_szSettingsGroup);

  const QString sNameKey = QString("UserSlot_%1_Name").arg(iSlot);
  const QString sStateKey = QString("UserSlot_%1_State").arg(iSlot);
  const QString sExistingName = settings.value(sNameKey, QString()).toString();

  bool bOk = false;
  const QString sName = QInputDialog::getText(pContainer, QStringLiteral("Save Layout"), QStringLiteral("Layout name:"), QLineEdit::Normal, sExistingName, &bOk);

  if (!bOk || sName.trimmed().isEmpty())
  {
    settings.endGroup();
    return;
  }

  settings.setValue(sNameKey, sName.trimmed());
  settings.setValue(sStateKey, pDockManager->saveState());

  settings.endGroup();
}

//////////////////////////////////////////////////////////////////////////
// ezLoadLayoutMenuAction
//////////////////////////////////////////////////////////////////////////

EZ_BEGIN_DYNAMIC_REFLECTED_TYPE(ezLoadLayoutMenuAction, 1, ezRTTINoAllocator)
EZ_END_DYNAMIC_REFLECTED_TYPE;

ezLoadLayoutMenuAction::ezLoadLayoutMenuAction(const ezActionContext& context, const char* szName, const char* szIconPath)
  : ezDynamicMenuAction(context, szName, szIconPath)
{
}

void ezLoadLayoutMenuAction::GetEntries(ezDynamicArray<Item>& out_entries)
{
  out_entries.Clear();

  QSettings settings;
  settings.beginGroup(s_szSettingsGroup);

  ezStringBuilder sDisplay;
  for (int i = 0; i < s_iNumUserLayoutSlots; ++i)
  {
    const QString sNameKey = QString("UserSlot_%1_Name").arg(i);
    const QString sSlotName = settings.value(sNameKey, QString()).toString();

    if (sSlotName.isEmpty())
      continue;

    Item item;
    sDisplay.SetFormat("Slot {0}: {1}", i + 1, sSlotName.toUtf8().constData());
    item.m_sDisplay = sDisplay;
    item.m_UserValue = i;
    out_entries.PushBack(item);
  }

  settings.endGroup();
}

void ezLoadLayoutMenuAction::Execute(const ezVariant& value)
{
  ezQtContainerWindow* pContainer = ezQtContainerWindow::GetContainerWindow();
  if (pContainer == nullptr)
    return;

  ads::CDockManager* pDockManager = pContainer->GetDockManager();
  if (pDockManager == nullptr)
    return;

  const int iSlot = value.ConvertTo<int>();

  QSettings settings;
  settings.beginGroup(s_szSettingsGroup);

  const QString sNameKey = QString("UserSlot_%1_Name").arg(iSlot);
  const QString sStateKey = QString("UserSlot_%1_State").arg(iSlot);

  if (settings.value(sNameKey, QString()).toString().isEmpty())
  {
    settings.endGroup();
    return;
  }

  const QByteArray state = settings.value(sStateKey).toByteArray();
  settings.endGroup();

  if (!state.isEmpty())
  {
    pDockManager->restoreState(state);
  }
}