Merge branch 'master' into blender2.8
[blender.git] / intern / ghost / GHOST_Rect.h
index c8cfc79ea9d8ec83944f908d6ef4239119ffcec8..c2ea8db0a66f6fd549a6de1d77a5af43e6152c41 100644 (file)
@@ -1,14 +1,10 @@
-/**
- * $Id$
- * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version. The Blender
- * Foundation also sells licenses for use in proprietary software under
- * the Blender License.  See http://www.blender.org/BL/ for information
- * about this.
+ * of the License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -17,7 +13,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
  *
  * Contributor(s): none yet.
  *
- * ***** END GPL/BL DUAL LICENSE BLOCK *****
+ * ***** END GPL LICENSE BLOCK *****
  */
 
-/**
-
- * $Id$
- * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+/** \file ghost/intern/GHOST_Debug.h
+ *  \ingroup GHOST
+ * Macro's used in GHOST debug target.
  */
 
-#ifndef _H_GHOST_Rect
-#define _H_GHOST_Rect
+#ifndef __GHOST_RECT_H__
+#define __GHOST_RECT_H__
 
 #include "GHOST_Types.h"
 
@@ -48,8 +41,8 @@
  * The four extreme coordinates are stored as left, top, right and bottom.
  * To be valid, a rectangle should have a left coordinate smaller than or equal to right.
  * To be valid, a rectangle should have a top coordinate smaller than or equal to bottom.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+ * \author  Maarten Gribnau
+ * \date    May 10, 2001
  */
 
 class GHOST_Rect {
@@ -57,125 +50,134 @@ public:
 
        /**
         * Constructs a rectangle with the given values.
-        * @param       l       requested left coordinate of the rectangle
-        * @param       t       requested top coordinate of the rectangle
-        * @param       r       requested right coordinate of the rectangle
-        * @param       b       requested bottom coordinate of the rectangle
+        * \param l requested left coordinate of the rectangle
+        * \param t requested top coordinate of the rectangle
+        * \param r requested right coordinate of the rectangle
+        * \param b requested bottom coordinate of the rectangle
         */
-       GHOST_Rect(GHOST_TInt32 l=0, GHOST_TInt32 t=0, GHOST_TInt32 r=0, GHOST_TInt32 b=0)
-               : m_l(l), m_t(t), m_r(r), m_b(b) {}
+       GHOST_Rect(GHOST_TInt32 l = 0, GHOST_TInt32 t = 0, GHOST_TInt32 r = 0, GHOST_TInt32 b = 0)
+               : m_l(l), m_t(t), m_r(r), m_b(b)
+       {}
 
        /**
         * Copy constructor.
-        * @param       r       rectangle to copy
+        * \param   r   rectangle to copy
         */
        GHOST_Rect(const GHOST_Rect& r)
-               : m_l(r.m_l), m_t(r.m_t), m_r(r.m_r), m_b(r.m_b) {}
-       
+               : m_l(r.m_l), m_t(r.m_t), m_r(r.m_r), m_b(r.m_b)
+       {}
+
        /**
         * Destructor.
         */
-       virtual ~GHOST_Rect() {};
+       virtual ~GHOST_Rect() {}
 
        /**
         * Access to rectangle width.
-        * @return      width of the rectangle
+        * \return  width of the rectangle
         */
        virtual inline GHOST_TInt32 getWidth() const;
 
        /**
         * Access to rectangle height.
-        * @return      height of the rectangle
+        * \return  height of the rectangle
         */
        virtual inline GHOST_TInt32 getHeight() const;
 
        /**
         * Sets all members of the rectangle.
-        * @param       l       requested left coordinate of the rectangle
-        * @param       t       requested top coordinate of the rectangle
-        * @param       r       requested right coordinate of the rectangle
-        * @param       b       requested bottom coordinate of the rectangle
+        * \param   l   requested left coordinate of the rectangle
+        * \param   t   requested top coordinate of the rectangle
+        * \param   r   requested right coordinate of the rectangle
+        * \param   b   requested bottom coordinate of the rectangle
         */
        virtual inline void set(GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOST_TInt32 b);
 
        /**
         * Returns whether this rectangle is empty.
         * Empty rectangles are rectangles that have width==0 and/or height==0.
-        * @return      boolean value (true==empty rectangle)
+        * \return  boolean value (true==empty rectangle)
         */
        virtual inline bool isEmpty() const;
 
        /**
         * Returns whether this rectangle is valid.
-        * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are valid.
-        * @return      boolean value (true==valid rectangle)
+        * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, empty rectangles are valid.
+        * \return  boolean value (true==valid rectangle)
         */
        virtual inline bool isValid() const;
 
        /**
         * Grows (or shrinks the rectangle).
         * The method avoids negative insets making the rectangle invalid
-        * @param       i       The amount of offset given to each extreme (negative values shrink the rectangle).
+        * \param   i   The amount of offset given to each extreme (negative values shrink the rectangle).
         */
        virtual void inset(GHOST_TInt32 i);
 
        /**
         * Does a union of the rectangle given and this rectangle.
         * The result is stored in this rectangle.
-        * @param       r       The rectangle that is input for the union operation.
+        * \param   r   The rectangle that is input for the union operation.
         */
        virtual inline void unionRect(const GHOST_Rect& r);
 
        /**
         * Grows the rectangle to included a point.
-        * @param       x       The x-coordinate of the point.
-        * @param       y       The y-coordinate of the point.
+        * \param   x   The x-coordinate of the point.
+        * \param   y   The y-coordinate of the point.
         */
        virtual inline void unionPoint(GHOST_TInt32 x, GHOST_TInt32 y);
 
+       /**
+        * Grows the rectangle to included a point.
+        * \param   x   The x-coordinate of the point.
+        * \param   y   The y-coordinate of the point.
+        */
+       virtual inline void wrapPoint(GHOST_TInt32 &x, GHOST_TInt32 &y, GHOST_TInt32 ofs);
+
        /**
         * Returns whether the point is inside this rectangle.
         * Point on the boundary is considered inside.
-        * @param x     x-coordinate of point to test.
-        * @param y y-coordinate of point to test.
-        * @return boolean value (true if point is inside).
+        * \param x x-coordinate of point to test.
+        * \param y y-coordinate of point to test.
+        * \return boolean value (true if point is inside).
         */
        virtual inline bool isInside(GHOST_TInt32 x, GHOST_TInt32 y) const;
 
        /**
         * Returns whether the rectangle is inside this rectangle.
-        * @param       r       rectangle to test.
-        * @return      visibility (not, partially or fully visible).
+        * \param   r   rectangle to test.
+        * \return  visibility (not, partially or fully visible).
         */
        virtual GHOST_TVisibility getVisibility(GHOST_Rect& r) const;
 
        /**
         * Sets rectangle members.
         * Sets rectangle members such that it is centered at the given location.
-        * @param       cx      requested center x-coordinate of the rectangle
-        * @param       cy      requested center y-coordinate of the rectangle
+        * \param   cx  requested center x-coordinate of the rectangle
+        * \param   cy  requested center y-coordinate of the rectangle
         */
-       virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy);
+       virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy);
 
        /**
         * Sets rectangle members.
         * Sets rectangle members such that it is centered at the given location,
         * with the width requested.
-        * @param       cx      requested center x-coordinate of the rectangle
-        * @param       cy      requested center y-coordinate of the rectangle
-        * @param       w       requested width of the rectangle
-        * @param       h       requested height of the rectangle
+        * \param   cx  requested center x-coordinate of the rectangle
+        * \param   cy  requested center y-coordinate of the rectangle
+        * \param   w   requested width of the rectangle
+        * \param   h   requested height of the rectangle
         */
