Skip to content

Commit 801e7b6

Browse files
thedmdpthom
authored andcommitted
thedmd: Stack Layout implementation v2.1 / pthom: revert clipping
See ocornut#846 (comment) : clipping has an issue, when mixed with your node editor and springs.
1 parent 314a601 commit 801e7b6

File tree

7 files changed

+1401
-4
lines changed

7 files changed

+1401
-4
lines changed

imgui.cpp

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1334,6 +1334,7 @@ ImGuiStyle::ImGuiStyle()
13341334
ScrollbarRounding = 9.0f; // Radius of grab corners rounding for scrollbar
13351335
GrabMinSize = 12.0f; // Minimum width/height of a grab box for slider/scrollbar
13361336
GrabRounding = 0.0f; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
1337+
LayoutAlign = 0.5f; // Element alignment inside horizontal and vertical layouts (0.0f - left/top, 1.0f - right/bottom, 0.5f - center).
13371338
LogSliderDeadzone = 4.0f; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
13381339
TabRounding = 4.0f; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
13391340
TabBorderSize = 0.0f; // Thickness of border around tabs.
@@ -3437,6 +3438,7 @@ static const ImGuiDataVarInfo GStyleVarInfo[] =
34373438
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, ScrollbarRounding) }, // ImGuiStyleVar_ScrollbarRounding
34383439
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, GrabMinSize) }, // ImGuiStyleVar_GrabMinSize
34393440
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, GrabRounding) }, // ImGuiStyleVar_GrabRounding
3441+
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, LayoutAlign) }, // ImGuiStyleVar_LayoutAlign
34403442
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, TabRounding) }, // ImGuiStyleVar_TabRounding
34413443
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, TabBorderSize) }, // ImGuiStyleVar_TabBorderSize
34423444
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, TabBarBorderSize) }, // ImGuiStyleVar_TabBarBorderSize
@@ -11633,6 +11635,10 @@ bool ImGui::ItemAdd(const ImRect& bb, ImGuiID id, const ImRect* nav_bb_arg, ImGu
1163311635
g.NextItemData.HasFlags = ImGuiNextItemDataFlags_None;
1163411636
g.NextItemData.ItemFlags = ImGuiItemFlags_None;
1163511637

11638+
#if IMGUI_HAS_STACK_LAYOUT
11639+
ImGuiInternal::UpdateItemRect(window->ID, bb.Min, bb.Max);
11640+
#endif
11641+
1163611642
#ifdef IMGUI_ENABLE_TEST_ENGINE
1163711643
if (id != 0)
1163811644
IMGUI_TEST_ENGINE_ITEM_ADD(id, g.LastItemData.NavRect, &g.LastItemData);
@@ -11714,6 +11720,38 @@ void ImGui::ItemSize(const ImVec2& size, float text_baseline_y)
1171411720
if (window->SkipItems)
1171511721
return;
1171611722

11723+
#if IMGUI_HAS_STACK_LAYOUT
11724+
ImGuiLayoutType layout_type = ImGuiInternal::GetCurrentLayoutType(window->ID);
11725+
#else
11726+
ImGuiLayoutType layout_type = window->DC.LayoutType;
11727+
#endif
11728+
11729+
//if (g.IO.KeyAlt) window->DrawList->AddCircle(window->DC.CursorPos, 3.0f, IM_COL32(255,255,0,255), 4); // [DEBUG] Widget position
11730+
11731+
// Stack Layouts: Handle horizontal case first to simplify merge in case code handling vertical changes.
11732+
if (layout_type == ImGuiLayoutType_Horizontal)
11733+
{
11734+
const float line_width = ImMax(window->DC.CurrLineSize.x, size.x);
11735+
11736+
// Always align ourselves on pixel boundaries
11737+
//if (g.IO.KeyAlt) window->DrawList->AddRect(window->DC.CursorPos, window->DC.CursorPos + ImVec2(size.x, line_height), IM_COL32(255,0,0,200)); // [DEBUG]
11738+
window->DC.CursorPosPrevLine.x = window->DC.CursorPos.x;
11739+
window->DC.CursorPosPrevLine.y = window->DC.CursorPos.y + size.y;
11740+
window->DC.CursorPos.x = IM_TRUNC(window->DC.CursorPos.x + line_width + g.Style.ItemSpacing.x);
11741+
window->DC.CursorPos.y = IM_TRUNC(window->DC.CursorPosPrevLine.y - size.y);
11742+
window->DC.CursorMaxPos.x = ImMax(window->DC.CursorMaxPos.x, window->DC.CursorPos.x - g.Style.ItemSpacing.x);
11743+
window->DC.CursorMaxPos.y = ImMax(window->DC.CursorMaxPos.y, window->DC.CursorPosPrevLine.y);
11744+
//if (g.IO.KeyAlt) window->DrawList->AddCircle(window->DC.CursorMaxPos, 3.0f, IM_COL32(255,0,0,255), 4); // [DEBUG]
11745+
11746+
window->DC.PrevLineSize.x = line_width;
11747+
window->DC.PrevLineSize.y = 0.0f;
11748+
window->DC.CurrLineSize.x = 0.0f;
11749+
window->DC.PrevLineTextBaseOffset = ImMax(window->DC.CurrLineTextBaseOffset, text_baseline_y);
11750+
window->DC.CurrLineTextBaseOffset = window->DC.PrevLineTextBaseOffset;
11751+
window->DC.IsSameLine = window->DC.IsSetPos = false;
11752+
return;
11753+
}
11754+
1171711755
// We increase the height in this function to accommodate for baseline offset.
1171811756
// In theory we should be offsetting the starting position (window->DC.CursorPos), that will be the topic of a larger refactor,
1171911757
// but since ItemSize() is not yet an API that moves the cursor (to handle e.g. wrapping) enlarging the height has the same effect.
@@ -11732,15 +11770,12 @@ void ImGui::ItemSize(const ImVec2& size, float text_baseline_y)
1173211770
window->DC.CursorMaxPos.y = ImMax(window->DC.CursorMaxPos.y, window->DC.CursorPos.y - g.Style.ItemSpacing.y);
1173311771
//if (g.IO.KeyAlt) window->DrawList->AddCircle(window->DC.CursorMaxPos, 3.0f, IM_COL32(255,0,0,255), 4); // [DEBUG]
1173411772

11773+
window->DC.PrevLineSize.x = 0.0f;
1173511774
window->DC.PrevLineSize.y = line_height;
1173611775
window->DC.CurrLineSize.y = 0.0f;
1173711776
window->DC.PrevLineTextBaseOffset = ImMax(window->DC.CurrLineTextBaseOffset, text_baseline_y);
1173811777
window->DC.CurrLineTextBaseOffset = 0.0f;
1173911778
window->DC.IsSameLine = window->DC.IsSetPos = false;
11740-
11741-
// Horizontal layout mode
11742-
if (window->DC.LayoutType == ImGuiLayoutType_Horizontal)
11743-
SameLine();
1174411779
}
1174511780
IM_MSVC_RUNTIME_CHECKS_RESTORE
1174611781

