office-gobmx/include/vcl/vectorgraphicdata.hxx
Miklos Vajna 04716690f6 sw HTML export: allow custom DPI for the bitmaps of shapes
But leave the CSS pixel size of them unchanged in the HTML markup.

Also add some documentation on the various options, so one doesn't have
to dig them out from testcases.

Change-Id: I6c6ee4e9c98d674f44e7c5835f2e6a6737e13f34
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/116722
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Tested-by: Jenkins
2021-06-04 18:03:10 +02:00

146 lines
4.6 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_VCL_VECTORGRAPHICDATA_HXX
#define INCLUDED_VCL_VECTORGRAPHICDATA_HXX
#include <basegfx/range/b2drange.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <vcl/bitmapex.hxx>
#include <vcl/BinaryDataContainer.hxx>
#include <rtl/ustring.hxx>
#include <deque>
#include <memory>
#include <algorithm>
#include <optional>
namespace com::sun::star::graphic { class XPrimitive2D; }
struct WmfExternal;
typedef css::uno::Sequence<sal_Int8> VectorGraphicDataArray;
// helper to convert any Primitive2DSequence to a good quality BitmapEx,
// using default parameters and graphic::XPrimitive2DRenderer
BitmapEx VCL_DLLPUBLIC convertPrimitive2DSequenceToBitmapEx(
const std::deque< css::uno::Reference< css::graphic::XPrimitive2D > >& rSequence,
const basegfx::B2DRange& rTargetRange,
const sal_uInt32 nMaximumQuadraticPixels = 500000,
const o3tl::Length eTargetUnit = o3tl::Length::mm100,
const std::optional<Size>& rTargetDPI = std::nullopt);
enum class VectorGraphicDataType
{
Svg = 0,
Emf = 1,
Wmf = 2,
Pdf = 3
};
class VCL_DLLPUBLIC VectorGraphicData
{
private:
// the file and length
BinaryDataContainer maDataContainer;
// on demand created content
bool mbSequenceCreated;
basegfx::B2DRange maRange;
std::deque< css::uno::Reference< css::graphic::XPrimitive2D > > maSequence;
BitmapEx maReplacement;
size_t mNestedBitmapSize;
VectorGraphicDataType meType;
// extra:
std::unique_ptr<WmfExternal> mpExternalHeader;
/// If the vector format has more pages this denotes which page to render
sal_Int32 mnPageIndex;
/// Useful for PDF, which is vector-based, but still rendered to a bitmap.
basegfx::B2DTuple maSizeHint;
bool mbEnableEMFPlus = true;
// on demand creators
void ensurePdfReplacement();
void ensureReplacement();
void ensureSequenceAndRange();
VectorGraphicData(const VectorGraphicData&) = delete;
VectorGraphicData& operator=(const VectorGraphicData&) = delete;
public:
VectorGraphicData(const OUString& rPath, VectorGraphicDataType eVectorDataType);
VectorGraphicData(
const BinaryDataContainer& rDataContainer,
VectorGraphicDataType eVectorDataType,
sal_Int32 nPageIndex = -1);
~VectorGraphicData();
/// compare op
bool operator==(const VectorGraphicData& rCandidate) const;
/// special: needed for emf/wmf, maybe replaced by scaling the result later (?)
void setWmfExternalHeader(const WmfExternal& aExtHeader);
/// data read
const BinaryDataContainer& getBinaryDataContainer() const
{
return maDataContainer;
}
enum class State { UNPARSED, PARSED };
std::pair<State, size_t> getSizeBytes() const;
const VectorGraphicDataType& getType() const { return meType; }
/// data read and evtl. on demand creation
const basegfx::B2DRange& getRange() const;
const std::deque<css::uno::Reference<css::graphic::XPrimitive2D>>& getPrimitive2DSequence() const;
const BitmapEx& getReplacement() const;
BitmapChecksum GetChecksum() const;
sal_Int32 getPageIndex() const
{
return std::max(sal_Int32(0), mnPageIndex);
}
void setPageIndex(sal_Int32 nPageIndex)
{
mnPageIndex = nPageIndex;
}
void setSizeHint(const basegfx::B2DTuple& rSizeHint)
{
maSizeHint = rSizeHint;
}
const basegfx::B2DTuple& getSizeHint() const { return maSizeHint; }
void setEnableEMFPlus(bool bEnableEMFPlus) { mbEnableEMFPlus = bEnableEMFPlus; }
bool isPrimitiveSequenceCreated() const { return mbSequenceCreated; }
};
#endif // INCLUDED_VCL_VECTORGRAPHICDATA_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */