index e52d6a7e6a0b1296656d2631859e84f57e7f9ce0..c2ea8db0a66f6fd549a6de1d77a5af43e6152c41 100644 (file)
@@ -41,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 {
@@ -50,10 +50,10 @@ 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)
@@ -61,85 +61,84 @@ public:

/**
* 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)
{}
-
+
/**
* 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.
+        * \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 x x-coordinate of point to test.
* \param y y-coordinate of point to test.
* \return boolean value (true if point is inside).
*/
@@ -147,16 +146,16 @@ public:

/**
* 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);

@@ -164,10 +163,10 @@ public:
* 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);

@@ -175,8 +174,8 @@ public:
* 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;