imgui.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
#define IMGUI_HAS_TABLE
3434
#define IMGUI_HAS_VIEWPORT // Viewport WIP branch
3535
#define IMGUI_HAS_DOCK // Docking WIP branch
36+
#define IMGUI_HAS_STACK_LAYOUT 1 // Stack-Layout PR #846
3637

3738
//
3839
// Adaptations for ImGui Bundle are noted with [ADAPT_IMGUI_BUNDLE]
@@ -1864,6 +1865,7 @@ enum ImGuiStyleVar_
18641865
ImGuiStyleVar_ScrollbarRounding, // float ScrollbarRounding
18651866
ImGuiStyleVar_GrabMinSize, // float GrabMinSize
18661867
ImGuiStyleVar_GrabRounding, // float GrabRounding
1868+
ImGuiStyleVar_LayoutAlign, // float LayoutAlign
18671869
ImGuiStyleVar_TabRounding, // float TabRounding
18681870
ImGuiStyleVar_TabBorderSize, // float TabBorderSize
18691871
ImGuiStyleVar_TabBarBorderSize, // float TabBarBorderSize
@@ -2346,6 +2348,7 @@ struct ImGuiStyle
23462348
float ScrollbarRounding; // Radius of grab corners for scrollbar.
23472349
float GrabMinSize; // Minimum width/height of a grab box for slider/scrollbar.
23482350
float GrabRounding; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
2351+
float LayoutAlign; // Element alignment inside horizontal and vertical layouts (0.0f - left/top, 1.0f - right/bottom, 0.5f - center).
23492352
float LogSliderDeadzone; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
23502353
float TabRounding; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
23512354
float TabBorderSize; // Thickness of border around tabs.
@@ -4162,6 +4165,10 @@ namespace ImGui
41624165
#pragma warning (pop)
41634166
#endif
41644167

