HexCracker / nodeeditor

README.md

Purpose

NodeEditor is conceived as a general-purpose Qt-based library aimed at graph-controlled data processing. Nodes represent algorithms with certain inputs and outputs. Connections transfer data from the output (source) of the first node to the input (sink) of the second one.

NodeEditor framework is a Visual Dataflow Programming tool. A library client defines models and registers them in the data model registry. Further work is driven by events taking place in DataModels and Nodes. The model computing is triggered upon arriving of any new input data. The computed result is propagated to the output connections. Each new connection fetches available data and propagates is further.

Each change in the source node is immediately propagated through all the connections updating the whole graph.

Platforms

OSX (Apple Clang - LLVM 3.6), Linux (x64, gcc-7.0, clang-7):
Windows (msvc2019/Qt5/Win32, msvc2019/Qt6/x64):

Dependencies

Qt >5.15
CMake 3.8
Catch2

Current state

Model-based nodes
Automatic data propagation
Datatype-aware connections
Embedded Qt widgets
One-output to many-input connections
JSON-based interface styles
Saving scenes to JSON files

Building

Linux

git clone git@github.com:paceholder/nodeeditor.git
cd nodeeditor
mkdir build
cd build
cmake ..
make -j && make install

Qt Creator

Open CMakeLists.txt as project.
If you don't have the Catch2 library installed, go to Build Settings, disable the checkbox BUILD_TESTING.
Build -> Run CMake
Build -> Build All
Click the button Run

>>> Version 3 Roadmap <<<

Headless mode. [done] You can create, populate, modify the derivative of AbsractGraphModel without adding it to the actual Flow Scene. The library is now designed to be general-purpose graph visualization and modification tool, without specialization on only data propagation.
Build data propagation on top of the graph code [done].
- Fix old unit-tests. [in progress].
- Fix save/restore. [in progress].
- Fix CI scriptst on travis and appveyor. [not started].
Backward compatibility with Qt5 [not started/help needed].
Write improved documentation based on Sphynx platform [done].
Extend set of examples [partially done].
Undo Redo [not started].
Python wrappring using PySide [HELP NEEDED].
Implement grouping nodes [not started].
GUI: fix scrolling for scene view window scrolling [need to check Qt6]

Any suggestions are welcome.

Citing

Dmitry Pinaev et al, Qt Node Editor, (2017), GitHub repository, https://github.com/paceholder/nodeeditor

BibTeX

@misc{Pinaev2017,
  author = {Dmitry Pinaev et al},
  title = {Qt5 Node Editor},
  year = {2017},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/paceholder/nodeeditor}},
  commit = {1d1757d09b03cea0e4921bc19659465fe6e65b9b}
}