ServiceMenu: optimitzacions

2025-06-06 21:29:43 +02:00
parent 0010d64d62
commit 2512345b2c
2 changed files with 135 additions and 92 deletions
--- a/source/service_menu.h
+++ b/source/service_menu.h
@@ -12,45 +12,48 @@ class Text;
 class ServiceMenu
 {
 public:
-    // --- Métodos de singleton ---
-    static void init();        // Inicializa el objeto ServiceMenu
-    static void destroy();     // Libera el objeto ServiceMenu
-    static ServiceMenu *get(); // Obtiene el puntero al objeto ServiceMenu
+    // --- Métodos de Singleton ---
+    static void init();        // Inicializa la instancia única de ServiceMenu
+    static void destroy();     // Libera la instancia única de ServiceMenu
+    static ServiceMenu *get(); // Devuelve el puntero a la instancia única

-    // -- Métodos ---
-    void toggle();
-    void render();
-    void update();
+    // --- Métodos principales ---
+    void toggle(); // Muestra u oculta el menú de servicio
+    void render(); // Dibuja el menú de servicio en pantalla
+    void update(); // Actualiza el estado del menú de servicio

-    // --- Métodos de control ---
-    void setSelectorUp();
-    void setSelectorDown();
-    void adjustOption(bool adjust_up);
-    void selectOption();
-    void moveBack();
+    // --- Métodos de control de navegación ---
+    void setSelectorUp();              // Mueve el selector hacia arriba
+    void setSelectorDown();            // Mueve el selector hacia abajo
+    void adjustOption(bool adjust_up); // Ajusta el valor de la opción seleccionada
+    void selectOption();               // Selecciona la opción actual
+    void moveBack();                   // Vuelve al grupo de opciones anterior

    // --- Getters ---
-    bool isEnabled() const { return enabled_; }
+    bool isEnabled() const { return enabled_; } // Indica si el menú de servicio está activo

 private:
+    // --- Tipos internos ---
    using OptionPairs = std::vector<std::pair<std::string, std::string>>;

-    static constexpr const char *MENU_SOUND_ = "clock.wav";
-    static constexpr int OPTIONS_HORIZONTAL_PADDING_ = 20;
+    // --- Constantes ---
+    static constexpr const char *MENU_SOUND_ = "clock.wav"; // Sonido al navegar por el menú
+    static constexpr int OPTIONS_HORIZONTAL_PADDING_ = 20;  // Relleno horizontal de las opciones

+    // --- Enumeraciones internas ---
    enum class Aspect
    {
        ASPECT1, // Fondo opaco y proyecta sombra
-        ASPECT2  // Fondo translucido
+        ASPECT2  // Fondo translúcido
    };

    enum class SettingsGroup
    {
-        VIDEO,  // Configuraciones relacionadas con la calidad y resolución de imagen
-        AUDIO,  // Opciones de sonido y volumen
-        GAME,   // Ajustes de jugabilidad y mecánicas
-        SYSTEM, // Preferencias generales y configuraciones del sistema
-        MAIN    // Raíz
+        VIDEO,  // Configuraciones de vídeo
+        AUDIO,  // Opciones de audio
+        GAME,   // Opciones de juego
+        SYSTEM, // Opciones del sistema
+        MAIN    // Menú principal
    };

    enum class OptionBehavior
@@ -61,18 +64,19 @@ private:

    enum class ValueType
    {
-        BOOL,
-        INT,
-        FOLDER,
-        NONE
+        BOOL,   // Valor booleano
+        INT,    // Valor entero
+        FOLDER, // Referencia a otro grupo
+        NONE    // Sin valor asociado
    };

    enum class GroupAlignment
    {
-        CENTERED,
-        LEFT
+        CENTERED, // Opciones centradas
+        LEFT      // Opciones alineadas a la izquierda
    };

+    // --- Estructura de opción del menú ---
    struct OptionEntry
    {
        std::string caption;     // Texto visible en el menú
@@ -102,7 +106,7 @@ private:
            : caption(cap), group(grp), behavior(beh), linked_variable(nullptr), type(ValueType::FOLDER),
              min_value(0), max_value(0), step_value(0), target_group(tgtGrp) {}

-        // Método para modificar el valor
+        // Método para modificar el valor de la opción
        void adjustValue(bool adjust_up)
        {
            if (linked_variable)
@@ -111,14 +115,12 @@ private:
                {
                    int &value = *(static_cast<int *>(linked_variable));
                    int newValue = adjust_up ? value + step_value : value - step_value;
-
-                    // Asegurar que el nuevo valor se mantenga dentro de los límites
                    value = std::clamp(newValue, min_value, max_value);
                }
                else if (type == ValueType::BOOL)
                {
                    bool &value = *(static_cast<bool *>(linked_variable));
-                    value = !value; // Invierte el valor booleano
+                    value = !value;
                }
            }
        }
@@ -138,49 +140,58 @@ private:
        }
    };

-    // -- Variables internas ---
+    // --- Variables internas ---
    bool enabled_ = false;                     // Indica si el menú de servicio está activo
-    SDL_FRect rect_;                           // Rectangulo para definir el area del menú de servicio
-    std::shared_ptr<Text> element_text_;       // Objeto para escribir texto;
-    std::shared_ptr<Text> title_text_;         // Objeto para escribir texto;
-    size_t selected_ = 0;                      // Elemento del menú seleccionado
+    SDL_FRect rect_;                           // Rectángulo que define el área del menú de servicio
+    std::shared_ptr<Text> element_text_;       // Objeto para escribir el texto de los elementos
+    std::shared_ptr<Text> title_text_;         // Objeto para escribir el texto del título
+    size_t selected_ = 0;                      // Índice del elemento del menú seleccionado
    Uint32 counter_ = 0;                       // Contador interno
    std::vector<OptionEntry> options_;         // Listado con todas las opciones del menú de servicio
-    std::vector<OptionEntry> display_options_; // Listado con todas las opciones del menú de servicio que se estan mostrando
-    OptionPairs option_pairs_;                 // Listado con las opciones de menu actuales (filtradas por grupo)
-    SettingsGroup current_settings_group_;     // Grupo actual
-    SettingsGroup previous_settings_group_;    // Grupo anterior
-    Aspect aspect_ = Aspect::ASPECT2;
+    std::vector<OptionEntry> display_options_; // Opciones actualmente mostradas en pantalla
+    OptionPairs option_pairs_;                 // Opciones actuales del menú (filtradas por grupo)
+    SettingsGroup current_settings_group_;     // Grupo de opciones actualmente activo
+    SettingsGroup previous_settings_group_;    // Grupo de opciones anterior
+    Aspect aspect_ = Aspect::ASPECT2;          // Estilo visual del menú

-    // -- Aspecto --
+    // --- Variables de aspecto ---
    Color bg_color_ = SERV_MENU_BG_COLOR;             // Color de fondo
-    Color title_color_ = SERV_MENU_TITLE_COLOR;       // Color del título del menu
-    Color text_color_ = SERV_MENU_TEXT_COLOR;         // Color para el texto de los elementos
-    Color selected_color_ = SERV_MENU_SELECTED_COLOR; // Color para el elemento seleccionado
+    Color title_color_ = SERV_MENU_TITLE_COLOR;       // Color del título del menú
+    Color text_color_ = SERV_MENU_TEXT_COLOR;         // Color del texto de los elementos
+    Color selected_color_ = SERV_MENU_SELECTED_COLOR; // Color del elemento seleccionado
    int width_;                                       // Ancho del menú
-    int height_;                                      // Alto del menu
-    int line_height_;                                 // Espacio entre elementos del menu
+    int height_;                                      // Alto del menú
+    int line_height_;                                 // Espacio entre elementos del menú

-    // -- Métodos internos ---
-    void setAnchors();        // Establece el valor de las variables de anclaje
-    void updateCounter();     // Actualiza el contador interno
-    Color getSelectedColor(); // Devuelve el color del elemento seleccionado
-    void initializeOptions(); // Crea todas las opciones del menú de servicio
-    OptionPairs getOptionPairs(SettingsGroup group) const;
-    std::vector<OptionEntry> getOptionsByGroup(SettingsGroup group) const;
-    void applySettings(SettingsGroup group);
-    void updateMenu(SettingsGroup group);
-    void reset();
-    int calculateMenuHeight();
-    int findLargestGroupSize();
-    GroupAlignment getGroupAlignment(SettingsGroup group);
+    // --- Métodos internos: Anclaje y aspecto ---
+    void setAnchors();              // Establece el valor de las variables de anclaje
+    Color getSelectedColor() const; // Devuelve el color del elemento seleccionado
+
+    // --- Métodos internos: Gestión de opciones ---
+    void initializeOptions();                                              // Crea todas las opciones del menú de servicio
+    OptionPairs getOptionPairs(SettingsGroup group) const;                 // Devuelve las opciones como pares de strings para un grupo
+    std::vector<OptionEntry> getOptionsByGroup(SettingsGroup group) const; // Devuelve las opciones de un grupo
+
+    // --- Métodos internos: Lógica de menú ---
+    void applySettings(SettingsGroup group); // Aplica la configuración de un grupo
+    void updateMenu(SettingsGroup group);    // Actualiza las opciones mostradas según el grupo
+    void reset();                            // Reinicia el menú al estado inicial
+
+    // --- Métodos internos: Utilidades ---
+    void updateCounter();                                        // Actualiza el contador interno
+    int calculateMenuHeight() const;                             // Calcula la altura del menú
+    int findLargestGroupSize() const;                            // Devuelve el tamaño del grupo más grande
+    GroupAlignment getGroupAlignment(SettingsGroup group) const; // Devuelve la alineación del grupo

    // --- Patrón Singleton ---
    ServiceMenu();                                        // Constructor privado
    ~ServiceMenu() = default;                             // Destructor privado
-    ServiceMenu(const ServiceMenu &) = delete;            // Evitar copia
-    ServiceMenu &operator=(const ServiceMenu &) = delete; // Evitar asignación
+    ServiceMenu(const ServiceMenu &) = delete;            // Evita la copia
+    ServiceMenu &operator=(const ServiceMenu &) = delete; // Evita la asignación

-    // --- Singleton ---
-    static ServiceMenu *instance_;
+    // --- Instancia Singleton ---
+    static ServiceMenu *instance_; // Instancia única del menú de servicio
+
+    // --- Método para reproducir el sonido del menú ---
+    void playMenuSound(); // Reproduce el sonido del menú
 };