editor_panel.h

Go to the documentation of this file.

#ifndef YAZE_APP_EDITOR_SYSTEM_EDITOR_PANEL_H_
#define YAZE_APP_EDITOR_SYSTEM_EDITOR_PANEL_H_
 
#include <string>
 
namespace yaze {
namespace editor {
 
enum class PanelCategory {
  EditorBound,  
  Persistent,   
  CrossEditor   
};
 
class EditorPanel {
 public:
  virtual ~EditorPanel() = default;
 
  // ==========================================================================
  // Identity (Required)
  // ==========================================================================
 
  virtual std::string GetId() const = 0;
 
  virtual std::string GetDisplayName() const = 0;
 
  virtual std::string GetIcon() const = 0;
 
  virtual std::string GetEditorCategory() const = 0;
 
  // ==========================================================================
  // Drawing (Required)
  // ==========================================================================
 
  virtual void Draw(bool* p_open) = 0;
 
  // ==========================================================================
  // Lifecycle Hooks (Optional)
  // ==========================================================================
 
  virtual void OnOpen() {}
 
  virtual void OnClose() {}
 
  virtual void OnFocus() {}
 
  // ==========================================================================
  // Behavior (Optional)
  // ==========================================================================
 
  virtual PanelCategory GetPanelCategory() const {
    return PanelCategory::EditorBound;
  }
 
  virtual bool IsEnabled() const { return true; }
 
  virtual std::string GetDisabledTooltip() const { return ""; }
 
  virtual std::string GetShortcutHint() const { return ""; }
 
  virtual int GetPriority() const { return 50; }
 
  virtual float GetPreferredWidth() const { return 0.0f; }
 
  virtual bool IsVisibleByDefault() const { return false; }
 
  // ==========================================================================
  // Relationships (Optional)
  // ==========================================================================
 
  virtual std::string GetParentPanelId() const { return ""; }
 
  virtual bool CascadeCloseChildren() const { return false; }
};
 
}  // namespace editor
}  // namespace yaze
 
#endif  // YAZE_APP_EDITOR_SYSTEM_EDITOR_PANEL_H_