xrb_widgetskin.hpp

// ///////////////////////////////////////////////////////////////////////////
// xrb_widgetskin.hpp by Victor Dods, created 2005/04/01
// ///////////////////////////////////////////////////////////////////////////
// Unless a different license was explicitly granted in writing by the
// copyright holder (Victor Dods), this software is freely distributable under
// the terms of the GNU General Public License, version 2.  Any works deriving
// from this work must also be released under the GNU GPL.  See the included
// file LICENSE for details.
// ///////////////////////////////////////////////////////////////////////////

#if !defined(_XRB_WIDGETSKIN_HPP_)
#define _XRB_WIDGETSKIN_HPP_

#include "xrb.hpp"

#include "xrb_font.hpp"
#include "xrb_gltexture.hpp"
#include "xrb_resourcelibrary.hpp"
#include "xrb_screencoord.hpp"

namespace Xrb
{

class Screen;
class WidgetBackground;

class WidgetSkin
{
public:

    enum WidgetBackgroundType
    {
        MODAL_WIDGET_BACKGROUND = 0,
        BUTTON_BACKGROUND,
        BUTTON_MOUSEOVER_BACKGROUND,
        BUTTON_PRESSED_BACKGROUND,
        LINE_EDIT_BACKGROUND,
        CHECK_BOX_BACKGROUND,
        RADIO_BUTTON_BACKGROUND,
        TOOLBAR_BUTTON_BACKGROUND,
        TOOLBAR_BUTTON_MOUSEOVER_BACKGROUND,
        TOOLBAR_BUTTON_CHECKED_BACKGROUND,
        TOOLBAR_BUTTON_PRESSED_BACKGROUND,

        WIDGET_BACKGROUND_TYPE_COUNT
    }; // end of enum WidgetSkin::WidgetBackgroundType

    enum FontType
    {
        DEFAULT_FONT = 0,

        FONT_TYPE_COUNT
    }; // end of enum WidgetSkin::FontType

    enum TextureType
    {
        CHECK_BOX_CHECK_TEXTURE = 0,
        RADIO_BUTTON_CHECK_TEXTURE,

        TEXTURE_TYPE_COUNT
    }; // end of enum WidgetSkin::TextureType

    enum MarginsType
    {
        DEFAULT_FRAME_MARGINS = 0,
        DEFAULT_CONTENT_MARGINS,
        LAYOUT_FRAME_MARGINS,
        LAYOUT_SPACING_MARGINS,

        MARGINS_TYPE_COUNT
    }; // end of enum WidgetSkin::MarginsType

    WidgetSkin (Screen const *screen);
    ~WidgetSkin ();

    WidgetSkin *CreateClone () const;

    Float RatioFromScreenCoord (ScreenCoord screen_coord) const;
    ScreenCoord ScreenCoordFromRatio (Float ratio) const;
    FloatVector2 RatiosFromScreenCoords (
        ScreenCoordVector2 const &screen_coords) const;
    ScreenCoordVector2 ScreenCoordsFromRatios (
        FloatVector2 const &ratios) const;

    inline WidgetBackground const *GetWidgetBackground (
        WidgetBackgroundType const widget_background_type) const
    {
        ASSERT1(widget_background_type < WIDGET_BACKGROUND_TYPE_COUNT);
        return m_widget_background[widget_background_type];
    }
    inline Resource<Font> const &GetFont (FontType const font_type) const
    {
        ASSERT1(font_type < FONT_TYPE_COUNT);
        return m_font_specification[font_type].m_font;
    }
    inline Resource<GLTexture> const &GetTexture (
        TextureType const texture_type) const
    {
        ASSERT1(texture_type < TEXTURE_TYPE_COUNT);
        return m_texture[texture_type];
    }
    inline ScreenCoordVector2 const &Margins (MarginsType const margins_type) const
    {
        ASSERT1(margins_type < MARGINS_TYPE_COUNT);
        return m_margins_specification[margins_type].m_margins;
    }

    void SetWidgetBackground (
        WidgetBackgroundType widget_background_type,
        WidgetBackground const *widget_background);
    void SetFont (
        FontType font_type,
        Resource<Font> const &font);
    void SetFontFacePath (
        FontType font_type,
        std::string const &font_face_path);
    void SetFontHeightRatio (
        FontType font_type,
        Float font_height_ratio);
    void SetFontHeight (
        FontType font_type,
        ScreenCoord font_height);
    void SetTexture (
        TextureType texture_type,
        Resource<GLTexture> const &texture);
    void SetTexturePath (
        TextureType texture_type,
        std::string const &texture_path);
    void SetMarginRatios (
        MarginsType margins_type,
        FloatVector2 const &margin_ratios);
    void SetMargins (
        MarginsType margins_type,
        ScreenCoordVector2 const &margins);

    // TODO: some function that updates stuff when the screen res changes

protected:

    inline WidgetSkin () { }

private:

    void UpdateFontHeight (FontType font_type);
    void UpdateMargins (MarginsType margins_type);

    struct FontSpecification
    {
        Resource<Font> m_font;
        Float m_font_height_ratio;
        ScreenCoord m_font_height;

        inline FontSpecification ()
        {
            m_font_height_ratio = 0.0f;
            m_font_height = 0;
        }
    }; // end of struct WidgetSkin::FontSpecification

    struct MarginsSpecification
    {
        FloatVector2 m_margin_ratios;
        ScreenCoordVector2 m_margins;

        inline MarginsSpecification ()
        {
            m_margin_ratios = FloatVector2::ms_zero;
            m_margins = ScreenCoordVector2::ms_zero;
        }
    }; // end of struct WidgetSkin::MarginsSpecification

    // the screen which this WidgetSkin is adapting size ratios to
    Screen const *m_screen;

    WidgetBackground const *m_widget_background[WIDGET_BACKGROUND_TYPE_COUNT];
    FontSpecification m_font_specification[FONT_TYPE_COUNT];
    Resource<GLTexture> m_texture[TEXTURE_TYPE_COUNT];
    MarginsSpecification m_margins_specification[MARGINS_TYPE_COUNT];
}; // end of class WidgetSkin

} // end of namespace Xrb

#endif // !defined(_XRB_WIDGETSKIN_HPP_)

---