src/libnr/nr-rect.h

   1 #ifndef LIBNR_NR_RECT_H_SEEN
   2 #define LIBNR_NR_RECT_H_SEEN
   3
   4 /** \file
   5  * Definitions of NRRect and NR::Rect types, and some associated functions \& macros.
   6  */
   7 /*
   8  * Authors:
   9  *   Lauris Kaplinski <lauris@kaplinski.com>
  10  *   Nathan Hurst <njh@mail.csse.monash.edu.au>
  11  *   MenTaLguY <mental@rydia.net>
  12  *
  13  * This code is in public domain
  14  */
  15
  16
  17 #include <stdexcept>
  18 #include <limits>
  19
  20 #include "libnr/nr-values.h"
  21 #include <libnr/nr-coord.h>
  22 #include <libnr/nr-i-coord.h>
  23 #include <libnr/nr-dim2.h>
  24 #include <libnr/nr-point.h>
  25 #include <libnr/nr-maybe.h>
  26 #include <libnr/nr-point-matrix-ops.h>
  27
  28 namespace NR {
  29     struct Matrix;
  30
  31 /** A rectangle is always aligned to the X and Y axis.  This means it
  32  * can be defined using only 4 coordinates, and determining
  33  * intersection is very efficient.  The points inside a rectangle are
  34  * min[dim] <= _pt[dim] <= max[dim].  Emptiness, however, is defined
  35  * as having zero area, meaning an empty rectangle may still contain
  36  * points.  Infinities are also permitted. */
  37 class Rect {
  38 public:
  39     Rect() : _min(-_inf(), -_inf()), _max(_inf(), _inf()) {}
  40     Rect(Point const &p0, Point const &p1);
  41
  42     Point const &min() const { return _min; }
  43     Point const &max() const { return _max; }
  44
  45     /** returns the four corners of the rectangle in order
  46      *  (clockwise if +Y is up, anticlockwise if +Y is down) */
  47     Point corner(unsigned i) const;
  48
  49     /** returns a vector from min to max. */
  50     Point dimensions() const;
  51
  52     /** returns the midpoint of this rect. */
  53     Point midpoint() const;
  54
  55     /** does this rectangle have zero area? */
  56     bool isEmpty() const {
  57         return isEmpty<X>() || isEmpty<Y>();
  58     }
  59
  60     bool intersects(Rect const &r) const {
  61         return intersects<X>(r) && intersects<Y>(r);
  62     }
  63     bool contains(Rect const &r) const {
  64         return contains<X>(r) && contains<Y>(r);
  65     }
  66     bool contains(Point const &p) const {
  67         return contains<X>(p) && contains<Y>(p);
  68     }
  69
  70     double area() const {
  71         return extent<X>() * extent<Y>();
  72     }
  73
  74     double maxExtent() const {
  75         return MAX(extent<X>(), extent<Y>());
  76     }
  77
  78     double extent(Dim2 const axis) const {
  79         switch (axis) {
  80             case X: return extent<X>();
  81             case Y: return extent<Y>();
  82             default: g_error("invalid axis value %d", (int) axis); return 0;
  83         };
  84     }
  85
  86     double extent(unsigned i) const throw(std::out_of_range) {
  87         switch (i) {
  88             case 0: return extent<X>();
  89             case 1: return extent<Y>();
  90             default: throw std::out_of_range("Dimension out of range");
  91         };
  92     }
  93
  94     /**
  95         \brief  Remove some precision from the Rect
  96         \param  places  The number of decimal places left in the end
  97
  98         This function just calls round on the \c _min and \c _max points.
  99     */
 100     inline void round(int places = 0) {
 101         _min.round(places);
 102         _max.round(places);
 103         return;
 104     }
 105
 106     /** Translates the rectangle by p. */
 107     void offset(Point p);
 108
 109     /** Makes this rectangle large enough to include the point p. */
 110     void expandTo(Point p);
 111
 112     /** Makes this rectangle large enough to include the rectangle r. */
 113     void expandTo(Rect const &r);
 114
 115     inline void move_left (gdouble by) {
 116         _min[NR::X] += by;
 117     }
 118     inline void move_right (gdouble by) {
 119         _max[NR::X] += by;
 120     }
 121     inline void move_top (gdouble by) {
 122         _min[NR::Y] += by;
 123     }
 124     inline void move_bottom (gdouble by) {
 125         _max[NR::Y] += by;
 126     }
 127
 128     /** Scales the rect by s, with origin at 0, 0 */
 129     inline Rect operator*(double const s) const {
 130         return Rect(s * min(), s * max());
 131     }
 132
 133     /** Transforms the rect by m. Note that it gives correct results only for scales and translates */
 134     inline Rect operator*(Matrix const m) const {
 135         return Rect(_min * m, _max * m);
 136     }
 137
 138     inline bool operator==(Rect const &in_rect) {
 139         return ((this->min() == in_rect.min()) && (this->max() == in_rect.max()));
 140     }
 141
 142     friend inline std::ostream &operator<<(std::ostream &out_file, NR::Rect const &in_rect);
 143
 144 private:
 145     Rect(Nothing) : _min(1, 1), _max(-1, -1) {}
 146
 147     static double _inf() {
 148         return std::numeric_limits<double>::infinity();
 149     }
 150
 151     template <NR::Dim2 axis>
 152     double extent() const {
 153         return _max[axis] - _min[axis];
 154     }
 155
 156     template <Dim2 axis>
 157     bool isEmpty() const {
 158         return !( _min[axis] < _max[axis] );
 159     }
 160
 161     template <Dim2 axis>
 162     bool intersects(Rect const &r) const {
 163         return _max[axis] >= r._min[axis] && _min[axis] <= r._max[axis];
 164     }
 165
 166     template <Dim2 axis>
 167     bool contains(Rect const &r) const {
 168         return contains(r._min) && contains(r._max);
 169     }
 170
 171     template <Dim2 axis>
 172     bool contains(Point const &p) const {
 173         return p[axis] >= _min[axis] && p[axis] <= _max[axis];
 174     }
 175
 176     Point _min, _max;
 177
 178     friend class MaybeStorage<Rect>;
 179 };
 180
 181 template <>
 182 class MaybeStorage<Rect> {
 183 public:
 184     MaybeStorage() : _rect(Nothing()) {}
 185     MaybeStorage(Rect const &rect) : _rect(rect) {}
 186
 187     bool is_nothing() const {
 188         return _rect._min[X] > _rect._max[X];
 189     }
 190     Rect const &value() const { return _rect; }
 191     Rect &value() { return _rect; }
 192
 193 private:
 194     Rect _rect;
 195 };
 196
 197 /** Returns the set of points shared by both rectangles. */
 198 Maybe<Rect> intersection(Maybe<Rect const &> a, Maybe<Rect const &> b);
 199
 200 /** Returns the smallest rectangle that encloses both rectangles. */
 201 Rect union_bounds(Rect const &a, Rect const &b);
 202 inline Rect union_bounds(Maybe<Rect const &> a, Rect const &b) {
 203     if (a) {
 204         return union_bounds(*a, b);
 205     } else {
 206         return b;
 207     }
 208 }
 209 inline Rect union_bounds(Rect const &a, Maybe<Rect const &> b) {
 210     if (b) {
 211         return union_bounds(a, *b);
 212     } else {
 213         return a;
 214     }
 215 }
 216 inline Maybe<Rect> union_bounds(Maybe<Rect const &> a, Maybe<Rect const &> b)
 217 {
 218     if (!a) {
 219         return b;
 220     } else if (!b) {
 221         return a;
 222     } else {
 223         return union_bounds(*a, *b);
 224     }
 225 }
 226
 227 /** A function to print out the rectange if sent to an output
 228     stream. */
 229 inline std::ostream
 230 &operator<<(std::ostream &out_file, NR::Rect const &in_rect)
 231 {
 232     out_file << "Rectangle:\n";
 233     out_file << "\tMin Point -> " << in_rect.min() << "\n";
 234     out_file << "\tMax Point -> " << in_rect.max() << "\n";
 235
 236     return out_file;
 237 }
 238
 239 } /* namespace NR */
 240
 241 /* legacy rect stuff */
 242
 243 struct NRMatrix;
 244
 245 /* NULL rect is infinite */
 246
 247 struct NRRect {
 248     NRRect() {}
 249     NRRect(NR::Coord xmin, NR::Coord ymin, NR::Coord xmax, NR::Coord ymax)
 250     : x0(xmin), y0(ymin), x1(xmin), y1(ymin)
 251     {}
 252     explicit NRRect(NR::Rect const &rect);
 253     explicit NRRect(NR::Maybe<NR::Rect> const &rect);
 254     operator NR::Maybe<NR::Rect>() const { return upgrade(); }
 255     NR::Maybe<NR::Rect> upgrade() const;
 256
 257     NR::Coord x0, y0, x1, y1;
 258 };
 259
 260 #define nr_rect_d_set_empty(r) (*(r) = NR_RECT_EMPTY)
 261 #define nr_rect_l_set_empty(r) (*(r) = NR_RECT_L_EMPTY)
 262
 263 #define nr_rect_d_test_empty(r) ((r) && NR_RECT_DFLS_TEST_EMPTY(r))
 264 #define nr_rect_l_test_empty(r) ((r) && NR_RECT_DFLS_TEST_EMPTY(r))
 265
 266 #define nr_rect_d_test_intersect(r0,r1) \
 267         (!nr_rect_d_test_empty(r0) && !nr_rect_d_test_empty(r1) && \
 268          !((r0) && (r1) && !NR_RECT_DFLS_TEST_INTERSECT(r0, r1)))
 269 #define nr_rect_l_test_intersect(r0,r1) \
 270         (!nr_rect_l_test_empty(r0) && !nr_rect_l_test_empty(r1) && \
 271          !((r0) && (r1) && !NR_RECT_DFLS_TEST_INTERSECT(r0, r1)))
 272
 273 #define nr_rect_d_point_d_test_inside(r,p) ((p) && (!(r) || (!NR_RECT_DF_TEST_EMPTY(r) && NR_RECT_DF_POINT_DF_TEST_INSIDE(r,p))))
 274 #define nr_rect_l_point_l_test_inside(r,p) ((p) && (!(r) || (!NR_RECT_DFLS_TEST_EMPTY(r) && NR_RECT_LS_POINT_LS_TEST_INSIDE(r,p))))
 275 #define nr_rect_l_test_inside(r,x,y) ((!(r) || (!NR_RECT_DFLS_TEST_EMPTY(r) && NR_RECT_LS_TEST_INSIDE(r,x,y))))
 276
 277 // returns minimal rect which covers all of r0 not covered by r1
 278 NRRectL *nr_rect_l_subtract(NRRectL *d, NRRectL const *r0, NRRectL const *r1);
 279
 280 // returns the area of r
 281 NR::ICoord nr_rect_l_area(NRRectL *r);
 282
 283 /* NULL values are OK for r0 and r1, but not for d */
 284 NRRect *nr_rect_d_intersect(NRRect *d, NRRect const *r0, NRRect const *r1);
 285 NRRectL *nr_rect_l_intersect(NRRectL *d, NRRectL const *r0, NRRectL const *r1);
 286
 287 NRRect *nr_rect_d_union(NRRect *d, NRRect const *r0, NRRect const *r1);
 288 NRRectL *nr_rect_l_union(NRRectL *d, NRRectL const *r0, NRRectL const *r1);
 289
 290 NRRect *nr_rect_union_pt(NRRect *dst, NR::Point const &p);
 291 NRRect *nr_rect_d_union_xy(NRRect *d, NR::Coord x, NR::Coord y);
 292 NRRectL *nr_rect_l_union_xy(NRRectL *d, NR::ICoord x, NR::ICoord y);
 293
 294 NRRect *nr_rect_d_matrix_transform(NRRect *d, NRRect const *s, NR::Matrix const &m);
 295 NRRect *nr_rect_d_matrix_transform(NRRect *d, NRRect const *s, NRMatrix const *m);
 296 NRRectL *nr_rect_l_enlarge(NRRectL *d, int amount);
 297
 298
 299 #endif /* !LIBNR_NR_RECT_H_SEEN */
 300
 301 /*
 302   Local Variables:
 303   mode:c++
 304   c-file-style:"stroustrup"
 305   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 306   indent-tabs-mode:nil
 307   fill-column:99
 308   End:
 309 */
 310 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :