Detecting Screen Mouse Position using as few frames as possible

[Son-Guhun]

Assumptions

• Tooltips show for every frame the mouse is currently hovering over, not just the top one.
• 1/32 is the mininum timer delay that is also a power of 2 which is necessary for a tooltip to show up in the UI after a frame has been moved to the mouse pointer's positon.

Algorithm

• Split screen into 64 blocks.

• Split a single one of those blocks (not all of them) into 64 smaller blocks.

• Effectively, we have a resolution of 64x64, or 4096 "pixels"

• In total, we would use 2x64 + 2x64 frames (we need double the frames because of tooltips), which is 256 frames.

• First, we would check all 64 big blocks to try and find which one contains the mouse.

• Then, move the small frames to that box.

• After 1/32 seconds, we check to see if the mouse is still in the big block we had checked.

  • If it is, then we find which small frame currently contains it.
  • Otherwise find which big block has the mouse and then move the small blocks there.
  • Repeat this step every 1/32 seconds.

• We can reduce the number of iterations required by also creating 4 bigger blocks above each set of 64 blocks. This reduces the required number of iterations from 64 to 20 (4 to find bigger block, 16 to find which smaller block in that bigger block)

[Son-Guhun]

Results

• Assumption 1 does not hold, at least for non-simple frames.

Code

Library

library MouseDetect
//! textmacro ThisLib_GetterSetter takes type, name
    static $type$ array array$name$

    method get$name$ takes integer i, integer j returns $type$
        return array$name$[this*OFFSET + i*MAX_SIZE + j]
    endmethod

    private method set$name$ takes integer i, integer j, $type$ val returns nothing
        set array$name$[this*OFFSET + i*MAX_SIZE + j] = val
    endmethod
//! endtextmacro

struct ScreenBlocks
    public  static constant integer MAX_SIZE = 9
    private static constant integer OFFSET = MAX_SIZE*MAX_SIZE

    //! runtextmacro  ThisLib_GetterSetter("framehandle", "Frame")
    //! runtextmacro  ThisLib_GetterSetter("framehandle", "Tooltip")

    static method create takes integer width, integer height, real x0, real y0, real x, real y returns thistype
        local thistype this = allocate()
        local integer i = 0
        local integer j = 0
        local framehandle frame
        local framehandle tooltip

        loop
            exitwhen i >= height
            loop 
                set frame = BlzCreateFrameByType("FRAME", "FaceFrame", BlzGetOriginFrame(ORIGIN_FRAME_GAME_UI, 0), "", 0) // BlzCreateFrame("ScriptDialogButton", BlzGetOriginFrame(ORIGIN_FRAME_GAME_UI, 0), 0,0)
                set tooltip = BlzCreateFrameByType("BACKDROP", "FaceButtonIcon", BlzGetOriginFrame(ORIGIN_FRAME_GAME_UI, 0), "", 0) //  BlzCreateFrame("ScriptDialogButton", BlzGetOriginFrame(ORIGIN_FRAME_GAME_UI, 0), 0,0)
                // call BlzFrameSetTexture(frame, "ReplaceableTextures\\CommandButtons\\BTNSelectHeroOn", 0, true)
                call BlzFrameSetTooltip(frame, tooltip)
                call BlzFrameSetPoint(frame, FRAMEPOINT_LEFT, .getFrame(i, j-1), FRAMEPOINT_RIGHT, 0., 0.)
                call BlzFrameSetSize(tooltip, (x - x0)/width, (y0 - y)/height)
                call BlzFrameSetAbsPoint(tooltip, FRAMEPOINT_CENTER, 0.4, 0.3)
                call BlzFrameSetTexture(tooltip, "ReplaceableTextures\\CommandButtons\\BTNSelectHeroOn", 0, true)
                call BlzFrameSetAlpha(frame, 127)
                call BlzFrameSetEnable(frame, false)

                /*if j > 0 then
                    call BlzFrameSetPoint(.getFrame(i, j-1), FRAMEPOINT_RIGHT, frame, FRAMEPOINT_LEFT, 0., 0.)
                endif*/
                call BlzFrameSetSize(frame, (x - x0)/width, (y0 - y)/height)
                call .setFrame(i, j, frame)
                call .setTooltip(i, j, tooltip)

                set j = j + 1
                if j == width then
                    call BlzFrameSetAbsPoint(.getFrame(i,j-1), FRAMEPOINT_RIGHT, x, y)
                    exitwhen true
                endif
            endloop

            if i > 0 then
                call BlzFrameSetPoint(.getFrame(i,0), FRAMEPOINT_TOP, .getFrame(i-1, 0), FRAMEPOINT_BOTTOM, 0., 0.)
            else
                call BlzFrameSetAbsPoint(.getFrame(0,0), FRAMEPOINT_TOPLEFT, x0, y0)
            endif
            set i = i + 1
            set j = 0
        endloop

        // call BlzFrameSetPoint(.getFrame(0, height-1), FRAMEPOINT_BOTTOMLEFT, leftBorderFrame, FRAMEPOINT_BOTTOMRIGHT, 0., 0.)

        return this
    endmethod

endstruct

endlibrary

Testing

globals
    ScreenBlocks bigBlocks
    ScreenBlocks smallBlocks
endglobals

function onTimer2 takes nothing returns nothing
   local integer i = 0
   local integer j = 0

   loop
       exitwhen i == 8
       loop
           exitwhen j == 8 or BlzFrameIsVisible(bigBlocks.getTooltip(i, j))
           set j = j + 1
       endloop
       exitwhen BlzFrameIsVisible(bigBlocks.getTooltip(i, j))
       set i = i + 1
       set j = 0
   endloop

   call BJDebugMsg("i / j: " + I2S(i) + " / " + I2S(j))
endfunction

//===========================================================================
function InitTrig_Untitled_Trigger_004 takes nothing returns nothing
   set bigBlocks = ScreenBlocks.create(8, 8, 0., 0.6, 0.8, 0.)
   set smallBlocks = ScreenBlocks.create(8, 8, 0., 0.6, 0.8/8, 7*0.6/8)

   if GetHandleId(bigBlocks.getFrame(0, 0)) > 0 then
      call TimerStart(CreateTimer(), 1/32., true, function onTimer2)
   endif

   call BJDebugMsg(I2S(bigBlocks))
   call BJDebugMsg(I2S(smallBlocks))
   // call BlzFrameSetVisible(bigBlocks.getFrame(0,7), false)
endfunction