egui/emigui/README.md

# GUI implementation
This is the core library crate Emigui. It is fully platform independent without any backend. You give the Emigui library input each frame (mouse pos etc), and it outputs a triangle mesh for you to paint.

## TODO:
### Widgets
* [x] Label
* [x] Button
* [x] Checkbox
* [x] Radiobutton
* [x] Horizontal slider
* [ ] Vertical slider
* [x] Collapsing header region
* [x] Tooltip
* [x] Movable/resizable windows
    * [ ] Kinetic windows
* [ ] Scroll areas
    * [x] Vertical scrolling
    * [ ] Horizontal scrolling
    * [ ] Scroll-wheel input
    * [x] Drag background to scroll
    * [ ] Kinetic scrolling
* [ ] Menu bar (File, Edit, etc)
* [ ] One-line TextField
    * [ ] Clipboard copy/paste
* [ ] Color picker
* [ ] Style editor

### Animations
Add extremely quick animations for some things, maybe 2-3 frames. For instance:
* [x] Animate collapsing headers with clip_rect

### Clip rects
* [x] Separate Region::clip_rect from Region::rect
* [x] Use clip rectangles when painting
* [ ] Use clip rectangles when interacting
* [x] Adjust clip rects so edges of child widgets aren't clipped

### Other
* [ ] Generalize Layout so we can create grid layouts etc
* [ ] Persist UI state in external storage
* [ ] Build in a profiler which tracks which region in which window takes up CPU.
    * [ ] Draw as flame graph
    * [ ] Draw as hotmap

### Names and structure
* [ ] Rename things to be more consistent with Dear ImGui
* [ ] Combine Emigui and Context
* [ ] Rename Region to something shorter?
    * `region: &Region` `region.add(...)` :/
    * `gui: &Gui` `gui.add(...)` :)
    * `ui: &Ui` `ui.add(...)` :)

### Global widget search
Ability to do a search for any widget. The search works even for collapsed regions and closed windows and menus. This is implemented like this: while searching, all region are layed out and their add_content functions are run. If none of the contents matches the search, the layout is reverted and nothing is shown. So windows will get temporarily opened and run, but if the search is not a match in the window it is closed again. This means then when searching your whole GUI is being run, which may be a bit slower, but it would be a really awesome feature.
Remove roadmap and replace with emigui/README.md with a TODO section 2020-04-19 09:15:35 +00:00			`# GUI implementation`
			`This is the core library crate Emigui. It is fully platform independent without any backend. You give the Emigui library input each frame (mouse pos etc), and it outputs a triangle mesh for you to paint.`

			`## TODO:`
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00			`### Widgets`
Some visual tweaks 2020-04-21 14:50:56 +00:00			`* [x] Label`
			`* [x] Button`
			`* [x] Checkbox`
			`* [x] Radiobutton`
Expand clip_rects slightly to allow widgets just on the border 2020-04-22 17:40:22 +00:00			`* [x] Horizontal slider`
			`* [ ] Vertical slider`
Rename foldable to CollapsingHeader and move to own file 2020-04-22 16:15:27 +00:00			`* [x] Collapsing header region`
Some visual tweaks 2020-04-21 14:50:56 +00:00			`* [x] Tooltip`
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00			`* [x] Movable/resizable windows`
			`* [ ] Kinetic windows`
			`* [ ] Scroll areas`
Drag scroll area background to scroll 2020-04-22 15:38:36 +00:00			`* [x] Vertical scrolling`
			`* [ ] Horizontal scrolling`
			`* [ ] Scroll-wheel input`
			`* [x] Drag background to scroll`
			`* [ ] Kinetic scrolling`
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00			`* [ ] Menu bar (File, Edit, etc)`
			`* [ ] One-line TextField`
Drag scroll area background to scroll 2020-04-22 15:38:36 +00:00			`* [ ] Clipboard copy/paste`
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00			`* [ ] Color picker`
			`* [ ] Style editor`

			`### Animations`
			`Add extremely quick animations for some things, maybe 2-3 frames. For instance:`
Rename foldable to CollapsingHeader and move to own file 2020-04-22 16:15:27 +00:00			`* [x] Animate collapsing headers with clip_rect`
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00
			`### Clip rects`
			`* [x] Separate Region::clip_rect from Region::rect`
			`* [x] Use clip rectangles when painting`
			`* [ ] Use clip rectangles when interacting`
Expand clip_rects slightly to allow widgets just on the border 2020-04-22 17:40:22 +00:00			`* [x] Adjust clip rects so edges of child widgets aren't clipped`
Some visual tweaks 2020-04-21 14:50:56 +00:00
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00			`### Other`
Some visual tweaks 2020-04-21 14:50:56 +00:00			`* [ ] Generalize Layout so we can create grid layouts etc`
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00			`* [ ] Persist UI state in external storage`
			`* [ ] Build in a profiler which tracks which region in which window takes up CPU.`
			`* [ ] Draw as flame graph`
			`* [ ] Draw as hotmap`

			`### Names and structure`
Drag scroll area background to scroll 2020-04-22 15:38:36 +00:00			`* [ ] Rename things to be more consistent with Dear ImGui`
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00			`* [ ] Combine Emigui and Context`
			`* [ ] Rename Region to something shorter?`
Remove roadmap and replace with emigui/README.md with a TODO section 2020-04-19 09:15:35 +00:00			* `region: &Region` `region.add(...)` :/
			* `gui: &Gui` `gui.add(...)` :)
			* `ui: &Ui` `ui.add(...)` :)
Add a bunch of TODOs 2020-04-21 08:27:53 +00:00
			`### Global widget search`
Rename foldable to CollapsingHeader and move to own file 2020-04-22 16:15:27 +00:00			Ability to do a search for any widget. The search works even for collapsed regions and closed windows and menus. This is implemented like this: while searching, all region are layed out and their add_content functions are run. If none of the contents matches the search, the layout is reverted and nothing is shown. So windows will get temporarily opened and run, but if the search is not a match in the window it is closed again. This means then when searching your whole GUI is being run, which may be a bit slower, but it would be a really awesome feature.