include/drawinglayer/primitive2d/graphicprimitive2d.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_PRIMITIVE2D_GRAPHICPRIMITIVE2D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_GRAPHICPRIMITIVE2D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive2d/baseprimitive2d.hxx>
  26 #include <basegfx/matrix/b2dhommatrix.hxx>
  27 #include <svtools/grfmgr.hxx>
  28
  29
  30
  31 namespace drawinglayer
  32 {
  33     namespace primitive2d
  34     {
  35         /** GraphicPrimitive2D class
  36
  37             Primitive to hold graphics defined by GraphicObject and GraphicAttr
  38             combination. This includes MetaFiles and diverse pixel-oriented graphic
  39             formats. It even includes animated GIFs, Croppings and other changes
  40             defined in GraphicAttr.
  41
  42             This makes the decomposition contain a wide variety of possibilites,
  43             too. From a simple BitmapPrimitive over AnimatedSwitchPrimitive2D,
  44             MetafilePrimitive2D (with and without embedding in a masking when e.g.
  45             the Metafile is bigger than the geometry) and embeddings in
  46             TransformPrimitive2D and MaskPrimitive2D for croppings.
  47
  48             The primitive geometry area is defined by Transform.
  49          */
  50         class DRAWINGLAYER_DLLPUBLIC GraphicPrimitive2D : public BufferedDecompositionPrimitive2D
  51         {
  52         private:
  53             /// the geometric definition
  54             basegfx::B2DHomMatrix                       maTransform;
  55
  56             /// the GraphicObject with all its content possibilities
  57             GraphicObject                               maGraphicObject;
  58
  59             /// The GraphicAttr with all its modification possibilities
  60             GraphicAttr                                 maGraphicAttr;
  61
  62         protected:
  63             /// local decomposition
  64             virtual Primitive2DSequence create2DDecomposition(const geometry::ViewInformation2D& rViewInformation) const SAL_OVERRIDE;
  65
  66         public:
  67             /// constructor(s)
  68             GraphicPrimitive2D(
  69                 const basegfx::B2DHomMatrix& rTransform,
  70                 const GraphicObject& rGraphicObject,
  71                 const GraphicAttr& rGraphicAttr);
  72             GraphicPrimitive2D(
  73                 const basegfx::B2DHomMatrix& rTransform,
  74                 const GraphicObject& rGraphicObject);
  75
  76             /// data read access
  77             const basegfx::B2DHomMatrix& getTransform() const { return maTransform; }
  78             const GraphicObject& getGraphicObject() const { return maGraphicObject; }
  79             const GraphicAttr& getGraphicAttr() const { return maGraphicAttr; }
  80             bool isTransparent() const;
  81
  82             /// compare operator
  83             virtual bool operator==(const BasePrimitive2D& rPrimitive) const SAL_OVERRIDE;
  84
  85             /// get range
  86             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const SAL_OVERRIDE;
  87
  88             /// provide unique ID
  89             DeclPrimitive2DIDBlock()
  90         };
  91     } // end of namespace primitive2d
  92 } // end of namespace drawinglayer
  93
  94
  95
  96 #endif // INCLUDED_DRAWINGLAYER_PRIMITIVE2D_GRAPHICPRIMITIVE2D_HXX
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */