Branch data Line data Source code
1 : : /***************************************************************************
2 : : qgsalgorithmextractlayoutmapextent.cpp
3 : : ---------------------
4 : : begin : March 2019
5 : : copyright : (C) 2019 by Nyall Dawson
6 : : email : nyall dot dawson at gmail dot com
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 : : #include "qgsalgorithmextractlayoutmapextent.h"
19 : : #include "layout/qgslayoutitemregistry.h"
20 : : #include "layout/qgslayoutitemmap.h"
21 : : #include "layout/qgslayout.h"
22 : : #include "layout/qgsprintlayout.h"
23 : : #include "qgsprocessingoutputs.h"
24 : :
25 : : ///@cond PRIVATE
26 : :
27 : 0 : QString QgsLayoutMapExtentToLayerAlgorithm::name() const
28 : : {
29 : 0 : return QStringLiteral( "printlayoutmapextenttolayer" );
30 : : }
31 : :
32 : 0 : QString QgsLayoutMapExtentToLayerAlgorithm::displayName() const
33 : : {
34 : 0 : return QObject::tr( "Print layout map extent to layer" );
35 : : }
36 : :
37 : 0 : QStringList QgsLayoutMapExtentToLayerAlgorithm::tags() const
38 : : {
39 : 0 : return QObject::tr( "layout,composer,composition,visible" ).split( ',' );
40 : 0 : }
41 : :
42 : 0 : QString QgsLayoutMapExtentToLayerAlgorithm::group() const
43 : : {
44 : 0 : return QObject::tr( "Cartography" );
45 : : }
46 : :
47 : 0 : QString QgsLayoutMapExtentToLayerAlgorithm::groupId() const
48 : : {
49 : 0 : return QStringLiteral( "cartography" );
50 : : }
51 : :
52 : 0 : QString QgsLayoutMapExtentToLayerAlgorithm::shortDescription() const
53 : : {
54 : 0 : return QObject::tr( "Creates a polygon layer containing the extent of a print layout map item." );
55 : : }
56 : :
57 : 0 : void QgsLayoutMapExtentToLayerAlgorithm::initAlgorithm( const QVariantMap & )
58 : : {
59 : 0 : addParameter( new QgsProcessingParameterLayout( QStringLiteral( "LAYOUT" ), QObject::tr( "Print layout" ) ) );
60 : 0 : addParameter( new QgsProcessingParameterLayoutItem( QStringLiteral( "MAP" ), QObject::tr( "Map item" ), QVariant(), QStringLiteral( "LAYOUT" ), QgsLayoutItemRegistry::LayoutMap, true ) );
61 : 0 : auto crsParam = std::make_unique< QgsProcessingParameterCrs >( QStringLiteral( "CRS" ), QObject::tr( "Override CRS" ), QVariant(), true );
62 : 0 : crsParam->setFlags( crsParam->flags() | QgsProcessingParameterDefinition::FlagAdvanced );
63 : 0 : addParameter( crsParam.release() );
64 : 0 : addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Extent" ), QgsProcessing::TypeVectorPolygon ) );
65 : 0 : addOutput( new QgsProcessingOutputNumber( QStringLiteral( "WIDTH" ), QObject::tr( "Map width" ) ) );
66 : 0 : addOutput( new QgsProcessingOutputNumber( QStringLiteral( "HEIGHT" ), QObject::tr( "Map height" ) ) );
67 : 0 : addOutput( new QgsProcessingOutputNumber( QStringLiteral( "SCALE" ), QObject::tr( "Map scale" ) ) );
68 : 0 : addOutput( new QgsProcessingOutputNumber( QStringLiteral( "ROTATION" ), QObject::tr( "Map rotation" ) ) );
69 : 0 : }
70 : :
71 : 0 : QString QgsLayoutMapExtentToLayerAlgorithm::shortHelpString() const
72 : : {
73 : 0 : return QObject::tr( "This algorithm creates a polygon layer containing the extent of a print layout map item (or items), "
74 : : "with attributes specifying the map size (in layout units), scale and rotation.\n\n"
75 : : "If the map item parameter is specified, then only the matching map extent will be exported. If it "
76 : : "is not specified, all map extents from the layout will be exported.\n\n"
77 : : "Optionally, a specific output CRS can be specified. If it is not specified, the original map "
78 : : "item CRS will be used." );
79 : : }
80 : :
81 : 0 : QgsLayoutMapExtentToLayerAlgorithm *QgsLayoutMapExtentToLayerAlgorithm::createInstance() const
82 : : {
83 : 0 : return new QgsLayoutMapExtentToLayerAlgorithm();
84 : 0 : }
85 : :
86 : 0 : bool QgsLayoutMapExtentToLayerAlgorithm::prepareAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
87 : : {
88 : : // this needs to be done in main thread, layouts are not thread safe
89 : 0 : QgsPrintLayout *layout = parameterAsLayout( parameters, QStringLiteral( "LAYOUT" ), context );
90 : 0 : if ( !layout )
91 : 0 : throw QgsProcessingException( QObject::tr( "Cannot find layout with name \"%1\"" ).arg( parameters.value( QStringLiteral( "LAYOUT" ) ).toString() ) );
92 : :
93 : 0 : QgsLayoutItemMap *map = qobject_cast< QgsLayoutItemMap * >( parameterAsLayoutItem( parameters, QStringLiteral( "MAP" ), context, layout ) );
94 : 0 : if ( !map && parameters.value( QStringLiteral( "MAP" ) ).isValid() )
95 : 0 : throw QgsProcessingException( QObject::tr( "Cannot find matching map item with ID %1" ).arg( parameters.value( QStringLiteral( "MAP" ) ).toString() ) );
96 : :
97 : 0 : QList< QgsLayoutItemMap *> maps;
98 : 0 : if ( map )
99 : 0 : maps << map;
100 : : else
101 : 0 : layout->layoutItems( maps );
102 : :
103 : 0 : QgsCoordinateReferenceSystem overrideCrs = parameterAsCrs( parameters, QStringLiteral( "CRS" ), context );
104 : :
105 : 0 : mFeatures.reserve( maps.size() );
106 : 0 : for ( QgsLayoutItemMap *map : maps )
107 : : {
108 : 0 : if ( !mCrs.isValid() )
109 : 0 : mCrs = !overrideCrs.isValid() ? map->crs() : overrideCrs;
110 : :
111 : 0 : QgsGeometry extent = QgsGeometry::fromQPolygonF( map->visibleExtentPolygon() );
112 : 0 : if ( map->crs() != mCrs )
113 : : {
114 : : try
115 : : {
116 : 0 : extent.transform( QgsCoordinateTransform( map->crs(), mCrs, context.transformContext() ) );
117 : 0 : }
118 : : catch ( QgsCsException & )
119 : : {
120 : 0 : feedback->reportError( QObject::tr( "Error reprojecting map to destination CRS" ) );
121 : : continue;
122 : 0 : }
123 : 0 : }
124 : :
125 : 0 : mWidth = map->rect().width();
126 : 0 : mHeight = map->rect().height();
127 : 0 : mScale = map->scale();
128 : 0 : mRotation = map->mapRotation();
129 : :
130 : 0 : QgsFeature f;
131 : 0 : f.setAttributes( QgsAttributes() << map->displayName() << mWidth << mHeight << mScale << mRotation );
132 : 0 : f.setGeometry( extent );
133 : :
134 : 0 : mFeatures << f;
135 : 0 : }
136 : : return true;
137 : 0 : }
138 : :
139 : 0 : QVariantMap QgsLayoutMapExtentToLayerAlgorithm::processAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
140 : : {
141 : 0 : QgsFields fields;
142 : 0 : fields.append( QgsField( QStringLiteral( "map" ), QVariant::String ) );
143 : 0 : fields.append( QgsField( QStringLiteral( "width" ), QVariant::Double ) );
144 : 0 : fields.append( QgsField( QStringLiteral( "height" ), QVariant::Double ) );
145 : 0 : fields.append( QgsField( QStringLiteral( "scale" ), QVariant::Double ) );
146 : 0 : fields.append( QgsField( QStringLiteral( "rotation" ), QVariant::Double ) );
147 : :
148 : 0 : QString dest;
149 : 0 : std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest, fields, QgsWkbTypes::Polygon, mCrs ) );
150 : 0 : if ( !sink )
151 : 0 : throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
152 : :
153 : 0 : for ( QgsFeature &f : mFeatures )
154 : 0 : sink->addFeature( f, QgsFeatureSink::FastInsert );
155 : :
156 : 0 : feedback->setProgress( 100 );
157 : :
158 : 0 : QVariantMap outputs;
159 : 0 : outputs.insert( QStringLiteral( "OUTPUT" ), dest );
160 : : // these numeric outputs only have value for single-map layouts
161 : 0 : outputs.insert( QStringLiteral( "WIDTH" ), mFeatures.size() == 1 ? mWidth : QVariant() );
162 : 0 : outputs.insert( QStringLiteral( "HEIGHT" ), mFeatures.size() == 1 ? mHeight : QVariant() );
163 : 0 : outputs.insert( QStringLiteral( "SCALE" ), mFeatures.size() == 1 ? mScale : QVariant() );
164 : 0 : outputs.insert( QStringLiteral( "ROTATION" ), mFeatures.size() == 1 ? mRotation : QVariant() );
165 : 0 : return outputs;
166 : 0 : }
167 : :
168 : : ///@endcond
169 : :
|
