office-gobmx/include/basegfx/range/b2dpolyrange.hxx
Thomas Arnhold 29c0fdc645 fixincludeguards.sh: include/{basegfx,basic}
Change-Id: Id18d3f4b4ed763b2ec9e718d66c3c3b9968fcac2
2013-10-23 23:22:31 +02:00

94 lines
3.1 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_BASEGFX_RANGE_B2DPOLYRANGE_HXX
#define INCLUDED_BASEGFX_RANGE_B2DPOLYRANGE_HXX
#include <o3tl/cow_wrapper.hxx>
#include <boost/tuple/tuple.hpp>
#include <basegfx/vector/b2enums.hxx>
#include <basegfx/basegfxdllapi.h>
namespace basegfx
{
class B2DTuple;
class B2DRange;
class B2DPolyPolygon;
class ImplB2DPolyRange;
/** Multiple ranges in one object.
This class combines multiple ranges in one object, providing a
total, enclosing range for it.
You can use this class e.g. when updating views containing
rectangular objects. Add each modified object to a
B2DMultiRange, then test each viewable object against
intersection with the multi range.
Similar in spirit to the poly-polygon vs. polygon relationship.
Note that comparable to polygons, a poly-range can also
contain 'holes' - this is encoded via polygon orientation at
the poly-polygon, and via explicit flags for the poly-range.
*/
class BASEGFX_DLLPUBLIC B2DPolyRange
{
public:
typedef boost::tuple<B2DRange,B2VectorOrientation> ElementType ;
B2DPolyRange();
~B2DPolyRange();
/** Create a multi range with exactly one containing range
*/
B2DPolyRange( const B2DPolyRange& );
B2DPolyRange& operator=( const B2DPolyRange& );
bool operator==(const B2DPolyRange&) const;
bool operator!=(const B2DPolyRange&) const;
/// Number of included ranges
sal_uInt32 count() const;
ElementType getElement(sal_uInt32 nIndex) const;
// insert/append a single range
void appendElement(const B2DRange& rRange, B2VectorOrientation eOrient, sal_uInt32 nCount = 1);
void clear();
/** Test whether given range overlaps one or more of the
included ranges. Does *not* use overall range, but checks
individually.
*/
bool overlaps( const B2DRange& rRange ) const;
/** Request a poly-polygon with solved cross-overs
*/
B2DPolyPolygon solveCrossovers() const;
private:
o3tl::cow_wrapper< ImplB2DPolyRange > mpImpl;
};
}
#endif // INCLUDED_BASEGFX_RANGE_B2DPOLYRANGE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */