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