1 /* 2 * Copyright (C) 2007 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_REGION_H 18 #define ANDROID_UI_REGION_H 19 20 #include <stdint.h> 21 #include <sys/types.h> 22 23 #include <utils/Vector.h> 24 25 #include <ui/Rect.h> 26 #include <utils/Flattenable.h> 27 28 namespace android { 29 // --------------------------------------------------------------------------- 30 31 class String8; 32 33 // --------------------------------------------------------------------------- 34 class Region : public LightFlattenable<Region> 35 { 36 public: 37 static const Region INVALID_REGION; 38 39 Region(); 40 Region(const Region& rhs); 41 explicit Region(const Rect& rhs); 42 ~Region(); 43 44 static Region createTJunctionFreeRegion(const Region& r); 45 46 Region& operator = (const Region& rhs); 47 48 inline bool isEmpty() const { return getBounds().isEmpty(); } 49 inline bool isRect() const { return mStorage.size() == 1; } 50 51 inline Rect getBounds() const { return mStorage[mStorage.size() - 1]; } 52 inline Rect bounds() const { return getBounds(); } 53 54 bool contains(const Point& point) const; 55 bool contains(int x, int y) const; 56 57 // the region becomes its bounds 58 Region& makeBoundsSelf(); 59 60 void clear(); 61 void set(const Rect& r); 62 void set(int32_t w, int32_t h); 63 void set(uint32_t w, uint32_t h); 64 65 Region& orSelf(const Rect& rhs); 66 Region& xorSelf(const Rect& rhs); 67 Region& andSelf(const Rect& rhs); 68 Region& subtractSelf(const Rect& rhs); 69 70 // boolean operators, applied on this 71 Region& orSelf(const Region& rhs); 72 Region& xorSelf(const Region& rhs); 73 Region& andSelf(const Region& rhs); 74 Region& subtractSelf(const Region& rhs); 75 76 // boolean operators 77 const Region merge(const Rect& rhs) const; 78 const Region mergeExclusive(const Rect& rhs) const; 79 const Region intersect(const Rect& rhs) const; 80 const Region subtract(const Rect& rhs) const; 81 82 // boolean operators 83 const Region merge(const Region& rhs) const; 84 const Region mergeExclusive(const Region& rhs) const; 85 const Region intersect(const Region& rhs) const; 86 const Region subtract(const Region& rhs) const; 87 88 // these translate rhs first 89 Region& translateSelf(int dx, int dy); 90 Region& orSelf(const Region& rhs, int dx, int dy); 91 Region& xorSelf(const Region& rhs, int dx, int dy); 92 Region& andSelf(const Region& rhs, int dx, int dy); 93 Region& subtractSelf(const Region& rhs, int dx, int dy); 94 95 // these translate rhs first 96 const Region translate(int dx, int dy) const; 97 const Region merge(const Region& rhs, int dx, int dy) const; 98 const Region mergeExclusive(const Region& rhs, int dx, int dy) const; 99 const Region intersect(const Region& rhs, int dx, int dy) const; 100 const Region subtract(const Region& rhs, int dx, int dy) const; 101 102 // convenience operators overloads 103 inline const Region operator | (const Region& rhs) const; 104 inline const Region operator ^ (const Region& rhs) const; 105 inline const Region operator & (const Region& rhs) const; 106 inline const Region operator - (const Region& rhs) const; 107 inline const Region operator + (const Point& pt) const; 108 109 inline Region& operator |= (const Region& rhs); 110 inline Region& operator ^= (const Region& rhs); 111 inline Region& operator &= (const Region& rhs); 112 inline Region& operator -= (const Region& rhs); 113 inline Region& operator += (const Point& pt); 114 115 116 // returns true if the regions share the same underlying storage 117 bool isTriviallyEqual(const Region& region) const; 118 119 120 /* various ways to access the rectangle list */ 121 122 123 // STL-like iterators 124 typedef Rect const* const_iterator; 125 const_iterator begin() const; 126 const_iterator end() const; 127 128 // returns an array of rect which has the same life-time has this 129 // Region object. 130 Rect const* getArray(size_t* count) const; 131 132 /* no user serviceable parts here... */ 133 134 // add a rectangle to the internal list. This rectangle must 135 // be sorted in Y and X and must not make the region invalid. 136 void addRectUnchecked(int l, int t, int r, int b); 137 138 inline bool isFixedSize() const { return false; } 139 size_t getFlattenedSize() const; 140 status_t flatten(void* buffer, size_t size) const; 141 status_t unflatten(void const* buffer, size_t size); 142 143 void dump(String8& out, const char* what, uint32_t flags=0) const; 144 void dump(const char* what, uint32_t flags=0) const; 145 146 private: 147 class rasterizer; 148 friend class rasterizer; 149 150 Region& operationSelf(const Rect& r, uint32_t op); 151 Region& operationSelf(const Region& r, uint32_t op); 152 Region& operationSelf(const Region& r, int dx, int dy, uint32_t op); 153 const Region operation(const Rect& rhs, uint32_t op) const; 154 const Region operation(const Region& rhs, uint32_t op) const; 155 const Region operation(const Region& rhs, int dx, int dy, uint32_t op) const; 156 157 static void boolean_operation(uint32_t op, Region& dst, 158 const Region& lhs, const Region& rhs, int dx, int dy); 159 static void boolean_operation(uint32_t op, Region& dst, 160 const Region& lhs, const Rect& rhs, int dx, int dy); 161 162 static void boolean_operation(uint32_t op, Region& dst, 163 const Region& lhs, const Region& rhs); 164 static void boolean_operation(uint32_t op, Region& dst, 165 const Region& lhs, const Rect& rhs); 166 167 static void translate(Region& reg, int dx, int dy); 168 static void translate(Region& dst, const Region& reg, int dx, int dy); 169 170 static bool validate(const Region& reg, 171 const char* name, bool silent = false); 172 173 // mStorage is a (manually) sorted array of Rects describing the region 174 // with an extra Rect as the last element which is set to the 175 // bounds of the region. However, if the region is 176 // a simple Rect then mStorage contains only that rect. 177 Vector<Rect> mStorage; 178 }; 179 180 181 const Region Region::operator | (const Region& rhs) const { 182 return merge(rhs); 183 } 184 const Region Region::operator ^ (const Region& rhs) const { 185 return mergeExclusive(rhs); 186 } 187 const Region Region::operator & (const Region& rhs) const { 188 return intersect(rhs); 189 } 190 const Region Region::operator - (const Region& rhs) const { 191 return subtract(rhs); 192 } 193 const Region Region::operator + (const Point& pt) const { 194 return translate(pt.x, pt.y); 195 } 196 197 198 Region& Region::operator |= (const Region& rhs) { 199 return orSelf(rhs); 200 } 201 Region& Region::operator ^= (const Region& rhs) { 202 return xorSelf(rhs); 203 } 204 Region& Region::operator &= (const Region& rhs) { 205 return andSelf(rhs); 206 } 207 Region& Region::operator -= (const Region& rhs) { 208 return subtractSelf(rhs); 209 } 210 Region& Region::operator += (const Point& pt) { 211 return translateSelf(pt.x, pt.y); 212 } 213 // --------------------------------------------------------------------------- 214 }; // namespace android 215 216 #endif // ANDROID_UI_REGION_H 217 218
