ScreenOptions.h

#ifndef SCREENOPTIONS_H
#define SCREENOPTIONS_H
 
#include "Etterna/Actor/Menus/DualScrollBar.h"
#include "Etterna/Models/Misc/InputEventPlus.h"
#include "Etterna/Models/Lua/LuaExpressionTransform.h"
#include "Etterna/Actor/Menus/OptionRow.h"
#include "Etterna/Actor/Menus/OptionsCursor.h"
#include "RageUtil/Sound/RageSound.h"
#include "Etterna/Screen/Others/ScreenWithMenuElements.h"
#include "Etterna/Models/Misc/ThemeMetric.h"
 
class OptionRowHandler;
 
AutoScreenMessage(SM_ExportOptions);
 
enum InputMode
{
    INPUTMODE_INDIVIDUAL,   
    INPUTMODE_SHARE_CURSOR, 
    NUM_InputMode,          
    InputMode_Invalid
};
InputMode
StringToInputMode(const std::string& str);
 
#define FOREACH_OptionsPlayer(pn)                                              \
    for (PlayerNumber pn = GetNextHumanPlayer((PlayerNumber)-1);               \
         pn != PLAYER_INVALID &&                                               \
         (m_InputMode == INPUTMODE_INDIVIDUAL || pn == 0);                     \
         pn = GetNextHumanPlayer(pn))
 
class ScreenOptions : public ScreenWithMenuElements
{
  public:
    ScreenOptions();
    void Init() override;
    void BeginScreen() override;
    void InitMenu(const std::vector<OptionRowHandler*>& vHands);
    ~ScreenOptions() override;
    void Update(float fDeltaTime) override;
    bool Input(const InputEventPlus& input) override;
    void HandleScreenMessage(const ScreenMessage& SM) override;
 
    void TweenOnScreen() override;
    void TweenOffScreen() override;
 
    // Lua
    void PushSelf(lua_State* L) override;
    friend class LunaScreenOptions;
 
  protected:
    virtual void ImportOptions(int iRow, const PlayerNumber& vpns) = 0;
    virtual void ExportOptions(int iRow, const PlayerNumber& vpns) = 0;
    virtual void ExportOptionsOnCancel(int iRow, const PlayerNumber& pn) = 0;
 
    void RestartOptions();
    void GetWidthXY(PlayerNumber pn,
                    int iRow,
                    int iChoiceOnRow,
                    int& iWidthOut,
                    int& iXOut,
                    int& iYOut) const;
    std::string GetExplanationText(int iRow) const;
    void RefreshIcons(int iRow, PlayerNumber pn);
    void PositionCursor(PlayerNumber pn);
    void PositionRows(bool bTween);
    void TweenCursor(PlayerNumber pn);
    void StoreFocus(PlayerNumber pn);
 
    void BeginFadingOut();
    virtual bool FocusedItemEndsScreen(PlayerNumber pn) const;
    std::string GetNextScreenForFocusedItem(PlayerNumber pn) const;
 
    void ChangeValueInRowRelative(int iRow,
                                  PlayerNumber pn,
                                  int iDelta,
                                  bool bRepeat);
    void ChangeValueInRowAbsolute(int iRow,
                                  PlayerNumber pn,
                                  int iChoiceIndex,
                                  bool bRepeat);
    virtual void AfterChangeValueInRow(int iRow, PlayerNumber pn);
    bool MoveRowRelative(PlayerNumber pn, int iDir, bool bRepeat);
    bool MoveRowAbsolute(PlayerNumber pn, int iRow);
    virtual void AfterChangeRow(PlayerNumber pn);
    virtual void AfterChangeValueOrRow(PlayerNumber pn);
 
    bool MenuBack(const InputEventPlus& input) override;
    bool MenuStart(const InputEventPlus& input) override;
    virtual void ProcessMenuStart(const InputEventPlus& input);
    bool MenuLeft(const InputEventPlus& input) override;
    bool MenuRight(const InputEventPlus& input) override;
    bool MenuUp(const InputEventPlus& input) override;
    bool MenuDown(const InputEventPlus& input) override;
    bool MenuSelect(const InputEventPlus& input) override;
    virtual void MenuUpDown(const InputEventPlus& input,
                            int iDir); // iDir == -1 or iDir == +1
 
    int GetCurrentRow(PlayerNumber pn = PLAYER_1) const
    {
        return m_iCurrentRow;
    }
    bool AllAreOnLastRow() const;
    OptionRow* GetRow(int iRow) const { return m_pRows[iRow]; }
    // void SetOptionRowFromName( const std::string& nombre );
    int GetNumRows() const { return static_cast<int>(m_pRows.size()); }
 
  protected: // derived classes need access to these
    enum Navigation
    {
        NAV_THREE_KEY,
        NAV_THREE_KEY_MENU,
        NAV_THREE_KEY_ALT,
        NAV_FIVE_KEY,
        NAV_TOGGLE_THREE_KEY,
        NAV_TOGGLE_FIVE_KEY
    };
    void SetNavigation(Navigation nav) { m_OptionsNavigation = nav; }
    void SetInputMode(InputMode im) { m_InputMode = im; }
 
    std::vector<OptionRow*> m_pRows;
    int m_iCurrentRow;
 
    OptionRowType m_OptionRowTypeNormal;
    OptionRowType m_OptionRowTypeExit;
 
    Navigation m_OptionsNavigation;
    InputMode m_InputMode;
 
    int m_iFocusX;
    bool m_bWasOnExit;
 
    bool m_bGotAtLeastOneStartPressed;
 
    // actors
    ActorFrame m_frameContainer;
    AutoActor m_sprPage;
 
    OptionsCursor m_Cursor;
    AutoActor m_sprLineHighlight;
 
    BitmapText m_textExplanation;
    BitmapText m_textExplanationTogether;
    DualScrollBar m_ScrollBar;
    AutoActor m_sprMore;
 
    RageSound m_SoundChangeCol;
    RageSound m_SoundNextRow;
    RageSound m_SoundPrevRow;
    RageSound m_SoundToggleOn;
    RageSound m_SoundToggleOff;
    RageSound m_SoundStart;
 
    // metrics
    ThemeMetric<int> NUM_ROWS_SHOWN;
    ThemeMetric<apActorCommands> ROW_INIT_COMMAND;
    ThemeMetric<apActorCommands> ROW_ON_COMMAND;
    ThemeMetric<apActorCommands> ROW_OFF_COMMAND;
    LuaExpressionTransform
      m_exprRowPositionTransformFunction; // params:
                                          // self,offsetFromCenter,itemIndex,numItems
    ThemeMetric<bool> SHOW_SCROLL_BAR;
    ThemeMetric<float> SCROLL_BAR_HEIGHT;
    ThemeMetric<float> SCROLL_BAR_TIME;
    ThemeMetric<float> LINE_HIGHLIGHT_X;
    ThemeMetric<bool> SHOW_EXIT_ROW;
    ThemeMetric<bool> SEPARATE_EXIT_ROW;
    ThemeMetric<float> SEPARATE_EXIT_ROW_Y;
    ThemeMetric<bool> SHOW_EXPLANATIONS;
    ThemeMetric<bool> ALLOW_REPEATING_CHANGE_VALUE_INPUT;
    ThemeMetric<float> CURSOR_TWEEN_SECONDS;
    ThemeMetric<bool> WRAP_VALUE_IN_ROW;
    ThemeMetric<std::string> OPTION_ROW_NORMAL_METRICS_GROUP;
    ThemeMetric<std::string> OPTION_ROW_EXIT_METRICS_GROUP;
};
 
#endif