qgsdxfexport.h

Go to the documentation of this file.

/***************************************************************************
                         qgsdxfexport.h
                         --------------
    begin                : September 2013
    copyright            : (C) 2013 by Marco Hugentobler
    email                : marco at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSDXFEXPORT_H
#define QGSDXFEXPORT_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsgeometry.h"
#include "qgslabelsink.h"
#include "qgsmapsettings.h"
#include "qgsrendercontext.h"
 
#include <QColor>
#include <QList>
#include <QTextStream>
 
class QgsMapLayer;
class QgsPointXY;
class QgsSymbolLayer;
class QIODevice;
class QgsPalLayerSettings;
class QgsCurve;
class QgsCurvePolygon;
class QgsCircularString;
class QgsCompoundCurve;
struct DxfLayerJob;
class QgsSymbolRenderContext;
class QgsMarkerSymbolLayer;
 
#define DXF_HANDSEED 100
#define DXF_HANDMAX 9999999
#define DXF_HANDPLOTSTYLE 0xf
 
namespace pal // SIP_SKIP
{
  class LabelPosition;
}
 

#ifdef SIP_RUN
class CORE_EXPORT QgsDxfExport
{
#else
 
static const bool DEFAULT_DXF_DATA_DEFINED_BLOCKS = true;
 
class CORE_EXPORT QgsDxfExport : public QgsLabelSink
{
#endif
    friend class TestQgsDxfExport;
 
  public:
    struct CORE_EXPORT DxfLayer
    {
        DxfLayer( QgsVectorLayer *vl, int layerOutputAttributeIndex = -1, bool buildDDBlocks = DEFAULT_DXF_DATA_DEFINED_BLOCKS, int ddBlocksMaxNumberOfClasses = -1, QString overriddenName = QString() )
          : mLayer( vl )
          , mLayerOutputAttributeIndex( layerOutputAttributeIndex )
          , mBuildDDBlocks( buildDDBlocks )
          , mDDBlocksMaxNumberOfClasses( ddBlocksMaxNumberOfClasses )
          , mOverriddenName( overriddenName )
        {}

        QgsVectorLayer *layer() const { return mLayer; }

        int layerOutputAttributeIndex() const { return mLayerOutputAttributeIndex; }

        QString splitLayerAttribute() const;

        bool buildDataDefinedBlocks() const { return mBuildDDBlocks; }

        int dataDefinedBlocksMaximumNumberOfClasses() const { return mDDBlocksMaxNumberOfClasses; }

        QString overriddenName() const { return mOverriddenName; }
 
      private:
        QgsVectorLayer *mLayer = nullptr;
        int mLayerOutputAttributeIndex = -1;

        bool mBuildDDBlocks = DEFAULT_DXF_DATA_DEFINED_BLOCKS;

        int mDDBlocksMaxNumberOfClasses = -1;

        QString mOverriddenName;
    };

    enum Flag SIP_ENUM_BASETYPE( IntFlag )
    {
      FlagNoMText = 1 << 1,              
      FlagOnlySelectedFeatures = 1 << 2, 
      FlagHairlineWidthExport = 1 << 3   
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    
    enum class ExportResult
    {
      Success = 0,            
      InvalidDeviceError,     
      DeviceNotWritableError, 
      EmptyExtentError        
    };

    enum class VAlign : int
    {
      VBaseLine = 0,   
      VBottom = 1,     
      VMiddle = 2,     
      VTop = 3,        
      Undefined = 9999 
    };

    enum class HAlign : int
    {
      HLeft = 0,       
      HCenter = 1,     
      HRight = 2,      
      HAligned = 3,    
      HMiddle = 4,     
      HFit = 5,        
      Undefined = 9999 
    };

    enum DxfPolylineFlag SIP_ENUM_BASETYPE( IntFlag )
    {
      Closed = 1,              
      Curve = 2,               
      Spline = 4,              
      Is3DPolyline = 8,        
      Is3DPolygonMesh = 16,    
      PolygonMesh = 32,        
      PolyfaceMesh = 64,       
      ContinuousPattern = 128, 
    };
 
    Q_DECLARE_FLAGS( DxfPolylineFlags, DxfPolylineFlag )
 
    
    QgsDxfExport();
 
    ~QgsDxfExport() override;

    void setMapSettings( const QgsMapSettings &settings );

    void setFlags( QgsDxfExport::Flags flags );

    QgsDxfExport::Flags flags() const;

    void addLayers( const QList< QgsDxfExport::DxfLayer > &layers );

    ExportResult writeToFile( QIODevice *d, const QString &codec ); //maybe add progress dialog? other parameters (e.g. scale, dpi)?

    const QString feedbackMessage() const { return mFeedbackMessage; }

    void setSymbologyScale( double scale ) { mSymbologyScale = scale; }

    double symbologyScale() const { return mSymbologyScale; }

    Qgis::DistanceUnit mapUnits() const;

    void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );

    QgsCoordinateReferenceSystem destinationCrs() const;

    void setSymbologyExport( Qgis::FeatureSymbologyExport e ) { mSymbologyExport = e; }

    Qgis::FeatureSymbologyExport symbologyExport() const { return mSymbologyExport; }

    void setExtent( const QgsRectangle &r ) { mExtent = r; }

    QgsRectangle extent() const { return mExtent; }

    void setLayerTitleAsName( bool layerTitleAsName ) { mLayerTitleAsName = layerTitleAsName; }

    bool layerTitleAsName() { return mLayerTitleAsName; }

    void setForce2d( bool force2d ) { mForce2d = force2d; }

    bool force2d() { return mForce2d; }

    static int closestColorMatch( QRgb color );

    QString layerName( const QString &id, const QgsFeature &f ) const;

    QString layerName( QgsVectorLayer *vl ) const;

    void writeGroup( int code, int i ) SIP_PYNAME( writeGroupInt );

    void writeGroup( int code, long long i ) SIP_PYNAME( writeGroupLong );

    void writeGroup( int code, double d ) SIP_PYNAME( writeGroupDouble );

    void writeGroup( int code, const QString &s );

    void writeGroup( int code, const QgsPoint &p ) SIP_PYNAME( writeGroupPointV2 );

    void writeGroup( const QColor &color, int exactMatch = 62, int rgbCode = 420, int transparencyCode = 440 );

    void writeGroupCode( int code );

    void writeInt( int i );

    void writeDouble( double d );

    void writeString( const QString &s );

    int writeHandle( int code = 5, int handle = 0 );

    void writePolyline( const QgsPointSequence &line, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ) SIP_SKIP;

    void writePolyline( const QgsCurve &curve, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ) SIP_SKIP;

    void writePolygon( const QgsRingSequence &polygon, const QString &layer, const QString &hatchPattern, const QColor &color ) SIP_SKIP;

    void writePolygon( const QgsCurvePolygon &polygon, const QString &layer, const QString &hatchPattern, const QColor &color ) SIP_SKIP;

    void writeLine( const QgsPoint &pt1, const QgsPoint &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 );

    void writePoint( const QString &layer, const QColor &color, const QgsPoint &pt ) SIP_PYNAME( writePointV2 );

    void writeFilledCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius ) SIP_PYNAME( writeFillCircleV2 );

    void writeCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius, const QString &lineStyleName, double width ) SIP_PYNAME( writeCircleV2 );

    void writeText(
      const QString &layer,
      const QString &text,
      const QgsPoint &pt,
      double size,
      double angle,
      const QColor &color,
      QgsDxfExport::HAlign hali = QgsDxfExport::HAlign::Undefined,
      QgsDxfExport::VAlign vali = QgsDxfExport::VAlign::Undefined
    ) SIP_PYNAME( writeTextV2 );

    void writeMText( const QString &layer, const QString &text, const QgsPoint &pt, double width, double angle, const QColor &color );

    Q_DECL_DEPRECATED static double mapUnitScaleFactor( double scale, Qgis::RenderUnit symbolUnits, Qgis::DistanceUnit mapUnits, double mapUnitsPerPixel = 1.0 ) SIP_DEPRECATED;

    static double mapUnitScaleFactor( const QgsRenderContext &renderContext, Qgis::RenderUnit symbolUnits );

    void clipValueToMapUnitScale( double &value, const QgsMapUnitScale &scale, double pixelToMMFactor ) const;

    static QString dxfLayerName( const QString &name );

    static QString dxfEncoding( const QString &name );

    static QStringList encodings();

    void drawLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings ) SIP_SKIP override;

    Q_DECL_DEPRECATED void registerDxfLayer( const QString &layerId, QgsFeatureId fid, const QString &layer );
 
  private:
#ifdef SIP_RUN
    QgsDxfExport( const QgsDxfExport &other );
    QgsDxfExport &operator=( const QgsDxfExport & );
#endif
 
    struct DataDefinedBlockInfo
    {
        QString blockName;
        double angle;
        double size;
        QgsFeature feature; //a feature representing the attribute combination (without geometry)
    };

    QgsRectangle mExtent;
    double mSymbologyScale = 1.0;
    Qgis::FeatureSymbologyExport mSymbologyExport = Qgis::FeatureSymbologyExport::NoSymbology;
    Qgis::DistanceUnit mMapUnits = Qgis::DistanceUnit::Meters;
    bool mLayerTitleAsName = false;
 
    QTextStream mTextStream;
 
    int mSymbolLayerCounter = 0; //internal counter
    int mNextHandleId = DXF_HANDSEED;
    int mBlockCounter = 0;
 
    QHash< const QgsSymbolLayer *, QString > mLineStyles;            //symbol layer name types
    QHash< const QgsSymbolLayer *, QString > mPointSymbolBlocks;     //reference to point symbol blocks
    QHash< const QgsSymbolLayer *, double > mPointSymbolBlockSizes;  //reference to point symbol size used to create its block
    QHash< const QgsSymbolLayer *, double > mPointSymbolBlockAngles; //reference to point symbol size used to create its block
    QHash< const QgsSymbolLayer *, QHash<uint, DataDefinedBlockInfo> > mDataDefinedBlockInfo; // symbolLayerName -> symbolHash/Feature
 
    //AC1009
    void createDDBlockInfo();
    void writeHeader( const QString &codepage );
    void prepareRenderers();
    void writeTables();
    void writeBlocks();
    void writeEntities();
    void writeEntitiesSymbolLevels( DxfLayerJob *job );
    void stopRenderers();
    void writeEndFile();
 
    void startSection();
    void endSection();
 
    void writePoint( const QgsPoint &pt, const QString &layer, const QColor &color, QgsSymbolRenderContext &ctx, const QgsSymbolLayer *symbolLayer, const QgsSymbol *symbol, double angle );
    void writeDefaultLinetypes();
    void writeSymbolLayerLinetype( const QgsSymbolLayer *symbolLayer );
    void writeLinetype( const QString &styleName, const QVector<qreal> &pattern, Qgis::RenderUnit u );

    void writeText( const QString &layer, const QString &text, pal::LabelPosition *label, const QgsPalLayerSettings &layerSettings, const QgsExpressionContext &expressionContext );

    void addGeometryGeneratorSymbolLayer( QgsSymbolRenderContext &context, const QgsCoordinateTransform &ct, const QString &layer, QgsSymbolLayer *symbolLayer, bool allSymbolLayers );

    void addFeature( QgsSymbolRenderContext &context, const QgsCoordinateTransform &ct, const QString &layer, const QgsSymbolLayer *symbolLayer, const QgsSymbol *symbol );
 
    //returns dxf palette index from symbol layer color
    static QColor colorFromSymbolLayer( const QgsSymbolLayer *symbolLayer, QgsSymbolRenderContext &ctx );
    QString lineStyleFromSymbolLayer( const QgsSymbolLayer *symbolLayer );
 
    //functions for dxf palette
    static int color_distance( QRgb p1, int index );
    static QRgb createRgbEntry( qreal r, qreal g, qreal b );
 
    //helper functions for symbology export
    QgsRenderContext renderContext() const;
 
    QList< QPair< QgsSymbolLayer *, QgsSymbol * > > symbolLayers( QgsRenderContext &context );
    static int nLineTypes( const QList< QPair< QgsSymbolLayer *, QgsSymbol *> > &symbolLayers );
    static bool hasBlockBreakingDataDefinedProperties( const QgsSymbolLayer *sl, const QgsSymbol *symbol );
    static bool isSymbolLayerEnabled( const QgsSymbolLayer *layer, QgsSymbolRenderContext &context );
    void writeSymbolTableBlockRef( const QString &blockName );
    void writeSymbolLayerBlock( const QString &blockName, const QgsMarkerSymbolLayer *ml, QgsSymbolRenderContext &ctx );
    void writePointBlockReference(
      const QgsPoint &pt, const QgsSymbolLayer *symbolLayer, QgsSymbolRenderContext &ctx, const QString &layer, double angle, const QString &blockName, double blockAngle, double blockSize
    );
    static uint dataDefinedSymbolClassHash( const QgsFeature &fet, const QgsPropertyCollection &prop, const QgsExpressionContext &context );
 
    double dashSize() const;
    double dotSize() const;
    double dashSeparatorSize() const;
    double sizeToMapUnits( double s ) const;
    static QString lineNameFromPenStyle( Qt::PenStyle style );
    bool layerIsScaleBasedVisible( const QgsMapLayer *layer ) const;
 
    QHash<QString, int> mBlockHandles;
    QString mBlockHandle;

    QMap< QString, QMap<QgsFeatureId, QString> > mDxfLayerNames;
    QgsCoordinateReferenceSystem mCrs;
    QgsMapSettings mMapSettings;
    QList<QgsMapLayer *> mLayerList;
    QHash<QString, int> mLayerNameAttribute;
    QHash<QString, int> mLayerDDBlockMaxNumberOfClasses;
    QHash<QString, QString> mLayerOverriddenName;
    double mFactor = 1.0;
    bool mForce2d = false;
 
    QgsDxfExport::Flags mFlags = QgsDxfExport::Flags();
 
    void appendCurve( const QgsCurve &c, QVector<QgsPoint> &points, QVector<double> &bulges );
    void appendLineString( const QgsLineString &ls, QVector<QgsPoint> &points, QVector<double> &bulges );
    void appendCircularString( const QgsCircularString &cs, QVector<QgsPoint> &points, QVector<double> &bulges );
    void appendCompoundCurve( const QgsCompoundCurve &cc, QVector<QgsPoint> &points, QVector<double> &bulges );
 
    QgsRenderContext mRenderContext;
    // Internal cache for layer related information required during rendering
    QList<DxfLayerJob *> mJobs;
    std::unique_ptr<QgsLabelingEngine> mLabelingEngine;
 
    QString mFeedbackMessage;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsDxfExport::Flags )
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsDxfExport::DxfPolylineFlags )
 
#endif // QGSDXFEXPORT_H