CEGUIFalDimensions.h

/***********************************************************************
    filename:   CEGUIFalDimensions.h
    created:    Mon Jun 13 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIFalDimensions_h_
#define _CEGUIFalDimensions_h_

#include "CEGUIFalEnums.h"
#include "../CEGUIString.h"
#include "../CEGUIUDim.h"
#include "../CEGUIXMLSerializer.h"

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT BaseDim
    {
    public:
        BaseDim();

        virtual ~BaseDim();

        float getValue(const Window& wnd) const;

        float getValue(const Window& wnd, const Rect& container) const;

        BaseDim* clone() const;

        DimensionOperator getDimensionOperator() const;

        void setDimensionOperator(DimensionOperator op);

        const BaseDim* getOperand() const;

        void setOperand(const BaseDim& operand);

        void writeXMLToStream(XMLSerializer& xml_stream) const;

    protected:
        virtual float getValue_impl(const Window& wnd) const = 0;

        virtual float getValue_impl(const Window& wnd, const Rect& container) const = 0;

        virtual BaseDim* clone_impl() const = 0;

        virtual void writeXMLElementName_impl(XMLSerializer& xml_stream) const = 0;

        virtual void writeXMLElementAttributes_impl(XMLSerializer& xml_stream) const = 0;

    private:
        DimensionOperator   d_operator;
        BaseDim*            d_operand;
    };


    class CEGUIEXPORT AbsoluteDim : public BaseDim
    {
    public:
        AbsoluteDim(float val);

        void setValue(float val);

    protected:
        // Implementation of the base class interface
        float getValue_impl(const Window& wnd) const;
        float getValue_impl(const Window& wnd, const Rect& container) const;
        void writeXMLElementName_impl(XMLSerializer& xml_stream) const;
        void writeXMLElementAttributes_impl(XMLSerializer& xml_stream) const;

        BaseDim* clone_impl() const;

    private:
        float d_val;    
    };


    class CEGUIEXPORT ImageDim : public BaseDim
    {
    public:
        ImageDim(const String& imageset, const String& image, DimensionType dim);

        void setSourceImage(const String& imageset, const String& image);

        void setSourceDimension(DimensionType dim);

    protected:
        // Implementation of the base class interface
        float getValue_impl(const Window& wnd) const;
        float getValue_impl(const Window& wnd, const Rect& container) const;
        void writeXMLElementName_impl(XMLSerializer& xml_stream) const;
        void writeXMLElementAttributes_impl(XMLSerializer& xml_stream) const;
        BaseDim* clone_impl() const;

    private:
        String d_imageset;      
        String d_image;         
        DimensionType d_what;   
    };


    class CEGUIEXPORT WidgetDim : public BaseDim
    {
    public:
        WidgetDim(const String& name, DimensionType dim);

        void setWidgetName(const String& name);

        void setSourceDimension(DimensionType dim);

    protected:
        // Implementation of the base class interface
        float getValue_impl(const Window& wnd) const;
        float getValue_impl(const Window& wnd, const Rect& container) const;
        void writeXMLElementName_impl(XMLSerializer& xml_stream) const;
        void writeXMLElementAttributes_impl(XMLSerializer& xml_stream) const;
        BaseDim* clone_impl() const;

    private:
        String d_widgetName;    
        DimensionType d_what;   
    };


    class CEGUIEXPORT UnifiedDim : public BaseDim
    {
    public:
        UnifiedDim(const UDim& value, DimensionType dim);

    protected:
        // Implementation of the base class interface
        float getValue_impl(const Window& wnd) const;
        float getValue_impl(const Window& wnd, const Rect& container) const;
        void writeXMLElementName_impl(XMLSerializer& xml_stream) const;
        void writeXMLElementAttributes_impl(XMLSerializer& xml_stream) const;
        BaseDim* clone_impl() const;

    private:
        UDim d_value;           
        DimensionType d_what;   
    };

    class CEGUIEXPORT FontDim : public BaseDim
    {
    public:
        FontDim(const String& name, const String& font, const String& text, FontMetricType metric, float padding = 0);

    protected:
        // Implementation of the base class interface
        float getValue_impl(const Window& wnd) const;
        float getValue_impl(const Window& wnd, const Rect& container) const;
        void writeXMLElementName_impl(XMLSerializer& xml_stream) const;
        void writeXMLElementAttributes_impl(XMLSerializer& xml_stream) const;
        BaseDim* clone_impl() const;

    private:
        String  d_font;          
        String  d_text;          
        String  d_childSuffix;   
        FontMetricType d_metric; 
        float   d_padding;       
    };

    class CEGUIEXPORT PropertyDim : public BaseDim
    {
    public:
        PropertyDim(const String& name, const String& property, DimensionType type);

    protected:
        // Implementation of the base class interface
        float getValue_impl(const Window& wnd) const;
        float getValue_impl(const Window& wnd, const Rect& container) const;
        void writeXMLElementName_impl(XMLSerializer& xml_stream) const;
        void writeXMLElementAttributes_impl(XMLSerializer& xml_stream) const;
        BaseDim* clone_impl() const;

    private:
        String d_property;      
        String d_childSuffix;   
        DimensionType d_type;   
    };

    class CEGUIEXPORT Dimension
    {
    public:
        Dimension();

        ~Dimension();

        Dimension(const BaseDim& dim, DimensionType type);

        Dimension(const Dimension& other);

        Dimension& operator=(const Dimension& other);

        const BaseDim& getBaseDimension() const;

        void setBaseDimension(const BaseDim& dim);

        DimensionType getDimensionType() const;

        void setDimensionType(DimensionType type);

        void writeXMLToStream(XMLSerializer& xml_stream) const;

    private:
        BaseDim*        d_value;    
        DimensionType   d_type;     
    };


    class CEGUIEXPORT ComponentArea
    {
    public:
        Rect getPixelRect(const Window& wnd) const;

        Rect getPixelRect(const Window& wnd, const Rect& container) const;

        void writeXMLToStream(XMLSerializer& xml_stream) const;

        bool isAreaFetchedFromProperty() const;

        const String& getAreaPropertySource() const;

        void setAreaPropertySource(const String& property);


        Dimension d_left;   
        Dimension d_top;    
        Dimension d_right_or_width;     
        Dimension d_bottom_or_height;   

    private:
        String  d_areaProperty;         
    };

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIFalDimensions_h_