Ticket #2414: minimapIconHover_v2_WIP.patch

binaries/data/mods/public/gui/session/session.xml

@@ -947 +947 @@
 
         <object name="minimapOverlay" size="4 4 100%-4 100%-4" type="image" sprite="stretched:session/minimap_circle_modern.png" ghost="true"/>
 
+        <!-- Score Button (deactivated until function is implemented)-->
+        <object size="100%-75 0 100% 75">
+            <object name="minimap_button[1]" size="0 0 100% 100%" type="button" ghost="true"
+            sprite="stretched:grayscale:session/icons/minimap/score_border.png"
+            sprite_over="stretched:session/icons/minimap/score_border_hover.png"
+            masked="true"
+            enabled="false">
+            </object>
+        </object>
+        
         <!-- Idle Worker Button -->
-        <object size="100%-36 100%-36 100%-5 100%-5">
-            <!-- TODO: should highlight the button if there's non-zero idle workers -->
-            <object name="idle-overlay" size="-85 -85 100% 100%" type="image" sprite="stretched:session/minimap-idle.png" ghost="true"/>
-            <!-- Since we don't support non-rectangular buttons, we approximate the area using 3 rectangles TODO: Make this cleaner -->
-            <object type="button"
-                tooltip_style="sessionToolTip"
-                tooltip="Find idle worker"
-                hotkey="selection.idleworker"
-            >
-                <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
+        <object size="100%-75 100%-75 100% 100%">
+            <object name="minimap_button[2]" size="0 0 100% 100%" type="button"
+            sprite="stretched:session/icons/minimap/idle_border.png"
+            sprite_over="stretched:session/icons/minimap/idle_border_hover.png"
+            tooltip_style="sessionToolTip"
+            tooltip="Find idle worker"
+            hotkey="selection.idleworker"
+            masked="true">
+            <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
             </object>
-            <object type="button"
-                tooltip_style="sessionToolTip"
-                tooltip="Find idle worker"
-                size="15 -15 100% 0"
-            >
-                <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
+        </object>
+        
+        <!-- Zoom Button (deactivated until function is implemented)-->
+        <object size="0 100%-75 75 100%">
+            <object name="minimap_button[3]" size="0 0 100% 100%" type="button"
+            sprite="stretched:grayscale:session/icons/minimap/zoom_border.png"
+            sprite_over="stretched:session/icons/minimap/zoom_border_hover.png" 
+            masked="true"
+            enabled="false">
             </object>
-            <object type="button"
-                tooltip_style="sessionToolTip"
-                tooltip="Find idle worker"
-                size="-15 15 0 100%"
-            >
-                <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
+        </object>
+        
+        <!-- Flare Button (deactivated until function is implemented)-->
+        <object size="0 0 75 75">
+            <object name="minimap_button[4]" size="0 0 100% 100%" type="button"
+            sprite="stretched:grayscale:session/icons/minimap/flare_border.png"
+            sprite_over="stretched:session/icons/minimap/flare_border_hover.png"
+            masked="true"
+            enabled="false">
             </object>
         </object>
     </object>

source/gui/CButton.cpp

@@ -52 +52 @@
     AddSetting(GUIST_CColor,                "textcolor_disabled");
     AddSetting(GUIST_CStrW,                 "tooltip");
     AddSetting(GUIST_CStr,                  "tooltip_style");
+    AddSetting(GUIST_bool,                  "masked"); // we don't want to check every button for "transparency mask"
 
     // Add text
     AddText(new SGUIText());
@@ -123 +124 @@
     CColor color = ChooseColor();
     DrawText(0, color, m_TextPos, bz+0.1f);
 }
+
+bool CButton::MouseOver()
+{
+    // return false, if mouse is in area of button
+    if (!IGUIObject::MouseOver())
+        return false;
+    
+    // check if masked flag is set
+    bool masked = false;
+    GUI<bool>::GetSetting(this, "masked", masked);
+
+    // return true, if masked flag is not set in button
+    if (!masked)
+        return true;
+
+    // get pixel coordinates relative to the button top left of the button
+    CPos topLeftOfButton = m_CachedActualSize.TopLeft();
+    CPos pos = GetMousePos();
+    pos.x -= topLeftOfButton.x;
+    pos.y -= topLeftOfButton.y;
+
+    // TODO: check in an efficient way, if pixel at (pos.x, pos.y) is transparent 
+    // or not in "sprite" attribute of button
+    // IGUIButtonBehavior::DrawButton, CGUISpriteInstance::Draw or m_DrawCallCache of CGUISpriteInstance may help ?!
+    return true;
+}
+

source/gui/CButton.h

@@ -77 +77 @@
      */
     virtual void Draw();
 
+    /**
+     * checks, if the mouse is over the button
+     * @see IGUIObject#MouseOver()
+     */
+    virtual bool MouseOver();
+
 protected:
     /**
      * Sets up text, should be called every time changes has been