#i105939# Adds special box clipping support to basegfx

3 files changed, 192 insertions, 117 deletions

diff --git a/basegfx/inc/basegfx/range/b2dmultirange.hxx b/basegfx/inc/basegfx/range/b2dmultirange.hxx
deleted file mode 100644
index d3a0259f0d27..000000000000
--- a/basegfx/inc/basegfx/range/b2dmultirange.hxx
+++ /dev/null
@@ -1,117 +0,0 @@
-/*************************************************************************
- *
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * Copyright 2008 by Sun Microsystems, Inc.
- *
- * OpenOffice.org - a multi-platform office productivity suite
- *
- * $RCSfile: b2dmultirange.hxx,v $
- * $Revision: 1.6 $
- *
- * This file is part of OpenOffice.org.
- *
- * OpenOffice.org is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 3
- * only, as published by the Free Software Foundation.
- *
- * OpenOffice.org is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Lesser General Public License version 3 for more details
- * (a copy is included in the LICENSE file that accompanied this code).
- *
- * You should have received a copy of the GNU Lesser General Public License
- * version 3 along with OpenOffice.org.  If not, see
- * <http://www.openoffice.org/license.html>
- * for a copy of the LGPLv3 License.
- *
- ************************************************************************/
-
-#ifndef _BGFX_RANGE_B2DMULTIRANGE_HXX
-#define _BGFX_RANGE_B2DMULTIRANGE_HXX
-
-#include <o3tl/cow_wrapper.hxx>
-#include <memory>
-
-
-namespace basegfx
-{
-    class B2DTuple;
-    class B2DRange;
-    class B2DPolyPolygon;
-    class ImplB2DMultiRange;
-
-    /** 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.
-     */
-    class B2DMultiRange
-    {
-    public:
-        B2DMultiRange();
-        ~B2DMultiRange();
-
-        /** Create a multi range with exactly one containing range
-         */
-        explicit B2DMultiRange( const B2DRange& rRange );
-
-        B2DMultiRange( const B2DMultiRange& );
-        B2DMultiRange& operator=( const B2DMultiRange& );
-
-        /** Check whether range is empty.
-
-            @return true, if this object either contains no ranges at
-            all, or all contained ranges are empty.
-         */
-        bool            isEmpty() const;
-
-        /** Reset to empty.
-
-            After this call, the object will not contain any ranges,
-            and isEmpty() will return true.
-         */
-        void            reset();
-
-        /** Test whether given tuple is inside one or more of the
-            included ranges.
-         */
-        bool            isInside( const B2DTuple& rTuple ) const;
-
-        /** Test whether given range is inside one or more of the
-            included ranges.
-         */
-        bool            isInside( const B2DRange& rRange ) const;
-
-        /** Test whether given range overlaps one or more of the
-            included ranges.
-         */
-        bool            overlaps( const B2DRange& rRange ) const;
-
-        /** Add given range to the number of contained ranges.
-         */
-        void            addRange( const B2DRange& rRange );
-
-        /** Get overall bound rect for all included ranges.
-         */
-        B2DRange        getBounds() const;
-
-        /** Request poly-polygon representing the added ranges.
-
-            This method creates a poly-polygon, consisting exactly out
-            of the contained ranges.
-         */
-        B2DPolyPolygon  getPolyPolygon() const;
-
-    private:
-        o3tl::cow_wrapper< ImplB2DMultiRange > mpImpl;
-    };
-}
-
-#endif /* _BGFX_RANGE_B2DMULTIRANGE_HXX */
diff --git a/basegfx/inc/basegfx/range/b2dpolyrange.hxx b/basegfx/inc/basegfx/range/b2dpolyrange.hxx
new file mode 100644
index 000000000000..f31f8319b159
--- /dev/null
+++ b/basegfx/inc/basegfx/range/b2dpolyrange.hxx
@@ -0,0 +1,139 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: b2dmultirange.hxx,v $
+ * $Revision: 1.6 $
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef _BGFX_RANGE_B2DPOLYRANGE_HXX
+#define _BGFX_RANGE_B2DPOLYRANGE_HXX
+
+#include <o3tl/cow_wrapper.hxx>
+#include <boost/tuple/tuple.hpp>
+#include <basegfx/vector/b2enums.hxx>
+
+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 B2DPolyRange
+    {
+    public:
+        typedef boost::tuple<B2DRange,B2VectorOrientation> ElementType ;
+
+        B2DPolyRange();
+        ~B2DPolyRange();
+
+        /** Create a multi range with exactly one containing range
+         */
+        explicit B2DPolyRange( const ElementType& rElement );
+        B2DPolyRange( const B2DRange& rRange, B2VectorOrientation eOrient );
+        B2DPolyRange( const B2DPolyRange& );
+        B2DPolyRange& operator=( const B2DPolyRange& );
+
+        /// unshare this poly-range with all internally shared instances
+        void makeUnique();
+
+        bool operator==(const B2DPolyRange&) const;
+        bool operator!=(const B2DPolyRange&) const;
+
+        /// Number of included ranges
+        sal_uInt32 count() const;
+
+        ElementType getElement(sal_uInt32 nIndex) const;
+        void        setElement(sal_uInt32 nIndex, const ElementType& rElement );
+        void        setElement(sal_uInt32 nIndex, const B2DRange& rRange, B2VectorOrientation eOrient );
+
+        // insert/append a single range
+        void insertElement(sal_uInt32 nIndex, const ElementType& rElement, sal_uInt32 nCount = 1);
+        void insertElement(sal_uInt32 nIndex, const B2DRange& rRange, B2VectorOrientation eOrient, sal_uInt32 nCount = 1);
+        void appendElement(const ElementType& rElement, sal_uInt32 nCount = 1);
+        void appendElement(const B2DRange& rRange, B2VectorOrientation eOrient, sal_uInt32 nCount = 1);
+
+        // insert/append multiple ranges
+        void insertPolyRange(sal_uInt32 nIndex, const B2DPolyRange&);
+        void appendPolyRange(const B2DPolyRange&);
+
+        void remove(sal_uInt32 nIndex, sal_uInt32 nCount = 1);
+        void clear();
+
+        // flip range orientations - converts holes to solids, and vice versa
+        void flip();
+
+        /** Get overall range
+
+            @return
+            The union range of all contained ranges
+        */
+        B2DRange getBounds() const;
+
+        /** Test whether given tuple is inside one or more of the
+            included ranges. Does *not* use overall range, but checks
+            individually.
+         */
+        bool isInside( const B2DTuple& rTuple ) const;
+
+        /** Test whether given range is inside one or more of the
+            included ranges. Does *not* use overall range, but checks
+            individually.
+         */
+        bool isInside( const B2DRange& rRange ) const;
+
+        /** 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 /* _BGFX_RANGE_B2DPOLYRANGE_HXX */
diff --git a/basegfx/inc/basegfx/range/b2drangeclipper.hxx b/basegfx/inc/basegfx/range/b2drangeclipper.hxx
new file mode 100644
index 000000000000..3285ffeaffe1
--- /dev/null
+++ b/basegfx/inc/basegfx/range/b2drangeclipper.hxx
@@ -0,0 +1,53 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: b2dmultirange.hxx,v $
+ * $Revision: 1.6 $
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef _BGFX_RANGE_B2DRANGECLIPPER_HXX
+#define _BGFX_RANGE_B2DRANGECLIPPER_HXX
+
+#include <basegfx/range/b2dpolyrange.hxx>
+#include <vector>
+
+namespace basegfx
+{
+    namespace tools
+    {
+        /** Extract poly-polygon w/o self-intersections from poly-range
+
+            Similar to the solveCrossovers(const B2DPolyPolygon&)
+            method, this one calculates a self-intersection-free
+            poly-polygon with the same topology, and encoding
+            inside/outsidedness via polygon orientation and layering.
+         */
+        B2DPolyPolygon solveCrossovers(const std::vector<B2DRange>& rRanges,
+                                       const std::vector<B2VectorOrientation>& rOrientations);
+    }
+}
+
+#endif /* _BGFX_RANGE_B2DRANGECLIPPER_HXX */