Code/Sandbox/Plugins/EditorCommon/QtViewPane.h

   1 // Copyright 2001-2018 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 #pragma once
   4
   5 #include "IEditorClassFactory.h"
   6 #include "AutoRegister.h"
   7 #include <QWidget>
   8 #include <QMainWindow>
   9 #include <QVariantMap>
  10 #include <QRect>
  11 #include <QSize>
  12 #include "EditorFramework/StateSerializable.h"
  13
  14 class IPane;
  15
  16 struct IViewPaneClass : public IClassDesc
  17 {
  18         enum EDockingDirection
  19         {
  20                 DOCK_DEFAULT = 0,
  21                 DOCK_TOP,
  22                 DOCK_LEFT,
  23                 DOCK_RIGHT,
  24                 DOCK_BOTTOM,
  25                 DOCK_FLOAT,
  26         };
  27         virtual ESystemClassID SystemClassID() { return ESYSTEM_CLASS_VIEWPANE; };
  28
  29         // Get view pane window runtime class.
  30         virtual CRuntimeClass* GetRuntimeClass() = 0;
  31
  32         // Return text for view pane title.
  33         virtual const char* GetPaneTitle() = 0;
  34
  35         // Return true if only one pane at a time of time view class can be created.
  36         virtual bool SinglePane() = 0;
  37
  38         //! Notifies the application if it should create an entry in the tools menu for this pane
  39         virtual bool NeedsMenuItem() { return true; }
  40
  41         //! This method returns the tools menu path where the tool can be spawned from.
  42         virtual const char* GetMenuPath() { return ""; }
  43
  44         //////////////////////////////////////////////////////////////////////////
  45         // Creates a Qt QWidget for this ViewPane
  46         virtual IPane* CreatePane() const { return 0; };
  47 };
  48
  49 class IPane : public IStateSerializable
  50 {
  51 public:
  52         virtual ~IPane() {}
  53
  54         virtual QWidget* GetWidget() = 0;
  55
  56         // Return preferable initial docking position for pane.
  57         virtual IViewPaneClass::EDockingDirection GetDockingDirection() const { return IViewPaneClass::DOCK_FLOAT; }
  58
  59         // Return text for view pane title.
  60         virtual const char* GetPaneTitle() const = 0;
  61
  62         // Initial pane size.
  63         virtual QRect GetPaneRect() { return QRect(0, 0, 800, 500); }
  64
  65         // Get Minimal view size
  66         virtual QSize GetMinSize() { return QSize(0, 0); }
  67
  68         // Save transient state
  69         virtual QVariantMap GetState() const { return QVariantMap(); }
  70
  71         // Restore transient state
  72         virtual void SetState(const QVariantMap& state) {}
  73
  74         //
  75         virtual void LoadLayoutPersonalization() {}
  76
  77         //
  78         virtual void SaveLayoutPersonalization() {}
  79 };
  80
  81 template<typename T>
  82 class CDockableWidgetT : public T, public IPane
  83 {
  84         static_assert(std::is_base_of<QWidget, T>::value, "T has to be QWidget");
  85
  86 public:
  87         CDockableWidgetT(QWidget* pParent = nullptr) : T(pParent)
  88         {
  89                 QWidget::setAttribute(Qt::WA_DeleteOnClose);
  90         }
  91         virtual ~CDockableWidgetT() {}
  92         virtual QWidget* GetWidget() override { return this; };
  93 };
  94
  95 typedef CDockableWidgetT<QWidget> CDockableWidget;
  96
  97 //DEPREACTED, DO NOT USE THIS, QMainWindow is not a suitable baseclass for a dockable pane
  98 typedef CDockableWidgetT<QMainWindow> CDockableWindow;
  99
 100
 101
 102 // Registers the QWidget pane so that it can be opened in the editor as a tool
 103 #define REGISTER_VIEWPANE_FACTORY_AND_MENU_IMPL(widget, name, category, unique, menuPath, needsItem)    \
 104   class widget ## Pane : public IViewPaneClass                                                          \
 105   {                                                                                                     \
 106     virtual const char* ClassName() override { return name; }                                           \
 107     virtual const char* Category()  { return category; }                                                \
 108     virtual bool NeedsMenuItem() { return needsItem; }                                                  \
 109     virtual const char* GetMenuPath() { return menuPath; }                                              \
 110     virtual CRuntimeClass* GetRuntimeClass() { return 0; }                                              \
 111     virtual const char* GetPaneTitle()       override { return name; }                                  \
 112     virtual bool SinglePane()                override { return unique; }                                \
 113     virtual IPane* CreatePane() const        override { return new widget(); }                          \
 114   };                                                                                                    \
 115   REGISTER_CLASS_DESC(widget ## Pane);
 116
 117
 118 #define REGISTER_VIEWPANE_FACTORY(widget, name, category, unique) \
 119   REGISTER_VIEWPANE_FACTORY_AND_MENU_IMPL(widget, name, category, unique, "", true)
 120
 121 #define REGISTER_VIEWPANE_FACTORY_AND_MENU(widget, name, category, unique, menuPath) \
 122   REGISTER_VIEWPANE_FACTORY_AND_MENU_IMPL(widget, name, category, unique, menuPath, true)
 123
 124 #define REGISTER_HIDDEN_VIEWPANE_FACTORY(widget, name, category, unique) \
 125   REGISTER_VIEWPANE_FACTORY_AND_MENU_IMPL(widget, name, category, unique, "", false)