SkRect.h 30.8 KB
Newer Older
reed@android.com's avatar
reed@android.com committed
1
/*
2
 * Copyright 2006 The Android Open Source Project
reed@android.com's avatar
reed@android.com committed
3
 *
4 5
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
reed@android.com's avatar
reed@android.com committed
6 7 8 9 10 11
 */

#ifndef SkRect_DEFINED
#define SkRect_DEFINED

#include "SkPoint.h"
12
#include "SkSize.h"
reed@android.com's avatar
reed@android.com committed
13

joshualitt's avatar
joshualitt committed
14 15
struct SkRect;

reed@android.com's avatar
reed@android.com committed
16 17 18 19
/** \struct SkIRect

    SkIRect holds four 32 bit integer coordinates for a rectangle
*/
20
struct SK_API SkIRect {
reed@android.com's avatar
reed@android.com committed
21 22
    int32_t fLeft, fTop, fRight, fBottom;

23
    static SkIRect SK_WARN_UNUSED_RESULT MakeEmpty() {
24 25 26 27
        SkIRect r;
        r.setEmpty();
        return r;
    }
28

29 30 31 32 33 34
    static SkIRect SK_WARN_UNUSED_RESULT MakeLargest() {
        SkIRect r;
        r.setLargest();
        return r;
    }

35
    static SkIRect SK_WARN_UNUSED_RESULT MakeWH(int32_t w, int32_t h) {
36 37 38 39
        SkIRect r;
        r.set(0, 0, w, h);
        return r;
    }
40

41
    static SkIRect SK_WARN_UNUSED_RESULT MakeSize(const SkISize& size) {
42 43 44 45
        SkIRect r;
        r.set(0, 0, size.width(), size.height());
        return r;
    }
46

47
    static SkIRect SK_WARN_UNUSED_RESULT MakeLTRB(int32_t l, int32_t t, int32_t r, int32_t b) {
48 49 50 51
        SkIRect rect;
        rect.set(l, t, r, b);
        return rect;
    }
52

53
    static SkIRect SK_WARN_UNUSED_RESULT MakeXYWH(int32_t x, int32_t y, int32_t w, int32_t h) {
54 55 56 57
        SkIRect r;
        r.set(x, y, x + w, y + h);
        return r;
    }
reed@android.com's avatar
reed@android.com committed
58

reed@google.com's avatar
reed@google.com committed
59 60 61 62
    int left() const { return fLeft; }
    int top() const { return fTop; }
    int right() const { return fRight; }
    int bottom() const { return fBottom; }
63

reed@google.com's avatar
reed@google.com committed
64 65 66 67 68 69 70 71
    /** return the left edge of the rect */
    int x() const { return fLeft; }
    /** return the top edge of the rect */
    int y() const { return fTop; }
    /**
     *  Returns the rectangle's width. This does not check for a valid rect
     *  (i.e. left <= right) so the result may be negative.
     */
reed@android.com's avatar
reed@android.com committed
72
    int width() const { return fRight - fLeft; }
73

reed@google.com's avatar
reed@google.com committed
74 75 76 77
    /**
     *  Returns the rectangle's height. This does not check for a valid rect
     *  (i.e. top <= bottom) so the result may be negative.
     */
reed@android.com's avatar
reed@android.com committed
78
    int height() const { return fBottom - fTop; }
79

80 81
    SkISize size() const { return SkISize::Make(this->width(), this->height()); }

82 83 84 85 86 87 88 89
    /**
     *  Since the center of an integer rect may fall on a factional value, this
     *  method is defined to return (right + left) >> 1.
     *
     *  This is a specific "truncation" of the average, which is different than
     *  (right + left) / 2 when the sum is negative.
     */
    int centerX() const { return (fRight + fLeft) >> 1; }
90

91 92 93 94 95 96 97 98
    /**
     *  Since the center of an integer rect may fall on a factional value, this
     *  method is defined to return (bottom + top) >> 1
     *
     *  This is a specific "truncation" of the average, which is different than
     *  (bottom + top) / 2 when the sum is negative.
     */
    int centerY() const { return (fBottom + fTop) >> 1; }
99

reed@google.com's avatar
reed@google.com committed
100 101 102 103
    /**
     *  Return true if the rectangle's width or height are <= 0
     */
    bool isEmpty() const { return fLeft >= fRight || fTop >= fBottom; }
104

105 106 107 108 109
    bool isLargest() const { return SK_MinS32 == fLeft &&
                                    SK_MinS32 == fTop &&
                                    SK_MaxS32 == fRight &&
                                    SK_MaxS32 == fBottom; }

110
    friend bool operator==(const SkIRect& a, const SkIRect& b) {
reed@android.com's avatar
reed@android.com committed
111 112
        return !memcmp(&a, &b, sizeof(a));
    }
113

114 115
    friend bool operator!=(const SkIRect& a, const SkIRect& b) {
        return !(a == b);
reed@android.com's avatar
reed@android.com committed
116 117
    }

118 119 120 121 122
    bool is16Bit() const {
        return  SkIsS16(fLeft) && SkIsS16(fTop) &&
                SkIsS16(fRight) && SkIsS16(fBottom);
    }

reed@android.com's avatar
reed@android.com committed
123 124 125 126
    /** Set the rectangle to (0,0,0,0)
    */
    void setEmpty() { memset(this, 0, sizeof(*this)); }

127
    void set(int32_t left, int32_t top, int32_t right, int32_t bottom) {
reed@android.com's avatar
reed@android.com committed
128 129 130 131 132
        fLeft   = left;
        fTop    = top;
        fRight  = right;
        fBottom = bottom;
    }
reed@google.com's avatar
reed@google.com committed
133 134 135 136
    // alias for set(l, t, r, b)
    void setLTRB(int32_t left, int32_t top, int32_t right, int32_t bottom) {
        this->set(left, top, right, bottom);
    }
reed@android.com's avatar
reed@android.com committed
137

reed@google.com's avatar
reed@google.com committed
138 139 140 141 142 143
    void setXYWH(int32_t x, int32_t y, int32_t width, int32_t height) {
        fLeft = x;
        fTop = y;
        fRight = x + width;
        fBottom = y + height;
    }
reed@google.com's avatar
reed@google.com committed
144 145 146 147 148 149 150 151

