qgsabstractgeopdfexporter.h

Go to the documentation of this file.

/***************************************************************************
                              qgsabstractgeopdfexporter.h
                             --------------------------
    begin                : August 2019
    copyright            : (C) 2019 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSABSTRACTGEOPDFEXPORTER_H
#define QGSABSTRACTGEOPDFEXPORTER_H
 
#include "qgis_core.h"
#include "qgsabstractmetadatabase.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsfeature.h"
#include "qgspolygon.h"
 
#include <QDateTime>
#include <QList>
#include <QMutex>
#include <QPainter>
#include <QTemporaryDir>
 
#define SIP_NO_FILE
 
class QgsGeospatialPdfRenderedFeatureHandler;

class CORE_EXPORT QgsAbstractGeospatialPdfExporter
{
  public:

    static bool geospatialPDFCreationAvailable();

    static QString geospatialPDFAvailabilityExplanation();
 
    QgsAbstractGeospatialPdfExporter() = default;
 
    virtual ~QgsAbstractGeospatialPdfExporter() = default;

    struct RenderedFeature
    {
 
      RenderedFeature() = default;

      RenderedFeature( const QgsFeature &feature, const QgsGeometry &renderedBounds )
        : feature( feature )
        , renderedBounds( renderedBounds )
      {}

      QgsFeature feature;

      QgsGeometry renderedBounds;
    };

    struct CORE_EXPORT ComponentLayerDetail
    {

      QString name;

      QString mapLayerId;

      QString group;

      QString sourcePdfPath;

      QPainter::CompositionMode compositionMode = QPainter::CompositionMode_SourceOver;

      double opacity = 1.0;
 
    };

    struct ControlPoint
    {

      ControlPoint( const QgsPointXY &pagePoint, const QgsPointXY &geoPoint )
        : pagePoint( pagePoint )
        , geoPoint( geoPoint )
      {}

      QgsPointXY pagePoint;

      QgsPointXY geoPoint;
    };
 
    struct GeoReferencedSection
    {

      QgsRectangle pageBoundsMm;

      QgsPolygon pageBoundsPolygon;

      QgsCoordinateReferenceSystem crs;

      QList< QgsAbstractGeospatialPdfExporter::ControlPoint > controlPoints;
 
    };

    void pushRenderedFeature( const QString &layerId, const QgsAbstractGeospatialPdfExporter::RenderedFeature &feature, const QString &group = QString() );
 
    struct ExportDetails
    {
      QSizeF pageSizeMm;

      double dpi = 300;

      QList< QgsAbstractGeospatialPdfExporter::GeoReferencedSection > georeferencedSections;

      QString author;

      QString producer;

      QString creator;

      QDateTime creationDateTime;

      QString subject;

      QString title;

      QgsAbstractMetadataBase::KeywordMap keywords;

      bool useIso32000ExtensionFormatGeoreferencing = true;

      bool useOgcBestPracticeFormatGeoreferencing = false;

      bool includeFeatures = true;

      QMap< QString, QString > customLayerTreeGroups;

      QMap< QString, QString > layerIdToPdfLayerTreeNameMap;

      QMap< QString, bool > initialLayerVisibility;

      QStringList layerOrder;

      QStringList layerTreeGroupOrder;

      QSet< QString > mutuallyExclusiveGroups;
 
    };

    bool finalize( const QList< QgsAbstractGeospatialPdfExporter::ComponentLayerDetail > &components, const QString &destinationFile, const ExportDetails &details );

    QString errorMessage() const { return mErrorMessage; }

    QString generateTemporaryFilepath( const QString &filename ) const;

    static bool compositionModeSupported( QPainter::CompositionMode mode );
 
  protected:

    struct VectorComponentDetail
    {
      QString name;

      QString mapLayerId;

      QString group;

      QString displayAttribute;

      QString sourceVectorPath;

      QString sourceVectorLayer;
 
    };
 
  private:
 
    QMutex mMutex;
    QMap< QString, QMap< QString, QgsFeatureList > > mCollatedFeatures;

    virtual VectorComponentDetail componentDetailForLayerId( const QString &layerId ) = 0;
 
    QList< VectorComponentDetail > mVectorComponents;
 
    QString mErrorMessage;
    QTemporaryDir mTemporaryDir;
 
 
    bool saveTemporaryLayers();
 
    QString createCompositionXml( const QList< QgsAbstractGeospatialPdfExporter::ComponentLayerDetail > &components, const ExportDetails &details );

    static QString compositionModeToString( QPainter::CompositionMode mode );
 
    friend class TestQgsLayoutGeospatialPdfExport;
    friend class TestQgsGeospatialPdfExport;
};
 
#endif //QGSABSTRACTGEOPDFEXPORTER_H