Working UI focus system (#943)

Author: Xottab-DUTY

src/xrGame/UIDialogHolder.cpp

@@ -55,7 +55,7 @@ void CDialogHolder::StartMenu(CUIDialogWnd* pDialog, bool bDoHideIndicators)
             CurrentGameUI()->ShowGameIndicators(false);
         }
     }
-    SetFocused(nullptr);
+    UI().Focus().SetFocused(nullptr);
     pDialog->SetHolder(this);
 
     if (pDialog->NeedCursor())
@@ -248,6 +248,9 @@ void CDialogHolder::OnFrame()
                 (*it).wnd->Update();
     }
 
+    if (m_is_foremost)
+        UI().Focus().Update(wnd);
+
     m_b_in_update = false;
     if (!m_dialogsToRender_new.empty())
     {
@@ -316,6 +319,33 @@ bool CDialogHolder::IR_UIOnKeyboardPress(int dik)
     if (TIR->OnKeyboardAction(dik, WINDOW_KEY_PRESSED))
         return true;
 
+    if (dik > XR_CONTROLLER_BUTTON_INVALID && dik < XR_CONTROLLER_BUTTON_MAX)
+    {
+        FocusDirection direction = FocusDirection::Same;
+        switch (GetBindedAction(dik, EKeyContext::UI))
+        {
+        case kUI_MOVE_LEFT:  direction = FocusDirection::Left; break;
+        case kUI_MOVE_RIGHT: direction = FocusDirection::Right; break;
+        case kUI_MOVE_UP:    direction = FocusDirection::Up; break;
+        case kUI_MOVE_DOWN:  direction = FocusDirection::Down; break;
+        }
+
+        if (direction != FocusDirection::Same)
+        {
+            auto& focus = UI().Focus();
+            const auto focused = focus.GetFocused();
+            const Fvector2 vec = focused ? focused->GetWndPos() : UI().GetUICursor().GetCursorPosition();
+            const auto [target, direct] = focus.FindClosestFocusable(vec, direction);
+
+            if (target)
+            {
+                focus.SetFocused(target);
+                GetUICursor().WarpToWindow(target, true);
+                return true;
+            }
+        }
+    }
+
     if (!TIR->StopAnyMove() && g_pGameLevel)
     {
         IGameObject* O = Level().CurrentEntity();
@@ -334,24 +364,6 @@ bool CDialogHolder::IR_UIOnKeyboardPress(int dik)
         }
     }
 
-    /*if (const auto focused = GetFocused())
-    {
-        CUIWindow* target{};
-        switch (GetBindedAction(dik, EKeyContext::UI))
-        {
-        case kUI_MOVE_LEFT:  target = FindClosestFocusable(focused, FocusDirection::Left); break;
-        case kUI_MOVE_RIGHT: target = FindClosestFocusable(focused, FocusDirection::Right); break;
-        case kUI_MOVE_UP:    target = FindClosestFocusable(focused, FocusDirection::Up); break;
-        case kUI_MOVE_DOWN:  target = FindClosestFocusable(focused, FocusDirection::Down); break;
-        }
-
-        if (target)
-        {
-            SetFocused(target);
-            GetUICursor().WarpToWindow(target, true);
-        }
-    }*/
-
     return true;
 }
 
@@ -574,6 +586,7 @@ bool CDialogHolder::IR_UIOnControllerHold(int dik, float x, float y)
 
 bool CDialogHolder::FillDebugTree(const CUIDebugState& debugState)
 {
+#ifndef MASTER_GOLD
     // XXX: Was this meant to be used somewhere here? Because currently its unused and could also be constexpr
     //ImGuiTreeNodeFlags flags = ImGuiTreeNodeFlags_OpenOnDoubleClick | ImGuiTreeNodeFlags_OpenOnArrow;
 
@@ -600,6 +613,7 @@ bool CDialogHolder::FillDebugTree(const CUIDebugState& debugState)
             ImGui::TreePop();
         }
     }
+#endif
     return true;
 }
 

src/xrGame/UIDialogHolder.h

@@ -4,7 +4,6 @@
 #include "xrCore/_flags.h"
 #include "xrEngine/pure.h"
 #include "xrUICore/ui_debug.h"
-#include "xrUICore/ui_focus.h"
 
 #include <SDL.h>
 
@@ -33,7 +32,7 @@ class recvItem
     Flags8 m_flags;
 };
 
