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