include/drawinglayer/primitive2d/metafileprimitive2d.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_METAFILEPRIMITIVE2D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE2D_METAFILEPRIMITIVE2D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive2d/baseprimitive2d.hxx>
  26 #include <basegfx/matrix/b2dhommatrix.hxx>
  27 #include <vcl/gdimtf.hxx>
  28 #include <vcl/gdimetafiletools.hxx>
  29
  30
  31 // MetafilePrimitive2D class
  32
  33 namespace drawinglayer
  34 {
  35     namespace primitive2d
  36     {
  37         /** MetafilePrimitive2D class
  38
  39             This is the MetaFile representing primitive. It's geometry is defined
  40             by MetaFileTransform. The content (defined by MetaFile) will be scaled
  41             to the geometric definition by using PrefMapMode and PrefSize of the
  42             Metafile.
  43
  44             It has shown that this not always guarantees that all Metafile content
  45             is inside the geometric definition, but this primitive defines that this
  46             is the case to allow a getB2DRange implementation. If it cannot be
  47             guaranteed that the Metafile is inside the geometric definition, it should
  48             be embedded to a MaskPrimitive2D.
  49
  50             This primitive has no decomposition yet, so when not supported by a renderer,
  51             it will not be visualized.
  52
  53             In the future, a decomposition implementation would be appreciated and would
  54             have many advantages; Metafile would no longer have to be rendered by
  55             sub-systems and a standard way for converting Metafiles would exist.
  56          */
  57         class DRAWINGLAYER_DLLPUBLIC MetafilePrimitive2D : public BufferedDecompositionPrimitive2D, public MetafileAccessor
  58         {
  59         private:
  60             /// the geometry definition
  61             basegfx::B2DHomMatrix                       maMetaFileTransform;
  62
  63             /// the content definition
  64             GDIMetaFile                                 maMetaFile;
  65
  66         protected:
  67             /// local decomposition.
  68             virtual void create2DDecomposition(Primitive2DContainer& rContainer, const geometry::ViewInformation2D& rViewInformation) const override;
  69         public:
  70             /// constructor
  71             MetafilePrimitive2D(
  72                 const basegfx::B2DHomMatrix& rMetaFileTransform,
  73                 const GDIMetaFile& rMetaFile);
  74
  75             /// data read access
  76             const basegfx::B2DHomMatrix& getTransform() const { return maMetaFileTransform; }
  77             const GDIMetaFile& getMetaFile() const { return maMetaFile; }
  78
  79             /// compare operator
  80             virtual bool operator==(const BasePrimitive2D& rPrimitive) const override;
  81
  82             /// get range
  83             virtual basegfx::B2DRange getB2DRange(const geometry::ViewInformation2D& rViewInformation) const override;
  84
  85             /// from MetafileAccessor
  86             virtual void accessMetafile(GDIMetaFile& rTargetMetafile) const override;
  87
  88             /// provide unique ID
  89             DeclPrimitive2DIDBlock()
  90         };
  91     } // end of namespace primitive2d
  92 } // end of namespace drawinglayer
  93
  94
  95 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE2D_METAFILEPRIMITIVE2D_HXX
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */