ModeInputVector.h

Go to the documentation of this file.

/*
  Cavestory Multiplayer API
  Copyright (C) 2021 Johnny Ledger
 
  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.
 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
 
  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.
*/
 
#ifndef CAVESTORY_MOD_API_H_
#error "Please include CavestoryModAPI.h before including sub-classes."
#endif
 
#include <CSMAPI_begincode.h>
class CAVESTORY_MOD_API BaseModeInstance;
 
#pragma once
 
 
typedef unsigned int ModeInputSelectionId;
 
typedef unsigned int ModeInputIndex;
 
typedef int ModeInputOptionCoord;
 
enum ModeInputButtonState
{
    MIBS_NORMAL  = 0,
 
    MIBS_HOVERED = 1,
 
    MIBS_PRESSED = 2
};
 
 
struct ModeInputOptionConfig
{
    bool clickable;
 
    struct
    {
        int left;
 
        int up;
 
        int right;
 
        int down;
    } increment;
 
    struct
    {
        bool open_for_keyboard;
 
        bool allocate_text;
 
        GUI_POINT surface_offset;
 
        int magnification_lvl;
 
        FontObject* font;
    } tooltip;
 
    ModeInputOptionConfig()
    {
        clickable                 = true;
        tooltip.open_for_keyboard = true;
        tooltip.allocate_text     = true;
        tooltip.surface_offset.x  = 0;
        tooltip.surface_offset.y  = 0;
        tooltip.magnification_lvl = -1;
        tooltip.font              = NULL;
        increment.left            = 1;
        increment.up              = 1;
        increment.right           = 1;
        increment.down            = 1;
    }
};
 
struct ModeInputOption
{
    enum OptionFlags
    {
        AUTO_EXPAND_WIDTH  = BIT(0),
 
        AUTO_EXPAND_HEIGHT = BIT(1),
 
        START_FROM_RIGHT   = BIT(2),
 
        START_FROM_BOTTOM  = BIT(3),
 
        START_ON_NEW_LINE  = BIT(4),
 
        AUTOMATION_FLAGS   = AUTO_EXPAND_WIDTH | AUTO_EXPAND_HEIGHT
    };
 
    ModeInputIndex index;
 
    unsigned int flags;
 
    ModeInputSelectionId selection_id;
 
    struct
    {
        bool use;
 
        ModeInputOptionCoord x;
 
        ModeInputOptionCoord y;
        
        ModeInputOptionCoord w;
        
        ModeInputOptionCoord h;
    } input_rect;
 
    struct
    {
        ModeInputOptionCoord x;
 
        ModeInputOptionCoord y;
        
        ModeInputOptionCoord w;
        
        ModeInputOptionCoord h;
    } calculated_input_rect;
 
    struct
    {
        bool use;
 
        GUI_RECT rect;
    } clip;
 
    struct
    {
        bool enabled;
 
        char* text;
    } tooltip;
 
    ModeInputOptionConfig config;
 
    ScrollAreaInfo* scroll_ptr;
 
    GUI_RECT* rect_ptr;
 
    GuiBase* gui_ptr;
 
    GUI_RECT rect_plain;
};
 
class CAVESTORY_MOD_API ModeInputVector
{
private: // Mechanical variables
 
    GUI_POINT m_MinSize;
 
    ModeInputOption** m_OptionList;
 
    int m_OptionCount;
 
    ScrollAreaInfo** m_ScrollList;
 
    int m_ScrollCount;
 
    ModeInputIndex* m_Array;
 
    int m_ArrayWidth;
 
    int m_ArrayHeight;
 
private: // Selected variables
 
    BaseModeInstance* m_Owner;
 
    int m_TooltipOption;
 
    int m_SelectedOption;
 
    int m_OldSelectedOption;
 
    bool m_UsedKeyboard;
 
    GUI_POINT m_SelectedPos;
 
    bool m_IsSelectionProcessing;
 
private: // Lock variables
 
    bool m_Dirty;
 
    bool m_Locked;
 
public: // State variables
 
    bool m_Clicking;
 
    bool m_Hovering;
 
public: // C++ stuff
 
    ModeInputVector();
 
    ~ModeInputVector();
 
protected: // Internal methods
 
    bool RebuildArray();
 
    bool IndexOptions();
 
    ModeInputOption* AllocateOption();
 
    ModeInputOption* FindOptionById(ModeInputSelectionId iSelectionId, int* pIndexPtr = NULL);
 
    inline GUI_RECT Internal_GetOptionRect(ModeInputOption* pOption);
 
