Blizzard_MapCanvas/Blizzard_MapCanvas.lua

Compare Download

Blizzard_MapCanvas/Blizzard_MapCanvas.lua (9.0.2.37474; unchanged since 9.0.2.36665)
  1. MapCanvasMixin = CreateFromMixins(CallbackRegistryMixin);
  3. MapCanvasMixin.MouseAction = { Up = 1, Down = 2, Click = 3 };
  5. function MapCanvasMixin:OnLoad()
  6. CallbackRegistryMixin.OnLoad(self);
  7. self:SetUndefinedEventsAllowed(true);
  9. self.detailLayerPool = CreateFramePool("FRAME", self:GetCanvas(), "MapCanvasDetailLayerTemplate");
  10. self.dataProviders = {};
  11. self.dataProviderEventsCount = {};
  12. self.pinPools = {};
  13. self.pinTemplateTypes = {};
  14. self.activeAreaTriggers = {};
  15. self.lockReasons = {};
  16. self.pinsToNudge = {};
  17. self.pinFrameLevelsManager = CreateFromMixins(MapCanvasPinFrameLevelsManagerMixin);
  18. self.pinFrameLevelsManager:Initialize();
  19. self.mouseClickHandlers = {};
  20. self.globalPinMouseActionHandlers = {};
  21. self.cursorHandlers = {};
  23. self:EvaluateLockReasons();
  25. self.debugAreaTriggers = false;
  26. end
  28. function MapCanvasMixin:OnUpdate()
  29. self:UpdatePinNudging();
  30. self:ProcessCursorHandlers();
  31. end
  33. function MapCanvasMixin:SetMapID(mapID)
  34. if Kiosk.IsEnabled() and KioskFrame:HasWhitelistedMaps() then
  35. local mapIDs = KioskFrame:GetWhitelistedMapIDs();
  36. if not tContains(mapIDs, mapID) then
  37. if not self.mapID then
  38. -- Initialize to an allowed map and assert. Using whitelisted maps is only
  39. -- suitable if we know exactly the maps the player should be in.
  40. assert(false, "Map ID "..mapID.." is not amongst the whitelisted maps.");
  41. mapID = mapIDs[1];
  42. else
  43. -- Not in our list, so don't change the map.
  44. return;
  45. end;
  46. end
  47. end
  49. local mapArtID = C_Map.GetMapArtID(mapID) -- phased map art may be different for the same mapID
  50. if self.mapID ~= mapID or self.mapArtID ~= mapArtID then
  51. self.areDetailLayersDirty = true;
  52. self.mapID = mapID;
  53. self.mapArtID = mapArtID;
  54. self.expandedMapInsetsByMapID = {};
  55. self.ScrollContainer:SetMapID(mapID);
  56. if self:IsShown() then
  57. self:RefreshDetailLayers();
  58. end
  59. self:OnMapChanged();
  60. end
  61. end
  63. function MapCanvasMixin:OnFrameSizeChanged()
  64. self.ScrollContainer:OnCanvasSizeChanged();
  65. end
  67. function MapCanvasMixin:GetMapID()
  68. -- normally the mapID is set in OnShow, however if the player has never opened the quest log or the map, and then
  69. -- hides the UI, and while the UI is hidden opens the quest log, mapID will be nil and we get a lua error.
  70. -- under these very rare circumstances, dig out the diplayable mapID.
  71. return self.mapID or MapUtil.GetDisplayableMapForPlayer();
  72. end
  74. function MapCanvasMixin:SetMapInsetPool(mapInsetPool)
  75. self.mapInsetPool = mapInsetPool;
  76. end
  78. function MapCanvasMixin:GetMapInsetPool()
  79. return self.mapInsetPool;
  80. end
  82. function MapCanvasMixin:OnShow()
  83. local FROM_ON_SHOW = true;
  84. self:RefreshAll(FROM_ON_SHOW);
  86. for dataProvider in pairs(self.dataProviders) do
  87. dataProvider:OnShow();
  88. end
  89. end
  91. function MapCanvasMixin:OnHide()
  92. for dataProvider in pairs(self.dataProviders) do
  93. dataProvider:OnHide();
  94. end
  95. end
  97. function MapCanvasMixin:OnEvent(event, ...)
  98. -- Data provider event
  99. for dataProvider in pairs(self.dataProviders) do
  100. dataProvider:SignalEvent(event, ...);
  101. end
  102. end
  104. function MapCanvasMixin:AddDataProvider(dataProvider)
  105. self.dataProviders[dataProvider] = true;
  106. dataProvider:OnAdded(self);
  107. end
  109. function MapCanvasMixin:RemoveDataProvider(dataProvider)
  110. dataProvider:RemoveAllData();
  111. self.dataProviders[dataProvider] = nil;
  112. dataProvider:OnRemoved(self);
  113. end
  115. function MapCanvasMixin:AddDataProviderEvent(event)
  116. self.dataProviderEventsCount[event] = (self.dataProviderEventsCount[event] or 0) + 1;
  117. self:RegisterEvent(event);
  118. end
  120. function MapCanvasMixin:RemoveDataProviderEvent(event)
  121. if self.dataProviderEventsCount[event] then
  122. self.dataProviderEventsCount[event] = self.dataProviderEventsCount[event] - 1;
  123. if self.dataProviderEventsCount[event] == 0 then
  124. self.dataProviderEventsCount[event] = nil;
  125. self:UnregisterEvent(event);
  126. end
  127. end
  128. end
  130. function MapCanvasMixin:SetPinNudgingDirty(dirty)
  131. self.pinNudgingDirty = dirty;
  132. end
  134. do
  135. local function OnPinReleased(pinPool, pin)
  136. FramePool_HideAndClearAnchors(pinPool, pin);
  137. pin:OnReleased();
  139. pin.pinTemplate = nil;
  140. pin.owningMap = nil;
  141. end
  143. local function OnPinMouseUp(pin, button, upInside)
  144. pin:OnMouseUp(button);
  145. if upInside then
  146. pin:OnClick(button);
  147. end
  148. end
  150. function MapCanvasMixin:AcquirePin(pinTemplate, ...)
  151. if not self.pinPools[pinTemplate] then
  152. local pinTemplateType = self.pinTemplateTypes[pinTemplate] or "FRAME";
  153. self.pinPools[pinTemplate] = CreateFramePool(pinTemplateType, self:GetCanvas(), pinTemplate, OnPinReleased);
  154. end
  156. local pin, newPin = self.pinPools[pinTemplate]:Acquire();
  158. if newPin then
  159. local isMouseClickEnabled = pin:IsMouseClickEnabled();
  160. local isMouseMotionEnabled = pin:IsMouseMotionEnabled();
  162. if isMouseClickEnabled then
  163. pin:SetScript("OnMouseUp", OnPinMouseUp);
  164. pin:SetScript("OnMouseDown", pin.OnMouseDown);
  165. end
  167. if isMouseMotionEnabled then
  168. if newPin then
  169. -- These will never be called, just define a OnMouseEnter and OnMouseLeave on the pin mixin and it'll be called when appropriate
  170. assert(pin:GetScript("OnEnter") == nil);
  171. assert(pin:GetScript("OnLeave") == nil);
  172. end
  173. pin:SetScript("OnEnter", pin.OnMouseEnter);
  174. pin:SetScript("OnLeave", pin.OnMouseLeave);
  175. end
  177. pin:SetMouseClickEnabled(isMouseClickEnabled);
  178. pin:SetMouseMotionEnabled(isMouseMotionEnabled);
  179. end
  181. pin.pinTemplate = pinTemplate;
  182. pin.owningMap = self;
  184. if newPin then
  185. pin:OnLoad();
  186. end
  188. self.ScrollContainer:MarkCanvasDirty();
  189. pin:Show();
  190. pin:OnAcquired(...);
  192. return pin;
  193. end
  194. end
  196. function MapCanvasMixin:SetPinTemplateType(pinTemplate, pinTemplateType)
  197. self.pinTemplateTypes[pinTemplate] = pinTemplateType;
  198. end
  200. function MapCanvasMixin:RemoveAllPinsByTemplate(pinTemplate)
  201. if self.pinPools[pinTemplate] then
  202. self.pinPools[pinTemplate]:ReleaseAll();
  203. self.ScrollContainer:MarkCanvasDirty();
  204. end
  205. end
  207. function MapCanvasMixin:RemovePin(pin)
  208. if pin:GetNudgeSourceRadius() > 0 then
  209. self.pinNudgingDirty = true;
  210. end
  212. self.pinPools[pin.pinTemplate]:Release(pin);
  213. self.ScrollContainer:MarkCanvasDirty();
  214. end
  216. function MapCanvasMixin:EnumeratePinsByTemplate(pinTemplate)
  217. if self.pinPools[pinTemplate] then
  218. return self.pinPools[pinTemplate]:EnumerateActive();
  219. end
  220. return nop;
  221. end
  223. function MapCanvasMixin:GetNumActivePinsByTemplate(pinTemplate)
  224. if self.pinPools[pinTemplate] then
  225. return self.pinPools[pinTemplate]:GetNumActive();
  226. end
  227. return 0;
  228. end
  230. function MapCanvasMixin:EnumerateAllPins()
  231. local currentPoolKey, currentPool = next(self.pinPools, nil);
  232. local currentPin = nil;
  233. return function()
  234. if currentPool then
  235. currentPin = currentPool:GetNextActive(currentPin);
  236. while not currentPin do
  237. currentPoolKey, currentPool = next(self.pinPools, currentPoolKey);
  238. if currentPool then
  239. currentPin = currentPool:GetNextActive();
  240. else
  241. break;
  242. end
  243. end
  244. end
  246. return currentPin;
  247. end, nil;
  248. end
  250. function MapCanvasMixin:AcquireAreaTrigger(namespace)
  251. if not self.activeAreaTriggers[namespace] then
  252. self.activeAreaTriggers[namespace] = {};
  253. end
  254. local areaTrigger = CreateRectangle();
  255. areaTrigger.enclosed = false;
  256. areaTrigger.intersects = false;
  258. areaTrigger.intersectCallback = nil;
  259. areaTrigger.enclosedCallback = nil;
  260. areaTrigger.triggerPredicate = nil;
  262. self.activeAreaTriggers[namespace][areaTrigger] = true;
  263. self.ScrollContainer:MarkAreaTriggersDirty();
  264. return areaTrigger;
  265. end
  267. function MapCanvasMixin:SetAreaTriggerEnclosedCallback(areaTrigger, enclosedCallback)
  268. areaTrigger.enclosedCallback = enclosedCallback;
  269. self.ScrollContainer:MarkAreaTriggersDirty();
  270. end
  272. function MapCanvasMixin:SetAreaTriggerIntersectsCallback(areaTrigger, intersectCallback)
  273. areaTrigger.intersectCallback = intersectCallback;
  274. self.ScrollContainer:MarkAreaTriggersDirty();
  275. end
  277. function MapCanvasMixin:SetAreaTriggerPredicate(areaTrigger, triggerPredicate)
  278. areaTrigger.triggerPredicate = triggerPredicate;
  279. self.ScrollContainer:MarkAreaTriggersDirty();
  280. end
  282. function MapCanvasMixin:ReleaseAreaTriggers(namespace)
  283. self.activeAreaTriggers[namespace] = nil;
  284. self:TryRefreshingDebugAreaTriggers();
  285. end
  287. function MapCanvasMixin:ReleaseAreaTrigger(namespace, areaTrigger)
  288. if self.activeAreaTriggers[namespace] then
  289. self.activeAreaTriggers[namespace][areaTrigger] = nil;
  290. self:TryRefreshingDebugAreaTriggers();
  291. end
  292. end
  294. function MapCanvasMixin:UpdateAreaTriggers(scrollRect)
  295. for namespace, areaTriggers in pairs(self.activeAreaTriggers) do
  296. for areaTrigger in pairs(areaTriggers) do
  297. if areaTrigger.intersectCallback then
  298. local intersects = (not areaTrigger.triggerPredicate or areaTrigger.triggerPredicate(areaTrigger)) and scrollRect:IntersectsRect(areaTrigger);
  299. if areaTrigger.intersects ~= intersects then
  300. areaTrigger.intersects = intersects;
  301. areaTrigger.intersectCallback(areaTrigger, intersects);
  302. end
  303. end
  305. if areaTrigger.enclosedCallback then
  306. local enclosed = (not areaTrigger.triggerPredicate or areaTrigger.triggerPredicate(areaTrigger)) and scrollRect:EnclosesRect(areaTrigger);
  308. if areaTrigger.enclosed ~= enclosed then
  309. areaTrigger.enclosed = enclosed;
  310. areaTrigger.enclosedCallback(areaTrigger, enclosed);
  311. end
  312. end
  313. end
  314. end
  316. self:TryRefreshingDebugAreaTriggers();
  317. end
  319. function SquaredDistanceBetweenPoints(firstX, firstY, secondX, secondY)
  320. local xDiff = firstX - secondX;
  321. local yDiff = firstY - secondY;
  323. return xDiff * xDiff + yDiff * yDiff;
  324. end
  326. function MapCanvasMixin:CalculatePinNudging(targetPin)
  327. targetPin:SetNudgeVector(nil, nil, nil, nil);
  328. if not targetPin:IgnoresNudging() and targetPin:GetNudgeTargetFactor() > 0 then
  329. local normalizedX, normalizedY = targetPin:GetPosition();
  330. for sourcePin in self:EnumerateAllPins() do
  331. if targetPin ~= sourcePin and not sourcePin:IgnoresNudging() and sourcePin:GetNudgeSourceRadius() > 0 then
  332. local otherNormalizedX, otherNormalizedY = sourcePin:GetPosition();
  333. local distanceSquared = SquaredDistanceBetweenPoints(normalizedX, normalizedY, otherNormalizedX, otherNormalizedY);
  335. local nudgeFactor = targetPin:GetNudgeTargetFactor() * sourcePin:GetNudgeSourceRadius();
  336. if distanceSquared < nudgeFactor * nudgeFactor then
  337. local distance = math.sqrt(distanceSquared);
  339. -- Avoid divide by zero: just push it right.
  340. if distanceSquared == 0 then
  341. targetPin:SetNudgeVector(sourcePin:GetNudgeSourceZoomedOutMagnitude(), sourcePin:GetNudgeSourceZoomedInMagnitude(), 1, 0);
  342. else
  343. targetPin:SetNudgeVector(sourcePin:GetNudgeSourceZoomedOutMagnitude(), sourcePin:GetNudgeSourceZoomedInMagnitude(), (normalizedX - otherNormalizedX) / distance, (normalizedY - otherNormalizedY) / distance);
  344. end
  346. targetPin:SetNudgeFactor(1 - (distance / nudgeFactor));
  347. break; -- This is non-exact: each target pin only gets pushed by one source pin.
  348. end
  349. end
  350. end
  351. end
  352. end
  354. function MapCanvasMixin:UpdatePinNudging()
  355. if not self.pinNudgingDirty and #self.pinsToNudge == 0 then
  356. return;
  357. end
  359. if self.pinNudgingDirty then
  360. for targetPin in self:EnumerateAllPins() do
  361. self:CalculatePinNudging(targetPin);
  362. end
  363. else
  364. for _, targetPin in ipairs(self.pinsToNudge) do
  365. self:CalculatePinNudging(targetPin);
  366. end
  367. end
  369. self.pinNudgingDirty = false;
  370. self.pinsToNudge = {};
  371. end
  373. function MapCanvasMixin:TryRefreshingDebugAreaTriggers()
  374. if self.debugAreaTriggers then
  375. self:RefreshDebugAreaTriggers();
  376. elseif self.debugAreaTriggerPool then
  377. self.debugAreaTriggerPool:ReleaseAll();
  378. end
  379. end
  381. function MapCanvasMixin:RefreshDebugAreaTriggers()
  382. if not self.debugAreaTriggerPool then
  383. self.debugAreaTriggerPool = CreateTexturePool(self:GetCanvas(), "OVERLAY", 7, "MapCanvasDebugTriggerAreaTemplate");
  384. self.debugAreaTriggerColors = {};
  385. end
  387. self.debugAreaTriggerPool:ReleaseAll();
  389. local canvas = self:GetCanvas();
  391. for namespace, areaTriggers in pairs(self.activeAreaTriggers) do
  392. if not self.debugAreaTriggerColors[namespace] then
  393. self.debugAreaTriggerColors[namespace] = { math.random(), math.random(), math.random(), 0.45 };
  394. end
  395. for areaTrigger in pairs(areaTriggers) do
  396. local debugAreaTexture = self.debugAreaTriggerPool:Acquire();
  397. debugAreaTexture:SetPoint("TOPLEFT", canvas, "TOPLEFT", canvas:GetWidth() * areaTrigger:GetLeft(), -canvas:GetHeight() * areaTrigger:GetTop());
  398. debugAreaTexture:SetPoint("BOTTOMRIGHT", canvas, "TOPLEFT", canvas:GetWidth() * areaTrigger:GetRight(), -canvas:GetHeight() * areaTrigger:GetBottom());
  399. debugAreaTexture:SetColorTexture(unpack(self.debugAreaTriggerColors[namespace]));
  400. debugAreaTexture:Show();
  401. end
  402. end
  403. end
  405. function MapCanvasMixin:SetDebugAreaTriggersEnabled(enabled)
  406. self.debugAreaTriggers = enabled;
  407. self.ScrollContainer:MarkAreaTriggersDirty();
  408. end
  410. function MapCanvasMixin:ForceRefreshDetailLayers()
  411. self.areDetailLayersDirty = true;
  412. self:RefreshDetailLayers();
  413. end
  415. function MapCanvasMixin:RefreshDetailLayers()
  416. if not self.areDetailLayersDirty then return end;
  417. self.detailLayerPool:ReleaseAll();
  419. local layers = C_Map.GetMapArtLayers(self.mapID);
  420. for layerIndex, layerInfo in ipairs(layers) do
  421. local detailLayer = self.detailLayerPool:Acquire();
  422. detailLayer:SetAllPoints(self:GetCanvas());
  423. detailLayer:SetMapAndLayer(self.mapID, layerIndex, self);
  424. detailLayer:SetGlobalAlpha(self:GetGlobalAlpha());
  425. detailLayer:Show();
  426. end
  428. self:AdjustDetailLayerAlpha();
  430. self.areDetailLayersDirty = false;
  431. end
  433. function MapCanvasMixin:AreDetailLayersLoaded()
  434. for detailLayer in self.detailLayerPool:EnumerateActive() do
  435. if not detailLayer:IsFullyLoaded() then
  436. return false;
  437. end
  438. end
  439. return true;
  440. end
  442. function MapCanvasMixin:AdjustDetailLayerAlpha()
  443. self.ScrollContainer:AdjustDetailLayerAlpha(self.detailLayerPool);
  444. end
  446. function MapCanvasMixin:RefreshAllDataProviders(fromOnShow)
  447. for dataProvider in pairs(self.dataProviders) do
  448. dataProvider:RefreshAllData(fromOnShow);
  449. end
  450. end
  452. function MapCanvasMixin:ResetInsets()
  453. if self.mapInsetPool then
  454. self.mapInsetPool:ReleaseAll();
  455. self.mapInsetsByIndex = {};
  456. end
  457. end
  459. function MapCanvasMixin:RefreshInsets()
  460. self:ResetInsets();
  461. end
  463. function MapCanvasMixin:AddInset(insetIndex, mapID, title, description, collapsedIcon, numDetailTiles, normalizedX, normalizedY)
  464. if self.mapInsetPool then
  465. local mapInset = self.mapInsetPool:Acquire();
  466. local expanded = self.expandedMapInsetsByMapID[mapID];
  467. mapInset:Initialize(self, not expanded, insetIndex, mapID, title, description, collapsedIcon, numDetailTiles, normalizedX, normalizedY);
  469. self.mapInsetsByIndex[insetIndex] = mapInset;
  470. end
  471. end
  473. function MapCanvasMixin:RefreshAll(fromOnShow)
  474. self:RefreshDetailLayers();
  475. self:RefreshInsets();
  476. self:RefreshAllDataProviders(fromOnShow);
  477. end
  479. function MapCanvasMixin:SetPinPosition(pin, normalizedX, normalizedY, insetIndex)
  480. self:ApplyPinPosition(pin, normalizedX, normalizedY, insetIndex);
  481. if not pin:IgnoresNudging() then
  482. if pin:GetNudgeSourceRadius() > 0 then
  483. -- If we nudge other things we need to recalculate all nudging.
  484. self.pinNudgingDirty = true;
  485. else
  486. self.pinsToNudge[#self.pinsToNudge + 1] = pin;
  487. end
  488. end
  489. end
  491. function MapCanvasMixin:ApplyPinPosition(pin, normalizedX, normalizedY, insetIndex)
  492. if insetIndex then
  493. if self.mapInsetsByIndex and self.mapInsetsByIndex[insetIndex] then
  494. self.mapInsetsByIndex[insetIndex]:SetLocalPinPosition(pin, normalizedX, normalizedY);
  495. pin:ApplyFrameLevel();
  496. end
  497. else
  498. pin:ClearAllPoints();
  499. if normalizedX and normalizedY then
  500. local x = normalizedX;
  501. local y = normalizedY;
  503. local nudgeVectorX, nudgeVectorY = pin:GetNudgeVector();
  504. if nudgeVectorX and nudgeVectorY then
  505. local finalNudgeFactor = pin:GetNudgeFactor() * pin:GetNudgeTargetFactor() * pin:GetNudgeZoomFactor();
  506. x = normalizedX + nudgeVectorX * finalNudgeFactor;
  507. y = normalizedY + nudgeVectorY * finalNudgeFactor;
  508. end
  510. local canvas = self:GetCanvas();
  511. local scale = pin:GetScale();
  512. pin:SetParent(canvas);
  513. pin:ApplyFrameLevel();
  514. pin:SetPoint("CENTER", canvas, "TOPLEFT", (canvas:GetWidth() * x) / scale, -(canvas:GetHeight() * y) / scale);
  515. end
  516. end
  517. end
  519. function MapCanvasMixin:GetGlobalPosition(normalizedX, normalizedY, insetIndex)
  520. if self.mapInsetsByIndex and self.mapInsetsByIndex[insetIndex] then
  521. return self.mapInsetsByIndex[insetIndex]:GetGlobalPosition(normalizedX, normalizedY);
  522. end
  523. return normalizedX, normalizedY;
  524. end
  526. function MapCanvasMixin:GetCanvas()
  527. return self.ScrollContainer.Child;
  528. end
  530. function MapCanvasMixin:GetCanvasContainer()
  531. return self.ScrollContainer;
  532. end
  534. function MapCanvasMixin:CallMethodOnPinsAndDataProviders(methodName, ...)
  535. for dataProvider in pairs(self.dataProviders) do
  536. dataProvider[methodName](dataProvider, ...);
  537. end
  539. for pin in self:EnumerateAllPins() do
  540. pin[methodName](pin, ...);
  541. end
  542. end
  544. function MapCanvasMixin:OnMapInsetSizeChanged(mapID, mapInsetIndex, expanded)
  545. self.expandedMapInsetsByMapID[mapID] = expanded;
  546. self:CallMethodOnPinsAndDataProviders("OnMapInsetSizeChanged", mapInsetIndex, expanded);
  547. end
  549. function MapCanvasMixin:OnMapInsetMouseEnter(mapInsetIndex)
  550. self:CallMethodOnPinsAndDataProviders("OnMapInsetMouseEnter", mapInsetIndex);
  551. end
  553. function MapCanvasMixin:OnMapInsetMouseLeave(mapInsetIndex)
  554. self:CallMethodOnPinsAndDataProviders("OnMapInsetMouseLeave", mapInsetIndex);
  555. end
  557. function MapCanvasMixin:OnMapChanged()
  558. for dataProvider in pairs(self.dataProviders) do
  559. dataProvider:OnMapChanged();
  560. end
  561. end
  563. function MapCanvasMixin:OnCanvasScaleChanged()
  564. self:AdjustDetailLayerAlpha();
  566. if self.mapInsetsByIndex then
  567. for insetIndex, mapInset in pairs(self.mapInsetsByIndex) do
  568. mapInset:OnCanvasScaleChanged();
  569. end
  570. end
  572. self:CallMethodOnPinsAndDataProviders("OnCanvasScaleChanged");
  573. end
  575. function MapCanvasMixin:OnCanvasPanChanged()
  576. self:CallMethodOnPinsAndDataProviders("OnCanvasPanChanged");
  577. end
  579. function MapCanvasMixin:OnCanvasSizeChanged()
  580. self:CallMethodOnPinsAndDataProviders("OnCanvasSizeChanged");
  581. end
  583. function MapCanvasMixin:GetCanvasScale()
  584. return self.ScrollContainer:GetCanvasScale();
  585. end
  587. function MapCanvasMixin:GetCanvasZoomPercent()
  588. return self.ScrollContainer:GetCanvasZoomPercent();
  589. end
  591. function MapCanvasMixin:IsZoomingIn()
  592. return self.ScrollContainer:IsZoomingIn();
  593. end
  595. function MapCanvasMixin:IsZoomingOut()
  596. return self.ScrollContainer:IsZoomingOut();
  597. end
  599. function MapCanvasMixin:ZoomIn()
  600. self.ScrollContainer:ZoomIn();
  601. end
  603. function MapCanvasMixin:ZoomOut()
  604. self.ScrollContainer:ZoomOut();
  605. end
  607. function MapCanvasMixin:ResetZoom()
  608. self.ScrollContainer:ResetZoom();
  609. end
  611. function MapCanvasMixin:InstantPanAndZoom(scale, x, y, ignoreScaleRatio)
  612. self.ScrollContainer:InstantPanAndZoom(scale, x, y, ignoreScaleRatio);
  613. end
  615. function MapCanvasMixin:IsAtMaxZoom()
  616. return self.ScrollContainer:IsAtMaxZoom();
  617. end
  619. function MapCanvasMixin:IsAtMinZoom()
  620. return self.ScrollContainer:IsAtMinZoom();
  621. end
  623. function MapCanvasMixin:PanTo(normalizedX, normalizedY)
  624. self.ScrollContainer:SetPanTarget(normalizedX, normalizedY);
  625. end
  627. function MapCanvasMixin:PanAndZoomTo(normalizedX, normalizedY)
  628. self.ScrollContainer:SetPanTarget(normalizedX, normalizedY);
  629. self.ScrollContainer:ZoomIn();
  630. end
  632. function MapCanvasMixin:SetMouseWheelZoomMode(zoomMode)
  633. self.ScrollContainer:SetMouseWheelZoomMode(zoomMode);
  634. end
  636. function MapCanvasMixin:SetShouldZoomInOnClick(shouldZoomInOnClick)
  637. self.ScrollContainer:SetShouldZoomInOnClick(shouldZoomInOnClick);
  638. end
  640. function MapCanvasMixin:ShouldZoomInOnClick()
  641. return self.ScrollContainer:ShouldZoomInOnClick();
  642. end
  644. function MapCanvasMixin:SetShouldNavigateOnClick(shouldNavigateOnClick)
  645. self.ScrollContainer:SetShouldNavigateOnClick(shouldNavigateOnClick);
  646. end
  648. function MapCanvasMixin:ShouldNavigateOnClick()
  649. return self.ScrollContainer:ShouldNavigateOnClick();
  650. end
  652. function MapCanvasMixin:SetShouldPanOnClick(shouldPanOnClick)
  653. self.ScrollContainer:SetShouldPanOnClick(shouldPanOnClick);
  654. end
  656. function MapCanvasMixin:ShouldPanOnClick()
  657. return self.ScrollContainer:ShouldPanOnClick();
  658. end
  660. function MapCanvasMixin:SetShouldZoomInstantly(shouldZoomInstantly)
  661. self.ScrollContainer:SetShouldZoomInstantly(shouldZoomInstantly);
  662. end
  664. function MapCanvasMixin:ShouldZoomInstantly()
  665. return self.ScrollContainer:ShouldZoomInstantly();
  666. end
  668. function MapCanvasMixin:GetViewRect()
  669. return self.ScrollContainer:GetViewRect();
  670. end
  672. function MapCanvasMixin:GetMaxZoomViewRect()
  673. return self.ScrollContainer:GetMaxZoomViewRect();
  674. end
  676. function MapCanvasMixin:GetMinZoomViewRect()
  677. return self.ScrollContainer:GetMinZoomViewRect();
  678. end
  680. function MapCanvasMixin:GetScaleForMaxZoom()
  681. return self.ScrollContainer:GetScaleForMaxZoom();
  682. end
  684. function MapCanvasMixin:GetScaleForMinZoom()
  685. return self.ScrollContainer:GetScaleForMinZoom();
  686. end
  688. function MapCanvasMixin:CalculateZoomScaleAndPositionForAreaInViewRect(...)
  689. return self.ScrollContainer:CalculateZoomScaleAndPositionForAreaInViewRect(...);
  690. end
  692. function MapCanvasMixin:NormalizeHorizontalSize(size)
  693. return self.ScrollContainer:NormalizeHorizontalSize(size);
  694. end
  696. function MapCanvasMixin:DenormalizeHorizontalSize(size)
  697. return self.ScrollContainer:DenormalizeHorizontalSize(size);
  698. end
  700. function MapCanvasMixin:NormalizeVerticalSize(size)
  701. return self.ScrollContainer:NormalizeVerticalSize(size);
  702. end
  704. function MapCanvasMixin:DenormalizeVerticalSize(size)
  705. return self.ScrollContainer:DenormalizeVerticalSize(size);
  706. end
  708. function MapCanvasMixin:GetNormalizedCursorPosition()
  709. return self.ScrollContainer:GetNormalizedCursorPosition()
  710. end
  712. function MapCanvasMixin:IsCanvasMouseFocus()
  713. return self.ScrollContainer == GetMouseFocus();
  714. end
  716. function MapCanvasMixin:AddLockReason(reason)
  717. self.lockReasons[reason] = true;
  718. self:EvaluateLockReasons();
  719. end
  721. function MapCanvasMixin:RemoveLockReason(reason)
  722. self.lockReasons[reason] = nil;
  723. self:EvaluateLockReasons();
  724. end
  726. function MapCanvasMixin:EvaluateLockReasons()
  727. if next(self.lockReasons) then
  728. self.BorderFrame:EnableMouse(true);
  729. self.BorderFrame:EnableMouseWheel(true);
  730. if self.BorderFrame.Underlay then
  731. self.BorderFrame.Underlay:Show();
  732. end
  733. else
  734. self.BorderFrame:EnableMouse(false);
  735. self.BorderFrame:EnableMouseWheel(false);
  736. if self.BorderFrame.Underlay then
  737. self.BorderFrame.Underlay:Hide();
  738. end
  739. end
  740. end
  742. function MapCanvasMixin:GetPinFrameLevelsManager()
  743. return self.pinFrameLevelsManager;
  744. end
  746. function MapCanvasMixin:ReapplyPinFrameLevels(pinFrameLevelType)
  747. for pin in self:EnumerateAllPins() do
  748. if pin:GetFrameLevelType() == pinFrameLevelType then
  749. pin:ApplyFrameLevel();
  750. end
  751. end
  752. end
  754. function MapCanvasMixin:NavigateToParentMap()
  755. local mapInfo = C_Map.GetMapInfo(self:GetMapID());
  756. if mapInfo.parentMapID > 0 then
  757. self:SetMapID(mapInfo.parentMapID);
  758. end
  759. end
  761. function MapCanvasMixin:NavigateToCursor()
  762. local normalizedCursorX, normalizedCursorY = self:GetNormalizedCursorPosition();
  763. local mapInfo = C_Map.GetMapInfoAtPosition(self:GetMapID(), normalizedCursorX, normalizedCursorY);
  764. if mapInfo then
  765. self:SetMapID(mapInfo.mapID);
  766. end
  767. end
  769. local function PrioritySorter(left, right)
  770. return left.priority > right.priority;
  771. end
  773. -- Add a function that will be checked when the canvas is clicked
  774. -- If the function returns true then handling will stop
  775. -- A priority can optionally be specified, higher priority values will be called first
  776. function MapCanvasMixin:AddCanvasClickHandler(handler, priority)
  777. table.insert(self.mouseClickHandlers, { handler = handler, priority = priority or 0 });
  778. table.sort(self.mouseClickHandlers, PrioritySorter);
  779. end
  781. function MapCanvasMixin:RemoveCanvasClickHandler(handler, priority)
  782. for i, handlerInfo in ipairs(self.mouseClickHandlers) do
  783. if handlerInfo.handler == handler and (not priority or handlerInfo.priority == priority) then
  784. table.remove(self.mouseClickHandlers, i);
  785. break;
  786. end
  787. end
  788. end
  790. function MapCanvasMixin:ProcessCanvasClickHandlers(button, cursorX, cursorY)
  791. for i, handlerInfo in ipairs(self.mouseClickHandlers) do
  792. local success, stopChecking = xpcall(handlerInfo.handler, CallErrorHandler, self, button, cursorX, cursorY);
  793. if success and stopChecking then
  794. return true;
  795. end
  796. end
  797. return false;
  798. end
  800. -- Add a function that will be checked when any pin is clicked
  801. -- If the function returns true then handling will stop
  802. -- A priority can optionally be specified, higher priority values will be called first
  803. function MapCanvasMixin:AddGlobalPinMouseActionHandler(handler, priority)
  804. table.insert(self.globalPinMouseActionHandlers, { handler = handler, priority = priority or 0 });
  805. table.sort(self.globalPinMouseActionHandlers, PrioritySorter);
  806. end
  808. function MapCanvasMixin:RemoveGlobalPinMouseActionHandler(handler, priority)
  809. for i, handlerInfo in ipairs(self.globalPinMouseActionHandlers) do
  810. if handlerInfo.handler == handler and (not priority or handlerInfo.priority == priority) then
  811. table.remove(self.globalPinMouseActionHandlers, i);
  812. break;
  813. end
  814. end
  815. end
  817. function MapCanvasMixin:ProcessGlobalPinMouseActionHandlers(mouseAction, button)
  818. for i, handlerInfo in ipairs(self.globalPinMouseActionHandlers) do
  819. local success, stopChecking = xpcall(handlerInfo.handler, CallErrorHandler, self, mouseAction, button);
  820. if success and stopChecking then
  821. return true;
  822. end
  823. end
  824. return false;
  825. end
  827. function MapCanvasMixin:AddCursorHandler(handler, priority)
  828. table.insert(self.cursorHandlers, { handler = handler, priority = priority or 0 });
  829. table.sort(self.cursorHandlers, PrioritySorter);
  830. end
  832. function MapCanvasMixin:RemoveCursorHandler(handler, priority)
  833. for i, handlerInfo in ipairs(self.cursorHandlers) do
  834. if handlerInfo.handler == handler and (not priority or handlerInfo.priority == priority) then
  835. table.remove(self.cursorHandlers, i);
  836. break;
  837. end
  838. end
  839. end
  841. function MapCanvasMixin:ProcessCursorHandlers()
  842. local focus = GetMouseFocus();
  843. if focus then
  844. -- pins have a .owningMap, our pins should be pointing to us
  845. if focus == self.ScrollContainer or focus.owningMap == self then
  846. for i, handlerInfo in ipairs(self.cursorHandlers) do
  847. local success, cursor = xpcall(handlerInfo.handler, CallErrorHandler, self);
  848. if success and cursor then
  849. self.lastCursor = cursor;
  850. SetCursor(cursor);
  851. return;
  852. end
  853. end
  854. end
  855. end
  856. if self.lastCursor then
  857. self.lastCursor = nil;
  858. ResetCursor();
  859. end
  860. end
  862. function MapCanvasMixin:GetGlobalPinScale()
  863. return self.globalPinScale or 1;
  864. end
  866. function MapCanvasMixin:SetGlobalPinScale(scale)
  867. if self.globalPinScale ~= scale then
  868. self.globalPinScale = scale;
  869. for pin in self:EnumerateAllPins() do
  870. pin:ApplyCurrentScale();
  871. end
  872. end
  873. end
  875. function MapCanvasMixin:GetGlobalAlpha()
  876. return self.globalAlpha or 1;
  877. end
  879. function MapCanvasMixin:SetGlobalAlpha(globalAlpha)
  880. if self.globalAlpha ~= globalAlpha then
  881. self.globalAlpha = globalAlpha;
  882. for detailLayer in self.detailLayerPool:EnumerateActive() do
  883. detailLayer:SetGlobalAlpha(globalAlpha);
  884. end
  885. for dataProvider in pairs(self.dataProviders) do
  886. dataProvider:OnGlobalAlphaChanged();
  887. end
  888. end
  889. end
  891. function MapCanvasMixin:SetMaskTexture(maskTexture)
  892. if self.maskTexture then
  893. for texture, value in pairs(self.maskableTextures) do
  894. self.maskableTextures[texture] = false;
  895. texture:RemoveMaskTexture(self.maskTexture);
  896. end
  897. end
  898. self.maskTexture = maskTexture;
  899. if self.maskableTextures then
  900. self:RefreshMaskableTextures();
  901. else
  902. self.maskableTextures = { };
  903. end
  904. end
  906. function MapCanvasMixin:GetMaskTexture()
  907. return self.maskTexture;
  908. end
  910. function MapCanvasMixin:SetUseMaskTexture(useMaskTexture)
  911. if not self:GetMaskTexture() then
  912. error("Must have a mask texture");
  913. end
  914. self.useMaskTexture = useMaskTexture;
  915. self:RefreshMaskableTextures();
  916. end
  918. function MapCanvasMixin:GetUseMaskTexture()
  919. return not not self.useMaskTexture;
  920. end
  922. function MapCanvasMixin:AddMaskableTexture(texture)
  923. local maskTexture = self:GetMaskTexture();
  924. if not maskTexture then
  925. return;
  926. end
  927. if self.maskableTextures[texture] ~= nil then
  928. return;
  929. end
  931. local useMaskTexture = self:GetUseMaskTexture();
  932. self.maskableTextures[texture] = useMaskTexture;
  933. if useMaskTexture then
  934. texture:AddMaskTexture(maskTexture);
  935. end
  936. end
  938. function MapCanvasMixin:RefreshMaskableTextures()
  939. local useMaskTexture = self:GetUseMaskTexture();
  940. local maskTexture = self:GetMaskTexture();
  941. for texture, value in pairs(self.maskableTextures) do
  942. if value ~= useMaskTexture then
  943. self.maskableTextures[texture] = useMaskTexture;
  944. if useMaskTexture then
  945. texture:AddMaskTexture(maskTexture);
  946. else
  947. texture:RemoveMaskTexture(maskTexture);
  948. end
  949. end
  950. end
  951. end