include/drawinglayer/primitive3d/groupprimitive3d.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_GROUPPRIMITIVE3D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE3D_GROUPPRIMITIVE3D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive3d/baseprimitive3d.hxx>
  26
  27
  28 namespace drawinglayer::primitive3d
  29     {
  30         /** GroupPrimitive3D class
  31
  32             Baseclass for all grouping 3D primitives
  33
  34             The description/functionality is identical with the 2D case in groupprimitive2d.hxx,
  35             please see there for detailed information.
  36
  37             Current Basic 3D StatePrimitives are:
  38
  39             - ModifiedColorPrimitive3D (for a stack of color modifications)
  40             - ShadowPrimitive3D (for 3D objects with shadow; this is a special case
  41               since the shadow of a 3D primitive is a 2D primitive set)
  42             - TexturePrimitive3D (with the following variations)
  43                 - GradientTexturePrimitive3D (for 3D gradient fill)
  44                 - BitmapTexturePrimitive3D (for 3D Bitmap fill)
  45                 - TransparenceTexturePrimitive3D (for 3D transparence)
  46                 - HatchTexturePrimitive3D (for 3D hatch fill)
  47             - TransformPrimitive3D (for a transformation stack)
  48          */
  49         class DRAWINGLAYER_DLLPUBLIC GroupPrimitive3D : public BasePrimitive3D
  50         {
  51         private:
  52             /// the children. Declared private since this shall never be changed at all after construction
  53             Primitive3DContainer                             maChildren;
  54
  55         public:
  56             /// constructor
  57             explicit GroupPrimitive3D(Primitive3DContainer aChildren);
  58
  59             /// data read access
  60             const Primitive3DContainer& getChildren() const { return maChildren; }
  61
  62             /// compare operator
  63             virtual bool operator==( const BasePrimitive3D& rPrimitive ) const override;
  64
  65             /// local decomposition. Implementation will just return children
  66             virtual Primitive3DContainer get3DDecomposition(const geometry::ViewInformation3D& rViewInformation) const override;
  67
  68             /// provide unique ID
  69             DeclPrimitive3DIDBlock()
  70         };
  71
  72 } // end of namespace drawinglayer::primitive3d
  73
  74
  75 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE3D_GROUPPRIMITIVE3D_HXX
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */