EditorWorkspace.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
 
#include "editor/EditorDock.h"
#include "editor/EditorSelection.h"
 
#include <cstdint>
#include <cstddef>
#include <string>
#include <string_view>
#include <vector>
 
namespace eve::editor {
 
enum class WorkspaceRegion { Left, Right, Top, Bottom, Center, Floating };
 
std::string_view workspaceRegionName(WorkspaceRegion region);
 
struct WorkspacePanelDescriptor {
    std::string id;
    std::string title;
    std::string region = "center";
    std::string capability;
    std::string context;
    int         order     = 0;
    bool        visible   = true;
    bool        singleton = true;
};
 
class EVENGINE_API_ORCHESTRATION EditorWorkspace {
public:
    EditorWorkspace(std::string id, std::string title);
 
    const std::string& getId() const { return id_; }
    const std::string& getTitle() const { return title_; }
    void setTitle(const std::string& title);
 
    [[nodiscard]] Result<WorkspacePanelDescriptor> registerPanel(WorkspacePanelDescriptor descriptor);
    [[nodiscard]] Result<WorkspacePanelDescriptor> movePanel(const StableId& id, WorkspaceRegion region,
                                                                  int order);
    [[nodiscard]] Result<WorkspacePanelDescriptor> removePanel(const StableId& id);
    [[nodiscard]] Result<WorkspacePanelDescriptor> activatePanel(const StableId& id);
    [[nodiscard]] Result<WorkspacePanelDescriptor> panelAt(std::size_t index) const;
 
    bool registerPanel(const std::string& id, const std::string& title, const std::string& region, int order);
    bool removePanel(const std::string& id);
    void clearPanels();
    bool movePanel(const std::string& id, const std::string& region, int order);
    bool setPanelCapability(const std::string& id, const std::string& capability);
    bool setPanelContext(const std::string& id, const std::string& context);
    bool setPanelVisible(const std::string& id, bool visible);
    bool setPanelSingleton(const std::string& id, bool singleton);
    bool activatePanel(const std::string& id);
    const std::string& getActivePanel() const { return activePanel_; }
 
    int getPanelCount() const { return static_cast<int>(panels_.size()); }
    std::string getPanelId(int index) const;
    std::string getPanelTitle(int index) const;
    std::string getPanelRegion(int index) const;
    std::string getPanelCapability(int index) const;
    std::string getPanelContext(int index) const;
    int getPanelOrder(int index) const;
    bool getPanelVisible(int index) const;
    bool getPanelSingleton(int index) const;
 
    void setRegionSize(const std::string& region, float pixels);
    void layout(float width, float height);
    float getRegionX(const std::string& region) const;
    float getRegionY(const std::string& region) const;
    float getRegionW(const std::string& region) const;
    float getRegionH(const std::string& region) const;
 
    bool setMode(const std::string& mode);
    [[nodiscard]] Result<StableId> setModeId(StableId mode);
    const std::string& getMode() const { return mode_; }
 
    bool select(const std::string& channel, const std::string& domain, const std::string& target,
                const std::string& item, const std::string& type, bool additive);
    [[nodiscard]] Result<SelectionSnapshot> selectItem(std::string channel, SelectionItem item, bool additive);
    bool clearSelection(const std::string& channel);
    [[nodiscard]] Result<SelectionSnapshot> clearSelectionChecked(const std::string& channel);
    int getSelectionCount(const std::string& channel) const;
    std::string getSelectionItem(const std::string& channel, int index) const;
    std::string getSelectionType(const std::string& channel, int index) const;
    std::string getPrimarySelection(const std::string& channel) const;
    std::uint64_t getSelectionSequence(const std::string& channel) const;
    bool focus(const std::string& channel, const std::string& surface, const std::string& item);
    [[nodiscard]] Result<EditorFocusSnapshot> focusItem(const std::string& channel, StableId surface,
                                                              StableId item);
    std::string getFocusedSurface(const std::string& channel) const;
 
    std::uint64_t getRevision() const { return revision_; }
 
private:
    static bool                     isRegion(const std::string& region);
    static bool                     parseDomain(const std::string& value, SelectionDomain& domain);
    WorkspacePanelDescriptor* findPanel(const std::string& id);
    const WorkspacePanelDescriptor* panelAtUnchecked(int index) const;
    void                            sortPanels();
    void                            changed();
 
    std::string                           id_;
    std::string                           title_;
    std::string                           mode_ = "edit";
    std::string                           activePanel_;
    std::vector<WorkspacePanelDescriptor> panels_;
    EditorDock                            dock_;
    EditorSelectionService                selection_;
    EditorFocusService                    focus_;
    std::uint64_t                         revision_ = 0;
};
 
}  // namespace eve::editor