    /**
     *  Make the largest representable rectangle
     */
    void setLargest() {
        fLeft = fTop = SK_MinS32;
        fRight = fBottom = SK_MaxS32;
    }
152

reed@google.com's avatar
reed@google.com committed
153 154 155 156 157 158 159 160
    /**
     *  Make the largest representable rectangle, but inverted (e.g. fLeft will
     *  be max 32bit and right will be min 32bit).
     */
    void setLargestInverted() {
        fLeft = fTop = SK_MaxS32;
        fRight = fBottom = SK_MinS32;
    }
161

reed's avatar
reed committed
162 163 164
    /**
     *  Return a new IRect, built as an offset of this rect.
     */
reed's avatar
reed committed
165
    SkIRect makeOffset(int32_t dx, int32_t dy) const {
reed's avatar
reed committed
166 167 168 169 170 171
        return MakeLTRB(fLeft + dx, fTop + dy, fRight + dx, fBottom + dy);
    }

    /**
     *  Return a new IRect, built as an inset of this rect.
     */
reed's avatar
reed committed
172
    SkIRect makeInset(int32_t dx, int32_t dy) const {
reed's avatar
reed committed
173 174 175
        return MakeLTRB(fLeft + dx, fTop + dy, fRight - dx, fBottom - dy);
    }

reed's avatar
reed committed
176 177 178 179 180 181 182
    /**
     *  Return a new Rect, built as an outset of this rect.
     */
    SkIRect makeOutset(int32_t dx, int32_t dy) const {
        return MakeLTRB(fLeft - dx, fTop - dy, fRight + dx, fBottom + dy);
    }

reed@android.com's avatar
reed@android.com committed
183 184 185
    /** Offset set the rectangle by adding dx to its left and right,
        and adding dy to its top and bottom.
    */
186
    void offset(int32_t dx, int32_t dy) {
reed@android.com's avatar
reed@android.com committed
187 188 189 190 191 192
        fLeft   += dx;
        fTop    += dy;
        fRight  += dx;
        fBottom += dy;
    }

193 194 195 196
    void offset(const SkIPoint& delta) {
        this->offset(delta.fX, delta.fY);
    }

197 198 199 200 201 202 203 204 205 206
    /**
     *  Offset this rect such its new x() and y() will equal newX and newY.
     */
    void offsetTo(int32_t newX, int32_t newY) {
        fRight += newX - fLeft;
        fBottom += newY - fTop;
        fLeft = newX;
        fTop = newY;
    }

reed@android.com's avatar
reed@android.com committed
207 208
    /** Inset the rectangle by (dx,dy). If dx is positive, then the sides are moved inwards,
        making the rectangle narrower. If dx is negative, then the sides are moved outwards,
209
        making the rectangle wider. The same holds true for dy and the top and bottom.
reed@android.com's avatar
reed@android.com committed
210
    */
211
    void inset(int32_t dx, int32_t dy) {
reed@android.com's avatar
reed@android.com committed
212 213 214 215 216
        fLeft   += dx;
        fTop    += dy;
        fRight  -= dx;
        fBottom -= dy;
    }
217

218 219 220 221 222 223 224
   /** Outset the rectangle by (dx,dy). If dx is positive, then the sides are
       moved outwards, making the rectangle wider. If dx is negative, then the
       sides are moved inwards, making the rectangle narrower. The same holds
       true for dy and the top and bottom.
    */
    void outset(int32_t dx, int32_t dy)  { this->inset(-dx, -dy); }

reed@google.com's avatar
reed@google.com committed
225 226 227
    bool quickReject(int l, int t, int r, int b) const {
        return l >= fRight || fLeft >= r || t >= fBottom || fTop >= b;
    }
228

reed@android.com's avatar
reed@android.com committed
229 230 231 232 233
    /** Returns true if (x,y) is inside the rectangle and the rectangle is not
        empty. The left and top are considered to be inside, while the right
        and bottom are not. Thus for the rectangle (0, 0, 5, 10), the
        points (0,0) and (0,9) are inside, while (-1,0) and (5,9) are not.
    */
234
    bool contains(int32_t x, int32_t y) const {
reed@android.com's avatar
reed@android.com committed
235 236 237 238 239 240 241
        return  (unsigned)(x - fLeft) < (unsigned)(fRight - fLeft) &&
                (unsigned)(y - fTop) < (unsigned)(fBottom - fTop);
    }

