Ticket #2414: minimapIconHover_v1.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"
+            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" ghost="true"
+            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">
+            <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" ghost="true" 
+            sprite="stretched:grayscale:session/icons/minimap/zoom_border.png"
+            sprite_over="stretched:session/icons/minimap/zoom_border_hover.png" 
+            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" ghost="true"
+            sprite="stretched:grayscale:session/icons/minimap/flare_border.png"
+            sprite_over="stretched:session/icons/minimap/flare_border_hover.png"
+            enabled="false">
             </object>
         </object>
     </object>

source/gui/IGUIObject.cpp

@@ -223 +223 @@
     }
 }
 
+void IGUIObject::UpdateMouseOverExternCall(IGUIObject * const &pMouseOver)
+{
+    UpdateMouseOver(pMouseOver);
+}
+
 bool IGUIObject::SettingExists(const CStr& Setting) const
 {
     // Because GetOffsets will direct dynamically defined

source/gui/IGUIObject.h

@@ -390 +390 @@
      */
     void SetFocus();
 
+    /**
+     * calls UpdateMouseOver which is protected; 
+     * this should only be used in RARE cases where no other solution can be found.
+     */
+    void UpdateMouseOverExternCall(IGUIObject * const &pMouseOver);
+
 protected:
     /**
      * Check if object is focused.

source/gui/MiniMap.cpp

@@ -69 +69 @@
     AddSetting(GUIST_CStr,      "tooltip_style");
     m_Clicking = false;
     m_MouseHovering = false;
+    m_lastHoveredButton = NULL;
+    m_px = 0.5;
+    m_py = 0.5;
     
     // Get the maximum height for unit passage in water.
     CParamNode externalParamNode;
@@ -137 +140 @@
 
 void CMiniMap::HandleMessage(SGUIMessage &Message)
 {
+    // get scaled map coordinates
+    UpdateScaledMapCoordinates();
+    
+    // mouse position is within the circle
+    if (IsPostionInCircle(m_px, m_py))
+        DisableMinimapButtonHovering();
+
+    // choose what action should be performed
     switch(Message.type)
     {
     case GUIM_MOUSE_PRESS_LEFT:
@@ -151 +162 @@
     case GUIM_MOUSE_RELEASE_LEFT:
         {
             if(m_MouseHovering && m_Clicking)
-            {
                 SetCameraPos();
-            }
+
             m_Clicking = false;
             break;
         }
@@ -160 +170 @@
     case GUIM_MOUSE_DBLCLICK_LEFT:
         {
             if(m_MouseHovering && m_Clicking)
-            {
                 SetCameraPos();
-            }
+
             m_Clicking = false;
             break;
         }
@@ -175 +184 @@
         {
             m_Clicking = false;
             m_MouseHovering = false;
+            DisableMinimapButtonHovering();
             break;
         }
     case GUIM_MOUSE_RELEASE_RIGHT:
@@ -203 +213 @@
     default:
         break;
     }   // switch
+
+    // check, if mouse position starts after little spacing to the circle
+    if (m_MouseHovering && IsPostionInButtonRange(m_px, m_py))
+    {
+        int buttonID;
+        GetNumberOfButton(m_px, m_py, buttonID);
+        if (!m_lastHoveredButton && buttonID != 0)
+        {
+            char buttonName[32];
+            sprintf(buttonName, "minimap_button[%d]", buttonID);
+
+            // get the button and trigger hover effect
+            m_lastHoveredButton = g_GUI->FindObjectByName(buttonName);
+            if (m_lastHoveredButton)
+                m_lastHoveredButton->UpdateMouseOverExternCall(m_lastHoveredButton);
+        }
+        else if(buttonID == 0)
+            DisableMinimapButtonHovering();
+        else
+        {
+            // let the button handle it's states by itself
+            m_lastHoveredButton->HandleMessage(Message);
+
+            // fix: after release of button hover is not there
+            if (Message.type == GUIM_MOUSE_RELEASE_LEFT || Message.type == GUIM_MOUSE_RELEASE_RIGHT)
+            {
+                // TODO: Why is this not working ?!? How does it work for a "regular" button ?
+                m_lastHoveredButton->UpdateMouseOverExternCall(NULL);
+                m_lastHoveredButton->UpdateMouseOverExternCall(m_lastHoveredButton);
+            }
+        }
+    }
 }
 
-void CMiniMap::GetMouseWorldCoordinates(float& x, float& z)
+void CMiniMap::GetNumberOfButton(float px, float py, int& buttonID)
 {
-    // Determine X and Z according to proportion of mouse position and minimap
+    // get the clock angle
+    float angleFloat;
+    GetClockAngle(px, py, angleFloat);
+    int angle = (int) angleFloat;
+        
+    // check, if any button is hit
+    int mod45 = angle % 45;
+    int mod90 = angle % 90;
+        
+    // some button is hovered (approximation with angles (45° +- 16°, 135° +- 16°, ...)
+    if ((mod45 <= 16 || (mod45-45) >= -16) && !(mod90 <= 16 || (mod90-90) >= -16))
+        buttonID = ((int) angle/90) + 1;
+    else
+        buttonID = 0;
+}
 
+void CMiniMap::DisableMinimapButtonHovering()
+{
+    if (m_lastHoveredButton)
+    {
+        m_lastHoveredButton->UpdateMouseOverExternCall(NULL); // button is not hovered anymore
+        m_lastHoveredButton = NULL;
+    }
+}
+
+void CMiniMap::UpdateScaledMapCoordinates()
+{
+    GetScaledMapCoordinates(m_px, m_py);
+}
+
+void CMiniMap::GetScaledMapCoordinates(float& px, float &py)
+{
     CPos mousePos = GetMousePos();
 
-    float px = (mousePos.x - m_CachedActualSize.left) / m_CachedActualSize.GetWidth();
-    float py = (m_CachedActualSize.bottom - mousePos.y) / m_CachedActualSize.GetHeight();
+    px = (mousePos.x - m_CachedActualSize.left) / m_CachedActualSize.GetWidth();
+    py = (m_CachedActualSize.bottom - mousePos.y) / m_CachedActualSize.GetHeight();
+}
 
-    float angle = GetAngle();
+void CMiniMap::GetDistanceFromCenter(float px, float py, float& distance)
+{
+    // calculate distance from center of circle
+    float dx = px-0.5f;
+    float dy = py-0.5f;
+    
+    distance = sqrt(dx*dx + dy*dy); 
+}
 
-    // Scale world coordinates for shrunken square map
-    x = TERRAIN_TILE_SIZE * m_MapSize * (m_MapScale * (cos(angle)*(px-0.5) - sin(angle)*(py-0.5)) + 0.5);
-    z = TERRAIN_TILE_SIZE * m_MapSize * (m_MapScale * (cos(angle)*(py-0.5) + sin(angle)*(px-0.5)) + 0.5);
+bool CMiniMap::IsPostionInButtonRange(float px, float py)
+{
+    float distance;
+    GetDistanceFromCenter(px, py, distance);
+    
+    return (distance >= 0.55f); 
 }
 
+bool CMiniMap::IsPostionInCircle(float px, float py)
+{
+    float distance;
+    GetDistanceFromCenter(px, py, distance);
+    
+    return (distance <= 0.5f);  
+}
+
+void CMiniMap::GetClockAngle(float px, float py, float& angleClock)
+{
+    // set up some points
+    CVector3D center = CVector3D(0.5f, 0.5f, 0.0f);
+    CVector3D vertical = CVector3D(0.5f, 1.0f, 0.0f);
+    CVector3D direction = CVector3D(px, py, 0.0f);
+    
+    // calculate vectors
+    CVector3D vc = CVector3D(vertical.X - center.X, vertical.Y - center.Y, 0.0f);
+    CVector3D dc = CVector3D(direction.X - center.X, direction.Y - center.Y, 0.0f);
+
+    // calculate length of vectors
+    float lengthVC = sqrt(vc.X*vc.X + vc.Y*vc.Y);
+    float lengthDC = sqrt(dc.X*dc.X + dc.Y*dc.Y);
+    // calculate scalar prodcut of cectors
+    float scalar = vc.X*dc.X + vc.Y*dc.Y;
+    // calculate angle between two vectors
+    angleClock = acos(scalar / (lengthVC*lengthDC)) * 180.0f / M_PI;
+    
+    // check for correct oriantation
+    if (px < 0.5f)
+    {
+        if (py > 0.5f)
+            angleClock = angleClock + 270.0f;
+        else
+            angleClock = angleClock + 90.0f;
+    }
+}
+
+void CMiniMap::GetMouseWorldCoordinates(float& x, float& z, int& buttonID)
+{
+    // inside the circle
+    if (IsPostionInCircle(m_px, m_py))
+    {
+        float angle = GetAngle();
+
+        // Scale world coordinates for shrunken square map
+        x = TERRAIN_TILE_SIZE * m_MapSize * (m_MapScale * (cos(angle)*(m_px-0.5) - sin(angle)*(m_py-0.5)) + 0.5);
+        z = TERRAIN_TILE_SIZE * m_MapSize * (m_MapScale * (cos(angle)*(m_py-0.5) + sin(angle)*(m_px-0.5)) + 0.5);
+        buttonID = 0; // set buttonID to dummy value
+    }
+    else if(IsPostionInButtonRange(m_px, m_py))
+    {
+        GetNumberOfButton(m_px, m_py, buttonID);
+        // set x and z to dummy values
+        x = -1;
+        z = -1;
+    }
+}
+
 void CMiniMap::SetCameraPos()
 {
     CTerrain* terrain = g_Game->GetWorld()->GetTerrain();
 
     CVector3D target;
-    GetMouseWorldCoordinates(target.X, target.Z);
-    target.Y = terrain->GetExactGroundLevel(target.X, target.Z);
-    g_Game->GetView()->MoveCameraTarget(target);
+    int buttonID;
+    GetMouseWorldCoordinates(target.X, target.Z, buttonID);
+    // click within the circle
+    if (IsPostionInCircle(m_px, m_py))
+    {
+        target.Y = terrain->GetExactGroundLevel(target.X, target.Z);
+        g_Game->GetView()->MoveCameraTarget(target);
+    }
 }
 
 float CMiniMap::GetAngle()
@@ -239 +385 @@
 
 void CMiniMap::FireWorldClickEvent(int button, int clicks)
 {
+    int buttonID;
     float x, z;
-    GetMouseWorldCoordinates(x, z);
+    GetMouseWorldCoordinates(x, z, buttonID);
 
-    CScriptValRooted coords;
-    g_GUI->GetActiveGUI()->GetScriptInterface()->Eval("({})", coords);
-    g_GUI->GetActiveGUI()->GetScriptInterface()->SetProperty(coords.get(), "x", x, false);
-    g_GUI->GetActiveGUI()->GetScriptInterface()->SetProperty(coords.get(), "z", z, false);
-    ScriptEvent("worldclick", coords);
+    CScriptValRooted data;
+    g_GUI->GetActiveGUI()->GetScriptInterface()->Eval("({})", data);
+    // click within the circle
+    if (IsPostionInCircle(m_px, m_py))
+    {
+        g_GUI->GetActiveGUI()->GetScriptInterface()->SetProperty(data.get(), "x", x, false);
+        g_GUI->GetActiveGUI()->GetScriptInterface()->SetProperty(data.get(), "z", z, false);
+        ScriptEvent("worldclick", data);    // send the event
+    }
+    
 
     UNUSED2(button);
     UNUSED2(clicks);

source/gui/MiniMap.h

@@ -20 +20 @@
 
 #include "gui/GUI.h"
 #include "renderer/VertexArray.h"
+#include <cmath>
 
-
 class CCamera;
 class CTerrain;
 
@@ -83 +83 @@
     // maximal water height to allow the passage of a unit (for underwater shallows).
     float m_ShallowPassageHeight;
 
+    // last hovered button of the minimap
+    IGUIObject* m_lastHoveredButton;
+
+    // scaled x and y values are cached here
+    float m_px, m_py;
+
     void DrawTexture(CShaderProgramPtr shader, float coordMax, float angle, float x, float y, float x2, float y2, float z);
 
     void DrawViewRect();
 
-    void GetMouseWorldCoordinates(float& x, float& z);
-
+    void GetMouseWorldCoordinates(float& x, float& z, int& buttonID);
+    void GetDistanceFromCenter(float px, float py, float& distance);
+    void UpdateScaledMapCoordinates();
+    void GetScaledMapCoordinates(float& px, float &py);
+    bool IsPostionInCircle(float px, float py);
+    bool IsPostionInButtonRange(float px, float py);
+    void GetClockAngle(float px, float py, float& angleClock);
+    void DisableMinimapButtonHovering(); 
+    void GetNumberOfButton(float px, float py, int& buttonID);
+    
     float GetAngle();
 
     VertexIndexArray m_IndexArray;