• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2006 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ANDROID_UI_RECT
18 #define ANDROID_UI_RECT
19 
20 #include <utils/Flattenable.h>
21 #include <utils/Log.h>
22 #include <utils/TypeHelpers.h>
23 #include <log/log.h>
24 
25 #include <ui/FloatRect.h>
26 #include <ui/Point.h>
27 
28 #include <android/rect.h>
29 
30 namespace android {
31 
32 class Rect : public ARect, public LightFlattenablePod<Rect>
33 {
34 public:
35     typedef ARect::value_type value_type;
36 
37     static const Rect INVALID_RECT;
38     static const Rect EMPTY_RECT;
39 
40     // we don't provide copy-ctor and operator= on purpose
41     // because we want the compiler generated versions
42 
Rect()43     inline Rect() : Rect(INVALID_RECT) {}
44 
45     template <typename T>
Rect(T w,T h)46     inline Rect(T w, T h) {
47         if (w > INT32_MAX) {
48             w = INT32_MAX;
49         }
50         if (h > INT32_MAX) {
51             h = INT32_MAX;
52         }
53         left = top = 0;
54         right = static_cast<int32_t>(w);
55         bottom = static_cast<int32_t>(h);
56     }
57 
Rect(int32_t l,int32_t t,int32_t r,int32_t b)58     inline Rect(int32_t l, int32_t t, int32_t r, int32_t b) {
59         left = l;
60         top = t;
61         right = r;
62         bottom = b;
63     }
64 
Rect(const Point & lt,const Point & rb)65     inline Rect(const Point& lt, const Point& rb) {
66         left = lt.x;
67         top = lt.y;
68         right = rb.x;
69         bottom = rb.y;
70     }
71 
72     void makeInvalid();
73 
clear()74     inline void clear() {
75         left = top = right = bottom = 0;
76     }
77 
78     // a valid rectangle has a non negative width and height
isValid()79     inline bool isValid() const {
80         return (getWidth() >= 0) && (getHeight() >= 0);
81     }
82 
83     // an empty rect has a zero width or height, or is invalid
isEmpty()84     inline bool isEmpty() const {
85         return (getWidth() <= 0) || (getHeight() <= 0);
86     }
87 
88     // rectangle's width
getWidth()89     inline int32_t getWidth() const {
90         return right - left;
91     }
92 
93     // rectangle's height
getHeight()94     inline int32_t getHeight() const {
95         return bottom - top;
96     }
97 
getBounds()98     inline Rect getBounds() const {
99         return Rect(right - left, bottom - top);
100     }
101 
setLeftTop(const Point & lt)102     void setLeftTop(const Point& lt) {
103         left = lt.x;
104         top = lt.y;
105     }
106 
setRightBottom(const Point & rb)107     void setRightBottom(const Point& rb) {
108         right = rb.x;
109         bottom = rb.y;
110     }
111 
112     // the following 4 functions return the 4 corners of the rect as Point
leftTop()113     Point leftTop() const {
114         return Point(left, top);
115     }
rightBottom()116     Point rightBottom() const {
117         return Point(right, bottom);
118     }
rightTop()119     Point rightTop() const {
120         return Point(right, top);
121     }
leftBottom()122     Point leftBottom() const {
123         return Point(left, bottom);
124     }
125 
126     // comparisons
127     inline bool operator == (const Rect& rhs) const {
128         return (left == rhs.left) && (top == rhs.top) &&
129                (right == rhs.right) && (bottom == rhs.bottom);
130     }
131 
132     inline bool operator != (const Rect& rhs) const {
133         return !operator == (rhs);
134     }
135 
136     // operator < defines an order which allows to use rectangles in sorted
137     // vectors.
138     bool operator < (const Rect& rhs) const;
139 
140     const Rect operator + (const Point& rhs) const;
141     const Rect operator - (const Point& rhs) const;
142 
143     Rect& operator += (const Point& rhs) {
144         return offsetBy(rhs.x, rhs.y);
145     }
146     Rect& operator -= (const Point& rhs) {
147         return offsetBy(-rhs.x, -rhs.y);
148     }
149 
offsetToOrigin()150     Rect& offsetToOrigin() {
151         right -= left;
152         bottom -= top;
153         left = top = 0;
154         return *this;
155     }
offsetTo(const Point & p)156     Rect& offsetTo(const Point& p) {
157         return offsetTo(p.x, p.y);
158     }
offsetBy(const Point & dp)159     Rect& offsetBy(const Point& dp) {
160         return offsetBy(dp.x, dp.y);
161     }
162 
163     Rect& offsetTo(int32_t x, int32_t y);
164     Rect& offsetBy(int32_t x, int32_t y);
165 
166     bool intersect(const Rect& with, Rect* result) const;
167 
168     // Create a new Rect by transforming this one using a graphics HAL
169     // transform.  This rectangle is defined in a coordinate space starting at
170     // the origin and extending to (width, height).  If the transform includes
171     // a ROT90 then the output rectangle is defined in a space extending to
172     // (height, width).  Otherwise the output rectangle is in the same space as
173     // the input.
174     Rect transform(uint32_t xform, int32_t width, int32_t height) const;
175 
176     // this calculates (Region(*this) - exclude).bounds() efficiently
177     Rect reduce(const Rect& exclude) const;
178 
179     // for backward compatibility
width()180     inline int32_t width() const { return getWidth(); }
height()181     inline int32_t height() const { return getHeight(); }
set(const Rect & rhs)182     inline void set(const Rect& rhs) { operator = (rhs); }
183 
toFloatRect()184     FloatRect toFloatRect() const {
185         return {static_cast<float>(left), static_cast<float>(top),
186                 static_cast<float>(right), static_cast<float>(bottom)};
187     }
188 };
189 
190 ANDROID_BASIC_TYPES_TRAITS(Rect)
191 
192 }; // namespace android
193 
194 #endif // ANDROID_UI_RECT
195