include/drawinglayer/primitive3d/modifiedcolorprimitive3d.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_PRIMITIVE3D_MODIFIEDCOLORPRIMITIVE3D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE3D_MODIFIEDCOLORPRIMITIVE3D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive3d/groupprimitive3d.hxx>
  26 #include <basegfx/color/bcolormodifier.hxx>
  27
  28
  29 namespace drawinglayer::primitive3d
  30     {
  31         /** ModifiedColorPrimitive3D class
  32
  33             This primitive is a grouping primitive and allows to define
  34             how the colors of its child content shall be modified for
  35             visualisation. Please see the ModifiedColorPrimitive2D
  36             description for more info.
  37          */
  38         class DRAWINGLAYER_DLLPUBLIC ModifiedColorPrimitive3D final : public GroupPrimitive3D
  39         {
  40         private:
  41             /// The ColorModifier to use
  42             basegfx::BColorModifierSharedPtr    maColorModifier;
  43
  44         public:
  45             /// constructor
  46             ModifiedColorPrimitive3D(
  47                 const Primitive3DContainer& rChildren,
  48                 basegfx::BColorModifierSharedPtr xColorModifier);
  49
  50             /// data read access
  51             const basegfx::BColorModifierSharedPtr& getColorModifier() const { return maColorModifier; }
  52
  53             /// compare operator
  54             virtual bool operator==(const BasePrimitive3D& rPrimitive) const override;
  55
  56             /// provide unique ID
  57             DeclPrimitive3DIDBlock()
  58         };
  59
  60 } // end of namespace drawinglayer::primitive3d
  61
  62
  63 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE3D_MODIFIEDCOLORPRIMITIVE3D_HXX
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */