Tooltip: SetTooltip() is expanded immediately into a window, honoring current font / styling setting. Add internal mechanism to override tooltips (not exposed in BeginTooltip yet because bools are evil)

 ocornut/imgui@138a9db

Author: elect86

src/main/kotlin/imgui/Context.kt

@@ -160,7 +160,7 @@ object Context {
     /** Distance between mouse and center of grab box, normalized in parent space. Use storage? */
     var scrollbarClickDeltaToGrabCenter = Vec2()
 
-    var tooltip = ""
+    var tooltipOverrideCount = 0
     /** If no custom clipboard handler is defined   */
     var privateClipboard = ""
     /** Cursor position request to the OS Input Method Editor   */

src/main/kotlin/imgui/imgui/internal.kt

@@ -99,13 +99,6 @@ interface imgui_internal {
         assert(g.initialized)                       // Forgot to call ImGui::NewFrame()
         assert(g.frameCountEnded != g.frameCount)   // ImGui::EndFrame() called multiple times, or forgot to call ImGui::NewFrame() again
 
-        // Render tooltip
-        if (g.tooltip.isNotEmpty() && g.tooltip[0] != '\u0000') {
-            ImGui.beginTooltip()
-            ImGui.textUnformatted(g.tooltip)
-            ImGui.endTooltip()
-        }
-
         // Notify OS when our Input Method Editor cursor has moved (e.g. CJK inputs using Microsoft IME)
 //        if (IO.imeSetInputScreenPosFn && ImLengthSqr(g.OsImePosRequest - g.OsImePosSet) > 0.0001f) { TODO
 //            g.IO.ImeSetInputScreenPosFn((int) g . OsImePosRequest . x, (int) g . OsImePosRequest . y)

src/main/kotlin/imgui/imgui/main.kt

@@ -43,7 +43,7 @@ interface imgui_main {
 
         g.time += IO.deltaTime
         g.frameCount += 1
-        g.tooltip = ""
+        g.tooltipOverrideCount = 0
         g.overlayDrawList.clear()
         g.overlayDrawList.pushTextureId(IO.fonts.texId)
         g.overlayDrawList.pushClipRectFullScreen()

src/main/kotlin/imgui/imgui/tooltips.kt

@@ -1,30 +1,46 @@
 package imgui.imgui
 
 import imgui.*
+import imgui.ImGui.begin
 import imgui.ImGui.currentWindowRead
-import imgui.Context.style
+import imgui.ImGui.end
+import imgui.ImGui.findWindowByName
+import imgui.ImGui.style
+import imgui.ImGui.textV
 import imgui.Context as g
 
 /** Tooltips    */
 interface imgui_tooltips {
 
-    /** set tooltip under mouse-cursor, typically use with ImGui::IsHovered(). last call wins
-     *
-     * Tooltip is stored and turned into a BeginTooltip()/EndTooltip() sequence at the end of the frame.
-     * Each call override previous value.*/
-    fun setTooltip(fmt: String, vararg values: Any) {
-        g.tooltip = fmt.format(style.locale, *values)
+    /** Not exposed publicly as BeginTooltip() because bool parameters are evil. Let's see if other needs arise first.  */
+    fun beginTooltipEx(overridePreviousTooltip: Boolean) {
+
+        var windowName = "##Tooltip%02d".format(style.locale, g.tooltipOverrideCount)
+        if (overridePreviousTooltip)
+            findWindowByName(windowName)?.let {
+                if (it.active) {
+                    // Hide previous tooltips. We can't easily "reset" the content of a window so we create a new one.
+                    it.hiddenFrames = 1
+                    windowName = "##Tooltip%02d".format(++g.tooltipOverrideCount)
+                }
+            }
+        begin(windowName, null, WindowFlags.Tooltip or WindowFlags.NoTitleBar or WindowFlags.NoMove or
+                WindowFlags.NoResize or WindowFlags.NoSavedSettings or WindowFlags.AlwaysAutoResize)
     }
 
-    /** use to create full-featured tooltip windows that aren't just text   */
-    fun beginTooltip()    {
-        val flags = WindowFlags.Tooltip or WindowFlags.NoTitleBar or WindowFlags.NoMove or WindowFlags.NoResize or
-                WindowFlags.NoSavedSettings or WindowFlags.AlwaysAutoResize
-        ImGui.begin("##Tooltip", null, flags)
+    fun setTooltipV(fmt: String, args: Array<out Any>) {
+        beginTooltipEx(true)
+        textV(fmt, args)
+        endTooltip()
     }
 
+    fun setTooltip(fmt: String, vararg args: Any)  = setTooltipV(fmt, args)
+
+    /** begin/append a tooltip window. to create full-featured tooltip (with any kind of contents). */
+    fun beginTooltip() = beginTooltipEx(false)
+
     fun endTooltip() {
         assert(currentWindowRead!!.flags has WindowFlags.Tooltip)   // Mismatched BeginTooltip()/EndTooltip() calls
-        ImGui.end()
+        end()
     }
 }

src/main/kotlin/imgui/imgui/widgets.kt

@@ -6,6 +6,7 @@ import glm_.i
 import glm_.vec2.Vec2
 import glm_.vec4.Vec4
 import imgui.*
+import imgui.Context.style
 import imgui.ImGui.F32_TO_INT8_SAT
 import imgui.ImGui.F32_TO_INT8_UNBOUND
 import imgui.ImGui.beginGroup
@@ -58,7 +59,6 @@ import imgui.ImGui.spacing
 import imgui.ImGui.textLineHeight
 import imgui.internal.*
 import imgui.Context as g
-import imgui.Context.style
 
 interface imgui_widgets {
 
@@ -82,7 +82,7 @@ interface imgui_widgets {
     /** shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, ...); PopStyleColor();   */
     fun textColored(col: Vec4, fmt: String, vararg args: Any) {
         pushStyleColor(Col.Text, col)
-        text(fmt, args)
+        text(fmt, *args)
         popStyleColor()
     }