GamePlay/gameplay/src/Theme.h

#ifndef THEME_H_
#define THEME_H_

#include "Base.h"
#include "Ref.h"
#include "Font.h"
#include "Rectangle.h"
#include "Texture.h"
#include "Properties.h"

namespace gameplay
{

/**
 * A theme is created and stored as part of a form and represents its appearance.
 * Once loaded, the appearance properties can be retrieved from their style IDs and set on other
 * UI controls.  A Theme has one property, 'texture', which points to a texture atlas containing
 * all the images used by the theme.  Cursor images, skins, and lists of images used by controls
 * are defined in their own namespaces.  The rest of the Theme consists of Style namespaces.
 * A Style describes the border, margin, and padding of a Control, what images, skins, and cursors
 * are associated with a Control, and Font properties to apply to a Control's text.
 *
 * Below is an explanation of the properties that can be set within themes:

@verbatim
    theme
    {
        texture = <Path to texture>

        // Describes a single image, to be used as a cursor.
        cursor <Cursor ID>
        {
            region = <x, y, width, height>
            color = <#ffffffff>
        }

        // Describes all the images used by a control for one or more states.
        imageList <ImageList ID>
        {
            image checked
            {
                region = <x, y, width, height>
            }

            image unchecked
            {
                region = <x, y, width, height>
                color = <#fffffffff>            // Optionally override image-list color.
            }

            color = <#fffffffff>    // Default blend color for images that don't specify their own.
        }
    
        // Defines the border and background of a Control.
        skin <Skin ID>
        {
            // The corners and edges of the given region will be used as border sprites.
            border
            {
                top     =   <int>   // Height of top border, top corners.
                bottom  =   <int>   // Height of bottom border, bottom corners.
                left    =   <int>   // Width of left border, left corners.
                right   =   <int>   // Width of right border, right corners.
            }
        
            region  =   <x, y, width, height>   // Total container region including entire border.
            color   =   <#ffffffff>             // Tint to apply to skin.
        }
    
        style <Style ID>
        {
            // Layouts may make use of a style's margin to put space between adjacent controls.
            margin
            {
                top     =   <int>
                bottom  =   <int>
                left    =   <int>
                right   =   <int>        
            }
        
            // Padding is the space between a control's border and its content.
            padding
            {
                top     =   <int>
                bottom  =   <int>
                left    =   <int>
                right   =   <int>        
            }
        
            // Properties used when in control is in the normal state.
            stateNormal
            {
                skin   =   <Skin ID>             // Skin to use for border and background sprites.
                imageList = <ImageList ID>

                cursor      =   <Cursor ID>                 // Cursor to use when the mouse is over this control.
                font        =   <Path to font>              // Font to use for rendering text.
                fontSize    =   <int>                       // Size of text.
                textColor   =   <#ffffffff>                 // Color of text.
                alignment   =   <Text alignment constant>   // Member of Font::Justify enum.
                rightToLeft =   <bool>                      // Whether to draw text from right to left.
                opacity     =   <float>                     // Opacity to apply to all text/border/icon colors.
            }
        
            // Properties used when in control is in the focus state
            // If not specified, the 'normal' overlay will be used.
            stateFocus
            {
                skin   =   <Skin ID>             // Skin to use for border and background sprites.
                ...
            }
        
            // Properties used when in control is in the focus. 
            // This is when a touch/mouse is down within the control.
            // If not specified, the 'normal' overlay will be used.
            stateActive
            {
                skin   =   <Skin ID>             // Skin to use for border and background sprites.
                ...
            }

            // Properties used when in control is in the focus. 
            // This is when a touch/mouse is down within the control.
            // If not specified, the 'normal' overlay will be used.
            state-disabled
            {
                skin   =   <Skin ID>             // Skin to use for border and background sprites.
                ...        
            }
        }
    }
@endverbatim
 *
 */
class Theme: public Ref
{
    friend class Control;
    friend class Container;
    friend class Form;
    friend class Skin;

public:

    /**
     * Class representing a set of themed attributes that can be
     * assigned to a control.
     *
     * Defined in "ThemeStyle.h"
     */
    class Style;
    friend class Style;

    /**
     * Struct representing the UV coordinates of a rectangular image.
     */
    struct UVs
    {
        /**
         * Constructor.
         */
        UVs();

        /**
         * Constructor
         *
         * @param u1 u component of the first UV coordinate.
         * @param v1 v component of the first UV coordinate.
         * @param u2 u component of the second UV coordinate.
         * @param v2 v component of the second UV coordinate.
         */
        UVs(float u1, float v1, float u2, float v2);

        /**
         * Get's an empty UVs.
         */
        static const UVs& empty();

        /**
         * u component of the first UV coordinate.
         */
        float u1;
        
        /**
         * v component of the first UV coordinate.
         */
        float v1;
        
        /**
         * u component of the second UV coordinate.
         */
        float u2;
        
        /**
         * v component of the second UV coordinate.
         */
        float v2;
    };

    /**
     * Struct representing margin, border, and padding areas by
     * the width or height of each side.
     */
    struct SideRegions
    {
        /** 
         * Constructor.
         */
        SideRegions() : top(0), bottom(0), left(0), right(0) {}

