27QString QgsLayoutMapExtentToLayerAlgorithm::name()
const
29 return QStringLiteral(
"printlayoutmapextenttolayer" );
32QString QgsLayoutMapExtentToLayerAlgorithm::displayName()
const
34 return QObject::tr(
"Print layout map extent to layer" );
37QStringList QgsLayoutMapExtentToLayerAlgorithm::tags()
const
39 return QObject::tr(
"layout,composer,composition,visible" ).split(
',' );
42QString QgsLayoutMapExtentToLayerAlgorithm::group()
const
44 return QObject::tr(
"Cartography" );
47QString QgsLayoutMapExtentToLayerAlgorithm::groupId()
const
49 return QStringLiteral(
"cartography" );
52QString QgsLayoutMapExtentToLayerAlgorithm::shortDescription()
const
54 return QObject::tr(
"Creates a polygon layer containing the extent of a print layout map item." );
57void QgsLayoutMapExtentToLayerAlgorithm::initAlgorithm(
const QVariantMap & )
61 auto crsParam = std::make_unique< QgsProcessingParameterCrs >( QStringLiteral(
"CRS" ), QObject::tr(
"Override CRS" ), QVariant(),
true );
63 addParameter( crsParam.release() );
76QString QgsLayoutMapExtentToLayerAlgorithm::shortHelpString()
const
78 return QObject::tr(
"This algorithm creates a polygon layer containing the extent of a print layout map item (or items), "
79 "with attributes specifying the map size (in layout units), scale and rotation.\n\n"
80 "If the map item parameter is specified, then only the matching map extent will be exported. If it "
81 "is not specified, all map extents from the layout will be exported.\n\n"
82 "Optionally, a specific output CRS can be specified. If it is not specified, the original map "
83 "item CRS will be used." );
86QgsLayoutMapExtentToLayerAlgorithm *QgsLayoutMapExtentToLayerAlgorithm::createInstance()
const
88 return new QgsLayoutMapExtentToLayerAlgorithm();
94 QgsPrintLayout *layout = parameterAsLayout( parameters, QStringLiteral(
"LAYOUT" ), context );
96 throw QgsProcessingException( QObject::tr(
"Cannot find layout with name \"%1\"" ).arg( parameters.value( QStringLiteral(
"LAYOUT" ) ).toString() ) );
98 QgsLayoutItemMap *map = qobject_cast< QgsLayoutItemMap * >( parameterAsLayoutItem( parameters, QStringLiteral(
"MAP" ), context, layout ) );
99 if ( !map && parameters.value( QStringLiteral(
"MAP" ) ).isValid() )
100 throw QgsProcessingException( QObject::tr(
"Cannot find matching map item with ID %1" ).arg( parameters.value( QStringLiteral(
"MAP" ) ).toString() ) );
102 QList< QgsLayoutItemMap *> maps;
110 mFeatures.reserve( maps.size() );
113 if ( !mCrs.isValid() )
114 mCrs = !overrideCrs.
isValid() ? map->crs() : overrideCrs;
117 if ( map->crs() != mCrs )
125 feedback->
reportError( QObject::tr(
"Error reprojecting map to destination CRS" ) );
130 mWidth = map->rect().width();
131 mHeight = map->rect().height();
132 mScale = map->scale();
133 mRotation = map->mapRotation();
147 fields.
append(
QgsField( QStringLiteral(
"map" ), QMetaType::Type::QString ) );
148 fields.
append(
QgsField( QStringLiteral(
"width" ), QMetaType::Type::Double ) );
149 fields.
append(
QgsField( QStringLiteral(
"height" ), QMetaType::Type::Double ) );
150 fields.
append(
QgsField( QStringLiteral(
"scale" ), QMetaType::Type::Double ) );
151 fields.
append(
QgsField( QStringLiteral(
"rotation" ), QMetaType::Type::Double ) );
154 std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral(
"OUTPUT" ), context, dest, fields,
Qgis::WkbType::Polygon, mCrs ) );
167 outputs.insert( QStringLiteral(
"OUTPUT" ), dest );
169 outputs.insert( QStringLiteral(
"WIDTH" ), mFeatures.size() == 1 ? mWidth : QVariant() );
170 outputs.insert( QStringLiteral(
"HEIGHT" ), mFeatures.size() == 1 ? mHeight : QVariant() );
171 outputs.insert( QStringLiteral(
"SCALE" ), mFeatures.size() == 1 ? mScale : QVariant() );
172 outputs.insert( QStringLiteral(
"ROTATION" ), mFeatures.size() == 1 ? mRotation : QVariant() );
@ VectorPolygon
Vector polygon layers.
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
@ RequiresProject
The algorithm requires that a valid QgsProject is available from the processing context in order to e...
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
This class represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
Custom exception class for Coordinate Reference System related exceptions.
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
void setProgress(double progress)
Sets the current progress for the feedback object.
Encapsulate a field in an attribute table or data source.
Container of fields for a vector layer.
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
A geometry is the spatial representation of a feature.
static QgsGeometry fromQPolygonF(const QPolygonF &polygon)
Construct geometry from a QPolygonF.
Qgis::GeometryOperationResult transform(const QgsCoordinateTransform &ct, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward, bool transformZ=false)
Transforms this geometry as described by the coordinate transform ct.
Layout graphical items for displaying a map.
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
Print layout, a QgsLayout subclass for static or atlas-based layouts.
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Contains information about the context in which a processing algorithm is executed.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
A numeric output for processing algorithms.
A feature sink output for processing algorithms.
A print layout item parameter, allowing users to select a particular item from a print layout.
A print layout parameter, allowing users to select a print layout.