anulax
/
imgui-docking
1
0
Fork 0
Code Issues Pull Requests Packages project_board Releases Wiki Activity

RangeSelect/MultiSelect: use a single ImGuiMultiSelectIO buffer.

Browse Source 
+ using local storage var in EndMultiSelect(), should be no-op.
features/range_select
ocornut ago%!(EXTRA string=2 years)
parent 075e223a1d
commit 84600712d5
2 changed files with 33 additions and 25 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      imgui_internal.h
  2. 52
      imgui_widgets.cpp

6
imgui_internal.h
Unescape View File

@ -1721,10 +1721,10 @@ struct IMGUI_API ImGuiMultiSelectTempData
ImGuiID FocusScopeId; // Copied from g.CurrentFocusScopeId (unless another selection scope was pushed manually) ImGuiID FocusScopeId; // Copied from g.CurrentFocusScopeId (unless another selection scope was pushed manually)
ImGuiMultiSelectFlags Flags; ImGuiMultiSelectFlags Flags;
ImGuiKeyChord KeyMods; ImGuiKeyChord KeyMods;
ImGuiMultiSelectIO BeginIO; // Requests are set and returned by BeginMultiSelect(), written to by user during the loop. ImGuiMultiSelectIO IO; // Requests are set and returned by BeginMultiSelect()/EndMultiSelect() + written to by user during the loop.
ImGuiMultiSelectIO EndIO; // Requests are set during the loop and returned by EndMultiSelect().
bool LoopRequestClear; bool LoopRequestClear;
bool LoopRequestSelectAll; bool LoopRequestSelectAll;
bool IsEndIO; // Set when switching IO from BeginMultiSelect() to EndMultiSelect() state.
bool IsFocused; // Set if currently focusing the selection scope (any item of the selection). May be used if you have custom shortcut associated to selection. bool IsFocused; // Set if currently focusing the selection scope (any item of the selection). May be used if you have custom shortcut associated to selection.
bool IsSetRange; // Set by BeginMultiSelect() when using Shift+Navigation. Because scrolling may be affected we can't afford a frame of lag with Shift+Navigation. bool IsSetRange; // Set by BeginMultiSelect() when using Shift+Navigation. Because scrolling may be affected we can't afford a frame of lag with Shift+Navigation.
bool NavIdPassedBy; bool NavIdPassedBy;
@ -1733,7 +1733,7 @@ struct IMGUI_API ImGuiMultiSelectTempData
//ImRect Rect; // Extent of selection scope between BeginMultiSelect() / EndMultiSelect(), used by ImGuiMultiSelectFlags_ClearOnClickRectVoid. //ImRect Rect; // Extent of selection scope between BeginMultiSelect() / EndMultiSelect(), used by ImGuiMultiSelectFlags_ClearOnClickRectVoid.
ImGuiMultiSelectTempData() { Clear(); } ImGuiMultiSelectTempData() { Clear(); }
void Clear() { Storage = NULL; FocusScopeId = 0; Flags = 0; KeyMods = 0; BeginIO.Clear(); EndIO.Clear(); LoopRequestClear = LoopRequestSelectAll = IsFocused = IsSetRange = NavIdPassedBy = RangeSrcPassedBy = RangeDstPassedBy = false; } void Clear() { Storage = NULL; FocusScopeId = 0; Flags = 0; KeyMods = 0; IO.Clear(); IsEndIO = LoopRequestClear = LoopRequestSelectAll = IsFocused = IsSetRange = NavIdPassedBy = RangeSrcPassedBy = RangeDstPassedBy = false; }
}; };
// Persistent storage for multi-select (as long as selection is alive) // Persistent storage for multi-select (as long as selection is alive)

52
imgui_widgets.cpp
Unescape View File

@ -7032,10 +7032,10 @@ ImGuiMultiSelectIO* ImGui::BeginMultiSelect(ImGuiMultiSelectFlags flags)
storage->Window = window; storage->Window = window;
ms->Storage = storage; ms->Storage = storage;
// We want EndIO's NavIdItem/NavIdSelected to match BeginIO's one, so the value never changes after EndMultiSelect() ms->IO.RangeSrcItem = storage->RangeSrcItem;
ms->BeginIO.RangeSrcItem = ms->EndIO.RangeSrcItem = storage->RangeSrcItem; ms->IO.NavIdItem = storage->NavIdItem;
ms->BeginIO.NavIdItem = ms->EndIO.NavIdItem = storage->NavIdItem; ms->IO.NavIdSelected = (storage->NavIdSelected == 1) ? true : false;
ms->BeginIO.NavIdSelected = ms->EndIO.NavIdSelected = (storage->NavIdSelected == 1) ? true : false; ms->IO.Requests.resize(0);
bool request_clear = false; bool request_clear = false;
bool request_select_all = false; bool request_select_all = false;
@ -7074,14 +7074,14 @@ ImGuiMultiSelectIO* ImGui::BeginMultiSelect(ImGuiMultiSelectFlags flags)
} }
if (request_clear || request_select_all) if (request_clear || request_select_all)
ms->BeginIO.Requests.push_back(ImGuiSelectionRequest(request_select_all ? ImGuiSelectionRequestType_SelectAll : ImGuiSelectionRequestType_Clear)); ms->IO.Requests.push_back(ImGuiSelectionRequest(request_select_all ? ImGuiSelectionRequestType_SelectAll : ImGuiSelectionRequestType_Clear));
ms->LoopRequestClear = request_clear; ms->LoopRequestClear = request_clear;
ms->LoopRequestSelectAll = request_select_all; ms->LoopRequestSelectAll = request_select_all;
if (g.DebugLogFlags & ImGuiDebugLogFlags_EventSelection) if (g.DebugLogFlags & ImGuiDebugLogFlags_EventSelection)
DebugLogMultiSelectRequests("BeginMultiSelect", &ms->BeginIO); DebugLogMultiSelectRequests("BeginMultiSelect", &ms->IO);
return &ms->BeginIO; return &ms->IO;
} }
// Return updated ImGuiMultiSelectIO structure. Lifetime: until EndFrame() or next BeginMultiSelect() call. // Return updated ImGuiMultiSelectIO structure. Lifetime: until EndFrame() or next BeginMultiSelect() call.
@ -7089,46 +7089,49 @@ ImGuiMultiSelectIO* ImGui::EndMultiSelect()
{ {
ImGuiContext& g = *GImGui; ImGuiContext& g = *GImGui;
ImGuiMultiSelectTempData* ms = g.CurrentMultiSelect; ImGuiMultiSelectTempData* ms = g.CurrentMultiSelect;
ImGuiMultiSelectState* storage = ms->Storage;
IM_ASSERT(ms->FocusScopeId == g.CurrentFocusScopeId); IM_ASSERT(ms->FocusScopeId == g.CurrentFocusScopeId);
IM_ASSERT(g.CurrentMultiSelect != NULL && ms->Storage->Window == g.CurrentWindow); IM_ASSERT(g.CurrentMultiSelect != NULL && storage->Window == g.CurrentWindow);
if (ms->IsFocused) if (ms->IsFocused)
{ {
// We currently don't allow user code to modify RangeSrcItem by writing to BeginIO's version, but that would be an easy change here. // We currently don't allow user code to modify RangeSrcItem by writing to BeginIO's version, but that would be an easy change here.
if (ms->BeginIO.RangeSrcReset || (ms->RangeSrcPassedBy == false && ms->BeginIO.RangeSrcItem != ImGuiSelectionUserData_Invalid)) // Can't read storage->RangeSrcItem here -> we want the state at begining of the scope (see tests for easy failure) if (ms->IO.RangeSrcReset || (ms->RangeSrcPassedBy == false && ms->IO.RangeSrcItem != ImGuiSelectionUserData_Invalid)) // Can't read storage->RangeSrcItem here -> we want the state at begining of the scope (see tests for easy failure)
{ {
IMGUI_DEBUG_LOG_SELECTION("[selection] EndMultiSelect: Reset RangeSrcItem.\n"); // Will set be to NavId. IMGUI_DEBUG_LOG_SELECTION("[selection] EndMultiSelect: Reset RangeSrcItem.\n"); // Will set be to NavId.
ms->Storage->RangeSrcItem = ImGuiSelectionUserData_Invalid; storage->RangeSrcItem = ImGuiSelectionUserData_Invalid;
} }
if (ms->NavIdPassedBy == false && ms->Storage->NavIdItem != ImGuiSelectionUserData_Invalid) if (ms->NavIdPassedBy == false && storage->NavIdItem != ImGuiSelectionUserData_Invalid)
{ {
IMGUI_DEBUG_LOG_SELECTION("[selection] EndMultiSelect: Reset NavIdItem.\n"); IMGUI_DEBUG_LOG_SELECTION("[selection] EndMultiSelect: Reset NavIdItem.\n");
ms->Storage->NavIdItem = ImGuiSelectionUserData_Invalid; storage->NavIdItem = ImGuiSelectionUserData_Invalid;
ms->Storage->NavIdSelected = -1; storage->NavIdSelected = -1;
} }
} }
if (ms->IsEndIO == false)
ms->IO.Requests.resize(0);
// Clear selection when clicking void? // Clear selection when clicking void?
// We specifically test for IsMouseDragPastThreshold(0) == false to allow box-selection! // We specifically test for IsMouseDragPastThreshold(0) == false to allow box-selection!
if (ms->Flags & ImGuiMultiSelectFlags_ClearOnClickWindowVoid) if (ms->Flags & ImGuiMultiSelectFlags_ClearOnClickWindowVoid)
if (IsWindowHovered() && g.HoveredId == 0) if (IsWindowHovered() && g.HoveredId == 0)
if (IsMouseReleased(0) && IsMouseDragPastThreshold(0) == false && g.IO.KeyMods == ImGuiMod_None) if (IsMouseReleased(0) && IsMouseDragPastThreshold(0) == false && g.IO.KeyMods == ImGuiMod_None)
{ {
ms->EndIO.Requests.resize(0); ms->IO.Requests.resize(0);
ms->EndIO.Requests.push_back(ImGuiSelectionRequest(ImGuiSelectionRequestType_Clear)); ms->IO.Requests.push_back(ImGuiSelectionRequest(ImGuiSelectionRequestType_Clear));
} }
// Unwind // Unwind
ms->FocusScopeId = 0; ms->FocusScopeId = 0;
ms->Flags = ImGuiMultiSelectFlags_None; ms->Flags = ImGuiMultiSelectFlags_None;
ms->BeginIO.Clear(); // Invalidate contents of BeginMultiSelect() to enforce scope.
PopFocusScope(); PopFocusScope();
g.CurrentMultiSelect = NULL; g.CurrentMultiSelect = NULL;
if (g.DebugLogFlags & ImGuiDebugLogFlags_EventSelection) if (g.DebugLogFlags & ImGuiDebugLogFlags_EventSelection)
DebugLogMultiSelectRequests("EndMultiSelect", &ms->EndIO); DebugLogMultiSelectRequests("EndMultiSelect", &ms->IO);
return &ms->EndIO; return &ms->IO;
} }
void ImGui::SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data) void ImGui::SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_data)
@ -7143,7 +7146,7 @@ void ImGui::SetNextItemSelectionUserData(ImGuiSelectionUserData selection_user_d
{ {
// Auto updating RangeSrcPassedBy for cases were clipper is not used (done before ItemAdd() clipping) // Auto updating RangeSrcPassedBy for cases were clipper is not used (done before ItemAdd() clipping)
g.NextItemData.ItemFlags |= ImGuiItemFlags_HasSelectionUserData | ImGuiItemFlags_IsMultiSelect; g.NextItemData.ItemFlags |= ImGuiItemFlags_HasSelectionUserData | ImGuiItemFlags_IsMultiSelect;
if (ms->BeginIO.RangeSrcItem == selection_user_data) if (ms->IO.RangeSrcItem == selection_user_data)
ms->RangeSrcPassedBy = true; ms->RangeSrcPassedBy = true;
} }
else else
@ -7240,6 +7243,11 @@ void ImGui::MultiSelectItemFooter(ImGuiID id, bool* p_selected, bool* p_pressed)
storage->RangeSrcItem = item_data; storage->RangeSrcItem = item_data;
storage->RangeSelected = selected; // Will be updated at the end of this function anyway. storage->RangeSelected = selected; // Will be updated at the end of this function anyway.
} }
if (ms->IsEndIO == false)
{
ms->IO.Requests.resize(0);
ms->IsEndIO = true;
}
// Auto-select as you navigate a list // Auto-select as you navigate a list
if (g.NavJustMovedToId == id) if (g.NavJustMovedToId == id)
@ -7299,8 +7307,8 @@ void ImGui::MultiSelectItemFooter(ImGuiID id, bool* p_selected, bool* p_pressed)
request_clear = true; // With is_shift==false the RequestClear was done in BeginIO, not necessary to do again. request_clear = true; // With is_shift==false the RequestClear was done in BeginIO, not necessary to do again.
if (request_clear) if (request_clear)
{ {
ms->EndIO.Requests.resize(0); ms->IO.Requests.resize(0);
ms->EndIO.Requests.push_back(ImGuiSelectionRequest(ImGuiSelectionRequestType_Clear)); ms->IO.Requests.push_back(ImGuiSelectionRequest(ImGuiSelectionRequestType_Clear));
} }
int range_direction; int range_direction;
@ -7326,7 +7334,7 @@ void ImGui::MultiSelectItemFooter(ImGuiID id, bool* p_selected, bool* p_pressed)
ImGuiSelectionUserData range_dst_item = item_data; ImGuiSelectionUserData range_dst_item = item_data;
req.RangeFirstItem = (range_direction > 0) ? storage->RangeSrcItem : range_dst_item; req.RangeFirstItem = (range_direction > 0) ? storage->RangeSrcItem : range_dst_item;
req.RangeLastItem = (range_direction > 0) ? range_dst_item : storage->RangeSrcItem; req.RangeLastItem = (range_direction > 0) ? range_dst_item : storage->RangeSrcItem;
ms->EndIO.Requests.push_back(req); ms->IO.Requests.push_back(req);
} }
// Update/store the selection state of the Source item (used by CTRL+SHIFT, when Source is unselected we perform a range unselect) // Update/store the selection state of the Source item (used by CTRL+SHIFT, when Source is unselected we perform a range unselect)

Write Preview
Loading…
Cancel
Save