|
Packit Service |
e3b512 |
/* Copyright (C) 2010 The cairomm Development Team
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* This library is free software; you can redistribute it and/or
|
|
Packit Service |
e3b512 |
* modify it under the terms of the GNU Library General Public
|
|
Packit Service |
e3b512 |
* License as published by the Free Software Foundation; either
|
|
Packit Service |
e3b512 |
* version 2 of the License, or (at your option) any later version.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* This library is distributed in the hope that it will be useful,
|
|
Packit Service |
e3b512 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit Service |
e3b512 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit Service |
e3b512 |
* Library General Public License for more details.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* You should have received a copy of the GNU Library General Public
|
|
Packit Service |
e3b512 |
* License along with this library; if not, write to the Free Software
|
|
Packit Service |
e3b512 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
Packit Service |
e3b512 |
* 02110-1301, USA.
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#ifndef __CAIROMM_REGION_H
|
|
Packit Service |
e3b512 |
#define __CAIROMM_REGION_H
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#include <cairomm/types.h>
|
|
Packit Service |
e3b512 |
#include <cairomm/enums.h>
|
|
Packit Service |
e3b512 |
#include <cairomm/refptr.h>
|
|
Packit Service |
e3b512 |
#include <cairo.h>
|
|
Packit Service |
e3b512 |
#include <vector>
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
namespace Cairo
|
|
Packit Service |
e3b512 |
{
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* A simple graphical data type representing an area of integer-aligned
|
|
Packit Service |
e3b512 |
* rectangles. They are often used on raster surfaces to track areas of
|
|
Packit Service |
e3b512 |
* interest, such as change or clip areas
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* It allows set-theoretical operations like union and intersect to be performed
|
|
Packit Service |
e3b512 |
* on them.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since: 1.10
|
|
Packit Service |
e3b512 |
**/
|
|
Packit Service |
e3b512 |
class Region
|
|
Packit Service |
e3b512 |
{
|
|
Packit Service |
e3b512 |
private:
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
Region();
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
explicit Region(const RectangleInt& rectangle);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
explicit Region(const std::vector<RectangleInt>& rects);
|
|
Packit Service |
e3b512 |
Region(const RectangleInt *rects, int count);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
public:
|
|
Packit Service |
e3b512 |
/** Create a C++ wrapper for the C instance. This C++ instance should then be given to a RefPtr.
|
|
Packit Service |
e3b512 |
* @param cobject The C instance.
|
|
Packit Service |
e3b512 |
* @param has_reference Whether we already have a reference. Otherwise, the constructor will take an extra reference.
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
explicit Region(cairo_region_t* cobject, bool has_reference = false);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Creates an empty Region object */
|
|
Packit Service |
e3b512 |
static RefPtr<Region> create();
|
|
Packit Service |
e3b512 |
/** Creates a Region object containing @a rectangle */
|
|
Packit Service |
e3b512 |
static RefPtr<Region> create(const RectangleInt& rectangle);
|
|
Packit Service |
e3b512 |
/** Creates a Region object containing the union of all given @a rects */
|
|
Packit Service |
e3b512 |
static RefPtr<Region> create(const std::vector<RectangleInt>& rects);
|
|
Packit Service |
e3b512 |
/** Creates a Region object containing the union of all given @a rects */
|
|
Packit Service |
e3b512 |
static RefPtr<Region> create(const RectangleInt *rects, int count);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** allocates a new region object copied from the original */
|
|
Packit Service |
e3b512 |
RefPtr<Region> copy() const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
virtual ~Region();
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Gets the bounding rectangle of the region */
|
|
Packit Service |
e3b512 |
RectangleInt get_extents() const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Gets the number of rectangles contained in the region */
|
|
Packit Service |
e3b512 |
int get_num_rectangles() const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Gets the nth rectangle from the region */
|
|
Packit Service |
e3b512 |
RectangleInt get_rectangle(int nth_rectangle) const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Checks whether the region is empty */
|
|
Packit Service |
e3b512 |
bool empty() const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Checks whether @a rectangle is inside, outside, or partially contained in
|
|
Packit Service |
e3b512 |
* the region
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
RegionOverlap contains_rectangle(const RectangleInt& rectangle) const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Checks whether (x,y) is contained in the region */
|
|
Packit Service |
e3b512 |
bool contains_point(int x, int y) const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Translates the region by (dx,dy) */
|
|
Packit Service |
e3b512 |
void translate(int dx, int dy);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Subtracts @a other from this region */
|
|
Packit Service |
e3b512 |
void subtract(const RefPtr<Region>& other);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Subtracts @a rectangle from this region */
|
|
Packit Service |
e3b512 |
void subtract(const RectangleInt& rectangle);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Sets the region to the intersection of this region with @a other */
|
|
Packit Service |
e3b512 |
void intersect(const RefPtr<Region>& other);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Sets the region to the intersection of this region with @a rectangle */
|
|
Packit Service |
e3b512 |
void intersect(const RectangleInt& rectangle);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
//We don't call this method union() because that is a C++ keyword.
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Sets this region to the union of the region with @a other */
|
|
Packit Service |
e3b512 |
void do_union(const RefPtr<Region>& other);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Sets this region to the union of the region with @a rectangle */
|
|
Packit Service |
e3b512 |
void do_union(const RectangleInt& rectangle);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Sets this region to the exclusive difference of the region with @a other.
|
|
Packit Service |
e3b512 |
* That is, the region will contain all areas that are in the original region
|
|
Packit Service |
e3b512 |
* or in @a other, but not in both */
|
|
Packit Service |
e3b512 |
void do_xor(const RefPtr<Region>& other);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/** Sets this region to the exclusive difference of the region with @a
|
|
Packit Service |
e3b512 |
* rectangle. That is, the region will contain all areas that are in the
|
|
Packit Service |
e3b512 |
* original region or in @a rectangle, but not in both */
|
|
Packit Service |
e3b512 |
void do_xor(const RectangleInt& rectangle);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
typedef cairo_region_t cobject;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
inline cobject* cobj() { return m_cobject; }
|
|
Packit Service |
e3b512 |
inline const cobject* cobj() const { return m_cobject; }
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#ifndef DOXYGEN_IGNORE_THIS
|
|
Packit Service |
e3b512 |
///For use only by the cairomm implementation.
|
|
Packit Service |
e3b512 |
inline ErrorStatus get_status() const
|
|
Packit Service |
e3b512 |
{ return cairo_region_status(const_cast<cairo_region_t*>(cobj())); }
|
|
Packit Service |
e3b512 |
#endif //DOXYGEN_IGNORE_THIS
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
void reference() const;
|
|
Packit Service |
e3b512 |
void unreference() const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
protected:
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
cobject* m_cobject;
|
|
Packit Service |
e3b512 |
};
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
} // namespace Cairo
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#endif //__CAIROMM_REGION_H
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
// vim: ts=2 sw=2 et
|