Implement feature to toggle between menu and tree UI for item details

Author: okmatija

source/app.jai

@@ -294,8 +294,6 @@ Selected :: #bake_arguments EntitiesIterator(entity_filter=#code !it.is_selected
 
 // :UserConfig hotload changes to this file
 User_Settings :: struct {
-    item_details_uses_menu := true;
-
     item_list_max_size_before_scroll_px := 300.;
     annotation_list_max_size_before_scroll_px := 400.;
 

source/changelog.jai

@@ -12,6 +12,7 @@ PRIZM_VERSION_BACKLOGGED :: Version.{"WIP", "WIP", #string DONE
 * New Feature: Attributes TODO Add a feature flag for enabling this
 
     * Attributes are complementary to annotations but are intended to be dense (every mesh element will have a value) overlays of typed data associated with mesh elements (vertex/face/edge/halfedges...). Currently string, float, Vector3, Matrix3 types are supported. The concept of annotations has been refined to be a sparse overlay of string data attached mesh elements which are addressable via the .obj format e.g., vertices via lines starting with the 'v' directive, and faces via lines starting with the 'f' directive
+    * TODO Implement some checks on the version numbers e.g., no duplicate numbers, no non-monotonic dates
     * TODO Added a new preset shape prism_obj_format_reference.obj which functions as a demo of how the semantic obj comments in Prism will work. This shape is also available via the Preset button.
     * Multiple attributes are supported, and each will have its own tab in the item context menu
     * TODO Added a preset example to demonstrate the new annotation functionality
@@ -33,6 +34,14 @@ PRIZM_VERSION_0_10_0 :: Version.{"0.10.0", "WIP", #string DONE
 * Removed the useless solid color option for triangle rendering, it will be replaced with gbuffer albedo visualization
 DONE};
 
+PRIZM_VERSION_0_9_3 :: Version.{"0.9.3", "17 April 2024", #string DONE
+
+* Clicking with LMB on a "Details" section heading now toggles between the following:
+    1. Displaying section options in a popup menu. This is useful if you want the options is visible only while you're editing them
+    2. Displaying section options inline with the "Details" section. This is useful if you want the options always visible
+* Removed the now unused "File > Preferences > Item List > Item Details Section Uses Menus" which is superceeded by the above feature
+DONE};
+
 PRIZM_VERSION_0_9_2 :: Version.{"0.9.2", "31 March 2024", #string DONE
 
 * Fixed some memory leaks
@@ -657,6 +666,7 @@ DONE
 init_changelog :: () {
     //array_add(*changelog, PRIZM_VERSION_BACKLOGGED);
     //array_add(*changelog, PRIZM_VERSION_0_10_0);
+    array_add(*changelog, PRIZM_VERSION_0_9_3);
     array_add(*changelog, PRIZM_VERSION_0_9_2);
     array_add(*changelog, PRIZM_VERSION_0_9_1);
     array_add(*changelog, PRIZM_VERSION_0_9_0);

source/ui.jai

@@ -1181,7 +1181,6 @@ DONE);
         show_tooltip("Used to handle invalid .obj files:\nInvalid `f` directive references (missing points) use this position\nInvalid point components (inf/nan) get the corresponding component value");
         ImGui.Checkbox(imgui_label(tprint("Disable reload via % when file unchanged", to_string(cast(u32) Special_Key_Code.F5, pad_unmodified=false))), *app.settings.disable_reload_key_if_file_unchanged); // @Volatile Sync with :ReloadItemsKey
         ImGui.Checkbox("Show Header Annotation Tooltips", *app.settings.show_header_annotation_tooltips);
-        ImGui.Checkbox("Item Details Section Uses Menus", *app.settings.item_details_uses_menu);
     }
 
     if ImGui.BeginMenu("Advanced") {
@@ -1227,18 +1226,87 @@ show_details_ui :: () {
     }
 }
 
-begin_item_details_section :: (label : *u8) -> bool {
-    if app.settings.item_details_uses_menu {
-        return ImGui.BeginMenu(label);
+
+Details_Section_Info :: struct {
+    Mode :: enum { NONE; MENU; TREE; }
+    begin_mode : Mode = .MENU;
+    end_mode : Mode = .MENU;
+}
+
+item_details_section_info : Table(*u8, Details_Section_Info);
+
+ConfigureItemDetailsSection :: () #expand {
+    if #complete `section_mode == {
+    case .NONE;
+        // Do nothing
+    case .MENU;
+        // @TODO This does not work, we probably need to call this function before BeginMenu
+        //ImGui.PushStyleColor(xx ImGui.Col.PopupBg, ImGui.GetStyle().Colors[ImGui.Col.WindowBg]);
+    case .TREE;
+        begin_box_section();
+    }
+
+    `defer if #complete `section_mode == {
+    case .NONE;
+        // Do nothing
+    case .MENU;
+        //ImGui.PopStyleColor();
+    case .TREE;
+        end_box_section();
     }
-    return ImGui.TreeNodeEx(label, ImGui.TreeNodeFlags.SpanAvailWidth);
 }
 
-end_item_details_section :: () {
-    if app.settings.item_details_uses_menu {
-        ImGui.EndMenu();
-    } else {
+begin_item_details_section :: (label : *u8) -> bool, Details_Section_Info.Mode {
+    info, newly_added := find_or_add(*item_details_section_info, label);
+
+    if #complete info.begin_mode == {
+    case .NONE;
+
+        // Only expect NONE in for end_mode (when there is no ImGui ending function to call)
+        assert(false);
+
+    case .TREE;
+
+        ImGui.SetNextItemOpen(true);
+        do_tree := ImGui.TreeNodeEx(label, ImGui.TreeNodeFlags.SpanAvailWidth);
+
+        info.end_mode = .TREE; // This frame close the tree
+        if ImGui.IsItemClicked(.Left) {
+            info.begin_mode = .MENU; // Next frame show a menu
+        }
+
+        return do_tree, .TREE;
+
+    case .MENU;
+        do_menu := ImGui.BeginMenu(label);
+
+        info.end_mode = .MENU; // This frame close the menu
+        if ImGui.IsItemClicked(.Left) {
+            info.begin_mode = .TREE; // Next frame show a tree
+        }
+
+        if do_menu {
+        }
+
+        return do_menu, .MENU;
+    }
+
+    assert(false); // Unreachable
+    return false, .NONE;
+}
+
+end_item_details_section :: (label : *u8) {
+    info, newly_added := find_or_add(*item_details_section_info, label);
+
+    if #complete info.end_mode == {
+    case .NONE;
+        // No ending function to call
+
+    case .TREE;
         ImGui.TreePop();
+
+    case .MENU;
+        ImGui.EndMenu();
     }
 }
 
@@ -1302,10 +1370,10 @@ show_details_pane_ui_for_item_selection :: () {
 
 show_item_selection_ui :: () {
 
-    if begin_item_details_section("Selection") {
-        defer end_item_details_section();
-        if !app.settings.item_details_uses_menu begin_box_section();
-        defer if !app.settings.item_details_uses_menu end_box_section();
+    do_section, section_mode := begin_item_details_section("Selection");
+    if do_section {
+        defer end_item_details_section("Selection");
+        ConfigureItemDetailsSection();
 
         for :Selected entity : app.entities {
 
@@ -2221,10 +2289,12 @@ display_info_ui :: (display_info : *Display_Info, aabb : AxisBox3, entity_index
 }
 
 display_information :: (entity : *Entity) {
-    if  begin_item_details_section("Information") {
-        defer end_item_details_section();
+
+    do_section, section_mode := begin_item_details_section("Information");
+    if do_section {
+        defer end_item_details_section("Information");
         table_flags : ImGui.TableFlags;
-        if !app.settings.item_details_uses_menu table_flags |= .BordersOuter;
+        if section_mode == .TREE table_flags |= .BordersOuter;
 
         ImGui.BeginTable("##InformationTable", 2, flags=table_flags);
         defer ImGui.EndTable();
@@ -2262,10 +2332,10 @@ display_information :: (entity : *Entity) {
 }
 
 display_transform :: (entity : *Entity) {
-    if  begin_item_details_section("Transform") {
-        defer end_item_details_section();
-        if !app.settings.item_details_uses_menu begin_box_section();
-        defer if !app.settings.item_details_uses_menu end_box_section();
+    do_section, section_mode := begin_item_details_section("Transform");
+    if do_section {
+        defer end_item_details_section("Transform");
+        ConfigureItemDetailsSection();
 
         ImGui.TableNextColumn();
 
@@ -2537,16 +2607,16 @@ show_rendering_triangles_ui :: (display_info : *Display_Info, entity_index : int
     if valid_geometry_index(entity_index) && app.entities[entity_index].mesh.triangles.count == 0 {
         ImGui.BeginDisabled();
         if  begin_item_details_section("Triangles (none)") {
-            defer end_item_details_section();
+            defer end_item_details_section("Triangles (none)");
         }
         ImGui.EndDisabled();
         return;
     }
 
-    if  begin_item_details_section("Triangles") {
-        defer end_item_details_section();
-        if !app.settings.item_details_uses_menu begin_box_section();
-        defer if !app.settings.item_details_uses_menu end_box_section();
+    do_section, section_mode := begin_item_details_section("Triangles");
+    if do_section {
+        defer end_item_details_section("Triangles");
+        ConfigureItemDetailsSection();
 
         ImGui.TableNextColumn();
         ImGui.Text(
@@ -2613,16 +2683,16 @@ show_rendering_segments_ui :: (display_info : *Display_Info, entity_index : int
     if valid_geometry_index(entity_index) && app.entities[entity_index].mesh.segments.count == 0 {
         ImGui.BeginDisabled();
         if  begin_item_details_section("Segments (none)") {
-            defer end_item_details_section();
+            defer end_item_details_section("Segments (none)");
         }
         ImGui.EndDisabled();
         return;
     }
 
-    if  begin_item_details_section("Segments") {
-        defer end_item_details_section();
-        if !app.settings.item_details_uses_menu begin_box_section();
-        defer if !app.settings.item_details_uses_menu end_box_section();
+    do_section, section_mode := begin_item_details_section("Segments");
+    if do_section {
+        defer end_item_details_section("Segments");
+        ConfigureItemDetailsSection();
 
         ImGui.TableNextColumn();
         ImGui.Text(
@@ -2656,16 +2726,16 @@ show_rendering_points_ui :: (display_info : *Display_Info, entity_index : int =
     if valid_geometry_index(entity_index) && app.entities[entity_index].mesh.points.count == 0 {
         ImGui.BeginDisabled();
         if  begin_item_details_section("Points (none)") {
-            defer end_item_details_section();
+            defer end_item_details_section("Points (none)");
         }
         ImGui.EndDisabled();
         return;
     }
 
-    if  begin_item_details_section("Points") {
-        defer end_item_details_section();
-        if !app.settings.item_details_uses_menu begin_box_section();
-        defer if !app.settings.item_details_uses_menu end_box_section();
+    do_section, section_mode := begin_item_details_section("Points");
+    if do_section {
+        defer end_item_details_section("Points");
+        ConfigureItemDetailsSection();
 
         ImGui.TableNextColumn();
         ImGui.Text(
@@ -2700,16 +2770,16 @@ show_rendering_positions_ui :: (display_info : *Display_Info, entity_index : int
     if valid_geometry_index(entity_index) && app.entities[entity_index].mesh.positions.count == 0 {
         ImGui.BeginDisabled();
         if begin_item_details_section("Vertices (none)") {
-            defer end_item_details_section();
+            defer end_item_details_section("Vertices (none)");
         }
         ImGui.EndDisabled();
         return;
     }
 
-    if  begin_item_details_section("Vertices") {
-        defer end_item_details_section();
-        if !app.settings.item_details_uses_menu begin_box_section();
-        defer if !app.settings.item_details_uses_menu end_box_section();
+    do_section, section_mode := begin_item_details_section("Vertices");
+    if do_section {
+        defer end_item_details_section("Vertices");
+        ConfigureItemDetailsSection();
 
         ImGui.TableNextColumn();
         ImGui.Text(
@@ -2751,10 +2821,12 @@ show_rendering_positions_ui :: (display_info : *Display_Info, entity_index : int
 
 show_clipping_ui :: (using display_info : *Display_Info, aabb : AxisBox3) {
 
-    if begin_item_details_section("Clipping") {
-        defer end_item_details_section();
+    do_section, section_mode := begin_item_details_section("Clipping");
+    if do_section {
+        defer end_item_details_section("Clipping");
+
         table_flags : ImGui.TableFlags;
-        if !app.settings.item_details_uses_menu {
+        if section_mode == .TREE {
             table_flags |= .BordersOuter; // | .RowBg; // .SizingFixedFit
         }
 

source/ui_utils.jai

@@ -73,8 +73,8 @@ imgui_label2 :: (label : string, ptr : *void = null) -> string {
     return tprint("%##%", label, ptr);
 }
 
-begin_box_section :: () {
-    table_flags := ImGui.TableFlags.BordersOuter;
+begin_box_section :: (extra_flags := ImGui.TableFlags.None) {
+    table_flags := ImGui.TableFlags.BordersOuter | extra_flags;
         // .NoHostExtendX; // Can be useful
     ImGui.BeginTable("", 1, flags=table_flags);
 }