drawinglayer/inc/primitive3d/shadowprimitive3d.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/primitive3d/groupprimitive3d.hxx>
  23 #include <basegfx/matrix/b2dhommatrix.hxx>
  24 #include <basegfx/color/bcolor.hxx>
  25
  26
  27 namespace drawinglayer::primitive3d
  28     {
  29         /** ShadowPrimitive3D class
  30
  31             This 3D grouping primitive is used to define a shadow for
  32             3d geometry by embedding it. The shadow of 3D objects are
  33             2D polygons, so the shadow transformation is a 2D transformation.
  34
  35             If the Shadow3D flag is set, the shadow definition has to be
  36             combined with the scene and camera definition to create the correct
  37             projected shadow 2D-Polygons.
  38          */
  39         class ShadowPrimitive3D final : public GroupPrimitive3D
  40         {
  41             /// 2D shadow definition
  42             basegfx::B2DHomMatrix                   maShadowTransform;
  43             basegfx::BColor                         maShadowColor;
  44             double                                  mfShadowTransparence;
  45
  46             bool                                    mbShadow3D : 1;
  47
  48         public:
  49             /// constructor
  50             ShadowPrimitive3D(
  51                 const basegfx::B2DHomMatrix& rShadowTransform,
  52                 const basegfx::BColor& rShadowColor,
  53                 double fShadowTransparence,
  54                 bool bShadow3D,
  55                 const Primitive3DContainer& rChildren);
  56
  57             /// data read access
  58             const basegfx::B2DHomMatrix& getShadowTransform() const { return maShadowTransform; }
  59             const basegfx::BColor& getShadowColor() const { return maShadowColor; }
  60             double getShadowTransparence() const { return mfShadowTransparence; }
  61             bool getShadow3D() const { return mbShadow3D; }
  62
  63             /// compare operator
  64             virtual bool operator==(const BasePrimitive3D& rPrimitive) const override;
  65
  66             /// provide unique ID
  67             DeclPrimitive3DIDBlock()
  68         };
  69
  70 } // end of namespace drawinglayer::primitive3d
  71
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */