Home | History | Annotate | Download | only in geometry 
      1 /*
      2  * Copyright (C) 2003, 2006, 2007 Apple Inc.  All rights reserved.
      3  * Copyright (C) 2005 Nokia.  All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  * 1. Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  * 2. Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in the
     12  *    documentation and/or other materials provided with the distribution.
     13  *
     14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
     15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     25  */
     26 
     27 #ifndef FloatRect_h
     28 #define FloatRect_h
     29 
     30 #include "platform/geometry/FloatPoint.h"
     31 #include "wtf/Vector.h"
     32 
     33 #if OS(MACOSX)
     34 typedef struct CGRect CGRect;
     35 #ifdef NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES
     36 typedef struct CGRect NSRect;
     37 #else
     38 typedef struct _NSRect NSRect;
     39 #endif
     40 #endif
     41 
     42 struct SkRect;
     43 
     44 namespace WebCore {
     45 
     46 class LayoutRect;
     47 class IntRect;
     48 class IntPoint;
     49 
     50 class PLATFORM_EXPORT FloatRect {
     51 public:
     52     enum ContainsMode {
     53         InsideOrOnStroke,
     54         InsideButNotOnStroke
     55     };
     56 
     57     FloatRect() { }
     58     FloatRect(const FloatPoint& location, const FloatSize& size)
     59         : m_location(location), m_size(size) { }
     60     FloatRect(float x, float y, float width, float height)
     61         : m_location(FloatPoint(x, y)), m_size(FloatSize(width, height)) { }
     62     FloatRect(const IntRect&);
     63     FloatRect(const LayoutRect&);
     64     FloatRect(const SkRect&);
     65 
     66     static FloatRect narrowPrecision(double x, double y, double width, double height);
     67 
     68     FloatPoint location() const { return m_location; }
     69     FloatSize size() const { return m_size; }
     70 
     71     void setLocation(const FloatPoint& location) { m_location = location; }
     72     void setSize(const FloatSize& size) { m_size = size; }
     73 
     74     float x() const { return m_location.x(); }
     75     float y() const { return m_location.y(); }
     76     float maxX() const { return x() + width(); }
     77     float maxY() const { return y() + height(); }
     78     float width() const { return m_size.width(); }
     79     float height() const { return m_size.height(); }
     80 
     81     void setX(float x) { m_location.setX(x); }
     82     void setY(float y) { m_location.setY(y); }
     83     void setWidth(float width) { m_size.setWidth(width); }
     84     void setHeight(float height) { m_size.setHeight(height); }
     85 
     86     bool isEmpty() const { return m_size.isEmpty(); }
     87     bool isZero() const { return m_size.isZero(); }
     88     bool isExpressibleAsIntRect() const;
     89 
     90     FloatPoint center() const { return FloatPoint(x() + width() / 2, y() + height() / 2); }
     91 
     92     void move(const FloatSize& delta) { m_location += delta; }
     93     void moveBy(const FloatPoint& delta) { m_location.move(delta.x(), delta.y()); }
     94     void move(float dx, float dy) { m_location.move(dx, dy); }
     95 
     96     void expand(const FloatSize& size) { m_size += size; }
     97     void expand(float dw, float dh) { m_size.expand(dw, dh); }
     98     void contract(const FloatSize& size) { m_size -= size; }
     99     void contract(float dw, float dh) { m_size.expand(-dw, -dh); }
    100 
    101     void shiftXEdgeTo(float edge)
    102     {
    103         float delta = edge - x();
    104         setX(edge);
    105         setWidth(std::max(0.0f, width() - delta));
    106     }
    107     void shiftMaxXEdgeTo(float edge)
    108     {
    109         float delta = edge - maxX();
    110         setWidth(std::max(0.0f, width() + delta));
    111     }
    112     void shiftYEdgeTo(float edge)
    113     {
    114         float delta = edge - y();
    115         setY(edge);
    116         setHeight(std::max(0.0f, height() - delta));
    117     }
    118     void shiftMaxYEdgeTo(float edge)
    119     {
    120         float delta = edge - maxY();
    121         setHeight(std::max(0.0f, height() + delta));
    122     }
    123 
    124     FloatPoint minXMinYCorner() const { return m_location; } // typically topLeft
    125     FloatPoint maxXMinYCorner() const { return FloatPoint(m_location.x() + m_size.width(), m_location.y()); } // typically topRight
    126     FloatPoint minXMaxYCorner() const { return FloatPoint(m_location.x(), m_location.y() + m_size.height()); } // typically bottomLeft
    127     FloatPoint maxXMaxYCorner() const { return FloatPoint(m_location.x() + m_size.width(), m_location.y() + m_size.height()); } // typically bottomRight
    128 
    129     bool intersects(const FloatRect&) const;
    130     bool contains(const FloatRect&) const;
    131     bool contains(const FloatPoint&, ContainsMode = InsideOrOnStroke) const;
    132 
    133     void intersect(const FloatRect&);
    134     void unite(const FloatRect&);
    135     void uniteEvenIfEmpty(const FloatRect&);
    136     void uniteIfNonZero(const FloatRect&);
    137     void extend(const FloatPoint&);
    138 
    139     // Note, this doesn't match what IntRect::contains(IntPoint&) does; the int version
    140     // is really checking for containment of 1x1 rect, but that doesn't make sense with floats.
    141     bool contains(float px, float py) const
    142     {
    143         return px >= x() && px <= maxX() && py >= y() && py <= maxY();
    144     }
    145 
    146     void inflateX(float dx)
    147     {
    148         m_location.setX(m_location.x() - dx);
    149         m_size.setWidth(m_size.width() + dx + dx);
    150     }
    151     void inflateY(float dy)
    152     {
    153         m_location.setY(m_location.y() - dy);
    154         m_size.setHeight(m_size.height() + dy + dy);
    155     }
    156     void inflate(float d) { inflateX(d); inflateY(d); }
    157     void scale(float s) { scale(s, s); }
    158     void scale(float sx, float sy);
    159 
    160     FloatRect transposedRect() const { return FloatRect(m_location.transposedPoint(), m_size.transposedSize()); }
    161 
    162     // Re-initializes this rectangle to fit the sets of passed points.
    163     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1);
    164     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1, const FloatPoint& p2);
    165     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1, const FloatPoint& p2, const FloatPoint& p3);
    166 
    167 #if OS(MACOSX)
    168     FloatRect(const CGRect&);
    169     operator CGRect() const;
    170 #if !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES)
    171     FloatRect(const NSRect&);
    172     operator NSRect() const;
    173 #endif
    174 #endif
    175 
    176     operator SkRect() const;
    177 
    178 private:
    179     FloatPoint m_location;
    180     FloatSize m_size;
    181 
    182     void setLocationAndSizeFromEdges(float left, float top, float right, float bottom)
    183     {
    184         m_location.set(left, top);
    185         m_size.setWidth(right - left);
    186         m_size.setHeight(bottom - top);
    187     }
    188 };
    189 
    190 inline FloatRect intersection(const FloatRect& a, const FloatRect& b)
    191 {
    192     FloatRect c = a;
    193     c.intersect(b);
    194     return c;
    195 }
    196 
    197 inline FloatRect unionRect(const FloatRect& a, const FloatRect& b)
    198 {
    199     FloatRect c = a;
    200     c.unite(b);
    201     return c;
    202 }
    203 
    204 FloatRect unionRect(const Vector<FloatRect>&);
    205 
    206 inline FloatRect& operator+=(FloatRect& a, const FloatRect& b)
    207 {
    208     a.move(b.x(), b.y());
    209     a.setWidth(a.width() + b.width());
    210     a.setHeight(a.height() + b.height());
    211     return a;
    212 }
    213 
    214 inline FloatRect operator+(const FloatRect& a, const FloatRect& b)
    215 {
    216     FloatRect c = a;
    217     c += b;
    218     return c;
    219 }
    220 
    221 inline bool operator==(const FloatRect& a, const FloatRect& b)
    222 {
    223     return a.location() == b.location() && a.size() == b.size();
    224 }
    225 
    226 inline bool operator!=(const FloatRect& a, const FloatRect& b)
    227 {
    228     return a.location() != b.location() || a.size() != b.size();
    229 }
    230 
    231 PLATFORM_EXPORT IntRect enclosingIntRect(const FloatRect&);
    232 
    233 // Returns a valid IntRect contained within the given FloatRect.
    234 PLATFORM_EXPORT IntRect enclosedIntRect(const FloatRect&);
    235 
    236 PLATFORM_EXPORT IntRect roundedIntRect(const FloatRect&);
    237 
    238 // Map supplied rect from srcRect to an equivalent rect in destRect.
    239 PLATFORM_EXPORT FloatRect mapRect(const FloatRect&, const FloatRect& srcRect, const FloatRect& destRect);
    240 
    241 }
    242 
    243 #endif
    244