plugin system initialisation

Author: zmoth

CMakeLists.txt

@@ -103,6 +103,7 @@ set(CPP_SOURCE_FILES
   src/StyleCollection.cpp
   src/UndoCommands.cpp
   src/locateNode.cpp
+  src/PluginsManager.cpp
 )
 
 set(HPP_HEADER_FILES
@@ -136,6 +137,8 @@ set(HPP_HEADER_FILES
   include/QtNodes/internal/Serializable.hpp
   include/QtNodes/internal/Style.hpp
   include/QtNodes/internal/StyleCollection.hpp
+  include/QtNodes/internal/PluginInterface.hpp
+  include/QtNodes/internal/PluginsManager.hpp
   src/ConnectionPainter.hpp
   src/DefaultHorizontalNodeGeometry.hpp
   src/DefaultVerticalNodeGeometry.hpp

examples/CMakeLists.txt

@@ -16,3 +16,7 @@ add_subdirectory(dynamic_ports)
 
 add_subdirectory(lock_nodes_and_connections)
 
+add_subdirectory(plugin_text)
+
+add_subdirectory(plugins_load)
+

examples/plugin_text/CMakeLists.txt

@@ -0,0 +1,11 @@
+file(GLOB_RECURSE CPPS ./*.cpp)
+file(GLOB_RECURSE HPPS ./*.hpp)
+
+add_library(plugin_text SHARED ${CPPS} ${HPPS})
+
+target_link_libraries(plugin_text QtNodes)
+
+target_compile_definitions(plugin_text
+  PUBLIC
+    NODE_EDITOR_SHARED
+)

examples/plugin_text/PluginDefinition.cpp

@@ -0,0 +1,14 @@
+#include "PluginDefinition.hpp"
+
+#include "TextSourceDataModel.hpp"
+
+Plugin *Plugin::_this_plugin = nullptr;
+
+Plugin::Plugin() { _this_plugin = this; }
+
+void Plugin::registerDataModels(std::shared_ptr<QtNodes::NodeDelegateModelRegistry> &reg)
+{
+    assert(reg);
+
+    reg->registerModel<TextSourceDataModel>();
+}

examples/plugin_text/PluginDefinition.hpp

@@ -0,0 +1,36 @@
+#pragma once
+
+#include <QObject>
+#include <QtNodes/NodeDelegateModelRegistry>
+#include <QtNodes/PluginInterface>
+
+#if defined(plugin_text_EXPORTS) // 这里需要和您的工程文件名一致${PROJECT_NAME}
+#define DLL_EXPORT Q_DECL_EXPORT
+#else
+#define DLL_EXPORT Q_DECL_IMPORT
+#endif
+
+using QtNodes::NodeDelegateModelRegistry;
+using QtNodes::PluginInterface;
+
+/* 插件名称，一个插件可以存在多个节点 */
+#define PLUGIN_NAME "plugin_text"
+
+class DLL_EXPORT Plugin
+    : public QObject
+    , public QtNodes::PluginInterface
+{
+    Q_OBJECT
+    Q_INTERFACES(QtNodes::PluginInterface)
+    Q_PLUGIN_METADATA(IID PLUGIN_NAME)
+
+  public:
+    Plugin();
+
+    QString name() const override { return PLUGIN_NAME; };
+
+    void registerDataModels(std::shared_ptr<QtNodes::NodeDelegateModelRegistry> &reg) override;
+
+  private:
+    static Plugin *_this_plugin;
+};

examples/plugin_text/TextData.hpp

@@ -0,0 +1,28 @@
+#pragma once
+
+#include <QtNodes/NodeData>
+
+using QtNodes::NodeData;
+using QtNodes::NodeDataType;
+
+/// The class can potentially incapsulate any user data which
+/// need to be transferred within the Node Editor graph
+class TextData : public NodeData
+{
+public:
+
+  TextData() {}
+
+  TextData(QString const &text)
+    : _text(text)
+  {}
+
+  NodeDataType type() const override
+  { return NodeDataType {"text", "Text"}; }
+
+  QString text() const { return _text; }
+
+private:
+
+  QString _text;
+};

examples/plugin_text/TextSourceDataModel.cpp

@@ -0,0 +1,78 @@
+#include "TextSourceDataModel.hpp"
+
+#include <QtWidgets/QLineEdit>
+
+TextSourceDataModel::
+TextSourceDataModel()
+  : _lineEdit{nullptr}
+{
+  //
+}
+
+
+unsigned int
+TextSourceDataModel::
+nPorts(PortType portType) const
+{
+  unsigned int result = 1;
+
+  switch (portType)
+  {
+    case PortType::In:
+      result = 0;
+      break;
+
+    case PortType::Out:
+      result = 1;
+
+    default:
+      break;
+  }
+
+  return result;
+}
+
+
+void
+TextSourceDataModel::
+onTextEdited(QString const & string)
+{
+  Q_UNUSED(string);
+
+  Q_EMIT dataUpdated(0);
+}
+
+
+NodeDataType
+TextSourceDataModel::
+dataType(PortType, PortIndex) const
+{
+  return TextData().type();
+}
+
+
+std::shared_ptr<NodeData>
+TextSourceDataModel::
+outData(PortIndex const portIndex)
+{
+  Q_UNUSED(portIndex);
+  return std::make_shared<TextData>(_lineEdit->text());
+}
+
+
+QWidget *
+TextSourceDataModel::
+embeddedWidget()
+{
+  if (!_lineEdit)
+  {
+    _lineEdit = new QLineEdit("Default Text"),
+
+    connect(_lineEdit, &QLineEdit::textEdited,
+            this, &TextSourceDataModel::onTextEdited);
+
+  }
+
+  return _lineEdit;
+}
+

examples/plugin_text/TextSourceDataModel.hpp

@@ -0,0 +1,66 @@
+#pragma once
+
+#include <QtCore/QObject>
+
+#include "TextData.hpp"
+
+#include <QtNodes/NodeDelegateModel>
+
+#include <iostream>
+
+using QtNodes::PortType;
+using QtNodes::PortIndex;
+using QtNodes::NodeData;
+using QtNodes::NodeDelegateModel;
+
+class QLineEdit;
+
+/// The model dictates the number of inputs and outputs for the Node.
+/// In this example it has no logic.
+class TextSourceDataModel : public NodeDelegateModel
+{
+  Q_OBJECT
+
+public:
+  TextSourceDataModel();
+
+public:
+  QString
+  caption() const override
+  { return QString("Text Source"); }
+
+  bool
+  captionVisible() const override { return false; }
+
+  static QString
+  Name()
+  { return QString("TextSourceDataModel"); }
+
+  QString
+  name() const override
+  { return TextSourceDataModel::Name(); }
+
+public:
+  unsigned int
+  nPorts(PortType portType) const override;
+
+  NodeDataType
+  dataType(PortType portType, PortIndex portIndex) const override;
+
+  std::shared_ptr<NodeData>
+  outData(PortIndex const portIndex) override;
+
+  void
+  setInData(std::shared_ptr<NodeData>, PortIndex const) override { }
+
+  QWidget *
+  embeddedWidget() override;
+
+private Q_SLOTS:
+
+  void
+  onTextEdited(QString const & string);
+
+private:
+  QLineEdit * _lineEdit;
+};

examples/plugins_load/CMakeLists.txt

@@ -0,0 +1,6 @@
+file(GLOB_RECURSE CPPS ./*.cpp)
+file(GLOB_RECURSE HPPS ./*.hpp)
+
+add_executable(plugins_load ${CPPS} ${HPPS})
+
+target_link_libraries(plugins_load QtNodes)

examples/plugins_load/main.cpp

@@ -0,0 +1,58 @@
+#include <QApplication>
+#include <QMenuBar>
+#include <QVBoxLayout>
+#include <QtNodes/DataFlowGraphModel>
+#include <QtNodes/DataFlowGraphicsScene>
+#include <QtNodes/GraphicsView>
+#include <QtNodes/NodeDelegateModelRegistry>
+#include <QtNodes/PluginsManager>
+
+using QtNodes::DataFlowGraphicsScene;
+using QtNodes::DataFlowGraphModel;
+using QtNodes::GraphicsView;
+using QtNodes::NodeDelegateModelRegistry;
+using QtNodes::PluginsManager;
+
+int main(int argc, char *argv[])
+{
+    qSetMessagePattern(
+        "[%{time yyyyMMdd h:mm:ss.zzz}] [%{time process}] "
+        "[%{if-debug}D%{endif}%{if-info}I%{endif}%{if-warning}W%{endif}%{if-critical}C%{endif}%{if-"
+        "fatal}F%{endif}]: %{message}\t| (%{function}) [%{file}:%{line}]");
+
+    QApplication app(argc, argv);
+
+    PluginsManager *pluginsManager = PluginsManager::instance();
+    std::shared_ptr<NodeDelegateModelRegistry> registry = pluginsManager->registry();
+    pluginsManager->loadPlugins(R"(./nodes)");
+    for (auto plugin : pluginsManager->pluginList())
+    {
+        plugin->registerDataModels(registry);
+    }
+
+    QWidget mainWidget;
+
+    auto menuBar = new QMenuBar();
+    QMenu *menu = menuBar->addMenu("File");
+    auto saveAction = menu->addAction("Save Scene");
+    auto loadAction = menu->addAction("Load Scene");
+
+    QVBoxLayout *l = new QVBoxLayout(&mainWidget);
+
+    DataFlowGraphModel dataFlowGraphModel(registry);
+
+    l->addWidget(menuBar);
+    auto scene = new DataFlowGraphicsScene(dataFlowGraphModel, &mainWidget);
+    l->addWidget(new GraphicsView(scene));
+    l->setContentsMargins(0, 0, 0, 0);
+    l->setSpacing(0);
+
+    QObject::connect(saveAction, &QAction::triggered, scene, &DataFlowGraphicsScene::save);
+    QObject::connect(loadAction, &QAction::triggered, scene, &DataFlowGraphicsScene::load);
+
+    mainWidget.setWindowTitle("Data Flow: Plugins Load");
+    mainWidget.resize(800, 600);
+    mainWidget.show();
+
+    return app.exec();
+}