ColourRect.h

/***********************************************************************
        filename:       CEGUIColourRect.h
        created:        8/3/2004
        author:         Paul D Turner
        
        purpose:        Defines class representing colours for four corners of a
                                rectangle
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIColourRect_h_
#define _CEGUIColourRect_h_

#include "CEGUI/Base.h"
#include "CEGUI/Colour.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ColourRect :
    public AllocatedObject<ColourRect>
{
public:
        ColourRect(void);


        ColourRect(const Colour& col);


        ColourRect(const Colour& top_left, const Colour& top_right, const Colour& bottom_left, const Colour& bottom_right);


        void    setAlpha(float alpha);


        void    setTopAlpha(float alpha);


        void    setBottomAlpha(float alpha);


        void    setLeftAlpha(float alpha);


        void    setRightAlpha(float alpha);


        bool    isMonochromatic() const;


        ColourRect getSubRectangle( float left, float right, float top, float bottom ) const;

        Colour getColourAtPoint( float x, float y ) const;


        void    setColours(const Colour& col);


        void    modulateAlpha(float alpha);

    ColourRect& operator*=(const ColourRect& other);

        inline ColourRect operator*(const float val) const
    {       
        return ColourRect(
            d_top_left * val, 
            d_top_right * val, 
            d_bottom_left * val,
            d_bottom_right * val 
        );  
    }

        inline ColourRect operator+(const ColourRect& val) const
    {       
        return ColourRect(
            d_top_left + val.d_top_left, 
            d_top_right + val.d_top_right, 
            d_bottom_left + val.d_bottom_left,
            d_bottom_right + val.d_bottom_right 
        );  
    }


        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_