UI.h

浏览该文件的文档.

#pragma once
 
#include "common/Module.h"
#include "ui/UIBackend.h"
#include "ui/UIHost.h"
#include "ui/Widget.h"
 
#include <SDL2/SDL.h>
#include <simplesquirrel/simplesquirrel.hpp>
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
namespace eve::graphics {
class Canvas;
class Graphics;
class Texture;
}
 
namespace eve::ui {
 
struct UIEvent;
 
class UI : public Module {
public:
    Module_REG(UI);
    UI();
    ~UI() override;
 
    bool initBackend();
    void shutdownBackend();
    bool isBackendReady() const;
 
    void processEvent(const SDL_Event *event);
    void beginFrameAndRender();
    void dispatchEvents();
 
    bool wantCaptureMouse() const;
    bool wantCaptureKeyboard() const;
 
    UIHost *mountAs(const std::string &name, WidgetDesc root);
    UIHost *mount(WidgetDesc root);
    UIHost *remount(WidgetDesc root);
    UIHost *remountReconcile(WidgetDesc root);
    UIHost *remountAs(const std::string &name, WidgetDesc root);
 
    bool select(const std::string &name);
    UIHost *findHost(const std::string &name) const;
    UIHost *findHostByOwner(uint32_t ownerId) const;
    UIHost *current() const { return selected_; }
    void bindOwner(uint32_t ownerId);
 
    void beginBuild();
    void beginWindow(const std::string &title, const std::string &id = "root");
    void beginGroup(const std::string &id = "");
    void beginList(const std::string &id);
    void beginCollapsing(const std::string &label, const std::string &id = "", bool open = true);
    void beginChild(const std::string &id, float width = 0.f, float height = 120.f);
    void beginScrollList(const std::string &id = "", float height = 0.f, float itemHeight = 0.f);
    void beginFlex(const std::string &direction = "row", const std::string &id = "",
                   float gap = -1.f);
    void beginRow(const std::string &id = "", float gap = -1.f);
    void beginColumn(const std::string &id = "", float gap = -1.f);
    void end();
    void addText(const std::string &content, const std::string &id = "");
    void addTextWrapped(const std::string &content, float width, const std::string &id = "");
    void addButton(const std::string &label, const std::string &id = "");
    void addSameLine(const std::string &id = "");
    void addSeparator(const std::string &id = "");
    void addCheckbox(const std::string &label, bool checked, const std::string &id = "");
    void addSlider(const std::string &label, float value, float minV, float maxV,
                   const std::string &id = "");
    void addProgress(float fraction, const std::string &id = "", const std::string &overlay = "");
    void addImage(const std::string &id = "", float width = 0.f, float height = 0.f);
    void addImageButton(const std::string &id, float width, float height);
    void addViewport(const std::string &id, float width = 0.f, float height = 0.f);
    void addCombo(const std::string &label, const std::string &options, int selected,
                  const std::string &id = "");
    void addInputText(const std::string &label, const std::string &value, const std::string &id = "");
    void addSpacer(const std::string &id = "", float grow = 1.f);
    void setItemFlexGrow(float grow);
    void setItemSize(float width, float height);
    void setItemMargin(float l, float t, float r, float b);
    void setItemPadding(float l, float t, float r, float b);
    void setItemMinSize(float w, float h);
    void setItemMaxSize(float w, float h);
    void setItemPercent(float w, float h);
    void setItemAbsolute(float anchorX, float anchorY, float x = 0.f, float y = 0.f);
    void setFlexAlign(const std::string &align);
    void setFlexJustify(const std::string &justify);
    void addListItem(const std::string &label, const std::string &id = "");
 
    bool mountBuild();
    bool mountBuildAs(const std::string &name);
    bool remountBuildAs(const std::string &name);
 
    bool setListItems(const std::string &listId, const std::vector<std::string> &items);
 
    void setText(const std::string &id, const std::string &text);
    void setTextWrap(const std::string &id, float width);
    void setVisible(const std::string &id, bool visible);
    void setChecked(const std::string &id, bool checked);
    void setValue(const std::string &id, float value);
    void setValueText(const std::string &id, const std::string &value);
    void setImageTint(const std::string &id, float r, float g, float b, float a = 1.f);
    void setImageUv(const std::string &id, float u0, float v0, float u1, float v1);
    void setImageNinePatch(const std::string &id, float l, float t, float r, float b);
    void setImageCornerRadius(const std::string &id, float radius);
    void setImageTextureId(const std::string &id, uint64_t textureId);
    uint64_t registerTexture(graphics::Texture *tex);
    float getValue(const std::string &id) const;
    std::string getValueText(const std::string &id) const;
    bool getChecked(const std::string &id) const;
    void setHostVisible(bool visible);
    void setHostLayer(int layer);
    void setHostModal(bool modal);
    void setHostOverlay(bool overlay);
    void setHostPos(float x, float y, float pivotX = 0.f, float pivotY = 0.f);
    void setHostAnchor(float x, float y);
    void setHostSize(float w, float h);
    void setHostPercent(float w, float h);
    void animateHostPos(float x, float y, float durationMs);
    std::string consumeClick();
    std::string consumeChange();
 
    void onClick(const std::string &id, ssq::Function fn);
    void onChange(const std::string &id, ssq::Function fn);
 
    void setThemeDark();
    void setThemeLight();
    bool setTheme(const std::string &name);
    std::string getTheme() const;
    void setNavKeyboard(bool enabled);
    void setNavGamepad(bool enabled);
    void setScale(float scale);
    float getScale() const;
    std::string getStats() const;
    std::string saveTreeJson() const;
    bool loadTreeJson(const std::string &json);
    graphics::Canvas *viewportCanvas(const std::string &id);
    bool viewportHovered(const std::string &id);
    bool viewportActive(const std::string &id);
    float viewportMouseX(const std::string &id);
    float viewportMouseY(const std::string &id);
    float viewportDragDX(const std::string &id);
    float viewportDragDY(const std::string &id);
    float viewportWheel(const std::string &id);
 
    void mountSimple(const std::string &title, const std::string &labelText,
                     const std::string &buttonText);
 
private:
    WidgetDesc &currentParent();
    void pushOpen(WidgetDesc d);
    bool buildComplete() const;
    UIHost *ensureSelected(const std::string &preferredName = "");
 
    std::unique_ptr<UIBackend> backend_;
    UIHost *selected_ = nullptr;
 
    std::vector<WidgetDesc> openStack_;
    WidgetDesc builtRoot_;
    bool hasBuiltRoot_ = false;
 
    struct ScriptHandler {
        ScriptHandler(std::string host, std::string node, std::string k, ssq::Function f)
            : hostName(std::move(host)), nodeId(std::move(node)), kind(std::move(k)),
              fn(std::move(f)) {}
        std::string hostName;
        std::string nodeId;
        std::string kind;  // "click" | "toggle" | "value" | "text"
        ssq::Function fn;
    };
    std::vector<ScriptHandler> scriptHandlers_;
    void fireScriptHandlers(const UIEvent &ev);
 
    struct HostTween {
        UIHost *host = nullptr;
        float fromX = 0.f;
        float fromY = 0.f;
        float toX = 0.f;
        float toY = 0.f;
        double startMs = 0.0;
        double durationMs = 0.0;
    };
    std::vector<HostTween> hostTweens_;
    void updateHostTweens();
};
 
}  // namespace eve::ui