-       virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy, GHOST_TInt32 w, GHOST_TInt32 h);
+       virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy, GHOST_TInt32 w, GHOST_TInt32 h);
 
        /**
         * Clips a rectangle.
         * Updates the rectangle given such that it will fit within this one.
         * This can result in an empty rectangle.
-        * @param       r       the rectangle to clip
-        * @return      whether clipping has occurred
+        * \param   r   the rectangle to clip
+        * \return  whether clipping has occurred
         */
-       virtual bool clip(GHOST_Rect& r) const;
+       virtual bool clip(GHOST_Rect& r) const;
 
        /** Left coordinate of the rectangle */
        GHOST_TInt32 m_l;
@@ -185,6 +187,10 @@ public:
        GHOST_TInt32 m_r;
        /** Bottom coordinate of the rectangle */
        GHOST_TInt32 m_b;
+
+#ifdef WITH_CXX_GUARDEDALLOC
+       MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_Rect")
+#endif
 };
 
 
@@ -203,7 +209,7 @@ inline void GHOST_Rect::set(GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOS
        m_l = l; m_t = t; m_r = r; m_b = b;
 }
 
-inline bool    GHOST_Rect::isEmpty() const
+inline bool GHOST_Rect::isEmpty() const
 {
        return (getWidth() == 0) || (getHeight() == 0);
 }
@@ -228,10 +234,27 @@ inline void GHOST_Rect::unionPoint(GHOST_TInt32 x, GHOST_TInt32 y)
        if (y < m_t) m_t = y;
        if (y > m_b) m_b = y;
 }
+#include <stdio.h>
+inline void GHOST_Rect::wrapPoint(GHOST_TInt32 &x, GHOST_TInt32 &y, GHOST_TInt32 ofs)
+{
+       GHOST_TInt32 w = getWidth();
+       GHOST_TInt32 h = getHeight();
+
+       /* highly unlikely but avoid eternal loop */
+       if (w - ofs * 2 <= 0 || h - ofs * 2 <= 0) {
+               return;
+       }
+
+       while (x - ofs < m_l) x += w - (ofs * 2);
+       while (y - ofs < m_t) y += h - (ofs * 2);
+       while (x + ofs > m_r) x -= w - (ofs * 2);
+       while (y + ofs > m_b) y -= h - (ofs * 2);
+}
 
 inline bool GHOST_Rect::isInside(GHOST_TInt32 x, GHOST_TInt32 y) const
 {
        return (x >= m_l) && (x <= m_r) && (y >= m_t) && (y <= m_b);
 }
 
-#endif // _H_GHOST_Rect
+#endif // __GHOST_RECT_H__
+