libcruft-util/region.hpp

69 lines
1.9 KiB
C++
Raw Normal View History

2011-05-23 17:18:52 +10:00
/*
* This file is part of libgim.
2011-05-23 17:18:52 +10:00
*
* libgim is free software: you can redistribute it and/or modify it under the
2011-05-23 17:18:52 +10:00
* terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
*
* libgim is distributed in the hope that it will be useful, but WITHOUT ANY
2011-05-23 17:18:52 +10:00
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with libgim. If not, see <http://www.gnu.org/licenses/>.
2011-05-23 17:18:52 +10:00
*
2012-04-23 13:06:41 +10:00
* Copyright 2010 Danny Robson <danny@nerdcruft.net>
2011-05-23 17:18:52 +10:00
*/
#ifndef __UTIL_REGION_HPP
#define __UTIL_REGION_HPP
#include "point.hpp"
#include "types/traits.hpp"
2011-08-15 20:10:43 +10:00
namespace util {
/**
* A two-dimensional rectangle, with size and position.
*/
template <typename T>
2011-08-29 14:40:05 +10:00
struct region {
typedef typename always_unsigned<T>::type size_type;
2011-05-23 17:18:52 +10:00
T x, y;
size_type w, h;
region (T _x, T _y, size_type _w, size_type _h);
2011-05-23 17:18:52 +10:00
region& operator +=(const vector<2>& rhs);
2011-10-26 21:43:55 +11:00
size_type area (void) const;
size_type diameter (void) const;
2011-08-15 20:10:43 +10:00
bool empty (void) const;
point<2> base (void) const;
point<2> centre (void) const;
bool includes (const point<2>&) const; // inclusive of borders
bool contains (const point<2>&) const; // exclusive of borders
bool overlaps (const region<T>&) const; // exclusive of borders
2011-05-23 17:18:52 +10:00
region overlap (const region<T>&) const;
2011-08-29 14:40:05 +10:00
bool operator ==(const region<T>& rhs) const;
bool operator !=(const region<T>& rhs) const
2011-08-15 20:10:43 +10:00
{ return !(*this == rhs); }
2011-05-23 17:18:52 +10:00
2011-08-15 20:10:43 +10:00
void sanity (void) const;
};
}
2011-05-23 17:18:52 +10:00
2011-10-20 23:53:30 +11:00
template <typename T>
std::ostream&
operator<< (std::ostream&, const util::region<T>&);
2011-05-23 17:18:52 +10:00
#endif