annotate UI.lua @ 58:0a9a6740ea5d v2.1

- Discarded use of blizzard functions never meant for the wild (http://forums.wowace.com/showthread.php?t=20397) - Fixed dock buttons not highlighting properly - Fixed dock buttons not dropping after selection change - Mouse input is disabled during player movement
author Nenue
date Tue, 12 Jan 2016 04:50:37 -0500
parents 1b8c597dba44
children 59e047d6c5de
rev   line source
Nenue@50 1 --- Devian - UI.lua
Nenue@35 2 -- @file-author@
Nenue@35 3 -- @project-revision@ @project-hash@
Nenue@35 4 -- @file-revision@ @file-hash@
Nenue@35 5 -- Created: 12/27/2015 3:01 AM
Nenue@35 6 if not LibStub then
Nenue@35 7 print('Something has happened...')
Nenue@35 8 end
Nenue@35 9 local D = LibStub("AceAddon-3.0"):GetAddon("Devian")
Nenue@35 10 local DEVIAN_FRAME = 'DevianConsole'
Nenue@35 11
Nenue@35 12
Nenue@35 13 local function Console_MinMax(self)
Nenue@35 14 if self.minimized then
Nenue@35 15 self:Maximize()
Nenue@35 16 else
Nenue@35 17 self:Minimize()
Nenue@35 18 end
Nenue@35 19 end
Nenue@35 20
Nenue@35 21 local function Console_Minimize(self)
Nenue@35 22 self:SetHeight(20)
Nenue@35 23 self:SetMaxResize(GetScreenWidth(),20)
Nenue@35 24 self.minimized = true
Nenue@35 25 self.out:Hide()
Nenue@35 26 self:Save()
Nenue@35 27 end
Nenue@35 28
Nenue@35 29 local function Console_Maximize(self)
Nenue@35 30 local db = D.channels[self.index]
Nenue@35 31 self:SetHeight(db.height)
Nenue@35 32 self:SetMaxResize(GetScreenWidth(),GetScreenHeight())
Nenue@35 33 self.minimized = nil
Nenue@35 34 self.out:Show()
Nenue@35 35 self:Save()
Nenue@35 36 end
Nenue@35 37
Nenue@35 38
Nenue@35 39 local function Console_Save(self)
Nenue@35 40 local db = D.channels[self.index]
Nenue@35 41 db.x = self:GetLeft()
Nenue@35 42 db.y = (self:GetTop() - GetScreenHeight())
Nenue@35 43 db.width = self:GetWidth()
Nenue@35 44
Nenue@35 45 if not self.minimized then
Nenue@55 46 db.height = self:GetHeight()
Nenue@35 47 self:SetHeight(db.height)
Nenue@35 48 end
Nenue@35 49
Nenue@35 50 db.dockedTo = self.dockedTo
Nenue@35 51 db.docked = self.docked
Nenue@35 52
Nenue@35 53 db.minimized = self.minimized and true or nil
Nenue@35 54 db.enabled = self:IsVisible() and true or nil
Nenue@35 55 db.active = self.active and true or nil
Nenue@35 56 self:SetPoint('TOPLEFT', UIParent, 'TOPLEFT', db.x, db.y)
Nenue@35 57 self:SetWidth(db.width)
Nenue@35 58 end
Nenue@35 59
Nenue@35 60 --- Brings the console to the front.
Nenue@35 61 -- Frame method used to bring a console frame to the front of the display stack.
Nenue@35 62 local function Console_ToFront(c)
Nenue@35 63 local db = D.db
Nenue@35 64 c:Raise()
Nenue@35 65 c:SetAlpha(db.frontalpha)
Nenue@35 66 c.out.backdrop:SetTexture(unpack(db.frontdrop))
Nenue@35 67 c.out.backdrop:SetGradientAlpha(unpack(db.frontgrad))
Nenue@35 68 c.out.backdrop:SetBlendMode(db.frontblend)
Nenue@45 69 c.dropmenu.icon:SetVertexColor(unpack(db.frontheader))
Nenue@45 70 c.title:SetTextColor(unpack(db.frontborder))
Nenue@35 71 db.current_channel = c.index
Nenue@35 72
Nenue@50 73 -- update dock buttons
Nenue@50 74 local beacon = D.dock.buttons[c.index]
Nenue@50 75 beacon.selected = true
Nenue@58 76 beacon.newMessage = nil
Nenue@50 77 D.UpdateBeacon(beacon)
Nenue@50 78
Nenue@35 79 for _, part in pairs(c.border) do
Nenue@35 80 part:SetTexture(unpack(db.frontborder))
Nenue@35 81 end
Nenue@35 82
Nenue@35 83 for id, bc in pairs(D.console) do
Nenue@35 84 if id ~= c.index then
Nenue@35 85 bc:SetAlpha(db.backalpha)
Nenue@35 86 bc.out.backdrop:SetTexture(unpack(db.backdrop))
Nenue@35 87 bc.out.backdrop:SetGradientAlpha(unpack(db.backgrad))
Nenue@35 88 bc.out.backdrop:SetBlendMode(db.backblend)
Nenue@45 89 bc.dropmenu.icon:SetVertexColor(unpack(db.backheader))
Nenue@36 90 bc.title:SetTextColor(unpack(db.backborder))
Nenue@35 91
Nenue@50 92 local beacon = D.dock.buttons[bc.index]
Nenue@58 93 beacon.raised = nil
Nenue@58 94 beacon.showName = nil
Nenue@50 95 beacon.selected = nil
Nenue@50 96 D.UpdateBeacon(beacon)
Nenue@50 97
Nenue@35 98 for _, part in pairs(bc.border) do
Nenue@35 99 part:SetTexture(unpack(db.backborder))
Nenue@35 100 end
Nenue@35 101 end
Nenue@35 102 end
Nenue@35 103 end
Nenue@35 104
Nenue@35 105 local function Console_MouseDown(self, button, up)
Nenue@35 106 if button == 'LeftButton' then
Nenue@35 107 if up then
Nenue@35 108 self:StopMovingOrSizing()
Nenue@35 109 self:ToFront()
Nenue@35 110 self:Save()
Nenue@35 111 elseif self.out.grip:IsMouseOver() then
Nenue@35 112 self:StartSizing()
Nenue@35 113 else
Nenue@35 114 self:StartMoving()
Nenue@35 115 end
Nenue@35 116 else
Nenue@35 117 if up then
Nenue@35 118 self:MinMax()
Nenue@35 119 end
Nenue@35 120 end
Nenue@35 121 end
Nenue@35 122 local function Console_MouseUp(self, button)
Nenue@35 123 return Console_MouseDown(self, button, true)
Nenue@35 124 end
Nenue@35 125
Nenue@35 126
Nenue@35 127 --- Constructs the frame object for a console channel
Nenue@35 128 -- Initializes the console channel at a specified index.
Nenue@35 129 -- Configuration data can be overridden by passing a desired settings table.
Nenue@35 130 -- @param i Numeric index of the channel as it manifests in db.channels
Nenue@35 131 -- @param vars Optional settings table to be used.
Nenue@35 132 local function CreateConsole(i, vars)
Nenue@35 133 local db = D.db
Nenue@35 134 if tonumber(i) == nil or math.floor(i) ~= i then
Nenue@35 135 error('Non-integer index value.')
Nenue@35 136 end
Nenue@35 137 if not vars then
Nenue@35 138 vars = D.channels[i] and D.channels[i] or D.channels[db.primary_channel]
Nenue@35 139 end
Nenue@35 140 local f
Nenue@47 141 f= CreateFrame('Frame', 'DevianChannelFrame' .. i, UIParent, DEVIAN_FRAME)
Nenue@47 142
Nenue@35 143 --@debug@
Nenue@35 144 --print(f:GetName())
Nenue@35 145
Nenue@35 146 --print('create(2)')
Nenue@35 147 for k,v in pairs(vars) do
Nenue@35 148 f[k] = v
Nenue@35 149 --@debug@
Nenue@36 150 --print(' f['..type(k)..' '..tostring(k)..'] = '..type(v)..' '..tostring(v))
Nenue@35 151 end
Nenue@35 152
Nenue@35 153 f:SetPoint('TOPLEFT', UIParent, 'TOPLEFT', vars.x, vars.y)
Nenue@35 154 f:SetSize(vars.width, vars.height)
Nenue@35 155 f:Lower()
Nenue@35 156 f.out:SetFont(db.font, db.fontsize, db.fontoutline)
Nenue@35 157 if (db.current_channel == i) then
Nenue@35 158 f.out.backdrop:SetTexture(unpack(db.frontdrop))
Nenue@36 159 f.dropmenu.icon:SetVertexColor(unpack(db.headerfontcolor))
Nenue@36 160 f.title:SetTextColor(unpack(db.headerfontcolor))
Nenue@45 161 f.header:SetAlpha(db.headeralpha)
Nenue@35 162 else
Nenue@35 163 f.out.backdrop:SetTexture(unpack(db.backdrop))
Nenue@35 164 end
Nenue@35 165
Nenue@35 166 f.Save = Console_Save
Nenue@35 167 f.Minimize = Console_Minimize
Nenue@35 168 f.Maximize = Console_Maximize
Nenue@35 169 f.MinMax = Console_MinMax
Nenue@35 170 f.ToFront = Console_ToFront
Nenue@35 171 f.Toggle = D.Console_Toggle
Nenue@35 172 f:SetScript('OnMouseDown', Console_MouseDown)
Nenue@35 173 f:SetScript('OnMouseUp', Console_MouseUp)
Nenue@35 174
Nenue@36 175
Nenue@36 176 UIDropDownMenu_Initialize(f.menuFrame, function()
Nenue@36 177 local info = { {
Nenue@36 178 text= "Close",
Nenue@36 179 value = "OptClose",
Nenue@36 180 func = function ()
Nenue@36 181 f.enabled = nil
Nenue@36 182 f:Hide()
Nenue@36 183 f:Save()
Nenue@38 184 end },--[[
Nenue@36 185 {
Nenue@36 186 text = "Dock",
Nenue@36 187 value = "OptDock",
Nenue@38 188 func = function() print('Dvn', 'docking shenanary') end }]]
Nenue@36 189 }
Nenue@36 190 for _, v in ipairs(info) do
Nenue@36 191 UIDropDownMenu_AddButton(v)
Nenue@36 192 end
Nenue@36 193 end, 'MENU')
Nenue@36 194
Nenue@47 195 D.dock.buttons[i] = CreateFrame('Button', 'Channel'..i..'Beacon', UIParent, 'DevianBeacon')
Nenue@47 196 D.dock.buttons[i].icon:SetVertexColor(math.random(),math.random(),math.random())
Nenue@47 197 D.dock.buttons[i].console = f
Nenue@47 198 D.dock.buttons[i].index = i
Nenue@47 199 D.dock.buttons[i].caption.name:SetText(vars.signature)
Nenue@47 200 D.dock.buttons[i]:Show()
Nenue@47 201
Nenue@35 202 if vars.minimized then
Nenue@35 203 f:Minimize()
Nenue@35 204 else
Nenue@35 205 f:Maximize()
Nenue@35 206 end
Nenue@35 207 if db.enabled and f.enabled then
Nenue@35 208 f:Show()
Nenue@35 209 end
Nenue@35 210
Nenue@35 211 return f
Nenue@35 212 end
Nenue@35 213
Nenue@35 214
Nenue@35 215 --- Updates console information and returns the handle of the channel object that was worked on.
Nenue@35 216 -- When key is nil or not a valid handle, a new channel is created using whatever signature can be found in cinfo.
Nenue@35 217 -- The signature can be passed as a string, or as a table entry under the key 'signature'
Nenue@35 218 -- If the signature of a new channel is also a tag, the channel will be added to that tag
Nenue@35 219 -- @param cinfo string signature of a new channel, or a table of config variables to be imposed on the channel
Nenue@35 220 -- @param key string signature or index number of channel to operate on
Nenue@35 221 -- @usage channel = D:SetChannel('new', nil) -- creates a new channel
Nenue@35 222 -- @usage channel = D:SetChannel({x = 200, y = 100}, 4) -- updates channel #4
Nenue@35 223 function D:SetChannel(cinfo, key)
Nenue@35 224 local db = self.db
Nenue@35 225 local t_info = {}
Nenue@35 226 local channel, isNew, id, sig, t_id
Nenue@36 227 --@debug@
Nenue@38 228 --print('setchan(0) cinfo, key', cinfo, key)--@end-debug@
Nenue@35 229 -- obtain source data
Nenue@35 230 if tonumber(key) ~= nil and db.channels[key] then
Nenue@35 231 id = tonumber(key)
Nenue@35 232 elseif D.sigID[tostring(key)] then
Nenue@35 233 id = D.sigID[tostring(key)]
Nenue@35 234 else
Nenue@35 235 id = db.primary_channel
Nenue@35 236 isNew = true
Nenue@35 237 end
Nenue@35 238 local dbvars = db.channels[id]
Nenue@35 239 t_id = id -- overridden later if new
Nenue@35 240 t_info.index = t_id --
Nenue@35 241 --@debug@
Nenue@38 242 --print('setchan(1) cinfo, key, id=', cinfo, key, id)--@end-debug@
Nenue@35 243
Nenue@35 244
Nenue@35 245 -- obtain config info
Nenue@35 246 if type(cinfo) == 'string' then
Nenue@35 247 sig = cinfo
Nenue@35 248 cinfo = {signature = sig}
Nenue@35 249 elseif type(cinfo) ~= 'table' then -- stop here if a table wans't passed
Nenue@35 250 error('Expecting table of string as arg1')
Nenue@35 251 elseif cinfo.signature then -- new sig
Nenue@35 252 sig = cinfo.signature
Nenue@35 253 elseif isNew then -- new channel sig
Nenue@35 254 sig = 'Ch'
Nenue@35 255 else -- old sig
Nenue@35 256 sig = db.channels[id].signature
Nenue@35 257 end
Nenue@35 258 t_info.signature = sig
Nenue@35 259 --@debug@
Nenue@38 260 --print('setchan(2) sig,id,isNew=', sig, id, isNew)--@end-debug@
Nenue@35 261
Nenue@35 262 for k,v in pairs(cinfo) do -- allow all cinfo to pass
Nenue@35 263 t_info[k] = v
Nenue@35 264 end
Nenue@35 265
Nenue@35 266 local blocked = { -- ignore these vars:
Nenue@35 267 ['docked'] = true, -- table
Nenue@35 268 ['dockedTo'] = true, -- table-related
Nenue@35 269 ['signature'] = true} -- already determined
Nenue@35 270 for k,v in pairs(dbvars) do
Nenue@35 271 if not t_info[k] and not blocked[k] then -- already set or blocked?
Nenue@35 272 t_info[k] = v
Nenue@35 273 end
Nenue@35 274 end
Nenue@35 275 -- new channel overrides
Nenue@35 276 if isNew then
Nenue@35 277 if D.sigID[sig]then -- find a non-clashing signature
Nenue@35 278 local result, i = sig, 1
Nenue@35 279 while D.sigID[result] do
Nenue@35 280 result = sig .. i
Nenue@35 281 i = i + 1
Nenue@35 282 end
Nenue@35 283 t_info.signature = result
Nenue@35 284 end
Nenue@36 285 t_id = self.max_channel + 1
Nenue@35 286 t_info.index = t_id
Nenue@35 287 --@debug@
Nenue@38 288 --print('setchan(3a) t_id, isNew, sig, t_info.signature=', t_id, isNew, sig, t_info.signature)--@end-debug@
Nenue@35 289 else
Nenue@35 290 --@debug@
Nenue@38 291 --print('setchan(3b) t_id, isNew, sig, t_info.signature=', t_id, isNew, sig, t_info.signature)--@end-debug@
Nenue@35 292 end
Nenue@35 293
Nenue@35 294 local channel
Nenue@35 295 if not self.console[t_id] then -- create a frame
Nenue@35 296 if isNew then -- position the channel frame
Nenue@36 297 self.max_channel = t_id
Nenue@36 298 db.max_channel = t_id
Nenue@36 299 t_info.x = t_info.x + 20
Nenue@36 300 t_info.y = t_info.y - 20
Nenue@36 301 db.channels[t_id] = t_info
Nenue@36 302 --@debug@
Nenue@38 303 --print('setchan(4a)', 't_id, x, y=', t_id, t_info.x, t_info.y)--@end-debug@
Nenue@35 304 end
Nenue@35 305 channel = CreateConsole(t_id, t_info)
Nenue@35 306 self.console[t_id] = channel
Nenue@35 307 self.sig[t_info.signature] = channel
Nenue@35 308 self.sigID[t_info.signature] = t_id
Nenue@35 309 self.IDsig[t_id] = t_info.signature
Nenue@35 310
Nenue@35 311 end
Nenue@35 312 channel = self.console[t_id]
Nenue@35 313 if channel.minimized then
Nenue@35 314 channel:Minimize()
Nenue@35 315 else
Nenue@35 316 channel:Maximize()
Nenue@35 317 end
Nenue@35 318
Nenue@55 319 if channel.enabled then -- hide or show last since Min/Max mess with visibility
Nenue@38 320 --print('setchan(5a) enable')
Nenue@55 321 channel:Show()
Nenue@45 322 channel:ToFront()
Nenue@35 323 else
Nenue@38 324 --print('setchan(5a) disable')
Nenue@35 325 channel:Hide()
Nenue@35 326 end
Nenue@35 327 --@debug@
Nenue@35 328 --print('setchan(end); c:IsVisible(), c.enabled, db.enabled=', channel:IsVisible(), channel.enabled, db.enabled)--@end-debug@
Nenue@35 329 return channel
Nenue@35 330 end