8b8d33a71348d4cbb9de6b439a92abbbe75821cb
[WebKit-https.git] / Source / WebCore / platform / graphics / FloatRect.h
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 "FloatPoint.h"
31 #include <wtf/Vector.h>
32
33 #if USE(CG)
34 typedef struct CGRect CGRect;
35 #endif
36
37 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))
38 #ifdef NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES
39 typedef struct CGRect NSRect;
40 #else
41 typedef struct _NSRect NSRect;
42 #endif
43 #endif
44
45 #if PLATFORM(QT)
46 QT_BEGIN_NAMESPACE
47 class QRectF;
48 QT_END_NAMESPACE
49 #endif
50
51 #if PLATFORM(WX) && USE(WXGC)
52 class wxRect2DDouble;
53 #endif
54
55 #if PLATFORM(BLACKBERRY)
56 namespace BlackBerry {
57 namespace Platform {
58 class FloatRect;
59 }
60 }
61 #endif
62
63 #if USE(SKIA)
64 struct SkRect;
65 #endif
66
67 #if USE(CAIRO)
68 typedef struct _cairo_rectangle cairo_rectangle_t;
69 #endif
70
71 namespace WebCore {
72
73 #if PLATFORM(OPENVG)
74 class VGRect;
75 #endif
76
77 class LayoutRect;
78 class IntRect;
79 class IntPoint;
80
81 class FloatRect {
82 public:
83     enum ContainsMode {
84         InsideOrOnStroke,
85         InsideButNotOnStroke
86     };
87
88     FloatRect() { }
89     FloatRect(const FloatPoint& location, const FloatSize& size)
90         : m_location(location), m_size(size) { }
91     FloatRect(float x, float y, float width, float height)
92         : m_location(FloatPoint(x, y)), m_size(FloatSize(width, height)) { }
93     FloatRect(const IntRect&);
94     FloatRect(const LayoutRect&);
95
96     static FloatRect narrowPrecision(double x, double y, double width, double height);
97
98     FloatPoint location() const { return m_location; }
99     FloatSize size() const { return m_size; }
100
101     void setLocation(const FloatPoint& location) { m_location = location; }
102     void setSize(const FloatSize& size) { m_size = size; }
103
104     float x() const { return m_location.x(); }
105     float y() const { return m_location.y(); }
106     float maxX() const { return x() + width(); }
107     float maxY() const { return y() + height(); }
108     float width() const { return m_size.width(); }
109     float height() const { return m_size.height(); }
110
111     void setX(float x) { m_location.setX(x); }
112     void setY(float y) { m_location.setY(y); }
113     void setWidth(float width) { m_size.setWidth(width); }
114     void setHeight(float height) { m_size.setHeight(height); }
115
116     bool isEmpty() const { return m_size.isEmpty(); }
117     bool isZero() const { return m_size.isZero(); }
118     bool isExpressibleAsIntRect() const;
119
120     FloatPoint center() const { return FloatPoint(x() + width() / 2, y() + height() / 2); }
121
122     void move(const FloatSize& delta) { m_location += delta; } 
123     void moveBy(const FloatPoint& delta) { m_location.move(delta.x(), delta.y()); }
124     void move(float dx, float dy) { m_location.move(dx, dy); }
125
126     void expand(const FloatSize& size) { m_size += size; }
127     void expand(float dw, float dh) { m_size.expand(dw, dh); }
128     void contract(const FloatSize& size) { m_size -= size; }
129     void contract(float dw, float dh) { m_size.expand(-dw, -dh); }
130
131     void shiftXEdgeTo(float edge)
132     {
133         float delta = edge - x();
134         setX(edge);
135         setWidth(std::max(0.0f, width() - delta));
136     }
137     void shiftMaxXEdgeTo(float edge)
138     {
139         float delta = edge - maxX();
140         setWidth(std::max(0.0f, width() + delta));
141     }
142     void shiftYEdgeTo(float edge)
143     {
144         float delta = edge - y();
145         setY(edge);
146         setHeight(std::max(0.0f, height() - delta));
147     }
148     void shiftMaxYEdgeTo(float edge)
149     {
150         float delta = edge - maxY();
151         setHeight(std::max(0.0f, height() + delta));
152     }
153
154     FloatPoint minXMinYCorner() const { return m_location; } // typically topLeft
155     FloatPoint maxXMinYCorner() const { return FloatPoint(m_location.x() + m_size.width(), m_location.y()); } // typically topRight
156     FloatPoint minXMaxYCorner() const { return FloatPoint(m_location.x(), m_location.y() + m_size.height()); } // typically bottomLeft
157     FloatPoint maxXMaxYCorner() const { return FloatPoint(m_location.x() + m_size.width(), m_location.y() + m_size.height()); } // typically bottomRight
158
159     bool intersects(const FloatRect&) const;
160     bool contains(const FloatRect&) const;
161     bool contains(const FloatPoint&, ContainsMode = InsideOrOnStroke) const;
162
163     void intersect(const FloatRect&);
164     void unite(const FloatRect&);
165     void uniteEvenIfEmpty(const FloatRect&);
166     void uniteIfNonZero(const FloatRect&);
167     void extend(const FloatPoint&);
168
169     // Note, this doesn't match what IntRect::contains(IntPoint&) does; the int version
170     // is really checking for containment of 1x1 rect, but that doesn't make sense with floats.
171     bool contains(float px, float py) const
172         { return px >= x() && px <= maxX() && py >= y() && py <= maxY(); }
173
174     void inflateX(float dx) {
175         m_location.setX(m_location.x() - dx);
176         m_size.setWidth(m_size.width() + dx + dx);
177     }
178     void inflateY(float dy) {
179         m_location.setY(m_location.y() - dy);
180         m_size.setHeight(m_size.height() + dy + dy);
181     }
182     void inflate(float d) { inflateX(d); inflateY(d); }
183     void scale(float s) { scale(s, s); }
184     void scale(float sx, float sy);
185
186     FloatRect transposedRect() const { return FloatRect(m_location.transposedPoint(), m_size.transposedSize()); }
187
188     // Re-initializes this rectangle to fit the sets of passed points.
189     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1);
190     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1, const FloatPoint& p2);
191     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1, const FloatPoint& p2, const FloatPoint& p3);
192
193 #if PLATFORM(BLACKBERRY)
194     FloatRect(const BlackBerry::Platform::FloatRect&);
195     operator BlackBerry::Platform::FloatRect() const;
196 #endif
197
198 #if USE(CG)
199     FloatRect(const CGRect&);
200     operator CGRect() const;
201 #endif
202
203 #if (PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))) \
204         && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES)
205     FloatRect(const NSRect&);
206     operator NSRect() const;
207 #endif
208
209 #if PLATFORM(QT)
210     FloatRect(const QRectF&);
211     operator QRectF() const;
212     FloatRect normalized() const;
213 #endif
214
215 #if PLATFORM(WX) && USE(WXGC)
216     FloatRect(const wxRect2DDouble&);
217     operator wxRect2DDouble() const;
218 #endif
219
220 #if USE(SKIA)
221     FloatRect(const SkRect&);
222     operator SkRect() const;
223 #endif
224
225 #if PLATFORM(OPENVG)
226     operator VGRect() const;
227 #endif
228
229 #if USE(CAIRO)
230     FloatRect(const cairo_rectangle_t&);
231     operator cairo_rectangle_t() const;
232 #endif
233
234 private:
235     FloatPoint m_location;
236     FloatSize m_size;
237
238     void setLocationAndSizeFromEdges(float left, float top, float right, float bottom)
239     {
240         m_location.set(left, top);
241         m_size.setWidth(right - left);
242         m_size.setHeight(bottom - top);
243     }
244 };
245
246 inline FloatRect intersection(const FloatRect& a, const FloatRect& b)
247 {
248     FloatRect c = a;
249     c.intersect(b);
250     return c;
251 }
252
253 inline FloatRect unionRect(const FloatRect& a, const FloatRect& b)
254 {
255     FloatRect c = a;
256     c.unite(b);
257     return c;
258 }
259
260 FloatRect unionRect(const Vector<FloatRect>&);
261
262 inline FloatRect& operator+=(FloatRect& a, const FloatRect& b)
263 {
264     a.move(b.x(), b.y());
265     a.setWidth(a.width() + b.width());
266     a.setHeight(a.height() + b.height());
267     return a;
268 }
269
270 inline FloatRect operator+(const FloatRect& a, const FloatRect& b)
271 {
272     FloatRect c = a;
273     c += b;
274     return c;
275 }
276
277 inline bool operator==(const FloatRect& a, const FloatRect& b)
278 {
279     return a.location() == b.location() && a.size() == b.size();
280 }
281
282 inline bool operator!=(const FloatRect& a, const FloatRect& b)
283 {
284     return a.location() != b.location() || a.size() != b.size();
285 }
286
287 IntRect enclosingIntRect(const FloatRect&);
288
289 // Returns a valid IntRect contained within the given FloatRect.
290 IntRect enclosedIntRect(const FloatRect&);
291
292 IntRect roundedIntRect(const FloatRect&);
293
294 // Map rect r from srcRect to an equivalent rect in destRect.
295 FloatRect mapRect(const FloatRect& r, const FloatRect& srcRect, const FloatRect& destRect);
296
297 }
298
299 #endif