libcruft-util/region.hpp

140 lines
4.2 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"
2015-02-20 15:26:59 +11:00
#include "vector.hpp"
#include "types/traits.hpp"
2011-08-15 20:10:43 +10:00
namespace util {
/**
* A two-dimensional rectangle, with size and position.
*/
template <size_t S, typename T>
2011-08-29 14:40:05 +10:00
struct region {
using position_type = T;
using size_type = typename try_unsigned<T>::type;
2011-05-23 17:18:52 +10:00
using extent_t = util::extent<S,size_type>;
using point_t = util::point<S,position_type>;
2015-03-02 18:48:09 +11:00
using value_type = T;
//---------------------------------------------------------------------
static constexpr size_t dimension = S;
static constexpr size_t elements = extent_t::elements + point_t::elements;
#pragma GCC diagnostic push
#if defined(COMPILER_GCC)
#pragma GCC diagnostic ignored "-pedantic"
#endif
#if defined(COMPILER_CLANG)
#pragma GCC diagnostic ignored "-Wgnu"
#endif
union {
struct {
point_t p;
extent_t e;
};
struct {
T x, y;
T w, h;
};
};
#pragma GCC diagnostic pop
//---------------------------------------------------------------------
region () = default;
region (extent_t);
region (point_t, extent_t);
region (point_t, point_t);
region (std::array<T,S*2>);
2011-05-23 17:18:52 +10:00
//---------------------------------------------------------------------
size_type area (void) const;
size_type diameter (void) const;
2015-03-02 18:48:09 +11:00
extent_t magnitude (void) const;
extent_t magnitude (extent_t);
2015-02-17 16:24:16 +11:00
void scale (T factor);
2011-08-15 20:10:43 +10:00
bool empty (void) const;
//---------------------------------------------------------------------
point_t base (void) const;
point_t away (void) const;
point_t centre (void) const;
point_t closest (point_t) const;
//---------------------------------------------------------------------
2015-01-21 23:33:35 +11:00
// Point and region relation queries
bool includes (point_t) const; // inclusive of borders
bool contains (point_t) const; // exclusive of borders
bool intersects (region<S,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_t&) const;
point_t constrained (point_t) const;
2015-01-21 23:33:35 +11:00
// Compute binary region combinations
region intersection (region<S,T>) const;
//---------------------------------------------------------------------
region& resize (extent<S,T>);
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;
region expanded (vector<S,T>) const;
2015-02-04 15:44:51 +11:00
2015-01-22 14:58:29 +11:00
region& expand (T mag);
region& expand (vector<S,T>);
2015-01-21 23:37:00 +11:00
2015-02-20 15:26:59 +11:00
// arithmetic operators
region operator+ (vector<S,T>) const;
region operator- (vector<S,T>) const;
2015-02-20 15:26:59 +11:00
2015-01-21 23:33:35 +11:00
// Logical comparison operators
bool operator ==(region<S,T> rhs) const;
bool operator !=(region<S,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
static const region<S,T> MAX;
static const region<S,T> UNIT;
2012-06-15 16:38:57 +10:00
2011-08-15 20:10:43 +10:00
void sanity (void) const;
};
typedef region<2,size_t> region2u;
typedef region<2,intmax_t> region2i;
typedef region<2,float> region2f;
typedef region<2,double> region2d;
template <size_t S, typename T>
std::ostream& operator<< (std::ostream&, const util::region<S,T>&);
2011-08-15 20:10:43 +10:00
}
2011-05-23 17:18:52 +10:00
2015-01-16 14:42:56 +11:00
#endif