imgui-node-editor Documentation

File: docs/README.md Copy Chapter

Node Editor in ImGui

About Copy Chapter

An implementation of node editor with ImGui-like API.

Project purpose is to serve as a basis for more complex solutions like blueprint editors.

Node Editor is build around an idea "draw your content, we do the rest", which mean interactions are handled by editor, content rendering is handled by user. Editor will take care of:

• placing your node in the word
• dragging nodes
• zoom and scrolling
• selection
• various interaction that can be queried by API (creation, deletion, selection changes, etc.)

Here are some highlights:

• Node movement and selection is handled internally

• Node and pin contents are fully customizable

• Fully styled, default theme is modeled after UE4 blueprints

  • Flexible enough to produce such nodes:

  • Customizable links based on Bézier curves:

• Automatic highlights for nodes, pins and links:

• Smooth navigation and selection

• Node state can be saved in user context, so layout will not break

• Selection rectangles and group dragging

• Context menu support

• Basic shortcuts support (cut/copy/paste/delete)

• ImGui style API

Editor is used to implement blueprint editor in Spark CE engine, it proved itself there by allowing to do everything we needed. Therefore it is now slowly moving into stable state from beeing a prototype.

Note: Project recently was restructured to mimic ImGui layout.

Please report issues or questions if something isn't clear.

Dependencies Copy Chapter

• Vanilla ImGui 1.72+
• C++14

Dependencies for examples: Copy Section

• https://github.com/thedmd/imgui/tree/feature/layout (used in blueprints sample only)

Optional extension you can pull into your local copy of ImGui node editor can take advantage of: Copy Section

• https://github.com/thedmd/imgui/tree/feature/draw-list-fringe-scale (for sharp rendering, while zooming) It is part of ImGui since 1.80 release
• https://github.com/thedmd/imgui/tree/feature/extra-keys (for extra shortcuts)

Building / Installing Copy Chapter

Node Editor sources are located in root project directory. To use it, simply copy&paste sources into your project. Exactly like you can do with ImGui.

Examples Copy Section

Examples can be build with CMake:

Windows:
    cmake -S examples -B build -G "Visual Studio 15 2017 Win64"
      or
    cmake -S examples -B build -G "Visual Studio 16 2019" -A x64

macOS:
    cmake -S examples -B build -G "Xcode"

Linux:
    cmake -S examples -B build -G "Unix Makefiles"

Build:
    cmake --build build --config Release

Executables will be located in build\bin directory.

Quick Start Copy Section

Main node editor header is located in imgui_node_editor.h.

Minimal example of one node can be found in simple-example.cpp.
Press 'F' in editor to focus on editor content if you see only grid.

# include 
# include 
# include <application.h>

namespace ed = ax::NodeEditor;

struct Example:
    public Application
{
    using Application::Application;

    void OnStart() override
    {
        ed::Config config;
        config.SettingsFile = "Simple.json";
        m_Context = ed::CreateEditor(&config);
    }

    void OnStop() override
    {
        ed::DestroyEditor(m_Context);
    }

    void OnFrame(float deltaTime) override
    {
        auto& io = ImGui::GetIO();

        ImGui::Text("FPS: %.2f (%.2gms)", io.Framerate, io.Framerate ? 1000.0f / io.Framerate : 0.0f);

        ImGui::Separator();

        ed::SetCurrentEditor(m_Context);
        ed::Begin("My Editor", ImVec2(0.0, 0.0f));
        int uniqueId = 1;
        // Start drawing nodes.
        ed::BeginNode(uniqueId++);
            ImGui::Text("Node A");
            ed::BeginPin(uniqueId++, ed::PinKind::Input);
                ImGui::Text("-> In");
            ed::EndPin();
            ImGui::SameLine();
            ed::BeginPin(uniqueId++, ed::PinKind::Output);
                ImGui::Text("Out ->");
            ed::EndPin();
        ed::EndNode();
        ed::End();
        ed::SetCurrentEditor(nullptr);

        //ImGui::ShowMetricsWindow();
    }

    ed::EditorContext* m_Context = nullptr;
};

int Main(int argc, char** argv)
{
    Example exampe("Simple", argc, argv);

    if (exampe.Create())
        return exampe.Run();

    return 0;
}

Result:

For more details please visit examples folder.

Blueprints Example Copy Section

Here is Node Editor at work in Spark CE Copy Section

File: docs/TODO.md Copy Chapter

In random order:

• Documentation: Make one

Done:

• ImGui: Factor out changes to ImGui to use vanilla version.
• Editor: Fix variable naming (mainly add m_ prefix)
• Editor: Split NodeEditorImpl.cpp to multiple files, file has grown too big.
• Editor: Factor out use of picojson.h
• Editor: Move use of <optional> to optional code extensions

#57 - join ax::NodeEditor::EditorContext with struct EditorContext and remove reinterpret_cast<>