QGIS API Documentation  2.99.0-Master (dc72e14)
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 
38 namespace pal SIP_SKIP
39 {
40  class LabelPosition;
41 }
42 
46 class CORE_EXPORT QgsDxfExport
47 {
48  public:
50  {
51  NoSymbology = 0, //export only data
52  FeatureSymbology, //Keeps the number of features and export symbology per feature (using the first symbol level)
53  SymbolLayerSymbology //Exports one feature per symbol layer (considering symbol levels)
54  };
55 
56  QgsDxfExport();
57  QgsDxfExport( const QgsDxfExport &dxfExport ) SIP_SKIP;
58  QgsDxfExport &operator=( const QgsDxfExport &dxfExport );
59 
64  void setMapSettings( const QgsMapSettings &settings );
65 
71  void addLayers( const QList< QPair<QgsVectorLayer *, int > > &layers );
72 
79  int writeToFile( QIODevice *d, const QString &codec ); //maybe add progress dialog? other parameters (e.g. scale, dpi)?
80 
87  void setSymbologyScale( double scale ) { mSymbologyScale = scale; }
88 
95  double symbologyScale() const { return mSymbologyScale; }
96 
101  QgsUnitTypes::DistanceUnit mapUnits() const;
102 
108  void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
109 
115  QgsCoordinateReferenceSystem destinationCrs() const;
116 
121  void setSymbologyExport( QgsDxfExport::SymbologyExport e ) { mSymbologyExport = e; }
122 
128  QgsDxfExport::SymbologyExport symbologyExport() const { return mSymbologyExport; }
129 
134  void setExtent( const QgsRectangle &r ) { mExtent = r; }
135 
141  QgsRectangle extent() const { return mExtent; }
142 
149  void setLayerTitleAsName( bool layerTitleAsName ) { mLayerTitleAsName = layerTitleAsName; }
150 
156  bool layerTitleAsName() { return mLayerTitleAsName; }
157 
163  void setForce2d( bool force2d ) { mForce2d = force2d; }
164 
170  bool force2d() { return mForce2d; }
171 
176  static int closestColorMatch( QRgb color );
177 
184  QString layerName( const QString &id, const QgsFeature &f ) const;
185 
192  QString layerName( QgsVectorLayer *vl ) const;
193 
200  void writeGroup( int code, int i ) SIP_PYNAME( writeGroupInt );
201 
208  void writeGroup( int code, double d ) SIP_PYNAME( writeGroupDouble );
209 
215  void writeGroup( int code, const QString &s );
216 
224  void writeGroup( int code, const QgsPoint &p ) SIP_PYNAME( writeGroupPointV2 );
225 
234  void writeGroup( const QColor &color, int exactMatch = 62, int rgbCode = 420, int transparencyCode = 440 );
235 
240  void writeGroupCode( int code );
241 
246  void writeInt( int i );
247 
252  void writeDouble( double d );
253 
258  void writeString( const QString &s );
259 
266  int writeHandle( int code = 5, int handle = 0 );
267 
278  void writePolyline( const QgsPointSequence &line, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ) SIP_SKIP;
279 
289  void writePolygon( const QgsRingSequence &polygon, const QString &layer, const QString &hatchPattern, const QColor &color ) SIP_SKIP;
290 
293  void writeLine( const QgsPoint &pt1, const QgsPoint &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 );
294 
298  void writePoint( const QString &layer, const QColor &color, const QgsPoint &pt ) SIP_PYNAME( writePointV2 );
299 
303  void writeFilledCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius ) SIP_PYNAME( writeFillCircleV2 );
304 
308  void writeCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius, const QString &lineStyleName, double width ) SIP_PYNAME( writeCircleV2 );
309 
313  void writeText( const QString &layer, const QString &text, const QgsPoint &pt, double size, double angle, const QColor &color ) SIP_PYNAME( writeTextV2 );
314 
318  void writeMText( const QString &layer, const QString &text, const QgsPoint &pt, double width, double angle, const QColor &color );
319 
324  static double mapUnitScaleFactor( double scale, QgsUnitTypes::RenderUnit symbolUnits, QgsUnitTypes::DistanceUnit mapUnits );
325 
327  static QString dxfLayerName( const QString &name );
328 
330  static QString dxfEncoding( const QString &name );
331 
333  static QStringList encodings();
334 
342  void drawLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings ) SIP_SKIP;
343 
349  void registerDxfLayer( const QString &layerId, QgsFeatureId fid, const QString &layer );
350 
351  private:
353  QgsRectangle mExtent;
355  double mSymbologyScale;
356  SymbologyExport mSymbologyExport;
357  QgsUnitTypes::DistanceUnit mMapUnits;
358  bool mLayerTitleAsName;
359 
360  QTextStream mTextStream;
361 
362  static int sDxfColors[][3];
363  static const char *DXF_ENCODINGS[][2];
364 
365  int mSymbolLayerCounter; //internal counter
366  int mNextHandleId;
367  int mBlockCounter;
368 
369  QHash< const QgsSymbolLayer *, QString > mLineStyles; //symbol layer name types
370  QHash< const QgsSymbolLayer *, QString > mPointSymbolBlocks; //reference to point symbol blocks
371 
372  //AC1009
373  void writeHeader( const QString &codepage );
374  void writeTables();
375  void writeBlocks();
376  void writeEntities();
377  void writeEntitiesSymbolLevels( QgsVectorLayer *layer );
378  void writeEndFile();
379 
380  void startSection();
381  void endSection();
382 
383  void writePoint( const QgsPoint &pt, const QString &layer, const QColor &color, QgsSymbolRenderContext &ctx, const QgsSymbolLayer *symbolLayer, const QgsSymbol *symbol, double angle );
384  void writeDefaultLinetypes();
385  void writeSymbolLayerLinetype( const QgsSymbolLayer *symbolLayer );
386  void writeLinetype( const QString &styleName, const QVector<qreal> &pattern, QgsUnitTypes::RenderUnit u );
387 
388  void addFeature( QgsSymbolRenderContext &ctx, const QgsCoordinateTransform &ct, const QString &layer, const QgsSymbolLayer *symbolLayer, const QgsSymbol *symbol );
389 
390  //returns dxf palette index from symbol layer color
391  static QColor colorFromSymbolLayer( const QgsSymbolLayer *symbolLayer, QgsSymbolRenderContext &ctx );
392  QString lineStyleFromSymbolLayer( const QgsSymbolLayer *symbolLayer );
393 
394  //functions for dxf palette
395  static int color_distance( QRgb p1, int index );
396  static QRgb createRgbEntry( qreal r, qreal g, qreal b );
397 
398  //helper functions for symbology export
399  QgsRenderContext renderContext() const;
400 
401  QList< QPair< QgsSymbolLayer *, QgsSymbol * > > symbolLayers( QgsRenderContext &context );
402  static int nLineTypes( const QList< QPair< QgsSymbolLayer *, QgsSymbol *> > &symbolLayers );
403  static bool hasDataDefinedProperties( const QgsSymbolLayer *sl, const QgsSymbol *symbol );
404  double dashSize() const;
405  double dotSize() const;
406  double dashSeparatorSize() const;
407  double sizeToMapUnits( double s ) const;
408  static QString lineNameFromPenStyle( Qt::PenStyle style );
409  bool layerIsScaleBasedVisible( const QgsMapLayer *layer ) const;
410 
411  QHash<QString, int> mBlockHandles;
412  QString mBlockHandle;
413 
415  QMap< QString, QMap<QgsFeatureId, QString> > mDxfLayerNames;
417  QgsMapSettings mMapSettings;
418  QHash<QString, int> mLayerNameAttribute;
419  double mFactor = 1.0;
420  bool mForce2d = false;
421 };
422 
423 #endif // QGSDXFEXPORT_H
A rectangle specified with double values.
Definition: qgsrectangle.h:38
Base class for all map layer types.
Definition: qgsmaplayer.h:54
double symbologyScale() const
Returns the reference scale for output.
Definition: qgsdxfexport.h:95
QgsDxfExport::SymbologyExport symbologyExport() const
Get symbology export mode.
Definition: qgsdxfexport.h:128
A class to represent a 2D point.
Definition: qgspointxy.h:42
bool force2d()
Retrieve whether the output should be forced to 2d.
Definition: qgsdxfexport.h:170
void setSymbologyExport(QgsDxfExport::SymbologyExport e)
Set symbology export mode.
Definition: qgsdxfexport.h:121
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:61
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
The QgsMapSettings class contains configuration for rendering of the map.
#define SIP_SKIP
Definition: qgis_sip.h:119
void setForce2d(bool force2d)
Force 2d output (eg.
Definition: qgsdxfexport.h:163
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:36
DistanceUnit
Units of distance.
Definition: qgsunittypes.h:42
void setSymbologyScale(double scale)
Set reference scale for output.
Definition: qgsdxfexport.h:87
Contains information about the context of a rendering operation.
QgsRectangle extent() const
Get extent of area to export.
Definition: qgsdxfexport.h:141
void setLayerTitleAsName(bool layerTitleAsName)
Enable use of title (where set) instead of layer name, when attribute index of corresponding layer in...
Definition: qgsdxfexport.h:149
void setExtent(const QgsRectangle &r)
Set extent of area to export.
Definition: qgsdxfexport.h:134
bool layerTitleAsName()
Retrieve whether layer title (where set) instead of name shall be use.
Definition: qgsdxfexport.h:156
This class represents a coordinate reference system (CRS).
QList< QgsPointSequence > QgsRingSequence
Class for doing transforms between two map coordinate systems.
LabelPosition is a candidate feature label position.
Definition: labelposition.h:55
qint64 QgsFeatureId
Definition: qgsfeature.h:37
QList< QgsPoint > QgsPointSequence
Represents a vector layer which manages a vector based data sets.
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:98
#define SIP_PYNAME(name)
Definition: qgis_sip.h:74