Rect.h revision b82203a6601728a507bc3e7d5b2b042356004aae
1edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/* 2edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 3edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 4edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * you may not use this file except in compliance with the License. 6edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * You may obtain a copy of the License at 7edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 8edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * 10edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * See the License for the specific language governing permissions and 14edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project * limitations under the License. 15edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project */ 16edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 17edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#ifndef ANDROID_UI_RECT 18edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#define ANDROID_UI_RECT 19edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 20edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <utils/TypeHelpers.h> 21edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <ui/Point.h> 22edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 239147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn#include <android/rect.h> 249147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn 25edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace android { 26edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 279147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackbornclass Rect : public ARect 28edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project{ 29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectpublic: 30000e95e7ebf1a60bbb7fda604b54092f45c87f89Mathias Agopian typedef ARect::value_type value_type; 314b8160fdfd3281d1d66c0cae9bb9c647b4333491Mathias Agopian 32edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // we don't provide copy-ctor and operator= on purpose 33edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // because we want the compiler generated versions 34edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 3535801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian inline Rect() { 36edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 379147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn inline Rect(int32_t w, int32_t h) { 389147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn left = top = 0; right = w; bottom = h; 39edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 409147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn inline Rect(int32_t l, int32_t t, int32_t r, int32_t b) { 419147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn left = l; top = t; right = r; bottom = b; 42edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 439147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn inline Rect(const Point& lt, const Point& rb) { 449147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn left = lt.x; top = lt.y; right = rb.x; bottom = rb.y; 45edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 46edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 47edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project void makeInvalid(); 484b8160fdfd3281d1d66c0cae9bb9c647b4333491Mathias Agopian 494b8160fdfd3281d1d66c0cae9bb9c647b4333491Mathias Agopian inline void clear() { 504b8160fdfd3281d1d66c0cae9bb9c647b4333491Mathias Agopian left = top = right = bottom = 0; 514b8160fdfd3281d1d66c0cae9bb9c647b4333491Mathias Agopian } 524b8160fdfd3281d1d66c0cae9bb9c647b4333491Mathias Agopian 53edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // a valid rectangle has a non negative width and height 54edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project inline bool isValid() const { 55edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return (width()>=0) && (height()>=0); 56edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 57edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 58edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // an empty rect has a zero width or height, or is invalid 59edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project inline bool isEmpty() const { 60edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return (width()<=0) || (height()<=0); 61edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 62edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 63edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project inline void set(const Rect& rhs) { 64edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project operator = (rhs); 65edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 66edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 67edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // rectangle's width 68b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian inline int32_t getWidth() const { 69edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return right-left; 70edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 71edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 72edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // rectangle's height 73b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian inline int32_t getHeight() const { 74edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return bottom-top; 75edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 76edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 77b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian inline Rect getBounds() const { 78b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian return Rect(right-left, bottom-top); 79b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian } 80b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian 81b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian inline int32_t width() const { return getWidth(); } 82b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian inline int32_t height() const { return getHeight(); } 83b82203a6601728a507bc3e7d5b2b042356004aaeMathias Agopian 8435801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian void setLeftTop(const Point& lt) { 8535801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian left = lt.x; 8635801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian top = lt.y; 87edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 8835801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian 8935801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian void setRightBottom(const Point& rb) { 9035801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian right = rb.x; 9135801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian bottom = rb.y; 92edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 93edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 94edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // the following 4 functions return the 4 corners of the rect as Point 9535801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian Point leftTop() const { 9635801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian return Point(left, top); 97edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 9835801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian Point rightBottom() const { 9935801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian return Point(right, bottom); 100edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 101edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Point rightTop() const { 102edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return Point(right, top); 103edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 104edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Point leftBottom() const { 105edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return Point(left, bottom); 106edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 107edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 108edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // comparisons 109edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project inline bool operator == (const Rect& rhs) const { 110edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return (left == rhs.left) && (top == rhs.top) && 111edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project (right == rhs.right) && (bottom == rhs.bottom); 112edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 113edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 114edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project inline bool operator != (const Rect& rhs) const { 115edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return !operator == (rhs); 116edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 117edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 118edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // operator < defines an order which allows to use rectangles in sorted 119edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project // vectors. 120edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project bool operator < (const Rect& rhs) const; 121edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 122edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Rect& offsetToOrigin() { 123edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project right -= left; 124edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project bottom -= top; 125edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project left = top = 0; 126edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return *this; 127edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 128edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Rect& offsetTo(const Point& p) { 129edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return offsetTo(p.x, p.y); 130edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 131edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Rect& offsetBy(const Point& dp) { 132edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return offsetBy(dp.x, dp.y); 133edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 134edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Rect& operator += (const Point& rhs) { 135edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return offsetBy(rhs.x, rhs.y); 136edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 137edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project Rect& operator -= (const Point& rhs) { 138edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project return offsetBy(-rhs.x, -rhs.y); 139edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 14035801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian const Rect operator + (const Point& rhs) const; 14135801cea5f301c0e1d7a93b15a8f73f98e6b1033Mathias Agopian const Rect operator - (const Point& rhs) const; 142edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 1439147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn void translate(int32_t dx, int32_t dy) { // legacy, don't use. 144edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project offsetBy(dx, dy); 145edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project } 14659332804306c054082a39e9b004146bd03ae1d30Jamie Gennis 1479147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn Rect& offsetTo(int32_t x, int32_t y); 1489147d11a5f1d50496908bb1f49996e3ad23e19ccDianne Hackborn Rect& offsetBy(int32_t x, int32_t y); 149edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project bool intersect(const Rect& with, Rect* result) const; 15059332804306c054082a39e9b004146bd03ae1d30Jamie Gennis 15159332804306c054082a39e9b004146bd03ae1d30Jamie Gennis // Create a new Rect by transforming this one using a graphics HAL 15259332804306c054082a39e9b004146bd03ae1d30Jamie Gennis // transform. This rectangle is defined in a coordinate space starting at 15359332804306c054082a39e9b004146bd03ae1d30Jamie Gennis // the origin and extending to (width, height). If the transform includes 15459332804306c054082a39e9b004146bd03ae1d30Jamie Gennis // a ROT90 then the output rectangle is defined in a space extending to 15559332804306c054082a39e9b004146bd03ae1d30Jamie Gennis // (height, width). Otherwise the output rectangle is in the same space as 15659332804306c054082a39e9b004146bd03ae1d30Jamie Gennis // the input. 157f15a83f5814219c167f87cb8aaea622fc8493499Jamie Gennis Rect transform(uint32_t xform, int32_t width, int32_t height) const; 158edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; 159edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 160edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source ProjectANDROID_BASIC_TYPES_TRAITS(Rect) 161edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 162edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project}; // namespace android 163edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 164edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#endif // ANDROID_UI_RECT 165