    ModeInputOption* Internal_AddOption(ModeInputSelectionId iSelectionId, ModeInputOptionCoord iX, ModeInputOptionCoord iY, ModeInputOptionCoord iW, ModeInputOptionCoord iH, ScrollAreaInfo* pScroll, GUI_RECT* pClipRect, char* pTooltipText, ModeInputOptionConfig* pConfig, unsigned int iFlags);
 
public: // Public memory management
 
    void SetMinArraySize(ModeInputOptionCoord iWidth, ModeInputOptionCoord iHeight);
 
    bool AddOption(ModeInputSelectionId iSelectionId, ModeInputOptionCoord iX, ModeInputOptionCoord iY, ModeInputOptionCoord iW, ModeInputOptionCoord iH, GUI_RECT* pRect, ScrollAreaInfo* pScroll = NULL, GUI_RECT* pClipRect = NULL, const char* pTooltipText = NULL, ModeInputOptionConfig* pConfig = NULL, unsigned int iFlags = 0);
 
    bool AddOption(ModeInputSelectionId iSelectionId, ModeInputOptionCoord iX, ModeInputOptionCoord iY, ModeInputOptionCoord iW, ModeInputOptionCoord iH, GuiBase* pGui, ScrollAreaInfo* pScroll = NULL, GUI_RECT* pClipRect = NULL, const char* pTooltipText = NULL, ModeInputOptionConfig* pConfig = NULL, unsigned int iFlags = 0);
    
    bool AddOption(ModeInputSelectionId iSelectionId, ModeInputOptionCoord iX, ModeInputOptionCoord iY, ModeInputOptionCoord iW, ModeInputOptionCoord iH, GUI_RECT pRect, ScrollAreaInfo* pScroll = NULL, GUI_RECT* pClipRect = NULL, const char* pTooltipText = NULL, ModeInputOptionConfig* pConfig = NULL, unsigned int iFlags = 0);
    
    bool AddOption(ModeInputSelectionId iSelectionId, GUI_RECT* pRect, ScrollAreaInfo* pScroll = NULL, GUI_RECT* pClipRect = NULL, const char* pTooltipText = NULL, ModeInputOptionConfig* pConfig = NULL, unsigned int iFlags = 0);
 
    bool AddOption(ModeInputSelectionId iSelectionId, GuiBase* pGui, ScrollAreaInfo* pScroll = NULL, GUI_RECT* pClipRect = NULL, const char* pTooltipText = NULL, ModeInputOptionConfig* pConfig = NULL, unsigned int iFlags = 0);
    
    bool AddOption(ModeInputSelectionId iSelectionId, GUI_RECT pRect, ScrollAreaInfo* pScroll = NULL, GUI_RECT* pClipRect = NULL, const char* pTooltipText = NULL, ModeInputOptionConfig* pConfig = NULL, unsigned int iFlags = 0);
 
    bool RemoveOption(ModeInputSelectionId iSelectionId);
 
    bool AddScroll(ScrollAreaInfo* pScroll);
 
    void Reset();
 
public: // More option methods
 
    ModeInputButtonState GetOptionState(ModeInputSelectionId iSelectionId);
 
    GUI_RECT GetOptionRect(ModeInputSelectionId iSelectionId);
 
public: // Selection manipulation methods
 
    void SetSelectionByPos(int iX, int iY, bool bUsedKeyboard, bool bOpenTooltip = true);
 
    void SetSelectionById(ModeInputSelectionId iSelectionId, bool bUsedKeyboard);
 
    GUI_POINT GetSelectedPos();
 
    int GetSelectedId();
    
    int GetSelectedIndex();
 
    inline bool WasKeyboardUsed() { return m_UsedKeyboard; }
 
protected: // Protected tooltip methods
 
    void SetTooltip(ModeInputOption* pOption);
 
    bool IsTooltipSetTo(ModeInputOption* pOption);
 
public: // Tooltip processing
 
    inline void SetModeOwner(BaseModeInstance* pMode) { m_Owner = pMode; }
 
public: // Processing methods
 
    GUI_POINT GetArraySize();
 
    int MoveSelection(int iXM, int iYM);
    
    int ProcessKeys(int* iSelectedOutTrg);
 
    int ProcessMouse(int* iSelectedOutTrg, GUI_POINT pMousePoint);
 
    void Lock();
    
    void Unlock();
 
public: // Debugging methods
 
    void DumpMap();
};
 
 
#include <CSMAPI_endcode.h>