include/drawinglayer/primitive2d/maskprimitive2d.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 #ifndef INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MASKPRIMITIVE2D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MASKPRIMITIVE2D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive2d/groupprimitive2d.hxx>
  26 #include <basegfx/polygon/b2dpolypolygon.hxx>
  27
  28
  29 namespace drawinglayer
  30 {
  31     namespace primitive2d
  32     {
  33         /** MaskPrimitive2D class
  34
  35             This is the central masking primitive. It's a grouping
  36             primitive and contains a tools::PolyPolygon which defines the visible
  37             area. Only visualisation parts of the Child primitive sequence
  38             inside of the mask tools::PolyPolygon is defined to be visible.
  39
  40             This primitive should be handled by a renderer. If it is not handled,
  41             it decomposes to its Child content, and thus the visualisation would
  42             contain no clips.
  43
  44             The geometry range of this primitive is completely defined by the Mask
  45             tools::PolyPolygon since by definition nothing outside of the mask is visible.
  46          */
  47         class DRAWINGLAYER_DLLPUBLIC MaskPrimitive2D : public GroupPrimitive2D
  48         {
  49         private:
  50             /// the mask PolyPolygon
  51             basegfx::B2DPolyPolygon                 maMask;
  52
  53         public:
  54             /// constructor
  55             MaskPrimitive2D(
  56                 const basegfx::B2DPolyPolygon& rMask,
  57                 const Primitive2DContainer& rChildren);
  58
  59             /// data read access
  60             const basegfx::B2DPolyPolygon& getMask() const { return maMask; }
  61
  62             /// compare operator
  63             virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;
  64
  65             /// get range
  66             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const override;
  67
  68             /// provide unique ID
  69             DeclPrimitive2DIDBlock()
  70         };
  71     } // end of namespace primitive2d
  72 } // end of namespace drawinglayer
  73
  74
  75 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_MASKPRIMITIVE2D_HXX
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */