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