Untitled conversation
- User
-- https://gist.github.com/thennequin/64b4b996ec990c6ddc13a48c6a0ba68c -- ported to Lua by FYP local imgui = require 'imgui' local vmajor, vminor, vpatch = string.match(imgui._VERSION, '(%d+)%.(%d+)%.(%d+)') assert(tonumber(vmajor) == 1 and (tonumber(vminor) > 1 or (tonumber(vminor) == 1 and tonumber(vpatch) >= 3)), 'ImGui Pie requires Moon ImGui v1.1.4 or greater') local ImVec2 = imgui.ImVec2 local ImVec4 = imgui.ImVec4 local ImColor = imgui.ImColor local function ImRectAdd(rect, rhs) local Min, Max = rect.Min, rect.Max if Min.x > rhs.x then Min.x = rhs.x end if Min.y > rhs.y then Min.y = rhs.y end if Max.x < rhs.x then Max.x = rhs.x end if Max.y < rhs.y then Max.y = rhs.y end end local function NewPieMenu(context) local obj = { m_iCurrentIndex = 0, m_fMaxItemSqrDiameter = 0, m_fLastMaxItemSqrDiameter = 0, m_iHoveredItem = 0, m_iLastHoveredItem = 0, m_iClickedItem = 0, m_oItemIsSubMenu = {}, -- [c_iMaxPieItemCount] m_oItemNames = {}, -- [c_iMaxPieItemCount] m_oItemSizes = {}, -- [c_iMaxPieItemCount] } return obj end local function NewPieMenuContext(MaxPieMenuStack, MaxPieItemCount, RadiusEmpty, RadiusMin, MinItemCount, MinItemCountPerLevel) local obj = { c_iMaxPieMenuStack = MaxPieMenuStack or 8, c_iMaxPieItemCount = MaxPieItemCount or 12, c_iRadiusEmpty = RadiusEmpty or 30, c_iRadiusMin = RadiusMin or 30, c_iMinItemCount = MinItemCount or 3, c_iMinItemCountPerLevel = MinItemCountPerLevel or 3, m_oPieMenuStack = {}, m_iCurrentIndex = -1, m_iLastFrame = 0, m_iMaxIndex = 0, m_oCenter = ImVec2(0, 0), m_iMouseButton = 0, m_bClose = false, } for i = 0, obj.c_iMaxPieMenuStack - 1 do obj.m_oPieMenuStack[i] = NewPieMenu(obj) end return obj end --local menuCtx = NewPieMenuContext() local function BeginPieMenuEx(menuCtx) assert(menuCtx.m_iCurrentIndex < menuCtx.c_iMaxPieMenuStack) menuCtx.m_iCurrentIndex = menuCtx.m_iCurrentIndex + 1 menuCtx.m_iMaxIndex = menuCtx.m_iMaxIndex + 1 local oPieMenu = menuCtx.m_oPieMenuStack[menuCtx.m_iCurrentIndex] oPieMenu.m_iCurrentIndex = 0 oPieMenu.m_fMaxItemSqrDiameter = 0 if not imgui.IsMouseReleased( menuCtx.m_iMouseButton ) then oPieMenu.m_iHoveredItem = -1 end if menuCtx.m_iCurrentIndex > 0 then oPieMenu.m_fMaxItemSqrDiameter = menuCtx.m_oPieMenuStack[menuCtx.m_iCurrentIndex - 1].m_fMaxItemSqrDiameter end end local function EndPieMenuEx(menuCtx) assert(menuCtx.m_iCurrentIndex >= 0) local oPieMenu = menuCtx.m_oPieMenuStack[menuCtx.m_iCurrentIndex] menuCtx.m_iCurrentIndex = menuCtx.m_iCurrentIndex - 1 end local function BeginPiePopup(menuCtx, pName, iMouseButton) iMouseButton = iMouseButton or 0 if imgui.IsPopupOpen(pName) then imgui.PushStyleColor(imgui.Col.WindowBg, ImVec4(0, 0, 0, 0)) imgui.PushStyleColor(imgui.Col.Border, ImVec4(0, 0, 0, 0)) imgui.PushStyleVar(imgui.StyleVar.WindowRounding, 0.0) imgui.PushStyleVar(imgui.StyleVar.Alpha, 1.0) menuCtx.m_iMouseButton = iMouseButton menuCtx.m_bClose = false imgui.SetNextWindowPos( ImVec2( -100, -100 ), imgui.Cond.Appearing ) imgui.SetNextWindowSize(ImVec2(0, 0), imgui.Cond.Always) local bOpened = imgui.BeginPopup(pName) if bOpened then local iCurrentFrame = imgui.GetFrameCount() if menuCtx.m_iLastFrame < (iCurrentFrame - 1) then menuCtx.m_oCenter = ImVec2(imgui.GetIO().MousePos) end menuCtx.m_iLastFrame = iCurrentFrame menuCtx.m_iMaxIndex = -1 BeginPieMenuEx(menuCtx) return true else imgui.End() imgui.PopStyleColor(2) imgui.PopStyleVar(2) end end return false end local function EndPiePopup(menuCtx) EndPieMenuEx(menuCtx) local oStyle = imgui.GetStyle() local pDrawList = imgui.GetWindowDrawList() pDrawList:PushClipRectFullScreen() local oMousePos = imgui.GetIO().MousePos local oDragDelta = ImVec2(oMousePos.x - menuCtx.m_oCenter.x, oMousePos.y - menuCtx.m_oCenter.y) local fDragDistSqr = oDragDelta.x*oDragDelta.x + oDragDelta.y*oDragDelta.y local fCurrentRadius = menuCtx.c_iRadiusEmpty -- ImRect local oArea = {Min = ImVec2(menuCtx.m_oCenter), Max = ImVec2(menuCtx.m_oCenter)} local bItemHovered = false local c_fDefaultRotate = -math.pi / 2 local fLastRotate = c_fDefaultRotate for iIndex = 0, menuCtx.m_iMaxIndex do local oPieMenu = menuCtx.m_oPieMenuStack[iIndex] local fMenuHeight = math.sqrt(oPieMenu.m_fMaxItemSqrDiameter) local fMinRadius = fCurrentRadius local fMaxRadius = fMinRadius + (fMenuHeight * oPieMenu.m_iCurrentIndex) / 2 local item_arc_span = 2 * math.pi / math.max(menuCtx.c_iMinItemCount + menuCtx.c_iMinItemCountPerLevel * iIndex, oPieMenu.m_iCurrentIndex) local drag_angle = math.atan2(oDragDelta.y, oDragDelta.x) local fRotate = fLastRotate - item_arc_span * ( oPieMenu.m_iCurrentIndex - 1 ) / 2 local item_hovered = -1 for item_n = 0, oPieMenu.m_iCurrentIndex - 1 do local item_label = oPieMenu.m_oItemNames[ item_n ] local inner_spacing = oStyle.ItemInnerSpacing.x / fMinRadius / 2 local fMinInnerSpacing = oStyle.ItemInnerSpacing.x / ( fMinRadius * 2 ) local fMaxInnerSpacing = oStyle.ItemInnerSpacing.x / ( fMaxRadius * 2 ) local item_inner_ang_min = item_arc_span * ( item_n - 0.5 + fMinInnerSpacing ) + fRotate local item_inner_ang_max = item_arc_span * ( item_n + 0.5 - fMinInnerSpacing ) + fRotate local item_outer_ang_min = item_arc_span * ( item_n - 0.5 + fMaxInnerSpacing ) + fRotate local item_outer_ang_max = item_arc_span * ( item_n + 0.5 - fMaxInnerSpacing ) + fRotate local hovered = false if fDragDistSqr >= fMinRadius * fMinRadius and fDragDistSqr < fMaxRadius * fMaxRadius then while (drag_angle - item_inner_ang_min) < 0 do drag_angle = drag_angle + (2 * math.pi) end while (drag_angle - item_inner_ang_min) > 2 * math.pi do drag_angle = drag_angle - (2 * math.pi) end if drag_angle >= item_inner_ang_min and drag_angle < item_inner_ang_max then hovered = true bItemHovered = not oPieMenu.m_oItemIsSubMenu[ item_n ] end end -- draw segments local arc_segments = math.floor(( 32 * item_arc_span / ( 2 * math.pi ) ) + 1) local iColor = imgui.GetStyleColorU32( hovered and imgui.Col.ButtonHovered or imgui.Col.Button ) local fAngleStepInner = (item_inner_ang_max - item_inner_ang_min) / arc_segments local fAngleStepOuter = ( item_outer_ang_max - item_outer_ang_min ) / arc_segments pDrawList:PrimReserve(arc_segments * 6, (arc_segments + 1) * 2) for iSeg = 0, arc_segments do local fCosInner = math.cos(item_inner_ang_min + fAngleStepInner * iSeg) local fSinInner = math.sin(item_inner_ang_min + fAngleStepInner * iSeg) local fCosOuter = math.cos(item_outer_ang_min + fAngleStepOuter * iSeg) local fSinOuter = math.sin(item_outer_ang_min + fAngleStepOuter * iSeg) if iSeg < arc_segments then local VtxCurrentIdx = pDrawList._VtxCurrentIdx pDrawList:PrimWriteIdx(VtxCurrentIdx + 0) pDrawList:PrimWriteIdx(VtxCurrentIdx + 2) pDrawList:PrimWriteIdx(VtxCurrentIdx + 1) pDrawList:PrimWriteIdx(VtxCurrentIdx + 3) pDrawList:PrimWriteIdx(VtxCurrentIdx + 2) pDrawList:PrimWriteIdx(VtxCurrentIdx + 1) end local pos = ImVec2(menuCtx.m_oCenter.x + fCosInner * (fMinRadius + oStyle.ItemInnerSpacing.x), menuCtx.m_oCenter.y + fSinInner * (fMinRadius + oStyle.ItemInnerSpacing.x)) local pos2 = ImVec2(menuCtx.m_oCenter.x + fCosOuter * (fMaxRadius - oStyle.ItemInnerSpacing.x), menuCtx.m_oCenter.y + fSinOuter * (fMaxRadius - oStyle.ItemInnerSpacing.x)) pDrawList:PrimWriteVtx(pos, ImVec2(0, 0), iColor) pDrawList:PrimWriteVtx(pos2, ImVec2(0, 0), iColor) end --[[ old way without pDrawList._VtxCurrentIdx pDrawList:PathArcTo(menuCtx.m_oCenter, fMaxRadius - oStyle.ItemInnerSpacing.x, item_outer_ang_min, item_outer_ang_max, arc_segments) pDrawList:PathArcTo(menuCtx.m_oCenter, fMinRadius + oStyle.ItemInnerSpacing.x, item_outer_ang_max, item_outer_ang_min, arc_segments) pDrawList:PathFillConvex(iColor) ]] local fRadCenter = ( item_arc_span * item_n ) + fRotate local oOuterCenter = ImVec2( menuCtx.m_oCenter.x + math.cos( fRadCenter ) * fMaxRadius, menuCtx.m_oCenter.y + math.sin( fRadCenter ) * fMaxRadius ) ImRectAdd(oArea, oOuterCenter) if oPieMenu.m_oItemIsSubMenu[item_n] then local oTrianglePos = {ImVec2(), ImVec2(), ImVec2()} local fRadLeft = fRadCenter - 5 / fMaxRadius local fRadRight = fRadCenter + 5 / fMaxRadius oTrianglePos[ 0+1 ].x = menuCtx.m_oCenter.x + math.cos( fRadCenter ) * ( fMaxRadius - 5 ) oTrianglePos[ 0+1 ].y = menuCtx.m_oCenter.y + math.sin( fRadCenter ) * ( fMaxRadius - 5 ) oTrianglePos[ 1+1 ].x = menuCtx.m_oCenter.x + math.cos( fRadLeft ) * ( fMaxRadius - 10 ) oTrianglePos[ 1+1 ].y = menuCtx.m_oCenter.y + math.sin( fRadLeft ) * ( fMaxRadius - 10 ) oTrianglePos[ 2+1 ].x = menuCtx.m_oCenter.x + math.cos( fRadRight ) * ( fMaxRadius - 10 ) oTrianglePos[ 2+1 ].y = menuCtx.m_oCenter.y + math.sin( fRadRight ) * ( fMaxRadius - 10 ) pDrawList:AddTriangleFilled(oTrianglePos[1], oTrianglePos[2], oTrianglePos[3], 0xFFFFFFFF) end local text_size = ImVec2(oPieMenu.m_oItemSizes[item_n]) local text_pos = ImVec2( menuCtx.m_oCenter.x + math.cos((item_inner_ang_min + item_inner_ang_max) * 0.5) * (fMinRadius + fMaxRadius) * 0.5 - text_size.x * 0.5, menuCtx.m_oCenter.y + math.sin((item_inner_ang_min + item_inner_ang_max) * 0.5) * (fMinRadius + fMaxRadius) * 0.5 - text_size.y * 0.5) pDrawList:AddText(text_pos, imgui.GetStyleColorU32(imgui.Col.Text), item_label) if hovered then item_hovered = item_n end end fCurrentRadius = fMaxRadius oPieMenu.m_fLastMaxItemSqrDiameter = oPieMenu.m_fMaxItemSqrDiameter oPieMenu.m_iHoveredItem = item_hovered if fDragDistSqr >= fMaxRadius * fMaxRadius then item_hovered = oPieMenu.m_iLastHoveredItem end oPieMenu.m_iLastHoveredItem = item_hovered fLastRotate = item_arc_span * oPieMenu.m_iLastHoveredItem + fRotate if item_hovered == -1 or not oPieMenu.m_oItemIsSubMenu[item_hovered] then break end end pDrawList:PopClipRect() if oArea.Min.x < 0 then menuCtx.m_oCenter.x = ( menuCtx.m_oCenter.x - oArea.Min.x ) end if oArea.Min.y < 0 then menuCtx.m_oCenter.y = ( menuCtx.m_oCenter.y - oArea.Min.y ) end local oDisplaySize = imgui.GetIO().DisplaySize if oArea.Max.x > oDisplaySize.x then menuCtx.m_oCenter.x = ( menuCtx.m_oCenter.x - oArea.Max.x ) + oDisplaySize.x end if oArea.Max.y > oDisplaySize.y then menuCtx.m_oCenter.y = ( menuCtx.m_oCenter.y - oArea.Max.y ) + oDisplaySize.y end if menuCtx.m_bClose or ( not bItemHovered and imgui.IsMouseReleased( menuCtx.m_iMouseButton ) ) then imgui.CloseCurrentPopup() end imgui.EndPopup() imgui.PopStyleColor(2) imgui.PopStyleVar(2) end local function BeginPieMenu(menuCtx, pName, bEnabled) assert(menuCtx.m_iCurrentIndex >= 0 and menuCtx.m_iCurrentIndex < menuCtx.c_iMaxPieItemCount) bEnabled = bEnabled or true local oPieMenu = menuCtx.m_oPieMenuStack[menuCtx.m_iCurrentIndex] local oTextSize = imgui.CalcTextSize(pName, true) oPieMenu.m_oItemSizes[oPieMenu.m_iCurrentIndex] = oTextSize local fSqrDiameter = oTextSize.x * oTextSize.x + oTextSize.y * oTextSize.y if fSqrDiameter > oPieMenu.m_fMaxItemSqrDiameter then oPieMenu.m_fMaxItemSqrDiameter = fSqrDiameter end oPieMenu.m_oItemIsSubMenu[oPieMenu.m_iCurrentIndex] = true oPieMenu.m_oItemNames[oPieMenu.m_iCurrentIndex] = pName if oPieMenu.m_iLastHoveredItem == oPieMenu.m_iCurrentIndex then oPieMenu.m_iCurrentIndex = oPieMenu.m_iCurrentIndex + 1 BeginPieMenuEx(menuCtx) return true end oPieMenu.m_iCurrentIndex = oPieMenu.m_iCurrentIndex + 1 return false end local function EndPieMenu(menuCtx) assert(menuCtx.m_iCurrentIndex >= 0 and menuCtx.m_iCurrentIndex < menuCtx.c_iMaxPieItemCount) menuCtx.m_iCurrentIndex = menuCtx.m_iCurrentIndex - 1 end local function PieMenuItem(menuCtx, pName, bEnabled) assert(menuCtx.m_iCurrentIndex >= 0 and menuCtx.m_iCurrentIndex < menuCtx.c_iMaxPieItemCount) bEnabled = bEnabled or true local oPieMenu = menuCtx.m_oPieMenuStack[menuCtx.m_iCurrentIndex] local oTextSize = imgui.CalcTextSize(pName, true) oPieMenu.m_oItemSizes[oPieMenu.m_iCurrentIndex] = oTextSize local fSqrDiameter = oTextSize.x * oTextSize.x + oTextSize.y * oTextSize.y if fSqrDiameter > oPieMenu.m_fMaxItemSqrDiameter then oPieMenu.m_fMaxItemSqrDiameter = fSqrDiameter end oPieMenu.m_oItemIsSubMenu[oPieMenu.m_iCurrentIndex] = false oPieMenu.m_oItemNames[oPieMenu.m_iCurrentIndex] = pName local bActive = oPieMenu.m_iCurrentIndex == oPieMenu.m_iHoveredItem oPieMenu.m_iCurrentIndex = oPieMenu.m_iCurrentIndex + 1 if bActive then menuCtx.m_bClose = true end return bActive end local function New(...) local menuContext = NewPieMenuContext(...) return { BeginPiePopup = function(name, mouseButton) return BeginPiePopup(menuContext, name, mouseButton) end, EndPiePopup = function() return EndPiePopup(menuContext) end, PieMenuItem = function(name, enabled) return PieMenuItem(menuContext, name, enabled) end, BeginPieMenu = function(name, enabled) return BeginPieMenu(menuContext, name, enabled) end, EndPieMenu = function() return EndPieMenu(menuContext) end } end local defaultPieMenu = New() defaultPieMenu.New = New return defaultPieMenuКак можно улучшить код?
- Assistant
Improving the provided Lua code for an ImGui-based pie menu involves several aspects, including code correctness, efficiency, readability, maintainability, and adherence to Lua best practices. Below are detailed suggestions and explanations on how to enhance the code:
1. Correct Version Checking
Issue:
The version check asserts that theminorversion is>= 3but the error message mentions v1.1.4 or greater, leading to confusion.Improvement:
Update the assertion message to match the condition or adjust the condition to align with the message.Code Fix:
-- Original assertion assert(tonumber(vmajor) == 1 and (tonumber(vminor) > 1 or (tonumber(vminor) == 1 and tonumber(vpatch) >= 3)), 'ImGui Pie requires Moon ImGui v1.1.4 or greater') -- Corrected assertion message assert(tonumber(vmajor) == 1 and (tonumber(vminor) > 1 or (tonumber(vminor) == 1 and tonumber(vpatch) >= 3)), 'ImGui Pie requires Moon ImGui v1.1.3 or greater')Or adjust the condition to require version
1.1.4:assert(tonumber(vmajor) == 1 and (tonumber(vminor) > 1 or (tonumber(vminor) == 1 and tonumber(vpatch) >= 4)), 'ImGui Pie requires Moon ImGui v1.1.4 or greater')2. Consistent Indexing
Issue:
Lua uses 1-based indexing, but the code inconsistently uses 0-based indices, especially in loops and table accesses.Improvement:
Standardize all indices to 1-based to align with Lua conventions, unless there's a specific reason to use 0-based indexing (e.g., interfacing with C libraries).Code Fix:
-- Example: Adjust loop from 0-based to 1-based for i = 1, obj.c_iMaxPieMenuStack do obj.m_oPieMenuStack[i] = NewPieMenu(obj) end -- Similarly, adjust all table accesses and loops accordingly3. Enhanced Readability and Naming Conventions
Issue:
Variable and function names use prefixes likem_andc_, which may not be idiomatic in Lua.Improvement:
Adopt Lua's naming conventions for better readability. For instance, usecamelCaseorsnake_casewithout prefixes.Code Fix:
-- Original naming local function NewPieMenuContext(MaxPieMenuStack, MaxPieItemCount, RadiusEmpty, RadiusMin, MinItemCount, MinItemCountPerLevel) -- Improved naming local function newPieMenuContext(maxMenuStack, maxItemCount, emptyRadius, minRadius, minItemCount, minItemCountPerLevel)Apply similar changes throughout the code to maintain consistency and clarity.
4. Modularization and Use of Metatables for Object-Oriented Design
Issue:
The current structure uses closures to bind functions to themenuContext, which can become cumbersome and less clear as the module grows.Improvement:
Utilize Lua’s metatables to create a more structured and object-oriented approach, enhancing maintainability and extensibility.Code Fix:
-- Define a PieMenu class using metatables local PieMenu = {} PieMenu.__index = PieMenu function PieMenu:new(maxMenuStack, maxItemCount, emptyRadius, minRadius, minItemCount, minItemCountPerLevel) local obj = { maxMenuStack = maxMenuStack or 8, maxPieItemCount = maxPieItemCount or 12, radiusEmpty = emptyRadius or 30, radiusMin = minRadius or 30, minItemCount = minItemCount or 3, minItemCountPerLevel = minItemCountPerLevel or 3, pieMenuStack = {}, currentIndex = -1, lastFrame = 0, maxIndex = 0, center = imgui.ImVec2(0, 0), mouseButton = 0, close = false, } for i = 1, obj.maxMenuStack do obj.pieMenuStack[i] = newPieMenu(obj) -- Assuming newPieMenu is updated for 1-based indexing end setmetatable(obj, PieMenu) return obj end -- Example method function PieMenu:beginPiePopup(name, mouseButton) -- Implementation here end -- Continue defining methods similarlyThis approach encapsulates the pie menu's data and behavior, making the code more organized.
5. Avoiding Magic Numbers
Issue:
The code uses hard-coded values like-100for window positions, which can be unclear and inflexible.Improvement:
Define constants or make such values configurable through parameters, enhancing flexibility and clarity.Code Fix:
-- Define constants at the top local OFFSCREEN_POS = ImVec2(-100, -100) -- Use the constant instead of magic number imgui.SetNextWindowPos(OFFSCREEN_POS, imgui.Cond.Appearing)Alternatively, pass these values as parameters to functions if variability is needed.
6. Optimizing Drawing Operations
Issue:
The code reserves and writes primitives directly, which can be error-prone and difficult to maintain.Improvement:
Leverage higher-level ImGui drawing functions where possible for simplicity unless low-level control is necessary.Code Fix:
-- Replace manual primitive writing with Path API if suitable pDrawList:PathArcTo(menuCtx.center, fMaxRadius - style.ItemInnerSpacing.x, item_outer_ang_min, item_outer_ang_max, arc_segments) pDrawList:PathArcTo(menuCtx.center, fMinRadius + style.ItemInnerSpacing.x, item_outer_ang_max, item_outer_ang_min, arc_segments) pDrawList:PathFillConvex(iColor)Ensure that the higher-level functions fulfill the desired drawing needs before removing the low-level drawing code.
7. Improving Performance
Issue:
Certain calculations and table operations are performed repeatedly within loops, potentially impacting performance.Improvement:
Cache repetitive calculations and minimize table lookups within performance-critical sections.Code Fix:
-- Example: Cache style variables outside inner loops local style = imgui.GetStyle() local itemInnerSpacingX = style.ItemInnerSpacing.x for i = 1, menuCtx.maxIndex do -- Use cached variables local fMinInnerSpacing = itemInnerSpacingX / (fMinRadius * 2) local fMaxInnerSpacing = itemInnerSpacingX / (fMaxRadius * 2) -- Rest of the loop endAdditionally, minimize the creation of temporary objects within loops to reduce garbage collection overhead.
8. Enhanced Error Handling
Issue:
The code usesassertstatements but lacks comprehensive error handling and informative messages for all potential issues.Improvement:
Provide detailed error messages and handle edge cases gracefully to aid debugging and ensure robustness.Code Fix:
-- Example: Enhanced error messages assert(menuCtx.currentIndex < menuCtx.maxPieMenuStack, string.format("Current index (%d) exceeds maximum stack size (%d)", menuCtx.currentIndex, menuCtx.maxPieMenuStack))Additionally, consider returning error codes or using pcall where appropriate to manage recoverable errors.
9. Lua-Specific Enhancements
Issue:
The code could better utilize Lua's features, such as local functions, upvalues, and table manipulation, to optimize performance and readability.Improvement:
Use local declarations for frequently accessed functions and variables to benefit from faster access through upvalues.Code Fix:
-- At the top, localize frequently used functions local math_cos = math.cos local math_sin = math.sin local math_atan2 = math.atan2 local math_floor = math.floor local imgui_GetStyleColorU32 = imgui.GetStyleColorU32 local imgui_AddText = imgui.GetWindowDrawList().AddText -- Continue for other frequently used functionsLocalizing these functions can reduce global table lookups, slightly improving performance.
10. Documentation and Comments
Issue:
The code lacks comprehensive documentation, making it harder for others (or future you) to understand and maintain.Improvement:
Add comments explaining the purpose of functions, parameters, return values, and complex logic sections. Consider using LuaDoc or similar documentation standards.Code Fix:
--- Creates a new pie menu context. -- @param maxMenuStack Maximum number of pie menu layers. -- @param maxItemCount Maximum number of items per pie menu. -- @param emptyRadius Initial radius of the pie menu. -- @param minRadius Minimum radius to detect hover. -- @param minItemCount Minimum number of items required. -- @param minItemCountPerLevel Additional items per submenu level. -- @return A new pie menu context object. local function newPieMenuContext(maxMenuStack, maxItemCount, emptyRadius, minRadius, minItemCount, minItemCountPerLevel) -- Function implementation endAdding such documentation promotes better understanding and ease of use.
11. Memory Management and Table Reuse
Issue:
Repeatedly creating new tables within loops can lead to unnecessary memory allocations and garbage collection overhead.Improvement:
Preallocate tables where possible or reuse existing tables by clearing them before reuse.Code Fix:
-- Example: Reuse tables local tempTrianglePos = {ImVec2(), ImVec2(), ImVec2()} for i = 1, someLimit do -- Clear and reuse tempTrianglePos tempTrianglePos[1].x, tempTrianglePos[1].y = 0, 0 tempTrianglePos[2].x, tempTrianglePos[2].y = 0, 0 tempTrianglePos[3].x, tempTrianglePos[3].y = 0, 0 -- Use tempTrianglePos endThis approach reduces the number of allocations and minimizes garbage collection pauses.
12. Handling Edge Cases and User Input Robustly
Issue:
The current implementation may not gracefully handle all user interactions or edge cases, such as rapid mouse movements or unusual menu configurations.Improvement:
Implement checks and fallback mechanisms to manage unexpected states and ensure the pie menu behaves correctly under various conditions.Code Fix:
-- Example: Ensure currentIndex doesn't exceed stack function PieMenu:beginPiePopup(name, mouseButton) if self.currentIndex >= self.maxPieMenuStack then imgui.CloseCurrentPopup() return false end -- Continue with existing logic endEnsure all functions validate state before proceeding with operations.
13. Refactoring Complex Functions
Issue:
Functions likeEndPiePopupandEndPieMenuExcontain deeply nested logic, making them hard to read and maintain.Improvement:
Break down complex functions into smaller, well-named helper functions to enhance readability and manageability.Code Fix:
-- Example: Refactor EndPiePopup local function adjustMenuCenter(menuCtx, area) if area.Min.x < 0 then menuCtx.center.x = menuCtx.center.x - area.Min.x end if area.Min.y < 0 then menuCtx.center.y = menuCtx.center.y - area.Min.y end local displaySize = imgui.GetIO().DisplaySize if area.Max.x > displaySize.x then menuCtx.center.x = menuCtx.center.x - (area.Max.x - displaySize.x) end if area.Max.y > displaySize.y then menuCtx.center.y = menuCtx.center.y - (area.Max.y - displaySize.y) end end local function EndPiePopup(menuCtx) EndPieMenuEx(menuCtx) -- Drawing and other logic here local area = {Min = ImVec2(menuCtx.center), Max = ImVec2(menuCtx.center)} -- ... more operations ... adjustMenuCenter(menuCtx, area) -- ... rest of the function ... endThis modular approach simplifies each function's responsibilities.
14. Leveraging Lua’s Built-in Functions and Features
Issue:
Some operations can be optimized or simplified using Lua's built-in functions or advanced features.Improvement:
Use functions liketable.insert,table.remove, or comprehensions where appropriate. Utilize local variables to enhance performance.Code Fix:
-- Example: Using table.insert table.insert(oPieMenu.m_oItemNames, pName) table.insert(oPieMenu.m_oItemSizes, oTextSize) table.insert(oPieMenu.m_oItemIsSubMenu, isSubMenu)Ensure that built-in functions are used effectively to write cleaner and more efficient code.
15. Unit Testing and Validation
Issue:
The code doesn’t include tests to verify its correctness, making it prone to regressions and bugs over time.Improvement:
Implement unit tests to validate the functionality of individual components, ensuring reliability and easing future modifications.Code Fix:
-- Example: Using a simple test framework local function testBeginPieMenu() local menu = New() assert(menu:BeginPiePopup("TestMenu"), "BeginPiePopup should return true when popup is open") -- Add more assertions and test cases end testBeginPieMenu()Incorporate a testing framework like busted for more comprehensive testing.
16. Provide Configuration Options
Issue:
Certain parameters like colors, radii, and spacing are hard-coded, limiting flexibility.Improvement:
Allow these parameters to be configurable through theNewfunction or setter methods, enabling users to customize the pie menu appearance and behavior.Code Fix:
-- Modify New function to accept configuration table local function New(config) config = config or {} local menuContext = newPieMenuContext( config.maxMenuStack, config.maxItemCount, config.emptyRadius, config.minRadius, config.minItemCount, config.minItemCountPerLevel ) -- Apply additional configurations like colors if provided if config.colors then -- Set colors accordingly end return { BeginPiePopup = function(name, mouseButton) return beginPiePopup(menuContext, name, mouseButton) end, -- ... other methods ... } endThis enhancement makes the pie menu more adaptable to different use cases.
17. Optimize Hotspot Detection
Issue:
Calculations for detecting hovered items involve trigonometric functions and could be optimized.Improvement:
Precompute frequently used values like2 * math.piand reuse them. Also, consider simplifying angle normalization.Code Fix:
local TWO_PI = 2 * math.pi -- Inside the loop while (drag_angle - item_inner_ang_min) < 0 do drag_angle = drag_angle + TWO_PI end while (drag_angle - item_inner_ang_min) > TWO_PI do drag_angle = drag_angle - TWO_PI endThis reduces repetitive calculations and enhances performance.
18. Enhance User Feedback and Accessibility
Issue:
The pie menu may lack visual cues or accessibility features, making it harder to understand or use for some users.Improvement:
Add features like highlighting selected items, providing keyboard navigation, and ensuring sufficient color contrast.Code Fix:
-- Example: Highlighting with alpha based on hover state local highlightColor = hovered and imgui.GetStyleColorU32(imgui.Col.ButtonHovered) or imgui.GetStyleColorU32(imgui.Col.Button) -- Ensure text is readable against background pDrawList:AddText(text_pos, imgui.GetStyleColorU32(imgui.Col.Text), item_label)Incorporate accessibility best practices to make the pie menu more user-friendly.
19. Remove or Update Deprecated or Unused Code
Issue:
There are commented-out sections and potential leftover code that may no longer be relevant.Improvement:
Clean up the code by removing deprecated parts or updating them as necessary to keep the codebase clean and maintainable.Code Fix:
-- Remove the old drawing method if not needed --[[ old way without pDrawList._VtxCurrentIdx pDrawList:PathArcTo(menuCtx.m_oCenter, fMaxRadius - oStyle.ItemInnerSpacing.x, item_outer_ang_min, item_outer_ang_max, arc_segments) pDrawList:PathArcTo(menuCtx.m_oCenter, fMinRadius + oStyle.ItemInnerSpacing.x, item_outer_ang_max, item_outer_ang_min, arc_segments) pDrawList:PathFillConvex(iColor) ]]Ensure all remnants of old implementations are either updated or removed to avoid confusion.
20. Implement Caching Mechanisms
Issue:
Recomputing layout and sizes every frame can be inefficient, especially for static or infrequently changing elements.Improvement:
Implement caching for element sizes and positions when appropriate, recalculating only when necessary.Code Fix:
-- Example: Cache text sizes and only recalculate when item names change function PieMenu:calculateItemSizes() if self.needsRecalculation then for i, name in ipairs(self.itemNames) do self.itemSizes[i] = imgui.CalcTextSize(name, true) end self.needsRecalculation = false end endThis reduces redundant calculations, improving performance.
21. Adopt Functional Programming Principles
Issue:
Some functions have side effects or perform multiple tasks, making them harder to test and reason about.Improvement:
Adopt functional programming principles by designing pure functions where possible, improving testability and maintainability.Code Fix:
-- Example: Refactor a function to be pure local function calculateDragAngle(mousePos, center) local deltaX = mousePos.x - center.x local deltaY = mousePos.y - center.y return math.atan2(deltaY, deltaX) end -- Use the pure function in the main loop local dragAngle = calculateDragAngle(imgui.GetIO().MousePos, menuCtx.center)Pure functions enhance code reliability and simplify debugging.
22. Ensure Cross-Platform Compatibility
Issue:
If the pie menu is intended for cross-platform use, certain implementations might not behave consistently across different systems.Improvement:
Test the pie menu on various platforms and adjust the code to handle platform-specific nuances.Code Fix:
-- Example: Adjust radii or spacing based on DPI or platform local dpiScale = imgui.GetIO().DisplayFramebufferScale.x local adjustedRadius = baseRadius * dpiScaleThis ensures consistent appearance and functionality across different environments.
23. Use Clear and Descriptive Variable Names
Issue:
Some variable names likefMinRadius,fMaxRadius,item_nmay not clearly convey their purpose.Improvement:
Choose descriptive names that reflect the variable's role, enhancing code clarity.Code Fix:
-- Original variable name local fMinRadius = fCurrentRadius -- Improved variable name local minimumRadius = currentRadiusConsistent and descriptive naming makes the code easier to understand and maintain.
24. Implement Logging for Debugging
Issue:
Lack of logging makes it difficult to trace issues or understand the flow during runtime.Improvement:
Incorporate logging statements, especially around critical operations, to aid in debugging and monitoring.Code Fix:
local function BeginPiePopup(menuCtx, pName, iMouseButton) if imgui.IsPopupOpen(pName) then print(string.format("Opening pie popup: %s with mouse button %d", pName, iMouseButton)) -- Rest of the function end endUse a configurable logging mechanism to control the verbosity and destinations of logs.
25. Provide Example Usage and Documentation
Issue:
Users may find it challenging to understand how to utilize the pie menu without examples.Improvement:
Include example usage in the documentation or as separate test scripts to demonstrate how to integrate and use the pie menu.Code Fix:
-- Example usage: local imgui_pie_menu = require 'imgui_pie_menu' -- Begin a pie popup if imgui_pie_menu:BeginPiePopup("MyPieMenu", 0) then if imgui_pie_menu:PieMenuItem("Option 1") then -- Handle Option 1 end if imgui_pie_menu:BeginPieMenu("Submenu", true) then if imgui_pie_menu:PieMenuItem("SubOption 1") then -- Handle SubOption 1 end imgui_pie_menu:EndPieMenu() end imgui_pie_menu:EndPiePopup() endProviding clear examples helps users get started quickly and understand the intended usage patterns.
By implementing these improvements, the pie menu module will become more robust, efficient, and user-friendly. Enhancing code quality not only makes it easier to maintain and extend but also ensures a better experience for end-users relying on the functionality provided by the module.