Line data    Source code

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