| // dear imgui, v1.91.1 WIP |
| // (tables and columns code) |
| |
| /* |
| |
| Index of this file: |
| |
| // [SECTION] Commentary |
| // [SECTION] Header mess |
| // [SECTION] Tables: Main code |
| // [SECTION] Tables: Simple accessors |
| // [SECTION] Tables: Row changes |
| // [SECTION] Tables: Columns changes |
| // [SECTION] Tables: Columns width management |
| // [SECTION] Tables: Drawing |
| // [SECTION] Tables: Sorting |
| // [SECTION] Tables: Headers |
| // [SECTION] Tables: Context Menu |
| // [SECTION] Tables: Settings (.ini data) |
| // [SECTION] Tables: Garbage Collection |
| // [SECTION] Tables: Debugging |
| // [SECTION] Columns, BeginColumns, EndColumns, etc. |
| |
| */ |
| |
| // Navigating this file: |
| // - In Visual Studio: CTRL+comma ("Edit.GoToAll") can follow symbols inside comments, whereas CTRL+F12 ("Edit.GoToImplementation") cannot. |
| // - In Visual Studio w/ Visual Assist installed: ALT+G ("VAssistX.GoToImplementation") can also follow symbols inside comments. |
| // - In VS Code, CLion, etc.: CTRL+click can follow symbols inside comments. |
| |
| //----------------------------------------------------------------------------- |
| // [SECTION] Commentary |
| //----------------------------------------------------------------------------- |
| |
| //----------------------------------------------------------------------------- |
| // Typical tables call flow: (root level is generally public API): |
| //----------------------------------------------------------------------------- |
| // - BeginTable() user begin into a table |
| // | BeginChild() - (if ScrollX/ScrollY is set) |
| // | TableBeginInitMemory() - first time table is used |
| // | TableResetSettings() - on settings reset |
| // | TableLoadSettings() - on settings load |
| // | TableBeginApplyRequests() - apply queued resizing/reordering/hiding requests |
| // | - TableSetColumnWidth() - apply resizing width (for mouse resize, often requested by previous frame) |
| // | - TableUpdateColumnsWeightFromWidth()- recompute columns weights (of stretch columns) from their respective width |
| // - TableSetupColumn() user submit columns details (optional) |
| // - TableSetupScrollFreeze() user submit scroll freeze information (optional) |
| //----------------------------------------------------------------------------- |
| // - TableUpdateLayout() [Internal] followup to BeginTable(): setup everything: widths, columns positions, clipping rectangles. Automatically called by the FIRST call to TableNextRow() or TableHeadersRow(). |
| // | TableSetupDrawChannels() - setup ImDrawList channels |
| // | TableUpdateBorders() - detect hovering columns for resize, ahead of contents submission |
| // | TableBeginContextMenuPopup() |
| // | - TableDrawDefaultContextMenu() - draw right-click context menu contents |
| //----------------------------------------------------------------------------- |
| // - TableHeadersRow() or TableHeader() user submit a headers row (optional) |
| // | TableSortSpecsClickColumn() - when left-clicked: alter sort order and sort direction |
| // | TableOpenContextMenu() - when right-clicked: trigger opening of the default context menu |
| // - TableGetSortSpecs() user queries updated sort specs (optional, generally after submitting headers) |
| // - TableNextRow() user begin into a new row (also automatically called by TableHeadersRow()) |
| // | TableEndRow() - finish existing row |
| // | TableBeginRow() - add a new row |
| // - TableSetColumnIndex() / TableNextColumn() user begin into a cell |
| // | TableEndCell() - close existing column/cell |
| // | TableBeginCell() - enter into current column/cell |
| // - [...] user emit contents |
| //----------------------------------------------------------------------------- |
| // - EndTable() user ends the table |
| // | TableDrawBorders() - draw outer borders, inner vertical borders |
| // | TableMergeDrawChannels() - merge draw channels if clipping isn't required |
| // | EndChild() - (if ScrollX/ScrollY is set) |
| //----------------------------------------------------------------------------- |
| |
| //----------------------------------------------------------------------------- |
| // TABLE SIZING |
| //----------------------------------------------------------------------------- |
| // (Read carefully because this is subtle but it does make sense!) |
| //----------------------------------------------------------------------------- |
| // About 'outer_size': |
| // Its meaning needs to differ slightly depending on if we are using ScrollX/ScrollY flags. |
| // Default value is ImVec2(0.0f, 0.0f). |
| // X |
| // - outer_size.x <= 0.0f -> Right-align from window/work-rect right-most edge. With -FLT_MIN or 0.0f will align exactly on right-most edge. |
| // - outer_size.x > 0.0f -> Set Fixed width. |
| // Y with ScrollX/ScrollY disabled: we output table directly in current window |
| // - outer_size.y < 0.0f -> Bottom-align (but will auto extend, unless _NoHostExtendY is set). Not meaningful if parent window can vertically scroll. |
| // - outer_size.y = 0.0f -> No minimum height (but will auto extend, unless _NoHostExtendY is set) |
| // - outer_size.y > 0.0f -> Set Minimum height (but will auto extend, unless _NoHostExtendY is set) |
| // Y with ScrollX/ScrollY enabled: using a child window for scrolling |
| // - outer_size.y < 0.0f -> Bottom-align. Not meaningful if parent window can vertically scroll. |
| // - outer_size.y = 0.0f -> Bottom-align, consistent with BeginChild(). Not recommended unless table is last item in parent window. |
| // - outer_size.y > 0.0f -> Set Exact height. Recommended when using Scrolling on any axis. |
| //----------------------------------------------------------------------------- |
| // Outer size is also affected by the NoHostExtendX/NoHostExtendY flags. |
| // Important to note how the two flags have slightly different behaviors! |
| // - ImGuiTableFlags_NoHostExtendX -> Make outer width auto-fit to columns (overriding outer_size.x value). Only available when ScrollX/ScrollY are disabled and Stretch columns are not used. |
| // - ImGuiTableFlags_NoHostExtendY -> Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY is disabled. Data below the limit will be clipped and not visible. |
| // In theory ImGuiTableFlags_NoHostExtendY could be the default and any non-scrolling tables with outer_size.y != 0.0f would use exact height. |
| // This would be consistent but perhaps less useful and more confusing (as vertically clipped items are not useful and not easily noticeable). |
| //----------------------------------------------------------------------------- |
| // About 'inner_width': |
| // With ScrollX disabled: |
| // - inner_width -> *ignored* |
| // With ScrollX enabled: |
| // - inner_width < 0.0f -> *illegal* fit in known width (right align from outer_size.x) <-- weird |
| // - inner_width = 0.0f -> fit in outer_width: Fixed size columns will take space they need (if avail, otherwise shrink down), Stretch columns becomes Fixed columns. |
| // - inner_width > 0.0f -> override scrolling width, generally to be larger than outer_size.x. Fixed column take space they need (if avail, otherwise shrink down), Stretch columns share remaining space! |
| //----------------------------------------------------------------------------- |
| // Details: |
| // - If you want to use Stretch columns with ScrollX, you generally need to specify 'inner_width' otherwise the concept |
| // of "available space" doesn't make sense. |
| // - Even if not really useful, we allow 'inner_width < outer_size.x' for consistency and to facilitate understanding |
| // of what the value does. |
| //----------------------------------------------------------------------------- |
| |
| //----------------------------------------------------------------------------- |
| // COLUMNS SIZING POLICIES |
| // (Reference: ImGuiTableFlags_SizingXXX flags and ImGuiTableColumnFlags_WidthXXX flags) |
| //----------------------------------------------------------------------------- |
| // About overriding column sizing policy and width/weight with TableSetupColumn(): |
| // We use a default parameter of -1 for 'init_width'/'init_weight'. |
| // - with ImGuiTableColumnFlags_WidthFixed, init_width <= 0 (default) --> width is automatic |
| // - with ImGuiTableColumnFlags_WidthFixed, init_width > 0 (explicit) --> width is custom |
| // - with ImGuiTableColumnFlags_WidthStretch, init_weight <= 0 (default) --> weight is 1.0f |
| // - with ImGuiTableColumnFlags_WidthStretch, init_weight > 0 (explicit) --> weight is custom |
| // Widths are specified _without_ CellPadding. If you specify a width of 100.0f, the column will be cover (100.0f + Padding * 2.0f) |
| // and you can fit a 100.0f wide item in it without clipping and with padding honored. |
| //----------------------------------------------------------------------------- |
| // About default sizing policy (if you don't specify a ImGuiTableColumnFlags_WidthXXXX flag) |
| // - with Table policy ImGuiTableFlags_SizingFixedFit --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is equal to contents width |
| // - with Table policy ImGuiTableFlags_SizingFixedSame --> default Column policy is ImGuiTableColumnFlags_WidthFixed, default Width is max of all contents width |
| // - with Table policy ImGuiTableFlags_SizingStretchSame --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is 1.0f |
| // - with Table policy ImGuiTableFlags_SizingStretchWeight --> default Column policy is ImGuiTableColumnFlags_WidthStretch, default Weight is proportional to contents |
| // Default Width and default Weight can be overridden when calling TableSetupColumn(). |
| //----------------------------------------------------------------------------- |
| // About mixing Fixed/Auto and Stretch columns together: |
| // - the typical use of mixing sizing policies is: any number of LEADING Fixed columns, followed by one or two TRAILING Stretch columns. |
| // - using mixed policies with ScrollX does not make much sense, as using Stretch columns with ScrollX does not make much sense in the first place! |
| // that is, unless 'inner_width' is passed to BeginTable() to explicitly provide a total width to layout columns in. |
| // - when using ImGuiTableFlags_SizingFixedSame with mixed columns, only the Fixed/Auto columns will match their widths to the width of the maximum contents. |
| // - when using ImGuiTableFlags_SizingStretchSame with mixed columns, only the Stretch columns will match their weights/widths. |
| //----------------------------------------------------------------------------- |
| // About using column width: |
| // If a column is manually resizable or has a width specified with TableSetupColumn(): |
| // - you may use GetContentRegionAvail().x to query the width available in a given column. |
| // - right-side alignment features such as SetNextItemWidth(-x) or PushItemWidth(-x) will rely on this width. |
| // If the column is not resizable and has no width specified with TableSetupColumn(): |
| // - its width will be automatic and be set to the max of items submitted. |
| // - therefore you generally cannot have ALL items of the columns use e.g. SetNextItemWidth(-FLT_MIN). |
| // - but if the column has one or more items of known/fixed size, this will become the reference width used by SetNextItemWidth(-FLT_MIN). |
| //----------------------------------------------------------------------------- |
| |
| |
| //----------------------------------------------------------------------------- |
| // TABLES CLIPPING/CULLING |
| //----------------------------------------------------------------------------- |
| // About clipping/culling of Rows in Tables: |
| // - For large numbers of rows, it is recommended you use ImGuiListClipper to submit only visible rows. |
| // ImGuiListClipper is reliant on the fact that rows are of equal height. |
| // See 'Demo->Tables->Vertical Scrolling' or 'Demo->Tables->Advanced' for a demo of using the clipper. |
| // - Note that auto-resizing columns don't play well with using the clipper. |
| // By default a table with _ScrollX but without _Resizable will have column auto-resize. |
| // So, if you want to use the clipper, make sure to either enable _Resizable, either setup columns width explicitly with _WidthFixed. |
| //----------------------------------------------------------------------------- |
| // About clipping/culling of Columns in Tables: |
| // - Both TableSetColumnIndex() and TableNextColumn() return true when the column is visible or performing |
| // width measurements. Otherwise, you may skip submitting the contents of a cell/column, BUT ONLY if you know |
| // it is not going to contribute to row height. |
| // In many situations, you may skip submitting contents for every column but one (e.g. the first one). |
| // - Case A: column is not hidden by user, and at least partially in sight (most common case). |
| // - Case B: column is clipped / out of sight (because of scrolling or parent ClipRect): TableNextColumn() return false as a hint but we still allow layout output. |
| // - Case C: column is hidden explicitly by the user (e.g. via the context menu, or _DefaultHide column flag, etc.). |
| // |
| // [A] [B] [C] |
| // TableNextColumn(): true false false -> [userland] when TableNextColumn() / TableSetColumnIndex() returns false, user can skip submitting items but only if the column doesn't contribute to row height. |
| // SkipItems: false false true -> [internal] when SkipItems is true, most widgets will early out if submitted, resulting is no layout output. |
| // ClipRect: normal zero-width zero-width -> [internal] when ClipRect is zero, ItemAdd() will return false and most widgets will early out mid-way. |
| // ImDrawList output: normal dummy dummy -> [internal] when using the dummy channel, ImDrawList submissions (if any) will be wasted (because cliprect is zero-width anyway). |
| // |
| // - We need to distinguish those cases because non-hidden columns that are clipped outside of scrolling bounds should still contribute their height to the row. |
| // However, in the majority of cases, the contribution to row height is the same for all columns, or the tallest cells are known by the programmer. |
| //----------------------------------------------------------------------------- |
| // About clipping/culling of whole Tables: |
| // - Scrolling tables with a known outer size can be clipped earlier as BeginTable() will return false. |
| //----------------------------------------------------------------------------- |
| |
| //----------------------------------------------------------------------------- |
| // [SECTION] Header mess |
| //----------------------------------------------------------------------------- |
| |
| #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) |
| #define _CRT_SECURE_NO_WARNINGS |
| #endif |
| |
| #ifndef IMGUI_DEFINE_MATH_OPERATORS |
| #define IMGUI_DEFINE_MATH_OPERATORS |
| #endif |
| |
| #include "imgui.h" |
| #ifndef IMGUI_DISABLE |
| #include "imgui_internal.h" |
| |
| // System includes |
| #include <stdint.h> // intptr_t |
| |
| // Visual Studio warnings |
| #ifdef _MSC_VER |
| #pragma warning (disable: 4127) // condition expression is constant |
| #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen |
| #if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later |
| #pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types |
| #endif |
| #pragma warning (disable: 26451) // [Static Analyzer] Arithmetic overflow : Using operator 'xxx' on a 4 byte value and then casting the result to a 8 byte value. Cast the value to the wider type before calling operator 'xxx' to avoid overflow(io.2). |
| #pragma warning (disable: 26812) // [Static Analyzer] The enum type 'xxx' is unscoped. Prefer 'enum class' over 'enum' (Enum.3). |
| #endif |
| |
| // Clang/GCC warnings with -Weverything |
| #if defined(__clang__) |
| #if __has_warning("-Wunknown-warning-option") |
| #pragma clang diagnostic ignored "-Wunknown-warning-option" // warning: unknown warning group 'xxx' // not all warnings are known by all Clang versions and they tend to be rename-happy.. so ignoring warnings triggers new warnings on some configuration. Great! |
| #endif |
| #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx' |
| #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse. |
| #pragma clang diagnostic ignored "-Wfloat-equal" // warning: comparing floating point with == or != is unsafe // storing and comparing against same constants (typically 0.0f) is ok. |
| #pragma clang diagnostic ignored "-Wformat-nonliteral" // warning: format string is not a string literal // passing non-literal to vsnformat(). yes, user passing incorrect format strings can crash the code. |
| #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness |
| #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0 |
| #pragma clang diagnostic ignored "-Wdouble-promotion" // warning: implicit conversion from 'float' to 'double' when passing argument to function // using printf() is a misery with this as C++ va_arg ellipsis changes float to double. |
| #pragma clang diagnostic ignored "-Wenum-enum-conversion" // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') |
| #pragma clang diagnostic ignored "-Wdeprecated-enum-enum-conversion"// warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated |
| #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision |
| #pragma clang diagnostic ignored "-Wunsafe-buffer-usage" // warning: 'xxx' is an unsafe pointer used for buffer access |
| #elif defined(__GNUC__) |
| #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind |
| #pragma GCC diagnostic ignored "-Wformat-nonliteral" // warning: format not a string literal, format string not checked |
| #pragma GCC diagnostic ignored "-Wclass-memaccess" // [__GNUC__ >= 8] warning: 'memset/memcpy' clearing/writing an object of type 'xxxx' with no trivial copy-assignment; use assignment or value-initialization instead |
| #endif |
| |
| //----------------------------------------------------------------------------- |
| // [SECTION] Tables: Main code |
| //----------------------------------------------------------------------------- |
| // - TableFixFlags() [Internal] |
| // - TableFindByID() [Internal] |
| // - BeginTable() |
| // - BeginTableEx() [Internal] |
| // - TableBeginInitMemory() [Internal] |
| // - TableBeginApplyRequests() [Internal] |
| // - TableSetupColumnFlags() [Internal] |
| // - TableUpdateLayout() [Internal] |
| // - TableUpdateBorders() [Internal] |
| // - EndTable() |
| // - TableSetupColumn() |
| // - TableSetupScrollFreeze() |
| //----------------------------------------------------------------------------- |
| |
| // Configuration |
| static const int TABLE_DRAW_CHANNEL_BG0 = 0; |
| static const int TABLE_DRAW_CHANNEL_BG2_FROZEN = 1; |
| static const int TABLE_DRAW_CHANNEL_NOCLIP = 2; // When using ImGuiTableFlags_NoClip (this becomes the last visible channel) |
| static const float TABLE_BORDER_SIZE = 1.0f; // FIXME-TABLE: Currently hard-coded because of clipping assumptions with outer borders rendering. |
| static const float TABLE_RESIZE_SEPARATOR_HALF_THICKNESS = 4.0f; // Extend outside inner borders. |
| static const float TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER = 0.06f; // Delay/timer before making the hover feedback (color+cursor) visible because tables/columns tends to be more cramped. |
| |
| // Helper |
| inline ImGuiTableFlags TableFixFlags(ImGuiTableFlags flags, ImGuiWindow* outer_window) |
| { |
| // Adjust flags: set default sizing policy |
| if ((flags & ImGuiTableFlags_SizingMask_) == 0) |
| flags |= ((flags & ImGuiTableFlags_ScrollX) || (outer_window->Flags & ImGuiWindowFlags_AlwaysAutoResize)) ? ImGuiTableFlags_SizingFixedFit : ImGuiTableFlags_SizingStretchSame; |
| |
| // Adjust flags: enable NoKeepColumnsVisible when using ImGuiTableFlags_SizingFixedSame |
| if ((flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame) |
| flags |= ImGuiTableFlags_NoKeepColumnsVisible; |
| |
| // Adjust flags: enforce borders when resizable |
| if (flags & ImGuiTableFlags_Resizable) |
| flags |= ImGuiTableFlags_BordersInnerV; |
| |
| // Adjust flags: disable NoHostExtendX/NoHostExtendY if we have any scrolling going on |
| if (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) |
| flags &= ~(ImGuiTableFlags_NoHostExtendX | ImGuiTableFlags_NoHostExtendY); |
| |
| // Adjust flags: NoBordersInBodyUntilResize takes priority over NoBordersInBody |
| if (flags & ImGuiTableFlags_NoBordersInBodyUntilResize) |
| flags &= ~ImGuiTableFlags_NoBordersInBody; |
| |
| // Adjust flags: disable saved settings if there's nothing to save |
| if ((flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Sortable)) == 0) |
| flags |= ImGuiTableFlags_NoSavedSettings; |
| |
| // Inherit _NoSavedSettings from top-level window (child windows always have _NoSavedSettings set) |
| if (outer_window->RootWindow->Flags & ImGuiWindowFlags_NoSavedSettings) |
| flags |= ImGuiTableFlags_NoSavedSettings; |
| |
| return flags; |
| } |
| |
| ImGuiTable* ImGui::TableFindByID(ImGuiID id) |
| { |
| ImGuiContext& g = *GImGui; |
| return g.Tables.GetByKey(id); |
| } |
| |
| // Read about "TABLE SIZING" at the top of this file. |
| bool ImGui::BeginTable(const char* str_id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width) |
| { |
| ImGuiID id = GetID(str_id); |
| return BeginTableEx(str_id, id, columns_count, flags, outer_size, inner_width); |
| } |
| |
| bool ImGui::BeginTableEx(const char* name, ImGuiID id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiWindow* outer_window = GetCurrentWindow(); |
| if (outer_window->SkipItems) // Consistent with other tables + beneficial side effect that assert on miscalling EndTable() will be more visible. |
| return false; |
| |
| // Sanity checks |
| IM_ASSERT(columns_count > 0 && columns_count < IMGUI_TABLE_MAX_COLUMNS); |
| if (flags & ImGuiTableFlags_ScrollX) |
| IM_ASSERT(inner_width >= 0.0f); |
| |
| // If an outer size is specified ahead we will be able to early out when not visible. Exact clipping criteria may evolve. |
| // FIXME: coarse clipping because access to table data causes two issues: |
| // - instance numbers varying/unstable. may not be a direct problem for users, but could make outside access broken or confusing, e.g. TestEngine. |
| // - can't implement support for ImGuiChildFlags_ResizeY as we need to somehow pull the height data from somewhere. this also needs stable instance numbers. |
| // The side-effects of accessing table data on coarse clip would be: |
| // - always reserving the pooled ImGuiTable data ahead for a fully clipped table (minor IMHO). Also the 'outer_window_is_measuring_size' criteria may already be defeating this in some situations. |
| // - always performing the GetOrAddByKey() O(log N) query in g.Tables.Map[]. |
| const bool use_child_window = (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) != 0; |
| const ImVec2 avail_size = GetContentRegionAvail(); |
| const ImVec2 actual_outer_size = CalcItemSize(outer_size, ImMax(avail_size.x, 1.0f), use_child_window ? ImMax(avail_size.y, 1.0f) : 0.0f); |
| const ImRect outer_rect(outer_window->DC.CursorPos, outer_window->DC.CursorPos + actual_outer_size); |
| const bool outer_window_is_measuring_size = (outer_window->AutoFitFramesX > 0) || (outer_window->AutoFitFramesY > 0); // Doesn't apply to AlwaysAutoResize windows! |
| if (use_child_window && IsClippedEx(outer_rect, 0) && !outer_window_is_measuring_size) |
| { |
| ItemSize(outer_rect); |
| ItemAdd(outer_rect, id); |
| return false; |
| } |
| |
| // [DEBUG] Debug break requested by user |
| if (g.DebugBreakInTable == id) |
| IM_DEBUG_BREAK(); |
| |
| // Acquire storage for the table |
| ImGuiTable* table = g.Tables.GetOrAddByKey(id); |
| |
| // Acquire temporary buffers |
| const int table_idx = g.Tables.GetIndex(table); |
| if (++g.TablesTempDataStacked > g.TablesTempData.Size) |
| g.TablesTempData.resize(g.TablesTempDataStacked, ImGuiTableTempData()); |
| ImGuiTableTempData* temp_data = table->TempData = &g.TablesTempData[g.TablesTempDataStacked - 1]; |
| temp_data->TableIndex = table_idx; |
| table->DrawSplitter = &table->TempData->DrawSplitter; |
| table->DrawSplitter->Clear(); |
| |
| // Fix flags |
| table->IsDefaultSizingPolicy = (flags & ImGuiTableFlags_SizingMask_) == 0; |
| flags = TableFixFlags(flags, outer_window); |
| |
| // Initialize |
| const int previous_frame_active = table->LastFrameActive; |
| const int instance_no = (previous_frame_active != g.FrameCount) ? 0 : table->InstanceCurrent + 1; |
| const ImGuiTableFlags previous_flags = table->Flags; |
| table->ID = id; |
| table->Flags = flags; |
| table->LastFrameActive = g.FrameCount; |
| table->OuterWindow = table->InnerWindow = outer_window; |
| table->ColumnsCount = columns_count; |
| table->IsLayoutLocked = false; |
| table->InnerWidth = inner_width; |
| temp_data->UserOuterSize = outer_size; |
| |
| // Instance data (for instance 0, TableID == TableInstanceID) |
| ImGuiID instance_id; |
| table->InstanceCurrent = (ImS16)instance_no; |
| if (instance_no > 0) |
| { |
| IM_ASSERT(table->ColumnsCount == columns_count && "BeginTable(): Cannot change columns count mid-frame while preserving same ID"); |
| if (table->InstanceDataExtra.Size < instance_no) |
| table->InstanceDataExtra.push_back(ImGuiTableInstanceData()); |
| instance_id = GetIDWithSeed(instance_no, GetIDWithSeed("##Instances", NULL, id)); // Push "##Instances" followed by (int)instance_no in ID stack. |
| } |
| else |
| { |
| instance_id = id; |
| } |
| ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); |
| table_instance->TableInstanceID = instance_id; |
| |
| // When not using a child window, WorkRect.Max will grow as we append contents. |
| if (use_child_window) |
| { |
| // Ensure no vertical scrollbar appears if we only want horizontal one, to make flag consistent |
| // (we have no other way to disable vertical scrollbar of a window while keeping the horizontal one showing) |
| ImVec2 override_content_size(FLT_MAX, FLT_MAX); |
| if ((flags & ImGuiTableFlags_ScrollX) && !(flags & ImGuiTableFlags_ScrollY)) |
| override_content_size.y = FLT_MIN; |
| |
| // Ensure specified width (when not specified, Stretched columns will act as if the width == OuterWidth and |
| // never lead to any scrolling). We don't handle inner_width < 0.0f, we could potentially use it to right-align |
| // based on the right side of the child window work rect, which would require knowing ahead if we are going to |
| // have decoration taking horizontal spaces (typically a vertical scrollbar). |
| if ((flags & ImGuiTableFlags_ScrollX) && inner_width > 0.0f) |
| override_content_size.x = inner_width; |
| |
| if (override_content_size.x != FLT_MAX || override_content_size.y != FLT_MAX) |
| SetNextWindowContentSize(ImVec2(override_content_size.x != FLT_MAX ? override_content_size.x : 0.0f, override_content_size.y != FLT_MAX ? override_content_size.y : 0.0f)); |
| |
| // Reset scroll if we are reactivating it |
| if ((previous_flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) == 0) |
| SetNextWindowScroll(ImVec2(0.0f, 0.0f)); |
| |
| // Create scrolling region (without border and zero window padding) |
| ImGuiWindowFlags child_window_flags = (flags & ImGuiTableFlags_ScrollX) ? ImGuiWindowFlags_HorizontalScrollbar : ImGuiWindowFlags_None; |
| BeginChildEx(name, instance_id, outer_rect.GetSize(), ImGuiChildFlags_None, child_window_flags); |
| table->InnerWindow = g.CurrentWindow; |
| table->WorkRect = table->InnerWindow->WorkRect; |
| table->OuterRect = table->InnerWindow->Rect(); |
| table->InnerRect = table->InnerWindow->InnerRect; |
| IM_ASSERT(table->InnerWindow->WindowPadding.x == 0.0f && table->InnerWindow->WindowPadding.y == 0.0f && table->InnerWindow->WindowBorderSize == 0.0f); |
| |
| // Allow submitting when host is measuring |
| if (table->InnerWindow->SkipItems && outer_window_is_measuring_size) |
| table->InnerWindow->SkipItems = false; |
| |
| // When using multiple instances, ensure they have the same amount of horizontal decorations (aka vertical scrollbar) so stretched columns can be aligned) |
| if (instance_no == 0) |
| { |
| table->HasScrollbarYPrev = table->HasScrollbarYCurr; |
| table->HasScrollbarYCurr = false; |
| } |
| table->HasScrollbarYCurr |= table->InnerWindow->ScrollbarY; |
| } |
| else |
| { |
| // For non-scrolling tables, WorkRect == OuterRect == InnerRect. |
| // But at this point we do NOT have a correct value for .Max.y (unless a height has been explicitly passed in). It will only be updated in EndTable(). |
| table->WorkRect = table->OuterRect = table->InnerRect = outer_rect; |
| table->HasScrollbarYPrev = table->HasScrollbarYCurr = false; |
| } |
| |
| // Push a standardized ID for both child-using and not-child-using tables |
| PushOverrideID(id); |
| if (instance_no > 0) |
| PushOverrideID(instance_id); // FIXME: Somehow this is not resolved by stack-tool, even tho GetIDWithSeed() submitted the symbol. |
| |
| // Backup a copy of host window members we will modify |
| ImGuiWindow* inner_window = table->InnerWindow; |
| table->HostIndentX = inner_window->DC.Indent.x; |
| table->HostClipRect = inner_window->ClipRect; |
| table->HostSkipItems = inner_window->SkipItems; |
| temp_data->HostBackupWorkRect = inner_window->WorkRect; |
| temp_data->HostBackupParentWorkRect = inner_window->ParentWorkRect; |
| temp_data->HostBackupColumnsOffset = outer_window->DC.ColumnsOffset; |
| temp_data->HostBackupPrevLineSize = inner_window->DC.PrevLineSize; |
| temp_data->HostBackupCurrLineSize = inner_window->DC.CurrLineSize; |
| temp_data->HostBackupCursorMaxPos = inner_window->DC.CursorMaxPos; |
| temp_data->HostBackupItemWidth = outer_window->DC.ItemWidth; |
| temp_data->HostBackupItemWidthStackSize = outer_window->DC.ItemWidthStack.Size; |
| inner_window->DC.PrevLineSize = inner_window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); |
| |
| // Make borders not overlap our contents by offsetting HostClipRect (#6765, #7428, #3752) |
| // (we normally shouldn't alter HostClipRect as we rely on TableMergeDrawChannels() expanding non-clipped column toward the |
| // limits of that rectangle, in order for ImDrawListSplitter::Merge() to merge the draw commands. However since the overlap |
| // problem only affect scrolling tables in this case we can get away with doing it without extra cost). |
| if (inner_window != outer_window) |
| { |
| // FIXME: Because inner_window's Scrollbar doesn't know about border size, since it's not encoded in window->WindowBorderSize, |
| // it already overlaps it and doesn't need an extra offset. Ideally we should be able to pass custom border size with |
| // different x/y values to BeginChild(). |
| if (flags & ImGuiTableFlags_BordersOuterV) |
| { |
| table->HostClipRect.Min.x = ImMin(table->HostClipRect.Min.x + TABLE_BORDER_SIZE, table->HostClipRect.Max.x); |
| if (inner_window->DecoOuterSizeX2 == 0.0f) |
| table->HostClipRect.Max.x = ImMax(table->HostClipRect.Max.x - TABLE_BORDER_SIZE, table->HostClipRect.Min.x); |
| } |
| if (flags & ImGuiTableFlags_BordersOuterH) |
| { |
| table->HostClipRect.Min.y = ImMin(table->HostClipRect.Min.y + TABLE_BORDER_SIZE, table->HostClipRect.Max.y); |
| if (inner_window->DecoOuterSizeY2 == 0.0f) |
| table->HostClipRect.Max.y = ImMax(table->HostClipRect.Max.y - TABLE_BORDER_SIZE, table->HostClipRect.Min.y); |
| } |
| } |
| |
| // Padding and Spacing |
| // - None ........Content..... Pad .....Content........ |
| // - PadOuter | Pad ..Content..... Pad .....Content.. Pad | |
| // - PadInner ........Content.. Pad | Pad ..Content........ |
| // - PadOuter+PadInner | Pad ..Content.. Pad | Pad ..Content.. Pad | |
| const bool pad_outer_x = (flags & ImGuiTableFlags_NoPadOuterX) ? false : (flags & ImGuiTableFlags_PadOuterX) ? true : (flags & ImGuiTableFlags_BordersOuterV) != 0; |
| const bool pad_inner_x = (flags & ImGuiTableFlags_NoPadInnerX) ? false : true; |
| const float inner_spacing_for_border = (flags & ImGuiTableFlags_BordersInnerV) ? TABLE_BORDER_SIZE : 0.0f; |
| const float inner_spacing_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) == 0) ? g.Style.CellPadding.x : 0.0f; |
| const float inner_padding_explicit = (pad_inner_x && (flags & ImGuiTableFlags_BordersInnerV) != 0) ? g.Style.CellPadding.x : 0.0f; |
| table->CellSpacingX1 = inner_spacing_explicit + inner_spacing_for_border; |
| table->CellSpacingX2 = inner_spacing_explicit; |
| table->CellPaddingX = inner_padding_explicit; |
| |
| const float outer_padding_for_border = (flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f; |
| const float outer_padding_explicit = pad_outer_x ? g.Style.CellPadding.x : 0.0f; |
| table->OuterPaddingX = (outer_padding_for_border + outer_padding_explicit) - table->CellPaddingX; |
| |
| table->CurrentColumn = -1; |
| table->CurrentRow = -1; |
| table->RowBgColorCounter = 0; |
| table->LastRowFlags = ImGuiTableRowFlags_None; |
| table->InnerClipRect = (inner_window == outer_window) ? table->WorkRect : inner_window->ClipRect; |
| table->InnerClipRect.ClipWith(table->WorkRect); // We need this to honor inner_width |
| table->InnerClipRect.ClipWithFull(table->HostClipRect); |
| table->InnerClipRect.Max.y = (flags & ImGuiTableFlags_NoHostExtendY) ? ImMin(table->InnerClipRect.Max.y, inner_window->WorkRect.Max.y) : table->HostClipRect.Max.y; |
| |
| table->RowPosY1 = table->RowPosY2 = table->WorkRect.Min.y; // This is needed somehow |
| table->RowTextBaseline = 0.0f; // This will be cleared again by TableBeginRow() |
| table->RowCellPaddingY = 0.0f; |
| table->FreezeRowsRequest = table->FreezeRowsCount = 0; // This will be setup by TableSetupScrollFreeze(), if any |
| table->FreezeColumnsRequest = table->FreezeColumnsCount = 0; |
| table->IsUnfrozenRows = true; |
| table->DeclColumnsCount = table->AngledHeadersCount = 0; |
| if (previous_frame_active + 1 < g.FrameCount) |
| table->IsActiveIdInTable = false; |
| table->AngledHeadersHeight = 0.0f; |
| temp_data->AngledHeadersExtraWidth = 0.0f; |
| |
| // Using opaque colors facilitate overlapping lines of the grid, otherwise we'd need to improve TableDrawBorders() |
| table->BorderColorStrong = GetColorU32(ImGuiCol_TableBorderStrong); |
| table->BorderColorLight = GetColorU32(ImGuiCol_TableBorderLight); |
| |
| // Make table current |
| g.CurrentTable = table; |
| outer_window->DC.NavIsScrollPushableX = false; // Shortcut for NavUpdateCurrentWindowIsScrollPushableX(); |
| outer_window->DC.CurrentTableIdx = table_idx; |
| if (inner_window != outer_window) // So EndChild() within the inner window can restore the table properly. |
| inner_window->DC.CurrentTableIdx = table_idx; |
| |
| if ((previous_flags & ImGuiTableFlags_Reorderable) && (flags & ImGuiTableFlags_Reorderable) == 0) |
| table->IsResetDisplayOrderRequest = true; |
| |
| // Mark as used to avoid GC |
| if (table_idx >= g.TablesLastTimeActive.Size) |
| g.TablesLastTimeActive.resize(table_idx + 1, -1.0f); |
| g.TablesLastTimeActive[table_idx] = (float)g.Time; |
| temp_data->LastTimeActive = (float)g.Time; |
| table->MemoryCompacted = false; |
| |
| // Setup memory buffer (clear data if columns count changed) |
| ImGuiTableColumn* old_columns_to_preserve = NULL; |
| void* old_columns_raw_data = NULL; |
| const int old_columns_count = table->Columns.size(); |
| if (old_columns_count != 0 && old_columns_count != columns_count) |
| { |
| // Attempt to preserve width on column count change (#4046) |
| old_columns_to_preserve = table->Columns.Data; |
| old_columns_raw_data = table->RawData; |
| table->RawData = NULL; |
| } |
| if (table->RawData == NULL) |
| { |
| TableBeginInitMemory(table, columns_count); |
| table->IsInitializing = table->IsSettingsRequestLoad = true; |
| } |
| if (table->IsResetAllRequest) |
| TableResetSettings(table); |
| if (table->IsInitializing) |
| { |
| // Initialize |
| table->SettingsOffset = -1; |
| table->IsSortSpecsDirty = true; |
| table->InstanceInteracted = -1; |
| table->ContextPopupColumn = -1; |
| table->ReorderColumn = table->ResizedColumn = table->LastResizedColumn = -1; |
| table->AutoFitSingleColumn = -1; |
| table->HoveredColumnBody = table->HoveredColumnBorder = -1; |
| for (int n = 0; n < columns_count; n++) |
| { |
| ImGuiTableColumn* column = &table->Columns[n]; |
| if (old_columns_to_preserve && n < old_columns_count) |
| { |
| // FIXME: We don't attempt to preserve column order in this path. |
| *column = old_columns_to_preserve[n]; |
| } |
| else |
| { |
| float width_auto = column->WidthAuto; |
| *column = ImGuiTableColumn(); |
| column->WidthAuto = width_auto; |
| column->IsPreserveWidthAuto = true; // Preserve WidthAuto when reinitializing a live table: not technically necessary but remove a visible flicker |
| column->IsEnabled = column->IsUserEnabled = column->IsUserEnabledNextFrame = true; |
| } |
| column->DisplayOrder = table->DisplayOrderToIndex[n] = (ImGuiTableColumnIdx)n; |
| } |
| } |
| if (old_columns_raw_data) |
| IM_FREE(old_columns_raw_data); |
| |
| // Load settings |
| if (table->IsSettingsRequestLoad) |
| TableLoadSettings(table); |
| |
| // Handle DPI/font resize |
| // This is designed to facilitate DPI changes with the assumption that e.g. style.CellPadding has been scaled as well. |
| // It will also react to changing fonts with mixed results. It doesn't need to be perfect but merely provide a decent transition. |
| // FIXME-DPI: Provide consistent standards for reference size. Perhaps using g.CurrentDpiScale would be more self explanatory. |
| // This is will lead us to non-rounded WidthRequest in columns, which should work but is a poorly tested path. |
| const float new_ref_scale_unit = g.FontSize; // g.Font->GetCharAdvance('A') ? |
| if (table->RefScale != 0.0f && table->RefScale != new_ref_scale_unit) |
| { |
| const float scale_factor = new_ref_scale_unit / table->RefScale; |
| //IMGUI_DEBUG_PRINT("[table] %08X RefScaleUnit %.3f -> %.3f, scaling width by %.3f\n", table->ID, table->RefScaleUnit, new_ref_scale_unit, scale_factor); |
| for (int n = 0; n < columns_count; n++) |
| table->Columns[n].WidthRequest = table->Columns[n].WidthRequest * scale_factor; |
| } |
| table->RefScale = new_ref_scale_unit; |
| |
| // Disable output until user calls TableNextRow() or TableNextColumn() leading to the TableUpdateLayout() call.. |
| // This is not strictly necessary but will reduce cases were "out of table" output will be misleading to the user. |
| // Because we cannot safely assert in EndTable() when no rows have been created, this seems like our best option. |
| inner_window->SkipItems = true; |
| |
| // Clear names |
| // At this point the ->NameOffset field of each column will be invalid until TableUpdateLayout() or the first call to TableSetupColumn() |
| if (table->ColumnsNames.Buf.Size > 0) |
| table->ColumnsNames.Buf.resize(0); |
| |
| // Apply queued resizing/reordering/hiding requests |
| TableBeginApplyRequests(table); |
| |
| return true; |
| } |
| |
| // For reference, the average total _allocation count_ for a table is: |
| // + 0 (for ImGuiTable instance, we are pooling allocations in g.Tables[]) |
| // + 1 (for table->RawData allocated below) |
| // + 1 (for table->ColumnsNames, if names are used) |
| // Shared allocations for the maximum number of simultaneously nested tables (generally a very small number) |
| // + 1 (for table->Splitter._Channels) |
| // + 2 * active_channels_count (for ImDrawCmd and ImDrawIdx buffers inside channels) |
| // Where active_channels_count is variable but often == columns_count or == columns_count + 1, see TableSetupDrawChannels() for details. |
| // Unused channels don't perform their +2 allocations. |
| void ImGui::TableBeginInitMemory(ImGuiTable* table, int columns_count) |
| { |
| // Allocate single buffer for our arrays |
| const int columns_bit_array_size = (int)ImBitArrayGetStorageSizeInBytes(columns_count); |
| ImSpanAllocator<6> span_allocator; |
| span_allocator.Reserve(0, columns_count * sizeof(ImGuiTableColumn)); |
| span_allocator.Reserve(1, columns_count * sizeof(ImGuiTableColumnIdx)); |
| span_allocator.Reserve(2, columns_count * sizeof(ImGuiTableCellData), 4); |
| for (int n = 3; n < 6; n++) |
| span_allocator.Reserve(n, columns_bit_array_size); |
| table->RawData = IM_ALLOC(span_allocator.GetArenaSizeInBytes()); |
| memset(table->RawData, 0, span_allocator.GetArenaSizeInBytes()); |
| span_allocator.SetArenaBasePtr(table->RawData); |
| span_allocator.GetSpan(0, &table->Columns); |
| span_allocator.GetSpan(1, &table->DisplayOrderToIndex); |
| span_allocator.GetSpan(2, &table->RowCellData); |
| table->EnabledMaskByDisplayOrder = (ImU32*)span_allocator.GetSpanPtrBegin(3); |
| table->EnabledMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(4); |
| table->VisibleMaskByIndex = (ImU32*)span_allocator.GetSpanPtrBegin(5); |
| } |
| |
| // Apply queued resizing/reordering/hiding requests |
| void ImGui::TableBeginApplyRequests(ImGuiTable* table) |
| { |
| // Handle resizing request |
| // (We process this in the TableBegin() of the first instance of each table) |
| // FIXME-TABLE: Contains columns if our work area doesn't allow for scrolling? |
| if (table->InstanceCurrent == 0) |
| { |
| if (table->ResizedColumn != -1 && table->ResizedColumnNextWidth != FLT_MAX) |
| TableSetColumnWidth(table->ResizedColumn, table->ResizedColumnNextWidth); |
| table->LastResizedColumn = table->ResizedColumn; |
| table->ResizedColumnNextWidth = FLT_MAX; |
| table->ResizedColumn = -1; |
| |
| // Process auto-fit for single column, which is a special case for stretch columns and fixed columns with FixedSame policy. |
| // FIXME-TABLE: Would be nice to redistribute available stretch space accordingly to other weights, instead of giving it all to siblings. |
| if (table->AutoFitSingleColumn != -1) |
| { |
| TableSetColumnWidth(table->AutoFitSingleColumn, table->Columns[table->AutoFitSingleColumn].WidthAuto); |
| table->AutoFitSingleColumn = -1; |
| } |
| } |
| |
| // Handle reordering request |
| // Note: we don't clear ReorderColumn after handling the request. |
| if (table->InstanceCurrent == 0) |
| { |
| if (table->HeldHeaderColumn == -1 && table->ReorderColumn != -1) |
| table->ReorderColumn = -1; |
| table->HeldHeaderColumn = -1; |
| if (table->ReorderColumn != -1 && table->ReorderColumnDir != 0) |
| { |
| // We need to handle reordering across hidden columns. |
| // In the configuration below, moving C to the right of E will lead to: |
| // ... C [D] E ---> ... [D] E C (Column name/index) |
| // ... 2 3 4 ... 2 3 4 (Display order) |
| const int reorder_dir = table->ReorderColumnDir; |
| IM_ASSERT(reorder_dir == -1 || reorder_dir == +1); |
| IM_ASSERT(table->Flags & ImGuiTableFlags_Reorderable); |
| ImGuiTableColumn* src_column = &table->Columns[table->ReorderColumn]; |
| ImGuiTableColumn* dst_column = &table->Columns[(reorder_dir == -1) ? src_column->PrevEnabledColumn : src_column->NextEnabledColumn]; |
| IM_UNUSED(dst_column); |
| const int src_order = src_column->DisplayOrder; |
| const int dst_order = dst_column->DisplayOrder; |
| src_column->DisplayOrder = (ImGuiTableColumnIdx)dst_order; |
| for (int order_n = src_order + reorder_dir; order_n != dst_order + reorder_dir; order_n += reorder_dir) |
| table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder -= (ImGuiTableColumnIdx)reorder_dir; |
| IM_ASSERT(dst_column->DisplayOrder == dst_order - reorder_dir); |
| |
| // Display order is stored in both columns->IndexDisplayOrder and table->DisplayOrder[]. Rebuild later from the former. |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImGuiTableColumnIdx)column_n; |
| table->ReorderColumnDir = 0; |
| table->IsSettingsDirty = true; |
| } |
| } |
| |
| // Handle display order reset request |
| if (table->IsResetDisplayOrderRequest) |
| { |
| for (int n = 0; n < table->ColumnsCount; n++) |
| table->DisplayOrderToIndex[n] = table->Columns[n].DisplayOrder = (ImGuiTableColumnIdx)n; |
| table->IsResetDisplayOrderRequest = false; |
| table->IsSettingsDirty = true; |
| } |
| } |
| |
| // Adjust flags: default width mode + stretch columns are not allowed when auto extending |
| static void TableSetupColumnFlags(ImGuiTable* table, ImGuiTableColumn* column, ImGuiTableColumnFlags flags_in) |
| { |
| ImGuiTableColumnFlags flags = flags_in; |
| |
| // Sizing Policy |
| if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0) |
| { |
| const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_); |
| if (table_sizing_policy == ImGuiTableFlags_SizingFixedFit || table_sizing_policy == ImGuiTableFlags_SizingFixedSame) |
| flags |= ImGuiTableColumnFlags_WidthFixed; |
| else |
| flags |= ImGuiTableColumnFlags_WidthStretch; |
| } |
| else |
| { |
| IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_WidthMask_)); // Check that only 1 of each set is used. |
| } |
| |
| // Resize |
| if ((table->Flags & ImGuiTableFlags_Resizable) == 0) |
| flags |= ImGuiTableColumnFlags_NoResize; |
| |
| // Sorting |
| if ((flags & ImGuiTableColumnFlags_NoSortAscending) && (flags & ImGuiTableColumnFlags_NoSortDescending)) |
| flags |= ImGuiTableColumnFlags_NoSort; |
| |
| // Indentation |
| if ((flags & ImGuiTableColumnFlags_IndentMask_) == 0) |
| flags |= (table->Columns.index_from_ptr(column) == 0) ? ImGuiTableColumnFlags_IndentEnable : ImGuiTableColumnFlags_IndentDisable; |
| |
| // Alignment |
| //if ((flags & ImGuiTableColumnFlags_AlignMask_) == 0) |
| // flags |= ImGuiTableColumnFlags_AlignCenter; |
| //IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_AlignMask_)); // Check that only 1 of each set is used. |
| |
| // Preserve status flags |
| column->Flags = flags | (column->Flags & ImGuiTableColumnFlags_StatusMask_); |
| |
| // Build an ordered list of available sort directions |
| column->SortDirectionsAvailCount = column->SortDirectionsAvailMask = column->SortDirectionsAvailList = 0; |
| if (table->Flags & ImGuiTableFlags_Sortable) |
| { |
| int count = 0, mask = 0, list = 0; |
| if ((flags & ImGuiTableColumnFlags_PreferSortAscending) != 0 && (flags & ImGuiTableColumnFlags_NoSortAscending) == 0) { mask |= 1 << ImGuiSortDirection_Ascending; list |= ImGuiSortDirection_Ascending << (count << 1); count++; } |
| if ((flags & ImGuiTableColumnFlags_PreferSortDescending) != 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; } |
| if ((flags & ImGuiTableColumnFlags_PreferSortAscending) == 0 && (flags & ImGuiTableColumnFlags_NoSortAscending) == 0) { mask |= 1 << ImGuiSortDirection_Ascending; list |= ImGuiSortDirection_Ascending << (count << 1); count++; } |
| if ((flags & ImGuiTableColumnFlags_PreferSortDescending) == 0 && (flags & ImGuiTableColumnFlags_NoSortDescending) == 0) { mask |= 1 << ImGuiSortDirection_Descending; list |= ImGuiSortDirection_Descending << (count << 1); count++; } |
| if ((table->Flags & ImGuiTableFlags_SortTristate) || count == 0) { mask |= 1 << ImGuiSortDirection_None; count++; } |
| column->SortDirectionsAvailList = (ImU8)list; |
| column->SortDirectionsAvailMask = (ImU8)mask; |
| column->SortDirectionsAvailCount = (ImU8)count; |
| ImGui::TableFixColumnSortDirection(table, column); |
| } |
| } |
| |
| // Layout columns for the frame. This is in essence the followup to BeginTable() and this is our largest function. |
| // Runs on the first call to TableNextRow(), to give a chance for TableSetupColumn() and other TableSetupXXXXX() functions to be called first. |
| // FIXME-TABLE: Our width (and therefore our WorkRect) will be minimal in the first frame for _WidthAuto columns. |
| // Increase feedback side-effect with widgets relying on WorkRect.Max.x... Maybe provide a default distribution for _WidthAuto columns? |
| void ImGui::TableUpdateLayout(ImGuiTable* table) |
| { |
| ImGuiContext& g = *GImGui; |
| IM_ASSERT(table->IsLayoutLocked == false); |
| |
| const ImGuiTableFlags table_sizing_policy = (table->Flags & ImGuiTableFlags_SizingMask_); |
| table->IsDefaultDisplayOrder = true; |
| table->ColumnsEnabledCount = 0; |
| ImBitArrayClearAllBits(table->EnabledMaskByIndex, table->ColumnsCount); |
| ImBitArrayClearAllBits(table->EnabledMaskByDisplayOrder, table->ColumnsCount); |
| table->LeftMostEnabledColumn = -1; |
| table->MinColumnWidth = ImMax(1.0f, g.Style.FramePadding.x * 1.0f); // g.Style.ColumnsMinSpacing; // FIXME-TABLE |
| |
| // [Part 1] Apply/lock Enabled and Order states. Calculate auto/ideal width for columns. Count fixed/stretch columns. |
| // Process columns in their visible orders as we are building the Prev/Next indices. |
| int count_fixed = 0; // Number of columns that have fixed sizing policies |
| int count_stretch = 0; // Number of columns that have stretch sizing policies |
| int prev_visible_column_idx = -1; |
| bool has_auto_fit_request = false; |
| bool has_resizable = false; |
| float stretch_sum_width_auto = 0.0f; |
| float fixed_max_width_auto = 0.0f; |
| for (int order_n = 0; order_n < table->ColumnsCount; order_n++) |
| { |
| const int column_n = table->DisplayOrderToIndex[order_n]; |
| if (column_n != order_n) |
| table->IsDefaultDisplayOrder = false; |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| |
| // Clear column setup if not submitted by user. Currently we make it mandatory to call TableSetupColumn() every frame. |
| // It would easily work without but we're not ready to guarantee it since e.g. names need resubmission anyway. |
| // We take a slight shortcut but in theory we could be calling TableSetupColumn() here with dummy values, it should yield the same effect. |
| if (table->DeclColumnsCount <= column_n) |
| { |
| TableSetupColumnFlags(table, column, ImGuiTableColumnFlags_None); |
| column->NameOffset = -1; |
| column->UserID = 0; |
| column->InitStretchWeightOrWidth = -1.0f; |
| } |
| |
| // Update Enabled state, mark settings and sort specs dirty |
| if (!(table->Flags & ImGuiTableFlags_Hideable) || (column->Flags & ImGuiTableColumnFlags_NoHide)) |
| column->IsUserEnabledNextFrame = true; |
| if (column->IsUserEnabled != column->IsUserEnabledNextFrame) |
| { |
| column->IsUserEnabled = column->IsUserEnabledNextFrame; |
| table->IsSettingsDirty = true; |
| } |
| column->IsEnabled = column->IsUserEnabled && (column->Flags & ImGuiTableColumnFlags_Disabled) == 0; |
| |
| if (column->SortOrder != -1 && !column->IsEnabled) |
| table->IsSortSpecsDirty = true; |
| if (column->SortOrder > 0 && !(table->Flags & ImGuiTableFlags_SortMulti)) |
| table->IsSortSpecsDirty = true; |
| |
| // Auto-fit unsized columns |
| const bool start_auto_fit = (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? (column->WidthRequest < 0.0f) : (column->StretchWeight < 0.0f); |
| if (start_auto_fit) |
| column->AutoFitQueue = column->CannotSkipItemsQueue = (1 << 3) - 1; // Fit for three frames |
| |
| if (!column->IsEnabled) |
| { |
| column->IndexWithinEnabledSet = -1; |
| continue; |
| } |
| |
| // Mark as enabled and link to previous/next enabled column |
| column->PrevEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx; |
| column->NextEnabledColumn = -1; |
| if (prev_visible_column_idx != -1) |
| table->Columns[prev_visible_column_idx].NextEnabledColumn = (ImGuiTableColumnIdx)column_n; |
| else |
| table->LeftMostEnabledColumn = (ImGuiTableColumnIdx)column_n; |
| column->IndexWithinEnabledSet = table->ColumnsEnabledCount++; |
| ImBitArraySetBit(table->EnabledMaskByIndex, column_n); |
| ImBitArraySetBit(table->EnabledMaskByDisplayOrder, column->DisplayOrder); |
| prev_visible_column_idx = column_n; |
| IM_ASSERT(column->IndexWithinEnabledSet <= column->DisplayOrder); |
| |
| // Calculate ideal/auto column width (that's the width required for all contents to be visible without clipping) |
| // Combine width from regular rows + width from headers unless requested not to. |
| if (!column->IsPreserveWidthAuto) |
| column->WidthAuto = TableGetColumnWidthAuto(table, column); |
| |
| // Non-resizable columns keep their requested width (apply user value regardless of IsPreserveWidthAuto) |
| const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0; |
| if (column_is_resizable) |
| has_resizable = true; |
| if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f && !column_is_resizable) |
| column->WidthAuto = column->InitStretchWeightOrWidth; |
| |
| if (column->AutoFitQueue != 0x00) |
| has_auto_fit_request = true; |
| if (column->Flags & ImGuiTableColumnFlags_WidthStretch) |
| { |
| stretch_sum_width_auto += column->WidthAuto; |
| count_stretch++; |
| } |
| else |
| { |
| fixed_max_width_auto = ImMax(fixed_max_width_auto, column->WidthAuto); |
| count_fixed++; |
| } |
| } |
| if ((table->Flags & ImGuiTableFlags_Sortable) && table->SortSpecsCount == 0 && !(table->Flags & ImGuiTableFlags_SortTristate)) |
| table->IsSortSpecsDirty = true; |
| table->RightMostEnabledColumn = (ImGuiTableColumnIdx)prev_visible_column_idx; |
| IM_ASSERT(table->LeftMostEnabledColumn >= 0 && table->RightMostEnabledColumn >= 0); |
| |
| // [Part 2] Disable child window clipping while fitting columns. This is not strictly necessary but makes it possible to avoid |
| // the column fitting having to wait until the first visible frame of the child container (may or not be a good thing). Also see #6510. |
| // FIXME-TABLE: for always auto-resizing columns may not want to do that all the time. |
| if (has_auto_fit_request && table->OuterWindow != table->InnerWindow) |
| table->InnerWindow->SkipItems = false; |
| if (has_auto_fit_request) |
| table->IsSettingsDirty = true; |
| |
| // [Part 3] Fix column flags and record a few extra information. |
| float sum_width_requests = 0.0f; // Sum of all width for fixed and auto-resize columns, excluding width contributed by Stretch columns but including spacing/padding. |
| float stretch_sum_weights = 0.0f; // Sum of all weights for stretch columns. |
| table->LeftMostStretchedColumn = table->RightMostStretchedColumn = -1; |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| { |
| if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) |
| continue; |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| |
| const bool column_is_resizable = (column->Flags & ImGuiTableColumnFlags_NoResize) == 0; |
| if (column->Flags & ImGuiTableColumnFlags_WidthFixed) |
| { |
| // Apply same widths policy |
| float width_auto = column->WidthAuto; |
| if (table_sizing_policy == ImGuiTableFlags_SizingFixedSame && (column->AutoFitQueue != 0x00 || !column_is_resizable)) |
| width_auto = fixed_max_width_auto; |
| |
| // Apply automatic width |
| // Latch initial size for fixed columns and update it constantly for auto-resizing column (unless clipped!) |
| if (column->AutoFitQueue != 0x00) |
| column->WidthRequest = width_auto; |
| else if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !column_is_resizable && column->IsRequestOutput) |
| column->WidthRequest = width_auto; |
| |
| // FIXME-TABLE: Increase minimum size during init frame to avoid biasing auto-fitting widgets |
| // (e.g. TextWrapped) too much. Otherwise what tends to happen is that TextWrapped would output a very |
| // large height (= first frame scrollbar display very off + clipper would skip lots of items). |
| // This is merely making the side-effect less extreme, but doesn't properly fixes it. |
| // FIXME: Move this to ->WidthGiven to avoid temporary lossyless? |
| // FIXME: This break IsPreserveWidthAuto from not flickering if the stored WidthAuto was smaller. |
| if (column->AutoFitQueue > 0x01 && table->IsInitializing && !column->IsPreserveWidthAuto) |
| column->WidthRequest = ImMax(column->WidthRequest, table->MinColumnWidth * 4.0f); // FIXME-TABLE: Another constant/scale? |
| sum_width_requests += column->WidthRequest; |
| } |
| else |
| { |
| // Initialize stretch weight |
| if (column->AutoFitQueue != 0x00 || column->StretchWeight < 0.0f || !column_is_resizable) |
| { |
| if (column->InitStretchWeightOrWidth > 0.0f) |
| column->StretchWeight = column->InitStretchWeightOrWidth; |
| else if (table_sizing_policy == ImGuiTableFlags_SizingStretchProp) |
| column->StretchWeight = (column->WidthAuto / stretch_sum_width_auto) * count_stretch; |
| else |
| column->StretchWeight = 1.0f; |
| } |
| |
| stretch_sum_weights += column->StretchWeight; |
| if (table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder > column->DisplayOrder) |
| table->LeftMostStretchedColumn = (ImGuiTableColumnIdx)column_n; |
| if (table->RightMostStretchedColumn == -1 || table->Columns[table->RightMostStretchedColumn].DisplayOrder < column->DisplayOrder) |
| table->RightMostStretchedColumn = (ImGuiTableColumnIdx)column_n; |
| } |
| column->IsPreserveWidthAuto = false; |
| sum_width_requests += table->CellPaddingX * 2.0f; |
| } |
| table->ColumnsEnabledFixedCount = (ImGuiTableColumnIdx)count_fixed; |
| table->ColumnsStretchSumWeights = stretch_sum_weights; |
| |
| // [Part 4] Apply final widths based on requested widths |
| const ImRect work_rect = table->WorkRect; |
| const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1); |
| const float width_removed = (table->HasScrollbarYPrev && !table->InnerWindow->ScrollbarY) ? g.Style.ScrollbarSize : 0.0f; // To synchronize decoration width of synched tables with mismatching scrollbar state (#5920) |
| const float width_avail = ImMax(1.0f, (((table->Flags & ImGuiTableFlags_ScrollX) && table->InnerWidth == 0.0f) ? table->InnerClipRect.GetWidth() : work_rect.GetWidth()) - width_removed); |
| const float width_avail_for_stretched_columns = width_avail - width_spacings - sum_width_requests; |
| float width_remaining_for_stretched_columns = width_avail_for_stretched_columns; |
| table->ColumnsGivenWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount; |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| { |
| if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) |
| continue; |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| |
| // Allocate width for stretched/weighted columns (StretchWeight gets converted into WidthRequest) |
| if (column->Flags & ImGuiTableColumnFlags_WidthStretch) |
| { |
| float weight_ratio = column->StretchWeight / stretch_sum_weights; |
| column->WidthRequest = IM_TRUNC(ImMax(width_avail_for_stretched_columns * weight_ratio, table->MinColumnWidth) + 0.01f); |
| width_remaining_for_stretched_columns -= column->WidthRequest; |
| } |
| |
| // [Resize Rule 1] The right-most Visible column is not resizable if there is at least one Stretch column |
| // See additional comments in TableSetColumnWidth(). |
| if (column->NextEnabledColumn == -1 && table->LeftMostStretchedColumn != -1) |
| column->Flags |= ImGuiTableColumnFlags_NoDirectResize_; |
| |
| // Assign final width, record width in case we will need to shrink |
| column->WidthGiven = ImTrunc(ImMax(column->WidthRequest, table->MinColumnWidth)); |
| table->ColumnsGivenWidth += column->WidthGiven; |
| } |
| |
| // [Part 5] Redistribute stretch remainder width due to rounding (remainder width is < 1.0f * number of Stretch column). |
| // Using right-to-left distribution (more likely to match resizing cursor). |
| if (width_remaining_for_stretched_columns >= 1.0f && !(table->Flags & ImGuiTableFlags_PreciseWidths)) |
| for (int order_n = table->ColumnsCount - 1; stretch_sum_weights > 0.0f && width_remaining_for_stretched_columns >= 1.0f && order_n >= 0; order_n--) |
| { |
| if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) |
| continue; |
| ImGuiTableColumn* column = &table->Columns[table->DisplayOrderToIndex[order_n]]; |
| if (!(column->Flags & ImGuiTableColumnFlags_WidthStretch)) |
| continue; |
| column->WidthRequest += 1.0f; |
| column->WidthGiven += 1.0f; |
| width_remaining_for_stretched_columns -= 1.0f; |
| } |
| |
| // Determine if table is hovered which will be used to flag columns as hovered. |
| // - In principle we'd like to use the equivalent of IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByActiveItem), |
| // but because our item is partially submitted at this point we use ItemHoverable() and a workaround (temporarily |
| // clear ActiveId, which is equivalent to the change provided by _AllowWhenBLockedByActiveItem). |
| // - This allows columns to be marked as hovered when e.g. clicking a button inside the column, or using drag and drop. |
| ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); |
| table_instance->HoveredRowLast = table_instance->HoveredRowNext; |
| table_instance->HoveredRowNext = -1; |
| table->HoveredColumnBody = table->HoveredColumnBorder = -1; |
| const ImRect mouse_hit_rect(table->OuterRect.Min.x, table->OuterRect.Min.y, table->OuterRect.Max.x, ImMax(table->OuterRect.Max.y, table->OuterRect.Min.y + table_instance->LastOuterHeight)); |
| const ImGuiID backup_active_id = g.ActiveId; |
| g.ActiveId = 0; |
| const bool is_hovering_table = ItemHoverable(mouse_hit_rect, 0, ImGuiItemFlags_None); |
| g.ActiveId = backup_active_id; |
| |
| // Determine skewed MousePos.x to support angled headers. |
| float mouse_skewed_x = g.IO.MousePos.x; |
| if (table->AngledHeadersHeight > 0.0f) |
| if (g.IO.MousePos.y >= table->OuterRect.Min.y && g.IO.MousePos.y <= table->OuterRect.Min.y + table->AngledHeadersHeight) |
| mouse_skewed_x += ImTrunc((table->OuterRect.Min.y + table->AngledHeadersHeight - g.IO.MousePos.y) * table->AngledHeadersSlope); |
| |
| // [Part 6] Setup final position, offset, skip/clip states and clipping rectangles, detect hovered column |
| // Process columns in their visible orders as we are comparing the visible order and adjusting host_clip_rect while looping. |
| int visible_n = 0; |
| bool has_at_least_one_column_requesting_output = false; |
| bool offset_x_frozen = (table->FreezeColumnsCount > 0); |
| float offset_x = ((table->FreezeColumnsCount > 0) ? table->OuterRect.Min.x : work_rect.Min.x) + table->OuterPaddingX - table->CellSpacingX1; |
| ImRect host_clip_rect = table->InnerClipRect; |
| //host_clip_rect.Max.x += table->CellPaddingX + table->CellSpacingX2; |
| ImBitArrayClearAllBits(table->VisibleMaskByIndex, table->ColumnsCount); |
| for (int order_n = 0; order_n < table->ColumnsCount; order_n++) |
| { |
| const int column_n = table->DisplayOrderToIndex[order_n]; |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| |
| column->NavLayerCurrent = (ImS8)(table->FreezeRowsCount > 0 ? ImGuiNavLayer_Menu : ImGuiNavLayer_Main); // Use Count NOT request so Header line changes layer when frozen |
| |
| if (offset_x_frozen && table->FreezeColumnsCount == visible_n) |
| { |
| offset_x += work_rect.Min.x - table->OuterRect.Min.x; |
| offset_x_frozen = false; |
| } |
| |
| // Clear status flags |
| column->Flags &= ~ImGuiTableColumnFlags_StatusMask_; |
| |
| if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) |
| { |
| // Hidden column: clear a few fields and we are done with it for the remainder of the function. |
| // We set a zero-width clip rect but set Min.y/Max.y properly to not interfere with the clipper. |
| column->MinX = column->MaxX = column->WorkMinX = column->ClipRect.Min.x = column->ClipRect.Max.x = offset_x; |
| column->WidthGiven = 0.0f; |
| column->ClipRect.Min.y = work_rect.Min.y; |
| column->ClipRect.Max.y = FLT_MAX; |
| column->ClipRect.ClipWithFull(host_clip_rect); |
| column->IsVisibleX = column->IsVisibleY = column->IsRequestOutput = false; |
| column->IsSkipItems = true; |
| column->ItemWidth = 1.0f; |
| continue; |
| } |
| |
| // Detect hovered column |
| if (is_hovering_table && mouse_skewed_x >= column->ClipRect.Min.x && mouse_skewed_x < column->ClipRect.Max.x) |
| table->HoveredColumnBody = (ImGuiTableColumnIdx)column_n; |
| |
| // Lock start position |
| column->MinX = offset_x; |
| |
| // Lock width based on start position and minimum/maximum width for this position |
| float max_width = TableGetMaxColumnWidth(table, column_n); |
| column->WidthGiven = ImMin(column->WidthGiven, max_width); |
| column->WidthGiven = ImMax(column->WidthGiven, ImMin(column->WidthRequest, table->MinColumnWidth)); |
| column->MaxX = offset_x + column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f; |
| |
| // Lock other positions |
| // - ClipRect.Min.x: Because merging draw commands doesn't compare min boundaries, we make ClipRect.Min.x match left bounds to be consistent regardless of merging. |
| // - ClipRect.Max.x: using WorkMaxX instead of MaxX (aka including padding) makes things more consistent when resizing down, tho slightly detrimental to visibility in very-small column. |
| // - ClipRect.Max.x: using MaxX makes it easier for header to receive hover highlight with no discontinuity and display sorting arrow. |
| // - FIXME-TABLE: We want equal width columns to have equal (ClipRect.Max.x - WorkMinX) width, which means ClipRect.max.x cannot stray off host_clip_rect.Max.x else right-most column may appear shorter. |
| const float previous_instance_work_min_x = column->WorkMinX; |
| column->WorkMinX = column->MinX + table->CellPaddingX + table->CellSpacingX1; |
| column->WorkMaxX = column->MaxX - table->CellPaddingX - table->CellSpacingX2; // Expected max |
| column->ItemWidth = ImTrunc(column->WidthGiven * 0.65f); |
| column->ClipRect.Min.x = column->MinX; |
| column->ClipRect.Min.y = work_rect.Min.y; |
| column->ClipRect.Max.x = column->MaxX; //column->WorkMaxX; |
| column->ClipRect.Max.y = FLT_MAX; |
| column->ClipRect.ClipWithFull(host_clip_rect); |
| |
| // Mark column as Clipped (not in sight) |
| // Note that scrolling tables (where inner_window != outer_window) handle Y clipped earlier in BeginTable() so IsVisibleY really only applies to non-scrolling tables. |
| // FIXME-TABLE: Because InnerClipRect.Max.y is conservatively ==outer_window->ClipRect.Max.y, we never can mark columns _Above_ the scroll line as not IsVisibleY. |
| // Taking advantage of LastOuterHeight would yield good results there... |
| // FIXME-TABLE: Y clipping is disabled because it effectively means not submitting will reduce contents width which is fed to outer_window->DC.CursorMaxPos.x, |
| // and this may be used (e.g. typically by outer_window using AlwaysAutoResize or outer_window's horizontal scrollbar, but could be something else). |
| // Possible solution to preserve last known content width for clipped column. Test 'table_reported_size' fails when enabling Y clipping and window is resized small. |
| column->IsVisibleX = (column->ClipRect.Max.x > column->ClipRect.Min.x); |
| column->IsVisibleY = true; // (column->ClipRect.Max.y > column->ClipRect.Min.y); |
| const bool is_visible = column->IsVisibleX; //&& column->IsVisibleY; |
| if (is_visible) |
| ImBitArraySetBit(table->VisibleMaskByIndex, column_n); |
| |
| // Mark column as requesting output from user. Note that fixed + non-resizable sets are auto-fitting at all times and therefore always request output. |
| column->IsRequestOutput = is_visible || column->AutoFitQueue != 0 || column->CannotSkipItemsQueue != 0; |
| |
| // Mark column as SkipItems (ignoring all items/layout) |
| // (table->HostSkipItems is a copy of inner_window->SkipItems before we cleared it above in Part 2) |
| column->IsSkipItems = !column->IsEnabled || table->HostSkipItems; |
| if (column->IsSkipItems) |
| IM_ASSERT(!is_visible); |
| if (column->IsRequestOutput && !column->IsSkipItems) |
| has_at_least_one_column_requesting_output = true; |
| |
| // Update status flags |
| column->Flags |= ImGuiTableColumnFlags_IsEnabled; |
| if (is_visible) |
| column->Flags |= ImGuiTableColumnFlags_IsVisible; |
| if (column->SortOrder != -1) |
| column->Flags |= ImGuiTableColumnFlags_IsSorted; |
| if (table->HoveredColumnBody == column_n) |
| column->Flags |= ImGuiTableColumnFlags_IsHovered; |
| |
| // Alignment |
| // FIXME-TABLE: This align based on the whole column width, not per-cell, and therefore isn't useful in |
| // many cases (to be able to honor this we might be able to store a log of cells width, per row, for |
| // visible rows, but nav/programmatic scroll would have visible artifacts.) |
| //if (column->Flags & ImGuiTableColumnFlags_AlignRight) |
| // column->WorkMinX = ImMax(column->WorkMinX, column->MaxX - column->ContentWidthRowsUnfrozen); |
| //else if (column->Flags & ImGuiTableColumnFlags_AlignCenter) |
| // column->WorkMinX = ImLerp(column->WorkMinX, ImMax(column->StartX, column->MaxX - column->ContentWidthRowsUnfrozen), 0.5f); |
| |
| // Reset content width variables |
| if (table->InstanceCurrent == 0) |
| { |
| column->ContentMaxXFrozen = column->WorkMinX; |
| column->ContentMaxXUnfrozen = column->WorkMinX; |
| column->ContentMaxXHeadersUsed = column->WorkMinX; |
| column->ContentMaxXHeadersIdeal = column->WorkMinX; |
| } |
| else |
| { |
| // As we store an absolute value to make per-cell updates faster, we need to offset values used for width computation. |
| const float offset_from_previous_instance = column->WorkMinX - previous_instance_work_min_x; |
| column->ContentMaxXFrozen += offset_from_previous_instance; |
| column->ContentMaxXUnfrozen += offset_from_previous_instance; |
| column->ContentMaxXHeadersUsed += offset_from_previous_instance; |
| column->ContentMaxXHeadersIdeal += offset_from_previous_instance; |
| } |
| |
| // Don't decrement auto-fit counters until container window got a chance to submit its items |
| if (table->HostSkipItems == false) |
| { |
| column->AutoFitQueue >>= 1; |
| column->CannotSkipItemsQueue >>= 1; |
| } |
| |
| if (visible_n < table->FreezeColumnsCount) |
| host_clip_rect.Min.x = ImClamp(column->MaxX + TABLE_BORDER_SIZE, host_clip_rect.Min.x, host_clip_rect.Max.x); |
| |
| offset_x += column->WidthGiven + table->CellSpacingX1 + table->CellSpacingX2 + table->CellPaddingX * 2.0f; |
| visible_n++; |
| } |
| |
| // In case the table is visible (e.g. decorations) but all columns clipped, we keep a column visible. |
| // Else if give no chance to a clipper-savy user to submit rows and therefore total contents height used by scrollbar. |
| if (has_at_least_one_column_requesting_output == false) |
| { |
| table->Columns[table->LeftMostEnabledColumn].IsRequestOutput = true; |
| table->Columns[table->LeftMostEnabledColumn].IsSkipItems = false; |
| } |
| |
| // [Part 7] Detect/store when we are hovering the unused space after the right-most column (so e.g. context menus can react on it) |
| // Clear Resizable flag if none of our column are actually resizable (either via an explicit _NoResize flag, either |
| // because of using _WidthAuto/_WidthStretch). This will hide the resizing option from the context menu. |
| const float unused_x1 = ImMax(table->WorkRect.Min.x, table->Columns[table->RightMostEnabledColumn].ClipRect.Max.x); |
| if (is_hovering_table && table->HoveredColumnBody == -1) |
| if (mouse_skewed_x >= unused_x1) |
| table->HoveredColumnBody = (ImGuiTableColumnIdx)table->ColumnsCount; |
| if (has_resizable == false && (table->Flags & ImGuiTableFlags_Resizable)) |
| table->Flags &= ~ImGuiTableFlags_Resizable; |
| |
| table->IsActiveIdAliveBeforeTable = (g.ActiveIdIsAlive != 0); |
| |
| // [Part 8] Lock actual OuterRect/WorkRect right-most position. |
| // This is done late to handle the case of fixed-columns tables not claiming more widths that they need. |
| // Because of this we are careful with uses of WorkRect and InnerClipRect before this point. |
| if (table->RightMostStretchedColumn != -1) |
| table->Flags &= ~ImGuiTableFlags_NoHostExtendX; |
| if (table->Flags & ImGuiTableFlags_NoHostExtendX) |
| { |
| table->OuterRect.Max.x = table->WorkRect.Max.x = unused_x1; |
| table->InnerClipRect.Max.x = ImMin(table->InnerClipRect.Max.x, unused_x1); |
| } |
| table->InnerWindow->ParentWorkRect = table->WorkRect; |
| table->BorderX1 = table->InnerClipRect.Min.x; |
| table->BorderX2 = table->InnerClipRect.Max.x; |
| |
| // Setup window's WorkRect.Max.y for GetContentRegionAvail(). Other values will be updated in each TableBeginCell() call. |
| float window_content_max_y; |
| if (table->Flags & ImGuiTableFlags_NoHostExtendY) |
| window_content_max_y = table->OuterRect.Max.y; |
| else |
| window_content_max_y = ImMax(table->InnerWindow->ContentRegionRect.Max.y, (table->Flags & ImGuiTableFlags_ScrollY) ? 0.0f : table->OuterRect.Max.y); |
| table->InnerWindow->WorkRect.Max.y = ImClamp(window_content_max_y - g.Style.CellPadding.y, table->InnerWindow->WorkRect.Min.y, table->InnerWindow->WorkRect.Max.y); |
| |
| // [Part 9] Allocate draw channels and setup background cliprect |
| TableSetupDrawChannels(table); |
| |
| // [Part 10] Hit testing on borders |
| if (table->Flags & ImGuiTableFlags_Resizable) |
| TableUpdateBorders(table); |
| table_instance->LastTopHeadersRowHeight = 0.0f; |
| table->IsLayoutLocked = true; |
| table->IsUsingHeaders = false; |
| |
| // Highlight header |
| table->HighlightColumnHeader = -1; |
| if (table->IsContextPopupOpen && table->ContextPopupColumn != -1 && table->InstanceInteracted == table->InstanceCurrent) |
| table->HighlightColumnHeader = table->ContextPopupColumn; |
| else if ((table->Flags & ImGuiTableFlags_HighlightHoveredColumn) && table->HoveredColumnBody != -1 && table->HoveredColumnBody != table->ColumnsCount && table->HoveredColumnBorder == -1) |
| if (g.ActiveId == 0 || (table->IsActiveIdInTable || g.DragDropActive)) |
| table->HighlightColumnHeader = table->HoveredColumnBody; |
| |
| // [Part 11] Default context menu |
| // - To append to this menu: you can call TableBeginContextMenuPopup()/.../EndPopup(). |
| // - To modify or replace this: set table->IsContextPopupNoDefaultContents = true, then call TableBeginContextMenuPopup()/.../EndPopup(). |
| // - You may call TableDrawDefaultContextMenu() with selected flags to display specific sections of the default menu, |
| // e.g. TableDrawDefaultContextMenu(table, table->Flags & ~ImGuiTableFlags_Hideable) will display everything EXCEPT columns visibility options. |
| if (table->DisableDefaultContextMenu == false && TableBeginContextMenuPopup(table)) |
| { |
| TableDrawDefaultContextMenu(table, table->Flags); |
| EndPopup(); |
| } |
| |
| // [Part 12] Sanitize and build sort specs before we have a chance to use them for display. |
| // This path will only be exercised when sort specs are modified before header rows (e.g. init or visibility change) |
| if (table->IsSortSpecsDirty && (table->Flags & ImGuiTableFlags_Sortable)) |
| TableSortSpecsBuild(table); |
| |
| // [Part 13] Setup inner window decoration size (for scrolling / nav tracking to properly take account of frozen rows/columns) |
| if (table->FreezeColumnsRequest > 0) |
| table->InnerWindow->DecoInnerSizeX1 = table->Columns[table->DisplayOrderToIndex[table->FreezeColumnsRequest - 1]].MaxX - table->OuterRect.Min.x; |
| if (table->FreezeRowsRequest > 0) |
| table->InnerWindow->DecoInnerSizeY1 = table_instance->LastFrozenHeight; |
| table_instance->LastFrozenHeight = 0.0f; |
| |
| // Initial state |
| ImGuiWindow* inner_window = table->InnerWindow; |
| if (table->Flags & ImGuiTableFlags_NoClip) |
| table->DrawSplitter->SetCurrentChannel(inner_window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP); |
| else |
| inner_window->DrawList->PushClipRect(inner_window->InnerClipRect.Min, inner_window->InnerClipRect.Max, false); |
| } |
| |
| // Process hit-testing on resizing borders. Actual size change will be applied in EndTable() |
| // - Set table->HoveredColumnBorder with a short delay/timer to reduce visual feedback noise. |
| void ImGui::TableUpdateBorders(ImGuiTable* table) |
| { |
| ImGuiContext& g = *GImGui; |
| IM_ASSERT(table->Flags & ImGuiTableFlags_Resizable); |
| |
| // At this point OuterRect height may be zero or under actual final height, so we rely on temporal coherency and |
| // use the final height from last frame. Because this is only affecting _interaction_ with columns, it is not |
| // really problematic (whereas the actual visual will be displayed in EndTable() and using the current frame height). |
| // Actual columns highlight/render will be performed in EndTable() and not be affected. |
| ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); |
| const float hit_half_width = ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale); |
| const float hit_y1 = (table->FreezeRowsCount >= 1 ? table->OuterRect.Min.y : table->WorkRect.Min.y) + table->AngledHeadersHeight; |
| const float hit_y2_body = ImMax(table->OuterRect.Max.y, hit_y1 + table_instance->LastOuterHeight - table->AngledHeadersHeight); |
| const float hit_y2_head = hit_y1 + table_instance->LastTopHeadersRowHeight; |
| |
| for (int order_n = 0; order_n < table->ColumnsCount; order_n++) |
| { |
| if (!IM_BITARRAY_TESTBIT(table->EnabledMaskByDisplayOrder, order_n)) |
| continue; |
| |
| const int column_n = table->DisplayOrderToIndex[order_n]; |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| if (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_)) |
| continue; |
| |
| // ImGuiTableFlags_NoBordersInBodyUntilResize will be honored in TableDrawBorders() |
| const float border_y2_hit = (table->Flags & ImGuiTableFlags_NoBordersInBody) ? hit_y2_head : hit_y2_body; |
| if ((table->Flags & ImGuiTableFlags_NoBordersInBody) && table->IsUsingHeaders == false) |
| continue; |
| |
| if (!column->IsVisibleX && table->LastResizedColumn != column_n) |
| continue; |
| |
| ImGuiID column_id = TableGetColumnResizeID(table, column_n, table->InstanceCurrent); |
| ImRect hit_rect(column->MaxX - hit_half_width, hit_y1, column->MaxX + hit_half_width, border_y2_hit); |
| ItemAdd(hit_rect, column_id, NULL, ImGuiItemFlags_NoNav); |
| //GetForegroundDrawList()->AddRect(hit_rect.Min, hit_rect.Max, IM_COL32(255, 0, 0, 100)); |
| |
| bool hovered = false, held = false; |
| bool pressed = ButtonBehavior(hit_rect, column_id, &hovered, &held, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick | ImGuiButtonFlags_NoNavFocus); |
| if (pressed && IsMouseDoubleClicked(0)) |
| { |
| TableSetColumnWidthAutoSingle(table, column_n); |
| ClearActiveID(); |
| held = false; |
| } |
| if (held) |
| { |
| if (table->LastResizedColumn == -1) |
| table->ResizeLockMinContentsX2 = table->RightMostEnabledColumn != -1 ? table->Columns[table->RightMostEnabledColumn].MaxX : -FLT_MAX; |
| table->ResizedColumn = (ImGuiTableColumnIdx)column_n; |
| table->InstanceInteracted = table->InstanceCurrent; |
| } |
| if ((hovered && g.HoveredIdTimer > TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER) || held) |
| { |
| table->HoveredColumnBorder = (ImGuiTableColumnIdx)column_n; |
| SetMouseCursor(ImGuiMouseCursor_ResizeEW); |
| } |
| } |
| } |
| |
| void ImGui::EndTable() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| IM_ASSERT(table != NULL && "Only call EndTable() if BeginTable() returns true!"); |
| |
| // This assert would be very useful to catch a common error... unfortunately it would probably trigger in some |
| // cases, and for consistency user may sometimes output empty tables (and still benefit from e.g. outer border) |
| //IM_ASSERT(table->IsLayoutLocked && "Table unused: never called TableNextRow(), is that the intent?"); |
| |
| // If the user never got to call TableNextRow() or TableNextColumn(), we call layout ourselves to ensure all our |
| // code paths are consistent (instead of just hoping that TableBegin/TableEnd will work), get borders drawn, etc. |
| if (!table->IsLayoutLocked) |
| TableUpdateLayout(table); |
| |
| const ImGuiTableFlags flags = table->Flags; |
| ImGuiWindow* inner_window = table->InnerWindow; |
| ImGuiWindow* outer_window = table->OuterWindow; |
| ImGuiTableTempData* temp_data = table->TempData; |
| IM_ASSERT(inner_window == g.CurrentWindow); |
| IM_ASSERT(outer_window == inner_window || outer_window == inner_window->ParentWindow); |
| |
| if (table->IsInsideRow) |
| TableEndRow(table); |
| |
| // Context menu in columns body |
| if (flags & ImGuiTableFlags_ContextMenuInBody) |
| if (table->HoveredColumnBody != -1 && !IsAnyItemHovered() && IsMouseReleased(ImGuiMouseButton_Right)) |
| TableOpenContextMenu((int)table->HoveredColumnBody); |
| |
| // Finalize table height |
| ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); |
| inner_window->DC.PrevLineSize = temp_data->HostBackupPrevLineSize; |
| inner_window->DC.CurrLineSize = temp_data->HostBackupCurrLineSize; |
| inner_window->DC.CursorMaxPos = temp_data->HostBackupCursorMaxPos; |
| const float inner_content_max_y = table->RowPosY2; |
| IM_ASSERT(table->RowPosY2 == inner_window->DC.CursorPos.y); |
| if (inner_window != outer_window) |
| inner_window->DC.CursorMaxPos.y = inner_content_max_y; |
| else if (!(flags & ImGuiTableFlags_NoHostExtendY)) |
| table->OuterRect.Max.y = table->InnerRect.Max.y = ImMax(table->OuterRect.Max.y, inner_content_max_y); // Patch OuterRect/InnerRect height |
| table->WorkRect.Max.y = ImMax(table->WorkRect.Max.y, table->OuterRect.Max.y); |
| table_instance->LastOuterHeight = table->OuterRect.GetHeight(); |
| |
| // Setup inner scrolling range |
| // FIXME: This ideally should be done earlier, in BeginTable() SetNextWindowContentSize call, just like writing to inner_window->DC.CursorMaxPos.y, |
| // but since the later is likely to be impossible to do we'd rather update both axises together. |
| if (table->Flags & ImGuiTableFlags_ScrollX) |
| { |
| const float outer_padding_for_border = (table->Flags & ImGuiTableFlags_BordersOuterV) ? TABLE_BORDER_SIZE : 0.0f; |
| float max_pos_x = table->InnerWindow->DC.CursorMaxPos.x; |
| if (table->RightMostEnabledColumn != -1) |
| max_pos_x = ImMax(max_pos_x, table->Columns[table->RightMostEnabledColumn].WorkMaxX + table->CellPaddingX + table->OuterPaddingX - outer_padding_for_border); |
| if (table->ResizedColumn != -1) |
| max_pos_x = ImMax(max_pos_x, table->ResizeLockMinContentsX2); |
| table->InnerWindow->DC.CursorMaxPos.x = max_pos_x + table->TempData->AngledHeadersExtraWidth; |
| } |
| |
| // Pop clipping rect |
| if (!(flags & ImGuiTableFlags_NoClip)) |
| inner_window->DrawList->PopClipRect(); |
| inner_window->ClipRect = inner_window->DrawList->_ClipRectStack.back(); |
| |
| // Draw borders |
| if ((flags & ImGuiTableFlags_Borders) != 0) |
| TableDrawBorders(table); |
| |
| #if 0 |
| // Strip out dummy channel draw calls |
| // We have no way to prevent user submitting direct ImDrawList calls into a hidden column (but ImGui:: calls will be clipped out) |
| // Pros: remove draw calls which will have no effect. since they'll have zero-size cliprect they may be early out anyway. |
| // Cons: making it harder for users watching metrics/debugger to spot the wasted vertices. |
| if (table->DummyDrawChannel != (ImGuiTableColumnIdx)-1) |
| { |
| ImDrawChannel* dummy_channel = &table->DrawSplitter._Channels[table->DummyDrawChannel]; |
| dummy_channel->_CmdBuffer.resize(0); |
| dummy_channel->_IdxBuffer.resize(0); |
| } |
| #endif |
| |
| // Flatten channels and merge draw calls |
| ImDrawListSplitter* splitter = table->DrawSplitter; |
| splitter->SetCurrentChannel(inner_window->DrawList, 0); |
| if ((table->Flags & ImGuiTableFlags_NoClip) == 0) |
| TableMergeDrawChannels(table); |
| splitter->Merge(inner_window->DrawList); |
| |
| // Update ColumnsAutoFitWidth to get us ahead for host using our size to auto-resize without waiting for next BeginTable() |
| float auto_fit_width_for_fixed = 0.0f; |
| float auto_fit_width_for_stretched = 0.0f; |
| float auto_fit_width_for_stretched_min = 0.0f; |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| if (IM_BITARRAY_TESTBIT(table->EnabledMaskByIndex, column_n)) |
| { |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| float column_width_request = ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && !(column->Flags & ImGuiTableColumnFlags_NoResize)) ? column->WidthRequest : TableGetColumnWidthAuto(table, column); |
| if (column->Flags & ImGuiTableColumnFlags_WidthFixed) |
| auto_fit_width_for_fixed += column_width_request; |
| else |
| auto_fit_width_for_stretched += column_width_request; |
| if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) && (column->Flags & ImGuiTableColumnFlags_NoResize) != 0) |
| auto_fit_width_for_stretched_min = ImMax(auto_fit_width_for_stretched_min, column_width_request / (column->StretchWeight / table->ColumnsStretchSumWeights)); |
| } |
| const float width_spacings = (table->OuterPaddingX * 2.0f) + (table->CellSpacingX1 + table->CellSpacingX2) * (table->ColumnsEnabledCount - 1); |
| table->ColumnsAutoFitWidth = width_spacings + (table->CellPaddingX * 2.0f) * table->ColumnsEnabledCount + auto_fit_width_for_fixed + ImMax(auto_fit_width_for_stretched, auto_fit_width_for_stretched_min); |
| |
| // Update scroll |
| if ((table->Flags & ImGuiTableFlags_ScrollX) == 0 && inner_window != outer_window) |
| { |
| inner_window->Scroll.x = 0.0f; |
| } |
| else if (table->LastResizedColumn != -1 && table->ResizedColumn == -1 && inner_window->ScrollbarX && table->InstanceInteracted == table->InstanceCurrent) |
| { |
| // When releasing a column being resized, scroll to keep the resulting column in sight |
| const float neighbor_width_to_keep_visible = table->MinColumnWidth + table->CellPaddingX * 2.0f; |
| ImGuiTableColumn* column = &table->Columns[table->LastResizedColumn]; |
| if (column->MaxX < table->InnerClipRect.Min.x) |
| SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x - neighbor_width_to_keep_visible, 1.0f); |
| else if (column->MaxX > table->InnerClipRect.Max.x) |
| SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x + neighbor_width_to_keep_visible, 1.0f); |
| } |
| |
| // Apply resizing/dragging at the end of the frame |
| if (table->ResizedColumn != -1 && table->InstanceCurrent == table->InstanceInteracted) |
| { |
| ImGuiTableColumn* column = &table->Columns[table->ResizedColumn]; |
| const float new_x2 = (g.IO.MousePos.x - g.ActiveIdClickOffset.x + ImTrunc(TABLE_RESIZE_SEPARATOR_HALF_THICKNESS * g.CurrentDpiScale)); |
| const float new_width = ImTrunc(new_x2 - column->MinX - table->CellSpacingX1 - table->CellPaddingX * 2.0f); |
| table->ResizedColumnNextWidth = new_width; |
| } |
| |
| table->IsActiveIdInTable = (g.ActiveIdIsAlive != 0 && table->IsActiveIdAliveBeforeTable == false); |
| |
| // Pop from id stack |
| IM_ASSERT_USER_ERROR(inner_window->IDStack.back() == table_instance->TableInstanceID, "Mismatching PushID/PopID!"); |
| IM_ASSERT_USER_ERROR(outer_window->DC.ItemWidthStack.Size >= temp_data->HostBackupItemWidthStackSize, "Too many PopItemWidth!"); |
| if (table->InstanceCurrent > 0) |
| PopID(); |
| PopID(); |
| |
| // Restore window data that we modified |
| const ImVec2 backup_outer_max_pos = outer_window->DC.CursorMaxPos; |
| inner_window->WorkRect = temp_data->HostBackupWorkRect; |
| inner_window->ParentWorkRect = temp_data->HostBackupParentWorkRect; |
| inner_window->SkipItems = table->HostSkipItems; |
| outer_window->DC.CursorPos = table->OuterRect.Min; |
| outer_window->DC.ItemWidth = temp_data->HostBackupItemWidth; |
| outer_window->DC.ItemWidthStack.Size = temp_data->HostBackupItemWidthStackSize; |
| outer_window->DC.ColumnsOffset = temp_data->HostBackupColumnsOffset; |
| |
| // Layout in outer window |
| // (FIXME: To allow auto-fit and allow desirable effect of SameLine() we dissociate 'used' vs 'ideal' size by overriding |
| // CursorPosPrevLine and CursorMaxPos manually. That should be a more general layout feature, see same problem e.g. #3414) |
| if (inner_window != outer_window) |
| { |
| short backup_nav_layers_active_mask = inner_window->DC.NavLayersActiveMask; |
| inner_window->DC.NavLayersActiveMask |= 1 << ImGuiNavLayer_Main; // So empty table don't appear to navigate differently. |
| EndChild(); |
| inner_window->DC.NavLayersActiveMask = backup_nav_layers_active_mask; |
| } |
| else |
| { |
| ItemSize(table->OuterRect.GetSize()); |
| ItemAdd(table->OuterRect, 0); |
| } |
| |
| // Override declared contents width/height to enable auto-resize while not needlessly adding a scrollbar |
| if (table->Flags & ImGuiTableFlags_NoHostExtendX) |
| { |
| // FIXME-TABLE: Could we remove this section? |
| // ColumnsAutoFitWidth may be one frame ahead here since for Fixed+NoResize is calculated from latest contents |
| IM_ASSERT((table->Flags & ImGuiTableFlags_ScrollX) == 0); |
| outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Min.x + table->ColumnsAutoFitWidth); |
| } |
| else if (temp_data->UserOuterSize.x <= 0.0f) |
| { |
| // Some references for this: #7651 + tests "table_reported_size", "table_reported_size_outer" equivalent Y block |
| // - Checking for ImGuiTableFlags_ScrollX/ScrollY flag makes us a frame ahead when disabling those flags. |
| // - FIXME-TABLE: Would make sense to pre-compute expected scrollbar visibility/sizes to generally save a frame of feedback. |
| const float inner_content_max_x = table->OuterRect.Min.x + table->ColumnsAutoFitWidth; // Slightly misleading name but used for code symmetry with inner_content_max_y |
| const float decoration_size = table->TempData->AngledHeadersExtraWidth + ((table->Flags & ImGuiTableFlags_ScrollY) ? inner_window->ScrollbarSizes.x : 0.0f); |
| outer_window->DC.IdealMaxPos.x = ImMax(outer_window->DC.IdealMaxPos.x, inner_content_max_x + decoration_size - temp_data->UserOuterSize.x); |
| outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, ImMin(table->OuterRect.Max.x, inner_content_max_x + decoration_size)); |
| } |
| else |
| { |
| outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos.x, table->OuterRect.Max.x); |
| } |
| if (temp_data->UserOuterSize.y <= 0.0f) |
| { |
| const float decoration_size = (table->Flags & ImGuiTableFlags_ScrollX) ? inner_window->ScrollbarSizes.y : 0.0f; |
| outer_window->DC.IdealMaxPos.y = ImMax(outer_window->DC.IdealMaxPos.y, inner_content_max_y + decoration_size - temp_data->UserOuterSize.y); |
| outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, ImMin(table->OuterRect.Max.y, inner_content_max_y + decoration_size)); |
| } |
| else |
| { |
| // OuterRect.Max.y may already have been pushed downward from the initial value (unless ImGuiTableFlags_NoHostExtendY is set) |
| outer_window->DC.CursorMaxPos.y = ImMax(backup_outer_max_pos.y, table->OuterRect.Max.y); |
| } |
| |
| // Save settings |
| if (table->IsSettingsDirty) |
| TableSaveSettings(table); |
| table->IsInitializing = false; |
| |
| // Clear or restore current table, if any |
| IM_ASSERT(g.CurrentWindow == outer_window && g.CurrentTable == table); |
| IM_ASSERT(g.TablesTempDataStacked > 0); |
| temp_data = (--g.TablesTempDataStacked > 0) ? &g.TablesTempData[g.TablesTempDataStacked - 1] : NULL; |
| g.CurrentTable = temp_data ? g.Tables.GetByIndex(temp_data->TableIndex) : NULL; |
| if (g.CurrentTable) |
| { |
| g.CurrentTable->TempData = temp_data; |
| g.CurrentTable->DrawSplitter = &temp_data->DrawSplitter; |
| } |
| outer_window->DC.CurrentTableIdx = g.CurrentTable ? g.Tables.GetIndex(g.CurrentTable) : -1; |
| NavUpdateCurrentWindowIsScrollPushableX(); |
| } |
| |
| // See "COLUMNS SIZING POLICIES" comments at the top of this file |
| // If (init_width_or_weight <= 0.0f) it is ignored |
| void ImGui::TableSetupColumn(const char* label, ImGuiTableColumnFlags flags, float init_width_or_weight, ImGuiID user_id) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| IM_ASSERT(table != NULL && "Need to call TableSetupColumn() after BeginTable()!"); |
| IM_ASSERT(table->IsLayoutLocked == false && "Need to call call TableSetupColumn() before first row!"); |
| IM_ASSERT((flags & ImGuiTableColumnFlags_StatusMask_) == 0 && "Illegal to pass StatusMask values to TableSetupColumn()"); |
| if (table->DeclColumnsCount >= table->ColumnsCount) |
| { |
| IM_ASSERT_USER_ERROR(table->DeclColumnsCount < table->ColumnsCount, "Called TableSetupColumn() too many times!"); |
| return; |
| } |
| |
| ImGuiTableColumn* column = &table->Columns[table->DeclColumnsCount]; |
| table->DeclColumnsCount++; |
| |
| // Assert when passing a width or weight if policy is entirely left to default, to avoid storing width into weight and vice-versa. |
| // Give a grace to users of ImGuiTableFlags_ScrollX. |
| if (table->IsDefaultSizingPolicy && (flags & ImGuiTableColumnFlags_WidthMask_) == 0 && (flags & ImGuiTableFlags_ScrollX) == 0) |
| IM_ASSERT(init_width_or_weight <= 0.0f && "Can only specify width/weight if sizing policy is set explicitly in either Table or Column."); |
| |
| // When passing a width automatically enforce WidthFixed policy |
| // (whereas TableSetupColumnFlags would default to WidthAuto if table is not Resizable) |
| if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0 && init_width_or_weight > 0.0f) |
| if ((table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedFit || (table->Flags & ImGuiTableFlags_SizingMask_) == ImGuiTableFlags_SizingFixedSame) |
| flags |= ImGuiTableColumnFlags_WidthFixed; |
| if (flags & ImGuiTableColumnFlags_AngledHeader) |
| { |
| flags |= ImGuiTableColumnFlags_NoHeaderLabel; |
| table->AngledHeadersCount++; |
| } |
| |
| TableSetupColumnFlags(table, column, flags); |
| column->UserID = user_id; |
| flags = column->Flags; |
| |
| // Initialize defaults |
| column->InitStretchWeightOrWidth = init_width_or_weight; |
| if (table->IsInitializing) |
| { |
| // Init width or weight |
| if (column->WidthRequest < 0.0f && column->StretchWeight < 0.0f) |
| { |
| if ((flags & ImGuiTableColumnFlags_WidthFixed) && init_width_or_weight > 0.0f) |
| column->WidthRequest = init_width_or_weight; |
| if (flags & ImGuiTableColumnFlags_WidthStretch) |
| column->StretchWeight = (init_width_or_weight > 0.0f) ? init_width_or_weight : -1.0f; |
| |
| // Disable auto-fit if an explicit width/weight has been specified |
| if (init_width_or_weight > 0.0f) |
| column->AutoFitQueue = 0x00; |
| } |
| |
| // Init default visibility/sort state |
| if ((flags & ImGuiTableColumnFlags_DefaultHide) && (table->SettingsLoadedFlags & ImGuiTableFlags_Hideable) == 0) |
| column->IsUserEnabled = column->IsUserEnabledNextFrame = false; |
| if (flags & ImGuiTableColumnFlags_DefaultSort && (table->SettingsLoadedFlags & ImGuiTableFlags_Sortable) == 0) |
| { |
| column->SortOrder = 0; // Multiple columns using _DefaultSort will be reassigned unique SortOrder values when building the sort specs. |
| column->SortDirection = (column->Flags & ImGuiTableColumnFlags_PreferSortDescending) ? (ImS8)ImGuiSortDirection_Descending : (ImU8)(ImGuiSortDirection_Ascending); |
| } |
| } |
| |
| // Store name (append with zero-terminator in contiguous buffer) |
| // FIXME: If we recorded the number of \n in names we could compute header row height |
| column->NameOffset = -1; |
| if (label != NULL && label[0] != 0) |
| { |
| column->NameOffset = (ImS16)table->ColumnsNames.size(); |
| table->ColumnsNames.append(label, label + strlen(label) + 1); |
| } |
| } |
| |
| // [Public] |
| void ImGui::TableSetupScrollFreeze(int columns, int rows) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| IM_ASSERT(table != NULL && "Need to call TableSetupColumn() after BeginTable()!"); |
| IM_ASSERT(table->IsLayoutLocked == false && "Need to call TableSetupColumn() before first row!"); |
| IM_ASSERT(columns >= 0 && columns < IMGUI_TABLE_MAX_COLUMNS); |
| IM_ASSERT(rows >= 0 && rows < 128); // Arbitrary limit |
| |
| table->FreezeColumnsRequest = (table->Flags & ImGuiTableFlags_ScrollX) ? (ImGuiTableColumnIdx)ImMin(columns, table->ColumnsCount) : 0; |
| table->FreezeColumnsCount = (table->InnerWindow->Scroll.x != 0.0f) ? table->FreezeColumnsRequest : 0; |
| table->FreezeRowsRequest = (table->Flags & ImGuiTableFlags_ScrollY) ? (ImGuiTableColumnIdx)rows : 0; |
| table->FreezeRowsCount = (table->InnerWindow->Scroll.y != 0.0f) ? table->FreezeRowsRequest : 0; |
| table->IsUnfrozenRows = (table->FreezeRowsCount == 0); // Make sure this is set before TableUpdateLayout() so ImGuiListClipper can benefit from it.b |
| |
| // Ensure frozen columns are ordered in their section. We still allow multiple frozen columns to be reordered. |
| // FIXME-TABLE: This work for preserving 2143 into 21|43. How about 4321 turning into 21|43? (preserve relative order in each section) |
| for (int column_n = 0; column_n < table->FreezeColumnsRequest; column_n++) |
| { |
| int order_n = table->DisplayOrderToIndex[column_n]; |
| if (order_n != column_n && order_n >= table->FreezeColumnsRequest) |
| { |
| ImSwap(table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder, table->Columns[table->DisplayOrderToIndex[column_n]].DisplayOrder); |
| ImSwap(table->DisplayOrderToIndex[order_n], table->DisplayOrderToIndex[column_n]); |
| } |
| } |
| } |
| |
| //----------------------------------------------------------------------------- |
| // [SECTION] Tables: Simple accessors |
| //----------------------------------------------------------------------------- |
| // - TableGetColumnCount() |
| // - TableGetColumnName() |
| // - TableGetColumnName() [Internal] |
| // - TableSetColumnEnabled() |
| // - TableGetColumnFlags() |
| // - TableGetCellBgRect() [Internal] |
| // - TableGetColumnResizeID() [Internal] |
| // - TableGetHoveredColumn() [Internal] |
| // - TableGetHoveredRow() [Internal] |
| // - TableSetBgColor() |
| //----------------------------------------------------------------------------- |
| |
| int ImGui::TableGetColumnCount() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| return table ? table->ColumnsCount : 0; |
| } |
| |
| const char* ImGui::TableGetColumnName(int column_n) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return NULL; |
| if (column_n < 0) |
| column_n = table->CurrentColumn; |
| return TableGetColumnName(table, column_n); |
| } |
| |
| const char* ImGui::TableGetColumnName(const ImGuiTable* table, int column_n) |
| { |
| if (table->IsLayoutLocked == false && column_n >= table->DeclColumnsCount) |
| return ""; // NameOffset is invalid at this point |
| const ImGuiTableColumn* column = &table->Columns[column_n]; |
| if (column->NameOffset == -1) |
| return ""; |
| return &table->ColumnsNames.Buf[column->NameOffset]; |
| } |
| |
| // Change user accessible enabled/disabled state of a column (often perceived as "showing/hiding" from users point of view) |
| // Note that end-user can use the context menu to change this themselves (right-click in headers, or right-click in columns body with ImGuiTableFlags_ContextMenuInBody) |
| // - Require table to have the ImGuiTableFlags_Hideable flag because we are manipulating user accessible state. |
| // - Request will be applied during next layout, which happens on the first call to TableNextRow() after BeginTable(). |
| // - For the getter you can test (TableGetColumnFlags() & ImGuiTableColumnFlags_IsEnabled) != 0. |
| // - Alternative: the ImGuiTableColumnFlags_Disabled is an overriding/master disable flag which will also hide the column from context menu. |
| void ImGui::TableSetColumnEnabled(int column_n, bool enabled) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| IM_ASSERT(table != NULL); |
| if (!table) |
| return; |
| IM_ASSERT(table->Flags & ImGuiTableFlags_Hideable); // See comments above |
| if (column_n < 0) |
| column_n = table->CurrentColumn; |
| IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount); |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| column->IsUserEnabledNextFrame = enabled; |
| } |
| |
| // We allow querying for an extra column in order to poll the IsHovered state of the right-most section |
| ImGuiTableColumnFlags ImGui::TableGetColumnFlags(int column_n) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return ImGuiTableColumnFlags_None; |
| if (column_n < 0) |
| column_n = table->CurrentColumn; |
| if (column_n == table->ColumnsCount) |
| return (table->HoveredColumnBody == column_n) ? ImGuiTableColumnFlags_IsHovered : ImGuiTableColumnFlags_None; |
| return table->Columns[column_n].Flags; |
| } |
| |
| // Return the cell rectangle based on currently known height. |
| // - Important: we generally don't know our row height until the end of the row, so Max.y will be incorrect in many situations. |
| // The only case where this is correct is if we provided a min_row_height to TableNextRow() and don't go below it, or in TableEndRow() when we locked that height. |
| // - Important: if ImGuiTableFlags_PadOuterX is set but ImGuiTableFlags_PadInnerX is not set, the outer-most left and right |
| // columns report a small offset so their CellBgRect can extend up to the outer border. |
| // FIXME: But the rendering code in TableEndRow() nullifies that with clamping required for scrolling. |
| ImRect ImGui::TableGetCellBgRect(const ImGuiTable* table, int column_n) |
| { |
| const ImGuiTableColumn* column = &table->Columns[column_n]; |
| float x1 = column->MinX; |
| float x2 = column->MaxX; |
| //if (column->PrevEnabledColumn == -1) |
| // x1 -= table->OuterPaddingX; |
| //if (column->NextEnabledColumn == -1) |
| // x2 += table->OuterPaddingX; |
| x1 = ImMax(x1, table->WorkRect.Min.x); |
| x2 = ImMin(x2, table->WorkRect.Max.x); |
| return ImRect(x1, table->RowPosY1, x2, table->RowPosY2); |
| } |
| |
| // Return the resizing ID for the right-side of the given column. |
| ImGuiID ImGui::TableGetColumnResizeID(ImGuiTable* table, int column_n, int instance_no) |
| { |
| IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount); |
| ImGuiID instance_id = TableGetInstanceID(table, instance_no); |
| return instance_id + 1 + column_n; // FIXME: #6140: still not ideal |
| } |
| |
| // Return -1 when table is not hovered. return columns_count if hovering the unused space at the right of the right-most visible column. |
| int ImGui::TableGetHoveredColumn() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return -1; |
| return (int)table->HoveredColumnBody; |
| } |
| |
| // Return -1 when table is not hovered. Return maxrow+1 if in table but below last submitted row. |
| // *IMPORTANT* Unlike TableGetHoveredColumn(), this has a one frame latency in updating the value. |
| // This difference with is the reason why this is not public yet. |
| int ImGui::TableGetHoveredRow() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return -1; |
| ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); |
| return (int)table_instance->HoveredRowLast; |
| } |
| |
| void ImGui::TableSetBgColor(ImGuiTableBgTarget target, ImU32 color, int column_n) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| IM_ASSERT(target != ImGuiTableBgTarget_None); |
| |
| if (color == IM_COL32_DISABLE) |
| color = 0; |
| |
| // We cannot draw neither the cell or row background immediately as we don't know the row height at this point in time. |
| switch (target) |
| { |
| case ImGuiTableBgTarget_CellBg: |
| { |
| if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard |
| return; |
| if (column_n == -1) |
| column_n = table->CurrentColumn; |
| if (!IM_BITARRAY_TESTBIT(table->VisibleMaskByIndex, column_n)) |
| return; |
| if (table->RowCellDataCurrent < 0 || table->RowCellData[table->RowCellDataCurrent].Column != column_n) |
| table->RowCellDataCurrent++; |
| ImGuiTableCellData* cell_data = &table->RowCellData[table->RowCellDataCurrent]; |
| cell_data->BgColor = color; |
| cell_data->Column = (ImGuiTableColumnIdx)column_n; |
| break; |
| } |
| case ImGuiTableBgTarget_RowBg0: |
| case ImGuiTableBgTarget_RowBg1: |
| { |
| if (table->RowPosY1 > table->InnerClipRect.Max.y) // Discard |
| return; |
| IM_ASSERT(column_n == -1); |
| int bg_idx = (target == ImGuiTableBgTarget_RowBg1) ? 1 : 0; |
| table->RowBgColor[bg_idx] = color; |
| break; |
| } |
| default: |
| IM_ASSERT(0); |
| } |
| } |
| |
| //------------------------------------------------------------------------- |
| // [SECTION] Tables: Row changes |
| //------------------------------------------------------------------------- |
| // - TableGetRowIndex() |
| // - TableNextRow() |
| // - TableBeginRow() [Internal] |
| // - TableEndRow() [Internal] |
| //------------------------------------------------------------------------- |
| |
| // [Public] Note: for row coloring we use ->RowBgColorCounter which is the same value without counting header rows |
| int ImGui::TableGetRowIndex() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return 0; |
| return table->CurrentRow; |
| } |
| |
| // [Public] Starts into the first cell of a new row |
| void ImGui::TableNextRow(ImGuiTableRowFlags row_flags, float row_min_height) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| |
| if (!table->IsLayoutLocked) |
| TableUpdateLayout(table); |
| if (table->IsInsideRow) |
| TableEndRow(table); |
| |
| table->LastRowFlags = table->RowFlags; |
| table->RowFlags = row_flags; |
| table->RowCellPaddingY = g.Style.CellPadding.y; |
| table->RowMinHeight = row_min_height; |
| TableBeginRow(table); |
| |
| // We honor min_row_height requested by user, but cannot guarantee per-row maximum height, |
| // because that would essentially require a unique clipping rectangle per-cell. |
| table->RowPosY2 += table->RowCellPaddingY * 2.0f; |
| table->RowPosY2 = ImMax(table->RowPosY2, table->RowPosY1 + row_min_height); |
| |
| // Disable output until user calls TableNextColumn() |
| table->InnerWindow->SkipItems = true; |
| } |
| |
| // [Internal] Only called by TableNextRow() |
| void ImGui::TableBeginRow(ImGuiTable* table) |
| { |
| ImGuiWindow* window = table->InnerWindow; |
| IM_ASSERT(!table->IsInsideRow); |
| |
| // New row |
| table->CurrentRow++; |
| table->CurrentColumn = -1; |
| table->RowBgColor[0] = table->RowBgColor[1] = IM_COL32_DISABLE; |
| table->RowCellDataCurrent = -1; |
| table->IsInsideRow = true; |
| |
| // Begin frozen rows |
| float next_y1 = table->RowPosY2; |
| if (table->CurrentRow == 0 && table->FreezeRowsCount > 0) |
| next_y1 = window->DC.CursorPos.y = table->OuterRect.Min.y; |
| |
| table->RowPosY1 = table->RowPosY2 = next_y1; |
| table->RowTextBaseline = 0.0f; |
| table->RowIndentOffsetX = window->DC.Indent.x - table->HostIndentX; // Lock indent |
| |
| window->DC.PrevLineTextBaseOffset = 0.0f; |
| window->DC.CursorPosPrevLine = ImVec2(window->DC.CursorPos.x, window->DC.CursorPos.y + table->RowCellPaddingY); // This allows users to call SameLine() to share LineSize between columns. |
| window->DC.PrevLineSize = window->DC.CurrLineSize = ImVec2(0.0f, 0.0f); // This allows users to call SameLine() to share LineSize between columns, and to call it from first column too. |
| window->DC.IsSameLine = window->DC.IsSetPos = false; |
| window->DC.CursorMaxPos.y = next_y1; |
| |
| // Making the header BG color non-transparent will allow us to overlay it multiple times when handling smooth dragging. |
| if (table->RowFlags & ImGuiTableRowFlags_Headers) |
| { |
| TableSetBgColor(ImGuiTableBgTarget_RowBg0, GetColorU32(ImGuiCol_TableHeaderBg)); |
| if (table->CurrentRow == 0) |
| table->IsUsingHeaders = true; |
| } |
| } |
| |
| // [Internal] Called by TableNextRow() |
| void ImGui::TableEndRow(ImGuiTable* table) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiWindow* window = g.CurrentWindow; |
| IM_ASSERT(window == table->InnerWindow); |
| IM_ASSERT(table->IsInsideRow); |
| |
| if (table->CurrentColumn != -1) |
| TableEndCell(table); |
| |
| // Logging |
| if (g.LogEnabled) |
| LogRenderedText(NULL, "|"); |
| |
| // Position cursor at the bottom of our row so it can be used for e.g. clipping calculation. However it is |
| // likely that the next call to TableBeginCell() will reposition the cursor to take account of vertical padding. |
| window->DC.CursorPos.y = table->RowPosY2; |
| |
| // Row background fill |
| const float bg_y1 = table->RowPosY1; |
| const float bg_y2 = table->RowPosY2; |
| const bool unfreeze_rows_actual = (table->CurrentRow + 1 == table->FreezeRowsCount); |
| const bool unfreeze_rows_request = (table->CurrentRow + 1 == table->FreezeRowsRequest); |
| ImGuiTableInstanceData* table_instance = TableGetInstanceData(table, table->InstanceCurrent); |
| if ((table->RowFlags & ImGuiTableRowFlags_Headers) && (table->CurrentRow == 0 || (table->LastRowFlags & ImGuiTableRowFlags_Headers))) |
| table_instance->LastTopHeadersRowHeight += bg_y2 - bg_y1; |
| |
| const bool is_visible = (bg_y2 >= table->InnerClipRect.Min.y && bg_y1 <= table->InnerClipRect.Max.y); |
| if (is_visible) |
| { |
| // Update data for TableGetHoveredRow() |
| if (table->HoveredColumnBody != -1 && g.IO.MousePos.y >= bg_y1 && g.IO.MousePos.y < bg_y2 && table_instance->HoveredRowNext < 0) |
| table_instance->HoveredRowNext = table->CurrentRow; |
| |
| // Decide of background color for the row |
| ImU32 bg_col0 = 0; |
| ImU32 bg_col1 = 0; |
| if (table->RowBgColor[0] != IM_COL32_DISABLE) |
| bg_col0 = table->RowBgColor[0]; |
| else if (table->Flags & ImGuiTableFlags_RowBg) |
| bg_col0 = GetColorU32((table->RowBgColorCounter & 1) ? ImGuiCol_TableRowBgAlt : ImGuiCol_TableRowBg); |
| if (table->RowBgColor[1] != IM_COL32_DISABLE) |
| bg_col1 = table->RowBgColor[1]; |
| |
| // Decide of top border color |
| ImU32 top_border_col = 0; |
| const float border_size = TABLE_BORDER_SIZE; |
| if (table->CurrentRow > 0 && (table->Flags & ImGuiTableFlags_BordersInnerH)) |
| top_border_col = (table->LastRowFlags & ImGuiTableRowFlags_Headers) ? table->BorderColorStrong : table->BorderColorLight; |
| |
| const bool draw_cell_bg_color = table->RowCellDataCurrent >= 0; |
| const bool draw_strong_bottom_border = unfreeze_rows_actual; |
| if ((bg_col0 | bg_col1 | top_border_col) != 0 || draw_strong_bottom_border || draw_cell_bg_color) |
| { |
| // In theory we could call SetWindowClipRectBeforeSetChannel() but since we know TableEndRow() is |
| // always followed by a change of clipping rectangle we perform the smallest overwrite possible here. |
| if ((table->Flags & ImGuiTableFlags_NoClip) == 0) |
| window->DrawList->_CmdHeader.ClipRect = table->Bg0ClipRectForDrawCmd.ToVec4(); |
| table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_BG0); |
| } |
| |
| // Draw row background |
| // We soft/cpu clip this so all backgrounds and borders can share the same clipping rectangle |
| if (bg_col0 || bg_col1) |
| { |
| ImRect row_rect(table->WorkRect.Min.x, bg_y1, table->WorkRect.Max.x, bg_y2); |
| row_rect.ClipWith(table->BgClipRect); |
| if (bg_col0 != 0 && row_rect.Min.y < row_rect.Max.y) |
| window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col0); |
| if (bg_col1 != 0 && row_rect.Min.y < row_rect.Max.y) |
| window->DrawList->AddRectFilled(row_rect.Min, row_rect.Max, bg_col1); |
| } |
| |
| // Draw cell background color |
| if (draw_cell_bg_color) |
| { |
| ImGuiTableCellData* cell_data_end = &table->RowCellData[table->RowCellDataCurrent]; |
| for (ImGuiTableCellData* cell_data = &table->RowCellData[0]; cell_data <= cell_data_end; cell_data++) |
| { |
| // As we render the BG here we need to clip things (for layout we would not) |
| // FIXME: This cancels the OuterPadding addition done by TableGetCellBgRect(), need to keep it while rendering correctly while scrolling. |
| const ImGuiTableColumn* column = &table->Columns[cell_data->Column]; |
| ImRect cell_bg_rect = TableGetCellBgRect(table, cell_data->Column); |
| cell_bg_rect.ClipWith(table->BgClipRect); |
| cell_bg_rect.Min.x = ImMax(cell_bg_rect.Min.x, column->ClipRect.Min.x); // So that first column after frozen one gets clipped when scrolling |
| cell_bg_rect.Max.x = ImMin(cell_bg_rect.Max.x, column->MaxX); |
| if (cell_bg_rect.Min.y < cell_bg_rect.Max.y) |
| window->DrawList->AddRectFilled(cell_bg_rect.Min, cell_bg_rect.Max, cell_data->BgColor); |
| } |
| } |
| |
| // Draw top border |
| if (top_border_col && bg_y1 >= table->BgClipRect.Min.y && bg_y1 < table->BgClipRect.Max.y) |
| window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y1), ImVec2(table->BorderX2, bg_y1), top_border_col, border_size); |
| |
| // Draw bottom border at the row unfreezing mark (always strong) |
| if (draw_strong_bottom_border && bg_y2 >= table->BgClipRect.Min.y && bg_y2 < table->BgClipRect.Max.y) |
| window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y2), ImVec2(table->BorderX2, bg_y2), table->BorderColorStrong, border_size); |
| } |
| |
| // End frozen rows (when we are past the last frozen row line, teleport cursor and alter clipping rectangle) |
| // We need to do that in TableEndRow() instead of TableBeginRow() so the list clipper can mark end of row and |
| // get the new cursor position. |
| if (unfreeze_rows_request) |
| { |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| table->Columns[column_n].NavLayerCurrent = ImGuiNavLayer_Main; |
| const float y0 = ImMax(table->RowPosY2 + 1, window->InnerClipRect.Min.y); |
| table_instance->LastFrozenHeight = y0 - table->OuterRect.Min.y; |
| |
| if (unfreeze_rows_actual) |
| { |
| IM_ASSERT(table->IsUnfrozenRows == false); |
| table->IsUnfrozenRows = true; |
| |
| // BgClipRect starts as table->InnerClipRect, reduce it now and make BgClipRectForDrawCmd == BgClipRect |
| table->BgClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y = ImMin(y0, window->InnerClipRect.Max.y); |
| table->BgClipRect.Max.y = table->Bg2ClipRectForDrawCmd.Max.y = window->InnerClipRect.Max.y; |
| table->Bg2DrawChannelCurrent = table->Bg2DrawChannelUnfrozen; |
| IM_ASSERT(table->Bg2ClipRectForDrawCmd.Min.y <= table->Bg2ClipRectForDrawCmd.Max.y); |
| |
| float row_height = table->RowPosY2 - table->RowPosY1; |
| table->RowPosY2 = window->DC.CursorPos.y = table->WorkRect.Min.y + table->RowPosY2 - table->OuterRect.Min.y; |
| table->RowPosY1 = table->RowPosY2 - row_height; |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| { |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| column->DrawChannelCurrent = column->DrawChannelUnfrozen; |
| column->ClipRect.Min.y = table->Bg2ClipRectForDrawCmd.Min.y; |
| } |
| |
| // Update cliprect ahead of TableBeginCell() so clipper can access to new ClipRect->Min.y |
| SetWindowClipRectBeforeSetChannel(window, table->Columns[0].ClipRect); |
| table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Columns[0].DrawChannelCurrent); |
| } |
| } |
| |
| if (!(table->RowFlags & ImGuiTableRowFlags_Headers)) |
| table->RowBgColorCounter++; |
| table->IsInsideRow = false; |
| } |
| |
| //------------------------------------------------------------------------- |
| // [SECTION] Tables: Columns changes |
| //------------------------------------------------------------------------- |
| // - TableGetColumnIndex() |
| // - TableSetColumnIndex() |
| // - TableNextColumn() |
| // - TableBeginCell() [Internal] |
| // - TableEndCell() [Internal] |
| //------------------------------------------------------------------------- |
| |
| int ImGui::TableGetColumnIndex() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return 0; |
| return table->CurrentColumn; |
| } |
| |
| // [Public] Append into a specific column |
| bool ImGui::TableSetColumnIndex(int column_n) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return false; |
| |
| if (table->CurrentColumn != column_n) |
| { |
| if (table->CurrentColumn != -1) |
| TableEndCell(table); |
| IM_ASSERT(column_n >= 0 && table->ColumnsCount); |
| TableBeginCell(table, column_n); |
| } |
| |
| // Return whether the column is visible. User may choose to skip submitting items based on this return value, |
| // however they shouldn't skip submitting for columns that may have the tallest contribution to row height. |
| return table->Columns[column_n].IsRequestOutput; |
| } |
| |
| // [Public] Append into the next column, wrap and create a new row when already on last column |
| bool ImGui::TableNextColumn() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| if (!table) |
| return false; |
| |
| if (table->IsInsideRow && table->CurrentColumn + 1 < table->ColumnsCount) |
| { |
| if (table->CurrentColumn != -1) |
| TableEndCell(table); |
| TableBeginCell(table, table->CurrentColumn + 1); |
| } |
| else |
| { |
| TableNextRow(); |
| TableBeginCell(table, 0); |
| } |
| |
| // Return whether the column is visible. User may choose to skip submitting items based on this return value, |
| // however they shouldn't skip submitting for columns that may have the tallest contribution to row height. |
| return table->Columns[table->CurrentColumn].IsRequestOutput; |
| } |
| |
| |
| // [Internal] Called by TableSetColumnIndex()/TableNextColumn() |
| // This is called very frequently, so we need to be mindful of unnecessary overhead. |
| // FIXME-TABLE FIXME-OPT: Could probably shortcut some things for non-active or clipped columns. |
| void ImGui::TableBeginCell(ImGuiTable* table, int column_n) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| ImGuiWindow* window = table->InnerWindow; |
| table->CurrentColumn = column_n; |
| |
| // Start position is roughly ~~ CellRect.Min + CellPadding + Indent |
| float start_x = column->WorkMinX; |
| if (column->Flags & ImGuiTableColumnFlags_IndentEnable) |
| start_x += table->RowIndentOffsetX; // ~~ += window.DC.Indent.x - table->HostIndentX, except we locked it for the row. |
| |
| window->DC.CursorPos.x = start_x; |
| window->DC.CursorPos.y = table->RowPosY1 + table->RowCellPaddingY; |
| window->DC.CursorMaxPos.x = window->DC.CursorPos.x; |
| window->DC.ColumnsOffset.x = start_x - window->Pos.x - window->DC.Indent.x; // FIXME-WORKRECT |
| window->DC.CursorPosPrevLine.x = window->DC.CursorPos.x; // PrevLine.y is preserved. This allows users to call SameLine() to share LineSize between columns. |
| window->DC.CurrLineTextBaseOffset = table->RowTextBaseline; |
| window->DC.NavLayerCurrent = (ImGuiNavLayer)column->NavLayerCurrent; |
| |
| // Note how WorkRect.Max.y is only set once during layout |
| window->WorkRect.Min.y = window->DC.CursorPos.y; |
| window->WorkRect.Min.x = column->WorkMinX; |
| window->WorkRect.Max.x = column->WorkMaxX; |
| window->DC.ItemWidth = column->ItemWidth; |
| |
| window->SkipItems = column->IsSkipItems; |
| if (column->IsSkipItems) |
| { |
| g.LastItemData.ID = 0; |
| g.LastItemData.StatusFlags = 0; |
| } |
| |
| if (table->Flags & ImGuiTableFlags_NoClip) |
| { |
| // FIXME: if we end up drawing all borders/bg in EndTable, could remove this and just assert that channel hasn't changed. |
| table->DrawSplitter->SetCurrentChannel(window->DrawList, TABLE_DRAW_CHANNEL_NOCLIP); |
| //IM_ASSERT(table->DrawSplitter._Current == TABLE_DRAW_CHANNEL_NOCLIP); |
| } |
| else |
| { |
| // FIXME-TABLE: Could avoid this if draw channel is dummy channel? |
| SetWindowClipRectBeforeSetChannel(window, column->ClipRect); |
| table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent); |
| } |
| |
| // Logging |
| if (g.LogEnabled && !column->IsSkipItems) |
| { |
| LogRenderedText(&window->DC.CursorPos, "|"); |
| g.LogLinePosY = FLT_MAX; |
| } |
| } |
| |
| // [Internal] Called by TableNextRow()/TableSetColumnIndex()/TableNextColumn() |
| void ImGui::TableEndCell(ImGuiTable* table) |
| { |
| ImGuiTableColumn* column = &table->Columns[table->CurrentColumn]; |
| ImGuiWindow* window = table->InnerWindow; |
| |
| if (window->DC.IsSetPos) |
| ErrorCheckUsingSetCursorPosToExtendParentBoundaries(); |
| |
| // Report maximum position so we can infer content size per column. |
| float* p_max_pos_x; |
| if (table->RowFlags & ImGuiTableRowFlags_Headers) |
| p_max_pos_x = &column->ContentMaxXHeadersUsed; // Useful in case user submit contents in header row that is not a TableHeader() call |
| else |
| p_max_pos_x = table->IsUnfrozenRows ? &column->ContentMaxXUnfrozen : &column->ContentMaxXFrozen; |
| *p_max_pos_x = ImMax(*p_max_pos_x, window->DC.CursorMaxPos.x); |
| if (column->IsEnabled) |
| table->RowPosY2 = ImMax(table->RowPosY2, window->DC.CursorMaxPos.y + table->RowCellPaddingY); |
| column->ItemWidth = window->DC.ItemWidth; |
| |
| // Propagate text baseline for the entire row |
| // FIXME-TABLE: Here we propagate text baseline from the last line of the cell.. instead of the first one. |
| table->RowTextBaseline = ImMax(table->RowTextBaseline, window->DC.PrevLineTextBaseOffset); |
| } |
| |
| //------------------------------------------------------------------------- |
| // [SECTION] Tables: Columns width management |
| //------------------------------------------------------------------------- |
| // - TableGetMaxColumnWidth() [Internal] |
| // - TableGetColumnWidthAuto() [Internal] |
| // - TableSetColumnWidth() |
| // - TableSetColumnWidthAutoSingle() [Internal] |
| // - TableSetColumnWidthAutoAll() [Internal] |
| // - TableUpdateColumnsWeightFromWidth() [Internal] |
| //------------------------------------------------------------------------- |
| // Note that actual columns widths are computed in TableUpdateLayout(). |
| //------------------------------------------------------------------------- |
| |
| // Maximum column content width given current layout. Use column->MinX so this value on a per-column basis. |
| float ImGui::TableGetMaxColumnWidth(const ImGuiTable* table, int column_n) |
| { |
| const ImGuiTableColumn* column = &table->Columns[column_n]; |
| float max_width = FLT_MAX; |
| const float min_column_distance = table->MinColumnWidth + table->CellPaddingX * 2.0f + table->CellSpacingX1 + table->CellSpacingX2; |
| if (table->Flags & ImGuiTableFlags_ScrollX) |
| { |
| // Frozen columns can't reach beyond visible width else scrolling will naturally break. |
| // (we use DisplayOrder as within a set of multiple frozen column reordering is possible) |
| if (column->DisplayOrder < table->FreezeColumnsRequest) |
| { |
| max_width = (table->InnerClipRect.Max.x - (table->FreezeColumnsRequest - column->DisplayOrder) * min_column_distance) - column->MinX; |
| max_width = max_width - table->OuterPaddingX - table->CellPaddingX - table->CellSpacingX2; |
| } |
| } |
| else if ((table->Flags & ImGuiTableFlags_NoKeepColumnsVisible) == 0) |
| { |
| // If horizontal scrolling if disabled, we apply a final lossless shrinking of columns in order to make |
| // sure they are all visible. Because of this we also know that all of the columns will always fit in |
| // table->WorkRect and therefore in table->InnerRect (because ScrollX is off) |
| // FIXME-TABLE: This is solved incorrectly but also quite a difficult problem to fix as we also want ClipRect width to match. |
| // See "table_width_distrib" and "table_width_keep_visible" tests |
| max_width = table->WorkRect.Max.x - (table->ColumnsEnabledCount - column->IndexWithinEnabledSet - 1) * min_column_distance - column->MinX; |
| //max_width -= table->CellSpacingX1; |
| max_width -= table->CellSpacingX2; |
| max_width -= table->CellPaddingX * 2.0f; |
| max_width -= table->OuterPaddingX; |
| } |
| return max_width; |
| } |
| |
| // Note this is meant to be stored in column->WidthAuto, please generally use the WidthAuto field |
| float ImGui::TableGetColumnWidthAuto(ImGuiTable* table, ImGuiTableColumn* column) |
| { |
| const float content_width_body = ImMax(column->ContentMaxXFrozen, column->ContentMaxXUnfrozen) - column->WorkMinX; |
| const float content_width_headers = column->ContentMaxXHeadersIdeal - column->WorkMinX; |
| float width_auto = content_width_body; |
| if (!(column->Flags & ImGuiTableColumnFlags_NoHeaderWidth)) |
| width_auto = ImMax(width_auto, content_width_headers); |
| |
| // Non-resizable fixed columns preserve their requested width |
| if ((column->Flags & ImGuiTableColumnFlags_WidthFixed) && column->InitStretchWeightOrWidth > 0.0f) |
| if (!(table->Flags & ImGuiTableFlags_Resizable) || (column->Flags & ImGuiTableColumnFlags_NoResize)) |
| width_auto = column->InitStretchWeightOrWidth; |
| |
| return ImMax(width_auto, table->MinColumnWidth); |
| } |
| |
| // 'width' = inner column width, without padding |
| void ImGui::TableSetColumnWidth(int column_n, float width) |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiTable* table = g.CurrentTable; |
| IM_ASSERT(table != NULL && table->IsLayoutLocked == false); |
| IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount); |
| ImGuiTableColumn* column_0 = &table->Columns[column_n]; |
| float column_0_width = width; |
| |
| // Apply constraints early |
| // Compare both requested and actual given width to avoid overwriting requested width when column is stuck (minimum size, bounded) |
| IM_ASSERT(table->MinColumnWidth > 0.0f); |
| const float min_width = table->MinColumnWidth; |
| const float max_width = ImMax(min_width, TableGetMaxColumnWidth(table, column_n)); |
| column_0_width = ImClamp(column_0_width, min_width, max_width); |
| if (column_0->WidthGiven == column_0_width || column_0->WidthRequest == column_0_width) |
| return; |
| |
| //IMGUI_DEBUG_PRINT("TableSetColumnWidth(%d, %.1f->%.1f)\n", column_0_idx, column_0->WidthGiven, column_0_width); |
| ImGuiTableColumn* column_1 = (column_0->NextEnabledColumn != -1) ? &table->Columns[column_0->NextEnabledColumn] : NULL; |
| |
| // In this surprisingly not simple because of how we support mixing Fixed and multiple Stretch columns. |
| // - All fixed: easy. |
| // - All stretch: easy. |
| // - One or more fixed + one stretch: easy. |
| // - One or more fixed + more than one stretch: tricky. |
| // Qt when manual resize is enabled only supports a single _trailing_ stretch column, we support more cases here. |
| |
| // When forwarding resize from Wn| to Fn+1| we need to be considerate of the _NoResize flag on Fn+1. |
| // FIXME-TABLE: Find a way to rewrite all of this so interactions feel more consistent for the user. |
| // Scenarios: |
| // - F1 F2 F3 resize from F1| or F2| --> ok: alter ->WidthRequested of Fixed column. Subsequent columns will be offset. |
| // - F1 F2 F3 resize from F3| --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered. |
| // - F1 F2 W3 resize from F1| or F2| --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered, but it doesn't make much sense as the Stretch column will always be minimal size. |
| // - F1 F2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1) |
| // - W1 W2 W3 resize from W1| or W2| --> ok |
| // - W1 W2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1) |
| // - W1 F2 F3 resize from F3| --> ok: no-op (disabled by Resize Rule 1) |
| // - W1 F2 resize from F2| --> ok: no-op (disabled by Resize Rule 1) |
| // - W1 W2 F3 resize from W1| or W2| --> ok |
| // - W1 F2 W3 resize from W1| or F2| --> ok |
| // - F1 W2 F3 resize from W2| --> ok |
| // - F1 W3 F2 resize from W3| --> ok |
| // - W1 F2 F3 resize from W1| --> ok: equivalent to resizing |F2. F3 will not move. |
| // - W1 F2 F3 resize from F2| --> ok |
| // All resizes from a Wx columns are locking other columns. |
| |
| // Possible improvements: |
| // - W1 W2 W3 resize W1| --> to not be stuck, both W2 and W3 would stretch down. Seems possible to fix. Would be most beneficial to simplify resize of all-weighted columns. |
| // - W3 F1 F2 resize W3| --> to not be stuck past F1|, both F1 and F2 would need to stretch down, which would be lossy or ambiguous. Seems hard to fix. |
| |
| // [Resize Rule 1] Can't resize from right of right-most visible column if there is any Stretch column. Implemented in TableUpdateLayout(). |
| |
| // If we have all Fixed columns OR resizing a Fixed column that doesn't come after a Stretch one, we can do an offsetting resize. |
| // This is the preferred resize path |
| if (column_0->Flags & ImGuiTableColumnFlags_WidthFixed) |
| if (!column_1 || table->LeftMostStretchedColumn == -1 || table->Columns[table->LeftMostStretchedColumn].DisplayOrder >= column_0->DisplayOrder) |
| { |
| column_0->WidthRequest = column_0_width; |
| table->IsSettingsDirty = true; |
| return; |
| } |
| |
| // We can also use previous column if there's no next one (this is used when doing an auto-fit on the right-most stretch column) |
| if (column_1 == NULL) |
| column_1 = (column_0->PrevEnabledColumn != -1) ? &table->Columns[column_0->PrevEnabledColumn] : NULL; |
| if (column_1 == NULL) |
| return; |
| |
| // Resizing from right-side of a Stretch column before a Fixed column forward sizing to left-side of fixed column. |
| // (old_a + old_b == new_a + new_b) --> (new_a == old_a + old_b - new_b) |
| float column_1_width = ImMax(column_1->WidthRequest - (column_0_width - column_0->WidthRequest), min_width); |
| column_0_width = column_0->WidthRequest + column_1->WidthRequest - column_1_width; |
| IM_ASSERT(column_0_width > 0.0f && column_1_width > 0.0f); |
| column_0->WidthRequest = column_0_width; |
| column_1->WidthRequest = column_1_width; |
| if ((column_0->Flags | column_1->Flags) & ImGuiTableColumnFlags_WidthStretch) |
| TableUpdateColumnsWeightFromWidth(table); |
| table->IsSettingsDirty = true; |
| } |
| |
| // Disable clipping then auto-fit, will take 2 frames |
| // (we don't take a shortcut for unclipped columns to reduce inconsistencies when e.g. resizing multiple columns) |
| void ImGui::TableSetColumnWidthAutoSingle(ImGuiTable* table, int column_n) |
| { |
| // Single auto width uses auto-fit |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| if (!column->IsEnabled) |
| return; |
| column->CannotSkipItemsQueue = (1 << 0); |
| table->AutoFitSingleColumn = (ImGuiTableColumnIdx)column_n; |
| } |
| |
| void ImGui::TableSetColumnWidthAutoAll(ImGuiTable* table) |
| { |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| { |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| if (!column->IsEnabled && !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) // Cannot reset weight of hidden stretch column |
| continue; |
| column->CannotSkipItemsQueue = (1 << 0); |
| column->AutoFitQueue = (1 << 1); |
| } |
| } |
| |
| void ImGui::TableUpdateColumnsWeightFromWidth(ImGuiTable* table) |
| { |
| IM_ASSERT(table->LeftMostStretchedColumn != -1 && table->RightMostStretchedColumn != -1); |
| |
| // Measure existing quantities |
| float visible_weight = 0.0f; |
| float visible_width = 0.0f; |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| { |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) |
| continue; |
| IM_ASSERT(column->StretchWeight > 0.0f); |
| visible_weight += column->StretchWeight; |
| visible_width += column->WidthRequest; |
| } |
| IM_ASSERT(visible_weight > 0.0f && visible_width > 0.0f); |
| |
| // Apply new weights |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| { |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| if (!column->IsEnabled || !(column->Flags & ImGuiTableColumnFlags_WidthStretch)) |
| continue; |
| column->StretchWeight = (column->WidthRequest / visible_width) * visible_weight; |
| IM_ASSERT(column->StretchWeight > 0.0f); |
| } |
| } |
| |
| //------------------------------------------------------------------------- |
| // [SECTION] Tables: Drawing |
| //------------------------------------------------------------------------- |
| // - TablePushBackgroundChannel() [Internal] |
| // - TablePopBackgroundChannel() [Internal] |
| // - TableSetupDrawChannels() [Internal] |
| // - TableMergeDrawChannels() [Internal] |
| // - TableGetColumnBorderCol() [Internal] |
| // - TableDrawBorders() [Internal] |
| //------------------------------------------------------------------------- |
| |
| // Bg2 is used by Selectable (and possibly other widgets) to render to the background. |
| // Unlike our Bg0/1 channel which we uses for RowBg/CellBg/Borders and where we guarantee all shapes to be CPU-clipped, the Bg2 channel being widgets-facing will rely on regular ClipRect. |
| void ImGui::TablePushBackgroundChannel() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiWindow* window = g.CurrentWindow; |
| ImGuiTable* table = g.CurrentTable; |
| |
| // Optimization: avoid SetCurrentChannel() + PushClipRect() |
| table->HostBackupInnerClipRect = window->ClipRect; |
| SetWindowClipRectBeforeSetChannel(window, table->Bg2ClipRectForDrawCmd); |
| table->DrawSplitter->SetCurrentChannel(window->DrawList, table->Bg2DrawChannelCurrent); |
| } |
| |
| void ImGui::TablePopBackgroundChannel() |
| { |
| ImGuiContext& g = *GImGui; |
| ImGuiWindow* window = g.CurrentWindow; |
| ImGuiTable* table = g.CurrentTable; |
| ImGuiTableColumn* column = &table->Columns[table->CurrentColumn]; |
| |
| // Optimization: avoid PopClipRect() + SetCurrentChannel() |
| SetWindowClipRectBeforeSetChannel(window, table->HostBackupInnerClipRect); |
| table->DrawSplitter->SetCurrentChannel(window->DrawList, column->DrawChannelCurrent); |
| } |
| |
| // Allocate draw channels. Called by TableUpdateLayout() |
| // - We allocate them following storage order instead of display order so reordering columns won't needlessly |
| // increase overall dormant memory cost. |
| // - We isolate headers draw commands in their own channels instead of just altering clip rects. |
| // This is in order to facilitate merging of draw commands. |
| // - After crossing FreezeRowsCount, all columns see their current draw channel changed to a second set of channels. |
| // - We only use the dummy draw channel so we can push a null clipping rectangle into it without affecting other |
| // channels, while simplifying per-row/per-cell overhead. It will be empty and discarded when merged. |
| // - We allocate 1 or 2 background draw channels. This is because we know TablePushBackgroundChannel() is only used for |
| // horizontal spanning. If we allowed vertical spanning we'd need one background draw channel per merge group (1-4). |
| // Draw channel allocation (before merging): |
| // - NoClip --> 2+D+1 channels: bg0/1 + bg2 + foreground (same clip rect == always 1 draw call) |
| // - Clip --> 2+D+N channels |
| // - FreezeRows --> 2+D+N*2 (unless scrolling value is zero) |
| // - FreezeRows || FreezeColunns --> 3+D+N*2 (unless scrolling value is zero) |
| // Where D is 1 if any column is clipped or hidden (dummy channel) otherwise 0. |
| void ImGui::TableSetupDrawChannels(ImGuiTable* table) |
| { |
| const int freeze_row_multiplier = (table->FreezeRowsCount > 0) ? 2 : 1; |
| const int channels_for_row = (table->Flags & ImGuiTableFlags_NoClip) ? 1 : table->ColumnsEnabledCount; |
| const int channels_for_bg = 1 + 1 * freeze_row_multiplier; |
| const int channels_for_dummy = (table->ColumnsEnabledCount < table->ColumnsCount || (memcmp(table->VisibleMaskByIndex, table->EnabledMaskByIndex, ImBitArrayGetStorageSizeInBytes(table->ColumnsCount)) != 0)) ? +1 : 0; |
| const int channels_total = channels_for_bg + (channels_for_row * freeze_row_multiplier) + channels_for_dummy; |
| table->DrawSplitter->Split(table->InnerWindow->DrawList, channels_total); |
| table->DummyDrawChannel = (ImGuiTableDrawChannelIdx)((channels_for_dummy > 0) ? channels_total - 1 : -1); |
| table->Bg2DrawChannelCurrent = TABLE_DRAW_CHANNEL_BG2_FROZEN; |
| table->Bg2DrawChannelUnfrozen = (ImGuiTableDrawChannelIdx)((table->FreezeRowsCount > 0) ? 2 + channels_for_row : TABLE_DRAW_CHANNEL_BG2_FROZEN); |
| |
| int draw_channel_current = 2; |
| for (int column_n = 0; column_n < table->ColumnsCount; column_n++) |
| { |
| ImGuiTableColumn* column = &table->Columns[column_n]; |
| if (column->IsVisibleX && column->IsVisibleY) |
| { |
| column->DrawChannelFrozen = (ImGuiTableDrawChannelIdx)(draw_channel_current); |
| column->DrawChannelUnf
|