Skip to content

Commit c48e267

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 ec3b2b8 commit c48e267

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
@@ -1353,6 +1353,7 @@ ImGuiStyle::ImGuiStyle()
13531353
ScrollbarRounding = 9.0f; // Radius of grab corners rounding for scrollbar
13541354
GrabMinSize = 12.0f; // Minimum width/height of a grab box for slider/scrollbar
13551355
GrabRounding = 0.0f; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
1356+
LayoutAlign = 0.5f; // Element alignment inside horizontal and vertical layouts (0.0f - left/top, 1.0f - right/bottom, 0.5f - center).
13561357
LogSliderDeadzone = 4.0f; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
13571358
TabRounding = 4.0f; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
13581359
TabBorderSize = 0.0f; // Thickness of border around tabs.
@@ -3474,6 +3475,7 @@ static const ImGuiDataVarInfo GStyleVarInfo[] =
34743475
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, ScrollbarRounding) }, // ImGuiStyleVar_ScrollbarRounding
34753476
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, GrabMinSize) }, // ImGuiStyleVar_GrabMinSize
34763477
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, GrabRounding) }, // ImGuiStyleVar_GrabRounding
3478+
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, LayoutAlign) }, // ImGuiStyleVar_LayoutAlign
34773479
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, TabRounding) }, // ImGuiStyleVar_TabRounding
34783480
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, TabBorderSize) }, // ImGuiStyleVar_TabBorderSize
34793481
{ ImGuiDataType_Float, 1, (ImU32)offsetof(ImGuiStyle, TabBarBorderSize) }, // ImGuiStyleVar_TabBarBorderSize
@@ -11591,6 +11593,10 @@ bool ImGui::ItemAdd(const ImRect& bb, ImGuiID id, const ImRect* nav_bb_arg, ImGu
1159111593
g.NextItemData.HasFlags = ImGuiNextItemDataFlags_None;
1159211594
g.NextItemData.ItemFlags = ImGuiItemFlags_None;
1159311595

11596+
#if IMGUI_HAS_STACK_LAYOUT
11597+
ImGuiInternal::UpdateItemRect(window->ID, bb.Min, bb.Max);
11598+
#endif
11599+
1159411600
#ifdef IMGUI_ENABLE_TEST_ENGINE
1159511601
if (id != 0)
1159611602
IMGUI_TEST_ENGINE_ITEM_ADD(id, g.LastItemData.NavRect, &g.LastItemData);
@@ -11672,6 +11678,38 @@ void ImGui::ItemSize(const ImVec2& size, float text_baseline_y)
1167211678
if (window->SkipItems)
1167311679
return;
1167411680

11681+
#if IMGUI_HAS_STACK_LAYOUT
11682+
ImGuiLayoutType layout_type = ImGuiInternal::GetCurrentLayoutType(window->ID);
11683+
#else
11684+
ImGuiLayoutType layout_type = window->DC.LayoutType;
11685+
#endif
11686+
11687+
//if (g.IO.KeyAlt) window->DrawList->AddCircle(window->DC.CursorPos, 3.0f, IM_COL32(255,255,0,255), 4); // [DEBUG] Widget position
11688+
11689+
// Stack Layouts: Handle horizontal case first to simplify merge in case code handling vertical changes.
11690+
if (layout_type == ImGuiLayoutType_Horizontal)
11691+
{
11692+
const float line_width = ImMax(window->DC.CurrLineSize.x, size.x);
11693+
11694+
// Always align ourselves on pixel boundaries
11695+
//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]
11696+
window->DC.CursorPosPrevLine.x = window->DC.CursorPos.x;
11697+
window->DC.CursorPosPrevLine.y = window->DC.CursorPos.y + size.y;
11698+
window->DC.CursorPos.x = IM_TRUNC(window->DC.CursorPos.x + line_width + g.Style.ItemSpacing.x);
11699+
window->DC.CursorPos.y = IM_TRUNC(window->DC.CursorPosPrevLine.y - size.y);
11700+
window->DC.CursorMaxPos.x = ImMax(window->DC.CursorMaxPos.x, window->DC.CursorPos.x - g.Style.ItemSpacing.x);
11701+
window->DC.CursorMaxPos.y = ImMax(window->DC.CursorMaxPos.y, window->DC.CursorPosPrevLine.y);
11702+
//if (g.IO.KeyAlt) window->DrawList->AddCircle(window->DC.CursorMaxPos, 3.0f, IM_COL32(255,0,0,255), 4); // [DEBUG]
11703+
11704+
window->DC.PrevLineSize.x = line_width;
11705+
window->DC.PrevLineSize.y = 0.0f;
11706+
window->DC.CurrLineSize.x = 0.0f;
11707+
window->DC.PrevLineTextBaseOffset = ImMax(window->DC.CurrLineTextBaseOffset, text_baseline_y);
11708+
window->DC.CurrLineTextBaseOffset = window->DC.PrevLineTextBaseOffset;
11709+
window->DC.IsSameLine = window->DC.IsSetPos = false;
11710+
return;
11711+
}
11712+
1167511713
// We increase the height in this function to accommodate for baseline offset.
1167611714
// In theory we should be offsetting the starting position (window->DC.CursorPos), that will be the topic of a larger refactor,
1167711715
// but since ItemSize() is not yet an API that moves the cursor (to handle e.g. wrapping) enlarging the height has the same effect.
@@ -11690,15 +11728,12 @@ void ImGui::ItemSize(const ImVec2& size, float text_baseline_y)
1169011728
window->DC.CursorMaxPos.y = ImMax(window->DC.CursorMaxPos.y, window->DC.CursorPos.y - g.Style.ItemSpacing.y);
1169111729
//if (g.IO.KeyAlt) window->DrawList->AddCircle(window->DC.CursorMaxPos, 3.0f, IM_COL32(255,0,0,255), 4); // [DEBUG]
1169211730

11731+
window->DC.PrevLineSize.x = 0.0f;
1169311732
window->DC.PrevLineSize.y = line_height;
1169411733
window->DC.CurrLineSize.y = 0.0f;
1169511734
window->DC.PrevLineTextBaseOffset = ImMax(window->DC.CurrLineTextBaseOffset, text_baseline_y);
1169611735
window->DC.CurrLineTextBaseOffset = 0.0f;
1169711736
window->DC.IsSameLine = window->DC.IsSetPos = false;
11698-
11699-
// Horizontal layout mode
11700-
if (window->DC.LayoutType == ImGuiLayoutType_Horizontal)
11701-
SameLine();
1170211737
}
1170311738
IM_MSVC_RUNTIME_CHECKS_RESTORE
1170411739

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]
@@ -1847,6 +1848,7 @@ enum ImGuiStyleVar_
18471848
ImGuiStyleVar_ScrollbarRounding, // float ScrollbarRounding
18481849
ImGuiStyleVar_GrabMinSize, // float GrabMinSize
18491850
ImGuiStyleVar_GrabRounding, // float GrabRounding
1851+
ImGuiStyleVar_LayoutAlign, // float LayoutAlign
18501852
ImGuiStyleVar_TabRounding, // float TabRounding
18511853
ImGuiStyleVar_TabBorderSize, // float TabBorderSize
18521854
ImGuiStyleVar_TabBarBorderSize, // float TabBarBorderSize
@@ -2330,6 +2332,7 @@ struct ImGuiStyle
23302332
float ScrollbarRounding; // Radius of grab corners for scrollbar.
23312333
float GrabMinSize; // Minimum width/height of a grab box for slider/scrollbar.
23322334
float GrabRounding; // Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.
2335+
float LayoutAlign; // Element alignment inside horizontal and vertical layouts (0.0f - left/top, 1.0f - right/bottom, 0.5f - center).
23332336
float LogSliderDeadzone; // The size in pixels of the dead-zone around zero on logarithmic sliders that cross zero.
23342337
float TabRounding; // Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.
23352338
float TabBorderSize; // Thickness of border around tabs.
@@ -4152,6 +4155,10 @@ namespace ImGui
41524155
#pragma warning (pop)
41534156
#endif
41544157

4158+
#if IMGUI_HAS_STACK_LAYOUT
4159+
#include "imgui_stacklayout.h"
4160+
#endif
4161+
41554162
// Include imgui_user.h at the end of imgui.h
41564163
// May be convenient for some users to only explicitly include vanilla imgui.h and have extra stuff included.
41574164
#ifdef IMGUI_INCLUDE_IMGUI_USER_H

imgui_demo.cpp

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

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

49115061
//-----------------------------------------------------------------------------

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
@@ -230,6 +231,14 @@ using ImGuiErrorStringCallback = std::function<void(const std::string&)>;
230231
extern IMGUI_API ImGuiContext* GImGui; // Current implicit context pointer
231232
#endif
232233

234+
//-------------------------------------------------------------------------
235+
// [SECTION] Stack Layout includes
236+
//-------------------------------------------------------------------------
237+
238+
#if IMGUI_HAS_STACK_LAYOUT
239+
# include "imgui_stacklayout_internal.h"
240+
#endif
241+
233242
//-----------------------------------------------------------------------------
234243
// [SECTION] Macros
235244
//-----------------------------------------------------------------------------

0 commit comments

Comments
 (0)