https://github.com/setzer22/egui_node_graph

Build your node graph applications in Rust, using egui
https://github.com/setzer22/egui_node_graph

Last synced: about 2 months ago
JSON representation

Build your node graph applications in Rust, using egui

• Host: GitHub
• URL: https://github.com/setzer22/egui_node_graph
• Owner: setzer22
• License: mit
• Archived: true
• Created: 2022-02-19T09:20:50.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T06:40:16.000Z (9 months ago)
• Last Synced: 2024-08-10T10:18:48.961Z (4 months ago)
• Language: Rust
• Size: 1.29 MB
• Stars: 714
• Watchers: 14
• Forks: 133
• Open Issues: 39
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-node-based-uis - egui_node_graph - Node applications using egui (Rust Libraries / Renderers)
• awesome-egui - egui node graph

README

        
# Egui Node Graph

> There you have it! Now go build your next awesome node graph thing in Rust 🦀

[![Latest version](https://img.shields.io/crates/v/egui_node_graph.svg)](https://crates.io/crates/egui_node_graph)

[![Documentation](https://docs.rs/egui_node_graph/badge.svg)](https://docs.rs/egui_node_graph)

![MIT](https://img.shields.io/badge/license-MIT-blue.svg)

[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)

**ARCHIVED REPOSITORY** This repository is now archived because of a variety of technical and political reasons that made me loose my motivation to continue contributing to the Rust community in my free time.

![Showcase image](showcase.png)

**Egui node graph** is a featureful, customizable library to create node graph

applications using [egui](https://github.com/emilk/egui). The library takes care

of presenting a node graph to your users, and allows customizing many aspects of

the interaction, creating the semantics you want for your specific application.

## Features and goals

This crate is meant to be a solid base for anyone wanting to expose a node graph

interface to their users. Its main design goal is to be completely agnostic to

the semantics of the graph, be it game logic, audio production, dialog trees,

shader generators... we have you covered!

The purpose of this library is to draw your graphs and handle the common user

interaction, like adding new nodes, moving nodes or creating connections. All

the additional functionality is provided by the user by means of custom user

types implementing several traits.

## Usage

To see a node graph in action, simply clone this repository and launch the

example using `cargo run`. This should open a window with an empty canvas. Right

clicking anywhere on the screen will bring up the *node finder* menu.

The [application code in the example](https://github.com/setzer22/egui_node_graph/blob/main/egui_node_graph_example/src/app.rs)

is thoroughly commented and serves as a good introduction to embedding this

library in your egui project.

## A note on API visibility

Contrary to the general tendency in the Rust ecosytem, this library exposes all

types and fields that may be remotely relevant to a user as public. This is done

with the intent to be as flexible as possible, so no implementation details are

hidden from users who wish to tinker with the internals. Note that this crate

forbids use of `unsafe` so there is no risk of introducing UB by breaking any of

its invariants.

That being said, for the most typical use cases, you will want to stick to the

customization options this crate provides for you: The generic types in the

`GraphEditorState` object and their associated traits are the main API, all of

the other types and fields in this crate should be considered an implementation

detail. The example project contains a detailed explanation of all the

customization options and how are users supposed to interact with this crate.

Finally, this does not change the fact that this crate follows semantic

versioning, as is usual in the Rust ecosystem. Any change to a public field is

still considered breaking.

## Use cases

**Egui node graph** is the library powering the graph user interface of

[Blackjack](https://github.com/setzer22/blackjack), a 3d procedural modelling

software built in Rust using egui, rend3 and wgpu.

![Main interface of blackjack](https://raw.githubusercontent.com/setzer22/blackjack/main/doc/resources/showcase.png)

Are you using this crate for something cool? Add yourself to this section by sending a PR!

## Contributing 

Contributions are welcome! Before writing a PR, please get in touch by filing an issue 😄