Mercurial > wow > buffalo2

annotate Veneer.lua @ 94:df10cd0ae949

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- Pre-load veneer frames for buffs, set their triggers when the appropriate frames have spawned. - Fix to background layers remaining on screen during pet battles.
author Nenue
date Sun, 01 Jan 2017 19:31:06 -0500
parents caded2668701
children 5476337198ec
rev   line source
Nenue@88 1 -- Veneer Custom Interface Framework
Nenue@88 2 -- 1. vn OnLoad
Nenue@88 3 -- 2. OnEvent where IsLoggedIn() == true
Nenue@88 4 -- 3. Setup() where (not self.initialized)
Nenue@88 5 -- 4. Update()
Nenue@88 6 -- 5. Reanchor()
Nenue@84 7
Nenue@84 8 SLASH_VENEER1 = "/veneer"
Nenue@84 9 SLASH_VENEER2 = "/vn"
Nenue@90 10 local VENEER_VERSION = 703
Nenue@93 11 local type, strrep, ipairs, tinsert, tostring, select = type, string.rep, ipairs, tinsert, tostring, select
Nenue@93 12 local pairs, tremove = pairs, tremove
Nenue@84 13
Nenue@84 14 SlashCmdList.VENEER = function(cmd)
Nenue@90 15
Nenue@90 16 if Veneer.ConfigMode then
Nenue@90 17 Veneer.ConfigMode = false
Nenue@90 18 else
Nenue@90 19 Veneer.ConfigMode = true
Nenue@90 20 end
Nenue@90 21 Veneer:UpdateConfigLayers()
Nenue@84 22 end
Nenue@88 23
Nenue@84 24 VeneerCore = {
Nenue@84 25 Frames = {},
Nenue@84 26 ConfigLayers = {},
Nenue@84 27 FrameClusters = {},
Nenue@84 28 parserDepth = 0,
Nenue@84 29 pendingCalls = {},
Nenue@90 30 AddOnCheck = {}
Nenue@84 31 }
Nenue@93 32
Nenue@93 33 local print = DEVIAN_WORKSPACE and function(...) _G.print('Veneer', ...) end or nop
Nenue@80 34 local wipe = table.wipe
Nenue@0 35
Nenue@59 36 local defaults = {
Nenue@59 37 enableAll = true,
Nenue@59 38 enableModule = {
Nenue@59 39 BuffFrame = true,
Nenue@59 40 },
Nenue@59 41 BuffFrame = {
Nenue@59 42 width = 48,
Nenue@59 43 height = 48,
Nenue@90 44 },
Nenue@90 45 ConfigMode = true
Nenue@59 46 }
Nenue@84 47
Nenue@71 48 local configMode
Nenue@79 49 local anonID = 0
Nenue@79 50 local IsFrameHandle = IsFrameHandle
Nenue@79 51 local GetAnonymousName = function(key)
Nenue@79 52 if not key then
Nenue@71 53 anonID = anonID + 1
Nenue@79 54 key = anonID
Nenue@71 55 end
Nenue@79 56 return 'VN' .. key
Nenue@71 57 end
Nenue@79 58 local GetTableName = function(table)
Nenue@79 59 return (IsFrameHandle(table) and table:GetName()) or tostring(table)
Nenue@79 60 end
Nenue@79 61
Nenue@87 62 local OFFSET_PARALLELS = {
Nenue@87 63 TOP = {'LEFT', 'RIGHT', 'SetHeight'},
Nenue@87 64 BOTTOM = {'LEFT', 'RIGHT', 'SetHeight'},
Nenue@87 65 LEFT = {'TOP', 'BOTTOM', 'SetWidth'},
Nenue@87 66 RIGHT = {'TOP', 'BOTTOM', 'SetWidth'},
Nenue@87 67 }
Nenue@87 68 local ANCHOR_OFFSET_POINT = {
Nenue@87 69 TOP = 'BOTTOM',
Nenue@87 70 TOPLEFT = 'BOTTOMRIGHT',
Nenue@87 71 TOPRIGHT = 'BOTTOMLEFT',
Nenue@87 72 LEFT = 'RIGHT',
Nenue@87 73 RIGHT = 'LEFT',
Nenue@87 74 CENTER = 'CENTER',
Nenue@87 75 BOTTOM = 'TOP',
Nenue@87 76 BOTTOMRIGHT = 'TOPLEFT',
Nenue@87 77 BOTTOMLEFT = 'TOPRIGHT',
Nenue@87 78 }
Nenue@87 79 local ANCHOR_INSET_DELTA = {
Nenue@87 80 TOP = {0, -1},
Nenue@87 81 TOPLEFT = {1, -1},
Nenue@87 82 TOPRIGHT = {-1,-1},
Nenue@87 83 LEFT = {1, 0},
Nenue@87 84 BOTTOMLEFT = {1, 1},
Nenue@87 85 BOTTOM = {0, 1},
Nenue@87 86 BOTTOMRIGHT = {-1, 1},
Nenue@87 87 RIGHT = {-1, 0},
Nenue@87 88 CENTER = {0, 0},
Nenue@72 89 }
Nenue@72 90
Nenue@84 91 function VeneerCore:print(...)
Nenue@84 92 local txt = '|cFFFFFF00Veneer|r:'
Nenue@84 93 for i = 1, select('#', ...) do
Nenue@84 94 txt = txt .. ' '.. tostring(select(i, ...))
Nenue@84 95 end
Nenue@84 96
Nenue@84 97 DEFAULT_CHAT_FRAME:AddMessage(txt)
Nenue@84 98 end
Nenue@84 99
Nenue@84 100 function VeneerCore:OnLoad()
Nenue@84 101 print('|cFFFFFF00Veneer!|r')
Nenue@84 102 self:RegisterEvent('ADDON_LOADED')
Nenue@84 103 self:RegisterEvent('PLAYER_LOGIN')
Nenue@84 104
Nenue@84 105 self.DEVIAN_PNAME = 'Veneer'
Nenue@84 106 self:RegisterForDrag('LeftButton')
Nenue@88 107
Nenue@88 108
Nenue@84 109 end
Nenue@84 110
Nenue@90 111 local select, IsAddOnLoaded, IsLoggedIn = select, IsAddOnLoaded, IsLoggedIn
Nenue@90 112
Nenue@84 113 function VeneerCore:OnEvent(event, ...)
Nenue@90 114 print(event, ...)
Nenue@84 115 if event == 'ADDON_LOADED' or event == 'PLAYER_LOGIN' then
Nenue@90 116 print(IsLoggedIn(), self.initialized)
Nenue@84 117 if IsLoggedIn() and not self.intialized then
Nenue@84 118 self:Setup()
Nenue@90 119 self.intialized = true
Nenue@90 120 print('popping init sequence', self.intialized)
Nenue@90 121 end
Nenue@90 122
Nenue@90 123
Nenue@90 124 if self.intialized then
Nenue@90 125 local addon = ...
Nenue@90 126 if self.AddOnCheck[addon] then
Nenue@90 127 print(' - setting up '..addon..' dependent modules:')
Nenue@90 128 local keepChecking = false
Nenue@90 129 for index, handler in ipairs(self.AddOnCheck[addon]) do
Nenue@90 130 print(' -', handler:GetName(), (not handler.initialized) and (handler.addonFrame and not _G[handler.addonFrame]))
Nenue@90 131 if not handler.initialized then
Nenue@90 132 print(' '..handler:GetName()..':Setup()')
Nenue@90 133 handler:Setup()
Nenue@90 134 handler.initialized = true
Nenue@90 135 end
Nenue@90 136 end
Nenue@90 137 if not keepChecking then
Nenue@90 138 self.AddOnCheck[addon] = nil
Nenue@90 139 end
Nenue@90 140 end
Nenue@84 141 end
Nenue@84 142 end
Nenue@84 143 end
Nenue@84 144
Nenue@84 145 function VeneerCore:OnDragStart()
Nenue@84 146 self:StartMoving()
Nenue@84 147 end
Nenue@84 148
Nenue@84 149 function VeneerCore:OnDragStop()
Nenue@84 150 self:StopMovingOrSizing()
Nenue@84 151 end
Nenue@84 152
Nenue@93 153 local VeneerModule_Setup = function(frame)
Nenue@93 154 if (not frame.addonTrigger) or select(2,IsAddOnLoaded(frame.addonTrigger)) then
Nenue@93 155 if not frame.initialized then
Nenue@93 156 frame:Setup()
Nenue@93 157 frame.initialized = true
Nenue@93 158 end
Nenue@93 159 end
Nenue@93 160 end
Nenue@93 161
Nenue@84 162 function VeneerCore:Setup ()
Nenue@90 163 local resetConfig = (not VeneerData)
Nenue@90 164 if (not VeneerData) then
Nenue@84 165 VeneerData = defaults
Nenue@90 166 VeneerData.version = VENEER_VERSION
Nenue@84 167 end
Nenue@84 168 self.data = VeneerData
Nenue@93 169 self:ExecuteOnClusters(nil, VeneerModule_Setup)
Nenue@90 170
Nenue@90 171 self.ConfigMode = VeneerData.ConfigMode
Nenue@90 172 self:UpdateConfigLayers()
Nenue@90 173 self:Reanchor()
Nenue@90 174 self:Update()
Nenue@87 175 end
Nenue@84 176
Nenue@90 177 function VeneerCore:UpdateConfigLayers()
Nenue@90 178 if VeneerData then
Nenue@90 179
Nenue@90 180 VeneerData.ConfigMode = self.ConfigMode
Nenue@90 181 end
Nenue@90 182
Nenue@90 183 self:print('Config mode '..(self.ConfigMode and '|cFF00FF00ON|r' or '|cFFFF0000OFF|r')..'.')
Nenue@90 184 self:ExecuteOnClusters(nil, function(frame)
Nenue@90 185 if frame.UpdateConfigLayers then
Nenue@90 186 frame:UpdateConfigLayers(self.ConfigMode)
Nenue@90 187 end
Nenue@90 188
Nenue@90 189
Nenue@90 190 if type(frame.ConfigLayer) == 'table' then
Nenue@90 191 for index, region in ipairs(frame.ConfigLayer) do
Nenue@90 192 print('setting', frame:GetName() .. '['.. index..']', 'to', self.ConfigMode)
Nenue@90 193
Nenue@90 194 region:SetShown(self.ConfigMode)
Nenue@90 195 end
Nenue@90 196 end
Nenue@90 197
Nenue@90 198 self.ConfigLayers[frame] = frame:IsShown()
Nenue@90 199 if self.ConfigMode then
Nenue@90 200 print(frame:GetName(), self.ConfigLayers[frame])
Nenue@90 201 frame:SetShown(self.ConfigMode)
Nenue@90 202 else
Nenue@90 203 frame:SetShown(self.ConfigLayers[frame])
Nenue@90 204 end
Nenue@90 205 end)
Nenue@90 206 end
Nenue@84 207
Nenue@93 208
Nenue@87 209 function VeneerCore:GetClusterFromArgs (...)
Nenue@87 210 local primaryAnchor
Nenue@87 211 local insertPosition
Nenue@90 212
Nenue@90 213
Nenue@90 214
Nenue@87 215 local clusterTable = self.FrameClusters
Nenue@87 216 for i = 1, select('#', ...) do
Nenue@87 217 local arg = select(i, ...)
Nenue@87 218 local argType = type(arg)
Nenue@87 219 if argType == 'string' then
Nenue@87 220 if not primaryAnchor then
Nenue@87 221 primaryAnchor = arg
Nenue@87 222 end
Nenue@87 223 clusterTable[arg] = clusterTable[arg] or {}
Nenue@87 224 clusterTable = clusterTable[arg]
Nenue@93 225 print(strrep(' ', i)..'anchor cluster', i, arg)
Nenue@87 226 elseif argType == 'boolean' then
Nenue@87 227 insertPosition = 1
Nenue@87 228 end
Nenue@87 229 end
Nenue@87 230 if not primaryAnchor then
Nenue@87 231 primaryAnchor = 'TOPLEFT'
Nenue@87 232 end
Nenue@87 233 if not insertPosition then
Nenue@87 234 insertPosition = #clusterTable + 1
Nenue@87 235 end
Nenue@87 236 return primaryAnchor, clusterTable, insertPosition
Nenue@84 237 end
Nenue@84 238
Nenue@84 239 function VeneerCore:AddHandler(handler, ...)
Nenue@84 240 print('*** Adding handler:', handler.moduleName or handler:GetName())
Nenue@87 241
Nenue@90 242
Nenue@90 243 local anchorGroup, clusterTable, clusterIndex = self:GetClusterFromArgs(...)
Nenue@90 244 if clusterIndex == 1 then
Nenue@90 245 for i, frame in ipairs(clusterTable) do
Nenue@90 246 frame.clusterIndex = i + 1
Nenue@90 247 end
Nenue@87 248 end
Nenue@90 249 tinsert(clusterTable, clusterIndex, handler)
Nenue@90 250
Nenue@87 251 print('cluster', anchorGroup, 'table', clusterTable, 'position', clusterIndex)
Nenue@87 252
Nenue@87 253 handler.anchorCluster = clusterTable
Nenue@87 254 handler.anchorIndex = clusterIndex
Nenue@84 255 for k,v in pairs(VeneerHandlerMixin) do
Nenue@84 256 if not handler[k] then
Nenue@87 257 print(' * from mixin:', k)
Nenue@84 258 handler[k] = v
Nenue@84 259 end
Nenue@84 260 end
Nenue@90 261
Nenue@90 262 if handler.addonTrigger and not IsAddOnLoaded(handler.addonTrigger) then
Nenue@90 263 print('|cFFFF4400 -- dependency:', handler.addonTrigger)
Nenue@90 264 self.AddOnCheck[handler.addonTrigger] = self.AddOnCheck[handler.addonTrigger] or {}
Nenue@90 265 tinsert(self.AddOnCheck[handler.addonTrigger], handler)
Nenue@90 266 end
Nenue@90 267
Nenue@87 268 if self.initialized then
Nenue@90 269 print(' -- initialization check')
Nenue@90 270 if handler.Setup then
Nenue@90 271 local doInit = (not handler.initialized)
Nenue@90 272 if handler.addonTrigger and not IsAddOnLoaded(handler.addonTrigger) then
Nenue@90 273 doInit = false
Nenue@90 274 end
Nenue@90 275 -- room to add other checks
Nenue@90 276
Nenue@90 277 if doInit then
Nenue@90 278 handler:Setup()
Nenue@90 279 handler.initialized = true
Nenue@90 280 self:InternalReanchor(handler)
Nenue@90 281 end
Nenue@87 282 end
Nenue@87 283 end
Nenue@87 284 end
Nenue@87 285
Nenue@87 286 function VeneerCore:Reanchor()
Nenue@87 287 self:ExecuteOnClusters(nil, 'Reanchor')
Nenue@88 288 self:DynamicReanchor(self)
Nenue@87 289 end
Nenue@87 290
Nenue@87 291 function VeneerCore:Update()
Nenue@90 292 self:ExecuteOnClusters(nil, function(frame)
Nenue@90 293 if frame.initialized and frame.Update then
Nenue@90 294 frame:Update()
Nenue@90 295 end
Nenue@90 296 end)
Nenue@88 297 self:Reanchor()
Nenue@87 298 end
Nenue@87 299
Nenue@87 300 -- updates anchor relations to and from the target handler
Nenue@87 301 function VeneerCore:GetAnchor(...)
Nenue@87 302
Nenue@87 303 end
Nenue@87 304
Nenue@88 305 -- Evaluates frames visibility and chains them accordingly
Nenue@88 306
Nenue@88 307 function VeneerCore:DynamicReanchor(parent)
Nenue@88 308 parent = parent or self
Nenue@88 309 print('|cFF88FF00DynamicReanchor()')
Nenue@88 310 for anchorPoint, cluster in pairs(parent.FrameClusters) do
Nenue@88 311 local lastFrame
Nenue@88 312 for index, frame in ipairs(cluster) do
Nenue@90 313 print(' |cFF00FF00'..index, frame:GetName(), frame:IsVisible(), (lastFrame and ('|cFFFFFF00'..lastFrame:GetName()..'|r') or '|cFF00FFFFUIParent'))
Nenue@88 314 if frame:IsVisible() then
Nenue@90 315
Nenue@90 316 if frame.anchorFrame then
Nenue@90 317 frame:SetPoint(frame.anchorPoint, frame.anchorFrame, frame.anchorFrom, frame.anchorX, frame.anchorY)
Nenue@90 318 print(frame:GetTop(), frame:GetRight())
Nenue@88 319 else
Nenue@90 320 anchorPoint = frame.anchorPoint
Nenue@90 321 frame:ClearAllPoints()
Nenue@90 322 if lastFrame then
Nenue@90 323 frame:SetPoint(anchorPoint, lastFrame, ANCHOR_OFFSET_POINT[anchorPoint], 0, 0)
Nenue@90 324 else
Nenue@90 325 frame:SetPoint(anchorPoint, UIParent, anchorPoint, frame.anchorX, frame.anchorY)
Nenue@90 326 end
Nenue@90 327 print(frame:GetTop(), frame:GetRight())
Nenue@90 328 lastFrame = frame
Nenue@88 329 end
Nenue@90 330
Nenue@88 331 end
Nenue@88 332
Nenue@88 333 end
Nenue@88 334 end
Nenue@88 335 end
Nenue@88 336
Nenue@88 337 -- Evaluates the current visibility state and re-anchors adjacent blocks accordingly
Nenue@87 338 function VeneerCore:InternalReanchor(handler, printFunc)
Nenue@87 339 print('|cFF00FFFFVeneer:InternalReanchor('..handler:GetName()..')')
Nenue@90 340 if handler.anchorFrame then
Nenue@90 341 handler:SetPoint(handler.anchorPoint, handler.anchorFrame, handler.anchorFrom, handler.anchorX, handler.anchorY)
Nenue@90 342 return
Nenue@90 343 end
Nenue@90 344
Nenue@90 345
Nenue@87 346 local anchorPoint = handler.anchorPath or handler.anchorPoint
Nenue@87 347 local anchorParent, anchorTo = UIParent, anchorPoint
Nenue@88 348 local subPoint, subTo
Nenue@88 349 local nextFrame
Nenue@88 350 for index, frame in ipairs(handler.anchorCluster) do
Nenue@88 351 print(' |cFF00FF00'..index, frame:GetName(), frame:IsVisible())
Nenue@88 352 if frame:IsVisible() then
Nenue@88 353 if frame ~= handler then
Nenue@88 354 anchorParent = frame
Nenue@88 355 anchorTo = ANCHOR_OFFSET_POINT[anchorPoint]
Nenue@87 356
Nenue@88 357 else
Nenue@88 358 nextFrame = handler.anchorCluster[index+1]
Nenue@88 359 if nextFrame then
Nenue@88 360
Nenue@88 361 subPoint = nextFrame.anchorPath or nextFrame.anchorPoint
Nenue@88 362 subTo = ANCHOR_OFFSET_POINT[subPoint]
Nenue@88 363 nextFrame:ClearAllPoints()
Nenue@88 364 nextFrame:SetPoint(subPoint, handler, subTo, 0, 0)
Nenue@88 365 print(' -- pushing '..nextFrame:GetName()..' down the anchor chain', subPoint, subTo)
Nenue@88 366 end
Nenue@88 367 break
Nenue@87 368 end
Nenue@87 369 end
Nenue@87 370 end
Nenue@87 371
Nenue@88 372 if handler:IsVisible() then
Nenue@88 373 handler:SetPoint(anchorPoint, anchorParent, anchorTo, 0, 0)
Nenue@88 374 else
Nenue@88 375 if anchorParent and nextFrame then
Nenue@88 376 nextFrame:SetPoint(subPoint, handler, subTo, 0, 0)
Nenue@88 377 end
Nenue@88 378 end
Nenue@88 379
Nenue@87 380
Nenue@87 381 print(handler.anchorPoint, anchorParent, anchorTo)
Nenue@87 382 if printFunc then
Nenue@87 383 printFunc('|cFF88FF00'..handler:GetName()..':SetPoint(', handler.anchorPoint, anchorParent, anchorTo)
Nenue@87 384 end
Nenue@88 385 end
Nenue@87 386
Nenue@88 387 function VeneerCore:SlideBlock(frame, ...)
Nenue@89 388 local aX, aY = frame:GetLeft(), frame:GetTop()
Nenue@88 389
Nenue@89 390 frame:SetPoint('TOPLEFT', frame, 'BOTTOMLEFT', aX, aY)
Nenue@89 391 frame.animation = frame.animation or {}
Nenue@89 392 frame.animation.startX = aX
Nenue@89 393 frame.animation.startY = aY
Nenue@88 394
Nenue@89 395 local targetPoint, targetParent, targetAnchor, offsetX, offsetY = ...
Nenue@89 396 frame.BlockSlide:SetScript('OnFinished', function()
Nenue@89 397 frame:SetPoint(targetPoint, targetParent, targetAnchor, offsetX, offsetY)
Nenue@89 398 VeneerAnimationMixin.OnFinished(frame)
Nenue@89 399 end)
Nenue@88 400
Nenue@84 401 end
Nenue@84 402
Nenue@88 403
Nenue@84 404 function VeneerCore:ExecuteOnClusters(layer, method)
Nenue@84 405 self.parserDepth = self.parserDepth + 1
Nenue@84 406 if not layer then
Nenue@87 407 if self.parserDepth > 1 then
Nenue@84 408 tinsert(self.pendingCalls, method)
Nenue@84 409 print('delaying walk for', method)
Nenue@84 410 return
Nenue@84 411 end
Nenue@90 412 print('|cFF00FF00Veneer:ExecuteOnClusters|r('..tostring(layer)..', '..tostring(method)..')')
Nenue@84 413 else
Nenue@87 414 print(' Level '..self.parserDepth)
Nenue@84 415 end
Nenue@87 416
Nenue@87 417 layer = layer or self.FrameClusters
Nenue@84 418 for anchor, cluster in pairs(layer) do
Nenue@84 419 for index, frame in ipairs(cluster) do
Nenue@87 420 print(' '..anchor..'.'..index..' = '..frame:GetName())
Nenue@90 421 if type(method) == 'function' then
Nenue@90 422 method(frame, true)
Nenue@90 423 elseif frame[method] then
Nenue@87 424 print(' |cFF00FF00'..frame:GetName())
Nenue@87 425 frame[method](frame, true)
Nenue@84 426 end
Nenue@84 427 end
Nenue@84 428 if cluster.FrameClusters then
Nenue@84 429 self:ExecuteOnClusters(cluster.FrameClusters, method)
Nenue@84 430 end
Nenue@84 431 end
Nenue@84 432 self.parserDepth = self.parserDepth - 1
Nenue@84 433
Nenue@84 434 if (self.parserDepth == 0) and (#self.pendingCalls >= 1) then
Nenue@84 435 local delayedMethod = tremove(self.pendingCalls, 1)
Nenue@84 436 print('starting delayed walk for', delayedMethod)
Nenue@84 437 self:ExecuteOnClusters(nil, delayedMethod)
Nenue@84 438 end
Nenue@84 439 end
Nenue@84 440
Nenue@72 441
Nenue@71 442
Nenue@88 443 -- Takes frame handle and assigns a block to it
Nenue@84 444 function VeneerCore:Acquire (frame, template)
Nenue@71 445 if not frame then
Nenue@71 446 print('|cFFFF4400Unable to acquire frame...|r')
Nenue@71 447 return
Nenue@71 448 end
Nenue@84 449 local veneer = self.Frames[frame]
Nenue@84 450 if not veneer then
Nenue@94 451 local name = GetAnonymousName()
Nenue@94 452 veneer = CreateFrame('Frame', name, frame, template)
Nenue@90 453 print(self:GetName()..':Acquire()', frame:GetName(), template)
Nenue@71 454
Nenue@84 455 veneer:SetAllPoints(frame)
Nenue@84 456 veneer:SetParent(frame)
Nenue@84 457 veneer.label:SetText(name)
Nenue@84 458 veneer.bg:SetColorTexture(0,0,0,0)
Nenue@84 459 veneer:Hide()
Nenue@84 460 veneer:EnableMouse(false)
Nenue@84 461 -- find current X/Y
Nenue@84 462 veneer.currentLeft = frame:GetLeft()
Nenue@84 463 veneer.currentTop = frame:GetTop()
Nenue@84 464 self.Frames[frame] = veneer
Nenue@71 465 end
Nenue@84 466 return veneer
Nenue@88 467 end