QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsalgorithmdxfexport.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmdxfexport.cpp
3 ---------------------
4 Date : September 2020
5 Copyright : (C) 2020 by Alexander Bruy
6 Email : alexander dot bruy at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
17
19#include "qgsdxfexport.h"
20
22
23QString QgsDxfExportAlgorithm::name() const
24{
25 return QStringLiteral( "dxfexport" );
26}
27
28QString QgsDxfExportAlgorithm::displayName() const
29{
30 return QObject::tr( "Export layers to DXF" );
31}
32
33QStringList QgsDxfExportAlgorithm::tags() const
34{
35 return QObject::tr( "layer,export,dxf,cad,dwg" ).split( ',' );
36}
37
38QString QgsDxfExportAlgorithm::group() const
39{
40 return QObject::tr( "Vector general" );
41}
42
43QString QgsDxfExportAlgorithm::groupId() const
44{
45 return QStringLiteral( "vectorgeneral" );
46}
47
48QString QgsDxfExportAlgorithm::shortHelpString() const
49{
50 return QObject::tr( "Exports layers to DXF file. For each layer, you can choose a field whose values are used to split features in generated destination layers in the DXF output.\n\n"
51 "If no field is chosen, you can still override the output layer name by directly entering a new output layer name in the Configure Layer panel or by preferring layer title (set in layer properties) to layer name." );
52}
53
54QgsDxfExportAlgorithm *QgsDxfExportAlgorithm::createInstance() const
55{
56 return new QgsDxfExportAlgorithm();
57}
58
59void QgsDxfExportAlgorithm::initAlgorithm( const QVariantMap & )
60{
61 addParameter( new QgsProcessingParameterDxfLayers( QStringLiteral( "LAYERS" ), QObject::tr( "Input layers" ) ) );
62 addParameter( new QgsProcessingParameterEnum( QStringLiteral( "SYMBOLOGY_MODE" ), QObject::tr( "Symbology mode" ), QStringList() << QObject::tr( "No Symbology" ) << QObject::tr( "Feature Symbology" ) << QObject::tr( "Symbol Layer Symbology" ), false, 0 ) );
63 addParameter( new QgsProcessingParameterScale( QStringLiteral( "SYMBOLOGY_SCALE" ), QObject::tr( "Symbology scale" ), 1000000 ) );
64 std::unique_ptr<QgsProcessingParameterMapTheme> mapThemeParam = std::make_unique<QgsProcessingParameterMapTheme>( QStringLiteral( "MAP_THEME" ), QObject::tr( "Map theme" ), QVariant(), true );
65 mapThemeParam->setHelp( QObject::tr( "Match layer styling to the provided map theme" ) );
66 addParameter( mapThemeParam.release() );
67 const QStringList encodings = QgsDxfExport::encodings();
68 addParameter( new QgsProcessingParameterEnum( QStringLiteral( "ENCODING" ), QObject::tr( "Encoding" ), encodings, false, encodings.at( 0 ), false, true ) );
69 addParameter( new QgsProcessingParameterCrs( QStringLiteral( "CRS" ), QObject::tr( "CRS" ), QStringLiteral( "EPSG:4326" ) ) );
70 std::unique_ptr<QgsProcessingParameterExtent> extentParam = std::make_unique<QgsProcessingParameterExtent>( QStringLiteral( "EXTENT" ), QObject::tr( "Extent" ), QVariant(), true );
71 extentParam->setHelp( QObject::tr( "Limit exported features to those with geometries intersecting the provided extent" ) );
72 addParameter( extentParam.release() );
73 addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "SELECTED_FEATURES_ONLY" ), QObject::tr( "Use only selected features" ), false ) );
74 std::unique_ptr<QgsProcessingParameterBoolean> useTitleParam = std::make_unique<QgsProcessingParameterBoolean>( QStringLiteral( "USE_LAYER_TITLE" ), QObject::tr( "Use layer title as name" ), false );
75 useTitleParam->setHelp( QObject::tr( "If no attribute is chosen and layer name is not being overridden, prefer layer title (set in layer properties) to layer name" ) );
76 addParameter( useTitleParam.release() );
77 addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "FORCE_2D" ), QObject::tr( "Force 2D output" ), false ) );
78 addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "MTEXT" ), QObject::tr( "Export labels as MTEXT elements" ), true ) );
79 addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "EXPORT_LINES_WITH_ZERO_WIDTH" ), QObject::tr( "Export lines with zero width" ) ), false );
80 addParameter( new QgsProcessingParameterFileDestination( QStringLiteral( "OUTPUT" ), QObject::tr( "DXF" ), QObject::tr( "DXF Files" ) + " (*.dxf *.DXF)" ) );
81}
82
83bool QgsDxfExportAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
84{
85 // Retrieve and clone layers
86 const QString mapTheme = parameterAsString( parameters, QStringLiteral( "MAP_THEME" ), context );
87 if ( !mapTheme.isEmpty() && context.project()->mapThemeCollection()->hasMapTheme( mapTheme ) )
88 {
89 mMapThemeStyleOverrides = context.project()->mapThemeCollection( )->mapThemeStyleOverrides( mapTheme );
90 }
91 return true;
92}
93
94QVariantMap QgsDxfExportAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
95{
96 QgsMapSettings mapSettings;
97 mapSettings.setTransformContext( context.transformContext() );
98 mapSettings.setLayerStyleOverrides( mMapThemeStyleOverrides );
99
100 QList<QgsVectorLayer *> mapLayers;
101
102 const QVariant layersVariant = parameters.value( parameterDefinition( QStringLiteral( "LAYERS" ) )->name() );
103 const QList<QgsDxfExport::DxfLayer> layers = QgsProcessingParameterDxfLayers::parameterAsLayers( layersVariant, context );
104 for ( const QgsDxfExport::DxfLayer &layer : layers )
105 {
106 if ( !layer.layer() )
107 throw QgsProcessingException( QObject::tr( "Unknown input layer" ) );
108
109 mapLayers.push_back( layer.layer() );
110 }
111
112 const Qgis::FeatureSymbologyExport symbologyMode = static_cast< Qgis::FeatureSymbologyExport >( parameterAsInt( parameters, QStringLiteral( "SYMBOLOGY_MODE" ), context ) );
113 const double symbologyScale = parameterAsDouble( parameters, QStringLiteral( "SYMBOLOGY_SCALE" ), context );
114 const QString encoding = parameterAsEnumString( parameters, QStringLiteral( "ENCODING" ), context );
115 const QgsCoordinateReferenceSystem crs = parameterAsCrs( parameters, QStringLiteral( "CRS" ), context );
116 const bool selectedFeaturesOnly = parameterAsBool( parameters, QStringLiteral( "SELECTED_FEATURES_ONLY" ), context );
117 const bool useLayerTitle = parameterAsBool( parameters, QStringLiteral( "USE_LAYER_TITLE" ), context );
118 const bool useMText = parameterAsBool( parameters, QStringLiteral( "MTEXT" ), context );
119 const bool force2D = parameterAsBool( parameters, QStringLiteral( "FORCE_2D" ), context );
120 const bool exportLinesWithZeroWidth = parameterAsBool( parameters, QStringLiteral( "EXPORT_LINES_WITH_ZERO_WIDTH" ), context );
121
122 QgsRectangle extent;
123 if ( parameters.value( QStringLiteral( "EXTENT" ) ).isValid() )
124 {
125 extent = parameterAsExtent( parameters, QStringLiteral( "EXTENT" ), context, crs );
126 }
127
128 const QString outputFile = parameterAsFileOutput( parameters, QStringLiteral( "OUTPUT" ), context );
129
130 QgsDxfExport dxfExport;
131
132 dxfExport.setMapSettings( mapSettings );
133 dxfExport.addLayers( layers );
134 dxfExport.setSymbologyScale( symbologyScale );
135 dxfExport.setSymbologyExport( symbologyMode );
136 dxfExport.setLayerTitleAsName( useLayerTitle );
137 dxfExport.setDestinationCrs( crs );
138 dxfExport.setForce2d( force2D );
139
140 if ( !extent.isEmpty() )
141 {
142 dxfExport.setExtent( extent );
143 }
144
146 if ( !useMText )
147 flags = flags | QgsDxfExport::FlagNoMText;
148 if ( selectedFeaturesOnly )
150 if ( exportLinesWithZeroWidth )
152 dxfExport.setFlags( flags );
153
154 QFile dxfFile( outputFile );
155 switch ( dxfExport.writeToFile( &dxfFile, encoding ) )
156 {
158 if ( !dxfExport.feedbackMessage().isEmpty() )
159 {
160 feedback->pushInfo( dxfExport.feedbackMessage() );
161 }
162 feedback->pushInfo( QObject::tr( "DXF export completed" ) );
163 break;
164
166 throw QgsProcessingException( QObject::tr( "DXF export failed, device is not writable" ) );
167 break;
168
170 throw QgsProcessingException( QObject::tr( "DXF export failed, the device is invalid" ) );
171 break;
172
174 throw QgsProcessingException( QObject::tr( "DXF export failed, the extent could not be determined" ) );
175 break;
176 }
177
178 QVariantMap outputs;
179 outputs.insert( QStringLiteral( "OUTPUT" ), outputFile );
180 return outputs;
181}
182
FeatureSymbologyExport
Options for exporting features considering their symbology.
Definition qgis.h:4716
This class represents a coordinate reference system (CRS).
Exports QGIS layers to the DXF format.
void setForce2d(bool force2d)
Force 2d output (eg.
@ DeviceNotWritableError
Device not writable error.
@ Success
Successful export.
@ EmptyExtentError
Empty extent, no extent given and no extent could be derived from layers.
@ InvalidDeviceError
Invalid device error.
ExportResult writeToFile(QIODevice *d, const QString &codec)
Export to a dxf file in the given encoding.
void setFlags(QgsDxfExport::Flags flags)
Sets the export flags.
@ FlagOnlySelectedFeatures
Use only selected features for the export.
@ FlagNoMText
Export text as TEXT elements. If not set, text will be exported as MTEXT elements.
void setDestinationCrs(const QgsCoordinateReferenceSystem &crs)
Set destination CRS.
void addLayers(const QList< QgsDxfExport::DxfLayer > &layers)
Add layers to export.
QFlags< Flag > Flags
void setSymbologyScale(double scale)
Set reference scale for output.
const QString feedbackMessage() const
Returns any feedback message produced while export to dxf file.
void setExtent(const QgsRectangle &r)
Set extent of area to export.
void setSymbologyExport(Qgis::FeatureSymbologyExport e)
Set symbology export mode.
static QStringList encodings()
Returns list of available DXF encodings.
void setMapSettings(const QgsMapSettings &settings)
Set map settings and assign layer name attributes.
void setLayerTitleAsName(bool layerTitleAsName)
Enable use of title (where set) instead of layer name, when attribute index of corresponding layer in...
The QgsMapSettings class contains configuration for rendering of the map.
void setLayerStyleOverrides(const QMap< QString, QString > &overrides)
Sets the map of map layer style overrides (key: layer ID, value: style name) where a different style ...
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the coordinate transform context, which stores various information regarding which datum transfo...
bool hasMapTheme(const QString &name) const
Returns whether a map theme with a matching name exists.
QMap< QString, QString > mapThemeStyleOverrides(const QString &name)
Gets layer style overrides (for QgsMapSettings) of the visible layers for given map theme.
Contains information about the context in which a processing algorithm is executed.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
QgsProject * project() const
Returns the project in which the algorithm is being executed.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
A boolean parameter for processing algorithms.
A coordinate reference system parameter for processing algorithms.
A parameter for Processing algorithms that need a list of input vector layers to export as DXF file -...
static QList< QgsDxfExport::DxfLayer > parameterAsLayers(const QVariant &layersVariant, QgsProcessingContext &context)
Converts a QVariant value (a QVariantList) to a list of input layers.
An enum based parameter for processing algorithms, allowing for selection from predefined values.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
A double numeric parameter for map scale values.
QgsMapThemeCollection * mapThemeCollection
Definition qgsproject.h:115
A rectangle specified with double values.
bool isEmpty() const
Returns true if the rectangle has no area.
const QgsCoordinateReferenceSystem & crs
Layers and optional attribute index to split into multiple layers using attribute value as layer name...