From: Dana Jansens Date: Mon, 4 Nov 2002 02:54:15 +0000 (+0000) Subject: documented X-Git-Url: https://git.brokenzipper.com/gitweb?a=commitdiff_plain;h=e9085c3a45be749fb5bda969552be52a0d60afe0;p=chaz%2Fopenbox documented --- diff --git a/otk/rect.hh b/otk/rect.hh index a11f3a25..1ffefcba 100644 --- a/otk/rect.hh +++ b/otk/rect.hh @@ -10,55 +10,194 @@ extern "C" { namespace otk { +//! The Rect class defines a rectangle in the plane. class Rect { public: + //! Constructs an invalid Rect inline Rect(void) : _x1(0), _y1(0), _x2(0), _y2(0) { } - inline Rect(int __x, int __y, unsigned int __w, unsigned int __h) - : _x1(__x), _y1(__y), _x2(__w + __x - 1), _y2(__h + __y - 1) { } + //! Constructs a Rect + /*! + @param x The x component of the point defining the top left corner of the + rectangle + @param y The y component of the point defining the top left corner of the + rectangle + @param w The width of the rectangle + @param h The height of the rectangle + */ + inline Rect(int x, int y, unsigned int w, unsigned int h) + : _x1(x), _y1(y), _x2(w + x - 1), _y2(h + y - 1) { } + //! Constructs a Rect from an XRectangle inline explicit Rect(const XRectangle& xrect) : _x1(xrect.x), _y1(xrect.y), _x2(xrect.width + xrect.x - 1), _y2(xrect.height + xrect.y - 1) { } + //! Returns the left coordinate of the Rect. Identical to Rect::x. inline int left(void) const { return _x1; } + //! Returns the top coordinate of the Rect. Identical to Rect::y. inline int top(void) const { return _y1; } + //! Returns the right coordinate of the Rect inline int right(void) const { return _x2; } + //! Returns the bottom coordinate of the Rect inline int bottom(void) const { return _y2; } + //! The x component of the point defining the top left corner of the Rect inline int x(void) const { return _x1; } + //! The y component of the point defining the top left corner of the Rect inline int y(void) const { return _y1; } - void setX(int __x); - void setY(int __y); - void setPos(int __x, int __y); - + //! Sets the x coordinate of the Rect. + /*! + @param x The new x component of the point defining the top left corner of + the rectangle + */ + void setX(int x); + //! Sets the y coordinate of the Rect. + /*! + @param y The new y component of the point defining the top left corner of + the rectangle + */ + void setY(int y); + //! Sets the x and y coordinates of the Rect. + /*! + @param x The new x component of the point defining the top left corner of + the rectangle + @param y The new y component of the point defining the top left corner of + the rectangle + */ + void setPos(int x, int y); + + //! The width of the Rect inline unsigned int width(void) const { return _x2 - _x1 + 1; } + //! The height of the Rect inline unsigned int height(void) const { return _y2 - _y1 + 1; } - void setWidth(unsigned int __w); - void setHeight(unsigned int __h); - void setSize(unsigned int __w, unsigned int __h); - - void setRect(int __x, int __y, unsigned int __w, unsigned int __h); - - void setCoords(int __l, int __t, int __r, int __b); - + //! Sets the width of the Rect + /*! + @param w The new width of the rectangle + */ + void setWidth(unsigned int w); + //! Sets the height of the Rect + /*! + @param h The new height of the rectangle + */ + void setHeight(unsigned int h); + //! Sets the width of the Rect. + /*! + @param w The new width of the rectangle + @param h The new height of the rectangle + */ + void setSize(unsigned int w, unsigned int h); + + //! Sets the position and size of the Rect + /*! + @param x The new x component of the point defining the top left corner of + the rectangle + @param y The new y component of the point defining the top left corner of + the rectangle + @param w The new width of the rectangle + @param h The new height of the rectangle + */ + void setRect(int x, int y, unsigned int w, unsigned int h); + + //! Sets the position of all 4 sides of the Rect + /*! + @param l The new left coordinate of the rectangle + @param t The new top coordinate of the rectangle + @param r The new right coordinate of the rectangle + @param b The new bottom coordinate of the rectangle + */ + void setCoords(int l, int t, int r, int b); + + //! Determines if two Rect objects are equal + /*! + The rectangles are considered equal if they are in the same position and + are the same size. + */ inline bool operator==(const Rect &a) { return _x1 == a._x1 && _y1 == a._y1 && _x2 == a._x2 && _y2 == a._y2; } + //! Determines if two Rect objects are inequal + /*! + @see operator== + */ inline bool operator!=(const Rect &a) { return ! operator==(a); } + //! Returns the union of two Rect objects + /*! + The union of the rectangles will consist of the maximimum area that the two + rectangles can make up. + @param a A second Rect object to form a union with. + */ Rect operator|(const Rect &a) const; + //! Returns the intersection of two Rect objects + /*! + The intersection of the rectangles will consist of just the area where the + two rectangles overlap. + @param A second Rect object to form an intersection with. + @return The intersection between this Rect and the one passed to the + function + */ Rect operator&(const Rect &a) const; + //! Sets the Rect to the union of itself with another Rect object + /*! + The union of the rectangles will consist of the maximimum area that the two + rectangles can make up. + @param a A second Rect object to form a union with. + @return The union between this Rect and the one passed to the function + */ inline Rect &operator|=(const Rect &a) { *this = *this | a; return *this; } + //! Sets the Rect to the intersection of itself with another Rect object + /*! + The intersection of the rectangles will consist of just the area where the + two rectangles overlap. + @param A second Rect object to form an intersection with. + */ inline Rect &operator&=(const Rect &a) { *this = *this & a; return *this; } + //! Returns if the Rect is valid + /*! + A rectangle is valid only if its right and bottom coordinates are larger + than its left and top coordinates (i.e. it does not have a negative width + or height). + @return true if the Rect is valid; otherwise, false + */ inline bool valid(void) const { return _x2 > _x1 && _y2 > _y1; } + //! Determines if this Rect intersects another Rect + /*! + The rectangles intersect if any part of them overlaps. + @param a Another Rect object to compare this Rect with + @return true if the Rect objects overlap; otherwise, false + */ bool intersects(const Rect &a) const; - bool contains(int __x, int __y) const; + //! Determines if this Rect contains a point + /*! + The rectangle contains the point if it falls within the rectangle's + boundaries. + @param x The x coordinate of the point to operate on + @param y The y coordinate of the point to operate on + @return true if the point is contained within this Rect; otherwise, false + */ + bool contains(int x, int y) const; + //! Determines if this Rect contains another Rect entirely + /*! + This rectangle contains the second rectangle if it is entirely within this + rectangle's boundaries. + @param a The Rect to test for containment inside of this Rect + @return true if the second Rect is contained within this Rect; otherwise, + false + */ bool contains(const Rect &a) const; private: - int _x1, _y1, _x2, _y2; + //! The left coordinate of the Rect + int _x1; + //! The top coordinate of the Rect + int _y1; + //! The right coordinate of the Rect + int _x2; + //! The bottom coordinate of the Rect + int _y2; }; +//! A list for Rect objects typedef std::vector RectList; }