    /** Returns true if the 4 specified sides of a rectangle are inside or equal to this rectangle.
        If either rectangle is empty, contains() returns false.
    */
242
    bool contains(int32_t left, int32_t top, int32_t right, int32_t bottom) const {
reed@android.com's avatar
reed@android.com committed
243 244 245 246 247 248 249
        return  left < right && top < bottom && !this->isEmpty() && // check for empties
                fLeft <= left && fTop <= top &&
                fRight >= right && fBottom >= bottom;
    }

    /** Returns true if the specified rectangle r is inside or equal to this rectangle.
    */
250
    bool contains(const SkIRect& r) const {
reed@android.com's avatar
reed@android.com committed
251 252 253 254 255
        return  !r.isEmpty() && !this->isEmpty() &&     // check for empties
                fLeft <= r.fLeft && fTop <= r.fTop &&
                fRight >= r.fRight && fBottom >= r.fBottom;
    }

joshualitt's avatar
joshualitt committed
256 257 258 259
    /** Returns true if the specified rectangle r is inside or equal to this rectangle.
    */
    bool contains(const SkRect& r) const;

reed@android.com's avatar
reed@android.com committed
260
    /** Return true if this rectangle contains the specified rectangle.
261 262 263 264
        For speed, this method does not check if either this or the specified
        rectangles are empty, and if either is, its return value is undefined.
        In the debugging build however, we assert that both this and the
        specified rectangles are non-empty.
reed@android.com's avatar
reed@android.com committed
265 266
    */
    bool containsNoEmptyCheck(int32_t left, int32_t top,
267 268
                              int32_t right, int32_t bottom) const {
        SkASSERT(fLeft < fRight && fTop < fBottom);
reed@android.com's avatar
reed@android.com committed
269 270 271
        SkASSERT(left < right && top < bottom);

        return fLeft <= left && fTop <= top &&
272
               fRight >= right && fBottom >= bottom;
reed@android.com's avatar
reed@android.com committed
273
    }
274

275 276 277
    bool containsNoEmptyCheck(const SkIRect& r) const {
        return containsNoEmptyCheck(r.fLeft, r.fTop, r.fRight, r.fBottom);
    }
278

reed@android.com's avatar
reed@android.com committed
279 280 281 282
    /** If r intersects this rectangle, return true and set this rectangle to that
        intersection, otherwise return false and do not change this rectangle.
        If either rectangle is empty, do nothing and return false.
    */
283
    bool SK_WARN_UNUSED_RESULT intersect(const SkIRect& r) {
reed@android.com's avatar
reed@android.com committed
284 285 286 287 288 289 290
        return this->intersect(r.fLeft, r.fTop, r.fRight, r.fBottom);
    }

    /** If rectangles a and b intersect, return true and set this rectangle to
        that intersection, otherwise return false and do not change this
        rectangle. If either rectangle is empty, do nothing and return false.
    */
291
    bool SK_WARN_UNUSED_RESULT intersect(const SkIRect& a, const SkIRect& b) {
292

reed@android.com's avatar
reed@android.com committed
293
        if (!a.isEmpty() && !b.isEmpty() &&
294 295
                a.fLeft < b.fRight && b.fLeft < a.fRight &&
                a.fTop < b.fBottom && b.fTop < a.fBottom) {
reed@android.com's avatar
reed@android.com committed
296 297 298 299 300 301 302 303
            fLeft   = SkMax32(a.fLeft,   b.fLeft);
            fTop    = SkMax32(a.fTop,    b.fTop);
            fRight  = SkMin32(a.fRight,  b.fRight);
            fBottom = SkMin32(a.fBottom, b.fBottom);
            return true;
        }
        return false;
    }
304

reed@android.com's avatar
reed@android.com committed
305 306 307 308 309 310
    /** If rectangles a and b intersect, return true and set this rectangle to
        that intersection, otherwise return false and do not change this
        rectangle. For speed, no check to see if a or b are empty is performed.
        If either is, then the return result is undefined. In the debug build,
        we assert that both rectangles are non-empty.
    */
311
    bool SK_WARN_UNUSED_RESULT intersectNoEmptyCheck(const SkIRect& a, const SkIRect& b) {
reed@android.com's avatar
reed@android.com committed
312
        SkASSERT(!a.isEmpty() && !b.isEmpty());
313

reed@android.com's avatar
reed@android.com committed
314
        if (a.fLeft < b.fRight && b.fLeft < a.fRight &&
315
                a.fTop < b.fBottom && b.fTop < a.fBottom) {
reed@android.com's avatar
reed@android.com committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329
            fLeft   = SkMax32(a.fLeft,   b.fLeft);
            fTop    = SkMax32(a.fTop,    b.fTop);
            fRight  = SkMin32(a.fRight,  b.fRight);
            fBottom = SkMin32(a.fBottom, b.fBottom);
            return true;
        }
        return false;
    }

    /** If the rectangle specified by left,top,right,bottom intersects this rectangle,
        return true and set this rectangle to that intersection,
        otherwise return false and do not change this rectangle.
        If either rectangle is empty, do nothing and return false.
    */
330 331
    bool SK_WARN_UNUSED_RESULT intersect(int32_t left, int32_t top, 
                                         int32_t right, int32_t bottom) {
reed@android.com's avatar
reed@android.com committed
332
        if (left < right && top < bottom && !this->isEmpty() &&
333
                fLeft < right && left < fRight && fTop < bottom && top < fBottom) {
reed@android.com's avatar
reed@android.com committed
334 335 336 337 338 339 340 341
            if (fLeft < left) fLeft = left;
            if (fTop < top) fTop = top;
            if (fRight > right) fRight = right;
            if (fBottom > bottom) fBottom = bottom;
            return true;
        }
        return false;
    }
342

reed@android.com's avatar
reed@android.com committed
343
    /** Returns true if a and b are not empty, and they intersect
344
     */
345
    static bool Intersects(const SkIRect& a, const SkIRect& b) {
reed@android.com's avatar
reed@android.com committed
346
        return  !a.isEmpty() && !b.isEmpty() &&              // check for empties
347 348
                a.fLeft < b.fRight && b.fLeft < a.fRight &&
                a.fTop < b.fBottom && b.fTop < a.fBottom;
349
    }
350

351 352 353 354 355 356 357
    /**
     *  Returns true if a and b intersect. debug-asserts that neither are empty.
     */
    static bool IntersectsNoEmptyCheck(const SkIRect& a, const SkIRect& b) {
        SkASSERT(!a.isEmpty());
        SkASSERT(!b.isEmpty());
        return  a.fLeft < b.fRight && b.fLeft < a.fRight &&
reed@android.com's avatar
reed@android.com committed
358 359
                a.fTop < b.fBottom && b.fTop < a.fBottom;
    }
360

reed@android.com's avatar
reed@android.com committed
361 362 363 364 365 366 367 368 369 370
    /** Update this rectangle to enclose itself and the specified rectangle.
        If this rectangle is empty, just set it to the specified rectangle. If the specified
        rectangle is empty, do nothing.
    */
    void join(int32_t left, int32_t top, int32_t right, int32_t bottom);

    /** Update this rectangle to enclose itself and the specified rectangle.
        If this rectangle is empty, just set it to the specified rectangle. If the specified
        rectangle is empty, do nothing.
    */
371
    void join(const SkIRect& r) {
reed@android.com's avatar
reed@android.com committed
372 373 374 375 376 377 378 379 380
        this->join(r.fLeft, r.fTop, r.fRight, r.fBottom);
    }

    /** Swap top/bottom or left/right if there are flipped.
        This can be called if the edges are computed separately,
        and may have crossed over each other.
        When this returns, left <= right && top <= bottom
    */
    void sort();
reed@google.com's avatar
reed@google.com committed
381

382
    static const SkIRect& SK_WARN_UNUSED_RESULT EmptyIRect() {
383
        static const SkIRect gEmpty = { 0, 0, 0, 0 };
reed@google.com's avatar
reed@google.com committed
384 385
        return gEmpty;
    }
reed@android.com's avatar
reed@android.com committed
386 387 388 389
};

/** \struct SkRect
*/
390
struct SK_API SkRect {
reed@android.com's avatar
reed@android.com committed
391 392
    SkScalar    fLeft, fTop, fRight, fBottom;

393
    static SkRect SK_WARN_UNUSED_RESULT MakeEmpty() {
394 395 396 397 398
        SkRect r;
        r.setEmpty();
        return r;
    }

399 400 401 402 403 404
    static SkRect SK_WARN_UNUSED_RESULT MakeLargest() {
        SkRect r;
        r.setLargest();
        return r;
    }

405
    static SkRect SK_WARN_UNUSED_RESULT MakeWH(SkScalar w, SkScalar h) {
406 407 408 409 410
        SkRect r;
        r.set(0, 0, w, h);
        return r;
    }

411 412 413 414 415 416
    static SkRect SK_WARN_UNUSED_RESULT MakeIWH(int w, int h) {
        SkRect r;
        r.set(0, 0, SkIntToScalar(w), SkIntToScalar(h));
        return r;
    }

417
    static SkRect SK_WARN_UNUSED_RESULT MakeSize(const SkSize& size) {
418 419 420 421
        SkRect r;
        r.set(0, 0, size.width(), size.height());
        return r;
    }
422

423
    static SkRect SK_WARN_UNUSED_RESULT MakeLTRB(SkScalar l, SkScalar t, SkScalar r, SkScalar b) {
424 425 426 427 428
        SkRect rect;
        rect.set(l, t, r, b);
        return rect;
    }

429
    static SkRect SK_WARN_UNUSED_RESULT MakeXYWH(SkScalar x, SkScalar y, SkScalar w, SkScalar h) {
430 431
        SkRect r;
        r.set(x, y, x + w, y + h);
432 433 434
        return r;
    }

435
    SK_ATTR_DEPRECATED("use Make()")
436 437 438 439 440 441
    static SkRect SK_WARN_UNUSED_RESULT MakeFromIRect(const SkIRect& irect) {
        SkRect r;
        r.set(SkIntToScalar(irect.fLeft),
              SkIntToScalar(irect.fTop),
              SkIntToScalar(irect.fRight),
              SkIntToScalar(irect.fBottom));
442 443
        return r;
    }
444

445 446 447 448 449 450 451 452
    static SkRect SK_WARN_UNUSED_RESULT Make(const SkIRect& irect) {
        SkRect r;
        r.set(SkIntToScalar(irect.fLeft),
              SkIntToScalar(irect.fTop),
              SkIntToScalar(irect.fRight),
              SkIntToScalar(irect.fBottom));
        return r;
    }
453

454 455 456 457
    /**
     *  Return true if the rectangle's width or height are <= 0
     */
    bool isEmpty() const { return fLeft >= fRight || fTop >= fBottom; }
458

459 460 461 462 463
    bool isLargest() const { return SK_ScalarMin == fLeft &&
                                    SK_ScalarMin == fTop &&
                                    SK_ScalarMax == fRight &&
                                    SK_ScalarMax == fBottom; }

464 465 466 467 468 469
    /**
     *  Returns true iff all values in the rect are finite. If any are
     *  infinite or NaN (or SK_FixedNaN when SkScalar is fixed) then this
     *  returns false.
     */
    bool isFinite() const {
470 471 472 473 474
        float accum = 0;
        accum *= fLeft;
        accum *= fTop;
        accum *= fRight;
        accum *= fBottom;
475

476
        // accum is either NaN or it is finite (zero).
477
        SkASSERT(0 == accum || SkScalarIsNaN(accum));
478

479
        // value==value will be true iff value is not NaN
480
        // TODO: is it faster to say !accum or accum==accum?
481
        return !SkScalarIsNaN(accum);
482 483
    }

484 485
    SkScalar    x() const { return fLeft; }
    SkScalar    y() const { return fTop; }
reed@google.com's avatar
reed@google.com committed
486 487 488 489
    SkScalar    left() const { return fLeft; }
    SkScalar    top() const { return fTop; }
    SkScalar    right() const { return fRight; }
    SkScalar    bottom() const { return fBottom; }
reed@android.com's avatar
reed@android.com committed
490 491 492 493 494
    SkScalar    width() const { return fRight - fLeft; }
    SkScalar    height() const { return fBottom - fTop; }
    SkScalar    centerX() const { return SkScalarHalf(fLeft + fRight); }
    SkScalar    centerY() const { return SkScalarHalf(fTop + fBottom); }

495
    friend bool operator==(const SkRect& a, const SkRect& b) {
496
        return SkScalarsEqual((SkScalar*)&a, (SkScalar*)&b, 4);
reed@android.com's avatar
reed@android.com committed
497
    }
498

499
    friend bool operator!=(const SkRect& a, const SkRect& b) {
500
        return !SkScalarsEqual((SkScalar*)&a, (SkScalar*)&b, 4);
reed@android.com's avatar
reed@android.com committed
501 502
    }

503 504 505
    /** return the 4 points that enclose the rectangle (top-left, top-right, bottom-right,
        bottom-left). TODO: Consider adding param to control whether quad is CW or CCW.
     */
reed@android.com's avatar
reed@android.com committed
506 507 508 509 510 511
    void toQuad(SkPoint quad[4]) const;

    /** Set this rectangle to the empty rectangle (0,0,0,0)
    */
    void setEmpty() { memset(this, 0, sizeof(*this)); }

512
    void set(const SkIRect& src) {
reed@android.com's avatar
reed@android.com committed
513 514 515 516 517 518
        fLeft   = SkIntToScalar(src.fLeft);
        fTop    = SkIntToScalar(src.fTop);
        fRight  = SkIntToScalar(src.fRight);
        fBottom = SkIntToScalar(src.fBottom);
    }

519
    void set(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom) {
reed@android.com's avatar
reed@android.com committed
520 521 522 523 524
        fLeft   = left;
        fTop    = top;
        fRight  = right;
        fBottom = bottom;
    }
reed@google.com's avatar
reed@google.com committed
525 526 527 528 529
    // alias for set(l, t, r, b)
    void setLTRB(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom) {
        this->set(left, top, right, bottom);
    }

reed@android.com's avatar
reed@android.com committed
530 531 532 533 534 535 536 537 538 539
    /** Initialize the rect with the 4 specified integers. The routine handles
        converting them to scalars (by calling SkIntToScalar)
     */
    void iset(int left, int top, int right, int bottom) {
        fLeft   = SkIntToScalar(left);
        fTop    = SkIntToScalar(top);
        fRight  = SkIntToScalar(right);
        fBottom = SkIntToScalar(bottom);
    }

540 541 542 543 544 545 546 547 548
    /**
     *  Set this rectangle to be left/top at 0,0, and have the specified width
     *  and height (automatically converted to SkScalar).
     */
    void isetWH(int width, int height) {
        fLeft = fTop = 0;
        fRight = SkIntToScalar(width);
        fBottom = SkIntToScalar(height);
    }
549

reed@android.com's avatar
reed@android.com committed
550 551 552 553
    /** Set this rectangle to be the bounds of the array of points.
        If the array is empty (count == 0), then set this rectangle
        to the empty rectangle (0,0,0,0)
    */
554 555 556 557 558 559
    void set(const SkPoint pts[], int count) {
        // set() had been checking for non-finite values, so keep that behavior
        // for now. Now that we have setBoundsCheck(), we may decide to make
        // set() be simpler/faster, and not check for those.
        (void)this->setBoundsCheck(pts, count);
    }
reed@android.com's avatar
reed@android.com committed
560

reed@google.com's avatar
reed@google.com committed
561 562
    // alias for set(pts, count)
    void setBounds(const SkPoint pts[], int count) {
563
        (void)this->setBoundsCheck(pts, count);
reed@google.com's avatar
reed@google.com committed
564
    }
565

566 567 568 569 570 571
    /**
     *  Compute the bounds of the array of points, and set this rect to that
     *  bounds and return true... unless a non-finite value is encountered,
     *  in which case this rect is set to empty and false is returned.
     */
    bool setBoundsCheck(const SkPoint pts[], int count);
572

573 574 575 576 577 578 579
    void set(const SkPoint& p0, const SkPoint& p1) {
        fLeft =   SkMinScalar(p0.fX, p1.fX);
        fRight =  SkMaxScalar(p0.fX, p1.fX);
        fTop =    SkMinScalar(p0.fY, p1.fY);
        fBottom = SkMaxScalar(p0.fY, p1.fY);
    }

reed@google.com's avatar
reed@google.com committed
580 581 582 583 584 585 586
    void setXYWH(SkScalar x, SkScalar y, SkScalar width, SkScalar height) {
        fLeft = x;
        fTop = y;
        fRight = x + width;
        fBottom = y + height;
    }

587 588 589 590 591 592 593
    void setWH(SkScalar width, SkScalar height) {
        fLeft = 0;
        fTop = 0;
        fRight = width;
        fBottom = height;
    }

reed@google.com's avatar
reed@google.com committed
594 595 596 597 598 599 600
    /**
     *  Make the largest representable rectangle
     */
    void setLargest() {
        fLeft = fTop = SK_ScalarMin;
        fRight = fBottom = SK_ScalarMax;
    }
601

reed@google.com's avatar
reed@google.com committed
602 603 604 605 606 607 608 609 610
    /**
     *  Make the largest representable rectangle, but inverted (e.g. fLeft will
     *  be max and right will be min).
     */
    void setLargestInverted() {
        fLeft = fTop = SK_ScalarMax;
        fRight = fBottom = SK_ScalarMin;
    }

reed's avatar
reed committed
611 612 613 614 615 616
    /**
     *  Return a new Rect, built as an offset of this rect.
     */
    SkRect makeOffset(SkScalar dx, SkScalar dy) const {
        return MakeLTRB(fLeft + dx, fTop + dy, fRight + dx, fBottom + dy);
    }
reed's avatar
reed committed
617
    
reed's avatar
reed committed
618 619 620 621 622 623 624
    /**
     *  Return a new Rect, built as an inset of this rect.
     */
    SkRect makeInset(SkScalar dx, SkScalar dy) const {
        return MakeLTRB(fLeft + dx, fTop + dy, fRight - dx, fBottom - dy);
    }

reed's avatar
reed committed
625 626 627 628 629 630 631
    /**
     *  Return a new Rect, built as an outset of this rect.
     */
    SkRect makeOutset(SkScalar dx, SkScalar dy) const {
        return MakeLTRB(fLeft - dx, fTop - dy, fRight + dx, fBottom + dy);
    }

reed@android.com's avatar
reed@android.com committed
632 633 634
    /** Offset set the rectangle by adding dx to its left and right,
        and adding dy to its top and bottom.
    */
635
    void offset(SkScalar dx, SkScalar dy) {
reed@android.com's avatar
reed@android.com committed
636 637 638 639
        fLeft   += dx;
        fTop    += dy;
        fRight  += dx;
        fBottom += dy;
640
    }
reed@android.com's avatar
reed@android.com committed
641

642 643 644 645
    void offset(const SkPoint& delta) {
        this->offset(delta.fX, delta.fY);
    }

646 647 648 649 650 651 652 653 654
    /**
     *  Offset this rect such its new x() and y() will equal newX and newY.
     */
    void offsetTo(SkScalar newX, SkScalar newY) {
        fRight += newX - fLeft;
        fBottom += newY - fTop;
        fLeft = newX;
        fTop = newY;
    }
655

656 657 658 659
    /** Inset the rectangle by (dx,dy). If dx is positive, then the sides are
        moved inwards, making the rectangle narrower. If dx is negative, then
        the sides are moved outwards, making the rectangle wider. The same holds
         true for dy and the top and bottom.
reed@android.com's avatar
reed@android.com committed
660
    */
661
    void inset(SkScalar dx, SkScalar dy)  {
reed@android.com's avatar
reed@android.com committed
662 663 664 665 666 667
        fLeft   += dx;
        fTop    += dy;
        fRight  -= dx;
        fBottom -= dy;
    }

668 669
   /** Outset the rectangle by (dx,dy). If dx is positive, then the sides are
       moved outwards, making the rectangle wider. If dx is negative, then the
670
       sides are moved inwards, making the rectangle narrower. The same holds
671 672 673 674
       true for dy and the top and bottom.
    */
    void outset(SkScalar dx, SkScalar dy)  { this->inset(-dx, -dy); }

reed@android.com's avatar
reed@android.com committed
675 676 677 678
    /** If this rectangle intersects r, return true and set this rectangle to that
        intersection, otherwise return false and do not change this rectangle.
        If either rectangle is empty, do nothing and return false.
    */
679
    bool SK_WARN_UNUSED_RESULT intersect(const SkRect& r);
reed@android.com's avatar
reed@android.com committed
680 681 682 683 684 685

    /** If this rectangle intersects the rectangle specified by left, top, right, bottom,
        return true and set this rectangle to that intersection, otherwise return false
        and do not change this rectangle.
        If either rectangle is empty, do nothing and return false.
    */
686 687
    bool SK_WARN_UNUSED_RESULT intersect(SkScalar left, SkScalar top, 
                                         SkScalar right, SkScalar bottom);
reed@android.com's avatar
reed@android.com committed
688

689 690 691 692 693
    /**
     *  If rectangles a and b intersect, return true and set this rectangle to
     *  that intersection, otherwise return false and do not change this
     *  rectangle. If either rectangle is empty, do nothing and return false.
     */
694
    bool SK_WARN_UNUSED_RESULT intersect(const SkRect& a, const SkRect& b);
695 696 697 698 699 700 701 702 703 704 705 706 707


private:
    static bool Intersects(SkScalar al, SkScalar at, SkScalar ar, SkScalar ab,
                           SkScalar bl, SkScalar bt, SkScalar br, SkScalar bb) {
        SkScalar L = SkMaxScalar(al, bl);
        SkScalar R = SkMinScalar(ar, br);
        SkScalar T = SkMaxScalar(at, bt);
        SkScalar B = SkMinScalar(ab, bb);
        return L < R && T < B;
    }

public:
reed@google.com's avatar
reed@google.com committed
708 709 710 711
    /**
     *  Return true if this rectangle is not empty, and the specified sides of
     *  a rectangle are not empty, and they intersect.
     */
712
    bool intersects(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom) const {
713
        return Intersects(fLeft, fTop, fRight, fBottom, left, top, right, bottom);
reed@android.com's avatar
reed@android.com committed
714
    }
715

reed's avatar
reed committed
716 717 718 719 720
    bool intersects(const SkRect& r) const {
        return Intersects(fLeft, fTop, fRight, fBottom,
                          r.fLeft, r.fTop, r.fRight, r.fBottom);
    }

reed@google.com's avatar
reed@google.com committed
721 722 723
    /**
     *  Return true if rectangles a and b are not empty and intersect.
     */
724
    static bool Intersects(const SkRect& a, const SkRect& b) {
725 726
        return Intersects(a.fLeft, a.fTop, a.fRight, a.fBottom,
                          b.fLeft, b.fTop, b.fRight, b.fBottom);
reed@android.com's avatar
reed@android.com committed
727
    }
728

reed@google.com's avatar
reed@google.com committed
729 730 731 732 733
    /**
     *  Update this rectangle to enclose itself and the specified rectangle.
     *  If this rectangle is empty, just set it to the specified rectangle.
     *  If the specified rectangle is empty, do nothing.
     */
reed@android.com's avatar
reed@android.com committed
734 735 736 737 738 739
    void join(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom);

    /** Update this rectangle to enclose itself and the specified rectangle.
        If this rectangle is empty, just set it to the specified rectangle. If the specified
        rectangle is empty, do nothing.
    */
740
    void join(const SkRect& r) {
reed@android.com's avatar
reed@android.com committed
741 742
        this->join(r.fLeft, r.fTop, r.fRight, r.fBottom);
    }
743 744 745 746 747 748 749

    void joinNonEmptyArg(const SkRect& r) {
        SkASSERT(!r.isEmpty());
        // if we are empty, just assign
        if (fLeft >= fRight || fTop >= fBottom) {
            *this = r;
        } else {
750
            this->joinPossiblyEmptyRect(r);
751 752
        }
    }
reed@google.com's avatar
reed@google.com committed
753

754 755 756 757 758 759 760 761 762 763 764
    /**
     * Joins the rectangle with another without checking if either are empty (may produce unexpected
     * results if either rect is inverted).
     */
    void joinPossiblyEmptyRect(const SkRect& r) {
        fLeft   = SkMinScalar(fLeft, r.left());
        fTop    = SkMinScalar(fTop, r.top());
        fRight  = SkMaxScalar(fRight, r.right());
        fBottom = SkMaxScalar(fBottom, r.bottom());
    }

reed@google.com's avatar
reed@google.com committed
765 766 767 768 769 770 771 772 773
    /**
     *  Grow the rect to include the specified (x,y). After this call, the
     *  following will be true: fLeft <= x <= fRight && fTop <= y <= fBottom.
     *
     *  This is close, but not quite the same contract as contains(), since
     *  contains() treats the left and top different from the right and bottom.
     *  contains(x,y) -> fLeft <= x < fRight && fTop <= y < fBottom. Also note
     *  that contains(x,y) always returns false if the rect is empty.
     */
reed@google.com's avatar
reed@google.com committed
774 775
    void growToInclude(SkScalar x, SkScalar y) {
        fLeft  = SkMinScalar(x, fLeft);
776 777
        fRight = SkMaxScalar(x, fRight);
        fTop    = SkMinScalar(y, fTop);
reed@google.com's avatar
reed@google.com committed
778 779
        fBottom = SkMaxScalar(y, fBottom);
    }
780

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
    /** Bulk version of growToInclude */
    void growToInclude(const SkPoint pts[], int count) {
        this->growToInclude(pts, sizeof(SkPoint), count);
    }

    /** Bulk version of growToInclude with stride. */
    void growToInclude(const SkPoint pts[], size_t stride, int count) {
        SkASSERT(count >= 0);
        SkASSERT(stride >= sizeof(SkPoint));
        const SkPoint* end = (const SkPoint*)((intptr_t)pts + count * stride);
        for (; pts < end; pts = (const SkPoint*)((intptr_t)pts + stride)) {
            this->growToInclude(pts->fX, pts->fY);
        }
    }

reed@google.com's avatar
reed@google.com committed
796 797 798 799
    /**
     *  Return true if this rectangle contains r, and if both rectangles are
     *  not empty.
     */
800
    bool contains(const SkRect& r) const {
801
        // todo: can we eliminate the this->isEmpty check?
reed@google.com's avatar
reed@google.com committed
802
        return  !r.isEmpty() && !this->isEmpty() &&
reed@android.com's avatar
reed@android.com committed
803 804 805 806
                fLeft <= r.fLeft && fTop <= r.fTop &&
                fRight >= r.fRight && fBottom >= r.fBottom;
    }

807 808 809 810 811 812 813 814 815 816
    /**
     * Returns true if the specified rectangle r is inside or equal to this rectangle.
     */
    bool contains(const SkIRect& r) const {
        // todo: can we eliminate the this->isEmpty check?
        return  !r.isEmpty() && !this->isEmpty() &&
                fLeft <= SkIntToScalar(r.fLeft) && fTop <= SkIntToScalar(r.fTop) &&
                fRight >= SkIntToScalar(r.fRight) && fBottom >= SkIntToScalar(r.fBottom);
    }

reed@google.com's avatar
reed@google.com committed
817 818
    /**
     *  Set the dst rectangle by rounding this rectangle's coordinates to their
819
     *  nearest integer values using SkScalarRoundToInt.
reed@google.com's avatar
reed@google.com committed
820
     */
821
    void round(SkIRect* dst) const {
reed@android.com's avatar
reed@android.com committed
822
        SkASSERT(dst);
823 824
        dst->set(SkScalarRoundToInt(fLeft), SkScalarRoundToInt(fTop),
                 SkScalarRoundToInt(fRight), SkScalarRoundToInt(fBottom));
reed@android.com's avatar
reed@android.com committed
825 826
    }

reed@google.com's avatar
reed@google.com committed
827 828 829 830
    /**
     *  Set the dst rectangle by rounding "out" this rectangle, choosing the
     *  SkScalarFloor of top and left, and the SkScalarCeil of right and bottom.
     */
831
    void roundOut(SkIRect* dst) const {
reed@android.com's avatar
reed@android.com committed
832
        SkASSERT(dst);
833 834
        dst->set(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
                 SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom));
reed@android.com's avatar
reed@android.com committed
835 836
    }

reed@google.com's avatar
reed@google.com committed
837
    /**
reed's avatar
reed committed
838 839
     *  Set the dst rectangle by rounding "out" this rectangle, choosing the
     *  SkScalarFloorToScalar of top and left, and the SkScalarCeilToScalar of right and bottom.
840 841
     *
     *  It is safe for this == dst
reed@google.com's avatar
reed@google.com committed
842
     */
843 844 845 846 847
    void roundOut(SkRect* dst) const {
        dst->set(SkScalarFloorToScalar(fLeft),
                 SkScalarFloorToScalar(fTop),
                 SkScalarCeilToScalar(fRight),
                 SkScalarCeilToScalar(fBottom));
reed@google.com's avatar
reed@google.com committed
848 849
    }

850 851 852 853 854 855 856 857 858 859 860
    /**
     *  Set the dst rectangle by rounding "in" this rectangle, choosing the
     *  ceil of top and left, and the floor of right and bottom. This does *not*
     *  call sort(), so it is possible that the resulting rect is inverted...
     *  e.g. left >= right or top >= bottom. Call isEmpty() to detect that.
     */
    void roundIn(SkIRect* dst) const {
        SkASSERT(dst);
        dst->set(SkScalarCeilToInt(fLeft), SkScalarCeilToInt(fTop),
                 SkScalarFloorToInt(fRight), SkScalarFloorToInt(fBottom));
    }
861

reed's avatar
reed committed
862
    //! Returns the result of calling round(&dst)
863 864 865 866 867
    SkIRect round() const {
        SkIRect ir;
        this->round(&ir);
        return ir;
    }
reed's avatar
reed committed
868 869 870 871 872 873 874 875
    
    //! Returns the result of calling roundOut(&dst)
    SkIRect roundOut() const {
        SkIRect ir;
        this->roundOut(&ir);
        return ir;
    }
    
reed@google.com's avatar
reed@google.com committed
876 877 878 879 880 881
    /**
     *  Swap top/bottom or left/right if there are flipped (i.e. if width()
     *  or height() would have returned a negative value.) This should be called
     *  if the edges are computed separately, and may have crossed over each
     *  other. When this returns, left <= right && top <= bottom
     */
reed's avatar
reed committed
882
    void sort() {
qiankun.miao's avatar
qiankun.miao committed
883 884 885 886 887 888 889
        if (fLeft > fRight) {
            SkTSwap<SkScalar>(fLeft, fRight);
        }

        if (fTop > fBottom) {
            SkTSwap<SkScalar>(fTop, fBottom);
        }
reed's avatar
reed committed
890
    }
891

892 893 894 895
    /**
     *  cast-safe way to treat the rect as an array of (4) SkScalars.
     */
    const SkScalar* asScalars() const { return &fLeft; }
896

897 898 899
    void dump(bool asHex) const;
    void dump() const { this->dump(false); }
    void dumpHex() const { this->dump(true); }
reed@android.com's avatar
reed@android.com committed
900 901
};

joshualitt's avatar
joshualitt committed
902 903 904 905 906 907
inline bool SkIRect::contains(const SkRect& r) const {
    return  !r.isEmpty() && !this->isEmpty() &&     // check for empties
            (SkScalar)fLeft <= r.fLeft && (SkScalar)fTop <= r.fTop &&
            (SkScalar)fRight >= r.fRight && (SkScalar)fBottom >= r.fBottom;
}

reed@android.com's avatar
reed@android.com committed
908
#endif