        /**
         * Gets an empty SideRegion.
         */
        static const SideRegions& empty();

        /**
         * The top of the SideRegion.
         */
        float top;
        
        /**
         * The bottom of the SideRegion.
         */
        float bottom;
        
        /**
         * The left side of the SideRegion.
         */
        float left;
        
        /**
         * The right side of the SideRegion.
         */
        float right;
    };
    
    /** 
     * Struct representing margin areas by the width or height of each side.
     */
    typedef SideRegions Margin;
    
    /** 
     * Struct representing border areas by the width or height of each side.
     */
    typedef SideRegions Border;
    
    /** 
     * Struct representing padding areas by the width or height of each side.
     */
    typedef SideRegions Padding;

    /**
     * Class representing an image within the theme's texture atlas.
     * An image has a region and a blend color in addition to an ID.
     * UV coordinates are calculated from the region and can be retrieved.
     */
    class ThemeImage : public Ref
    {
        friend class Theme;
        friend class Control;

    public:

        /**
         * Gets the ID of the ThemeImage.
         */
        const char* getId() const;

        /**
         * Gets the UV coordinates for the ThemeImage.
         */
        const UVs& getUVs() const;

        /** 
         * Gets the Rectangle region of the ThemeImage.
         */
        const Rectangle& getRegion() const;

        /** 
         * Gets the color of the ThemeImage in a Vector4.
         */
        const Vector4& getColor() const;

    private:

        ThemeImage(float tw, float th, const Rectangle& region, const Vector4& color);

        ~ThemeImage();

        static ThemeImage* create(float tw, float th, Properties* properties, const Vector4& defaultColor);

        std::string _id;
        UVs _uvs;
        Rectangle _region;
        Vector4 _color;
    };

private:

    /**
     * Class representing a collection of theme images.  An image list
     * can be assigned to each overlay of a style, and controls
     * using the style can then retrieve images by ID in order to draw themselves.
     */
    class ImageList : public Ref
    {
        friend class Theme;
        friend class Control;

    public:

        const char* getId() const;

        ThemeImage* getImage(const char* imageId) const;

    private:

        ImageList(const Vector4& color);

        ImageList(const ImageList& copy);

        ~ImageList();

        static ImageList* create(float tw, float th, Properties* properties);

        std::string _id;
        std::vector<ThemeImage*> _images;
        Vector4 _color;
    };

    /**
     * A skin defines the border and background of a control.
     */
    class Skin : public Ref
    {
        friend class Theme;

    public:

        enum SkinArea
        {
            TOP_LEFT, TOP, TOP_RIGHT,
            LEFT, CENTER, RIGHT,
            BOTTOM_LEFT, BOTTOM, BOTTOM_RIGHT
        };

        /**
         * Gets this skin's ID.
         *
         * @return This skin's ID.
         */
        const char* getId() const;

        /**
         * Gets this skin's border.
         *
         * @return This skin's border.
         */
        const Theme::Border& getBorder() const;

        const Rectangle& getRegion() const;

        /**
         * Gets this skin's UVs.
         *
         * @return This skin's UVs.
         */
        const Theme::UVs& getUVs(SkinArea area) const;

        /**
         * Gets this skin's color.
         *
         * @return This skin's color.
         */
        const Vector4& getColor() const;

    private:

        Skin(float tw, float th, const Rectangle& region, const Theme::Border& border, const Vector4& color);
        
        ~Skin();

        static Skin* create(const char* id, float tw, float th, const Rectangle& region, const Theme::Border& border, const Vector4& color);

        void setRegion(const Rectangle& region, float tw, float th);
    
        std::string _id;
        Theme::Border _border;
        UVs _uvs[9];
        Vector4 _color;
        Rectangle _region;
        float _tw, _th;
    };

    /**
     * Constructor.
     */
    Theme();

    /**
     * Constructor.
     */
    Theme(const Theme& theme);

    /**
     * Destructor.
     */
    ~Theme();

    /**
     * Creates an instance of a Theme using the data from the Properties object defined at the specified URL, 
     * where the URL is of the format "<file-path>.<extension>#<namespace-id>/<namespace-id>/.../<namespace-id>"
     * (and "#<namespace-id>/<namespace-id>/.../<namespace-id>" is optional). 
     * 
     * @param url The URL pointing to the Properties object defining the theme.
     *
     * @return A new Theme.
     */
    static Theme* create(const char* url);

    Theme::Style* getStyle(const char* id) const;

    void setProjectionMatrix(const Matrix& matrix);

    SpriteBatch* getSpriteBatch() const;

    static void generateUVs(float tw, float th, float x, float y, float width, float height, UVs* uvs);

    void lookUpSprites(const Properties* overlaySpace, ImageList** imageList, ThemeImage** mouseCursor, Skin** skin);

    std::string _url;
    Texture* _texture;
    SpriteBatch* _spriteBatch;
    std::vector<Style*> _styles;
    std::vector<ThemeImage*> _images;
    std::vector<ImageList*> _imageLists;
    std::vector<Skin*> _skins;
    std::set<Font*> _fonts;
};

}

#endif