4168+
#if IMGUI_HAS_STACK_LAYOUT
4169+
#include "imgui_stacklayout.h"
4170+
#endif
4171+
41654172
// Include imgui_user.h at the end of imgui.h
41664173
// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included.
41674174
#ifdef IMGUI_INCLUDE_IMGUI_USER_H

imgui_demo.cpp

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4877,6 +4877,156 @@ static void ShowDemoWindowLayout()
48774877

48784878
ImGui::TreePop();
48794879
}
4880+
4881+
#if IMGUI_HAS_STACK_LAYOUT
4882+
IMGUI_DEMO_MARKER("Layout/Stack Layout");
4883+
if (ImGui::TreeNode("Stack Layout"))
4884+
{
4885+
static bool widget_a = true, widget_b = true, widget_c = true;
4886+
static bool spring_a = true, spring_ab = true, spring_bc = true, spring_c = true;
4887+
static bool minimize_width = false, minimize_height = true;
4888+
static bool horizontal = true, draw_springs = true;
4889+
static ImVec2 item_spacing = ImGui::GetStyle().ItemSpacing;
4890+
static float a_c_spring_weight = 0.0f;
4891+
static float ab_spring_weight = 0.5f;
4892+
static float alignment = 0.5f;
4893+
4894+
struct funcs
4895+
{
4896+
static void VisibleSpring(float spring_weight)
4897+
{
4898+
ImGui::Spring(spring_weight);
4899+
if (!draw_springs)
4900+
return;
4901+
4902+
ImVec2 rect_min = ImGui::GetItemRectMin();
4903+
ImVec2 rect_max = ImGui::GetItemRectMax();
4904+
4905+
ImVec2 rect_size = ImGui::GetItemRectSize();
4906+
if (rect_size.x <= 0.0f && rect_size.y <= 0.0f)
4907+
return;
4908+
4909+
// Draw zig-zag
4910+
float width = 0.0f, spacing = 0.0f;
4911+
ImVec2 direction, origin;
4912+
ImVec2 spacing_min, spring_max;
4913+
4914+
if (horizontal)
4915+
{
4916+
spacing = floorf(item_spacing.x);
4917+
width = rect_size.x - spacing;
4918+
origin = ImVec2(floorf(rect_min.x), floorf(rect_min.y + (rect_max.y - rect_min.y) / 2));
4919+
direction = ImVec2(1.0f, 0.0f);
4920+
spring_max = ImVec2(rect_min.x + width, rect_max.y);
4921+
spacing_min = ImVec2(rect_min.x + width, rect_min.y);
4922+
}
4923+
else
4924+
{
4925+
spacing = floorf(item_spacing.y);
4926+
width = rect_size.y - spacing;
4927+
origin = ImVec2(floorf(rect_min.x + (rect_max.x - rect_min.x) / 2), floorf(rect_min.y));
4928+
direction = ImVec2(0.0f, 1.0f);
4929+
spring_max = ImVec2(rect_max.x, rect_min.y + width);
4930+
spacing_min = ImVec2(rect_min.x, rect_min.y + width);
4931+
}
4932+
4933+
if (spring_weight <= 0.0f && spacing <= 0.0f)
4934+
return;
4935+
4936+
ImDrawList* draw_list = ImGui::GetWindowDrawList();
4937+
4938+
draw_list->PushClipRect(rect_min, rect_max, true);
4939+
4940+
draw_list->AddRectFilled(rect_min, spring_max, ImColor(80, 20, 80));
4941+
draw_list->AddRectFilled(spacing_min, rect_max, ImColor(80, 20, 20));
4942+
4943+
const float zig_zag_size = 3;
4944+
ImVec2 normal = ImVec2(-direction.y, direction.x);
4945+
4946+
draw_list->PathClear();
4947+
origin.x += 0.5f;
4948+
origin.y += 0.5f;
4949+
draw_list->PathLineTo(origin);
4950+
for (float x = zig_zag_size * 0.5f; x <= width; x += zig_zag_size)
4951+
{
4952+
ImVec2 p;
4953+
p.x = origin.x + direction.x * x + normal.x * zig_zag_size;
4954+
p.y = origin.y + direction.y * x + normal.y * zig_zag_size;
4955+
draw_list->PathLineTo(p);
4956+
normal = ImVec2(-normal.x, -normal.y);
4957+
}
4958+
draw_list->PathStroke(ImColor(255, 255, 255, 190), false, 1.0f);
4959+
4960+
draw_list->PopClipRect();
4961+
}
4962+
};
4963+
4964+
ImGui::Checkbox("Widget A", &widget_a); ImGui::SameLine();
4965+
ImGui::Checkbox("Widget B", &widget_b); ImGui::SameLine();
4966+
ImGui::Checkbox("Widget C", &widget_c);
4967+
ImGui::Checkbox("Spring A", &spring_a); ImGui::SameLine();
4968+
ImGui::Checkbox("Spring AB", &spring_ab); ImGui::SameLine();
4969+
ImGui::Checkbox("Spring BC", &spring_bc); ImGui::SameLine();
4970+
ImGui::Checkbox("Spring C", &spring_c);
4971+
ImGui::Checkbox("Horizontal", &horizontal); ImGui::SameLine();
4972+
ImGui::Checkbox("Minimize Width", &minimize_width); ImGui::SameLine();
4973+
ImGui::Checkbox("Minimize Height", &minimize_height);
4974+
ImGui::Checkbox("Draw Springs", &draw_springs); ImGui::SameLine();
4975+
ImGui::TextUnformatted(" "); ImGui::SameLine();
4976+
ImGui::ColorButton("- Spring", ImColor(80, 20, 80), ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoPicker); ImGui::SameLine();
4977+
ImGui::TextUnformatted("Spring"); ImGui::SameLine();
4978+
ImGui::TextUnformatted(" "); ImGui::SameLine();
4979+
ImGui::ColorButton("- Spacing", ImColor(80, 20, 20), ImGuiColorEditFlags_NoTooltip | ImGuiColorEditFlags_NoPicker); ImGui::SameLine();
4980+
ImGui::TextUnformatted("Item Spacing");
4981+
ImGui::DragFloat("Item Spacing", horizontal ? &item_spacing.x : &item_spacing.y, 0.1f, 0.0f, 50.0f);
4982+
ImGui::DragFloat("A & C Spring Weight", &a_c_spring_weight, 0.002f, 0.0f, 1.0f);
4983+
ImGui::DragFloat("AB Spring Weight", &ab_spring_weight, 0.002f, 0.0f, 1.0f);
4984+
if (ImGui::IsItemHovered()) ImGui::SetTooltip("BC Spring Weight = 1 - AB Spring Weight");
4985+
ImGui::DragFloat("Minor Axis Alignment", &alignment, 0.002f, 0.0f, 1.0f);
4986+
if (ImGui::IsItemHovered()) ImGui::SetTooltip("This is vertical alignment for horizontal layouts and horizontal alignment for vertical layouts.");
4987+
ImGui::Text("Layout widgets:");
4988+
ImGui::Text("| Spring A | Widget A | Spring AB | Widget B | Spring BC | Widget C | Spring C |");
4989+
4990+
ImGui::Spacing();
4991+
4992+
ImVec2 widget_size;
4993+
widget_size.x = floorf(ImGui::GetContentRegionAvail().x / 4);
4994+
widget_size.y = horizontal ? floorf(widget_size.x / 3) : widget_size.x;
4995+
4996+
ImVec2 small_widget_size = widget_size;
4997+
if (horizontal)
4998+
small_widget_size.y = floorf(small_widget_size.y / 2);
4999+
else
5000+
small_widget_size.x = floorf(small_widget_size.x / 2);
5001+
5002+
ImVec2 layout_size = ImVec2(widget_size.x * 4, widget_size.y * 4);
5003+
if (minimize_width) layout_size.x = 0.0f;
5004+
if (minimize_height) layout_size.y = 0.0f;
5005+
5006+
// Minor axis alignment can be set by style or directly in BeginHorizontal/BeginVertical
5007+
// Example:
5008+
// ImGui::PushStyleVar(ImGuiStyleVar_LayoutAlign, alignment);
5009+
5010+
ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(floorf(item_spacing.x), floorf(item_spacing.y)));
5011+
5012+
if (horizontal) { ImGui::BeginHorizontal("h1", layout_size, alignment); } else { ImGui::BeginVertical("v1", layout_size, alignment); }
5013+
if (spring_a) { funcs::VisibleSpring(a_c_spring_weight); }
5014+
if (widget_a) { ImGui::Button("Widget A", widget_size); }
5015+
if (spring_ab) { funcs::VisibleSpring(ab_spring_weight); }
5016+
if (widget_b) { ImGui::Button("Widget B", small_widget_size); }
5017+
if (spring_bc) { funcs::VisibleSpring(1.0f - ab_spring_weight); }
5018+
if (widget_c) { ImGui::Button("Widget C", widget_size); }
5019+
if (spring_c) { funcs::VisibleSpring(a_c_spring_weight); }
5020+
if (horizontal) { ImGui::EndHorizontal(); } else { ImGui::EndVertical(); }
5021+
5022+
ImGui::PopStyleVar();
5023+
5024+
ImDrawList* draw_list = ImGui::GetWindowDrawList();
5025+
draw_list->AddRect(ImGui::GetItemRectMin(), ImGui::GetItemRectMax(), ImGui::GetColorU32(ImGuiCol_Border));
5026+
5027+
ImGui::TreePop();
5028+
}
5029+
#endif // IMGUI_HAS_STACK_LAYOUT
48805030
}
48815031

48825032
//-----------------------------------------------------------------------------

imgui_internal.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Index of this file:
1111
// [SECTION] Forward declarations
1212
// [SECTION] Context pointer
1313
// [SECTION] STB libraries includes
14+
// [SECTION] Stack Layout includes
1415
// [SECTION] Macros
1516
// [SECTION] Generic helpers
1617
// [SECTION] ImDrawList support
@@ -221,6 +222,14 @@ using ImGuiErrorStringCallback = std::function<void(const std::string&)>;
221222
extern IMGUI_API ImGuiContext* GImGui; // Current implicit context pointer
222223
#endif
223224

225+
//-------------------------------------------------------------------------
226+
// [SECTION] Stack Layout includes
227+
//-------------------------------------------------------------------------
228+
229+
#if IMGUI_HAS_STACK_LAYOUT
230+
# include "imgui_stacklayout_internal.h"
231+
#endif
232+
224233
//-----------------------------------------------------------------------------
225234
// [SECTION] Macros
226235
//-----------------------------------------------------------------------------

0 commit comments

Comments
 (0)