include/drawinglayer/primitive2d/patternfillprimitive2d.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 <drawinglayer/drawinglayerdllapi.h>
  23 #include <drawinglayer/primitive2d/BufferedDecompositionPrimitive2D.hxx>
  24 #include <basegfx/polygon/b2dpolypolygon.hxx>
  25 #include <vcl/bitmapex.hxx>
  26
  27
  28 namespace drawinglayer::primitive2d
  29 {
  30         /** PatternFillPrimitive2D class
  31
  32             This primitive allows filling a given tools::PolyPolygon with a pattern
  33             defined by a sequence of primitives which are mapped to  the unit range.
  34             The pattern is defined using a reference range which defines a rectangular
  35             area relative to the tools::PolyPolygon (in unit coordinates) which is virtually
  36             infinitely repeated.
  37          */
  38         class DRAWINGLAYER_DLLPUBLIC PatternFillPrimitive2D final : public BufferedDecompositionPrimitive2D
  39         {
  40         private:
  41             const basegfx::B2DPolyPolygon       maMask;
  42             const Primitive2DContainer          maChildren;
  43             const basegfx::B2DRange             maReferenceRange;
  44
  45             /// values holding the discrete buffer size
  46             sal_uInt32                          mnDiscreteWidth;
  47             sal_uInt32                          mnDiscreteHeight;
  48
  49             /// helper that is capable to calculate the needed discrete buffer size for
  50             /// eventually buffered content
  51             void calculateNeededDiscreteBufferSize(
  52                 sal_uInt32& rWidth,
  53                 sal_uInt32& rHeight,
  54                 const geometry::ViewInformation2D& rViewInformation) const;
  55
  56             /// helper which creates the content - checks if clipping is needed and eventually
  57             /// creates buffered content to speed up rendering
  58             Primitive2DContainer createContent(const geometry::ViewInformation2D& rViewInformation) const;
  59
  60             /// create local decomposition
  61             virtual void create2DDecomposition(Primitive2DContainer& rContainer, const geometry::ViewInformation2D& rViewInformation) const override;
  62
  63         public:
  64             /// constructor
  65             PatternFillPrimitive2D(
  66                 basegfx::B2DPolyPolygon aMask,
  67                 Primitive2DContainer&& rChildren,
  68                 const basegfx::B2DRange& rReferenceRange);
  69
  70             /// data read access
  71             const basegfx::B2DPolyPolygon& getMask() const { return maMask; }
  72             const Primitive2DContainer& getChildren() const { return maChildren; }
  73             const basegfx::B2DRange& getReferenceRange() const { return maReferenceRange; }
  74
  75             /// compare operator
  76             virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;
  77
  78             /// get range
  79             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const override;
  80
  81             /// overload to react on evtl. buffered content
  82             virtual void get2DDecomposition(Primitive2DDecompositionVisitor& rVisitor, const geometry::ViewInformation2D& rViewInformation) const override;
  83
  84             /// provide unique ID
  85             virtual sal_uInt32 getPrimitive2DID() const override;
  86
  87             // XAccounting
  88             virtual sal_Int64 estimateUsage() override;
  89
  90             /// helper which creates the content - checks if clipping is needed and eventually
  91             /// creates buffered content to speed up rendering
  92             BitmapEx createTileImage(sal_uInt32 nWidth, sal_uInt32 nHeight) const;
  93
  94             /// helper that is capable to calculate the needed discrete buffer size for
  95             /// eventually buffered content
  96             void getTileSize(
  97                 sal_uInt32& rWidth,
  98                 sal_uInt32& rHeight,
  99                 const geometry::ViewInformation2D& rViewInformation) const;
 100         };
 101 } // end of namespace drawinglayer::primitive2d
 102
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */