imgui_tables.cpp 153 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150
  1. // dear imgui, v1.80 WIP
  2. // (tables and columns code)
  3. /*
  4. *
  5. * Index of this file:
  6. *
  7. * // [SECTION] Widgets: BeginTable, EndTable, etc.
  8. * // [SECTION] Widgets: Columns, BeginColumns, EndColumns, etc.
  9. *
  10. */
  11. #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
  12. #define _CRT_SECURE_NO_WARNINGS
  13. #endif
  14. #include "imgui.h"
  15. #ifndef IMGUI_DISABLE
  16. #ifndef IMGUI_DEFINE_MATH_OPERATORS
  17. #define IMGUI_DEFINE_MATH_OPERATORS
  18. #endif
  19. #include "imgui_internal.h"
  20. #if defined(_MSC_VER) && _MSC_VER <= 1500 // MSVC 2008 or earlier
  21. #include <stddef.h> // intptr_t
  22. #else
  23. #include <stdint.h> // intptr_t
  24. #endif
  25. // Visual Studio warnings
  26. #ifdef _MSC_VER
  27. #pragma warning (disable: 4127) // condition expression is constant
  28. #pragma warning (disable: 4996) // 'This function or variable may be unsafe': strcpy, strdup, sprintf, vsnprintf, sscanf, fopen
  29. #if defined(_MSC_VER) && _MSC_VER >= 1922 // MSVC 2019 16.2 or later
  30. #pragma warning (disable: 5054) // operator '|': deprecated between enumerations of different types
  31. #endif
  32. #endif
  33. // Clang/GCC warnings with -Weverything
  34. #if defined(__clang__)
  35. #if __has_warning("-Wunknown-warning-option")
  36. #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!
  37. #endif
  38. #pragma clang diagnostic ignored "-Wunknown-pragmas" // warning: unknown warning group 'xxx'
  39. #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse.
  40. #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.
  41. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness
  42. #pragma clang diagnostic ignored "-Wzero-as-null-pointer-constant" // warning: zero as null pointer constant // some standard header variations use #define NULL 0
  43. #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.
  44. #pragma clang diagnostic ignored "-Wenum-enum-conversion" // warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_')
  45. #pragma clang diagnostic ignored "-Wdeprecated-enum-enum-conversion"// warning: bitwise operation between different enumeration types ('XXXFlags_' and 'XXXFlagsPrivate_') is deprecated
  46. #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision
  47. #elif defined(__GNUC__)
  48. #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind
  49. #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
  50. #endif
  51. //-----------------------------------------------------------------------------
  52. // [SECTION] Widgets: BeginTable, EndTable, etc.
  53. //-----------------------------------------------------------------------------
  54. //-----------------------------------------------------------------------------
  55. // Typical call flow: (root level is public API):
  56. // - BeginTable() user begin into a table
  57. // | BeginChild() - (if ScrollX/ScrollY is set)
  58. // | TableBeginUpdateColumns() - apply resize/order requests, lock columns active state, order
  59. // | - TableSetColumnWidth() - apply resizing width (for mouse resize, often requested by previous frame)
  60. // | - TableUpdateColumnsWeightFromWidth()- recompute columns weights (of weighted columns) from their respective width
  61. // - TableSetupColumn() user submit columns details (optional)
  62. // - TableAutoHeaders() or TableHeader() user submit a headers row (optional)
  63. // | TableSortSpecsClickColumn() - when clicked: alter sort order and sort direction
  64. // - TableGetSortSpecs() user queries updated sort specs (optional, generally after submitting headers)
  65. // - TableNextRow() / TableNextCell() user begin into the first row, also automatically called by TableAutoHeaders()
  66. // | TableUpdateLayout() - lock all widths and columns positions! called by the FIRST call to TableNextRow()!
  67. // | - TableUpdateDrawChannels() - setup ImDrawList channels
  68. // | - TableUpdateBorders() - detect hovering columns for resize, ahead of contents submission
  69. // | - TableDrawContextMenu() - draw right-click context menu
  70. // | TableEndCell() - close existing cell if not the first time
  71. // | TableBeginCell() - enter into current cell
  72. // - [...] user emit contents
  73. // - EndTable() user ends the table
  74. // | TableDrawBorders() - draw outer borders, inner vertical borders
  75. // | TableDrawMergeChannels() - merge draw channels if clipping isn't required
  76. // | EndChild() - (if ScrollX/ScrollY is set)
  77. //-----------------------------------------------------------------------------
  78. // Configuration
  79. static const float TABLE_RESIZE_SEPARATOR_HALF_THICKNESS = 4.0f; // Extend outside inner borders.
  80. 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.
  81. // Helper
  82. inline ImGuiTableFlags TableFixFlags(ImGuiTableFlags flags)
  83. {
  84. // Adjust flags: set default sizing policy
  85. if ((flags & ImGuiTableFlags_SizingPolicyMaskX_) == 0)
  86. flags |= (flags & ImGuiTableFlags_ScrollX) ? ImGuiTableFlags_SizingPolicyFixedX : ImGuiTableFlags_SizingPolicyStretchX;
  87. // Adjust flags: MultiSortable automatically enable Sortable
  88. if (flags & ImGuiTableFlags_MultiSortable)
  89. flags |= ImGuiTableFlags_Sortable;
  90. // Adjust flags: disable saved settings if there's nothing to save
  91. if ((flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Hideable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Sortable)) == 0)
  92. flags |= ImGuiTableFlags_NoSavedSettings;
  93. // Adjust flags: enforce borders when resizable
  94. if (flags & ImGuiTableFlags_Resizable)
  95. flags |= ImGuiTableFlags_BordersVInner;
  96. // Adjust flags: disable top rows freezing if there's no scrolling.
  97. // We could want to assert if ScrollFreeze was set without the corresponding scroll flag, but that would hinder demos.
  98. if ((flags & ImGuiTableFlags_ScrollX) == 0)
  99. flags &= ~ImGuiTableFlags_ScrollFreezeColumnsMask_;
  100. if ((flags & ImGuiTableFlags_ScrollY) == 0)
  101. flags &= ~ImGuiTableFlags_ScrollFreezeRowsMask_;
  102. // Adjust flags: disable NoHostExtendY if we have any scrolling going on
  103. if ((flags & ImGuiTableFlags_NoHostExtendY) && (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) != 0)
  104. flags &= ~ImGuiTableFlags_NoHostExtendY;
  105. // Adjust flags: we don't support NoClipX with (FreezeColumns > 0)
  106. // We could with some work but it doesn't appear to be worth the effort.
  107. if (flags & ImGuiTableFlags_ScrollFreezeColumnsMask_)
  108. flags &= ~ImGuiTableFlags_NoClipX;
  109. return flags;
  110. }
  111. ImGuiTable* ImGui::FindTableByID(ImGuiID id)
  112. {
  113. ImGuiContext& g = *GImGui;
  114. return g.Tables.GetByKey(id);
  115. }
  116. // (Read carefully because this is subtle but it does make sense!)
  117. // About 'outer_size', its meaning needs to differ slightly depending of if we are using ScrollX/ScrollY flags:
  118. // X:
  119. // - outer_size.x < 0.0f -> right align from window/work-rect maximum x edge.
  120. // - outer_size.x = 0.0f -> auto enlarge, use all available space.
  121. // - outer_size.x > 0.0f -> fixed width
  122. // Y with ScrollX/ScrollY: using a child window for scrolling:
  123. // - outer_size.y < 0.0f -> bottom align
  124. // - outer_size.y = 0.0f -> bottom align, consistent with BeginChild(). not recommended unless table is last item in parent window.
  125. // - outer_size.y > 0.0f -> fixed child height. recommended when using Scrolling on any axis.
  126. // Y without scrolling, we output table directly in parent window:
  127. // - outer_size.y < 0.0f -> bottom align (will auto extend, unless NoHostExtendV is set)
  128. // - outer_size.y = 0.0f -> zero minimum height (will auto extend, unless NoHostExtendV is set)
  129. // - outer_size.y > 0.0f -> minimum height (will auto extend, unless NoHostExtendV is set)
  130. // About 'inner_width':
  131. // With ScrollX:
  132. // - inner_width < 0.0f -> *illegal* fit in known width (right align from outer_size.x) <-- weird
  133. // - 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.
  134. // - 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!
  135. // Without ScrollX:
  136. // - inner_width -> *ignored*
  137. // Details:
  138. // - If you want to use Stretch columns with ScrollX, you generally need to specify 'inner_width' otherwise the concept
  139. // of "available space" doesn't make sense.
  140. // - Even if not really useful, we allow 'inner_width < outer_size.x' for consistency and to facilitate understanding
  141. // of what the value does.
  142. bool ImGui::BeginTable(const char* str_id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width)
  143. {
  144. ImGuiID id = GetID(str_id);
  145. return BeginTableEx(str_id, id, columns_count, flags, outer_size, inner_width);
  146. }
  147. bool ImGui::BeginTableEx(const char* name, ImGuiID id, int columns_count, ImGuiTableFlags flags, const ImVec2& outer_size, float inner_width)
  148. {
  149. ImGuiContext& g = *GImGui;
  150. ImGuiWindow* outer_window = GetCurrentWindow();
  151. if (outer_window->SkipItems) // Consistent with other tables + beneficial side effect that assert on miscalling EndTable() will be more visible.
  152. return false;
  153. // Sanity checks
  154. IM_ASSERT(columns_count > 0 && columns_count <= IMGUI_TABLE_MAX_COLUMNS && "Only 1..64 columns allowed!");
  155. if (flags & ImGuiTableFlags_ScrollX)
  156. IM_ASSERT(inner_width >= 0.0f);
  157. const bool use_child_window = (flags & (ImGuiTableFlags_ScrollX | ImGuiTableFlags_ScrollY)) != 0;
  158. const ImVec2 avail_size = GetContentRegionAvail();
  159. ImVec2 actual_outer_size = CalcItemSize(outer_size, ImMax(avail_size.x, 1.0f), use_child_window ? ImMax(avail_size.y, 1.0f) : 0.0f);
  160. ImRect outer_rect(outer_window->DC.CursorPos, outer_window->DC.CursorPos + actual_outer_size);
  161. // If an outer size is specified ahead we will be able to early out when not visible. Exact clipping rules may evolve.
  162. if (use_child_window && IsClippedEx(outer_rect, 0, false))
  163. {
  164. ItemSize(outer_rect);
  165. return false;
  166. }
  167. flags = TableFixFlags(flags);
  168. if (outer_window->Flags & ImGuiWindowFlags_NoSavedSettings)
  169. flags |= ImGuiTableFlags_NoSavedSettings;
  170. // Acquire storage for the table
  171. ImGuiTable* table = g.Tables.GetOrAddByKey(id);
  172. const ImGuiTableFlags table_last_flags = table->Flags;
  173. const int instance_no = (table->LastFrameActive != g.FrameCount) ? 0 : table->InstanceCurrent + 1;
  174. const ImGuiID instance_id = id + instance_no;
  175. if (instance_no > 0)
  176. IM_ASSERT(table->ColumnsCount == columns_count && "BeginTable(): Cannot change columns count mid-frame while preserving same ID");
  177. // Initialize
  178. table->ID = id;
  179. table->Flags = flags;
  180. table->InstanceCurrent = (ImS16)instance_no;
  181. table->LastFrameActive = g.FrameCount;
  182. table->OuterWindow = table->InnerWindow = outer_window;
  183. table->ColumnsCount = columns_count;
  184. table->ColumnsNames.Buf.resize(0);
  185. table->IsInitializing = false;
  186. table->IsLayoutLocked = false;
  187. table->InnerWidth = inner_width;
  188. table->OuterRect = outer_rect;
  189. table->WorkRect = outer_rect;
  190. if (use_child_window)
  191. {
  192. // Ensure no vertical scrollbar appears if we only want horizontal one, to make flag consistent
  193. // (we have no other way to disable vertical scrollbar of a window while keeping the horizontal one showing)
  194. ImVec2 override_content_size(FLT_MAX, FLT_MAX);
  195. if ((flags & ImGuiTableFlags_ScrollX) && !(flags & ImGuiTableFlags_ScrollY))
  196. override_content_size.y = FLT_MIN;
  197. // Ensure specified width (when not specified, Stretched columns will act as if the width == OuterWidth and
  198. // never lead to any scrolling). We don't handle inner_width < 0.0f, we could potentially use it to right-align
  199. // based on the right side of the child window work rect, which would require knowing ahead if we are going to
  200. // have decoration taking horizontal spaces (typically a vertical scrollbar).
  201. if ((flags & ImGuiTableFlags_ScrollX) && inner_width > 0.0f)
  202. override_content_size.x = inner_width;
  203. if (override_content_size.x != FLT_MAX || override_content_size.y != FLT_MAX)
  204. 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));
  205. // Create scrolling region (without border = zero window padding)
  206. ImGuiWindowFlags child_flags = (flags & ImGuiTableFlags_ScrollX) ? ImGuiWindowFlags_HorizontalScrollbar : ImGuiWindowFlags_None;
  207. BeginChildEx(name, instance_id, table->OuterRect.GetSize(), false, child_flags);
  208. table->InnerWindow = g.CurrentWindow;
  209. table->WorkRect = table->InnerWindow->WorkRect;
  210. table->OuterRect = table->InnerWindow->Rect();
  211. }
  212. else
  213. {
  214. // WorkRect.Max will grow as we append contents.
  215. PushID(instance_id);
  216. }
  217. // Backup a copy of host window members we will modify
  218. ImGuiWindow* inner_window = table->InnerWindow;
  219. table->HostIndentX = inner_window->DC.Indent.x;
  220. table->HostClipRect = inner_window->ClipRect;
  221. table->HostSkipItems = inner_window->SkipItems;
  222. table->HostWorkRect = inner_window->WorkRect;
  223. table->HostCursorMaxPos = inner_window->DC.CursorMaxPos;
  224. // Borders
  225. // - None ........Content..... Pad .....Content........
  226. // - VOuter | Pad ..Content..... Pad .....Content.. Pad | // FIXME-TABLE: Not handled properly
  227. // - VInner ........Content.. Pad | Pad ..Content........ // FIXME-TABLE: Not handled properly
  228. // - VOuter+VInner | Pad ..Content.. Pad | Pad ..Content.. Pad |
  229. const bool has_cell_padding_x = (flags & ImGuiTableFlags_BordersVOuter) != 0;
  230. table->CellPaddingX1 = has_cell_padding_x ? g.Style.CellPadding.x + 1.0f : 0.0f;
  231. table->CellPaddingX2 = has_cell_padding_x ? g.Style.CellPadding.x : 0.0f;
  232. table->CellPaddingY = g.Style.CellPadding.y;
  233. table->CellSpacingX = has_cell_padding_x ? 0.0f : g.Style.CellPadding.x;
  234. table->CurrentColumn = -1;
  235. table->CurrentRow = -1;
  236. table->RowBgColorCounter = 0;
  237. table->LastRowFlags = ImGuiTableRowFlags_None;
  238. table->InnerClipRect = (inner_window == outer_window) ? table->WorkRect : inner_window->ClipRect;
  239. table->InnerClipRect.ClipWith(table->WorkRect); // We need this to honor inner_width
  240. table->InnerClipRect.ClipWith(table->HostClipRect);
  241. table->InnerClipRect.Max.y = (flags & ImGuiTableFlags_NoHostExtendY) ? table->WorkRect.Max.y : inner_window->ClipRect.Max.y;
  242. table->BackgroundClipRect = table->InnerClipRect;
  243. table->RowPosY1 = table->RowPosY2 = table->WorkRect.Min.y; // This is needed somehow
  244. table->RowTextBaseline = 0.0f; // This will be cleared again by TableBeginRow()
  245. table->FreezeRowsRequest = (ImS8)((flags & ImGuiTableFlags_ScrollFreezeRowsMask_) >> ImGuiTableFlags_ScrollFreezeRowsShift_);
  246. table->FreezeRowsCount = (inner_window->Scroll.y != 0.0f) ? table->FreezeRowsRequest : 0;
  247. table->FreezeColumnsRequest = (ImS8)((flags & ImGuiTableFlags_ScrollFreezeColumnsMask_) >> ImGuiTableFlags_ScrollFreezeColumnsShift_);
  248. table->FreezeColumnsCount = (inner_window->Scroll.x != 0.0f) ? table->FreezeColumnsRequest : 0;
  249. table->IsFreezeRowsPassed = (table->FreezeRowsCount == 0);
  250. table->DeclColumnsCount = 0;
  251. table->HoveredColumnBody = -1;
  252. table->HoveredColumnBorder = -1;
  253. table->RightMostVisibleColumn = -1;
  254. // Using opaque colors facilitate overlapping elements of the grid
  255. table->BorderColorStrong = GetColorU32(ImGuiCol_TableBorderStrong);
  256. table->BorderColorLight = GetColorU32(ImGuiCol_TableBorderLight);
  257. table->BorderX1 = table->InnerClipRect.Min.x;// +((table->Flags & ImGuiTableFlags_BordersOuter) ? 0.0f : -1.0f);
  258. table->BorderX2 = table->InnerClipRect.Max.x;// +((table->Flags & ImGuiTableFlags_BordersOuter) ? 0.0f : +1.0f);
  259. // Make table current
  260. g.CurrentTableStack.push_back(ImGuiPtrOrIndex(g.Tables.GetIndex(table)));
  261. g.CurrentTable = table;
  262. outer_window->DC.CurrentTable = table;
  263. if ((table_last_flags & ImGuiTableFlags_Reorderable) && !(flags & ImGuiTableFlags_Reorderable))
  264. table->IsResetDisplayOrderRequest = true;
  265. // Setup default columns state. Clear data if columns count changed
  266. const int stored_size = table->Columns.size();
  267. if (stored_size != 0 && stored_size != columns_count)
  268. table->RawData.resize(0);
  269. if (table->RawData.Size == 0)
  270. {
  271. // Allocate single buffer for our arrays
  272. ImSpanAllocator<2> span_allocator;
  273. span_allocator.ReserveBytes(0, columns_count * sizeof(ImGuiTableColumn));
  274. span_allocator.ReserveBytes(1, columns_count * sizeof(ImS8));
  275. table->RawData.resize(span_allocator.GetArenaSizeInBytes());
  276. span_allocator.SetArenaBasePtr(table->RawData.Data);
  277. span_allocator.GetSpan(0, &table->Columns);
  278. span_allocator.GetSpan(1, &table->DisplayOrderToIndex);
  279. for (int n = 0; n < columns_count; n++)
  280. {
  281. table->Columns[n] = ImGuiTableColumn();
  282. table->Columns[n].DisplayOrder = table->DisplayOrderToIndex[n] = (ImS8)n;
  283. }
  284. table->IsInitializing = table->IsSettingsRequestLoad = table->IsSortSpecsDirty = true;
  285. }
  286. // Load settings
  287. if (table->IsSettingsRequestLoad)
  288. TableLoadSettings(table);
  289. // Handle DPI/font resize
  290. // This is designed to facilitate DPI changes with the assumption that e.g. style.CellPadding has been scaled as well.
  291. // It will also react to changing fonts with mixed results. It doesn't need to be perfect but merely provide a decent transition.
  292. // FIXME-DPI: Provide consistent standards for reference size. Perhaps using g.CurrentDpiScale would be more self explanatory.
  293. // This is will lead us to non-rounded WidthRequest in columns, which should work but is a poorly tested path.
  294. const float new_ref_scale_unit = g.FontSize; // g.Font->GetCharAdvance('A') ?
  295. if (table->RefScale != 0.0f && table->RefScale != new_ref_scale_unit)
  296. {
  297. const float scale_factor = new_ref_scale_unit / table->RefScale;
  298. //IMGUI_DEBUG_LOG("[table] %08X RefScaleUnit %.3f -> %.3f, scaling width by %.3f\n", table->ID, table->RefScaleUnit, new_ref_scale_unit, scale_factor);
  299. for (int n = 0; n < columns_count; n++)
  300. table->Columns[n].WidthRequest = table->Columns[n].WidthRequest * scale_factor;
  301. }
  302. table->RefScale = new_ref_scale_unit;
  303. // Disable output until user calls TableNextRow() or TableNextCell() leading to the TableUpdateLayout() call..
  304. // This is not strictly necessary but will reduce cases were "out of table" output will be misleading to the user.
  305. // Because we cannot safely assert in EndTable() when no rows have been created, this seems like our best option.
  306. inner_window->SkipItems = true;
  307. // Update/lock which columns will be Visible for the frame
  308. TableBeginUpdateColumns(table);
  309. return true;
  310. }
  311. void ImGui::TableBeginUpdateColumns(ImGuiTable* table)
  312. {
  313. // Handle resizing request
  314. // (We process this at the first TableBegin of the frame)
  315. // FIXME-TABLE: Preserve contents width _while resizing down_ until releasing.
  316. // FIXME-TABLE: Contains columns if our work area doesn't allow for scrolling.
  317. if (table->InstanceCurrent == 0)
  318. {
  319. if (table->ResizedColumn != -1 && table->ResizedColumnNextWidth != FLT_MAX)
  320. TableSetColumnWidth(table, &table->Columns[table->ResizedColumn], table->ResizedColumnNextWidth);
  321. table->LastResizedColumn = table->ResizedColumn;
  322. table->ResizedColumnNextWidth = FLT_MAX;
  323. table->ResizedColumn = -1;
  324. }
  325. // Handle reordering request
  326. // Note: we don't clear ReorderColumn after handling the request.
  327. if (table->InstanceCurrent == 0)
  328. {
  329. if (table->HeldHeaderColumn == -1 && table->ReorderColumn != -1)
  330. table->ReorderColumn = -1;
  331. table->HeldHeaderColumn = -1;
  332. if (table->ReorderColumn != -1 && table->ReorderColumnDir != 0)
  333. {
  334. // We need to handle reordering across hidden columns.
  335. // In the configuration below, moving C to the right of E will lead to:
  336. // ... C [D] E ---> ... [D] E C (Column name/index)
  337. // ... 2 3 4 ... 2 3 4 (Display order)
  338. const int reorder_dir = table->ReorderColumnDir;
  339. IM_ASSERT(reorder_dir == -1 || reorder_dir == +1);
  340. IM_ASSERT(table->Flags & ImGuiTableFlags_Reorderable);
  341. ImGuiTableColumn* src_column = &table->Columns[table->ReorderColumn];
  342. ImGuiTableColumn* dst_column = &table->Columns[(reorder_dir == -1) ? src_column->PrevVisibleColumn : src_column->NextVisibleColumn];
  343. IM_UNUSED(dst_column);
  344. const int src_order = src_column->DisplayOrder;
  345. const int dst_order = dst_column->DisplayOrder;
  346. src_column->DisplayOrder = (ImS8)dst_order;
  347. for (int order_n = src_order + reorder_dir; order_n != dst_order + reorder_dir; order_n += reorder_dir)
  348. table->Columns[table->DisplayOrderToIndex[order_n]].DisplayOrder -= (ImS8)reorder_dir;
  349. IM_ASSERT(dst_column->DisplayOrder == dst_order - reorder_dir);
  350. // Display order is stored in both columns->IndexDisplayOrder and table->DisplayOrder[],
  351. // rebuild the later from the former.
  352. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  353. table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImS8)column_n;
  354. table->ReorderColumnDir = 0;
  355. table->IsSettingsDirty = true;
  356. }
  357. }
  358. // Handle display order reset request
  359. if (table->IsResetDisplayOrderRequest)
  360. {
  361. for (int n = 0; n < table->ColumnsCount; n++)
  362. table->DisplayOrderToIndex[n] = table->Columns[n].DisplayOrder = (ImS8)n;
  363. table->IsResetDisplayOrderRequest = false;
  364. table->IsSettingsDirty = true;
  365. }
  366. // Setup and lock Visible state and order
  367. table->ColumnsVisibleCount = 0;
  368. table->IsDefaultDisplayOrder = true;
  369. ImGuiTableColumn* last_visible_column = NULL;
  370. bool want_column_auto_fit = false;
  371. for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
  372. {
  373. const int column_n = table->DisplayOrderToIndex[order_n];
  374. if (column_n != order_n)
  375. table->IsDefaultDisplayOrder = false;
  376. ImGuiTableColumn* column = &table->Columns[column_n];
  377. column->NameOffset = -1;
  378. if (!(table->Flags & ImGuiTableFlags_Hideable) || (column->Flags & ImGuiTableColumnFlags_NoHide))
  379. column->IsVisibleNextFrame = true;
  380. if (column->IsVisible != column->IsVisibleNextFrame)
  381. {
  382. column->IsVisible = column->IsVisibleNextFrame;
  383. table->IsSettingsDirty = true;
  384. if (!column->IsVisible && column->SortOrder != -1)
  385. table->IsSortSpecsDirty = true;
  386. }
  387. if (column->SortOrder > 0 && !(table->Flags & ImGuiTableFlags_MultiSortable))
  388. table->IsSortSpecsDirty = true;
  389. if (column->AutoFitQueue != 0x00)
  390. want_column_auto_fit = true;
  391. ImU64 index_mask = (ImU64)1 << column_n;
  392. ImU64 display_order_mask = (ImU64)1 << column->DisplayOrder;
  393. if (column->IsVisible)
  394. {
  395. column->PrevVisibleColumn = column->NextVisibleColumn = -1;
  396. if (last_visible_column)
  397. {
  398. last_visible_column->NextVisibleColumn = (ImS8)column_n;
  399. column->PrevVisibleColumn = (ImS8)table->Columns.index_from_ptr(last_visible_column);
  400. }
  401. column->IndexWithinVisibleSet = (ImS8)table->ColumnsVisibleCount;
  402. table->ColumnsVisibleCount++;
  403. table->VisibleMaskByIndex |= index_mask;
  404. table->VisibleMaskByDisplayOrder |= display_order_mask;
  405. last_visible_column = column;
  406. }
  407. else
  408. {
  409. column->IndexWithinVisibleSet = -1;
  410. table->VisibleMaskByIndex &= ~index_mask;
  411. table->VisibleMaskByDisplayOrder &= ~display_order_mask;
  412. }
  413. IM_ASSERT(column->IndexWithinVisibleSet <= column->DisplayOrder);
  414. }
  415. table->VisibleUnclippedMaskByIndex = table->VisibleMaskByIndex; // Columns will be masked out by TableUpdateLayout() when Clipped
  416. table->RightMostVisibleColumn = (ImS8)(last_visible_column ? table->Columns.index_from_ptr(last_visible_column) : -1);
  417. // Disable child window clipping while fitting columns. This is not strictly necessary but makes it possible to avoid
  418. // the column fitting to wait until the first visible frame of the child container (may or not be a good thing).
  419. if (want_column_auto_fit && table->OuterWindow != table->InnerWindow)
  420. table->InnerWindow->SkipItems = false;
  421. }
  422. void ImGui::TableUpdateDrawChannels(ImGuiTable* table)
  423. {
  424. // Allocate draw channels.
  425. // - We allocate them following storage order instead of display order so reordering columns won't needlessly
  426. // increase overall dormant memory cost.
  427. // - We isolate headers draw commands in their own channels instead of just altering clip rects.
  428. // This is in order to facilitate merging of draw commands.
  429. // - After crossing FreezeRowsCount, all columns see their current draw channel changed to a second set of channels.
  430. // - We only use the dummy draw channel so we can push a null clipping rectangle into it without affecting other
  431. // channels, while simplifying per-row/per-cell overhead. It will be empty and discarded when merged.
  432. // Draw channel allocation (before merging):
  433. // - NoClip --> 1+1 channels: background + foreground (same clip rect == 1 draw call)
  434. // - Clip --> 1+N channels
  435. // - FreezeRows || FreezeColumns --> 1+N*2 (unless scrolling value is zero)
  436. // - FreezeRows && FreezeColunns --> 2+N*2 (unless scrolling value is zero)
  437. const int freeze_row_multiplier = (table->FreezeRowsCount > 0) ? 2 : 1;
  438. const int channels_for_row = (table->Flags & ImGuiTableFlags_NoClipX) ? 1 : table->ColumnsVisibleCount;
  439. const int channels_for_background = 1;
  440. const int channels_for_dummy = (table->ColumnsVisibleCount < table->ColumnsCount || table->VisibleUnclippedMaskByIndex != table->VisibleMaskByIndex) ? +1 : 0;
  441. const int channels_total = channels_for_background + (channels_for_row * freeze_row_multiplier) + channels_for_dummy;
  442. table->DrawSplitter.Split(table->InnerWindow->DrawList, channels_total);
  443. table->DummyDrawChannel = channels_for_dummy ? (ImS8)(channels_total - 1) : -1;
  444. int draw_channel_current = 1;
  445. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  446. {
  447. ImGuiTableColumn* column = &table->Columns[column_n];
  448. if (!column->IsClipped)
  449. {
  450. column->DrawChannelRowsBeforeFreeze = (ImS8)(draw_channel_current);
  451. column->DrawChannelRowsAfterFreeze = (ImS8)(draw_channel_current + (table->FreezeRowsCount > 0 ? channels_for_row : 0));
  452. if (!(table->Flags & ImGuiTableFlags_NoClipX))
  453. draw_channel_current++;
  454. }
  455. else
  456. {
  457. column->DrawChannelRowsBeforeFreeze = column->DrawChannelRowsAfterFreeze = table->DummyDrawChannel;
  458. }
  459. column->DrawChannelCurrent = column->DrawChannelRowsBeforeFreeze;
  460. }
  461. }
  462. // Adjust flags: default width mode + weighted columns are not allowed when auto extending
  463. static ImGuiTableColumnFlags TableFixColumnFlags(ImGuiTable* table, ImGuiTableColumnFlags flags)
  464. {
  465. // Sizing Policy
  466. if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0)
  467. {
  468. // FIXME-TABLE: Inconsistent to promote columns to WidthAlwaysAutoResize
  469. if (table->Flags & ImGuiTableFlags_SizingPolicyFixedX)
  470. flags |= ((table->Flags & ImGuiTableFlags_Resizable) && !(flags & ImGuiTableColumnFlags_NoResize)) ? ImGuiTableColumnFlags_WidthFixed : ImGuiTableColumnFlags_WidthAlwaysAutoResize;
  471. else
  472. flags |= ImGuiTableColumnFlags_WidthStretch;
  473. }
  474. IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_WidthMask_)); // Check that only 1 of each set is used.
  475. if ((flags & ImGuiTableColumnFlags_WidthAlwaysAutoResize))// || ((flags & ImGuiTableColumnFlags_WidthStretch) && (table->Flags & ImGuiTableFlags_SizingPolicyStretchX)))
  476. flags |= ImGuiTableColumnFlags_NoResize;
  477. //if ((flags & ImGuiTableColumnFlags_WidthStretch) && (table->Flags & ImGuiTableFlags_SizingPolicyFixedX))
  478. // flags = (flags & ~ImGuiTableColumnFlags_WidthMask_) | ImGuiTableColumnFlags_WidthFixed;
  479. // Sorting
  480. if ((flags & ImGuiTableColumnFlags_NoSortAscending) && (flags & ImGuiTableColumnFlags_NoSortDescending))
  481. flags |= ImGuiTableColumnFlags_NoSort;
  482. // Alignment
  483. //if ((flags & ImGuiTableColumnFlags_AlignMask_) == 0)
  484. // flags |= ImGuiTableColumnFlags_AlignCenter;
  485. //IM_ASSERT(ImIsPowerOfTwo(flags & ImGuiTableColumnFlags_AlignMask_)); // Check that only 1 of each set is used.
  486. return flags;
  487. }
  488. static void TableFixColumnSortDirection(ImGuiTableColumn* column)
  489. {
  490. // Handle NoSortAscending/NoSortDescending
  491. if (column->SortDirection == ImGuiSortDirection_Ascending && (column->Flags & ImGuiTableColumnFlags_NoSortAscending))
  492. column->SortDirection = ImGuiSortDirection_Descending;
  493. else if (column->SortDirection == ImGuiSortDirection_Descending && (column->Flags & ImGuiTableColumnFlags_NoSortDescending))
  494. column->SortDirection = ImGuiSortDirection_Ascending;
  495. }
  496. static float TableGetMinColumnWidth()
  497. {
  498. ImGuiContext& g = *GImGui;
  499. // return g.Style.ColumnsMinSpacing;
  500. return g.Style.FramePadding.x * 3.0f;
  501. }
  502. // Layout columns for the frame
  503. // Runs on the first call to TableNextRow(), to give a chance for TableSetupColumn() to be called first.
  504. // FIXME-TABLE: Our width (and therefore our WorkRect) will be minimal in the first frame for WidthAlwaysAutoResize
  505. // columns, increase feedback side-effect with widgets relying on WorkRect.Max.x. Maybe provide a default distribution
  506. // for WidthAlwaysAutoResize columns?
  507. void ImGui::TableUpdateLayout(ImGuiTable* table)
  508. {
  509. IM_ASSERT(table->IsLayoutLocked == false);
  510. // Compute offset, clip rect for the frame
  511. // (can't make auto padding larger than what WorkRect knows about so right-alignment matches)
  512. const ImRect work_rect = table->WorkRect;
  513. const float padding_auto_x = table->CellPaddingX2;
  514. const float spacing_auto_x = table->CellSpacingX * (1.0f + 2.0f); // CellSpacingX is >0.0f when there's no vertical border, in which case we add two extra CellSpacingX to make auto-fit look nice instead of cramped. We may want to expose this somehow.
  515. const float min_column_width = TableGetMinColumnWidth();
  516. int count_fixed = 0;
  517. float sum_weights_stretched = 0.0f; // Sum of all weights for weighted columns.
  518. float sum_width_fixed_requests = 0.0f; // Sum of all width for fixed and auto-resize columns, excluding width contributed by Stretch columns.
  519. table->LeftMostStretchedColumnDisplayOrder = -1;
  520. table->ColumnsAutoFitWidth = 0.0f;
  521. for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
  522. {
  523. if (!(table->VisibleMaskByDisplayOrder & ((ImU64)1 << order_n)))
  524. continue;
  525. const int column_n = table->DisplayOrderToIndex[order_n];
  526. ImGuiTableColumn* column = &table->Columns[column_n];
  527. // Adjust flags: default width mode + weighted columns are not allowed when auto extending
  528. // FIXME-TABLE: Clarify why we need to do this again here and not just in TableSetupColumn()
  529. column->Flags = TableFixColumnFlags(table, column->FlagsIn);
  530. if ((column->Flags & ImGuiTableColumnFlags_IndentMask_) == 0)
  531. column->Flags |= (column_n == 0) ? ImGuiTableColumnFlags_IndentEnable : ImGuiTableColumnFlags_IndentDisable;
  532. // We have a unusual edge case where if the user doesn't call TableGetSortSpecs() but has sorting enabled
  533. // or varying sorting flags, we still want the sorting arrows to honor those flags.
  534. if (table->Flags & ImGuiTableFlags_Sortable)
  535. TableFixColumnSortDirection(column);
  536. // Calculate "ideal" column width for nothing to be clipped.
  537. // Combine width from regular rows + width from headers unless requested not to.
  538. const float column_content_width_rows = (float)ImMax(column->ContentWidthRowsFrozen, column->ContentWidthRowsUnfrozen);
  539. const float column_content_width_headers = (float)column->ContentWidthHeadersIdeal;
  540. float column_width_ideal = column_content_width_rows;
  541. if (!(table->Flags & ImGuiTableFlags_NoHeadersWidth) && !(column->Flags & ImGuiTableColumnFlags_NoHeaderWidth))
  542. column_width_ideal = ImMax(column_width_ideal, column_content_width_headers);
  543. column_width_ideal = ImMax(column_width_ideal + padding_auto_x, min_column_width);
  544. table->ColumnsAutoFitWidth += column_width_ideal;
  545. if (column->Flags & (ImGuiTableColumnFlags_WidthAlwaysAutoResize | ImGuiTableColumnFlags_WidthFixed))
  546. {
  547. // Latch initial size for fixed columns
  548. count_fixed += 1;
  549. const bool auto_fit = (column->AutoFitQueue != 0x00) || (column->Flags & ImGuiTableColumnFlags_WidthAlwaysAutoResize);
  550. if (auto_fit)
  551. {
  552. column->WidthRequest = column_width_ideal;
  553. // FIXME-TABLE: Increase minimum size during init frame to avoid biasing auto-fitting widgets
  554. // (e.g. TextWrapped) too much. Otherwise what tends to happen is that TextWrapped would output a very
  555. // large height (= first frame scrollbar display very off + clipper would skip lots of items).
  556. // This is merely making the side-effect less extreme, but doesn't properly fixes it.
  557. // FIXME: Move this to ->WidthGiven to avoid temporary lossyless?
  558. if (column->AutoFitQueue > 0x01 && table->IsInitializing)
  559. column->WidthRequest = ImMax(column->WidthRequest, min_column_width * 4.0f);
  560. }
  561. sum_width_fixed_requests += column->WidthRequest;
  562. }
  563. else
  564. {
  565. IM_ASSERT(column->Flags & ImGuiTableColumnFlags_WidthStretch);
  566. const int init_size = (column->WidthStretchWeight < 0.0f);
  567. if (init_size)
  568. column->WidthStretchWeight = 1.0f;
  569. sum_weights_stretched += column->WidthStretchWeight;
  570. if (table->LeftMostStretchedColumnDisplayOrder == -1)
  571. table->LeftMostStretchedColumnDisplayOrder = (ImS8)column->DisplayOrder;
  572. }
  573. }
  574. // CellSpacingX is >0.0f when there's no vertical border, in which case we add two extra CellSpacingX to make auto-fit look nice instead of cramped.
  575. // We may want to expose this somehow.
  576. table->ColumnsAutoFitWidth += spacing_auto_x * (table->ColumnsVisibleCount - 1);
  577. // Layout
  578. // Remove -1.0f to cancel out the +1.0f we are doing in EndTable() to make last column line visible
  579. const float width_spacings = table->CellSpacingX * (table->ColumnsVisibleCount - 1);
  580. float width_avail;
  581. if ((table->Flags & ImGuiTableFlags_ScrollX) && table->InnerWidth == 0.0f)
  582. width_avail = table->InnerClipRect.GetWidth() - width_spacings - 1.0f;
  583. else
  584. width_avail = work_rect.GetWidth() - width_spacings - 1.0f;
  585. const float width_avail_for_stretched_columns = width_avail - sum_width_fixed_requests;
  586. float width_remaining_for_stretched_columns = width_avail_for_stretched_columns;
  587. // Apply final width based on requested widths
  588. // Mark some columns as not resizable
  589. int count_resizable = 0;
  590. table->ColumnsTotalWidth = width_spacings;
  591. for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
  592. {
  593. if (!(table->VisibleMaskByDisplayOrder & ((ImU64)1 << order_n)))
  594. continue;
  595. ImGuiTableColumn* column = &table->Columns[table->DisplayOrderToIndex[order_n]];
  596. // Allocate width for stretched/weighted columns
  597. if (column->Flags & ImGuiTableColumnFlags_WidthStretch)
  598. {
  599. // WidthStretchWeight gets converted into WidthRequest
  600. float weight_ratio = column->WidthStretchWeight / sum_weights_stretched;
  601. column->WidthRequest = IM_FLOOR(ImMax(width_avail_for_stretched_columns * weight_ratio, min_column_width) + 0.01f);
  602. width_remaining_for_stretched_columns -= column->WidthRequest;
  603. // [Resize Rule 2] Resizing from right-side of a weighted column preceding a fixed column
  604. // needs to forward resizing to left-side of fixed column. We also need to copy the NoResize flag..
  605. if (column->NextVisibleColumn != -1)
  606. if (ImGuiTableColumn* next_column = &table->Columns[column->NextVisibleColumn])
  607. if (next_column->Flags & ImGuiTableColumnFlags_WidthFixed)
  608. column->Flags |= (next_column->Flags & ImGuiTableColumnFlags_NoDirectResize_);
  609. }
  610. // [Resize Rule 1] The right-most Visible column is not resizable if there is at least one Stretch column
  611. // (see comments in TableResizeColumn())
  612. if (column->NextVisibleColumn == -1 && table->LeftMostStretchedColumnDisplayOrder != -1)
  613. column->Flags |= ImGuiTableColumnFlags_NoDirectResize_;
  614. if (!(column->Flags & ImGuiTableColumnFlags_NoResize))
  615. count_resizable++;
  616. // Assign final width, record width in case we will need to shrink
  617. column->WidthGiven = ImFloor(ImMax(column->WidthRequest, min_column_width));
  618. table->ColumnsTotalWidth += column->WidthGiven;
  619. }
  620. #if 0
  621. const float width_excess = table->ColumnsTotalWidth - work_rect.GetWidth();
  622. if ((table->Flags & ImGuiTableFlags_SizingPolicyStretchX) && width_excess > 0.0f)
  623. {
  624. // Shrink widths when the total does not fit
  625. // FIXME-TABLE: This is working but confuses/conflicts with manual resizing.
  626. // FIXME-TABLE: Policy to shrink down below below ideal/requested width if there's no room?
  627. g.ShrinkWidthBuffer.resize(table->ColumnsVisibleCount);
  628. for (int order_n = 0, visible_n = 0; order_n < table->ColumnsCount; order_n++)
  629. {
  630. if (!(table->VisibleMaskByDisplayOrder & ((ImU64)1 << order_n)))
  631. continue;
  632. const int column_n = table->DisplayOrder[order_n];
  633. g.ShrinkWidthBuffer[visible_n].Index = column_n;
  634. g.ShrinkWidthBuffer[visible_n].Width = table->Columns[column_n].WidthGiven;
  635. visible_n++;
  636. }
  637. ShrinkWidths(g.ShrinkWidthBuffer.Data, g.ShrinkWidthBuffer.Size, width_excess);
  638. for (int n = 0; n < g.ShrinkWidthBuffer.Size; n++)
  639. table->Columns[g.ShrinkWidthBuffer.Data[n].Index].WidthGiven = ImMax(g.ShrinkWidthBuffer.Data[n].Width, min_column_size);
  640. // FIXME: Need to alter table->ColumnsTotalWidth
  641. }
  642. else
  643. #endif
  644. // Redistribute remainder width due to rounding (remainder width is < 1.0f * number of Stretch column).
  645. // Using right-to-left distribution (more likely to match resizing cursor), could be adjusted depending
  646. // on where the mouse cursor is and/or relative weights.
  647. // FIXME-TABLE: May be simpler to store floating width and floor final positions only
  648. // FIXME-TABLE: Make it optional? User might prefer to preserve pixel perfect same size?
  649. if (width_remaining_for_stretched_columns >= 1.0f)
  650. for (int order_n = table->ColumnsCount - 1; sum_weights_stretched > 0.0f && width_remaining_for_stretched_columns >= 1.0f && order_n >= 0; order_n--)
  651. {
  652. if (!(table->VisibleMaskByDisplayOrder & ((ImU64)1 << order_n)))
  653. continue;
  654. ImGuiTableColumn* column = &table->Columns[table->DisplayOrderToIndex[order_n]];
  655. if (!(column->Flags & ImGuiTableColumnFlags_WidthStretch))
  656. continue;
  657. column->WidthRequest += 1.0f;
  658. column->WidthGiven += 1.0f;
  659. width_remaining_for_stretched_columns -= 1.0f;
  660. }
  661. // Setup final position, offset and clipping rectangles
  662. int visible_n = 0;
  663. float offset_x = (table->FreezeColumnsCount > 0) ? table->OuterRect.Min.x : work_rect.Min.x;
  664. ImRect host_clip_rect = table->InnerClipRect;
  665. for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
  666. {
  667. const int column_n = table->DisplayOrderToIndex[order_n];
  668. ImGuiTableColumn* column = &table->Columns[column_n];
  669. if (table->FreezeColumnsCount > 0 && table->FreezeColumnsCount == visible_n)
  670. offset_x += work_rect.Min.x - table->OuterRect.Min.x;
  671. if (!(table->VisibleMaskByDisplayOrder & ((ImU64)1 << order_n)))
  672. {
  673. // Hidden column: clear a few fields and we are done with it for the remainder of the function.
  674. // We set a zero-width clip rect but set Min.y/Max.y properly to not interfere with the clipper.
  675. column->MinX = column->MaxX = offset_x;
  676. column->StartXRows = column->StartXHeaders = offset_x;
  677. column->WidthGiven = 0.0f;
  678. column->ClipRect.Min.x = offset_x;
  679. column->ClipRect.Min.y = work_rect.Min.y;
  680. column->ClipRect.Max.x = offset_x;
  681. column->ClipRect.Max.y = FLT_MAX;
  682. column->ClipRect.ClipWithFull(host_clip_rect);
  683. column->IsClipped = column->SkipItems = true;
  684. continue;
  685. }
  686. float max_x = FLT_MAX;
  687. if (table->Flags & ImGuiTableFlags_ScrollX)
  688. {
  689. // Frozen columns can't reach beyond visible width else scrolling will naturally break.
  690. if (order_n < table->FreezeColumnsRequest)
  691. max_x = table->InnerClipRect.Max.x - (table->FreezeColumnsRequest - order_n) * min_column_width;
  692. }
  693. else
  694. {
  695. // If horizontal scrolling if disabled, we apply a final lossless shrinking of columns in order to make
  696. // sure they are all visible. Because of this we also know that all of the columns will always fit in
  697. // table->WorkRect and therefore in table->InnerRect (because ScrollX is off)
  698. if (!(table->Flags & ImGuiTableFlags_NoKeepColumnsVisible))
  699. max_x = table->WorkRect.Max.x - (table->ColumnsVisibleCount - (column->IndexWithinVisibleSet + 1)) * min_column_width;
  700. }
  701. if (offset_x + column->WidthGiven > max_x)
  702. column->WidthGiven = ImMax(max_x - offset_x, min_column_width);
  703. column->MinX = offset_x;
  704. column->MaxX = column->MinX + column->WidthGiven;
  705. //// A one pixel padding on the right side makes clipping more noticeable and contents look less cramped.
  706. column->ClipRect.Min.x = column->MinX;
  707. column->ClipRect.Min.y = work_rect.Min.y;
  708. column->ClipRect.Max.x = column->MaxX;// -1.0f;
  709. column->ClipRect.Max.y = FLT_MAX;
  710. column->ClipRect.ClipWithFull(host_clip_rect);
  711. column->IsClipped = (column->ClipRect.Max.x <= column->ClipRect.Min.x) && (column->AutoFitQueue & 1) == 0 && (column->CannotSkipItemsQueue & 1) == 0;
  712. column->SkipItems = column->IsClipped || table->HostSkipItems;
  713. if (column->IsClipped)
  714. {
  715. // Columns with the _WidthAlwaysAutoResize sizing policy will never be updated then.
  716. table->VisibleUnclippedMaskByIndex &= ~((ImU64)1 << column_n);
  717. }
  718. else
  719. {
  720. // Starting cursor position
  721. column->StartXRows = column->StartXHeaders = column->MinX + table->CellPaddingX1;
  722. // Alignment
  723. // FIXME-TABLE: This align based on the whole column width, not per-cell, and therefore isn't useful in
  724. // many cases (to be able to honor this we might be able to store a log of cells width, per row, for
  725. // visible rows, but nav/programmatic scroll would have visible artifacts.)
  726. //if (column->Flags & ImGuiTableColumnFlags_AlignRight)
  727. // column->StartXRows = ImMax(column->StartXRows, column->MaxX - column->ContentWidthRowsUnfrozen);
  728. //else if (column->Flags & ImGuiTableColumnFlags_AlignCenter)
  729. // column->StartXRows = ImLerp(column->StartXRows, ImMax(column->StartXRows, column->MaxX - column->ContentWidthRowsUnfrozen), 0.5f);
  730. // Reset content width variables
  731. const float initial_max_pos_x = column->MinX + table->CellPaddingX1;
  732. column->ContentMaxPosRowsFrozen = column->ContentMaxPosRowsUnfrozen = initial_max_pos_x;
  733. column->ContentMaxPosHeadersUsed = column->ContentMaxPosHeadersIdeal = initial_max_pos_x;
  734. }
  735. // Don't decrement auto-fit counters until container window got a chance to submit its items
  736. if (table->HostSkipItems == false)
  737. {
  738. column->AutoFitQueue >>= 1;
  739. column->CannotSkipItemsQueue >>= 1;
  740. }
  741. if (visible_n < table->FreezeColumnsCount)
  742. host_clip_rect.Min.x = ImMax(host_clip_rect.Min.x, column->MaxX + 2.0f);
  743. offset_x += column->WidthGiven + table->CellSpacingX;
  744. visible_n++;
  745. }
  746. // Clear Resizable flag if none of our column are actually resizable (either via an explicit _NoResize flag,
  747. // either because of using _WidthAlwaysAutoResize/_WidthStretch).
  748. // This will hide the resizing option from the context menu.
  749. if (count_resizable == 0 && (table->Flags & ImGuiTableFlags_Resizable))
  750. table->Flags &= ~ImGuiTableFlags_Resizable;
  751. // Allocate draw channels
  752. TableUpdateDrawChannels(table);
  753. // Borders
  754. if (table->Flags & ImGuiTableFlags_Resizable)
  755. TableUpdateBorders(table);
  756. // Reset fields after we used them in TableSetupResize()
  757. table->LastFirstRowHeight = 0.0f;
  758. table->IsLayoutLocked = true;
  759. table->IsUsingHeaders = false;
  760. // Context menu
  761. if (table->IsContextPopupOpen && table->InstanceCurrent == table->InstanceInteracted)
  762. {
  763. if (BeginPopup("##TableContextMenu"))
  764. {
  765. TableDrawContextMenu(table, table->ContextPopupColumn);
  766. EndPopup();
  767. }
  768. else
  769. {
  770. table->IsContextPopupOpen = false;
  771. }
  772. }
  773. // Initial state
  774. ImGuiWindow* inner_window = table->InnerWindow;
  775. if (table->Flags & ImGuiTableFlags_NoClipX)
  776. table->DrawSplitter.SetCurrentChannel(inner_window->DrawList, 1);
  777. else
  778. inner_window->DrawList->PushClipRect(inner_window->ClipRect.Min, inner_window->ClipRect.Max, false);
  779. }
  780. // Process interaction on resizing borders. Actual size change will be applied in EndTable()
  781. // - Set table->HoveredColumnBorder with a short delay/timer to reduce feedback noise
  782. // - Submit ahead of table contents and header, use ImGuiButtonFlags_AllowItemOverlap to prioritize widgets
  783. // overlapping the same area.
  784. void ImGui::TableUpdateBorders(ImGuiTable* table)
  785. {
  786. ImGuiContext& g = *GImGui;
  787. IM_ASSERT(table->Flags & ImGuiTableFlags_Resizable);
  788. // At this point OuterRect height may be zero or under actual final height, so we rely on temporal coherency and
  789. // use the final height from last frame. Because this is only affecting _interaction_ with columns, it is not
  790. // really problematic (whereas the actual visual will be displayed in EndTable() and using the current frame height).
  791. // Actual columns highlight/render will be performed in EndTable() and not be affected.
  792. const bool borders_full_height = (table->IsUsingHeaders == false) || (table->Flags & ImGuiTableFlags_BordersVFullHeight);
  793. const float hit_half_width = TABLE_RESIZE_SEPARATOR_HALF_THICKNESS;
  794. const float hit_y1 = table->OuterRect.Min.y;
  795. const float hit_y2_full = ImMax(table->OuterRect.Max.y, hit_y1 + table->LastOuterHeight);
  796. const float hit_y2 = borders_full_height ? hit_y2_full : (hit_y1 + table->LastFirstRowHeight);
  797. const float mouse_x_hover_body = (g.IO.MousePos.y >= hit_y1 && g.IO.MousePos.y < hit_y2_full) ? g.IO.MousePos.x : FLT_MAX;
  798. for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
  799. {
  800. if (!(table->VisibleMaskByDisplayOrder & ((ImU64)1 << order_n)))
  801. continue;
  802. const int column_n = table->DisplayOrderToIndex[order_n];
  803. ImGuiTableColumn* column = &table->Columns[column_n];
  804. // Detect hovered column:
  805. // - we perform an unusually low-level check here.. not using IsMouseHoveringRect() to avoid touch padding.
  806. // - we don't care about the full set of IsItemHovered() feature either.
  807. if (mouse_x_hover_body >= column->MinX && mouse_x_hover_body < column->MaxX)
  808. table->HoveredColumnBody = (ImS8)column_n;
  809. if (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_))
  810. continue;
  811. ImGuiID column_id = TableGetColumnResizeID(table, column_n, table->InstanceCurrent);
  812. ImRect hit_rect(column->MaxX - hit_half_width, hit_y1, column->MaxX + hit_half_width, hit_y2);
  813. //GetForegroundDrawList()->AddRect(hit_rect.Min, hit_rect.Max, IM_COL32(255, 0, 0, 100));
  814. KeepAliveID(column_id);
  815. bool hovered = false, held = false;
  816. bool pressed = ButtonBehavior(hit_rect, column_id, &hovered, &held, ImGuiButtonFlags_FlattenChildren | ImGuiButtonFlags_AllowItemOverlap | ImGuiButtonFlags_PressedOnClick | ImGuiButtonFlags_PressedOnDoubleClick);
  817. if (pressed && IsMouseDoubleClicked(0) && !(column->Flags & ImGuiTableColumnFlags_WidthStretch))
  818. {
  819. // FIXME-TABLE: Double-clicking on column edge could auto-fit weighted column?
  820. TableSetColumnAutofit(table, column_n);
  821. ClearActiveID();
  822. held = hovered = false;
  823. }
  824. if (held)
  825. {
  826. table->ResizedColumn = (ImS8)column_n;
  827. table->InstanceInteracted = table->InstanceCurrent;
  828. }
  829. if ((hovered && g.HoveredIdTimer > TABLE_RESIZE_SEPARATOR_FEEDBACK_TIMER) || held)
  830. {
  831. table->HoveredColumnBorder = (ImS8)column_n;
  832. SetMouseCursor(ImGuiMouseCursor_ResizeEW);
  833. }
  834. }
  835. }
  836. void ImGui::EndTable()
  837. {
  838. ImGuiContext& g = *GImGui;
  839. ImGuiTable* table = g.CurrentTable;
  840. IM_ASSERT(table != NULL && "Only call EndTable() if BeginTable() returns true!");
  841. // This assert would be very useful to catch a common error... unfortunately it would probably trigger in some
  842. // cases, and for consistency user may sometimes output empty tables (and still benefit from e.g. outer border)
  843. //IM_ASSERT(table->IsLayoutLocked && "Table unused: never called TableNextRow(), is that the intent?");
  844. // If the user never got to call TableNextRow() or TableNextCell(), we call layout ourselves to ensure all our
  845. // code paths are consistent (instead of just hoping that TableBegin/TableEnd will work), get borders drawn, etc.
  846. if (!table->IsLayoutLocked)
  847. TableUpdateLayout(table);
  848. const ImGuiTableFlags flags = table->Flags;
  849. ImGuiWindow* inner_window = table->InnerWindow;
  850. ImGuiWindow* outer_window = table->OuterWindow;
  851. IM_ASSERT(inner_window == g.CurrentWindow);
  852. IM_ASSERT(outer_window == inner_window || outer_window == inner_window->ParentWindow);
  853. if (table->IsInsideRow)
  854. TableEndRow(table);
  855. // Finalize table height
  856. inner_window->SkipItems = table->HostSkipItems;
  857. inner_window->DC.CursorMaxPos = table->HostCursorMaxPos;
  858. if (inner_window != outer_window)
  859. {
  860. table->OuterRect.Max.y = ImMax(table->OuterRect.Max.y, inner_window->Pos.y + inner_window->Size.y);
  861. inner_window->DC.CursorMaxPos.y = table->RowPosY2;
  862. }
  863. else if (!(flags & ImGuiTableFlags_NoHostExtendY))
  864. {
  865. table->OuterRect.Max.y = ImMax(table->OuterRect.Max.y, inner_window->DC.CursorPos.y);
  866. inner_window->DC.CursorMaxPos.y = table->RowPosY2;
  867. }
  868. table->WorkRect.Max.y = ImMax(table->WorkRect.Max.y, table->OuterRect.Max.y);
  869. table->LastOuterHeight = table->OuterRect.GetHeight();
  870. if (!(flags & ImGuiTableFlags_NoClipX))
  871. inner_window->DrawList->PopClipRect();
  872. inner_window->ClipRect = inner_window->DrawList->_ClipRectStack.back();
  873. // Draw borders
  874. if ((flags & ImGuiTableFlags_Borders) != 0)
  875. TableDrawBorders(table);
  876. // Flatten channels and merge draw calls
  877. table->DrawSplitter.SetCurrentChannel(inner_window->DrawList, 0);
  878. TableDrawMergeChannels(table);
  879. // When releasing a column being resized, scroll to keep the resulting column in sight
  880. const float min_column_width = TableGetMinColumnWidth();
  881. if (!(table->Flags & ImGuiTableFlags_ScrollX) && inner_window != outer_window)
  882. {
  883. inner_window->Scroll.x = 0.0f;
  884. }
  885. else if (table->LastResizedColumn != -1 && table->ResizedColumn == -1 && inner_window->ScrollbarX && table->InstanceInteracted == table->InstanceCurrent)
  886. {
  887. ImGuiTableColumn* column = &table->Columns[table->LastResizedColumn];
  888. if (column->MaxX < table->InnerClipRect.Min.x)
  889. SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x - min_column_width, 1.0f);
  890. else if (column->MaxX > table->InnerClipRect.Max.x)
  891. SetScrollFromPosX(inner_window, column->MaxX - inner_window->Pos.x + min_column_width, 1.0f);
  892. }
  893. // Apply resizing/dragging at the end of the frame
  894. if (table->ResizedColumn != -1)
  895. {
  896. ImGuiTableColumn* column = &table->Columns[table->ResizedColumn];
  897. const float new_x2 = (g.IO.MousePos.x - g.ActiveIdClickOffset.x + TABLE_RESIZE_SEPARATOR_HALF_THICKNESS);
  898. const float new_width = ImFloor(new_x2 - column->MinX);
  899. table->ResizedColumnNextWidth = new_width;
  900. }
  901. // Layout in outer window
  902. const float backup_outer_cursor_pos_x = outer_window->DC.CursorPos.x;
  903. const float backup_outer_max_pos_x = outer_window->DC.CursorMaxPos.x;
  904. const float backup_inner_max_pos_x = inner_window->DC.CursorMaxPos.x;
  905. inner_window->WorkRect = table->HostWorkRect;
  906. inner_window->SkipItems = table->HostSkipItems;
  907. outer_window->DC.CursorPos = table->OuterRect.Min;
  908. outer_window->DC.ColumnsOffset.x = 0.0f;
  909. if (inner_window != outer_window)
  910. {
  911. EndChild();
  912. }
  913. else
  914. {
  915. PopID();
  916. ImVec2 item_size = table->OuterRect.GetSize();
  917. item_size.x = table->ColumnsTotalWidth;
  918. ItemSize(item_size);
  919. }
  920. // Store content width reference for each column
  921. float max_pos_x = backup_inner_max_pos_x;
  922. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  923. {
  924. ImGuiTableColumn* column = &table->Columns[column_n];
  925. // Store content width (for both Headers and Rows)
  926. //float ref_x = column->MinX;
  927. float ref_x_rows = column->StartXRows - table->CellPaddingX1;
  928. float ref_x_headers = column->StartXHeaders - table->CellPaddingX1;
  929. column->ContentWidthRowsFrozen = (ImS16)ImMax(0.0f, column->ContentMaxPosRowsFrozen - ref_x_rows);
  930. column->ContentWidthRowsUnfrozen = (ImS16)ImMax(0.0f, column->ContentMaxPosRowsUnfrozen - ref_x_rows);
  931. column->ContentWidthHeadersUsed = (ImS16)ImMax(0.0f, column->ContentMaxPosHeadersUsed - ref_x_headers);
  932. column->ContentWidthHeadersIdeal = (ImS16)ImMax(0.0f, column->ContentMaxPosHeadersIdeal - ref_x_headers);
  933. // Add an extra 1 pixel so we can see the last column vertical line if it lies on the right-most edge.
  934. if (table->VisibleMaskByIndex & ((ImU64)1 << column_n))
  935. max_pos_x = ImMax(max_pos_x, column->MaxX + 1.0f);
  936. }
  937. // Override EndChild/ItemSize max extent with our own to enable auto-resize on the X axis when possible
  938. // FIXME-TABLE: This can be improved (e.g. for Fixed columns we don't want to auto AutoFitWidth? or propagate window auto-fit to table?)
  939. if (table->Flags & ImGuiTableFlags_ScrollX)
  940. {
  941. inner_window->DC.CursorMaxPos.x = max_pos_x; // Set contents width for scrolling
  942. outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos_x, backup_outer_cursor_pos_x + table->ColumnsTotalWidth + 1.0f + inner_window->ScrollbarSizes.x); // For auto-fit
  943. }
  944. else
  945. {
  946. outer_window->DC.CursorMaxPos.x = ImMax(backup_outer_max_pos_x, table->WorkRect.Min.x + table->ColumnsAutoFitWidth); // For auto-fit
  947. }
  948. // Save settings
  949. if (table->IsSettingsDirty)
  950. TableSaveSettings(table);
  951. // Clear or restore current table, if any
  952. IM_ASSERT(g.CurrentWindow == outer_window);
  953. IM_ASSERT(g.CurrentTable == table);
  954. outer_window->DC.CurrentTable = NULL;
  955. g.CurrentTableStack.pop_back();
  956. g.CurrentTable = g.CurrentTableStack.Size ? g.Tables.GetByIndex(g.CurrentTableStack.back().Index) : NULL;
  957. }
  958. // FIXME-TABLE: This is a mess, need to redesign how we render borders.
  959. void ImGui::TableDrawBorders(ImGuiTable* table)
  960. {
  961. ImGuiWindow* inner_window = table->InnerWindow;
  962. ImGuiWindow* outer_window = table->OuterWindow;
  963. table->DrawSplitter.SetCurrentChannel(inner_window->DrawList, 0);
  964. if (inner_window->Hidden || !table->HostClipRect.Overlaps(table->InnerClipRect))
  965. return;
  966. ImDrawList* inner_drawlist = inner_window->DrawList;
  967. ImDrawList* outer_drawlist = outer_window->DrawList;
  968. // Draw inner border and resizing feedback
  969. const float draw_y1 = table->OuterRect.Min.y;
  970. float draw_y2_base = (table->FreezeRowsCount >= 1 ? table->OuterRect.Min.y : table->WorkRect.Min.y) + table->LastFirstRowHeight;
  971. float draw_y2_full = table->OuterRect.Max.y;
  972. ImU32 border_base_col;
  973. if (!table->IsUsingHeaders || (table->Flags & ImGuiTableFlags_BordersVFullHeight))
  974. {
  975. draw_y2_base = draw_y2_full;
  976. border_base_col = table->BorderColorLight;
  977. }
  978. else
  979. {
  980. border_base_col = table->BorderColorStrong;
  981. }
  982. if ((table->Flags & ImGuiTableFlags_BordersVOuter) && (table->InnerWindow == table->OuterWindow))
  983. inner_drawlist->AddLine(ImVec2(table->OuterRect.Min.x, draw_y1), ImVec2(table->OuterRect.Min.x, draw_y2_base), border_base_col, 1.0f);
  984. if (table->Flags & ImGuiTableFlags_BordersVInner)
  985. {
  986. for (int order_n = 0; order_n < table->ColumnsCount; order_n++)
  987. {
  988. if (!(table->VisibleMaskByDisplayOrder & ((ImU64)1 << order_n)))
  989. continue;
  990. const int column_n = table->DisplayOrderToIndex[order_n];
  991. ImGuiTableColumn* column = &table->Columns[column_n];
  992. const bool is_hovered = (table->HoveredColumnBorder == column_n);
  993. const bool is_resized = (table->ResizedColumn == column_n) && (table->InstanceInteracted == table->InstanceCurrent);
  994. const bool is_resizable = (column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_NoDirectResize_)) == 0;
  995. bool draw_right_border = (column->MaxX <= table->InnerClipRect.Max.x) || (is_resized || is_hovered);
  996. if (column->NextVisibleColumn == -1 && !is_resizable)
  997. draw_right_border = false;
  998. if (draw_right_border && column->MaxX > column->ClipRect.Min.x) // FIXME-TABLE FIXME-STYLE: Assume BorderSize==1, this is problematic if we want to increase the border size..
  999. {
  1000. // Draw in outer window so right-most column won't be clipped
  1001. // Always draw full height border when:
  1002. // - not using headers
  1003. // - user specify ImGuiTableFlags_BordersFullHeight
  1004. // - being interacted with
  1005. // - on the delimitation of frozen column scrolling
  1006. const ImU32 col = is_resized ? GetColorU32(ImGuiCol_SeparatorActive) : is_hovered ? GetColorU32(ImGuiCol_SeparatorHovered) : border_base_col;
  1007. float draw_y2 = draw_y2_base;
  1008. if (is_hovered || is_resized || (table->FreezeColumnsCount != -1 && table->FreezeColumnsCount == order_n + 1))
  1009. draw_y2 = draw_y2_full;
  1010. inner_drawlist->AddLine(ImVec2(column->MaxX, draw_y1), ImVec2(column->MaxX, draw_y2), col, 1.0f);
  1011. }
  1012. }
  1013. }
  1014. // Draw outer border
  1015. if (table->Flags & ImGuiTableFlags_BordersOuter)
  1016. {
  1017. // Display outer border offset by 1 which is a simple way to display it without adding an extra draw call
  1018. // (Without the offset, in outer_window it would be rendered behind cells, because child windows are above their
  1019. // parent. In inner_window, it won't reach out over scrollbars. Another weird solution would be to display part
  1020. // of it in inner window, and the part that's over scrollbars in the outer window..)
  1021. // Either solution currently won't allow us to use a larger border size: the border would clipped.
  1022. ImRect outer_border = table->OuterRect;
  1023. const ImU32 outer_col = table->BorderColorStrong;
  1024. if (inner_window != outer_window)
  1025. outer_border.Expand(1.0f);
  1026. if ((table->Flags & ImGuiTableFlags_BordersOuter) == ImGuiTableFlags_BordersOuter)
  1027. outer_drawlist->AddRect(outer_border.Min, outer_border.Max, outer_col);
  1028. else if (table->Flags & ImGuiTableFlags_BordersVOuter)
  1029. {
  1030. outer_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Min.x, outer_border.Max.y), outer_col);
  1031. outer_drawlist->AddLine(ImVec2(outer_border.Max.x, outer_border.Min.y), outer_border.Max, outer_col);
  1032. }
  1033. else if (table->Flags & ImGuiTableFlags_BordersHOuter)
  1034. {
  1035. outer_drawlist->AddLine(outer_border.Min, ImVec2(outer_border.Max.x, outer_border.Min.y), outer_col);
  1036. outer_drawlist->AddLine(ImVec2(outer_border.Min.x, outer_border.Max.y), outer_border.Max, outer_col);
  1037. }
  1038. }
  1039. if ((table->Flags & ImGuiTableFlags_BordersHInner) && table->RowPosY2 < table->OuterRect.Max.y)
  1040. {
  1041. // Draw bottom-most row border
  1042. const float border_y = table->RowPosY2;
  1043. if (border_y >= table->BackgroundClipRect.Min.y && border_y < table->BackgroundClipRect.Max.y)
  1044. inner_drawlist->AddLine(ImVec2(table->BorderX1, border_y), ImVec2(table->BorderX2, border_y), table->BorderColorLight);
  1045. }
  1046. }
  1047. static void TableUpdateColumnsWeightFromWidth(ImGuiTable* table)
  1048. {
  1049. IM_ASSERT(table->LeftMostStretchedColumnDisplayOrder != -1);
  1050. // Measure existing quantity
  1051. float visible_weight = 0.0f;
  1052. float visible_width = 0.0f;
  1053. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1054. {
  1055. ImGuiTableColumn* column = &table->Columns[column_n];
  1056. if (!column->IsVisible || !(column->Flags & ImGuiTableColumnFlags_WidthStretch))
  1057. continue;
  1058. visible_weight += column->WidthStretchWeight;
  1059. visible_width += column->WidthRequest;
  1060. }
  1061. IM_ASSERT(visible_weight > 0.0f && visible_width > 0.0f);
  1062. // Apply new weights
  1063. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1064. {
  1065. ImGuiTableColumn* column = &table->Columns[column_n];
  1066. if (!column->IsVisible || !(column->Flags & ImGuiTableColumnFlags_WidthStretch))
  1067. continue;
  1068. column->WidthStretchWeight = ((column->WidthRequest + 0.0f) / visible_width) * visible_weight;
  1069. }
  1070. }
  1071. // Public wrapper
  1072. void ImGui::TableSetColumnWidth(int column_n, float width)
  1073. {
  1074. ImGuiContext& g = *GImGui;
  1075. ImGuiTable* table = g.CurrentTable;
  1076. IM_ASSERT(table != NULL);
  1077. IM_ASSERT(table->IsLayoutLocked == false);
  1078. IM_ASSERT(column_n >= 0 && column_n < table->ColumnsCount);
  1079. TableSetColumnWidth(table, &table->Columns[column_n], width);
  1080. }
  1081. // [Internal]
  1082. void ImGui::TableSetColumnWidth(ImGuiTable* table, ImGuiTableColumn* column_0, float column_0_width)
  1083. {
  1084. // Constraints
  1085. float min_width = TableGetMinColumnWidth();
  1086. float max_width_0 = FLT_MAX;
  1087. if (!(table->Flags & ImGuiTableFlags_ScrollX))
  1088. max_width_0 = (table->WorkRect.Max.x - column_0->MinX) - (table->ColumnsVisibleCount - (column_0->IndexWithinVisibleSet + 1)) * min_width;
  1089. column_0_width = ImClamp(column_0_width, min_width, max_width_0);
  1090. // Compare both requested and actual given width to avoid overwriting requested width when column is stuck (minimum size, bounded)
  1091. if (column_0->WidthGiven == column_0_width || column_0->WidthRequest == column_0_width)
  1092. return;
  1093. ImGuiTableColumn* column_1 = (column_0->NextVisibleColumn != -1) ? &table->Columns[column_0->NextVisibleColumn] : NULL;
  1094. // In this surprisingly not simple because of how we support mixing Fixed and Stretch columns.
  1095. // When forwarding resize from Wn| to Fn+1| we need to be considerate of the _NoResize flag on Fn+1.
  1096. // FIXME-TABLE: Find a way to rewrite all of this so interactions feel more consistent for the user.
  1097. // Scenarios:
  1098. // - F1 F2 F3 resize from F1| or F2| --> ok: alter ->WidthRequested of Fixed column. Subsequent columns will be offset.
  1099. // - F1 F2 F3 resize from F3| --> ok: alter ->WidthRequested of Fixed column. If active, ScrollX extent can be altered.
  1100. // - 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 Weighted column will always be minimal size.
  1101. // - F1 F2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1)
  1102. // - W1 W2 W3 resize from W1| or W2| --> FIXME
  1103. // - W1 W2 W3 resize from W3| --> ok: no-op (disabled by Resize Rule 1)
  1104. // - W1 F2 F3 resize from F3| --> ok: no-op (disabled by Resize Rule 1)
  1105. // - W1 F2 resize from F2| --> ok: no-op (disabled by Resize Rule 1)
  1106. // - W1 W2 F3 resize from W1| or W2| --> ok
  1107. // - W1 F2 W3 resize from W1| or F2| --> FIXME
  1108. // - F1 W2 F3 resize from W2| --> ok
  1109. // - W1 F2 F3 resize from W1| --> ok: equivalent to resizing |F2. F3 will not move. (forwarded by Resize Rule 2)
  1110. // - W1 F2 F3 resize from F2| --> FIXME should resize F2, F3 and not have effect on W1 (Stretch columns are _before_ the Fixed column).
  1111. // Rules:
  1112. // - [Resize Rule 1] Can't resize from right of right-most visible column if there is any Stretch column. Implemented in TableUpdateLayout().
  1113. // - [Resize Rule 2] Resizing from right-side of a Stretch column before a fixed column froward sizing to left-side of fixed column.
  1114. // - [Resize Rule 3] If we are are followed by a fixed column and we have a Stretch column before, we need to ensure that our left border won't move.
  1115. if (column_0->Flags & ImGuiTableColumnFlags_WidthFixed)
  1116. {
  1117. // [Resize Rule 3] If we are are followed by a fixed column and we have a Stretch column before, we need to ensure
  1118. // that our left border won't move, which we can do by making sure column_a/column_b resizes cancels each others.
  1119. if (column_1 && (column_1->Flags & ImGuiTableColumnFlags_WidthFixed))
  1120. if (table->LeftMostStretchedColumnDisplayOrder != -1 && table->LeftMostStretchedColumnDisplayOrder < column_0->DisplayOrder)
  1121. {
  1122. // (old_a + old_b == new_a + new_b) --> (new_a == old_a + old_b - new_b)
  1123. float column_1_width = ImMax(column_1->WidthRequest - (column_0_width - column_0->WidthRequest), min_width);
  1124. column_0_width = column_0->WidthRequest + column_1->WidthRequest - column_1_width;
  1125. column_1->WidthRequest = column_1_width;
  1126. }
  1127. // Apply
  1128. //IMGUI_DEBUG_LOG("TableSetColumnWidth(%d, %.1f->%.1f)\n", column_0_idx, column_0->WidthRequested, column_0_width);
  1129. column_0->WidthRequest = column_0_width;
  1130. }
  1131. else if (column_0->Flags & ImGuiTableColumnFlags_WidthStretch)
  1132. {
  1133. // [Resize Rule 2]
  1134. if (column_1 && (column_1->Flags & ImGuiTableColumnFlags_WidthFixed))
  1135. {
  1136. float off = (column_0->WidthGiven - column_0_width);
  1137. float column_1_width = column_1->WidthGiven + off;
  1138. column_1->WidthRequest = ImMax(min_width, column_1_width);
  1139. return;
  1140. }
  1141. // (old_a + old_b == new_a + new_b) --> (new_a == old_a + old_b - new_b)
  1142. float column_1_width = ImMax(column_1->WidthRequest - (column_0_width - column_0->WidthRequest), min_width);
  1143. column_0_width = column_0->WidthRequest + column_1->WidthRequest - column_1_width;
  1144. column_1->WidthRequest = column_1_width;
  1145. column_0->WidthRequest = column_0_width;
  1146. TableUpdateColumnsWeightFromWidth(table);
  1147. }
  1148. table->IsSettingsDirty = true;
  1149. }
  1150. // Columns where the contents didn't stray off their local clip rectangle can be merged into a same draw command.
  1151. // To achieve this we merge their clip rect and make them contiguous in the channel list so they can be merged.
  1152. // This function first reorder the draw cmd which can be merged, by arranging them into a maximum of 4 distinct groups:
  1153. //
  1154. // 1 group: 2 groups: 2 groups: 4 groups:
  1155. // [ 0. ] no freeze [ 0. ] row freeze [ 01 ] col freeze [ 02 ] row+col freeze
  1156. // [ .. ] or no scroll [ 1. ] and v-scroll [ .. ] and h-scroll [ 13 ] and v+h-scroll
  1157. //
  1158. // Each column itself can use 1 channel (row freeze disabled) or 2 channels (row freeze enabled).
  1159. // When the contents of a column didn't stray off its limit, we move its channels into the corresponding group
  1160. // based on its position (within frozen rows/columns groups or not).
  1161. // At the end of the operation our 1-4 groups will each have a ImDrawCmd using the same ClipRect, and they will be
  1162. // merged by the DrawSplitter.Merge() call.
  1163. //
  1164. // Column channels will not be merged into one of the 1-4 groups in the following cases:
  1165. // - The contents stray off its clipping rectangle (we only compare the MaxX value, not the MinX value).
  1166. // Direct ImDrawList calls won't be taken into account by default, if you use them make sure the ImGui:: bounds
  1167. // matches, by e.g. calling SetCursorScreenPos().
  1168. // - The channel uses more than one draw command itself. We drop all our attempt at merging stuff here..
  1169. // we could do better but it's going to be rare and probably not worth the hassle.
  1170. // Columns for which the draw chnanel(s) haven't been merged with other will use their own ImDrawCmd.
  1171. //
  1172. // This function is particularly tricky to understand.. take a breath.
  1173. void ImGui::TableDrawMergeChannels(ImGuiTable* table)
  1174. {
  1175. ImGuiContext& g = *GImGui;
  1176. ImDrawListSplitter* splitter = &table->DrawSplitter;
  1177. const bool is_frozen_v = (table->FreezeRowsCount > 0);
  1178. const bool is_frozen_h = (table->FreezeColumnsCount > 0);
  1179. // Track which groups we are going to attempt to merge, and which channels goes into each group.
  1180. struct MergeGroup
  1181. {
  1182. ImRect ClipRect;
  1183. int ChannelsCount;
  1184. ImBitArray<IMGUI_TABLE_MAX_DRAW_CHANNELS> ChannelsMask;
  1185. };
  1186. int merge_group_mask = 0x00;
  1187. MergeGroup merge_groups[4];
  1188. memset(merge_groups, 0, sizeof(merge_groups));
  1189. bool merge_groups_all_fit_within_inner_rect = (table->Flags & ImGuiTableFlags_NoHostExtendY) == 0;
  1190. // 1. Scan channels and take note of those which can be merged
  1191. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1192. {
  1193. if (!(table->VisibleUnclippedMaskByIndex & ((ImU64)1 << column_n)))
  1194. continue;
  1195. ImGuiTableColumn* column = &table->Columns[column_n];
  1196. const int merge_group_sub_count = is_frozen_v ? 2 : 1;
  1197. for (int merge_group_sub_n = 0; merge_group_sub_n < merge_group_sub_count; merge_group_sub_n++)
  1198. {
  1199. const int channel_no = (merge_group_sub_n == 0) ? column->DrawChannelRowsBeforeFreeze : column->DrawChannelRowsAfterFreeze;
  1200. // Don't attempt to merge if there are multiple draw calls within the column
  1201. ImDrawChannel* src_channel = &splitter->_Channels[channel_no];
  1202. if (src_channel->_CmdBuffer.Size > 0 && src_channel->_CmdBuffer.back().ElemCount == 0)
  1203. src_channel->_CmdBuffer.pop_back();
  1204. if (src_channel->_CmdBuffer.Size != 1)
  1205. continue;
  1206. // Find out the width of this merge group and check if it will fit in our column.
  1207. if (!(column->Flags & ImGuiTableColumnFlags_NoClipX))
  1208. {
  1209. float width_contents;
  1210. if (merge_group_sub_count == 1) // No row freeze (same as testing !is_frozen_v)
  1211. width_contents = ImMax(column->ContentWidthRowsUnfrozen, column->ContentWidthHeadersUsed);
  1212. else if (merge_group_sub_n == 0) // Row freeze: use width before freeze
  1213. width_contents = ImMax(column->ContentWidthRowsFrozen, column->ContentWidthHeadersUsed);
  1214. else // Row freeze: use width after freeze
  1215. width_contents = column->ContentWidthRowsUnfrozen;
  1216. if (width_contents > column->WidthGiven)
  1217. continue;
  1218. }
  1219. const int merge_group_dst_n = (is_frozen_h && column_n < table->FreezeColumnsCount ? 0 : 2) + (is_frozen_v ? merge_group_sub_n : 1);
  1220. IM_ASSERT(channel_no < IMGUI_TABLE_MAX_DRAW_CHANNELS);
  1221. MergeGroup* merge_group = &merge_groups[merge_group_dst_n];
  1222. if (merge_group->ChannelsCount == 0)
  1223. merge_group->ClipRect = ImRect(+FLT_MAX, +FLT_MAX, -FLT_MAX, -FLT_MAX);
  1224. merge_group->ChannelsMask.SetBit(channel_no);
  1225. merge_group->ChannelsCount++;
  1226. merge_group->ClipRect.Add(src_channel->_CmdBuffer[0].ClipRect);
  1227. merge_group_mask |= (1 << merge_group_dst_n);
  1228. // If we end with a single group and hosted by the outer window, we'll attempt to merge our draw command
  1229. // with the existing outer window command. But we can only do so if our columns all fit within the expected
  1230. // clip rect, otherwise clipping will be incorrect when ScrollX is disabled.
  1231. // FIXME-TABLE FIXME-WORKRECT: We are wasting a merge opportunity on tables without scrolling if column don't fit within host clip rect, solely because of the half-padding difference between window->WorkRect and window->InnerClipRect
  1232. // 2019/10/22: (1) This is breaking table_2_draw_calls but I cannot seem to repro what it is attempting to
  1233. // fix... cf git fce2e8dc "Fixed issue with clipping when outerwindow==innerwindow / support ScrollH without ScrollV."
  1234. // 2019/10/22: (2) Clamping code in TableUpdateLayout() seemingly made this not necessary...
  1235. #if 0
  1236. if (column->MinX < table->InnerClipRect.Min.x || column->MaxX > table->InnerClipRect.Max.x)
  1237. merge_groups_all_fit_within_inner_rect = false;
  1238. #endif
  1239. }
  1240. // Invalidate current draw channel
  1241. // (we don't clear DrawChannelBeforeRowFreeze/DrawChannelAfterRowFreeze solely to facilitate debugging/later inspection of data)
  1242. column->DrawChannelCurrent = -1;
  1243. }
  1244. // [DEBUG] Display merge groups
  1245. #if 0
  1246. if (g.IO.KeyShift)
  1247. for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++)
  1248. {
  1249. MergeGroup* merge_group = &merge_groups[merge_group_n];
  1250. if (merge_group->ChannelsCount == 0)
  1251. continue;
  1252. char buf[32];
  1253. ImFormatString(buf, 32, "MG%d:%d", merge_group_n, merge_group->ChannelsCount);
  1254. ImVec2 text_pos = merge_group->ClipRect.Min + ImVec2(4, 4);
  1255. ImVec2 text_size = CalcTextSize(buf, NULL);
  1256. GetForegroundDrawList()->AddRectFilled(text_pos, text_pos + text_size, IM_COL32(0, 0, 0, 255));
  1257. GetForegroundDrawList()->AddText(text_pos, IM_COL32(255, 255, 0, 255), buf, NULL);
  1258. GetForegroundDrawList()->AddRect(merge_group->ClipRect.Min, merge_group->ClipRect.Max, IM_COL32(255, 255, 0, 255));
  1259. }
  1260. #endif
  1261. // 2. Rewrite channel list in our preferred order
  1262. if (merge_group_mask != 0)
  1263. {
  1264. // Conceptually we want to test if only 1 bit of merge_group_mask is set, but with no freezing we know it's always going to be group 3.
  1265. // We need to test for !is_frozen because any unfitting column will not be part of a merge group, so testing for merge_group_mask isn't enough.
  1266. const bool may_extend_clip_rect_to_host_rect = (merge_group_mask == (1 << 3)) && !is_frozen_v && !is_frozen_h;
  1267. // Use shared temporary storage so the allocation gets amortized
  1268. g.DrawChannelsTempMergeBuffer.resize(splitter->_Count - 1);
  1269. ImDrawChannel* dst_tmp = g.DrawChannelsTempMergeBuffer.Data;
  1270. ImBitArray<IMGUI_TABLE_MAX_DRAW_CHANNELS> remaining_mask; // We need 130-bit of storage
  1271. remaining_mask.ClearBits();
  1272. remaining_mask.SetBitRange(1, splitter->_Count - 1); // Background channel 0 not part of the merge (see channel allocation in TableUpdateDrawChannels)
  1273. int remaining_count = splitter->_Count - 1;
  1274. for (int merge_group_n = 0; merge_group_n < IM_ARRAYSIZE(merge_groups); merge_group_n++)
  1275. if (int merge_channels_count = merge_groups[merge_group_n].ChannelsCount)
  1276. {
  1277. MergeGroup* merge_group = &merge_groups[merge_group_n];
  1278. ImRect merge_clip_rect = merge_groups[merge_group_n].ClipRect;
  1279. if (may_extend_clip_rect_to_host_rect)
  1280. {
  1281. IM_ASSERT(merge_group_n == 3);
  1282. //GetOverlayDrawList()->AddRect(table->HostClipRect.Min, table->HostClipRect.Max, IM_COL32(255, 0, 0, 200), 0.0f, ~0, 3.0f);
  1283. //GetOverlayDrawList()->AddRect(table->InnerClipRect.Min, table->InnerClipRect.Max, IM_COL32(0, 255, 0, 200), 0.0f, ~0, 1.0f);
  1284. //GetOverlayDrawList()->AddRect(merge_clip_rect.Min, merge_clip_rect.Max, IM_COL32(255, 0, 0, 200), 0.0f, ~0, 2.0f);
  1285. merge_clip_rect.Add(merge_groups_all_fit_within_inner_rect ? table->HostClipRect : table->InnerClipRect);
  1286. //GetOverlayDrawList()->AddRect(merge_clip_rect.Min, merge_clip_rect.Max, IM_COL32(0, 255, 0, 200));
  1287. }
  1288. remaining_count -= merge_group->ChannelsCount;
  1289. for (int n = 0; n < IM_ARRAYSIZE(remaining_mask.Storage); n++)
  1290. remaining_mask.Storage[n] &= ~merge_group->ChannelsMask.Storage[n];
  1291. for (int n = 0; n < splitter->_Count && merge_channels_count != 0; n++)
  1292. {
  1293. // Copy + overwrite new clip rect
  1294. if (!merge_group->ChannelsMask.TestBit(n))
  1295. continue;
  1296. merge_group->ChannelsMask.ClearBit(n);
  1297. merge_channels_count--;
  1298. ImDrawChannel* channel = &splitter->_Channels[n];
  1299. IM_ASSERT(channel->_CmdBuffer.Size == 1 && merge_clip_rect.Contains(ImRect(channel->_CmdBuffer[0].ClipRect)));
  1300. channel->_CmdBuffer[0].ClipRect = merge_clip_rect.ToVec4();
  1301. memcpy(dst_tmp++, channel, sizeof(ImDrawChannel));
  1302. }
  1303. }
  1304. // Append unmergeable channels that we didn't reorder at the end of the list
  1305. for (int n = 0; n < splitter->_Count && remaining_count != 0; n++)
  1306. {
  1307. if (!remaining_mask.TestBit(n))
  1308. continue;
  1309. ImDrawChannel* channel = &splitter->_Channels[n];
  1310. memcpy(dst_tmp++, channel, sizeof(ImDrawChannel));
  1311. remaining_count--;
  1312. }
  1313. IM_ASSERT(dst_tmp == g.DrawChannelsTempMergeBuffer.Data + g.DrawChannelsTempMergeBuffer.Size);
  1314. memcpy(splitter->_Channels.Data + 1, g.DrawChannelsTempMergeBuffer.Data, (splitter->_Count - 1) * sizeof(ImDrawChannel));
  1315. }
  1316. // 3. Actually merge (channels using the same clip rect will be contiguous and naturally merged)
  1317. splitter->Merge(table->InnerWindow->DrawList);
  1318. }
  1319. // We use a default parameter of 'init_width_or_weight == -1'
  1320. // ImGuiTableColumnFlags_WidthFixed, width <= 0 --> init width == auto
  1321. // ImGuiTableColumnFlags_WidthFixed, width > 0 --> init width == manual
  1322. // ImGuiTableColumnFlags_WidthStretch, weight < 0 --> init weight == 1.0f
  1323. // ImGuiTableColumnFlags_WidthStretch, weight >= 0 --> init weight == custom
  1324. // Use a different API?
  1325. void ImGui::TableSetupColumn(const char* label, ImGuiTableColumnFlags flags, float init_width_or_weight, ImGuiID user_id)
  1326. {
  1327. ImGuiContext& g = *GImGui;
  1328. ImGuiTable* table = g.CurrentTable;
  1329. IM_ASSERT(table != NULL && "Need to call TableSetupColumn() after BeginTable()!");
  1330. IM_ASSERT(!table->IsLayoutLocked && "Need to call call TableSetupColumn() before first row!");
  1331. IM_ASSERT(table->DeclColumnsCount >= 0 && table->DeclColumnsCount < table->ColumnsCount && "Called TableSetupColumn() too many times!");
  1332. ImGuiTableColumn* column = &table->Columns[table->DeclColumnsCount];
  1333. table->DeclColumnsCount++;
  1334. // When passing a width automatically enforce WidthFixed policy
  1335. // (vs TableFixColumnFlags would default to WidthAlwaysAutoResize)
  1336. // (we write to FlagsIn which is a little misleading, another solution would be to pass init_width_or_weight to TableFixColumnFlags)
  1337. if ((flags & ImGuiTableColumnFlags_WidthMask_) == 0)
  1338. if ((table->Flags & ImGuiTableFlags_SizingPolicyFixedX) && (init_width_or_weight > 0.0f))
  1339. flags |= ImGuiTableColumnFlags_WidthFixed;
  1340. column->UserID = user_id;
  1341. column->FlagsIn = flags;
  1342. column->Flags = TableFixColumnFlags(table, column->FlagsIn);
  1343. flags = column->Flags;
  1344. // Initialize defaults
  1345. // FIXME-TABLE: We don't restore widths/weight so let's avoid using IsSettingsLoaded for now
  1346. if (table->IsInitializing && column->WidthRequest < 0.0f && column->WidthStretchWeight < 0.0f)// && !table->IsSettingsLoaded)
  1347. {
  1348. // Init width or weight
  1349. // Disable auto-fit if a default fixed width has been specified
  1350. if ((flags & ImGuiTableColumnFlags_WidthFixed) && init_width_or_weight > 0.0f)
  1351. {
  1352. column->WidthRequest = init_width_or_weight;
  1353. column->AutoFitQueue = 0x00;
  1354. }
  1355. if (flags & ImGuiTableColumnFlags_WidthStretch)
  1356. {
  1357. IM_ASSERT(init_width_or_weight < 0.0f || init_width_or_weight > 0.0f);
  1358. column->WidthStretchWeight = (init_width_or_weight < 0.0f ? 1.0f : init_width_or_weight);
  1359. }
  1360. else
  1361. {
  1362. column->WidthStretchWeight = 1.0f;
  1363. }
  1364. }
  1365. if (table->IsInitializing)
  1366. {
  1367. // Init default visibility/sort state
  1368. if ((flags & ImGuiTableColumnFlags_DefaultHide) && (table->SettingsLoadedFlags & ImGuiTableFlags_Hideable) == 0)
  1369. column->IsVisible = column->IsVisibleNextFrame = false;
  1370. if (flags & ImGuiTableColumnFlags_DefaultSort && (table->SettingsLoadedFlags & ImGuiTableFlags_Sortable) == 0)
  1371. {
  1372. column->SortOrder = 0; // Multiple columns using _DefaultSort will be reordered when building the sort specs.
  1373. column->SortDirection = (column->Flags & ImGuiTableColumnFlags_PreferSortDescending) ? (ImS8)ImGuiSortDirection_Descending : (ImU8)(ImGuiSortDirection_Ascending);
  1374. }
  1375. }
  1376. // Store name (append with zero-terminator in contiguous buffer)
  1377. IM_ASSERT(column->NameOffset == -1);
  1378. if (label != NULL)
  1379. {
  1380. column->NameOffset = (ImS16)table->ColumnsNames.size();
  1381. table->ColumnsNames.append(label, label + strlen(label) + 1);
  1382. }
  1383. }
  1384. // Starts into the first cell of a new row
  1385. void ImGui::TableNextRow(ImGuiTableRowFlags row_flags, float row_min_height)
  1386. {
  1387. ImGuiContext& g = *GImGui;
  1388. ImGuiTable* table = g.CurrentTable;
  1389. if (table->CurrentRow == -1)
  1390. TableUpdateLayout(table);
  1391. else if (table->IsInsideRow)
  1392. TableEndRow(table);
  1393. table->LastRowFlags = table->RowFlags;
  1394. table->RowFlags = row_flags;
  1395. table->RowMinHeight = row_min_height;
  1396. TableBeginRow(table);
  1397. // We honor min_row_height requested by user, but cannot guarantee per-row maximum height,
  1398. // because that would essentially require a unique clipping rectangle per-cell.
  1399. table->RowPosY2 += table->CellPaddingY * 2.0f;
  1400. table->RowPosY2 = ImMax(table->RowPosY2, table->RowPosY1 + row_min_height);
  1401. TableBeginCell(table, 0);
  1402. }
  1403. // [Internal]
  1404. void ImGui::TableBeginRow(ImGuiTable* table)
  1405. {
  1406. ImGuiWindow* window = table->InnerWindow;
  1407. IM_ASSERT(!table->IsInsideRow);
  1408. // New row
  1409. table->CurrentRow++;
  1410. table->CurrentColumn = -1;
  1411. table->RowBgColor = IM_COL32_DISABLE;
  1412. table->IsInsideRow = true;
  1413. // Begin frozen rows
  1414. float next_y1 = table->RowPosY2;
  1415. if (table->CurrentRow == 0 && table->FreezeRowsCount > 0)
  1416. next_y1 = window->DC.CursorPos.y = table->OuterRect.Min.y;
  1417. table->RowPosY1 = table->RowPosY2 = next_y1;
  1418. table->RowTextBaseline = 0.0f;
  1419. table->RowIndentOffsetX = window->DC.Indent.x - table->HostIndentX; // Lock indent
  1420. window->DC.PrevLineTextBaseOffset = 0.0f;
  1421. window->DC.CursorMaxPos.y = next_y1;
  1422. // Making the header BG color non-transparent will allow us to overlay it multiple times when handling smooth dragging.
  1423. if (table->RowFlags & ImGuiTableRowFlags_Headers)
  1424. {
  1425. table->RowBgColor = GetColorU32(ImGuiCol_TableHeaderBg);
  1426. if (table->CurrentRow == 0)
  1427. table->IsUsingHeaders = true;
  1428. }
  1429. }
  1430. // [Internal]
  1431. void ImGui::TableEndRow(ImGuiTable* table)
  1432. {
  1433. ImGuiContext& g = *GImGui;
  1434. ImGuiWindow* window = g.CurrentWindow;
  1435. IM_ASSERT(window == table->InnerWindow);
  1436. IM_ASSERT(table->IsInsideRow);
  1437. TableEndCell(table);
  1438. // Position cursor at the bottom of our row so it can be used for e.g. clipping calculation. However it is
  1439. // likely that the next call to TableBeginCell() will reposition the cursor to take account of vertical padding.
  1440. window->DC.CursorPos.y = table->RowPosY2;
  1441. // Row background fill
  1442. const float bg_y1 = table->RowPosY1;
  1443. const float bg_y2 = table->RowPosY2;
  1444. if (table->CurrentRow == 0)
  1445. table->LastFirstRowHeight = bg_y2 - bg_y1;
  1446. if (table->CurrentRow >= 0 && bg_y2 >= table->InnerClipRect.Min.y && bg_y1 <= table->InnerClipRect.Max.y)
  1447. {
  1448. // Decide of background color for the row
  1449. ImU32 bg_col = 0;
  1450. if (table->RowBgColor != IM_COL32_DISABLE)
  1451. bg_col = table->RowBgColor;
  1452. else if (table->Flags & ImGuiTableFlags_RowBg)
  1453. bg_col = GetColorU32((table->RowBgColorCounter & 1) ? ImGuiCol_TableRowBgAlt : ImGuiCol_TableRowBg);
  1454. // Decide of top border color
  1455. ImU32 border_col = 0;
  1456. if (table->CurrentRow != 0 || table->InnerWindow == table->OuterWindow)
  1457. {
  1458. if (table->Flags & ImGuiTableFlags_BordersHInner)
  1459. {
  1460. //if (table->CurrentRow == 0 && table->InnerWindow == table->OuterWindow)
  1461. // border_col = table->BorderOuterColor;
  1462. //else
  1463. if (table->CurrentRow > 0)// && !(table->LastRowFlags & ImGuiTableRowFlags_Headers))
  1464. border_col = (table->LastRowFlags & ImGuiTableRowFlags_Headers) ? table->BorderColorStrong : table->BorderColorLight;
  1465. }
  1466. else
  1467. {
  1468. //if (table->RowFlags & ImGuiTableRowFlags_Headers)
  1469. // border_col = table->BorderOuterColor;
  1470. }
  1471. }
  1472. if (bg_col != 0 || border_col != 0)
  1473. table->DrawSplitter.SetCurrentChannel(window->DrawList, 0);
  1474. // Draw background
  1475. // We soft/cpu clip this so all backgrounds and borders can share the same clipping rectangle
  1476. if (bg_col)
  1477. {
  1478. ImRect bg_rect(table->WorkRect.Min.x, bg_y1, table->WorkRect.Max.x, bg_y2);
  1479. bg_rect.ClipWith(table->BackgroundClipRect);
  1480. if (bg_rect.Min.y < bg_rect.Max.y)
  1481. window->DrawList->AddRectFilledMultiColor(bg_rect.Min, bg_rect.Max, bg_col, bg_col, bg_col, bg_col);
  1482. }
  1483. // Draw top border
  1484. const float border_y = bg_y1;
  1485. if (border_col && border_y >= table->BackgroundClipRect.Min.y && border_y < table->BackgroundClipRect.Max.y)
  1486. window->DrawList->AddLine(ImVec2(table->BorderX1, border_y), ImVec2(table->BorderX2, border_y), border_col);
  1487. }
  1488. const bool unfreeze_rows = (table->CurrentRow + 1 == table->FreezeRowsCount && table->FreezeRowsCount > 0);
  1489. // Draw bottom border (always strong)
  1490. const bool draw_separating_border = unfreeze_rows;// || (table->RowFlags & ImGuiTableRowFlags_Headers);
  1491. if (draw_separating_border)
  1492. if (bg_y2 >= table->BackgroundClipRect.Min.y && bg_y2 < table->BackgroundClipRect.Max.y)
  1493. window->DrawList->AddLine(ImVec2(table->BorderX1, bg_y2), ImVec2(table->BorderX2, bg_y2), table->BorderColorStrong);
  1494. // End frozen rows (when we are past the last frozen row line, teleport cursor and alter clipping rectangle)
  1495. // We need to do that in TableEndRow() instead of TableBeginRow() so the list clipper can mark end of row and
  1496. // get the new cursor position.
  1497. if (unfreeze_rows)
  1498. {
  1499. IM_ASSERT(table->IsFreezeRowsPassed == false);
  1500. table->IsFreezeRowsPassed = true;
  1501. table->DrawSplitter.SetCurrentChannel(window->DrawList, 0);
  1502. ImRect r;
  1503. r.Min.x = table->InnerClipRect.Min.x;
  1504. r.Min.y = ImMax(table->RowPosY2 + 1, window->InnerClipRect.Min.y);
  1505. r.Max.x = table->InnerClipRect.Max.x;
  1506. r.Max.y = window->InnerClipRect.Max.y;
  1507. table->BackgroundClipRect = r;
  1508. float row_height = table->RowPosY2 - table->RowPosY1;
  1509. table->RowPosY2 = window->DC.CursorPos.y = table->WorkRect.Min.y + table->RowPosY2 - table->OuterRect.Min.y;
  1510. table->RowPosY1 = table->RowPosY2 - row_height;
  1511. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1512. {
  1513. ImGuiTableColumn* column = &table->Columns[column_n];
  1514. column->DrawChannelCurrent = column->DrawChannelRowsAfterFreeze;
  1515. column->ClipRect.Min.y = r.Min.y;
  1516. }
  1517. }
  1518. if (!(table->RowFlags & ImGuiTableRowFlags_Headers))
  1519. table->RowBgColorCounter++;
  1520. table->IsInsideRow = false;
  1521. }
  1522. // [Internal] Called by TableNextCell()!
  1523. // This is called very frequently, so we need to be mindful of unnecessary overhead.
  1524. // FIXME-TABLE FIXME-OPT: Could probably shortcut some things for non-active or clipped columns.
  1525. void ImGui::TableBeginCell(ImGuiTable* table, int column_n)
  1526. {
  1527. table->CurrentColumn = column_n;
  1528. ImGuiTableColumn* column = &table->Columns[column_n];
  1529. ImGuiWindow* window = table->InnerWindow;
  1530. // Start position is roughly ~~ CellRect.Min + CellPadding + Indent
  1531. float start_x = (table->RowFlags & ImGuiTableRowFlags_Headers) ? column->StartXHeaders : column->StartXRows;
  1532. if (column->Flags & ImGuiTableColumnFlags_IndentEnable)
  1533. start_x += table->RowIndentOffsetX; // ~~ += window.DC.Indent.x - table->HostIndentX, except we locked it for the row.
  1534. window->DC.CursorPos.x = start_x;
  1535. window->DC.CursorPos.y = table->RowPosY1 + table->CellPaddingY;
  1536. window->DC.CursorMaxPos.x = window->DC.CursorPos.x;
  1537. window->DC.ColumnsOffset.x = start_x - window->Pos.x - window->DC.Indent.x; // FIXME-WORKRECT
  1538. window->DC.CurrLineTextBaseOffset = table->RowTextBaseline;
  1539. window->DC.LastItemId = 0;
  1540. window->WorkRect.Min.y = window->DC.CursorPos.y;
  1541. window->WorkRect.Min.x = column->MinX + table->CellPaddingX1;
  1542. window->WorkRect.Max.x = column->MaxX - table->CellPaddingX2;
  1543. // To allow ImGuiListClipper to function we propagate our row height
  1544. if (!column->IsVisible)
  1545. window->DC.CursorPos.y = ImMax(window->DC.CursorPos.y, table->RowPosY2);
  1546. window->SkipItems = column->SkipItems;
  1547. if (table->Flags & ImGuiTableFlags_NoClipX)
  1548. {
  1549. table->DrawSplitter.SetCurrentChannel(window->DrawList, 1);
  1550. }
  1551. else
  1552. {
  1553. table->DrawSplitter.SetCurrentChannel(window->DrawList, column->DrawChannelCurrent);
  1554. //window->ClipRect = column->ClipRect;
  1555. //IM_ASSERT(column->ClipRect.Max.x > column->ClipRect.Min.x && column->ClipRect.Max.y > column->ClipRect.Min.y);
  1556. //window->DrawList->_ClipRectStack.back() = ImVec4(column->ClipRect.Min.x, column->ClipRect.Min.y, column->ClipRect.Max.x, column->ClipRect.Max.y);
  1557. //window->DrawList->UpdateClipRect();
  1558. window->DrawList->PopClipRect();
  1559. window->DrawList->PushClipRect(column->ClipRect.Min, column->ClipRect.Max, false);
  1560. //IMGUI_DEBUG_LOG("%d (%.0f,%.0f)(%.0f,%.0f)\n", column_n, column->ClipRect.Min.x, column->ClipRect.Min.y, column->ClipRect.Max.x, column->ClipRect.Max.y);
  1561. window->ClipRect = window->DrawList->_ClipRectStack.back();
  1562. }
  1563. }
  1564. // [Internal] Called by TableNextRow()/TableNextCell()!
  1565. void ImGui::TableEndCell(ImGuiTable* table)
  1566. {
  1567. ImGuiTableColumn* column = &table->Columns[table->CurrentColumn];
  1568. ImGuiWindow* window = table->InnerWindow;
  1569. // Report maximum position so we can infer content size per column.
  1570. float* p_max_pos_x;
  1571. if (table->RowFlags & ImGuiTableRowFlags_Headers)
  1572. p_max_pos_x = &column->ContentMaxPosHeadersUsed; // Useful in case user submit contents in header row that is not a TableHeader() call
  1573. else
  1574. p_max_pos_x = table->IsFreezeRowsPassed ? &column->ContentMaxPosRowsUnfrozen : &column->ContentMaxPosRowsFrozen;
  1575. *p_max_pos_x = ImMax(*p_max_pos_x, window->DC.CursorMaxPos.x);
  1576. table->RowPosY2 = ImMax(table->RowPosY2, window->DC.CursorMaxPos.y + table->CellPaddingY);
  1577. // Propagate text baseline for the entire row
  1578. // FIXME-TABLE: Here we propagate text baseline from the last line of the cell.. instead of the first one.
  1579. table->RowTextBaseline = ImMax(table->RowTextBaseline, window->DC.PrevLineTextBaseOffset);
  1580. }
  1581. // Append into the next cell
  1582. // FIXME-TABLE: Wrapping to next row should be optional?
  1583. bool ImGui::TableNextCell()
  1584. {
  1585. ImGuiContext& g = *GImGui;
  1586. ImGuiTable* table = g.CurrentTable;
  1587. if (table->CurrentColumn != -1 && table->CurrentColumn + 1 < table->ColumnsCount)
  1588. {
  1589. TableEndCell(table);
  1590. TableBeginCell(table, table->CurrentColumn + 1);
  1591. }
  1592. else
  1593. {
  1594. TableNextRow();
  1595. }
  1596. int column_n = table->CurrentColumn;
  1597. return (table->VisibleUnclippedMaskByIndex & ((ImU64)1 << column_n)) != 0;
  1598. }
  1599. const char* ImGui::TableGetColumnName(int column_n)
  1600. {
  1601. ImGuiContext& g = *GImGui;
  1602. ImGuiTable* table = g.CurrentTable;
  1603. if (!table)
  1604. return NULL;
  1605. if (column_n < 0)
  1606. column_n = table->CurrentColumn;
  1607. return TableGetColumnName(table, column_n);
  1608. }
  1609. // We expose "Visible and Unclipped" to the user, vs our internal "Visible" state which is !Hidden
  1610. bool ImGui::TableGetColumnIsVisible(int column_n)
  1611. {
  1612. ImGuiContext& g = *GImGui;
  1613. ImGuiTable* table = g.CurrentTable;
  1614. if (!table)
  1615. return false;
  1616. if (column_n < 0)
  1617. column_n = table->CurrentColumn;
  1618. return (table->VisibleUnclippedMaskByIndex & ((ImU64)1 << column_n)) != 0;
  1619. }
  1620. int ImGui::TableGetColumnIndex()
  1621. {
  1622. ImGuiContext& g = *GImGui;
  1623. ImGuiTable* table = g.CurrentTable;
  1624. if (!table)
  1625. return 0;
  1626. return table->CurrentColumn;
  1627. }
  1628. bool ImGui::TableSetColumnIndex(int column_idx)
  1629. {
  1630. ImGuiContext& g = *GImGui;
  1631. ImGuiTable* table = g.CurrentTable;
  1632. if (!table)
  1633. return false;
  1634. if (table->CurrentColumn != column_idx)
  1635. {
  1636. if (table->CurrentColumn != -1)
  1637. TableEndCell(table);
  1638. IM_ASSERT(column_idx >= 0 && table->ColumnsCount);
  1639. TableBeginCell(table, column_idx);
  1640. }
  1641. return (table->VisibleUnclippedMaskByIndex & ((ImU64)1 << column_idx)) != 0;
  1642. }
  1643. // Return the cell rectangle based on currently known height.
  1644. // Important: we generally don't know our row height until the end of the row, so Max.y will be incorrect in many situations.
  1645. // The only case where this is correct is if we provided a min_row_height to TableNextRow() and don't go below it.
  1646. ImRect ImGui::TableGetCellRect()
  1647. {
  1648. ImGuiContext& g = *GImGui;
  1649. ImGuiTable* table = g.CurrentTable;
  1650. ImGuiTableColumn* column = &table->Columns[table->CurrentColumn];
  1651. return ImRect(column->MinX, table->RowPosY1, column->MaxX, table->RowPosY2);
  1652. }
  1653. const char* ImGui::TableGetColumnName(const ImGuiTable* table, int column_n)
  1654. {
  1655. const ImGuiTableColumn* column = &table->Columns[column_n];
  1656. if (column->NameOffset == -1)
  1657. return NULL;
  1658. return &table->ColumnsNames.Buf[column->NameOffset];
  1659. }
  1660. // Return the resizing ID for the right-side of the given column.
  1661. ImGuiID ImGui::TableGetColumnResizeID(const ImGuiTable* table, int column_n, int instance_no)
  1662. {
  1663. IM_ASSERT(column_n < table->ColumnsCount);
  1664. ImGuiID id = table->ID + (instance_no * table->ColumnsCount) + column_n;
  1665. return id;
  1666. }
  1667. void ImGui::TableSetColumnAutofit(ImGuiTable* table, int column_n)
  1668. {
  1669. // Disable clipping then auto-fit, will take 2 frames
  1670. // (we don't take a shortcut for unclipped columns to reduce inconsistencies when e.g. resizing multiple columns)
  1671. ImGuiTableColumn* column = &table->Columns[column_n];
  1672. column->CannotSkipItemsQueue = (1 << 0);
  1673. column->AutoFitQueue = (1 << 1);
  1674. }
  1675. void ImGui::PushTableBackground()
  1676. {
  1677. ImGuiContext& g = *GImGui;
  1678. ImGuiWindow* window = g.CurrentWindow;
  1679. ImGuiTable* table = g.CurrentTable;
  1680. table->DrawSplitter.SetCurrentChannel(window->DrawList, 0);
  1681. PushClipRect(table->HostClipRect.Min, table->HostClipRect.Max, false);
  1682. }
  1683. void ImGui::PopTableBackground()
  1684. {
  1685. ImGuiContext& g = *GImGui;
  1686. ImGuiWindow* window = g.CurrentWindow;
  1687. ImGuiTable* table = g.CurrentTable;
  1688. ImGuiTableColumn* column = &table->Columns[table->CurrentColumn];
  1689. table->DrawSplitter.SetCurrentChannel(window->DrawList, column->DrawChannelCurrent);
  1690. PopClipRect();
  1691. }
  1692. // Output context menu into current window (generally a popup)
  1693. // FIXME-TABLE: Ideally this should be writable by the user. Full programmatic access to that data?
  1694. void ImGui::TableDrawContextMenu(ImGuiTable* table, int selected_column_n)
  1695. {
  1696. ImGuiContext& g = *GImGui;
  1697. ImGuiWindow* window = g.CurrentWindow;
  1698. if (window->SkipItems)
  1699. return;
  1700. bool want_separator = false;
  1701. selected_column_n = ImClamp(selected_column_n, -1, table->ColumnsCount - 1);
  1702. // Sizing
  1703. if (table->Flags & ImGuiTableFlags_Resizable)
  1704. {
  1705. if (ImGuiTableColumn* selected_column = (selected_column_n != -1) ? &table->Columns[selected_column_n] : NULL)
  1706. {
  1707. const bool can_resize = !(selected_column->Flags & (ImGuiTableColumnFlags_NoResize | ImGuiTableColumnFlags_WidthStretch)) && selected_column->IsVisible;
  1708. if (MenuItem("Size column to fit", NULL, false, can_resize))
  1709. TableSetColumnAutofit(table, selected_column_n);
  1710. }
  1711. if (MenuItem("Size all columns to fit", NULL))
  1712. {
  1713. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1714. {
  1715. ImGuiTableColumn* column = &table->Columns[column_n];
  1716. if (column->IsVisible)
  1717. TableSetColumnAutofit(table, column_n);
  1718. }
  1719. }
  1720. want_separator = true;
  1721. }
  1722. // Ordering
  1723. if (table->Flags & ImGuiTableFlags_Reorderable)
  1724. {
  1725. if (MenuItem("Reset order", NULL, false, !table->IsDefaultDisplayOrder))
  1726. table->IsResetDisplayOrderRequest = true;
  1727. want_separator = true;
  1728. }
  1729. // Hiding / Visibility
  1730. if (table->Flags & ImGuiTableFlags_Hideable)
  1731. {
  1732. if (want_separator)
  1733. Separator();
  1734. want_separator = false;
  1735. PushItemFlag(ImGuiItemFlags_SelectableDontClosePopup, true);
  1736. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1737. {
  1738. ImGuiTableColumn* column = &table->Columns[column_n];
  1739. const char* name = TableGetColumnName(table, column_n);
  1740. if (name == NULL)
  1741. name = "<Unknown>";
  1742. // Make sure we can't hide the last active column
  1743. bool menu_item_active = (column->Flags & ImGuiTableColumnFlags_NoHide) ? false : true;
  1744. if (column->IsVisible && table->ColumnsVisibleCount <= 1)
  1745. menu_item_active = false;
  1746. if (MenuItem(name, NULL, column->IsVisible, menu_item_active))
  1747. column->IsVisibleNextFrame = !column->IsVisible;
  1748. }
  1749. PopItemFlag();
  1750. }
  1751. }
  1752. // This is a helper to output TableHeader() calls based on the column names declared in TableSetupColumn().
  1753. // The intent is that advanced users willing to create customized headers would not need to use this helper and may
  1754. // create their own. However presently this function uses too many internal structures/calls.
  1755. void ImGui::TableAutoHeaders()
  1756. {
  1757. ImGuiContext& g = *GImGui;
  1758. ImGuiWindow* window = g.CurrentWindow;
  1759. ImGuiTable* table = g.CurrentTable;
  1760. IM_ASSERT(table != NULL && "Need to call TableAutoHeaders() after BeginTable()!");
  1761. const int columns_count = table->ColumnsCount;
  1762. // Calculate row height (for the unlikely case that labels may be are multi-line)
  1763. float row_height = GetTextLineHeight();
  1764. for (int column_n = 0; column_n < columns_count; column_n++)
  1765. if (TableGetColumnIsVisible(column_n))
  1766. row_height = ImMax(row_height, CalcTextSize(TableGetColumnName(column_n)).y);
  1767. row_height += g.Style.CellPadding.y * 2.0f;
  1768. // Open row
  1769. TableNextRow(ImGuiTableRowFlags_Headers, row_height);
  1770. if (table->HostSkipItems) // Merely an optimization
  1771. return;
  1772. // This for loop is constructed to not make use of internal functions,
  1773. // as this is intended to be a base template to copy and build from.
  1774. int open_context_popup = INT_MAX;
  1775. for (int column_n = 0; column_n < columns_count; column_n++)
  1776. {
  1777. if (!TableSetColumnIndex(column_n))
  1778. continue;
  1779. const char* name = TableGetColumnName(column_n);
  1780. // [DEBUG] Test custom user elements
  1781. #if 0
  1782. if (column_n < 2)
  1783. {
  1784. static bool b[2] = {};
  1785. PushID(column_n);
  1786. PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2(0, 0));
  1787. Checkbox("##", &b[column_n]);
  1788. PopStyleVar();
  1789. PopID();
  1790. SameLine(0.0f, g.Style.ItemInnerSpacing.x);
  1791. }
  1792. #endif
  1793. // [DEBUG]
  1794. //if (g.IO.KeyCtrl) { static char buf[32]; name = buf; ImGuiTableColumn* c = &table->Columns[column_n]; if (c->Flags & ImGuiTableColumnFlags_WidthStretch) ImFormatString(buf, 32, "%.3f>%.1f", c->ResizeWeight, c->WidthGiven); else ImFormatString(buf, 32, "%.1f", c->WidthGiven); }
  1795. // Push an id to allow unnamed labels (generally accidental, but let's behave nicely with them)
  1796. PushID(table->InstanceCurrent * table->ColumnsCount + column_n);
  1797. TableHeader(name);
  1798. PopID();
  1799. // We don't use BeginPopupContextItem() because we want the popup to stay up even after the column is hidden
  1800. if (IsMouseReleased(1) && IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup))
  1801. open_context_popup = column_n;
  1802. }
  1803. // FIXME-TABLE: This is not user-land code any more + need to explain WHY this is here!
  1804. window->SkipItems = table->HostSkipItems;
  1805. // Allow opening popup from the right-most section after the last column
  1806. // FIXME-TABLE: This is not user-land code any more... perhaps instead we should expose hovered column.
  1807. // and allow some sort of row-centric IsItemHovered() for full flexibility?
  1808. float unused_x1 = table->WorkRect.Min.x;
  1809. if (table->RightMostVisibleColumn != -1)
  1810. unused_x1 = ImMax(unused_x1, table->Columns[table->RightMostVisibleColumn].MaxX);
  1811. if (unused_x1 < table->WorkRect.Max.x)
  1812. {
  1813. // FIXME: We inherit ClipRect/SkipItem from last submitted column (active or not), let's temporarily override it.
  1814. // Because we don't perform any rendering here we just overwrite window->ClipRect used by logic.
  1815. window->ClipRect = table->InnerClipRect;
  1816. ImVec2 backup_cursor_max_pos = window->DC.CursorMaxPos;
  1817. window->DC.CursorPos = ImVec2(unused_x1, table->RowPosY1);
  1818. ImVec2 size = ImVec2(table->WorkRect.Max.x - window->DC.CursorPos.x, table->RowPosY2 - table->RowPosY1);
  1819. if (size.x > 0.0f && size.y > 0.0f)
  1820. {
  1821. InvisibleButton("##RemainingSpace", size);
  1822. window->DC.CursorPos.y -= g.Style.ItemSpacing.y;
  1823. window->DC.CursorMaxPos = backup_cursor_max_pos; // Don't feed back into the width of the Header row
  1824. // We don't use BeginPopupContextItem() because we want the popup to stay up even after the column is hidden.
  1825. if (IsMouseReleased(1) && IsItemHovered(ImGuiHoveredFlags_AllowWhenBlockedByPopup))
  1826. open_context_popup = -1;
  1827. }
  1828. window->ClipRect = window->DrawList->_ClipRectStack.back();
  1829. }
  1830. // Open Context Menu
  1831. if (open_context_popup != INT_MAX)
  1832. if (table->Flags & (ImGuiTableFlags_Resizable | ImGuiTableFlags_Reorderable | ImGuiTableFlags_Hideable))
  1833. {
  1834. table->IsContextPopupOpen = true;
  1835. table->ContextPopupColumn = (ImS8)open_context_popup;
  1836. table->InstanceInteracted = table->InstanceCurrent;
  1837. OpenPopup("##TableContextMenu");
  1838. }
  1839. }
  1840. // Emit a column header (text + optional sort order)
  1841. // We cpu-clip text here so that all columns headers can be merged into a same draw call.
  1842. // Note that because of how we cpu-clip and display sorting indicators, you _cannot_ use SameLine() after a TableHeader()
  1843. // FIXME-TABLE: Should hold a selection state.
  1844. // FIXME-TABLE: Style confusion between CellPadding.y and FramePadding.y
  1845. void ImGui::TableHeader(const char* label)
  1846. {
  1847. ImGuiContext& g = *GImGui;
  1848. ImGuiWindow* window = g.CurrentWindow;
  1849. if (window->SkipItems)
  1850. return;
  1851. ImGuiTable* table = g.CurrentTable;
  1852. IM_ASSERT(table != NULL && "Need to call TableAutoHeaders() after BeginTable()!");
  1853. IM_ASSERT(table->CurrentColumn != -1);
  1854. const int column_n = table->CurrentColumn;
  1855. ImGuiTableColumn* column = &table->Columns[column_n];
  1856. // Label
  1857. if (label == NULL)
  1858. label = "";
  1859. const char* label_end = FindRenderedTextEnd(label);
  1860. ImVec2 label_size = CalcTextSize(label, label_end, true);
  1861. ImVec2 label_pos = window->DC.CursorPos;
  1862. // If we already got a row height, there's use that.
  1863. ImRect cell_r = TableGetCellRect();
  1864. float label_height = ImMax(label_size.y, table->RowMinHeight - g.Style.CellPadding.y * 2.0f);
  1865. //GetForegroundDrawList()->AddRect(cell_r.Min, cell_r.Max, IM_COL32(255, 0, 0, 255)); // [DEBUG]
  1866. ImRect work_r = cell_r;
  1867. work_r.Min.x = window->DC.CursorPos.x;
  1868. work_r.Max.y = work_r.Min.y + label_height;
  1869. float ellipsis_max = work_r.Max.x;
  1870. // Selectable
  1871. PushID(label);
  1872. // FIXME-TABLE: Fix when padding are disabled.
  1873. //window->DC.CursorPos.x = column->MinX + table->CellPadding.x;
  1874. // Keep header highlighted when context menu is open.
  1875. // (FIXME-TABLE: however we cannot assume the ID of said popup if it has been created by the user...)
  1876. const bool selected = (table->IsContextPopupOpen && table->ContextPopupColumn == column_n && table->InstanceInteracted == table->InstanceCurrent);
  1877. const bool pressed = Selectable("", selected, ImGuiSelectableFlags_DrawHoveredWhenHeld | ImGuiSelectableFlags_DontClosePopups, ImVec2(0.0f, label_height));
  1878. const bool held = IsItemActive();
  1879. if (held)
  1880. table->HeldHeaderColumn = (ImS8)column_n;
  1881. window->DC.CursorPos.y -= g.Style.ItemSpacing.y * 0.5f;
  1882. // Drag and drop to re-order columns.
  1883. // FIXME-TABLE: Scroll request while reordering a column and it lands out of the scrolling zone.
  1884. if (held && (table->Flags & ImGuiTableFlags_Reorderable) && IsMouseDragging(0) && !g.DragDropActive)
  1885. {
  1886. // While moving a column it will jump on the other side of the mouse, so we also test for MouseDelta.x
  1887. table->ReorderColumn = (ImS8)column_n;
  1888. table->InstanceInteracted = table->InstanceCurrent;
  1889. // We don't reorder: through the frozen<>unfrozen line, or through a column that is marked with ImGuiTableColumnFlags_NoReorder.
  1890. if (g.IO.MouseDelta.x < 0.0f && g.IO.MousePos.x < cell_r.Min.x)
  1891. if (ImGuiTableColumn* prev_column = (column->PrevVisibleColumn != -1) ? &table->Columns[column->PrevVisibleColumn] : NULL)
  1892. if (!((column->Flags | prev_column->Flags) & ImGuiTableColumnFlags_NoReorder))
  1893. if ((column->IndexWithinVisibleSet < table->FreezeColumnsRequest) == (prev_column->IndexWithinVisibleSet < table->FreezeColumnsRequest))
  1894. table->ReorderColumnDir = -1;
  1895. if (g.IO.MouseDelta.x > 0.0f && g.IO.MousePos.x > cell_r.Max.x)
  1896. if (ImGuiTableColumn* next_column = (column->NextVisibleColumn != -1) ? &table->Columns[column->NextVisibleColumn] : NULL)
  1897. if (!((column->Flags | next_column->Flags) & ImGuiTableColumnFlags_NoReorder))
  1898. if ((column->IndexWithinVisibleSet < table->FreezeColumnsRequest) == (next_column->IndexWithinVisibleSet < table->FreezeColumnsRequest))
  1899. table->ReorderColumnDir = +1;
  1900. }
  1901. // Sort order arrow
  1902. float w_arrow = 0.0f;
  1903. float w_sort_text = 0.0f;
  1904. if ((table->Flags & ImGuiTableFlags_Sortable) && !(column->Flags & ImGuiTableColumnFlags_NoSort))
  1905. {
  1906. const float ARROW_SCALE = 0.65f;
  1907. w_arrow = ImFloor(g.FontSize * ARROW_SCALE + g.Style.FramePadding.x);// table->CellPadding.x);
  1908. if (column->SortOrder != -1)
  1909. {
  1910. w_sort_text = 0.0f;
  1911. char sort_order_suf[8];
  1912. if (column->SortOrder > 0)
  1913. {
  1914. ImFormatString(sort_order_suf, IM_ARRAYSIZE(sort_order_suf), "%d", column->SortOrder + 1);
  1915. w_sort_text = g.Style.ItemInnerSpacing.x + CalcTextSize(sort_order_suf).x;
  1916. }
  1917. float x = ImMax(cell_r.Min.x, work_r.Max.x - w_arrow - w_sort_text);
  1918. ellipsis_max -= w_arrow + w_sort_text;
  1919. float y = label_pos.y;
  1920. ImU32 col = GetColorU32(ImGuiCol_Text);
  1921. if (column->SortOrder > 0)
  1922. {
  1923. PushStyleColor(ImGuiCol_Text, GetColorU32(ImGuiCol_Text, 0.70f));
  1924. RenderText(ImVec2(x + g.Style.ItemInnerSpacing.x, y), sort_order_suf);
  1925. PopStyleColor();
  1926. x += w_sort_text;
  1927. }
  1928. RenderArrow(window->DrawList, ImVec2(x, y), col, column->SortDirection == ImGuiSortDirection_Ascending ? ImGuiDir_Up : ImGuiDir_Down, ARROW_SCALE);
  1929. }
  1930. // Handle clicking on column header to adjust Sort Order
  1931. if (pressed && table->ReorderColumn != column_n)
  1932. TableSortSpecsClickColumn(table, column, g.IO.KeyShift);
  1933. }
  1934. // Render clipped label. Clipping here ensure that in the majority of situations, all our header cells will
  1935. // be merged into a single draw call.
  1936. //window->DrawList->AddCircleFilled(ImVec2(ellipsis_max, label_pos.y), 40, IM_COL32_WHITE);
  1937. RenderTextEllipsis(window->DrawList, label_pos, ImVec2(ellipsis_max, label_pos.y + label_height + g.Style.FramePadding.y), ellipsis_max, ellipsis_max, label, label_end, &label_size);
  1938. // We feed our unclipped width to the column without writing on CursorMaxPos, so that column is still considering
  1939. // for merging.
  1940. // FIXME-TABLE: Clarify policies of how label width and potential decorations (arrows) fit into auto-resize of the column
  1941. float max_pos_x = label_pos.x + label_size.x + w_sort_text + w_arrow;
  1942. column->ContentMaxPosHeadersUsed = ImMax(column->ContentMaxPosHeadersUsed, work_r.Max.x);// ImMin(max_pos_x, work_r.Max.x));
  1943. column->ContentMaxPosHeadersIdeal = ImMax(column->ContentMaxPosHeadersIdeal, max_pos_x);
  1944. PopID();
  1945. }
  1946. void ImGui::TableSortSpecsClickColumn(ImGuiTable* table, ImGuiTableColumn* clicked_column, bool add_to_existing_sort_orders)
  1947. {
  1948. if (!(table->Flags & ImGuiTableFlags_MultiSortable))
  1949. add_to_existing_sort_orders = false;
  1950. ImS8 sort_order_max = 0;
  1951. if (add_to_existing_sort_orders)
  1952. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1953. sort_order_max = ImMax(sort_order_max, table->Columns[column_n].SortOrder);
  1954. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  1955. {
  1956. ImGuiTableColumn* column = &table->Columns[column_n];
  1957. if (column == clicked_column)
  1958. {
  1959. // Set new sort direction and sort order
  1960. // - If the PreferSortDescending flag is set, we will default to a Descending direction on the first click.
  1961. // - Note that the PreferSortAscending flag is never checked, it is essentially the default and therefore a no-op.
  1962. // - Note that the NoSortAscending/NoSortDescending flags are processed in TableSortSpecsSanitize(), and they may change/revert
  1963. // the value of SortDirection. We could technically also do it here but it would be unnecessary and duplicate code.
  1964. if (column->SortOrder == -1)
  1965. column->SortDirection = (column->Flags & ImGuiTableColumnFlags_PreferSortDescending) ? (ImS8)ImGuiSortDirection_Descending : (ImU8)(ImGuiSortDirection_Ascending);
  1966. else
  1967. column->SortDirection = (ImU8)((column->SortDirection == ImGuiSortDirection_Ascending) ? ImGuiSortDirection_Descending : ImGuiSortDirection_Ascending);
  1968. if (column->SortOrder == -1 || !add_to_existing_sort_orders)
  1969. column->SortOrder = add_to_existing_sort_orders ? sort_order_max + 1 : 0;
  1970. }
  1971. else
  1972. {
  1973. if (!add_to_existing_sort_orders)
  1974. column->SortOrder = -1;
  1975. }
  1976. TableFixColumnSortDirection(column);
  1977. }
  1978. table->IsSettingsDirty = true;
  1979. table->IsSortSpecsDirty = true;
  1980. }
  1981. // Return NULL if no sort specs (most often when ImGuiTableFlags_Sortable is not set)
  1982. // You can sort your data again when 'SpecsChanged == true'. It will be true with sorting specs have changed since
  1983. // last call, or the first time.
  1984. // Lifetime: don't hold on this pointer over multiple frames or past any subsequent call to BeginTable()!
  1985. const ImGuiTableSortSpecs* ImGui::TableGetSortSpecs()
  1986. {
  1987. ImGuiContext& g = *GImGui;
  1988. ImGuiTable* table = g.CurrentTable;
  1989. IM_ASSERT(table != NULL);
  1990. if (!(table->Flags & ImGuiTableFlags_Sortable))
  1991. return NULL;
  1992. // Flatten sort specs into user facing data
  1993. const bool was_dirty = table->IsSortSpecsDirty;
  1994. if (was_dirty)
  1995. {
  1996. TableSortSpecsSanitize(table);
  1997. // Write output
  1998. table->SortSpecsData.resize(table->SortSpecsCount);
  1999. table->SortSpecs.ColumnsMask = 0x00;
  2000. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  2001. {
  2002. ImGuiTableColumn* column = &table->Columns[column_n];
  2003. if (column->SortOrder == -1)
  2004. continue;
  2005. ImGuiTableSortSpecsColumn* sort_spec = &table->SortSpecsData[column->SortOrder];
  2006. sort_spec->ColumnUserID = column->UserID;
  2007. sort_spec->ColumnIndex = (ImU8)column_n;
  2008. sort_spec->SortOrder = (ImU8)column->SortOrder;
  2009. sort_spec->SortDirection = column->SortDirection;
  2010. table->SortSpecs.ColumnsMask |= (ImU64)1 << column_n;
  2011. }
  2012. }
  2013. // User facing data
  2014. table->SortSpecs.Specs = table->SortSpecsData.Data;
  2015. table->SortSpecs.SpecsCount = table->SortSpecsData.Size;
  2016. table->SortSpecs.SpecsChanged = was_dirty;
  2017. table->IsSortSpecsDirty = false;
  2018. return table->SortSpecs.SpecsCount ? &table->SortSpecs : NULL;
  2019. }
  2020. bool ImGui::TableGetColumnIsSorted(int column_n)
  2021. {
  2022. ImGuiContext& g = *GImGui;
  2023. ImGuiTable* table = g.CurrentTable;
  2024. if (!table)
  2025. return false;
  2026. if (column_n < 0)
  2027. column_n = table->CurrentColumn;
  2028. ImGuiTableColumn* column = &table->Columns[column_n];
  2029. return (column->SortOrder != -1);
  2030. }
  2031. void ImGui::TableSortSpecsSanitize(ImGuiTable* table)
  2032. {
  2033. // Clear SortOrder from hidden column and verify that there's no gap or duplicate.
  2034. int sort_order_count = 0;
  2035. ImU64 sort_order_mask = 0x00;
  2036. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  2037. {
  2038. ImGuiTableColumn* column = &table->Columns[column_n];
  2039. if (column->SortOrder != -1 && !column->IsVisible)
  2040. column->SortOrder = -1;
  2041. if (column->SortOrder == -1)
  2042. continue;
  2043. sort_order_count++;
  2044. sort_order_mask |= ((ImU64)1 << column->SortOrder);
  2045. IM_ASSERT(sort_order_count < (int)sizeof(sort_order_mask) * 8);
  2046. }
  2047. const bool need_fix_linearize = ((ImU64)1 << sort_order_count) != (sort_order_mask + 1);
  2048. const bool need_fix_single_sort_order = (sort_order_count > 1) && !(table->Flags & ImGuiTableFlags_MultiSortable);
  2049. if (need_fix_linearize || need_fix_single_sort_order)
  2050. {
  2051. ImU64 fixed_mask = 0x00;
  2052. for (int sort_n = 0; sort_n < sort_order_count; sort_n++)
  2053. {
  2054. // Fix: Rewrite sort order fields if needed so they have no gap or duplicate.
  2055. // (e.g. SortOrder 0 disappeared, SortOrder 1..2 exists --> rewrite then as SortOrder 0..1)
  2056. int column_with_smallest_sort_order = -1;
  2057. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  2058. if ((fixed_mask & ((ImU64)1 << (ImU64)column_n)) == 0 && table->Columns[column_n].SortOrder != -1)
  2059. if (column_with_smallest_sort_order == -1 || table->Columns[column_n].SortOrder < table->Columns[column_with_smallest_sort_order].SortOrder)
  2060. column_with_smallest_sort_order = column_n;
  2061. IM_ASSERT(column_with_smallest_sort_order != -1);
  2062. fixed_mask |= ((ImU64)1 << column_with_smallest_sort_order);
  2063. table->Columns[column_with_smallest_sort_order].SortOrder = (ImS8)sort_n;
  2064. // Fix: Make sure only one column has a SortOrder if ImGuiTableFlags_MultiSortable is not set.
  2065. if (need_fix_single_sort_order)
  2066. {
  2067. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  2068. if (column_n != column_with_smallest_sort_order)
  2069. table->Columns[column_n].SortOrder = -1;
  2070. break;
  2071. }
  2072. }
  2073. }
  2074. // Fallback default sort order (if no column has the ImGuiTableColumnFlags_DefaultSort flag)
  2075. if (sort_order_count == 0 && table->IsInitializing)
  2076. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  2077. {
  2078. ImGuiTableColumn* column = &table->Columns[column_n];
  2079. if (!(column->Flags & ImGuiTableColumnFlags_NoSort) && column->IsVisible)
  2080. {
  2081. sort_order_count = 1;
  2082. column->SortOrder = 0;
  2083. break;
  2084. }
  2085. }
  2086. table->SortSpecsCount = (ImS8)sort_order_count;
  2087. }
  2088. //-------------------------------------------------------------------------
  2089. // TABLE - .ini settings
  2090. //-------------------------------------------------------------------------
  2091. // [Init] 1: TableSettingsHandler_ReadXXXX() Load and parse .ini file into TableSettings.
  2092. // [Main] 2: TableLoadSettings() When table is created, bind Table to TableSettings, serialize TableSettings data into Table.
  2093. // [Main] 3: TableSaveSettings() When table properties are modified, serialize Table data into bound or new TableSettings, mark .ini as dirty.
  2094. // [Main] 4: TableSettingsHandler_WriteAll() When .ini file is dirty (which can come from other source), save TableSettings into .ini file.
  2095. //-------------------------------------------------------------------------
  2096. // Clear and initialize empty settings instance
  2097. static void InitTableSettings(ImGuiTableSettings* settings, ImGuiID id, int columns_count, int columns_count_max)
  2098. {
  2099. IM_PLACEMENT_NEW(settings) ImGuiTableSettings();
  2100. ImGuiTableColumnSettings* settings_column = settings->GetColumnSettings();
  2101. for (int n = 0; n < columns_count_max; n++, settings_column++)
  2102. IM_PLACEMENT_NEW(settings_column) ImGuiTableColumnSettings();
  2103. settings->ID = id;
  2104. settings->ColumnsCount = (ImS8)columns_count;
  2105. settings->ColumnsCountMax = (ImS8)columns_count_max;
  2106. settings->WantApply = true;
  2107. }
  2108. static ImGuiTableSettings* CreateTableSettings(ImGuiID id, int columns_count)
  2109. {
  2110. ImGuiContext& g = *GImGui;
  2111. ImGuiTableSettings* settings = g.SettingsTables.alloc_chunk(sizeof(ImGuiTableSettings) + (size_t)columns_count * sizeof(ImGuiTableColumnSettings));
  2112. InitTableSettings(settings, id, columns_count, columns_count);
  2113. return settings;
  2114. }
  2115. // Find existing settings
  2116. static ImGuiTableSettings* FindTableSettingsByID(ImGuiID id)
  2117. {
  2118. // FIXME-OPT: Might want to store a lookup map for this?
  2119. ImGuiContext& g = *GImGui;
  2120. for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
  2121. if (settings->ID == id)
  2122. return settings;
  2123. return NULL;
  2124. }
  2125. // Get settings for a given table, NULL if none
  2126. ImGuiTableSettings* ImGui::TableGetBoundSettings(const ImGuiTable* table)
  2127. {
  2128. if (table->SettingsOffset != -1)
  2129. {
  2130. ImGuiContext& g = *GImGui;
  2131. ImGuiTableSettings* settings = g.SettingsTables.ptr_from_offset(table->SettingsOffset);
  2132. IM_ASSERT(settings->ID == table->ID);
  2133. if (settings->ColumnsCountMax >= table->ColumnsCount)
  2134. return settings; // OK
  2135. settings->ID = 0; // Invalidate storage, we won't fit because of a count change
  2136. }
  2137. return NULL;
  2138. }
  2139. void ImGui::TableSaveSettings(ImGuiTable* table)
  2140. {
  2141. table->IsSettingsDirty = false;
  2142. if (table->Flags & ImGuiTableFlags_NoSavedSettings)
  2143. return;
  2144. // Bind or create settings data
  2145. ImGuiContext& g = *GImGui;
  2146. ImGuiTableSettings* settings = TableGetBoundSettings(table);
  2147. if (settings == NULL)
  2148. {
  2149. settings = CreateTableSettings(table->ID, table->ColumnsCount);
  2150. table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings);
  2151. }
  2152. settings->ColumnsCount = (ImS8)table->ColumnsCount;
  2153. // Serialize ImGuiTable/ImGuiTableColumn into ImGuiTableSettings/ImGuiTableColumnSettings
  2154. IM_ASSERT(settings->ID == table->ID);
  2155. IM_ASSERT(settings->ColumnsCount == table->ColumnsCount && settings->ColumnsCountMax >= settings->ColumnsCount);
  2156. ImGuiTableColumn* column = table->Columns.Data;
  2157. ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings();
  2158. // FIXME-TABLE: Logic to avoid saving default widths?
  2159. bool save_ref_scale = false;
  2160. settings->SaveFlags = ImGuiTableFlags_Resizable;
  2161. for (int n = 0; n < table->ColumnsCount; n++, column++, column_settings++)
  2162. {
  2163. column_settings->WidthOrWeight = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? column->WidthStretchWeight : column->WidthRequest;
  2164. column_settings->Index = (ImS8)n;
  2165. column_settings->DisplayOrder = column->DisplayOrder;
  2166. column_settings->SortOrder = column->SortOrder;
  2167. column_settings->SortDirection = column->SortDirection;
  2168. column_settings->IsVisible = column->IsVisible;
  2169. column_settings->IsWeighted = (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? 1 : 0;
  2170. if ((column->Flags & ImGuiTableColumnFlags_WidthStretch) == 0)
  2171. save_ref_scale = true;
  2172. // We skip saving some data in the .ini file when they are unnecessary to restore our state
  2173. // FIXME-TABLE: We don't have logic to easily compare SortOrder to DefaultSortOrder yet so it's always saved when present.
  2174. if (column->DisplayOrder != n)
  2175. settings->SaveFlags |= ImGuiTableFlags_Reorderable;
  2176. if (column->SortOrder != -1)
  2177. settings->SaveFlags |= ImGuiTableFlags_Sortable;
  2178. if (column->IsVisible != ((column->Flags & ImGuiTableColumnFlags_DefaultHide) == 0))
  2179. settings->SaveFlags |= ImGuiTableFlags_Hideable;
  2180. }
  2181. settings->SaveFlags &= table->Flags;
  2182. settings->RefScale = save_ref_scale ? table->RefScale : 0.0f;
  2183. MarkIniSettingsDirty();
  2184. }
  2185. void ImGui::TableLoadSettings(ImGuiTable* table)
  2186. {
  2187. ImGuiContext& g = *GImGui;
  2188. table->IsSettingsRequestLoad = false;
  2189. if (table->Flags & ImGuiTableFlags_NoSavedSettings)
  2190. return;
  2191. // Bind settings
  2192. ImGuiTableSettings* settings;
  2193. if (table->SettingsOffset == -1)
  2194. {
  2195. settings = FindTableSettingsByID(table->ID);
  2196. if (settings == NULL)
  2197. return;
  2198. table->SettingsOffset = g.SettingsTables.offset_from_ptr(settings);
  2199. }
  2200. else
  2201. {
  2202. settings = TableGetBoundSettings(table);
  2203. }
  2204. table->SettingsLoadedFlags = settings->SaveFlags;
  2205. table->RefScale = settings->RefScale;
  2206. IM_ASSERT(settings->ColumnsCount == table->ColumnsCount);
  2207. // Serialize ImGuiTableSettings/ImGuiTableColumnSettings into ImGuiTable/ImGuiTableColumn
  2208. ImGuiTableColumnSettings* column_settings = settings->GetColumnSettings();
  2209. for (int data_n = 0; data_n < settings->ColumnsCount; data_n++, column_settings++)
  2210. {
  2211. int column_n = column_settings->Index;
  2212. if (column_n < 0 || column_n >= table->ColumnsCount)
  2213. continue;
  2214. ImGuiTableColumn* column = &table->Columns[column_n];
  2215. if (settings->SaveFlags & ImGuiTableFlags_Resizable)
  2216. {
  2217. if (column_settings->IsWeighted)
  2218. column->WidthStretchWeight = column_settings->WidthOrWeight;
  2219. else
  2220. column->WidthRequest = column_settings->WidthOrWeight;
  2221. column->AutoFitQueue = 0x00;
  2222. }
  2223. if (settings->SaveFlags & ImGuiTableFlags_Reorderable)
  2224. column->DisplayOrder = column_settings->DisplayOrder;
  2225. else
  2226. column->DisplayOrder = (ImS8)column_n;
  2227. column->IsVisible = column->IsVisibleNextFrame = column_settings->IsVisible;
  2228. column->SortOrder = column_settings->SortOrder;
  2229. column->SortDirection = column_settings->SortDirection;
  2230. }
  2231. // FIXME-TABLE: Need to validate .ini data
  2232. for (int column_n = 0; column_n < table->ColumnsCount; column_n++)
  2233. table->DisplayOrderToIndex[table->Columns[column_n].DisplayOrder] = (ImS8)column_n;
  2234. }
  2235. static void TableSettingsHandler_ClearAll(ImGuiContext* ctx, ImGuiSettingsHandler*)
  2236. {
  2237. ImGuiContext& g = *ctx;
  2238. for (int i = 0; i != g.Tables.GetSize(); i++)
  2239. g.Tables.GetByIndex(i)->SettingsOffset = -1;
  2240. g.SettingsTables.clear();
  2241. }
  2242. // Apply to existing windows (if any)
  2243. static void TableSettingsHandler_ApplyAll(ImGuiContext* ctx, ImGuiSettingsHandler*)
  2244. {
  2245. ImGuiContext& g = *ctx;
  2246. for (int i = 0; i != g.Tables.GetSize(); i++)
  2247. {
  2248. ImGuiTable* table = g.Tables.GetByIndex(i);
  2249. table->IsSettingsRequestLoad = true;
  2250. table->SettingsOffset = -1;
  2251. }
  2252. }
  2253. static void* TableSettingsHandler_ReadOpen(ImGuiContext*, ImGuiSettingsHandler*, const char* name)
  2254. {
  2255. ImGuiID id = 0;
  2256. int columns_count = 0;
  2257. if (sscanf(name, "0x%08X,%d", &id, &columns_count) < 2)
  2258. return NULL;
  2259. if (ImGuiTableSettings* settings = FindTableSettingsByID(id))
  2260. {
  2261. if (settings->ColumnsCountMax >= columns_count)
  2262. {
  2263. InitTableSettings(settings, id, columns_count, settings->ColumnsCountMax); // Recycle
  2264. return settings;
  2265. }
  2266. settings->ID = 0; // Invalidate storage if we won't fit because of a count change
  2267. }
  2268. return CreateTableSettings(id, columns_count);
  2269. }
  2270. static void TableSettingsHandler_ReadLine(ImGuiContext*, ImGuiSettingsHandler*, void* entry, const char* line)
  2271. {
  2272. // "Column 0 UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v"
  2273. ImGuiTableSettings* settings = (ImGuiTableSettings*)entry;
  2274. float f = 0.0f;
  2275. int column_n = 0, r = 0, n = 0;
  2276. if (sscanf(line, "RefScale=%f", &f) == 1) { settings->RefScale = f; return; }
  2277. if (sscanf(line, "Column %d%n", &column_n, &r) == 1)
  2278. {
  2279. if (column_n < 0 || column_n >= settings->ColumnsCount)
  2280. return;
  2281. line = ImStrSkipBlank(line + r);
  2282. char c = 0;
  2283. ImGuiTableColumnSettings* column = settings->GetColumnSettings() + column_n;
  2284. column->Index = (ImS8)column_n;
  2285. if (sscanf(line, "UserID=0x%08X%n", (ImU32*)&n, &r)==1) { line = ImStrSkipBlank(line + r); column->UserID = (ImGuiID)n; }
  2286. if (sscanf(line, "Width=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->WidthOrWeight = (float)n; column->IsWeighted = 0; settings->SaveFlags |= ImGuiTableFlags_Resizable; }
  2287. if (sscanf(line, "Weight=%f%n", &f, &r) == 1) { line = ImStrSkipBlank(line + r); column->WidthOrWeight = f; column->IsWeighted = 1; settings->SaveFlags |= ImGuiTableFlags_Resizable; }
  2288. if (sscanf(line, "Visible=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->IsVisible = (ImU8)n; settings->SaveFlags |= ImGuiTableFlags_Hideable; }
  2289. if (sscanf(line, "Order=%d%n", &n, &r) == 1) { line = ImStrSkipBlank(line + r); column->DisplayOrder = (ImS8)n; settings->SaveFlags |= ImGuiTableFlags_Reorderable; }
  2290. if (sscanf(line, "Sort=%d%c%n", &n, &c, &r) == 2) { line = ImStrSkipBlank(line + r); column->SortOrder = (ImS8)n; column->SortDirection = (c == '^') ? ImGuiSortDirection_Descending : ImGuiSortDirection_Ascending; settings->SaveFlags |= ImGuiTableFlags_Sortable; }
  2291. }
  2292. }
  2293. static void TableSettingsHandler_WriteAll(ImGuiContext* ctx, ImGuiSettingsHandler* handler, ImGuiTextBuffer* buf)
  2294. {
  2295. ImGuiContext& g = *ctx;
  2296. for (ImGuiTableSettings* settings = g.SettingsTables.begin(); settings != NULL; settings = g.SettingsTables.next_chunk(settings))
  2297. {
  2298. if (settings->ID == 0) // Skip ditched settings
  2299. continue;
  2300. // TableSaveSettings() may clear some of those flags when we establish that the data can be stripped
  2301. // (e.g. Order was unchanged)
  2302. const bool save_size = (settings->SaveFlags & ImGuiTableFlags_Resizable) != 0;
  2303. const bool save_visible = (settings->SaveFlags & ImGuiTableFlags_Hideable) != 0;
  2304. const bool save_order = (settings->SaveFlags & ImGuiTableFlags_Reorderable) != 0;
  2305. const bool save_sort = (settings->SaveFlags & ImGuiTableFlags_Sortable) != 0;
  2306. if (!save_size && !save_visible && !save_order && !save_sort)
  2307. continue;
  2308. buf->reserve(buf->size() + 30 + settings->ColumnsCount * 50); // ballpark reserve
  2309. buf->appendf("[%s][0x%08X,%d]\n", handler->TypeName, settings->ID, settings->ColumnsCount);
  2310. if (settings->RefScale != 0.0f)
  2311. buf->appendf("RefScale=%g\n", settings->RefScale);
  2312. ImGuiTableColumnSettings* column = settings->GetColumnSettings();
  2313. for (int column_n = 0; column_n < settings->ColumnsCount; column_n++, column++)
  2314. {
  2315. // "Column 0 UserID=0x42AD2D21 Width=100 Visible=1 Order=0 Sort=0v"
  2316. buf->appendf("Column %-2d", column_n);
  2317. if (column->UserID != 0) buf->appendf(" UserID=%08X", column->UserID);
  2318. if (save_size && column->IsWeighted) buf->appendf(" Weight=%.4f", column->WidthOrWeight);
  2319. if (save_size && !column->IsWeighted) buf->appendf(" Width=%d", (int)column->WidthOrWeight);
  2320. if (save_visible) buf->appendf(" Visible=%d", column->IsVisible);
  2321. if (save_order) buf->appendf(" Order=%d", column->DisplayOrder);
  2322. if (save_sort && column->SortOrder != -1) buf->appendf(" Sort=%d%c", column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? 'v' : '^');
  2323. buf->append("\n");
  2324. }
  2325. buf->append("\n");
  2326. }
  2327. }
  2328. void ImGui::TableInstallSettingsHandler(ImGuiContext* context)
  2329. {
  2330. ImGuiContext& g = *context;
  2331. ImGuiSettingsHandler ini_handler;
  2332. ini_handler.TypeName = "Table";
  2333. ini_handler.TypeHash = ImHashStr("Table");
  2334. ini_handler.ClearAllFn = TableSettingsHandler_ClearAll;
  2335. ini_handler.ReadOpenFn = TableSettingsHandler_ReadOpen;
  2336. ini_handler.ReadLineFn = TableSettingsHandler_ReadLine;
  2337. ini_handler.ApplyAllFn = TableSettingsHandler_ApplyAll;
  2338. ini_handler.WriteAllFn = TableSettingsHandler_WriteAll;
  2339. g.SettingsHandlers.push_back(ini_handler);
  2340. }
  2341. //-------------------------------------------------------------------------
  2342. // TABLE - Debugging
  2343. //-------------------------------------------------------------------------
  2344. // - DebugNodeTable() [Internal]
  2345. //-------------------------------------------------------------------------
  2346. #ifndef IMGUI_DISABLE_METRICS_WINDOW
  2347. void ImGui::DebugNodeTable(ImGuiTable* table)
  2348. {
  2349. char buf[256];
  2350. char* p = buf;
  2351. const char* buf_end = buf + IM_ARRAYSIZE(buf);
  2352. ImFormatString(p, buf_end - p, "Table 0x%08X (%d columns, in '%s')", table->ID, table->ColumnsCount, table->OuterWindow->Name);
  2353. bool open = TreeNode(table, "%s", buf);
  2354. if (IsItemHovered())
  2355. GetForegroundDrawList()->AddRect(table->OuterRect.Min, table->OuterRect.Max, IM_COL32(255, 255, 0, 255));
  2356. if (!open)
  2357. return;
  2358. BulletText("OuterWidth: %.1f, InnerWidth: %.1f%s, ColumnsWidth: %.1f, AutoFitWidth: %.1f", table->OuterRect.GetWidth(), table->InnerWidth, table->InnerWidth == 0.0f ? " (auto)" : "", table->ColumnsTotalWidth, table->ColumnsAutoFitWidth);
  2359. for (int n = 0; n < table->ColumnsCount; n++)
  2360. {
  2361. ImGuiTableColumn* column = &table->Columns[n];
  2362. const char* name = TableGetColumnName(table, n);
  2363. BulletText("Column %d order %d name '%s': +%.1f to +%.1f\n"
  2364. "Visible: %d, Clipped: %d, DrawChannels: %d,%d\n"
  2365. "WidthGiven/Request: %.2f/%.2f, WidthWeight: %.3f\n"
  2366. "ContentWidth: RowsFrozen %d, RowsUnfrozen %d, HeadersUsed/Ideal %d/%d\n"
  2367. "SortOrder: %d, SortDir: %s\n"
  2368. "UserID: 0x%08X, Flags: 0x%04X: %s%s%s%s..",
  2369. n, column->DisplayOrder, name ? name : "NULL", column->MinX - table->WorkRect.Min.x, column->MaxX - table->WorkRect.Min.x,
  2370. column->IsVisible, column->IsClipped, column->DrawChannelRowsBeforeFreeze, column->DrawChannelRowsAfterFreeze,
  2371. column->WidthGiven, column->WidthRequest, column->WidthStretchWeight,
  2372. column->ContentWidthRowsFrozen, column->ContentWidthRowsUnfrozen, column->ContentWidthHeadersUsed, column->ContentWidthHeadersIdeal,
  2373. column->SortOrder, (column->SortDirection == ImGuiSortDirection_Ascending) ? "Ascending" : (column->SortDirection == ImGuiSortDirection_Descending) ? "Descending" : "None",
  2374. column->UserID, column->Flags,
  2375. (column->Flags & ImGuiTableColumnFlags_WidthFixed) ? "WidthFixed " : "",
  2376. (column->Flags & ImGuiTableColumnFlags_WidthStretch) ? "WidthStretch " : "",
  2377. (column->Flags & ImGuiTableColumnFlags_WidthAlwaysAutoResize) ? "WidthAlwaysAutoResize " : "",
  2378. (column->Flags & ImGuiTableColumnFlags_NoResize) ? "NoResize " : "");
  2379. }
  2380. if (ImGuiTableSettings* settings = TableGetBoundSettings(table))
  2381. DebugNodeTableSettings(settings);
  2382. TreePop();
  2383. }
  2384. void ImGui::DebugNodeTableSettings(ImGuiTableSettings* settings)
  2385. {
  2386. if (!TreeNode((void*)(intptr_t)settings->ID, "Settings 0x%08X (%d columns)", settings->ID, settings->ColumnsCount))
  2387. return;
  2388. BulletText("SaveFlags: 0x%08X", settings->SaveFlags);
  2389. BulletText("ColumnsCount: %d (max %d)", settings->ColumnsCount, settings->ColumnsCountMax);
  2390. for (int n = 0; n < settings->ColumnsCount; n++)
  2391. {
  2392. ImGuiTableColumnSettings* column_settings = &settings->GetColumnSettings()[n];
  2393. ImGuiSortDirection sort_dir = (column_settings->SortOrder != -1) ? (ImGuiSortDirection)column_settings->SortDirection : ImGuiSortDirection_None;
  2394. BulletText("Column %d Order %d SortOrder %d %s Visible %d UserID 0x%08X WidthOrWeight %.3f",
  2395. n, column_settings->DisplayOrder, column_settings->SortOrder,
  2396. (sort_dir == ImGuiSortDirection_Ascending) ? "Asc" : (sort_dir == ImGuiSortDirection_Descending) ? "Des" : "---",
  2397. column_settings->IsVisible, column_settings->UserID, column_settings->WidthOrWeight);
  2398. }
  2399. TreePop();
  2400. }
  2401. #endif // #ifndef IMGUI_DISABLE_METRICS_WINDOW
  2402. //-------------------------------------------------------------------------
  2403. //-------------------------------------------------------------------------
  2404. // [SECTION] Widgets: Columns, BeginColumns, EndColumns, etc.
  2405. // (This is a legacy API, prefer using BeginTable/EndTable!)
  2406. //-------------------------------------------------------------------------
  2407. // - SetWindowClipRectBeforeSetChannel() [Internal]
  2408. // - GetColumnIndex()
  2409. // - GetColumnsCount()
  2410. // - GetColumnOffset()
  2411. // - GetColumnWidth()
  2412. // - SetColumnOffset()
  2413. // - SetColumnWidth()
  2414. // - PushColumnClipRect() [Internal]
  2415. // - PushColumnsBackground() [Internal]
  2416. // - PopColumnsBackground() [Internal]
  2417. // - FindOrCreateColumns() [Internal]
  2418. // - GetColumnsID() [Internal]
  2419. // - BeginColumns()
  2420. // - NextColumn()
  2421. // - EndColumns()
  2422. // - Columns()
  2423. //-------------------------------------------------------------------------
  2424. // [Internal] Small optimization to avoid calls to PopClipRect/SetCurrentChannel/PushClipRect in sequences,
  2425. // they would meddle many times with the underlying ImDrawCmd.
  2426. // Instead, we do a preemptive overwrite of clipping rectangle _without_ altering the command-buffer and let
  2427. // the subsequent single call to SetCurrentChannel() does it things once.
  2428. void ImGui::SetWindowClipRectBeforeSetChannel(ImGuiWindow* window, const ImRect& clip_rect)
  2429. {
  2430. ImVec4 clip_rect_vec4 = clip_rect.ToVec4();
  2431. window->ClipRect = clip_rect;
  2432. window->DrawList->_CmdHeader.ClipRect = clip_rect_vec4;
  2433. window->DrawList->_ClipRectStack.Data[window->DrawList->_ClipRectStack.Size - 1] = clip_rect_vec4;
  2434. }
  2435. int ImGui::GetColumnIndex()
  2436. {
  2437. ImGuiWindow* window = GetCurrentWindowRead();
  2438. return window->DC.CurrentColumns ? window->DC.CurrentColumns->Current : 0;
  2439. }
  2440. int ImGui::GetColumnsCount()
  2441. {
  2442. ImGuiWindow* window = GetCurrentWindowRead();
  2443. return window->DC.CurrentColumns ? window->DC.CurrentColumns->Count : 1;
  2444. }
  2445. float ImGui::GetColumnOffsetFromNorm(const ImGuiOldColumns* columns, float offset_norm)
  2446. {
  2447. return offset_norm * (columns->OffMaxX - columns->OffMinX);
  2448. }
  2449. float ImGui::GetColumnNormFromOffset(const ImGuiOldColumns* columns, float offset)
  2450. {
  2451. return offset / (columns->OffMaxX - columns->OffMinX);
  2452. }
  2453. static const float COLUMNS_HIT_RECT_HALF_WIDTH = 4.0f;
  2454. static float GetDraggedColumnOffset(ImGuiOldColumns* columns, int column_index)
  2455. {
  2456. // Active (dragged) column always follow mouse. The reason we need this is that dragging a column to the right edge of an auto-resizing
  2457. // window creates a feedback loop because we store normalized positions. So while dragging we enforce absolute positioning.
  2458. ImGuiContext& g = *GImGui;
  2459. ImGuiWindow* window = g.CurrentWindow;
  2460. IM_ASSERT(column_index > 0); // We are not supposed to drag column 0.
  2461. IM_ASSERT(g.ActiveId == columns->ID + ImGuiID(column_index));
  2462. float x = g.IO.MousePos.x - g.ActiveIdClickOffset.x + COLUMNS_HIT_RECT_HALF_WIDTH - window->Pos.x;
  2463. x = ImMax(x, ImGui::GetColumnOffset(column_index - 1) + g.Style.ColumnsMinSpacing);
  2464. if ((columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths))
  2465. x = ImMin(x, ImGui::GetColumnOffset(column_index + 1) - g.Style.ColumnsMinSpacing);
  2466. return x;
  2467. }
  2468. float ImGui::GetColumnOffset(int column_index)
  2469. {
  2470. ImGuiWindow* window = GetCurrentWindowRead();
  2471. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2472. if (columns == NULL)
  2473. return 0.0f;
  2474. if (column_index < 0)
  2475. column_index = columns->Current;
  2476. IM_ASSERT(column_index < columns->Columns.Size);
  2477. const float t = columns->Columns[column_index].OffsetNorm;
  2478. const float x_offset = ImLerp(columns->OffMinX, columns->OffMaxX, t);
  2479. return x_offset;
  2480. }
  2481. static float GetColumnWidthEx(ImGuiOldColumns* columns, int column_index, bool before_resize = false)
  2482. {
  2483. if (column_index < 0)
  2484. column_index = columns->Current;
  2485. float offset_norm;
  2486. if (before_resize)
  2487. offset_norm = columns->Columns[column_index + 1].OffsetNormBeforeResize - columns->Columns[column_index].OffsetNormBeforeResize;
  2488. else
  2489. offset_norm = columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm;
  2490. return ImGui::GetColumnOffsetFromNorm(columns, offset_norm);
  2491. }
  2492. float ImGui::GetColumnWidth(int column_index)
  2493. {
  2494. ImGuiContext& g = *GImGui;
  2495. ImGuiWindow* window = g.CurrentWindow;
  2496. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2497. if (columns == NULL)
  2498. return GetContentRegionAvail().x;
  2499. if (column_index < 0)
  2500. column_index = columns->Current;
  2501. return GetColumnOffsetFromNorm(columns, columns->Columns[column_index + 1].OffsetNorm - columns->Columns[column_index].OffsetNorm);
  2502. }
  2503. void ImGui::SetColumnOffset(int column_index, float offset)
  2504. {
  2505. ImGuiContext& g = *GImGui;
  2506. ImGuiWindow* window = g.CurrentWindow;
  2507. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2508. IM_ASSERT(columns != NULL);
  2509. if (column_index < 0)
  2510. column_index = columns->Current;
  2511. IM_ASSERT(column_index < columns->Columns.Size);
  2512. const bool preserve_width = !(columns->Flags & ImGuiOldColumnFlags_NoPreserveWidths) && (column_index < columns->Count - 1);
  2513. const float width = preserve_width ? GetColumnWidthEx(columns, column_index, columns->IsBeingResized) : 0.0f;
  2514. if (!(columns->Flags & ImGuiOldColumnFlags_NoForceWithinWindow))
  2515. offset = ImMin(offset, columns->OffMaxX - g.Style.ColumnsMinSpacing * (columns->Count - column_index));
  2516. columns->Columns[column_index].OffsetNorm = GetColumnNormFromOffset(columns, offset - columns->OffMinX);
  2517. if (preserve_width)
  2518. SetColumnOffset(column_index + 1, offset + ImMax(g.Style.ColumnsMinSpacing, width));
  2519. }
  2520. void ImGui::SetColumnWidth(int column_index, float width)
  2521. {
  2522. ImGuiWindow* window = GetCurrentWindowRead();
  2523. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2524. IM_ASSERT(columns != NULL);
  2525. if (column_index < 0)
  2526. column_index = columns->Current;
  2527. SetColumnOffset(column_index + 1, GetColumnOffset(column_index) + width);
  2528. }
  2529. void ImGui::PushColumnClipRect(int column_index)
  2530. {
  2531. ImGuiWindow* window = GetCurrentWindowRead();
  2532. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2533. if (column_index < 0)
  2534. column_index = columns->Current;
  2535. ImGuiOldColumnData* column = &columns->Columns[column_index];
  2536. PushClipRect(column->ClipRect.Min, column->ClipRect.Max, false);
  2537. }
  2538. // Get into the columns background draw command (which is generally the same draw command as before we called BeginColumns)
  2539. void ImGui::PushColumnsBackground()
  2540. {
  2541. ImGuiWindow* window = GetCurrentWindowRead();
  2542. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2543. if (columns->Count == 1)
  2544. return;
  2545. // Optimization: avoid SetCurrentChannel() + PushClipRect()
  2546. columns->HostBackupClipRect = window->ClipRect;
  2547. SetWindowClipRectBeforeSetChannel(window, columns->HostInitialClipRect);
  2548. columns->Splitter.SetCurrentChannel(window->DrawList, 0);
  2549. }
  2550. void ImGui::PopColumnsBackground()
  2551. {
  2552. ImGuiWindow* window = GetCurrentWindowRead();
  2553. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2554. if (columns->Count == 1)
  2555. return;
  2556. // Optimization: avoid PopClipRect() + SetCurrentChannel()
  2557. SetWindowClipRectBeforeSetChannel(window, columns->HostBackupClipRect);
  2558. columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1);
  2559. }
  2560. ImGuiOldColumns* ImGui::FindOrCreateColumns(ImGuiWindow* window, ImGuiID id)
  2561. {
  2562. // We have few columns per window so for now we don't need bother much with turning this into a faster lookup.
  2563. for (int n = 0; n < window->ColumnsStorage.Size; n++)
  2564. if (window->ColumnsStorage[n].ID == id)
  2565. return &window->ColumnsStorage[n];
  2566. window->ColumnsStorage.push_back(ImGuiOldColumns());
  2567. ImGuiOldColumns* columns = &window->ColumnsStorage.back();
  2568. columns->ID = id;
  2569. return columns;
  2570. }
  2571. ImGuiID ImGui::GetColumnsID(const char* str_id, int columns_count)
  2572. {
  2573. ImGuiWindow* window = GetCurrentWindow();
  2574. // Differentiate column ID with an arbitrary prefix for cases where users name their columns set the same as another widget.
  2575. // In addition, when an identifier isn't explicitly provided we include the number of columns in the hash to make it uniquer.
  2576. PushID(0x11223347 + (str_id ? 0 : columns_count));
  2577. ImGuiID id = window->GetID(str_id ? str_id : "columns");
  2578. PopID();
  2579. return id;
  2580. }
  2581. void ImGui::BeginColumns(const char* str_id, int columns_count, ImGuiOldColumnFlags flags)
  2582. {
  2583. ImGuiContext& g = *GImGui;
  2584. ImGuiWindow* window = GetCurrentWindow();
  2585. IM_ASSERT(columns_count >= 1);
  2586. IM_ASSERT(window->DC.CurrentColumns == NULL); // Nested columns are currently not supported
  2587. // Acquire storage for the columns set
  2588. ImGuiID id = GetColumnsID(str_id, columns_count);
  2589. ImGuiOldColumns* columns = FindOrCreateColumns(window, id);
  2590. IM_ASSERT(columns->ID == id);
  2591. columns->Current = 0;
  2592. columns->Count = columns_count;
  2593. columns->Flags = flags;
  2594. window->DC.CurrentColumns = columns;
  2595. columns->HostCursorPosY = window->DC.CursorPos.y;
  2596. columns->HostCursorMaxPosX = window->DC.CursorMaxPos.x;
  2597. columns->HostInitialClipRect = window->ClipRect;
  2598. columns->HostBackupParentWorkRect = window->ParentWorkRect;
  2599. window->ParentWorkRect = window->WorkRect;
  2600. // Set state for first column
  2601. // We aim so that the right-most column will have the same clipping width as other after being clipped by parent ClipRect
  2602. const float column_padding = g.Style.ItemSpacing.x;
  2603. const float half_clip_extend_x = ImFloor(ImMax(window->WindowPadding.x * 0.5f, window->WindowBorderSize));
  2604. const float max_1 = window->WorkRect.Max.x + column_padding - ImMax(column_padding - window->WindowPadding.x, 0.0f);
  2605. const float max_2 = window->WorkRect.Max.x + half_clip_extend_x;
  2606. columns->OffMinX = window->DC.Indent.x - column_padding + ImMax(column_padding - window->WindowPadding.x, 0.0f);
  2607. columns->OffMaxX = ImMax(ImMin(max_1, max_2) - window->Pos.x, columns->OffMinX + 1.0f);
  2608. columns->LineMinY = columns->LineMaxY = window->DC.CursorPos.y;
  2609. // Clear data if columns count changed
  2610. if (columns->Columns.Size != 0 && columns->Columns.Size != columns_count + 1)
  2611. columns->Columns.resize(0);
  2612. // Initialize default widths
  2613. columns->IsFirstFrame = (columns->Columns.Size == 0);
  2614. if (columns->Columns.Size == 0)
  2615. {
  2616. columns->Columns.reserve(columns_count + 1);
  2617. for (int n = 0; n < columns_count + 1; n++)
  2618. {
  2619. ImGuiOldColumnData column;
  2620. column.OffsetNorm = n / (float)columns_count;
  2621. columns->Columns.push_back(column);
  2622. }
  2623. }
  2624. for (int n = 0; n < columns_count; n++)
  2625. {
  2626. // Compute clipping rectangle
  2627. ImGuiOldColumnData* column = &columns->Columns[n];
  2628. float clip_x1 = IM_ROUND(window->Pos.x + GetColumnOffset(n));
  2629. float clip_x2 = IM_ROUND(window->Pos.x + GetColumnOffset(n + 1) - 1.0f);
  2630. column->ClipRect = ImRect(clip_x1, -FLT_MAX, clip_x2, +FLT_MAX);
  2631. column->ClipRect.ClipWithFull(window->ClipRect);
  2632. }
  2633. if (columns->Count > 1)
  2634. {
  2635. columns->Splitter.Split(window->DrawList, 1 + columns->Count);
  2636. columns->Splitter.SetCurrentChannel(window->DrawList, 1);
  2637. PushColumnClipRect(0);
  2638. }
  2639. // We don't generally store Indent.x inside ColumnsOffset because it may be manipulated by the user.
  2640. float offset_0 = GetColumnOffset(columns->Current);
  2641. float offset_1 = GetColumnOffset(columns->Current + 1);
  2642. float width = offset_1 - offset_0;
  2643. PushItemWidth(width * 0.65f);
  2644. window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f);
  2645. window->DC.CursorPos.x = IM_FLOOR(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
  2646. window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding;
  2647. }
  2648. void ImGui::NextColumn()
  2649. {
  2650. ImGuiWindow* window = GetCurrentWindow();
  2651. if (window->SkipItems || window->DC.CurrentColumns == NULL)
  2652. return;
  2653. ImGuiContext& g = *GImGui;
  2654. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2655. if (columns->Count == 1)
  2656. {
  2657. window->DC.CursorPos.x = IM_FLOOR(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
  2658. IM_ASSERT(columns->Current == 0);
  2659. return;
  2660. }
  2661. // Next column
  2662. if (++columns->Current == columns->Count)
  2663. columns->Current = 0;
  2664. PopItemWidth();
  2665. // Optimization: avoid PopClipRect() + SetCurrentChannel() + PushClipRect()
  2666. // (which would needlessly attempt to update commands in the wrong channel, then pop or overwrite them),
  2667. ImGuiOldColumnData* column = &columns->Columns[columns->Current];
  2668. SetWindowClipRectBeforeSetChannel(window, column->ClipRect);
  2669. columns->Splitter.SetCurrentChannel(window->DrawList, columns->Current + 1);
  2670. const float column_padding = g.Style.ItemSpacing.x;
  2671. columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y);
  2672. if (columns->Current > 0)
  2673. {
  2674. // Columns 1+ ignore IndentX (by canceling it out)
  2675. // FIXME-COLUMNS: Unnecessary, could be locked?
  2676. window->DC.ColumnsOffset.x = GetColumnOffset(columns->Current) - window->DC.Indent.x + column_padding;
  2677. }
  2678. else
  2679. {
  2680. // New row/line: column 0 honor IndentX.
  2681. window->DC.ColumnsOffset.x = ImMax(column_padding - window->WindowPadding.x, 0.0f);
  2682. columns->LineMinY = columns->LineMaxY;
  2683. }
  2684. window->DC.CursorPos.x = IM_FLOOR(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
  2685. window->DC.CursorPos.y = columns->LineMinY;
  2686. window->DC.CurrLineSize = ImVec2(0.0f, 0.0f);
  2687. window->DC.CurrLineTextBaseOffset = 0.0f;
  2688. // FIXME-COLUMNS: Share code with BeginColumns() - move code on columns setup.
  2689. float offset_0 = GetColumnOffset(columns->Current);
  2690. float offset_1 = GetColumnOffset(columns->Current + 1);
  2691. float width = offset_1 - offset_0;
  2692. PushItemWidth(width * 0.65f);
  2693. window->WorkRect.Max.x = window->Pos.x + offset_1 - column_padding;
  2694. }
  2695. void ImGui::EndColumns()
  2696. {
  2697. ImGuiContext& g = *GImGui;
  2698. ImGuiWindow* window = GetCurrentWindow();
  2699. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2700. IM_ASSERT(columns != NULL);
  2701. PopItemWidth();
  2702. if (columns->Count > 1)
  2703. {
  2704. PopClipRect();
  2705. columns->Splitter.Merge(window->DrawList);
  2706. }
  2707. const ImGuiOldColumnFlags flags = columns->Flags;
  2708. columns->LineMaxY = ImMax(columns->LineMaxY, window->DC.CursorPos.y);
  2709. window->DC.CursorPos.y = columns->LineMaxY;
  2710. if (!(flags & ImGuiOldColumnFlags_GrowParentContentsSize))
  2711. window->DC.CursorMaxPos.x = columns->HostCursorMaxPosX; // Restore cursor max pos, as columns don't grow parent
  2712. // Draw columns borders and handle resize
  2713. // The IsBeingResized flag ensure we preserve pre-resize columns width so back-and-forth are not lossy
  2714. bool is_being_resized = false;
  2715. if (!(flags & ImGuiOldColumnFlags_NoBorder) && !window->SkipItems)
  2716. {
  2717. // We clip Y boundaries CPU side because very long triangles are mishandled by some GPU drivers.
  2718. const float y1 = ImMax(columns->HostCursorPosY, window->ClipRect.Min.y);
  2719. const float y2 = ImMin(window->DC.CursorPos.y, window->ClipRect.Max.y);
  2720. int dragging_column = -1;
  2721. for (int n = 1; n < columns->Count; n++)
  2722. {
  2723. ImGuiOldColumnData* column = &columns->Columns[n];
  2724. float x = window->Pos.x + GetColumnOffset(n);
  2725. const ImGuiID column_id = columns->ID + ImGuiID(n);
  2726. const float column_hit_hw = COLUMNS_HIT_RECT_HALF_WIDTH;
  2727. const ImRect column_hit_rect(ImVec2(x - column_hit_hw, y1), ImVec2(x + column_hit_hw, y2));
  2728. KeepAliveID(column_id);
  2729. if (IsClippedEx(column_hit_rect, column_id, false))
  2730. continue;
  2731. bool hovered = false, held = false;
  2732. if (!(flags & ImGuiOldColumnFlags_NoResize))
  2733. {
  2734. ButtonBehavior(column_hit_rect, column_id, &hovered, &held);
  2735. if (hovered || held)
  2736. g.MouseCursor = ImGuiMouseCursor_ResizeEW;
  2737. if (held && !(column->Flags & ImGuiOldColumnFlags_NoResize))
  2738. dragging_column = n;
  2739. }
  2740. // Draw column
  2741. const ImU32 col = GetColorU32(held ? ImGuiCol_SeparatorActive : hovered ? ImGuiCol_SeparatorHovered : ImGuiCol_Separator);
  2742. const float xi = IM_FLOOR(x);
  2743. window->DrawList->AddLine(ImVec2(xi, y1 + 1.0f), ImVec2(xi, y2), col);
  2744. }
  2745. // Apply dragging after drawing the column lines, so our rendered lines are in sync with how items were displayed during the frame.
  2746. if (dragging_column != -1)
  2747. {
  2748. if (!columns->IsBeingResized)
  2749. for (int n = 0; n < columns->Count + 1; n++)
  2750. columns->Columns[n].OffsetNormBeforeResize = columns->Columns[n].OffsetNorm;
  2751. columns->IsBeingResized = is_being_resized = true;
  2752. float x = GetDraggedColumnOffset(columns, dragging_column);
  2753. SetColumnOffset(dragging_column, x);
  2754. }
  2755. }
  2756. columns->IsBeingResized = is_being_resized;
  2757. window->WorkRect = window->ParentWorkRect;
  2758. window->ParentWorkRect = columns->HostBackupParentWorkRect;
  2759. window->DC.CurrentColumns = NULL;
  2760. window->DC.ColumnsOffset.x = 0.0f;
  2761. window->DC.CursorPos.x = IM_FLOOR(window->Pos.x + window->DC.Indent.x + window->DC.ColumnsOffset.x);
  2762. }
  2763. void ImGui::Columns(int columns_count, const char* id, bool border)
  2764. {
  2765. ImGuiWindow* window = GetCurrentWindow();
  2766. IM_ASSERT(columns_count >= 1);
  2767. ImGuiOldColumnFlags flags = (border ? 0 : ImGuiOldColumnFlags_NoBorder);
  2768. //flags |= ImGuiOldColumnFlags_NoPreserveWidths; // NB: Legacy behavior
  2769. ImGuiOldColumns* columns = window->DC.CurrentColumns;
  2770. if (columns != NULL && columns->Count == columns_count && columns->Flags == flags)
  2771. return;
  2772. if (columns != NULL)
  2773. EndColumns();
  2774. if (columns_count != 1)
  2775. BeginColumns(id, columns_count, flags);
  2776. }
  2777. //-------------------------------------------------------------------------
  2778. #endif // #ifndef IMGUI_DISABLE