ModuleWidget.hpp

Go to the documentation of this file.

#pragma once
#include <app/common.hpp>
#include <widget/OpaqueWidget.hpp>
#include <ui/Menu.hpp>
#include <app/PortWidget.hpp>
#include <app/ParamWidget.hpp>
#include <plugin/Model.hpp>
#include <engine/Module.hpp>
#include <history.hpp>
 
 
namespace rack {
namespace app {
 
 
struct ModuleWidget : widget::OpaqueWidget {
    struct Internal;
    Internal* internal;
 
    plugin::Model* model = NULL;
    engine::Module* module = NULL;
 
    ModuleWidget();
    DEPRECATED ModuleWidget(engine::Module* module) : ModuleWidget() {
        setModule(module);
    }
    ~ModuleWidget();
 
    plugin::Model* getModel();
    void setModel(plugin::Model* model);
 
    engine::Module* getModule();
    template <class TModule>
    TModule* getModule() {
        return dynamic_cast<TModule*>(getModule());
    }
    void setModule(engine::Module* module);
 
    widget::Widget* getPanel();
    void setPanel(widget::Widget* panel);
    void setPanel(std::shared_ptr<window::Svg> svg);
 
    void addParam(ParamWidget* param);
    void addInput(PortWidget* input);
    void addOutput(PortWidget* output);
    ParamWidget* getParam(int paramId);
    PortWidget* getInput(int portId);
    PortWidget* getOutput(int portId);
    std::vector<ParamWidget*> getParams();
    std::vector<PortWidget*> getPorts();
    std::vector<PortWidget*> getInputs();
    std::vector<PortWidget*> getOutputs();
 
    void draw(const DrawArgs& args) override;
    void drawLayer(const DrawArgs& args, int layer) override;
 
    virtual void appendContextMenu(ui::Menu* menu) {}
 
    void onHover(const HoverEvent& e) override;
    void onHoverKey(const HoverKeyEvent& e) override;
    void onButton(const ButtonEvent& e) override;
    void onDragStart(const DragStartEvent& e) override;
    void onDragEnd(const DragEndEvent& e) override;
    void onDragMove(const DragMoveEvent& e) override;
    void onDragHover(const DragHoverEvent& e) override;
 
    json_t* toJson();
    void fromJson(json_t* rootJ);
    bool pasteJsonAction(json_t* rootJ);
    void copyClipboard();
    bool pasteClipboardAction();
    void load(std::string filename);
    void loadAction(std::string filename);
    void loadTemplate();
    void loadDialog();
    void save(std::string filename);
    void saveTemplate();
    void saveTemplateDialog();
    bool hasTemplate();
    void clearTemplate();
    void clearTemplateDialog();
    void saveDialog();
 
    void disconnect();
 
    void resetAction();
    void randomizeAction();
    void appendDisconnectActions(history::ComplexAction* complexAction);
    void disconnectAction();
    void cloneAction(bool cloneCables = true);
    void bypassAction(bool bypassed);
    void removeAction();
    void createContextMenu();
 
    // Returns the rack position in grid coordinates
    math::Vec getGridPosition();
    void setGridPosition(math::Vec pos);
    math::Vec getGridSize();
    math::Rect getGridBox();
 
    PRIVATE math::Vec& dragOffset();
    PRIVATE bool& dragEnabled();
    PRIVATE engine::Module* releaseModule();
};
 
 
} // namespace app
} // namespace rack