silvana/implot-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
implot-rs/README.md

70 lines
2.2 KiB
Markdown
Raw Normal View History

Create README.md
2020-07-01 17:41:31 +00:00
# implot-rs
Updated readme, renamed example
2020-08-08 14:01:51 +00:00
Rust bindings for [ImPlot](https://github.com/epezent/implot), built by running
[bindgen](https://github.com/rust-lang/rust-bindgen) on [cimplot](https://github.com/cimgui/cimplot).
Update README.md
2020-07-01 19:50:14 +00:00
Updated readme, renamed example
2020-08-08 14:01:51 +00:00
![demo](demo.png)
Update README.md
2020-07-01 19:50:14 +00:00
Updated readme, renamed example
2020-08-08 14:01:51 +00:00
## Requirements
imgui-rs requires minimum Rust version 1.40, so this project does as well by extension.
Currently the master branch of imgui-rs is used as a dependency until
https://github.com/Gekkio/imgui-rs/pull/339 makes it into a release.
Update README.md
2020-07-01 19:50:14 +00:00
Added axis and plot flag support
2020-08-23 18:10:24 +00:00
The sys crate compiles implot, so a C++ compiler will also be required.
Updated readme, renamed example
2020-08-08 14:01:51 +00:00
Added plot style colors and some misc utils. See comments. - Also exposed the sys crate's ImPlotRange, ImPlotLimits and ImPlotPoint to the user as well as changing the limit-setting interface to using those. I'm not super sure about doing this yet though, because it is more verbose for no real reason to the user and for the purposes of the abstraction it may be better to add facade types anyway. - There is no protection against calling things like `is_hovered` from outside a plot. Will need to think about how to make this impossible by design - we could for example pass an object to Plot's closure that has these methods, and that object is not created anywhere else.
2020-08-23 19:26:27 +00:00
## Design approach
This repo tries to follow the approaches and style used in `imgui-rs` somewhat closely,
because implot is to be used within imgui programs, and hence keeping the interfaces
and design philosophies close should make it easier to do that.
If you spot any design inconsistencies or papercuts, feel free to open an issue.
Updated readme, renamed example
2020-08-08 14:01:51 +00:00
## Status
Currently a work in progress. The author is open to collaboration, if you'd like to
help, feel free to reach out via a Github issue.
Added marker, stylevar and querying support
2020-08-30 09:01:28 +00:00
Note that the API is not stabilized yet and expected to change as development progresses.
Once there are actual releases on crates.io, semantic versioning will be followed.
Updated readme, renamed example
2020-08-08 14:01:51 +00:00
At this point, raw bindings are working in implot-sys, and more idiomatic interfaces
Added plot style colors and some misc utils. See comments. - Also exposed the sys crate's ImPlotRange, ImPlotLimits and ImPlotPoint to the user as well as changing the limit-setting interface to using those. I'm not super sure about doing this yet though, because it is more verbose for no real reason to the user and for the purposes of the abstraction it may be better to add facade types anyway. - There is no protection against calling things like `is_hovered` from outside a plot. Will need to think about how to make this impossible by design - we could for example pass an object to Plot's closure that has these methods, and that object is not created anywhere else.
2020-08-23 19:26:27 +00:00
for plot creation as well a subset of the functionality for plots are implemented.
See below for an overview of the progress.
Added axis and plot flag support
2020-08-23 18:10:24 +00:00
- [x] "BeginPlot"
- [x] Basic hello world
- [x] Plot flags
- [ ] Plotting functionality
Added text plot support
2020-08-23 18:31:28 +00:00
- [x] Line plot
- [x] Text plot
Added axis and plot flag support
2020-08-23 18:10:24 +00:00
- [ ] Scatter plot
- [ ] Bar plot
- [ ] Vertical
- [ ] Horizontal
- [ ] Error bar plot
- [ ] Vertical
- [ ] Horizontal
- [ ] Heatmap
- [ ] Pie chart
- [ ] Digital data
- [ ] Plot customization
Added plot style colors and some misc utils. See comments. - Also exposed the sys crate's ImPlotRange, ImPlotLimits and ImPlotPoint to the user as well as changing the limit-setting interface to using those. I'm not super sure about doing this yet though, because it is more verbose for no real reason to the user and for the purposes of the abstraction it may be better to add facade types anyway. - There is no protection against calling things like `is_hovered` from outside a plot. Will need to think about how to make this impossible by design - we could for example pass an object to Plot's closure that has these methods, and that object is not created anywhere else.
2020-08-23 19:26:27 +00:00
- [x] Axis flags
- [x] Styling colors
Added marker, stylevar and querying support
2020-08-30 09:01:28 +00:00
- [x] Styling variables
Added plot style colors and some misc utils. See comments. - Also exposed the sys crate's ImPlotRange, ImPlotLimits and ImPlotPoint to the user as well as changing the limit-setting interface to using those. I'm not super sure about doing this yet though, because it is more verbose for no real reason to the user and for the purposes of the abstraction it may be better to add facade types anyway. - There is no protection against calling things like `is_hovered` from outside a plot. Will need to think about how to make this impossible by design - we could for example pass an object to Plot's closure that has these methods, and that object is not created anywhere else.
2020-08-23 19:26:27 +00:00
- [ ] Colormaps
Added axis and plot flag support
2020-08-23 18:10:24 +00:00
- [ ] Plot querying
Added plot style colors and some misc utils. See comments. - Also exposed the sys crate's ImPlotRange, ImPlotLimits and ImPlotPoint to the user as well as changing the limit-setting interface to using those. I'm not super sure about doing this yet though, because it is more verbose for no real reason to the user and for the purposes of the abstraction it may be better to add facade types anyway. - There is no protection against calling things like `is_hovered` from outside a plot. Will need to think about how to make this impossible by design - we could for example pass an object to Plot's closure that has these methods, and that object is not created anywhere else.
2020-08-23 19:26:27 +00:00
- [x] is hovered
- [x] mouse position in plot
- [x] plot limits
Added marker, stylevar and querying support
2020-08-30 09:01:28 +00:00
- [x] is queried
- [x] get plot query
- [ ] Choice of y axis
Added axis and plot flag support
2020-08-23 18:10:24 +00:00
- [ ] Utils
- [x] Plot limit setting
Added marker, stylevar and querying support
2020-08-30 09:01:28 +00:00
- [x] imgui-rs style safe push/pop stacks
Added axis and plot flag support
2020-08-23 18:10:24 +00:00
- [ ] Plot tick setting
Added marker, stylevar and querying support
2020-08-30 09:01:28 +00:00
- [ ] Set Y axis setting for subsequent elements
Added plot style colors and some misc utils. See comments. - Also exposed the sys crate's ImPlotRange, ImPlotLimits and ImPlotPoint to the user as well as changing the limit-setting interface to using those. I'm not super sure about doing this yet though, because it is more verbose for no real reason to the user and for the purposes of the abstraction it may be better to add facade types anyway. - There is no protection against calling things like `is_hovered` from outside a plot. Will need to think about how to make this impossible by design - we could for example pass an object to Plot's closure that has these methods, and that object is not created anywhere else.
2020-08-23 19:26:27 +00:00
- [ ] Plot position and size reading
Added axis and plot flag support
2020-08-23 18:10:24 +00:00
- [ ] Pixel to plot position
- [ ] Plot to pixel position
- [ ] Push/pop plotclip rect (?)
Reference in a new issue Copy permalink