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