SkRect.h 28.9 KB
Newer Older
1

reed@android.com's avatar
reed@android.com committed
2
/*
3
 * Copyright 2006 The Android Open Source Project
reed@android.com's avatar
reed@android.com committed
4
 *
5 6
 * 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
7 8
 */

9

reed@android.com's avatar
reed@android.com committed
10 11 12 13
#ifndef SkRect_DEFINED
#define SkRect_DEFINED

#include "SkPoint.h"
14
#include "SkSize.h"
reed@android.com's avatar
reed@android.com committed
15 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 82 83 84 85 86 87
    /**
     *  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; }
88

89 90 91 92 93 94 95 96
    /**
     *  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; }
97

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

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

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

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

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

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

125
    void set(int32_t left, int32_t top, int32_t right, int32_t bottom) {
reed@android.com's avatar
reed@android.com committed
126 127 128 129 130
        fLeft   = left;
        fTop    = top;
        fRight  = right;
        fBottom = bottom;
    }
reed@google.com's avatar
reed@google.com committed
131 132 133 134
    // 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
135

reed@google.com's avatar
reed@google.com committed
136 137 138 139 140 141
    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
142 143 144 145 146 147 148 149

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

reed@google.com's avatar
reed@google.com committed
151 152 153 154 155 156 157 158
    /**
     *  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;
    }
159

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

    /**
     *  Return a new IRect, built as an inset of this rect.
     */
    SkIRect makeInset(int dx, int dy) const {
        return MakeLTRB(fLeft + dx, fTop + dy, fRight - dx, fBottom - dy);
    }

reed@android.com's avatar
reed@android.com committed
174 175 176
    /** Offset set the rectangle by adding dx to its left and right,
        and adding dy to its top and bottom.
    */
177
    void offset(int32_t dx, int32_t dy) {
reed@android.com's avatar
reed@android.com committed
178 179 180 181 182 183
        fLeft   += dx;
        fTop    += dy;
        fRight  += dx;
        fBottom += dy;
    }

184 185 186 187
    void offset(const SkIPoint& delta) {
        this->offset(delta.fX, delta.fY);
    }

188 189 190 191 192 193 194 195 196 197
    /**
     *  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
198 199
    /** 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,
200
        making the rectangle wider. The same holds true for dy and the top and bottom.
reed@android.com's avatar
reed@android.com committed
201
    */
202
    void inset(int32_t dx, int32_t dy) {
reed@android.com's avatar
reed@android.com committed
203 204 205 206 207
        fLeft   += dx;
        fTop    += dy;
        fRight  -= dx;
        fBottom -= dy;
    }
208

209 210 211 212 213 214 215
   /** 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
216 217 218
    bool quickReject(int l, int t, int r, int b) const {
        return l >= fRight || fLeft >= r || t >= fBottom || fTop >= b;
    }
219

reed@android.com's avatar
reed@android.com committed
220 221 222 223 224
    /** 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.
    */
225
    bool contains(int32_t x, int32_t y) const {
reed@android.com's avatar
reed@android.com committed
226 227 228 229 230 231 232
        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.
    */
233
    bool contains(int32_t left, int32_t top, int32_t right, int32_t bottom) const {
reed@android.com's avatar
reed@android.com committed
234 235 236 237 238 239 240
        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.
    */
241
    bool contains(const SkIRect& r) const {
reed@android.com's avatar
reed@android.com committed
242 243 244 245 246 247
        return  !r.isEmpty() && !this->isEmpty() &&     // check for empties
                fLeft <= r.fLeft && fTop <= r.fTop &&
                fRight >= r.fRight && fBottom >= r.fBottom;
    }

    /** Return true if this rectangle contains the specified rectangle.
248 249 250 251
        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
252 253
    */
    bool containsNoEmptyCheck(int32_t left, int32_t top,
254 255
                              int32_t right, int32_t bottom) const {
        SkASSERT(fLeft < fRight && fTop < fBottom);
reed@android.com's avatar
reed@android.com committed
256 257 258
        SkASSERT(left < right && top < bottom);

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

262 263 264
    bool containsNoEmptyCheck(const SkIRect& r) const {
        return containsNoEmptyCheck(r.fLeft, r.fTop, r.fRight, r.fBottom);
    }
265

reed@android.com's avatar
reed@android.com committed
266 267 268 269
    /** 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.
    */
270
    bool intersect(const SkIRect& r) {
reed@android.com's avatar
reed@android.com committed
271 272 273 274 275 276 277 278
        SkASSERT(&r);
        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.
    */
279
    bool intersect(const SkIRect& a, const SkIRect& b) {
280

reed@android.com's avatar
reed@android.com committed
281
        if (!a.isEmpty() && !b.isEmpty() &&
282 283
                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
284 285 286 287 288 289 290 291
            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;
    }
292

reed@android.com's avatar
reed@android.com committed
293 294 295 296 297 298
    /** 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.
    */
299
    bool intersectNoEmptyCheck(const SkIRect& a, const SkIRect& b) {
reed@android.com's avatar
reed@android.com committed
300
        SkASSERT(!a.isEmpty() && !b.isEmpty());
301

reed@android.com's avatar
reed@android.com committed
302
        if (a.fLeft < b.fRight && b.fLeft < a.fRight &&
303
                a.fTop < b.fBottom && b.fTop < a.fBottom) {
reed@android.com's avatar
reed@android.com committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317
            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.
    */
318
    bool intersect(int32_t left, int32_t top, int32_t right, int32_t bottom) {
reed@android.com's avatar
reed@android.com committed
319
        if (left < right && top < bottom && !this->isEmpty() &&
320
                fLeft < right && left < fRight && fTop < bottom && top < fBottom) {
reed@android.com's avatar
reed@android.com committed
321 322 323 324 325 326 327 328
            if (fLeft < left) fLeft = left;
            if (fTop < top) fTop = top;
            if (fRight > right) fRight = right;
            if (fBottom > bottom) fBottom = bottom;
            return true;
        }
        return false;
    }
329

reed@android.com's avatar
reed@android.com committed
330
    /** Returns true if a and b are not empty, and they intersect
331
     */
332
    static bool Intersects(const SkIRect& a, const SkIRect& b) {
reed@android.com's avatar
reed@android.com committed
333
        return  !a.isEmpty() && !b.isEmpty() &&              // check for empties
334 335 336
        a.fLeft < b.fRight && b.fLeft < a.fRight &&
        a.fTop < b.fBottom && b.fTop < a.fBottom;
    }
337

338 339 340 341 342 343 344
    /**
     *  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
345 346
                a.fTop < b.fBottom && b.fTop < a.fBottom;
    }
347

reed@android.com's avatar
reed@android.com committed
348 349 350 351 352 353 354 355 356 357
    /** 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.
    */
358
    void join(const SkIRect& r) {
reed@android.com's avatar
reed@android.com committed
359 360 361 362 363 364 365 366 367
        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
368

369
    static const SkIRect& SK_WARN_UNUSED_RESULT EmptyIRect() {
370
        static const SkIRect gEmpty = { 0, 0, 0, 0 };
reed@google.com's avatar
reed@google.com committed
371 372
        return gEmpty;
    }
reed@android.com's avatar
reed@android.com committed
373 374 375 376
};

/** \struct SkRect
*/
377
struct SK_API SkRect {
reed@android.com's avatar
reed@android.com committed
378 379
    SkScalar    fLeft, fTop, fRight, fBottom;

380
    static SkRect SK_WARN_UNUSED_RESULT MakeEmpty() {
381 382 383 384 385
        SkRect r;
        r.setEmpty();
        return r;
    }

386 387 388 389 390 391
    static SkRect SK_WARN_UNUSED_RESULT MakeLargest() {
        SkRect r;
        r.setLargest();
        return r;
    }

392
    static SkRect SK_WARN_UNUSED_RESULT MakeWH(SkScalar w, SkScalar h) {
393 394 395 396 397
        SkRect r;
        r.set(0, 0, w, h);
        return r;
    }

398
    static SkRect SK_WARN_UNUSED_RESULT MakeSize(const SkSize& size) {
399 400 401 402
        SkRect r;
        r.set(0, 0, size.width(), size.height());
        return r;
    }
403

404
    static SkRect SK_WARN_UNUSED_RESULT MakeLTRB(SkScalar l, SkScalar t, SkScalar r, SkScalar b) {
405 406 407 408 409
        SkRect rect;
        rect.set(l, t, r, b);
        return rect;
    }

410
    static SkRect SK_WARN_UNUSED_RESULT MakeXYWH(SkScalar x, SkScalar y, SkScalar w, SkScalar h) {
411 412
        SkRect r;
        r.set(x, y, x + w, y + h);
413 414 415
        return r;
    }

416
    SK_ATTR_DEPRECATED("use Make()")
417 418 419 420 421 422
    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));
423 424
        return r;
    }
425

426 427 428 429 430 431 432 433
    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;
    }
434

435 436 437 438
    /**
     *  Return true if the rectangle's width or height are <= 0
     */
    bool isEmpty() const { return fLeft >= fRight || fTop >= fBottom; }
439

440 441 442 443 444
    bool isLargest() const { return SK_ScalarMin == fLeft &&
                                    SK_ScalarMin == fTop &&
                                    SK_ScalarMax == fRight &&
                                    SK_ScalarMax == fBottom; }

445 446 447 448 449 450
    /**
     *  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 {
451 452 453 454 455
        float accum = 0;
        accum *= fLeft;
        accum *= fTop;
        accum *= fRight;
        accum *= fBottom;
456

457 458 459
        // accum is either NaN or it is finite (zero).
        SkASSERT(0 == accum || !(accum == accum));

460
        // value==value will be true iff value is not NaN
461 462
        // TODO: is it faster to say !accum or accum==accum?
        return accum == accum;
463 464
    }

465 466
    SkScalar    x() const { return fLeft; }
    SkScalar    y() const { return fTop; }
reed@google.com's avatar
reed@google.com committed
467 468 469 470
    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
471 472 473 474 475
    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); }

476
    friend bool operator==(const SkRect& a, const SkRect& b) {
477
        return SkScalarsEqual((SkScalar*)&a, (SkScalar*)&b, 4);
reed@android.com's avatar
reed@android.com committed
478
    }
479

480
    friend bool operator!=(const SkRect& a, const SkRect& b) {
481
        return !SkScalarsEqual((SkScalar*)&a, (SkScalar*)&b, 4);
reed@android.com's avatar
reed@android.com committed
482 483
    }

484 485 486
    /** 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
487 488 489 490 491 492
    void toQuad(SkPoint quad[4]) const;

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

493
    void set(const SkIRect& src) {
reed@android.com's avatar
reed@android.com committed
494 495 496 497 498 499
        fLeft   = SkIntToScalar(src.fLeft);
        fTop    = SkIntToScalar(src.fTop);
        fRight  = SkIntToScalar(src.fRight);
        fBottom = SkIntToScalar(src.fBottom);
    }

500
    void set(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom) {
reed@android.com's avatar
reed@android.com committed
501 502 503 504 505
        fLeft   = left;
        fTop    = top;
        fRight  = right;
        fBottom = bottom;
    }
reed@google.com's avatar
reed@google.com committed
506 507 508 509 510
    // 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
511 512 513 514 515 516 517 518 519 520
    /** 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);
    }

521 522 523 524 525 526 527 528 529
    /**
     *  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);
    }
530

reed@android.com's avatar
reed@android.com committed
531 532 533 534
    /** 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)
    */
535 536 537 538 539 540
    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
541

reed@google.com's avatar
reed@google.com committed
542 543
    // alias for set(pts, count)
    void setBounds(const SkPoint pts[], int count) {
544
        (void)this->setBoundsCheck(pts, count);
reed@google.com's avatar
reed@google.com committed
545
    }
546

547 548 549 550 551 552
    /**
     *  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);
553

554 555 556 557 558 559 560
    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
561 562 563 564 565 566 567
    void setXYWH(SkScalar x, SkScalar y, SkScalar width, SkScalar height) {
        fLeft = x;
        fTop = y;
        fRight = x + width;
        fBottom = y + height;
    }

568 569 570 571 572 573 574
    void setWH(SkScalar width, SkScalar height) {
        fLeft = 0;
        fTop = 0;
        fRight = width;
        fBottom = height;
    }

reed@google.com's avatar
reed@google.com committed
575 576 577 578 579 580 581
    /**
     *  Make the largest representable rectangle
     */
    void setLargest() {
        fLeft = fTop = SK_ScalarMin;
        fRight = fBottom = SK_ScalarMax;
    }
582

reed@google.com's avatar
reed@google.com committed
583 584 585 586 587 588 589 590 591
    /**
     *  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
592 593 594 595 596 597 598 599 600 601 602 603 604 605
    /**
     *  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);
    }

    /**
     *  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@android.com's avatar
reed@android.com committed
606 607 608
    /** Offset set the rectangle by adding dx to its left and right,
        and adding dy to its top and bottom.
    */
609
    void offset(SkScalar dx, SkScalar dy) {
reed@android.com's avatar
reed@android.com committed
610 611 612 613
        fLeft   += dx;
        fTop    += dy;
        fRight  += dx;
        fBottom += dy;
614
    }
reed@android.com's avatar
reed@android.com committed
615

616 617 618 619
    void offset(const SkPoint& delta) {
        this->offset(delta.fX, delta.fY);
    }

620 621 622 623 624 625 626 627 628
    /**
     *  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;
    }
629

630 631 632 633
    /** 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
634
    */
635
    void inset(SkScalar dx, SkScalar dy)  {
reed@android.com's avatar
reed@android.com committed
636 637 638 639 640 641
        fLeft   += dx;
        fTop    += dy;
        fRight  -= dx;
        fBottom -= dy;
    }

642 643
   /** 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
644
       sides are moved inwards, making the rectangle narrower. The same holds
645 646 647 648
       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
649 650 651 652 653
    /** 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.
    */
    bool intersect(const SkRect& r);
mike@reedtribe.org's avatar
mike@reedtribe.org committed
654
    bool intersect2(const SkRect& r);
reed@android.com's avatar
reed@android.com committed
655 656 657 658 659 660 661 662

    /** 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.
    */
    bool intersect(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom);

reed@google.com's avatar
reed@google.com committed
663 664 665 666
    /**
     *  Return true if this rectangle is not empty, and the specified sides of
     *  a rectangle are not empty, and they intersect.
     */
667
    bool intersects(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom) const {
reed@android.com's avatar
reed@android.com committed
668 669 670 671 672 673 674
        return // first check that both are not empty
               left < right && top < bottom &&
               fLeft < fRight && fTop < fBottom &&
               // now check for intersection
               fLeft < right && left < fRight &&
               fTop < bottom && top < fBottom;
    }
675 676 677 678 679 680

    /** 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.
     */
    bool intersect(const SkRect& a, const SkRect& b);
681

reed@google.com's avatar
reed@google.com committed
682 683 684
    /**
     *  Return true if rectangles a and b are not empty and intersect.
     */
685
    static bool Intersects(const SkRect& a, const SkRect& b) {
reed@google.com's avatar
reed@google.com committed
686 687 688
        return  !a.isEmpty() && !b.isEmpty() &&
                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
689
    }
690

reed@google.com's avatar
reed@google.com committed
691 692 693 694 695
    /**
     *  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
696 697 698 699 700 701
    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.
    */
702
    void join(const SkRect& r) {
reed@android.com's avatar
reed@android.com committed
703 704
        this->join(r.fLeft, r.fTop, r.fRight, r.fBottom);
    }
reed@google.com's avatar
reed@google.com committed
705 706 707
    // alias for join()
    void growToInclude(const SkRect& r) { this->join(r); }

reed@google.com's avatar
reed@google.com committed
708 709 710 711 712 713 714 715 716
    /**
     *  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
717 718
    void growToInclude(SkScalar x, SkScalar y) {
        fLeft  = SkMinScalar(x, fLeft);
719 720
        fRight = SkMaxScalar(x, fRight);
        fTop    = SkMinScalar(y, fTop);
reed@google.com's avatar
reed@google.com committed
721 722
        fBottom = SkMaxScalar(y, fBottom);
    }
723

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
    /** 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
739 740 741 742
    /**
     *  Return true if this rectangle contains r, and if both rectangles are
     *  not empty.
     */
743
    bool contains(const SkRect& r) const {
744
        // todo: can we eliminate the this->isEmpty check?
reed@google.com's avatar
reed@google.com committed
745
        return  !r.isEmpty() && !this->isEmpty() &&
reed@android.com's avatar
reed@android.com committed
746 747 748 749
                fLeft <= r.fLeft && fTop <= r.fTop &&
                fRight >= r.fRight && fBottom >= r.fBottom;
    }

reed@google.com's avatar
reed@google.com committed
750 751
    /**
     *  Set the dst rectangle by rounding this rectangle's coordinates to their
752
     *  nearest integer values using SkScalarRoundToInt.
reed@google.com's avatar
reed@google.com committed
753
     */
754
    void round(SkIRect* dst) const {
reed@android.com's avatar
reed@android.com committed
755
        SkASSERT(dst);
756 757
        dst->set(SkScalarRoundToInt(fLeft), SkScalarRoundToInt(fTop),
                 SkScalarRoundToInt(fRight), SkScalarRoundToInt(fBottom));
reed@android.com's avatar
reed@android.com committed
758 759
    }

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
    /**
     *  Variant of round() that explicitly performs the rounding step (i.e. floor(x + 0.5)) using
     *  double instead of SkScalar (float). It does this by calling SkDScalarRoundToInt(), which
     *  may be slower than calling SkScalarRountToInt(), but gives slightly more accurate results.
     *
     *  e.g.
     *      SkScalar x = 0.49999997f;
     *      int ix = SkScalarRoundToInt(x);
     *      SkASSERT(0 == ix);  // <--- fails
     *      ix = SkDScalarRoundToInt(x);
     *      SkASSERT(0 == ix);  // <--- succeeds
     */
    void dround(SkIRect* dst) const {
        SkASSERT(dst);
        dst->set(SkDScalarRoundToInt(fLeft), SkDScalarRoundToInt(fTop),
                 SkDScalarRoundToInt(fRight), SkDScalarRoundToInt(fBottom));
    }

reed@google.com's avatar
reed@google.com committed
778 779 780 781
    /**
     *  Set the dst rectangle by rounding "out" this rectangle, choosing the
     *  SkScalarFloor of top and left, and the SkScalarCeil of right and bottom.
     */
782
    void roundOut(SkIRect* dst) const {
reed@android.com's avatar
reed@android.com committed
783
        SkASSERT(dst);
784 785
        dst->set(SkScalarFloorToInt(fLeft), SkScalarFloorToInt(fTop),
                 SkScalarCeilToInt(fRight), SkScalarCeilToInt(fBottom));
reed@android.com's avatar
reed@android.com committed
786 787
    }

reed@google.com's avatar
reed@google.com committed
788 789 790 791 792 793 794 795 796 797 798 799
    /**
     *  Expand this rectangle by rounding its coordinates "out", choosing the
     *  floor of top and left, and the ceil of right and bottom. If this rect
     *  is already on integer coordinates, then it will be unchanged.
     */
    void roundOut() {
        this->set(SkScalarFloorToScalar(fLeft),
                  SkScalarFloorToScalar(fTop),
                  SkScalarCeilToScalar(fRight),
                  SkScalarCeilToScalar(fBottom));
    }

800 801 802 803 804 805 806 807 808 809 810
    /**
     *  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));
    }
811

812 813 814 815 816 817 818 819 820
    /**
     *  Return a new SkIRect which is contains the rounded coordinates of this
     *  rect using SkScalarRoundToInt.
     */
    SkIRect round() const {
        SkIRect ir;
        this->round(&ir);
        return ir;
    }
821

reed@google.com's avatar
reed@google.com committed
822 823 824 825 826 827
    /**
     *  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@android.com's avatar
reed@android.com committed
828
    void sort();
829

830 831 832 833
    /**
     *  cast-safe way to treat the rect as an array of (4) SkScalars.
     */
    const SkScalar* asScalars() const { return &fLeft; }
834 835 836 837 838 839 840 841 842 843 844

#ifdef SK_DEVELOPER
    /**
     * Dumps the rect using SkDebugf. This is intended for Skia development debugging. Don't
     * rely on the existence of this function or the formatting of its output.
     */
    void dump() const {
        SkDebugf("{ l: %f, t: %f, r: %f, b: %f }", fLeft, fTop, fRight, fBottom);
    }
#endif

reed@android.com's avatar
reed@android.com committed
845 846 847
};

#endif