-class CDialogHolder : public pureFrame, public CUIDebuggable, public CUIFocusSystem
+class CDialogHolder : public pureFrame, public CUIDebuggable
 {
     // dialogs
     xr_vector<recvItem> m_input_receivers;

src/xrGame/ui/UIDialogWnd.h

@@ -22,15 +22,7 @@ class CUIDialogWnd : public CUIWindow
     bool OnControllerAction(int axis, float x, float y, EUIMessages controller_action) override;
 
     CDialogHolder* GetHolder() const { return m_pParentHolder; }
-
-    void SetHolder(CDialogHolder* h)
-    {
-        if (m_pParentHolder)
-            m_pParentHolder->UnregisterFocusable(this);
-        m_pParentHolder = h;
-    }
-
-    CUIFocusSystem* GetCurrentFocusSystem() const override { return GetHolder(); }
+    void SetHolder(CDialogHolder* h) { m_pParentHolder = h; }
 
     virtual bool StopAnyMove() { return true; }
     virtual bool NeedCursor() const { return pInput->IsCurrentInputTypeKeyboardMouse(); }

src/xrUICore/Buttons/UIButton.cpp

@@ -10,7 +10,6 @@
 
 CUIButton::CUIButton() : CUIStatic("CUIButton")
 {
-    m_bFocusValuable = true;
     m_eButtonState = BUTTON_NORMAL;
     m_bIsSwitch = false;
 
@@ -22,6 +21,13 @@ CUIButton::CUIButton() : CUIStatic("CUIButton")
     TextItemControl()->SetTextComplexMode(false);
     TextItemControl()->SetTextAlignment(CGameFont::alCenter); // this will create class instance for m_pLines
     TextItemControl()->SetVTextAlignment(valCenter);
+
+    UI().Focus().RegisterFocusable(this);
+}
+
+CUIButton::~CUIButton()
+{
+    UI().Focus().UnregisterFocusable(this);
 }
 
 void CUIButton::Reset()

src/xrUICore/Buttons/UIButton.h

@@ -8,6 +8,7 @@ class XRUICORE_API CUIButton : public CUIStatic
 
 public:
     CUIButton();
+    ~CUIButton() override;
 
     virtual bool OnMouseAction(float x, float y, EUIMessages mouse_action);
     virtual void OnClick();

src/xrUICore/ComboBox/UIComboBox.cpp

@@ -9,8 +9,6 @@
 
 CUIComboBox::CUIComboBox() : CUIWindow("CUIComboBox")
 {
-    m_bFocusValuable = true;
-
     AttachChild(&m_frameLine);
     AttachChild(&m_text);
 
@@ -21,6 +19,13 @@ CUIComboBox::CUIComboBox() : CUIWindow("CUIComboBox")
     m_bInited = false;
     m_eState = LIST_FONDED;
     m_textColor[0] = 0xff00ff00;
+
+    UI().Focus().RegisterFocusable(this);
+}
+
+CUIComboBox::~CUIComboBox()
+{
+    UI().Focus().UnregisterFocusable(this);
 }
 
 void CUIComboBox::SetListLength(int length)

src/xrUICore/ComboBox/UIComboBox.h

@@ -16,6 +16,7 @@ class XRUICORE_API CUIComboBox final : public CUIWindow, public CUIOptionsItem,
 
 public:
     CUIComboBox();
+    ~CUIComboBox() override;
 
     // CUIOptionsItem
     virtual void SetCurrentOptValue(); // opt->current

src/xrUICore/EditBox/UICustomEdit.cpp

@@ -8,8 +8,6 @@
 
 CUICustomEdit::CUICustomEdit() : CUIStatic("CUICustomEdit")
 {
-    m_bFocusValuable = true;
-
     m_editor_control = xr_new<text_editor::line_edit_control>(EDIT_BUF_SIZE);
     Init(EDIT_BUF_SIZE);
 
@@ -25,9 +23,15 @@ CUICustomEdit::CUICustomEdit() : CUIStatic("CUICustomEdit")
     m_force_update = true;
     m_last_key_state_time = 0;
     m_next_focus_capturer = NULL;
+
+    UI().Focus().RegisterFocusable(this);
 }
 
-CUICustomEdit::~CUICustomEdit() { xr_delete(m_editor_control); }
+CUICustomEdit::~CUICustomEdit()
+{
+    xr_delete(m_editor_control);
+    UI().Focus().UnregisterFocusable(this);
+}
 
 text_editor::line_edit_control& CUICustomEdit::ec()
 {

src/xrUICore/TrackBar/UITrackBar.cpp

@@ -19,8 +19,6 @@ CUITrackBar::CUITrackBar()
     : m_b_invert(false), m_b_is_float(true), m_b_bound_already_set(false), m_f_val(0), m_f_max(1), m_f_min(0),
       m_f_step(0.01f), m_f_opt_backup_value(0)
 {
-    m_bFocusValuable = true;
-
     m_pSlider = xr_new<CUI3tButton>();
     AttachChild(m_pSlider);
     m_pSlider->SetAutoDelete(true);
@@ -31,6 +29,13 @@ CUITrackBar::CUITrackBar()
     m_static->SetAutoDelete(true);
 
     m_b_mouse_capturer = false;
+
+    //UI().Focus().RegisterFocusable(this);
+}
+
+CUITrackBar::~CUITrackBar()
+{
+    //UI().Focus().UnregisterFocusable(this);
 }
 
 bool CUITrackBar::OnMouseAction(float x, float y, EUIMessages mouse_action)

src/xrUICore/TrackBar/UITrackBar.h

@@ -8,6 +8,8 @@ class XRUICORE_API CUITrackBar final : public CUI_IB_FrameLineWnd, public CUIOpt
 {
 public:
     CUITrackBar();
+    ~CUITrackBar() override;
+
     // CUIOptionsItem
     virtual void SetCurrentOptValue(); // opt->current
     virtual void SaveBackUpOptValue(); // current->backup