include/basegfx/polygon/b2dpolypolygon.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <ostream>
  23 #include <vector>
  24
  25 #include <sal/types.h>
  26 #include <o3tl/cow_wrapper.hxx>
  27 #include <basegfx/range/b2drange.hxx>
  28 #include <basegfx/basegfxdllapi.h>
  29 #include <basegfx/polygon/b2dpolygon.hxx>
  30
  31 namespace basegfx
  32 {
  33     class B2DHomMatrix;
  34     class ImplB2DPolyPolygon;
  35
  36     class BASEGFX_DLLPUBLIC B2DPolyPolygon
  37     {
  38     private:
  39         o3tl::cow_wrapper<ImplB2DPolyPolygon, o3tl::ThreadSafeRefCountingPolicy> mpPolyPolygon;
  40
  41     public:
  42         B2DPolyPolygon();
  43         B2DPolyPolygon(const B2DPolyPolygon& rPolyPolygon);
  44         B2DPolyPolygon(B2DPolyPolygon&& rPolyPolygon);
  45         explicit B2DPolyPolygon(const B2DPolygon& rPolygon);
  46         ~B2DPolyPolygon();
  47
  48         // assignment operator
  49         B2DPolyPolygon& operator=(const B2DPolyPolygon& rPolyPolygon);
  50         B2DPolyPolygon& operator=(B2DPolyPolygon&& rPolyPolygon);
  51
  52         /// unshare this poly-polygon (and all included polygons) with all internally shared instances
  53         void makeUnique();
  54
  55         // compare operators
  56         bool operator==(const B2DPolyPolygon& rPolyPolygon) const;
  57
  58         // polygon interface
  59         sal_uInt32 count() const;
  60
  61         B2DPolygon const & getB2DPolygon(sal_uInt32 nIndex) const;
  62         void setB2DPolygon(sal_uInt32 nIndex, const B2DPolygon& rPolygon);
  63
  64         // test for curve
  65         bool areControlPointsUsed() const;
  66
  67         // insert/append single polygon
  68         void insert(sal_uInt32 nIndex, const B2DPolygon& rPolygon, sal_uInt32 nCount = 1);
  69         void append(const B2DPolygon& rPolygon, sal_uInt32 nCount = 1);
  70         void reserve(sal_uInt32 nCount);
  71
  72         /** Default adaptive subdivision access
  73
  74             For details refer to B2DPolygon::getDefaultAdaptiveSubdivision()
  75
  76             @return
  77             The default subdivision of this polygon
  78         */
  79         B2DPolyPolygon getDefaultAdaptiveSubdivision() const;
  80
  81         /** Get the B2DRange (Rectangle dimensions) of this B2DPolyPolygon
  82
  83             For details refer to B2DPolygon::getB2DRange()
  84
  85             @return
  86             The outer range of the bezier curve/polygon
  87         */
  88         B2DRange getB2DRange() const;
  89
  90         // insert/append multiple polygons
  91         void insert(sal_uInt32 nIndex, const B2DPolyPolygon& rPolyPolygon);
  92         void append(const B2DPolyPolygon& rPolyPolygon);
  93
  94         // remove
  95         void remove(sal_uInt32 nIndex, sal_uInt32 nCount = 1);
  96
  97         // reset to empty state
  98         void clear();
  99
 100         // closed state
 101         bool isClosed() const;
 102         void setClosed(bool bNew);
 103
 104         // flip polygon direction
 105         void flip();
 106
 107         // test if tools::PolyPolygon has double points
 108         bool hasDoublePoints() const;
 109
 110         // remove double points, at the begin/end and follow-ups, too
 111         void removeDoublePoints();
 112
 113         // apply transformation given in matrix form to the polygon
 114         void transform(const basegfx::B2DHomMatrix& rMatrix);
 115
 116         // polygon iterators (same iterator validity conditions as for vector)
 117         const B2DPolygon* begin() const;
 118         const B2DPolygon* end() const;
 119         B2DPolygon* begin();
 120         B2DPolygon* end();
 121
 122         // exclusive management op's for SystemDependentData at B2DPolygon
 123         template<class T>
 124         std::shared_ptr<T> getSystemDependentData(basegfx::SDD_Type aType) const
 125         {
 126             return std::static_pointer_cast<T>(getSystemDependantDataInternal(aType));
 127         }
 128
 129         template<class T, class... Args>
 130         std::shared_ptr<T> addOrReplaceSystemDependentData(Args&&... args) const
 131         {
 132             std::shared_ptr<T> r = std::make_shared<T>(std::forward<Args>(args)...);
 133
 134             // tdf#129845 only add to buffer if a relevant buffer time is estimated
 135             if(r->calculateCombinedHoldCyclesInSeconds() > 0)
 136             {
 137                 basegfx::SystemDependentData_SharedPtr r2(r);
 138                 addOrReplaceSystemDependentDataInternal(r2);
 139             }
 140
 141             return r;
 142         }
 143
 144     private:
 145         void addOrReplaceSystemDependentDataInternal(SystemDependentData_SharedPtr& rData) const;
 146         SystemDependentData_SharedPtr getSystemDependantDataInternal(basegfx::SDD_Type aType) const;
 147     };
 148
 149     // typedef for a vector of B2DPolyPolygons
 150     typedef ::std::vector< B2DPolyPolygon > B2DPolyPolygonVector;
 151
 152     template< typename charT, typename traits >
 153     inline std::basic_ostream<charT, traits> & operator <<(
 154         std::basic_ostream<charT, traits> & stream, const B2DPolyPolygon& poly )
 155     {
 156         stream << "[" << poly.count() << ":";
 157         for (sal_uInt32 i = 0; i < poly.count(); i++)
 158         {
 159             if (i > 0)
 160                 stream << ",";
 161             stream << poly.getB2DPolygon(i);
 162         }
 163         stream << "]";
 164
 165         return stream;
 166     }
 167
 168 } // end of namespace basegfx
 169
 170 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */