libcruft-util/region.hpp

100 lines
2.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
*
2015-01-15 14:01:05 +11:00
* Copyright 2010-2015 Danny Robson <danny@nerdcruft.net>
2011-05-23 17:18:52 +10:00
*/
#ifndef __UTIL_REGION_HPP
#define __UTIL_REGION_HPP
2015-01-15 14:01:05 +11:00
#include "extent.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 {
2012-06-08 16:49:09 +10:00
typedef T position_type;
typedef T size_type;
2011-05-23 17:18:52 +10:00
static constexpr size_t dimension = 2u;
typedef T value_type;
2015-01-22 14:58:42 +11:00
position_type x, y;
size_type w, h;
region () = default;
2015-01-15 14:01:05 +11:00
region (util::point<2,T>, util::extent<size_type>);
region (T _x, T _y, size_type _w, size_type _h);
2011-05-23 17:18:52 +10:00
size_type area (void) const;
size_type diameter (void) const;
void scale (T factor);
2011-08-15 20:10:43 +10:00
bool empty (void) const;
point<2,T> base (void) const;
point<2,T> centre (void) const;
point<2,T> closest (point<2,T>) const;
2015-01-21 23:33:35 +11:00
// Point and region relation queries
bool includes (const point<2,T>&) const; // inclusive of borders
bool contains (const point<2,T>&) const; // exclusive of borders
2015-01-21 23:33:35 +11:00
bool intersects (const region<T>&) const; // exclusive of borders
2011-05-23 17:18:52 +10:00
2015-01-21 23:33:35 +11:00
// Move a point to be within the region bounds
void constrain (point<2,T>&) const;
point<2,T> constrained (const point<2,T>&) const;
2015-01-21 23:33:35 +11:00
// Compute binary region combinations
region intersection (const region<T>&) const;
2015-01-21 23:37:00 +11:00
// Compute a region `mag` units into the region
region inset (T mag);
2015-02-04 15:44:51 +11:00
2015-01-22 14:58:29 +11:00
region expanded (T mag) const;
2015-02-04 15:44:51 +11:00
region expanded (T w, T h) const;
2015-01-22 14:58:29 +11:00
region& expand (T mag);
2015-02-04 15:44:51 +11:00
region& expand (T w, T h);
2015-01-21 23:37:00 +11:00
2015-01-21 23:33:35 +11:00
// Logical comparison operators
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
2015-01-21 23:33:35 +11:00
// Utility constants
2012-06-15 16:38:57 +10:00
static const region<T> MAX;
static const region<T> UNIT;
2011-08-15 20:10:43 +10:00
void sanity (void) const;
};
2015-01-22 15:00:35 +11:00
typedef region<size_t> region2u;
typedef region<intmax_t> region2i;
typedef region<float> region2f;
template <typename T>
std::ostream& operator<< (std::ostream&, const util::region<T>&);
2011-08-15 20:10:43 +10:00
}
2011-05-23 17:18:52 +10:00
2011-10-20 23:53:30 +11:00
2015-01-16 14:42:56 +11:00
#endif