source: OGRE/trunk/ogrenew/Dependencies/include/CEGUI/CEGUIColourRect.h @ 657

/************************************************************************
        filename:       CEGUIColourRect.h
        created:        8/3/2004
        author:         Paul D Turner
        
        purpose:        Defines class representing colours for four corners of a
                                rectangle
*************************************************************************/
/*************************************************************************
    Crazy Eddie's GUI System (http://www.cegui.org.uk)
    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*************************************************************************/
#ifndef _CEGUIColourRect_h_
#define _CEGUIColourRect_h_

#include "CEGUIBase.h"
#include "CEGUIcolour.h"

// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
        Class that holds details of colours for the four corners of a rectangle.
*/
class CEGUIEXPORT ColourRect
{
public:
        /*!
        \brief
                Default constructor
        */
        ColourRect(void);


        /*!
        \brief
                Constructor for ColourRect objects (via single colour).  Also handles default construction.
        */
        ColourRect(const colour& col);


        /*!
        \brief
                Constructor for ColourRect objects
        */
        ColourRect(const colour& top_left, const colour& top_right, const colour& bottom_left, const colour& bottom_right);


        /*!
        \brief
                Set the alpha value to use for all four corners of the ColourRect.

        \param alpha
                Alpha value to use.

        \return
                Nothing.
        */
        void    setAlpha(float alpha);


        /*!
        \brief
                Set the alpha value to use for the top edge of the ColourRect.

        \param alpha
                Alpha value to use.

        \return
                Nothing.
        */
        void    setTopAlpha(float alpha);


        /*!
        \brief
                Set the alpha value to use for the bottom edge of the ColourRect.

        \param alpha
                Alpha value to use.

        \return
                Nothing.
        */
        void    setBottomAlpha(float alpha);


        /*!
        \brief
                Set the alpha value to use for the left edge of the ColourRect.

        \param alpha
                Alpha value to use.

        \return
                Nothing.
        */
        void    setLeftAlpha(float alpha);


        /*!
        \brief
                Set the alpha value to use for the right edge of the ColourRect.

        \param alpha
                Alpha value to use.

        \return
                Nothing.
        */
        void    setRightAlpha(float alpha);


        /*!
        \brief
                Determinate the ColourRect is monochromatic or variegated.

        \return
                True if all four corners of the ColourRect has same colour, false otherwise.
        */
        bool    isMonochromatic() const;


        /*!
        \brief
                Gets a portion of this ColourRect as a subset ColourRect

        \param left
                The left side of this subrectangle (in the range of 0-1 float)
        \param right
                The right side of this subrectangle (in the range of 0-1 float)
        \param top
                The top side of this subrectangle (in the range of 0-1 float)
        \param bottom
                The bottom side of this subrectangle (in the range of 0-1 float)

        \return
                A ColourRect from the specified range
        */
        ColourRect getSubRectangle( float left, float right, float top, float bottom ) const;

        /*!
        \brief
                Get the colour at a point in the rectangle

        \param x
                The x coordinate of the point
        \param y
                The y coordinate of the point

        \return
                The colour at the specified point.
        */
        colour getColourAtPoint( float x, float y ) const;


        /*!
        \brief
                Set the colour of all four corners simultaneously.

        \param col
                colour that is to be set for all four corners of the ColourRect;
        */
        void    setColours(const colour& col);


        /*!
        \brief
                Module the alpha components of each corner's colour by a constant.

        \param alpha
                The constant factor to modulate all alpha colour components by.
        */
        void    modulateAlpha(float alpha);


        colour  d_top_left, d_top_right, d_bottom_left, d_bottom_right;         //<! ColourRect component colours
};

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIColourRect_h_