CRect.hpp

Go to the documentation of this file.

#ifndef __CRect__
#define __CRect__

#include "CPoint.hpp"
#include "CDimension.hpp"
#include "../Basics/CString.hpp"
using Exponent::Basics::CString;
using Exponent::MathTools::CDimension;
using Exponent::MathTools::CPoint;

//  ===========================================================================

namespace Exponent
{
    namespace MathTools
    {
        class CRect : public CCountedObject
        {
            EXPONENT_CLASS_DECLARATION;
//  ===========================================================================

        public:

//  ===========================================================================

            CRect(const long left = 0, const long top = 0, const long width = 0, const long height = 0);

            CRect(const CRect &rect);

            CRect(const CPoint &origin, const CDimension &dimension);

            virtual ~CRect();

//  ===========================================================================

            virtual CRect &operator = (const CRect &rect);

            virtual bool operator == (const CRect &rect);

//  ===========================================================================

            void setRect(const long left, const long top, const long width, const long height);

            void setRect(const CPoint &origin, const CDimension &dimension);

            void setLeft(const long left);

            /* 
             * Set the width
             * @param width The width of the rectangle 
             */
            void setWidth(const long width);

            void setTop(const long top);

            void setHeight(const long height);

            void setOrigin(const CPoint &point);

            void setDimensions(const CDimension &dimension);

//  ===========================================================================

            long getLeft() const { return m_left; }

            long getRight() const { return m_right; }

            long getTop() const { return m_top; }

            long getBottom() const { return m_bottom; }

            long getWidth() const { return m_width; }

            long getHeight() const { return m_height; }

            CPoint getOrigin() const { return CPoint(m_left, m_top); }

            CDimension getDimension() const { return CDimension(m_width, m_height); }

            long getCentralXPosition() const;

            long getCentralYPosition() const;

//  ===========================================================================

#ifdef WIN32

            RECT getAsRect();

            void setFromRect(RECT &rect);
#else

            Rect *getAsRect() const;

            void setFromRect(Rect &rect);
#endif

            FORCEINLINE bool pointIsInside(const CPoint &point) const
            {
                return ((point.getXPosition() >= m_left)  &&
                       (point.getXPosition()  <= m_right) &&
                       (point.getYPosition()  >= m_top)   &&
                       (point.getYPosition()  <= m_bottom));
            }

            FORCEINLINE bool rectIsInside(const CRect &rect) const 
            {
                return ((rect.getLeft()   >= m_left)  &&
                        (rect.getTop()    >= m_top)   &&
                        (rect.getRight()  <= m_right) &&
                        (rect.getBottom() <= m_bottom));
            }

            FORCEINLINE bool rectanglesIntersect(const CRect& other) const
            {
                return !((m_left > other.getRight()) ||
                        (m_top > other.getBottom())  ||
                        (other.getLeft() > m_right)  ||
                        (other.getTop() > m_bottom));
            }

            FORCEINLINE bool isRectangleEmpty() const
            {
                return (m_left == 0 && m_top == 0 && m_width == 0 && m_height == 0);
            }

            void offset(const CPoint &point);

            void inset(const long amount);

            void scale(const double amount);

            static CRect *getIntersectionArea(const CRect &rect1, const CRect &rect2);

            static void getIntersectionArea(const CRect &rect1, const CRect &rect2, CRect &output);
            
            void unionWith(const CRect &rect);

            virtual void getObjectDescription(char *string, const long size) const;

            static CRect convertFromString(const CString &string);

//  ===========================================================================

        protected:

//  ===========================================================================

            long m_width;                   
            long m_height;                  
            long m_left;                    
            long m_right;                   
            long m_top;                     
            long m_bottom;                  
        };
    }
}
#endif  // End of CRect.hpp

---