include/drawinglayer/primitive2d/transparenceprimitive2d.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_TRANSPARENCEPRIMITIVE2D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_TRANSPARENCEPRIMITIVE2D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive2d/groupprimitive2d.hxx>
  26
  27
  28 namespace drawinglayer
  29 {
  30     namespace primitive2d
  31     {
  32         /** TransparencePrimitive2D class
  33
  34             This is the basic primitive for applying freely defined transparence
  35             to freely defined content. The basic idea is to associate a content
  36             which is defined as a sequence of primitives and hold as child content
  37             in the GroupPrimitive2D with a transparence channel also defined as a sequence
  38             of primitives and hold in the transparence member.
  39
  40             The basic definition is to use the transparence content as transparence-Mask by
  41             interpreting the transparence-content not as RGB, but as Luminance transparence mask
  42             using the common RGB_to_luminance definition as e.g. used by VCL.
  43
  44             The defining geometry is the Range of the child primitive sequence,
  45             this means the renderers will/shall use this geometric information for
  46             rendering, not the transparent one. The transparent one should/will be clipped
  47             accordingly.
  48          */
  49         class DRAWINGLAYER_DLLPUBLIC TransparencePrimitive2D : public GroupPrimitive2D
  50         {
  51         private:
  52             /// The transparence-Mask who's RGB-Values are interpreted as Luminance
  53             Primitive2DContainer                     maTransparence;
  54
  55         public:
  56             /** constructor
  57
  58                 @param rChildren
  59                 The content which is defined to have a transparency. The
  60                 range of this primitive is defined by this content
  61
  62                 @param rTransparence
  63                 The definition of the Transparence-channel for this primitive. It
  64                 will be interpreted as mask by interpreting as gray values
  65                 using the common RGB_to_luminance definitions
  66              */
  67             TransparencePrimitive2D(
  68                 const Primitive2DContainer& rChildren,
  69                 const Primitive2DContainer& rTransparence);
  70
  71             /// data read access
  72             const Primitive2DContainer& getTransparence() const { return maTransparence; }
  73
  74             /// compare operator
  75             virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;
  76
  77             /// provide unique ID
  78             DeclPrimitive2DIDBlock()
  79         };
  80     } // end of namespace primitive2d
  81 } // end of namespace drawinglayer
  82
  83
  84 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_TRANSPARENCEPRIMITIVE2D_HXX
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */