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

• Label
• Button
• Checkbox
• Radiobutton
• Slider
• Foldable region
• Tooltip
• Movable/resizable windows
  • Kinetic windows
• Scroll areas
• Menu bar (File, Edit, etc)
• One-line TextField
• Color picker
• Style editor

Animations

Add extremely quick animations for some things, maybe 2-3 frames. For instance:

• Animate foldables with clip_rect

Clip rects

• Separate Region::clip_rect from Region::rect
• Use clip rectangles when painting
• Use clip rectangles when interacting

When drawing children, they are drawn just on the edge of the clip rect. This means e.g. the leftmost side of a button or slider handle is clipped. We can fix this in three ways:

• A) Each component minds its bounds, so button offset their position by their outline width + one pixel for AA
• B) Each region enlarges the clip_rect slightly to handle inner children
• C) Each region shrinks its rect slightly so children move further in in child regions (creates unintentional indentation. ugh)

I think A) is the correct solution, but might be tedious to get right for every component. For instance, the outline may grow on mouse-over, but we don't want to move the component as a consequence.

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

• 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 closed windows and foldables. 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.