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