QGIS API Documentation  3.8.0-Zanzibar (11aff65)
qgsdxfexport.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsdxfexport.h
3  --------------
4  begin : September 2013
5  copyright : (C) 2013 by Marco Hugentobler
6  email : marco at sourcepole dot ch
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSDXFEXPORT_H
19 #define QGSDXFEXPORT_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgis.h"
24 #include "qgsgeometry.h"
25 #include "qgssymbol.h" // for OutputUnit enum
26 #include "qgsmapsettings.h"
27 
28 #include <QColor>
29 #include <QList>
30 #include <QTextStream>
31 
32 class QgsMapLayer;
33 class QgsPointXY;
34 class QgsSymbolLayer;
35 class QIODevice;
37 class QgsCurve;
38 class QgsCurvePolygon;
39 class QgsCircularString;
40 class QgsCompoundCurve;
41 
42 #define DXF_HANDSEED 100
43 #define DXF_HANDMAX 9999999
44 #define DXF_HANDPLOTSTYLE 0xf
45 
46 namespace pal SIP_SKIP
47 {
48  class LabelPosition;
49 }
50 
55 class CORE_EXPORT QgsDxfExport
56 {
57  public:
58 
63  struct DxfLayer
64  {
65  DxfLayer( QgsVectorLayer *vl, int layerOutputAttributeIndex = -1 )
66  : mLayer( vl )
67  , mLayerOutputAttributeIndex( layerOutputAttributeIndex )
68  {}
69 
71  QgsVectorLayer *layer() const {return mLayer;}
72 
77  int layerOutputAttributeIndex() const {return mLayerOutputAttributeIndex;}
78 
79  private:
80  QgsVectorLayer *mLayer = nullptr;
81  int mLayerOutputAttributeIndex = -1;
82  };
83 
85  {
86  NoSymbology = 0,
88  SymbolLayerSymbology
89  };
90 
92  enum Flag
93  {
94  FlagNoMText = 1 << 1,
95  };
96  Q_DECLARE_FLAGS( Flags, Flag )
97 
98 
101  QgsDxfExport() = default;
102  QgsDxfExport( const QgsDxfExport &dxfExport ) SIP_SKIP;
103  QgsDxfExport &operator=( const QgsDxfExport &dxfExport );
104 
109  void setMapSettings( const QgsMapSettings &settings );
110 
116  void setFlags( QgsDxfExport::Flags flags );
117 
123  QgsDxfExport::Flags flags() const;
124 
130  void addLayers( const QList< QgsDxfExport::DxfLayer > &layers );
131 
138  int writeToFile( QIODevice *d, const QString &codec ); //maybe add progress dialog? other parameters (e.g. scale, dpi)?
139 
146  void setSymbologyScale( double scale ) { mSymbologyScale = scale; }
147 
154  double symbologyScale() const { return mSymbologyScale; }
155 
160  QgsUnitTypes::DistanceUnit mapUnits() const;
161 
167  void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
168 
174  QgsCoordinateReferenceSystem destinationCrs() const;
175 
180  void setSymbologyExport( QgsDxfExport::SymbologyExport e ) { mSymbologyExport = e; }
181 
187  QgsDxfExport::SymbologyExport symbologyExport() const { return mSymbologyExport; }
188 
193  void setExtent( const QgsRectangle &r ) { mExtent = r; }
194 
200  QgsRectangle extent() const { return mExtent; }
201 
208  void setLayerTitleAsName( bool layerTitleAsName ) { mLayerTitleAsName = layerTitleAsName; }
209 
215  bool layerTitleAsName() { return mLayerTitleAsName; }
216 
222  void setForce2d( bool force2d ) { mForce2d = force2d; }
223 
229  bool force2d() { return mForce2d; }
230 
235  static int closestColorMatch( QRgb color );
236 
243  QString layerName( const QString &id, const QgsFeature &f ) const;
244 
251  QString layerName( QgsVectorLayer *vl ) const;
252 
259  void writeGroup( int code, int i ) SIP_PYNAME( writeGroupInt );
260 
267  void writeGroup( int code, double d ) SIP_PYNAME( writeGroupDouble );
268 
274  void writeGroup( int code, const QString &s );
275 
283  void writeGroup( int code, const QgsPoint &p ) SIP_PYNAME( writeGroupPointV2 );
284 
293  void writeGroup( const QColor &color, int exactMatch = 62, int rgbCode = 420, int transparencyCode = 440 );
294 
299  void writeGroupCode( int code );
300 
305  void writeInt( int i );
306 
311  void writeDouble( double d );
312 
317  void writeString( const QString &s );
318 
325  int writeHandle( int code = 5, int handle = 0 );
326 
337  void writePolyline( const QgsPointSequence &line, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ) SIP_SKIP;
338 
349  void writePolyline( const QgsCurve &curve, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ) SIP_SKIP;
350 
360  void writePolygon( const QgsRingSequence &polygon, const QString &layer, const QString &hatchPattern, const QColor &color ) SIP_SKIP;
361 
371  void writePolygon( const QgsCurvePolygon &polygon, const QString &layer, const QString &hatchPattern, const QColor &color ) SIP_SKIP;
372 
377  void writeLine( const QgsPoint &pt1, const QgsPoint &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 );
378 
384  void writePoint( const QString &layer, const QColor &color, const QgsPoint &pt ) SIP_PYNAME( writePointV2 );
385 
391  void writeFilledCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius ) SIP_PYNAME( writeFillCircleV2 );
392 
398  void writeCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius, const QString &lineStyleName, double width ) SIP_PYNAME( writeCircleV2 );
399 
405  void writeText( const QString &layer, const QString &text, const QgsPoint &pt, double size, double angle, const QColor &color ) SIP_PYNAME( writeTextV2 );
406 
412  void writeMText( const QString &layer, const QString &text, const QgsPoint &pt, double width, double angle, const QColor &color );
413 
421  static double mapUnitScaleFactor( double scale, QgsUnitTypes::RenderUnit symbolUnits, QgsUnitTypes::DistanceUnit mapUnits, double mapUnitsPerPixel = 1.0 );
422 
429  void clipValueToMapUnitScale( double &value, const QgsMapUnitScale &scale, double pixelToMMFactor ) const;
430 
432  static QString dxfLayerName( const QString &name );
433 
435  static QString dxfEncoding( const QString &name );
436 
438  static QStringList encodings();
439 
448  void drawLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings ) SIP_SKIP;
449 
456  void registerDxfLayer( const QString &layerId, QgsFeatureId fid, const QString &layer );
457 
458  private:
460  QgsRectangle mExtent;
462  double mSymbologyScale = 1.0;
463  SymbologyExport mSymbologyExport = NoSymbology;
465  bool mLayerTitleAsName = false;
466 
467  QTextStream mTextStream;
468 
469  static int sDxfColors[][3];
470  static const char *DXF_ENCODINGS[][2];
471 
472  int mSymbolLayerCounter = 0; //internal counter
473  int mNextHandleId = DXF_HANDSEED;
474  int mBlockCounter = 0;
475 
476  QHash< const QgsSymbolLayer *, QString > mLineStyles; //symbol layer name types
477  QHash< const QgsSymbolLayer *, QString > mPointSymbolBlocks; //reference to point symbol blocks
478 
479  //AC1009
480  void writeHeader( const QString &codepage );
481  void writeTables();
482  void writeBlocks();
483  void writeEntities();
484  void writeEntitiesSymbolLevels( QgsVectorLayer *layer );
485  void writeEndFile();
486 
487  void startSection();
488  void endSection();
489 
490  void writePoint( const QgsPoint &pt, const QString &layer, const QColor &color, QgsSymbolRenderContext &ctx, const QgsSymbolLayer *symbolLayer, const QgsSymbol *symbol, double angle );
491  void writeDefaultLinetypes();
492  void writeSymbolLayerLinetype( const QgsSymbolLayer *symbolLayer );
493  void writeLinetype( const QString &styleName, const QVector<qreal> &pattern, QgsUnitTypes::RenderUnit u );
494 
503  void addGeometryGeneratorSymbolLayer( QgsSymbolRenderContext &ctx, const QgsCoordinateTransform &ct, const QString &layer, QgsSymbolLayer *symbolLayer, bool allSymbolLayers );
504 
505  void addFeature( QgsSymbolRenderContext &ctx, const QgsCoordinateTransform &ct, const QString &layer, const QgsSymbolLayer *symbolLayer, const QgsSymbol *symbol );
506 
507  //returns dxf palette index from symbol layer color
508  static QColor colorFromSymbolLayer( const QgsSymbolLayer *symbolLayer, QgsSymbolRenderContext &ctx );
509  QString lineStyleFromSymbolLayer( const QgsSymbolLayer *symbolLayer );
510 
511  //functions for dxf palette
512  static int color_distance( QRgb p1, int index );
513  static QRgb createRgbEntry( qreal r, qreal g, qreal b );
514 
515  //helper functions for symbology export
516  QgsRenderContext renderContext() const;
517 
518  QList< QPair< QgsSymbolLayer *, QgsSymbol * > > symbolLayers( QgsRenderContext &context );
519  static int nLineTypes( const QList< QPair< QgsSymbolLayer *, QgsSymbol *> > &symbolLayers );
520  static bool hasDataDefinedProperties( const QgsSymbolLayer *sl, const QgsSymbol *symbol );
521  double dashSize() const;
522  double dotSize() const;
523  double dashSeparatorSize() const;
524  double sizeToMapUnits( double s ) const;
525  static QString lineNameFromPenStyle( Qt::PenStyle style );
526  bool layerIsScaleBasedVisible( const QgsMapLayer *layer ) const;
527 
528  QHash<QString, int> mBlockHandles;
529  QString mBlockHandle;
530 
532  QMap< QString, QMap<QgsFeatureId, QString> > mDxfLayerNames;
534  QgsMapSettings mMapSettings;
535  QHash<QString, int> mLayerNameAttribute;
536  double mFactor = 1.0;
537  bool mForce2d = false;
538 
539  QgsDxfExport::Flags mFlags = nullptr;
540 
541  void appendCurve( const QgsCurve &c, QVector<QgsPoint> &points, QVector<double> &bulges );
542  void appendLineString( const QgsLineString &ls, QVector<QgsPoint> &points, QVector<double> &bulges );
543  void appendCircularString( const QgsCircularString &cs, QVector<QgsPoint> &points, QVector<double> &bulges );
544  void appendCompoundCurve( const QgsCompoundCurve &cc, QVector<QgsPoint> &points, QVector<double> &bulges );
545 };
546 
547 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsDxfExport::Flags )
548 
549 #endif // QGSDXFEXPORT_H
A rectangle specified with double values.
Definition: qgsrectangle.h:41
Base class for all map layer types.
Definition: qgsmaplayer.h:78
double symbologyScale() const
Returns the reference scale for output.
Definition: qgsdxfexport.h:154
QgsDxfExport::SymbologyExport symbologyExport() const
Gets symbology export mode.
Definition: qgsdxfexport.h:187
DxfLayer(QgsVectorLayer *vl, int layerOutputAttributeIndex=-1)
Definition: qgsdxfexport.h:65
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:61
A class to represent a 2D point.
Definition: qgspointxy.h:43
bool force2d()
Retrieve whether the output should be forced to 2d.
Definition: qgsdxfexport.h:229
qint64 QgsFeatureId
Definition: qgsfeatureid.h:25
Curve polygon geometry type.
void setSymbologyExport(QgsDxfExport::SymbologyExport e)
Set symbology export mode.
Definition: qgsdxfexport.h:180
QgsVectorLayer * layer() const
Returns the layer.
Definition: qgsdxfexport.h:71
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
Layers and optional attribute index to split into multiple layers using attribute value as layer name...
Definition: qgsdxfexport.h:63
const QgsCoordinateReferenceSystem & crs
double ANALYSIS_EXPORT angle(QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
Definition: MathUtils.cpp:786
#define DXF_HANDSEED
Definition: qgsdxfexport.h:42
The QgsMapSettings class contains configuration for rendering of the map.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define SIP_SKIP
Definition: qgis_sip.h:119
void setForce2d(bool force2d)
Force 2d output (eg.
Definition: qgsdxfexport.h:222
Abstract base class for curved geometry type.
Definition: qgscurve.h:35
Keeps the number of features and export symbology per feature (using the first symbol level) ...
Definition: qgsdxfexport.h:87
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
DistanceUnit
Units of distance.
Definition: qgsunittypes.h:54
QVector< QgsPoint > QgsPointSequence
QVector< QgsPointSequence > QgsRingSequence
void setSymbologyScale(double scale)
Set reference scale for output.
Definition: qgsdxfexport.h:146
Contains information about the context of a rendering operation.
QgsRectangle extent() const
Gets extent of area to export.
Definition: qgsdxfexport.h:200
Flag
Export flags.
Definition: qgsdxfexport.h:92
void setLayerTitleAsName(bool layerTitleAsName)
Enable use of title (where set) instead of layer name, when attribute index of corresponding layer in...
Definition: qgsdxfexport.h:208
Struct for storing maximum and minimum scales for measurements in map units.
void setExtent(const QgsRectangle &r)
Set extent of area to export.
Definition: qgsdxfexport.h:193
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:43
bool layerTitleAsName()
Retrieve whether layer title (where set) instead of name shall be use.
Definition: qgsdxfexport.h:215
This class represents a coordinate reference system (CRS).
Class for doing transforms between two map coordinate systems.
LabelPosition is a candidate feature label position.
Definition: labelposition.h:55
Compound curve geometry type.
Circular string geometry type.
Represents a vector layer which manages a vector based data sets.
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:111
int layerOutputAttributeIndex() const
Returns the attribute index used to split into multiple layers.
Definition: qgsdxfexport.h:77
#define SIP_PYNAME(name)
Definition: qgis_sip.h:74