CEGUIRect.h

/***********************************************************************
        filename:       CEGUIRect.h
        created:        8/3/2004
        author:         Paul D Turner
        
        purpose:        Defines 'Rect' class
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIRect_h_
#define _CEGUIRect_h_

#include "CEGUIBase.h"
#include "CEGUIVector.h"
#include "CEGUISize.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT Rect
{
public:
        Rect(void) {}


        Rect(float left, float top, float right, float bottom);

    Rect(Point pos, Size sz);


        Point   getPosition(void) const         {return Point(d_left, d_top);}

        float   getWidth(void) const            {return d_right - d_left;}


        float   getHeight(void) const           {return d_bottom - d_top;}


        Size    getSize(void) const                     {return Size(getWidth(), getHeight());}


        void    setPosition(const Point& pt);


        void    setWidth(float width)           {d_right = d_left + width;}

        void    setHeight(float height)         {d_bottom = d_top + height;}


        void    setSize(const Size& sze)        {setWidth(sze.d_width); setHeight(sze.d_height);}


        Rect    getIntersection(const Rect& rect) const;


        Rect&   offset(const Point& pt);


        bool    isPointInRect(const Point& pt) const;


        Rect&   constrainSizeMax(const Size& sz);


        Rect&   constrainSizeMin(const Size& sz);


        Rect&   constrainSize(const Size& max_sz, const Size& min_sz);


        /*************************************************************************
                Operators
        *************************************************************************/
        bool    operator==(const Rect& rhs) const
        {
                return ((d_left == rhs.d_left) && (d_right == rhs.d_right) && (d_top == rhs.d_top) && (d_bottom == rhs.d_bottom));
        }

        bool    operator!=(const Rect& rhs) const               {return !operator==(rhs);}

        Rect&   operator=(const Rect& rhs);

    Rect operator*(float scalar) const      { return Rect(d_left * scalar, d_top * scalar, d_right * scalar, d_bottom * scalar); }
    const Rect& operator*=(float scalar)    { d_left *= scalar; d_top *= scalar; d_right *= scalar; d_bottom *= scalar; return *this; }

        Rect operator+(const Rect& r) const             { return Rect(d_left + r.d_left, d_top + r.d_top, d_right + r.d_right, d_bottom + r.d_bottom); }


        /*************************************************************************
                Data Fields
        *************************************************************************/
        float   d_left, d_top, d_right, d_bottom;
};

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIRect_h_