Skip to content

Commit 1631056

Browse files
zmothzmoth
committed
plugin
- Added the plug-in manager - Added plug-in example
1 parent 5465ddc commit 1631056

File tree

15 files changed

+606
-6
lines changed

15 files changed

+606
-6
lines changed

‎CMakeLists.txt‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ option(QT_NODES_FORCE_TEST_COLOR "Force colorized unit test output" OFF)
3131

3232
enable_testing()
3333

34+
include(GNUInstallDirs)
3435
if(QT_NODES_DEVELOPER_DEFAULTS)
35-
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/bin")
36-
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/lib")
37-
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/lib")
36+
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}")
37+
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}")
38+
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}")
3839
endif()
3940

4041
if(BUILD_DEBUG_POSTFIX_D)
@@ -89,6 +90,7 @@ set(CPP_SOURCE_FILES
8990
src/StyleCollection.cpp
9091
src/UndoCommands.cpp
9192
src/locateNode.cpp
93+
src/PluginsManager.cpp
9294
)
9395

9496
set(HPP_HEADER_FILES
@@ -122,6 +124,8 @@ set(HPP_HEADER_FILES
122124
include/QtNodes/internal/Serializable.hpp
123125
include/QtNodes/internal/Style.hpp
124126
include/QtNodes/internal/StyleCollection.hpp
127+
include/QtNodes/internal/PluginInterface.hpp
128+
include/QtNodes/internal/PluginsManager.hpp
125129
src/ConnectionPainter.hpp
126130
src/DefaultHorizontalNodeGeometry.hpp
127131
src/DefaultVerticalNodeGeometry.hpp
@@ -240,16 +244,13 @@ endif()
240244
# Installation
241245
##
242246

243-
include(GNUInstallDirs)
244-
245247
set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/QtNodes)
246248

247249
install(TARGETS QtNodes
248250
EXPORT QtNodesTargets
249251
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
250252
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
251253
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
252-
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
253254
)
254255

255256
install(DIRECTORY include/

‎examples/CMakeLists.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ add_subdirectory(dynamic_ports)
1616

1717
add_subdirectory(lock_nodes_and_connections)
1818

19+
add_subdirectory(plugins_load)
20+

‎examples/plugins_load/CMakeLists.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
set(CPPS main.cpp)
2+
3+
add_executable(plugins_load ${CPPS})
4+
5+
target_link_libraries(plugins_load QtNodes)
6+
7+
add_subdirectory(plugins/plugin_text)

‎examples/plugins_load/main.cpp‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
#include <QApplication>
2+
#include <QFileDialog>
3+
#include <QMenuBar>
4+
#include <QObject>
5+
#include <QVBoxLayout>
6+
7+
#include <QtNodes/DataFlowGraphModel>
8+
#include <QtNodes/DataFlowGraphicsScene>
9+
#include <QtNodes/GraphicsView>
10+
#include <QtNodes/NodeDelegateModelRegistry>
11+
#include <QtNodes/PluginInterface>
12+
#include <QtNodes/PluginsManager>
13+
14+
using QtNodes::ConnectionStyle;
15+
using QtNodes::DataFlowGraphicsScene;
16+
using QtNodes::DataFlowGraphModel;
17+
using QtNodes::GraphicsView;
18+
using QtNodes::NodeDelegateModelRegistry;
19+
using QtNodes::PluginInterface;
20+
using QtNodes::PluginsManager;
21+
22+
void loadPluginsFromFolder()
23+
{
24+
PluginsManager *pluginsManager = PluginsManager::instance();
25+
std::shared_ptr<NodeDelegateModelRegistry> registry = pluginsManager->registry();
26+
27+
// load plugins
28+
pluginsManager->loadPlugins(QDir::cleanPath(QCoreApplication::applicationDirPath()
29+
+ QDir::separator() + "plugins"),
30+
QStringList() << "*.node"
31+
<< "*.data");
32+
33+
for (auto l : pluginsManager->loaders()) {
34+
PluginInterface *plugin = qobject_cast<PluginInterface *>(l.second->instance());
35+
if (!plugin)
36+
continue;
37+
38+
plugin->registerDataModels(registry);
39+
}
40+
}
41+
42+
int main(int argc, char *argv[])
43+
{
44+
QApplication app(argc, argv);
45+
46+
QWidget mainWidget;
47+
48+
// Load plugins and register models
49+
loadPluginsFromFolder();
50+
51+
QVBoxLayout *l = new QVBoxLayout(&mainWidget);
52+
53+
DataFlowGraphModel dataFlowGraphModel(PluginsManager::instance()->registry());
54+
55+
auto scene = new DataFlowGraphicsScene(dataFlowGraphModel, &mainWidget);
56+
57+
auto view = new GraphicsView(scene);
58+
l->addWidget(view);
59+
l->setContentsMargins(0, 0, 0, 0);
60+
l->setSpacing(0);
61+
62+
QObject::connect(scene, &DataFlowGraphicsScene::sceneLoaded, view, &GraphicsView::centerScene);
63+
64+
mainWidget.setWindowTitle("Data Flow: Plugins Load");
65+
mainWidget.resize(800, 600);
66+
mainWidget.show();
67+
68+
return app.exec();
69+
}

‎examples/plugins_load/plugins/plugin_text/CMakeLists.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
if(MSVC)
2+
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "$<TARGET_FILE_DIR:plugins_load>/plugins")
3+
else()
4+
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "$<TARGET_FILE_DIR:plugins_load>/plugins")
5+
endif()
6+
7+
file(GLOB_RECURSE CPPS ./*.cpp)
8+
file(GLOB_RECURSE HPPS ./*.hpp)
9+
10+
add_library(plugin_text SHARED ${CPPS} ${HPPS})
11+
12+
target_link_libraries(plugin_text QtNodes)
13+
14+
target_compile_definitions(plugin_text PUBLIC NODE_EDITOR_SHARED)
15+
16+
set_target_properties(plugin_text PROPERTIES SUFFIX ".node")

‎examples/plugins_load/plugins/plugin_text/PluginDefinition.cpp‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#include "PluginDefinition.hpp"
2+
3+
#include "TextModel.hpp"
4+
5+
Plugin *Plugin::_this_plugin = nullptr;
6+
7+
Plugin::Plugin()
8+
{
9+
_this_plugin = this;
10+
}
11+
12+
Plugin::~Plugin()
13+
{
14+
// TODO: Unregister all models here
15+
}
16+
17+
void Plugin::registerDataModels(std::shared_ptr<QtNodes::NodeDelegateModelRegistry> &reg)
18+
{
19+
assert(reg);
20+
21+
reg->registerModel<TextModel>();
22+
}

‎examples/plugins_load/plugins/plugin_text/PluginDefinition.hpp‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#pragma once
2+
3+
#include <QObject>
4+
#include <QtNodes/NodeDelegateModelRegistry>
5+
#include <QtNodes/PluginInterface>
6+
7+
// This needs to be the same as the name of your project file ${PROJECT_NAME}
8+
#ifdef plugin_text_EXPORTS
9+
#define DLL_EXPORT Q_DECL_EXPORT
10+
#else
11+
#define DLL_EXPORT Q_DECL_IMPORT
12+
#endif
13+
14+
#define PLUGIN_NAME "Text"
15+
16+
class DLL_EXPORT Plugin
17+
: public QObject
18+
, public QtNodes::PluginInterface
19+
{
20+
Q_OBJECT
21+
Q_INTERFACES(QtNodes::PluginInterface)
22+
Q_PLUGIN_METADATA(IID PLUGIN_NAME)
23+
24+
public:
25+
Plugin();
26+
~Plugin();
27+
28+
QString name() const override { return PLUGIN_NAME; };
29+
30+
void registerDataModels(std::shared_ptr<QtNodes::NodeDelegateModelRegistry> &reg) override;
31+
32+
private:
33+
static Plugin *_this_plugin;
34+
};

‎examples/plugins_load/plugins/plugin_text/TextData.hpp‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#pragma once
2+
3+
#include <QtNodes/NodeData>
4+
5+
using QtNodes::NodeData;
6+
using QtNodes::NodeDataType;
7+
8+
/// The class can potentially incapsulate any user data which
9+
/// need to be transferred within the Node Editor graph
10+
class TextData : public NodeData
11+
{
12+
public:
13+
TextData() {}
14+
15+
TextData(QString const &text)
16+
: _text(text)
17+
{}
18+
19+
NodeDataType type() const override { return NodeDataType{"text", "Text"}; }
20+
21+
QString text() const { return _text; }
22+
23+
private:
24+
QString _text;
25+
};

‎examples/plugins_load/plugins/plugin_text/TextModel.cpp‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
#include "TextModel.hpp"
2+
3+
#include <QtWidgets/QTextEdit>
4+
5+
TextModel::TextModel() {}
6+
7+
unsigned int TextModel::nPorts(PortType portType) const
8+
{
9+
unsigned int result = 1;
10+
11+
switch (portType) {
12+
case PortType::In:
13+
result = 1;
14+
break;
15+
16+
case PortType::Out:
17+
result = 1;
18+
19+
default:
20+
break;
21+
}
22+
23+
return result;
24+
}
25+
26+
void TextModel::onTextEdited()
27+
{
28+
Q_EMIT dataUpdated(0);
29+
}
30+
31+
NodeDataType TextModel::dataType(PortType, PortIndex) const
32+
{
33+
return TextData().type();
34+
}
35+
36+
std::shared_ptr<NodeData> TextModel::outData(PortIndex const portIndex)
37+
{
38+
Q_UNUSED(portIndex);
39+
return std::make_shared<TextData>(_textEdit->toPlainText());
40+
}
41+
42+
QWidget *TextModel::embeddedWidget()
43+
{
44+
if (!_textEdit) {
45+
_textEdit = new QTextEdit();
46+
47+
connect(_textEdit, &QTextEdit::textChanged, this, &TextModel::onTextEdited);
48+
}
49+
50+
return _textEdit;
51+
}
52+
53+
void TextModel::setInData(std::shared_ptr<NodeData> data, PortIndex const)
54+
{
55+
auto textData = std::dynamic_pointer_cast<TextData>(data);
56+
57+
QString inputText;
58+
59+
if (textData) {
60+
inputText = textData->text();
61+
} else {
62+
inputText = "";
63+
}
64+
65+
_textEdit->setText(inputText);
66+
}

‎examples/plugins_load/plugins/plugin_text/TextModel.hpp‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
#pragma once
2+
3+
#include <QtCore/QObject>
4+
5+
#include "TextData.hpp"
6+
7+
#include <QtNodes/NodeDelegateModel>
8+
9+
#include <iostream>
10+
11+
using QtNodes::NodeData;
12+
using QtNodes::NodeDelegateModel;
13+
using QtNodes::PortIndex;
14+
using QtNodes::PortType;
15+
16+
class QTextEdit;
17+
18+
/// The model dictates the number of inputs and outputs for the Node.
19+
/// In this example it has no logic.
20+
class TextModel : public NodeDelegateModel
21+
{
22+
Q_OBJECT
23+
24+
public:
25+
TextModel();
26+
27+
public:
28+
QString caption() const override { return QString("Text"); }
29+
30+
bool captionVisible() const override { return true; }
31+
32+
static QString Name() { return QString("Text"); }
33+
34+
QString name() const override { return TextModel::Name(); }
35+
36+
public:
37+
unsigned int nPorts(PortType portType) const override;
38+
39+
NodeDataType dataType(PortType portType, PortIndex portIndex) const override;
40+
41+
std::shared_ptr<NodeData> outData(PortIndex const portIndex) override;
42+
43+
void setInData(std::shared_ptr<NodeData>, PortIndex const) override;
44+
45+
QWidget *embeddedWidget() override;
46+
47+
bool resizable() const override { return true; }
48+
49+
private Q_SLOTS:
50+
51+
void onTextEdited();
52+
53+
private:
54+
QTextEdit *_textEdit = nullptr;
55+
};

0 commit comments

Comments
 (0)