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