Drezil/imgui
1
0
Fork 0
mirror of https://github.com/Drezil/imgui.git synced 2024-11-29 14:56:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clipper: extract code into a ImGuiListClipper_StepInternal() to facilitate debugging. Moved clipper End() call to outer layer, stopped heretic use of comma operator.

Browse Source 
Removed obsolete comments in clipper Begin()
This commit is contained in:
ocornut 2022-08-23 14:33:29 +02:00
parent 21b5fac57a
commit 4eb9066997
1 changed files with 41 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
imgui.cpp
View File

@ -2592,9 +2592,6 @@ ImGuiListClipper::~ImGuiListClipper()
End(); End();
} }
// Use case A: Begin() called from constructor with items_height<0, then called again from Step() in StepNo 1
// Use case B: Begin() called from constructor with items_height>0
// FIXME-LEGACY: Ideally we should remove the Begin/End functions but they are part of the legacy API we still support. This is why some of the code in Step() calling Begin() and reassign some fields, spaghetti style.
void ImGuiListClipper::Begin(int items_count, float items_height) void ImGuiListClipper::Begin(int items_count, float items_height)
{ {
ImGuiContext& g = *GImGui; ImGuiContext& g = *GImGui;
@ -2650,11 +2647,11 @@ void ImGuiListClipper::ForceDisplayRangeByIndices(int item_min, int item_max)
data->Ranges.push_back(ImGuiListClipperRange::FromIndices(item_min, item_max)); data->Ranges.push_back(ImGuiListClipperRange::FromIndices(item_min, item_max));
} }
bool ImGuiListClipper::Step() static bool ImGuiListClipper_StepInternal(ImGuiListClipper* clipper)
{ {
ImGuiContext& g = *GImGui; ImGuiContext& g = *GImGui;
ImGuiWindow* window = g.CurrentWindow; ImGuiWindow* window = g.CurrentWindow;
ImGuiListClipperData* data = (ImGuiListClipperData*)TempData; ImGuiListClipperData* data = (ImGuiListClipperData*)clipper->TempData;
IM_ASSERT(data != NULL && "Called ImGuiListClipper::Step() too many times, or before ImGuiListClipper::Begin() ?"); IM_ASSERT(data != NULL && "Called ImGuiListClipper::Step() too many times, or before ImGuiListClipper::Begin() ?");
ImGuiTable* table = g.CurrentTable; ImGuiTable* table = g.CurrentTable;
@ -2662,17 +2659,17 @@ bool ImGuiListClipper::Step()
ImGui::TableEndRow(table); ImGui::TableEndRow(table);
// No items // No items
if (ItemsCount == 0 || GetSkipItemForListClipping()) if (clipper->ItemsCount == 0 || GetSkipItemForListClipping())
return (void)End(), false; return false;
// While we are in frozen row state, keep displaying items one by one, unclipped // While we are in frozen row state, keep displaying items one by one, unclipped
// FIXME: Could be stored as a table-agnostic state. // FIXME: Could be stored as a table-agnostic state.
if (data->StepNo == 0 && table != NULL && !table->IsUnfrozenRows) if (data->StepNo == 0 && table != NULL && !table->IsUnfrozenRows)
{ {
DisplayStart = data->ItemsFrozen; clipper->DisplayStart = data->ItemsFrozen;
DisplayEnd = data->ItemsFrozen + 1; clipper->DisplayEnd = data->ItemsFrozen + 1;
if (DisplayStart >= ItemsCount) if (clipper->DisplayStart >= clipper->ItemsCount)
return (void)End(), false; return false;
data->ItemsFrozen++; data->ItemsFrozen++;
return true; return true;
} }
@ -2681,15 +2678,15 @@ bool ImGuiListClipper::Step()
bool calc_clipping = false; bool calc_clipping = false;
if (data->StepNo == 0) if (data->StepNo == 0)
{ {
StartPosY = window->DC.CursorPos.y; clipper->StartPosY = window->DC.CursorPos.y;
if (ItemsHeight <= 0.0f) if (clipper->ItemsHeight <= 0.0f)
{ {
// Submit the first item (or range) so we can measure its height (generally the first range is 0..1) // Submit the first item (or range) so we can measure its height (generally the first range is 0..1)
data->Ranges.push_front(ImGuiListClipperRange::FromIndices(data->ItemsFrozen, data->ItemsFrozen + 1)); data->Ranges.push_front(ImGuiListClipperRange::FromIndices(data->ItemsFrozen, data->ItemsFrozen + 1));
DisplayStart = ImMax(data->Ranges[0].Min, data->ItemsFrozen); clipper->DisplayStart = ImMax(data->Ranges[0].Min, data->ItemsFrozen);
DisplayEnd = ImMin(data->Ranges[0].Max, ItemsCount); clipper->DisplayEnd = ImMin(data->Ranges[0].Max, clipper->ItemsCount);
if (DisplayStart == DisplayEnd) if (clipper->DisplayStart == clipper->DisplayEnd)
return (void)End(), false; return false;
data->StepNo = 1; data->StepNo = 1;
return true; return true;
} }
@ -2697,29 +2694,29 @@ bool ImGuiListClipper::Step()
} }
// Step 1: Let the clipper infer height from first range // Step 1: Let the clipper infer height from first range
if (ItemsHeight <= 0.0f) if (clipper->ItemsHeight <= 0.0f)
{ {
IM_ASSERT(data->StepNo == 1); IM_ASSERT(data->StepNo == 1);
if (table) if (table)
IM_ASSERT(table->RowPosY1 == StartPosY && table->RowPosY2 == window->DC.CursorPos.y); IM_ASSERT(table->RowPosY1 == clipper->StartPosY && table->RowPosY2 == window->DC.CursorPos.y);
ItemsHeight = (window->DC.CursorPos.y - StartPosY) / (float)(DisplayEnd - DisplayStart); clipper->ItemsHeight = (window->DC.CursorPos.y - clipper->StartPosY) / (float)(clipper->DisplayEnd - clipper->DisplayStart);
bool affected_by_floating_point_precision = ImIsFloatAboveGuaranteedIntegerPrecision(StartPosY) || ImIsFloatAboveGuaranteedIntegerPrecision(window->DC.CursorPos.y); bool affected_by_floating_point_precision = ImIsFloatAboveGuaranteedIntegerPrecision(clipper->StartPosY) || ImIsFloatAboveGuaranteedIntegerPrecision(window->DC.CursorPos.y);
if (affected_by_floating_point_precision) if (affected_by_floating_point_precision)
ItemsHeight = window->DC.PrevLineSize.y + g.Style.ItemSpacing.y; // FIXME: Technically wouldn't allow multi-line entries. clipper->ItemsHeight = window->DC.PrevLineSize.y + g.Style.ItemSpacing.y; // FIXME: Technically wouldn't allow multi-line entries.
IM_ASSERT(ItemsHeight > 0.0f && "Unable to calculate item height! First item hasn't moved the cursor vertically!"); IM_ASSERT(clipper->ItemsHeight > 0.0f && "Unable to calculate item height! First item hasn't moved the cursor vertically!");
calc_clipping = true; // If item height had to be calculated, calculate clipping afterwards. calc_clipping = true; // If item height had to be calculated, calculate clipping afterwards.
} }
// Step 0 or 1: Calculate the actual ranges of visible elements. // Step 0 or 1: Calculate the actual ranges of visible elements.
const int already_submitted = DisplayEnd; const int already_submitted = clipper->DisplayEnd;
if (calc_clipping) if (calc_clipping)
{ {
if (g.LogEnabled) if (g.LogEnabled)
{ {
// If logging is active, do not perform any clipping // If logging is active, do not perform any clipping
data->Ranges.push_back(ImGuiListClipperRange::FromIndices(0, ItemsCount)); data->Ranges.push_back(ImGuiListClipperRange::FromIndices(0, clipper->ItemsCount));
} }
else else
{ {
@ -2728,7 +2725,7 @@ bool ImGuiListClipper::Step()
if (is_nav_request) if (is_nav_request)
data->Ranges.push_back(ImGuiListClipperRange::FromPositions(g.NavScoringNoClipRect.Min.y, g.NavScoringNoClipRect.Max.y, 0, 0)); data->Ranges.push_back(ImGuiListClipperRange::FromPositions(g.NavScoringNoClipRect.Min.y, g.NavScoringNoClipRect.Max.y, 0, 0));
if (is_nav_request && (g.NavMoveFlags & ImGuiNavMoveFlags_Tabbing) && g.NavTabbingDir == -1) if (is_nav_request && (g.NavMoveFlags & ImGuiNavMoveFlags_Tabbing) && g.NavTabbingDir == -1)
data->Ranges.push_back(ImGuiListClipperRange::FromIndices(ItemsCount - 1, ItemsCount)); data->Ranges.push_back(ImGuiListClipperRange::FromIndices(clipper->ItemsCount - 1, clipper->ItemsCount));
// Add focused/active item // Add focused/active item
ImRect nav_rect_abs = ImGui::WindowRectRelToAbs(window, window->NavRectRel[0]); ImRect nav_rect_abs = ImGui::WindowRectRelToAbs(window, window->NavRectRel[0]);
@ -2748,10 +2745,10 @@ bool ImGuiListClipper::Step()
for (int i = 0; i < data->Ranges.Size; i++) for (int i = 0; i < data->Ranges.Size; i++)
if (data->Ranges[i].PosToIndexConvert) if (data->Ranges[i].PosToIndexConvert)
{ {
int m1 = (int)(((double)data->Ranges[i].Min - window->DC.CursorPos.y - data->LossynessOffset) / ItemsHeight); int m1 = (int)(((double)data->Ranges[i].Min - window->DC.CursorPos.y - data->LossynessOffset) / clipper->ItemsHeight);
int m2 = (int)((((double)data->Ranges[i].Max - window->DC.CursorPos.y - data->LossynessOffset) / ItemsHeight) + 0.999999f); int m2 = (int)((((double)data->Ranges[i].Max - window->DC.CursorPos.y - data->LossynessOffset) / clipper->ItemsHeight) + 0.999999f);
data->Ranges[i].Min = ImClamp(already_submitted + m1 + data->Ranges[i].PosToIndexOffsetMin, already_submitted, ItemsCount - 1); data->Ranges[i].Min = ImClamp(already_submitted + m1 + data->Ranges[i].PosToIndexOffsetMin, already_submitted, clipper->ItemsCount - 1);
data->Ranges[i].Max = ImClamp(already_submitted + m2 + data->Ranges[i].PosToIndexOffsetMax, data->Ranges[i].Min + 1, ItemsCount); data->Ranges[i].Max = ImClamp(already_submitted + m2 + data->Ranges[i].PosToIndexOffsetMax, data->Ranges[i].Min + 1, clipper->ItemsCount);
data->Ranges[i].PosToIndexConvert = false; data->Ranges[i].PosToIndexConvert = false;
} }
ImGuiListClipper_SortAndFuseRanges(data->Ranges, data->StepNo); ImGuiListClipper_SortAndFuseRanges(data->Ranges, data->StepNo);
@ -2760,23 +2757,30 @@ bool ImGuiListClipper::Step()
// Step 0+ (if item height is given in advance) or 1+: Display the next range in line. // Step 0+ (if item height is given in advance) or 1+: Display the next range in line.
if (data->StepNo < data->Ranges.Size) if (data->StepNo < data->Ranges.Size)
{ {
DisplayStart = ImMax(data->Ranges[data->StepNo].Min, already_submitted); clipper->DisplayStart = ImMax(data->Ranges[data->StepNo].Min, already_submitted);
DisplayEnd = ImMin(data->Ranges[data->StepNo].Max, ItemsCount); clipper->DisplayEnd = ImMin(data->Ranges[data->StepNo].Max, clipper->ItemsCount);
if (DisplayStart > already_submitted) //-V1051 if (clipper->DisplayStart > already_submitted) //-V1051
ImGuiListClipper_SeekCursorForItem(this, DisplayStart); ImGuiListClipper_SeekCursorForItem(clipper, clipper->DisplayStart);
data->StepNo++; data->StepNo++;
return true; return true;
} }
// After the last step: Let the clipper validate that we have reached the expected Y position (corresponding to element DisplayEnd), // After the last step: Let the clipper validate that we have reached the expected Y position (corresponding to element DisplayEnd),
// Advance the cursor to the end of the list and then returns 'false' to end the loop. // Advance the cursor to the end of the list and then returns 'false' to end the loop.
if (ItemsCount < INT_MAX) if (clipper->ItemsCount < INT_MAX)
ImGuiListClipper_SeekCursorForItem(this, ItemsCount); ImGuiListClipper_SeekCursorForItem(clipper, clipper->ItemsCount);
End();
return false; return false;
} }
bool ImGuiListClipper::Step()
{
bool ret = ImGuiListClipper_StepInternal(this);
if (ret == false)
End();
return ret;
}
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------
// [SECTION] STYLING // [SECTION] STYLING
//----------------------------------------------------------------------------- //-----------------------------------------------------------------------------