QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsalgorithmtranslate.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmtranslate.cpp
3 ---------------------
4 begin : November 2017
5 copyright : (C) 2017 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
19#include "qgsvectorlayer.h"
20
22
23QString QgsTranslateAlgorithm::name() const
24{
25 return QStringLiteral( "translategeometry" );
26}
27
28QString QgsTranslateAlgorithm::displayName() const
29{
30 return QObject::tr( "Translate" );
31}
32
33QStringList QgsTranslateAlgorithm::tags() const
34{
35 return QObject::tr( "move,shift,transform,z,m,values,add" ).split( ',' );
36}
37
38QString QgsTranslateAlgorithm::group() const
39{
40 return QObject::tr( "Vector geometry" );
41}
42
43QString QgsTranslateAlgorithm::groupId() const
44{
45 return QStringLiteral( "vectorgeometry" );
46}
47
48QString QgsTranslateAlgorithm::outputName() const
49{
50 return QObject::tr( "Translated" );
51}
52
53QString QgsTranslateAlgorithm::shortHelpString() const
54{
55 return QObject::tr( "This algorithm moves the geometries within a layer, by offsetting them with a specified x and y displacement." )
56 + QStringLiteral( "\n\n" )
57 + QObject::tr( "Z and M values present in the geometry can also be translated." );
58}
59
60QgsTranslateAlgorithm *QgsTranslateAlgorithm::createInstance() const
61{
62 return new QgsTranslateAlgorithm();
63}
64
65void QgsTranslateAlgorithm::initParameters( const QVariantMap & )
66{
67 std::unique_ptr< QgsProcessingParameterDistance > xOffset = std::make_unique< QgsProcessingParameterDistance >( QStringLiteral( "DELTA_X" ),
68 QObject::tr( "Offset distance (x-axis)" ),
69 0.0, QStringLiteral( "INPUT" ) );
70 xOffset->setIsDynamic( true );
71 xOffset->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "DELTA_X" ), QObject::tr( "Offset distance (x-axis)" ), QgsPropertyDefinition::Double ) );
72 xOffset->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
73 addParameter( xOffset.release() );
74
75 std::unique_ptr< QgsProcessingParameterDistance > yOffset = std::make_unique< QgsProcessingParameterDistance >( QStringLiteral( "DELTA_Y" ),
76 QObject::tr( "Offset distance (y-axis)" ),
77 0.0, QStringLiteral( "INPUT" ) );
78 yOffset->setIsDynamic( true );
79 yOffset->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "DELTA_Y" ), QObject::tr( "Offset distance (y-axis)" ), QgsPropertyDefinition::Double ) );
80 yOffset->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
81 addParameter( yOffset.release() );
82
83 std::unique_ptr< QgsProcessingParameterNumber > zOffset = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "DELTA_Z" ),
84 QObject::tr( "Offset distance (z-axis)" ), Qgis::ProcessingNumberParameterType::Double,
85 0.0 );
86 zOffset->setIsDynamic( true );
87 zOffset->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "DELTA_Z" ), QObject::tr( "Offset distance (z-axis)" ), QgsPropertyDefinition::Double ) );
88 zOffset->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
89 addParameter( zOffset.release() );
90
91 std::unique_ptr< QgsProcessingParameterNumber > mOffset = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "DELTA_M" ),
92 QObject::tr( "Offset distance (m values)" ), Qgis::ProcessingNumberParameterType::Double,
93 0.0 );
94 mOffset->setIsDynamic( true );
95 mOffset->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "DELTA_M" ), QObject::tr( "Offset distance (m values)" ), QgsPropertyDefinition::Double ) );
96 mOffset->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
97 addParameter( mOffset.release() );
98}
99
100bool QgsTranslateAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
101{
102 mDeltaX = parameterAsDouble( parameters, QStringLiteral( "DELTA_X" ), context );
103 mDynamicDeltaX = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "DELTA_X" ) );
104 if ( mDynamicDeltaX )
105 mDeltaXProperty = parameters.value( QStringLiteral( "DELTA_X" ) ).value< QgsProperty >();
106
107 mDeltaY = parameterAsDouble( parameters, QStringLiteral( "DELTA_Y" ), context );
108 mDynamicDeltaY = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "DELTA_Y" ) );
109 if ( mDynamicDeltaY )
110 mDeltaYProperty = parameters.value( QStringLiteral( "DELTA_Y" ) ).value< QgsProperty >();
111
112 mDeltaZ = parameterAsDouble( parameters, QStringLiteral( "DELTA_Z" ), context );
113 mDynamicDeltaZ = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "DELTA_Z" ) );
114 if ( mDynamicDeltaZ )
115 mDeltaZProperty = parameters.value( QStringLiteral( "DELTA_Z" ) ).value< QgsProperty >();
116
117 mDeltaM = parameterAsDouble( parameters, QStringLiteral( "DELTA_M" ), context );
118 mDynamicDeltaM = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "DELTA_M" ) );
119 if ( mDynamicDeltaM )
120 mDeltaMProperty = parameters.value( QStringLiteral( "DELTA_M" ) ).value< QgsProperty >();
121
122 return true;
123}
124
125QgsFeatureList QgsTranslateAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback * )
126{
127 QgsFeature f = feature;
128 if ( f.hasGeometry() )
129 {
130 QgsGeometry geometry = f.geometry();
131
132 double deltaX = mDeltaX;
133 if ( mDynamicDeltaX )
134 deltaX = mDeltaXProperty.valueAsDouble( context.expressionContext(), deltaX );
135 double deltaY = mDeltaY;
136 if ( mDynamicDeltaY )
137 deltaY = mDeltaYProperty.valueAsDouble( context.expressionContext(), deltaY );
138 double deltaZ = mDeltaZ;
139 if ( mDynamicDeltaZ )
140 deltaZ = mDeltaZProperty.valueAsDouble( context.expressionContext(), deltaZ );
141 double deltaM = mDeltaM;
142 if ( mDynamicDeltaM )
143 deltaM = mDeltaMProperty.valueAsDouble( context.expressionContext(), deltaM );
144
145 if ( deltaZ != 0.0 && !geometry.constGet()->is3D() )
146 geometry.get()->addZValue( 0 );
147 if ( deltaM != 0.0 && !geometry.constGet()->isMeasure() )
148 geometry.get()->addMValue( 0 );
149
150 geometry.translate( deltaX, deltaY, deltaZ, deltaM );
151 f.setGeometry( geometry );
152 }
153 return QgsFeatureList() << f;
154}
155
156Qgis::WkbType QgsTranslateAlgorithm::outputWkbType( Qgis::WkbType inputWkbType ) const
157{
158 Qgis::WkbType wkb = inputWkbType;
159 if ( mDeltaZ != 0.0 )
160 wkb = QgsWkbTypes::addZ( wkb );
161 if ( mDeltaM != 0.0 )
162 wkb = QgsWkbTypes::addM( wkb );
163 return wkb;
164}
165
166
167bool QgsTranslateAlgorithm::supportInPlaceEdit( const QgsMapLayer *l ) const
168{
169 const QgsVectorLayer *layer = qobject_cast< const QgsVectorLayer * >( l );
170 if ( !layer )
171 return false;
172
174 return false;
175
176 // Check if we can drop Z/M and still have some work done
177 if ( mDeltaX != 0.0 || mDeltaY != 0.0 )
178 return true;
179
180 // If the type differs there is no sense in executing the algorithm and drop the result
181 const Qgis::WkbType inPlaceWkbType = layer->wkbType();
182 return inPlaceWkbType == outputWkbType( inPlaceWkbType );
183}
185
186
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:201
virtual bool addZValue(double zValue=0)=0
Adds a z-dimension to the geometry, initialized to a preset value.
bool isMeasure() const
Returns true if the geometry contains m values.
bool is3D() const
Returns true if the geometry is 3D and contains a z-value.
virtual bool addMValue(double mValue=0)=0
Adds a measure to the geometry, initialized to a preset value.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
QgsGeometry geometry
Definition qgsfeature.h:69
bool hasGeometry() const
Returns true if the feature has an associated geometry.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
A geometry is the spatial representation of a feature.
QgsAbstractGeometry * get()
Returns a modifiable (non-const) reference to the underlying abstract geometry primitive.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
Qgis::GeometryOperationResult translate(double dx, double dy, double dz=0.0, double dm=0.0)
Translates this geometry by dx, dy, dz and dm.
Base class for all map layer types.
Definition qgsmaplayer.h:75
Contains information about the context in which a processing algorithm is executed.
QgsExpressionContext & expressionContext()
Returns the expression context.
bool supportInPlaceEdit(const QgsMapLayer *layer) const override
Checks whether this algorithm supports in-place editing on the given layer Default implementation for...
Base class for providing feedback from a processing algorithm.
static bool isDynamic(const QVariantMap &parameters, const QString &name)
Returns true if the parameter with matching name is a dynamic parameter, and must be evaluated once f...
Definition for a property.
Definition qgsproperty.h:45
@ Double
Double value (including negative values)
Definition qgsproperty.h:55
A store for object properties.
double valueAsDouble(const QgsExpressionContext &context, double defaultValue=0.0, bool *ok=nullptr) const
Calculates the current value of the property and interprets it as a double.
Represents a vector layer which manages a vector based data sets.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
static Qgis::WkbType addM(Qgis::WkbType type)
Adds the m dimension to a WKB type and returns the new type.
static Qgis::WkbType addZ(Qgis::WkbType type)
Adds the z dimension to a WKB type and returns the new type.
QList< QgsFeature > QgsFeatureList