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