include/vcl/vectorgraphicdata.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_VCL_VECTORGRAPHICDATA_HXX
  21 #define INCLUDED_VCL_VECTORGRAPHICDATA_HXX
  22
  23 #include <basegfx/range/b2drange.hxx>
  24 #include <vcl/bitmapex.hxx>
  25 #include <vcl/BinaryDataContainer.hxx>
  26 #include <rtl/ustring.hxx>
  27 #include <deque>
  28 #include <algorithm>
  29 #include <optional>
  30
  31 namespace com::sun::star::graphic { class XPrimitive2D; }
  32
  33
  34 // helper to convert any Primitive2DSequence to a good quality BitmapEx,
  35 // using default parameters and graphic::XPrimitive2DRenderer
  36
  37 BitmapEx VCL_DLLPUBLIC convertPrimitive2DSequenceToBitmapEx(
  38     const std::deque< css::uno::Reference< css::graphic::XPrimitive2D > >& rSequence,
  39     const basegfx::B2DRange& rTargetRange,
  40     const sal_uInt32 nMaximumQuadraticPixels = 500000,
  41     const o3tl::Length eTargetUnit = o3tl::Length::mm100,
  42     const std::optional<Size>& rTargetDPI = std::nullopt);
  43
  44
  45 enum class VectorGraphicDataType
  46 {
  47     Svg = 0,
  48     Emf = 1,
  49     Wmf = 2,
  50     Pdf = 3
  51 };
  52
  53 class VCL_DLLPUBLIC VectorGraphicData
  54 {
  55 private:
  56     // the file and length
  57     BinaryDataContainer maDataContainer;
  58
  59     // on demand created content
  60     bool                        mbSequenceCreated;
  61     basegfx::B2DRange           maRange;
  62     std::deque< css::uno::Reference< css::graphic::XPrimitive2D > > maSequence;
  63     BitmapEx                    maReplacement;
  64     size_t                      mNestedBitmapSize;
  65     VectorGraphicDataType meType;
  66
  67     /// If the vector format has more pages this denotes which page to render
  68     sal_Int32 mnPageIndex;
  69
  70     /// Useful for PDF, which is vector-based, but still rendered to a bitmap.
  71     basegfx::B2DTuple maSizeHint;
  72
  73     bool mbEnableEMFPlus = true;
  74
  75     // on demand creators
  76     void ensurePdfReplacement();
  77     void ensureReplacement();
  78     void ensureSequenceAndRange();
  79
  80     VectorGraphicData(const VectorGraphicData&) = delete;
  81     VectorGraphicData& operator=(const VectorGraphicData&) = delete;
  82
  83 public:
  84     VectorGraphicData(const OUString& rPath, VectorGraphicDataType eVectorDataType);
  85     VectorGraphicData(
  86         BinaryDataContainer aDataContainer,
  87         VectorGraphicDataType eVectorDataType,
  88         sal_Int32 nPageIndex = -1);
  89     ~VectorGraphicData();
  90
  91     /// compare op
  92     bool operator==(const VectorGraphicData& rCandidate) const;
  93
  94     /// data read
  95     const BinaryDataContainer& getBinaryDataContainer() const
  96     {
  97         return maDataContainer;
  98     }
  99
 100     enum class State { UNPARSED, PARSED };
 101     std::pair<State, size_t> getSizeBytes() const;
 102
 103     const VectorGraphicDataType& getType() const { return meType; }
 104
 105     /// data read and evtl. on demand creation
 106     const basegfx::B2DRange& getRange() const;
 107     const std::deque<css::uno::Reference<css::graphic::XPrimitive2D>>& getPrimitive2DSequence() const;
 108     BitmapEx getBitmap(const Size& pixelSize) const;
 109     const BitmapEx& getReplacement() const;
 110     BitmapChecksum GetChecksum() const;
 111
 112     sal_Int32 getPageIndex() const
 113     {
 114         return std::max(sal_Int32(0), mnPageIndex);
 115     }
 116
 117     void setPageIndex(sal_Int32 nPageIndex)
 118     {
 119         mnPageIndex = nPageIndex;
 120     }
 121
 122     void setSizeHint(const basegfx::B2DTuple& rSizeHint)
 123     {
 124         maSizeHint = rSizeHint;
 125     }
 126
 127     const basegfx::B2DTuple& getSizeHint() const { return maSizeHint; }
 128
 129     void setEnableEMFPlus(bool bEnableEMFPlus) { mbEnableEMFPlus = bEnableEMFPlus; }
 130
 131     bool isPrimitiveSequenceCreated() const { return mbSequenceCreated; }
 132 };
 133
 134 #endif // INCLUDED_VCL_VECTORGRAPHICDATA_HXX
 135
 136 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */