hanabi_node_graph 0.1.0

Reusable egui node-graph canvas with caller-owned topology and state
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# 🎆 Hanabi Node Graph

The `hanabi_node_graph` crate provides a generic reusable node graph canvas for [`egui`](https://crates.io/crates/egui), with a
caller-owned topology and persistent view state.

![Screenshot of a node graph with a free node linked to 3 different stacked nodes](./docs/hanabi-node-graph.png)

The crate provides an infinite pan/zoom canvas, nodes and typed ports, spline
links, stack containers, selection and reordering, inline value chips, and
external drop targeting. It does not own an application graph or mutate domain
data.

## Usage

Implement `GraphViewer` to describe the graph, keep a `GraphView` with the
document, and apply the actions returned by `NodeGraph::show`:

```rust
let response = NodeGraph::show(
    ui,
    &mut graph_view,
    &viewer,
    |ui, node_rect, chips| paint_inline_editors(ui, node_rect, chips),
);

for action in response.actions {
    apply_to_your_model(action);
}
```

See the public API documentation for `GraphViewer`, `GraphView`,
`GraphResponse`, and the node/port descriptors.

## Compatibility

| `hanabi_node_graph` | egui | Minimum Rust |
| --- | --- | --- |
| 0.1 | 0.34 | 1.95 |

Versions below 1.0 follow SemVer's pre-1.0 rules: breaking public API changes
increment the minor version.

This crate is developed as part of
[Hanabi Workshop](https://github.com/djeedai/hanabi-workshop).

## License

Licensed under either Apache-2.0 or MIT, at your option.

`SPDX-License-Identifier: MIT OR Apache-2.0`