Branch data Line data Source code
1 : : /***************************************************************************
2 : : qgsalgorithmtransect.cpp
3 : : -------------------------
4 : : begin : October 2017
5 : : copyright : (C) 2017 by Loïc Bartoletti
6 : : email : lbartoletti at tuxfamily dot org
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 "qgsalgorithmtransect.h"
19 : : #include "qgsmultilinestring.h"
20 : : #include "qgslinestring.h"
21 : :
22 : : ///@cond PRIVATE
23 : :
24 : 0 : QString QgsTransectAlgorithm::name() const
25 : : {
26 : 0 : return QStringLiteral( "transect" );
27 : : }
28 : :
29 : 0 : QString QgsTransectAlgorithm::displayName() const
30 : : {
31 : 0 : return QObject::tr( "Transect" );
32 : : }
33 : :
34 : 0 : QStringList QgsTransectAlgorithm::tags() const
35 : : {
36 : 0 : return QObject::tr( "transect,station,lines,extend," ).split( ',' );
37 : 0 : }
38 : :
39 : 0 : QString QgsTransectAlgorithm::group() const
40 : : {
41 : 0 : return QObject::tr( "Vector geometry" );
42 : : }
43 : :
44 : 0 : QString QgsTransectAlgorithm::groupId() const
45 : : {
46 : 0 : return QStringLiteral( "vectorgeometry" );
47 : : }
48 : :
49 : 0 : void QgsTransectAlgorithm::initAlgorithm( const QVariantMap & )
50 : : {
51 : 0 : addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ),
52 : 0 : QObject::tr( "Input layer" ), QList< int >() << QgsProcessing::TypeVectorLine ) );
53 : 0 : std::unique_ptr< QgsProcessingParameterDistance > length = std::make_unique< QgsProcessingParameterDistance >( QStringLiteral( "LENGTH" ), QObject::tr( "Length of the transect" ),
54 : 0 : 5.0, QStringLiteral( "INPUT" ), false, 0 );
55 : 0 : length->setIsDynamic( true );
56 : 0 : length->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "LENGTH" ), QObject::tr( "Length of the transect" ), QgsPropertyDefinition::DoublePositive ) );
57 : 0 : length->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
58 : 0 : addParameter( length.release() );
59 : :
60 : 0 : std::unique_ptr< QgsProcessingParameterNumber > angle = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "ANGLE" ), QObject::tr( "Angle in degrees from the original line at the vertices" ), QgsProcessingParameterNumber::Double,
61 : 0 : 90.0, false, 0, 360 );
62 : 0 : angle->setIsDynamic( true );
63 : 0 : angle->setDynamicPropertyDefinition( QgsPropertyDefinition( QStringLiteral( "ANGLE" ), QObject::tr( "Angle in degrees" ), QgsPropertyDefinition::Double ) );
64 : 0 : angle->setDynamicLayerParameterName( QStringLiteral( "INPUT" ) );
65 : 0 : addParameter( angle.release() );
66 : :
67 : 0 : addParameter( new QgsProcessingParameterEnum( QStringLiteral( "SIDE" ), QObject::tr( "Side to create the transects" ), QStringList() << QObject::tr( "Left" ) << QObject::tr( "Right" ) << QObject::tr( "Both" ), false ) );
68 : 0 : addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Transect" ), QgsProcessing::TypeVectorLine ) );
69 : :
70 : 0 : }
71 : :
72 : 0 : QString QgsTransectAlgorithm::shortHelpString() const
73 : : {
74 : :
75 : 0 : return QObject::tr( "This algorithm creates transects on vertices for (multi)linestring.\n" ) +
76 : 0 : QObject::tr( "A transect is a line oriented from an angle (by default perpendicular) to the input polylines (at vertices)." ) +
77 : 0 : QStringLiteral( "\n\n" ) +
78 : 0 : QObject::tr( "Field(s) from feature(s) are returned in the transect with these new fields:\n" ) +
79 : 0 : QObject::tr( "- TR_FID: ID of the original feature\n" ) +
80 : 0 : QObject::tr( "- TR_ID: ID of the transect. Each transect have an unique ID\n" ) +
81 : 0 : QObject::tr( "- TR_SEGMENT: ID of the segment of the linestring\n" ) +
82 : 0 : QObject::tr( "- TR_ANGLE: Angle in degrees from the original line at the vertex\n" ) +
83 : 0 : QObject::tr( "- TR_LENGTH: Total length of the transect returned\n" ) +
84 : 0 : QObject::tr( "- TR_ORIENT: Side of the transect (only on the left or right of the line, or both side)\n" );
85 : :
86 : 0 : }
87 : :
88 : 0 : QgsTransectAlgorithm *QgsTransectAlgorithm::createInstance() const
89 : : {
90 : 0 : return new QgsTransectAlgorithm();
91 : : }
92 : :
93 : 0 : QVariantMap QgsTransectAlgorithm::processAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
94 : : {
95 : 0 : Side orientation = static_cast< QgsTransectAlgorithm::Side >( parameterAsInt( parameters, QStringLiteral( "SIDE" ), context ) );
96 : 0 : double angle = fabs( parameterAsDouble( parameters, QStringLiteral( "ANGLE" ), context ) );
97 : 0 : bool dynamicAngle = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "ANGLE" ) );
98 : 0 : QgsProperty angleProperty;
99 : 0 : if ( dynamicAngle )
100 : 0 : angleProperty = parameters.value( QStringLiteral( "ANGLE" ) ).value< QgsProperty >();
101 : :
102 : 0 : double length = parameterAsDouble( parameters, QStringLiteral( "LENGTH" ), context );
103 : 0 : bool dynamicLength = QgsProcessingParameters::isDynamic( parameters, QStringLiteral( "LENGTH" ) );
104 : 0 : QgsProperty lengthProperty;
105 : 0 : if ( dynamicLength )
106 : 0 : lengthProperty = parameters.value( QStringLiteral( "LENGTH" ) ).value< QgsProperty >();
107 : :
108 : 0 : if ( orientation == QgsTransectAlgorithm::Both )
109 : 0 : length /= 2.0;
110 : :
111 : 0 : std::unique_ptr< QgsFeatureSource > source( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
112 : 0 : if ( !source )
113 : 0 : throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
114 : :
115 : 0 : QgsExpressionContext expressionContext = createExpressionContext( parameters, context, dynamic_cast< QgsProcessingFeatureSource * >( source.get() ) );
116 : :
117 : 0 : QgsFields fields = source->fields();
118 : :
119 : 0 : fields.append( QgsField( QStringLiteral( "TR_FID" ), QVariant::Int, QString(), 20 ) );
120 : 0 : fields.append( QgsField( QStringLiteral( "TR_ID" ), QVariant::Int, QString(), 20 ) );
121 : 0 : fields.append( QgsField( QStringLiteral( "TR_SEGMENT" ), QVariant::Int, QString(), 20 ) );
122 : 0 : fields.append( QgsField( QStringLiteral( "TR_ANGLE" ), QVariant::Double, QString(), 5, 2 ) );
123 : 0 : fields.append( QgsField( QStringLiteral( "TR_LENGTH" ), QVariant::Double, QString(), 20, 6 ) );
124 : 0 : fields.append( QgsField( QStringLiteral( "TR_ORIENT" ), QVariant::Int, QString(), 1 ) );
125 : :
126 : 0 : QgsWkbTypes::Type outputWkb = QgsWkbTypes::LineString;
127 : 0 : if ( QgsWkbTypes::hasZ( source->wkbType() ) )
128 : 0 : outputWkb = QgsWkbTypes::addZ( outputWkb );
129 : 0 : if ( QgsWkbTypes::hasM( source->wkbType() ) )
130 : 0 : outputWkb = QgsWkbTypes::addM( outputWkb );
131 : :
132 : 0 : QString dest;
133 : 0 : std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest, fields,
134 : 0 : outputWkb, source->sourceCrs(), QgsFeatureSink::RegeneratePrimaryKey ) );
135 : 0 : if ( !sink )
136 : 0 : throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
137 : :
138 : 0 : QgsFeatureIterator features = source->getFeatures( );
139 : :
140 : 0 : int current = -1;
141 : 0 : int number = 0;
142 : 0 : double step = source->featureCount() > 0 ? 100.0 / source->featureCount() : 1;
143 : 0 : QgsFeature feat;
144 : :
145 : :
146 : 0 : while ( features.nextFeature( feat ) )
147 : : {
148 : 0 : current++;
149 : 0 : if ( feedback->isCanceled() )
150 : : {
151 : 0 : break;
152 : : }
153 : :
154 : 0 : feedback->setProgress( current * step );
155 : 0 : if ( !feat.hasGeometry() )
156 : 0 : continue;
157 : :
158 : 0 : QgsGeometry inputGeometry = feat.geometry();
159 : :
160 : 0 : if ( dynamicLength || dynamicAngle )
161 : : {
162 : 0 : expressionContext.setFeature( feat );
163 : 0 : }
164 : :
165 : 0 : double evaluatedLength = length;
166 : 0 : if ( dynamicLength )
167 : 0 : evaluatedLength = lengthProperty.valueAsDouble( context.expressionContext(), length );
168 : 0 : double evaluatedAngle = angle;
169 : 0 : if ( dynamicAngle )
170 : 0 : evaluatedAngle = angleProperty.valueAsDouble( context.expressionContext(), angle );
171 : :
172 : 0 : inputGeometry.convertToMultiType();
173 : 0 : const QgsMultiLineString *multiLine = static_cast< const QgsMultiLineString * >( inputGeometry.constGet() );
174 : 0 : for ( int id = 0; id < multiLine->numGeometries(); ++id )
175 : : {
176 : 0 : const QgsLineString *line = multiLine->lineStringN( id );
177 : 0 : QgsAbstractGeometry::vertex_iterator it = line->vertices_begin();
178 : 0 : while ( it != line->vertices_end() )
179 : : {
180 : 0 : QgsVertexId vertexId = it.vertexId();
181 : 0 : int i = vertexId.vertex;
182 : 0 : QgsFeature outFeat;
183 : 0 : QgsAttributes attrs = feat.attributes();
184 : 0 : attrs << current << number << i + 1 << evaluatedAngle <<
185 : 0 : ( ( orientation == QgsTransectAlgorithm::Both ) ? evaluatedLength * 2 : evaluatedLength ) <<
186 : 0 : orientation;
187 : 0 : outFeat.setAttributes( attrs );
188 : 0 : double angleAtVertex = line->vertexAngle( vertexId );
189 : 0 : outFeat.setGeometry( calcTransect( *it, angleAtVertex, evaluatedLength, orientation, evaluatedAngle ) );
190 : 0 : sink->addFeature( outFeat, QgsFeatureSink::FastInsert );
191 : 0 : number++;
192 : 0 : it++;
193 : 0 : }
194 : 0 : }
195 : 0 : }
196 : :
197 : 0 : QVariantMap outputs;
198 : 0 : outputs.insert( QStringLiteral( "OUTPUT" ), dest );
199 : 0 : return outputs;
200 : 0 : }
201 : :
202 : :
203 : 0 : QgsGeometry QgsTransectAlgorithm::calcTransect( const QgsPoint &point, const double angleAtVertex, const double length, const QgsTransectAlgorithm::Side orientation, const double angle )
204 : : {
205 : 0 : QgsPoint pLeft; // left point of the line
206 : 0 : QgsPoint pRight; // right point of the line
207 : :
208 : 0 : QgsPolyline line;
209 : :
210 : 0 : if ( ( orientation == QgsTransectAlgorithm::Right ) || ( orientation == QgsTransectAlgorithm::Both ) )
211 : : {
212 : 0 : pLeft = point.project( length, angle + 180.0 / M_PI * angleAtVertex );
213 : 0 : if ( orientation != QgsTransectAlgorithm::Both )
214 : 0 : pRight = point;
215 : 0 : }
216 : :
217 : 0 : if ( ( orientation == QgsTransectAlgorithm::Left ) || ( orientation == QgsTransectAlgorithm::Both ) )
218 : : {
219 : 0 : pRight = point.project( -length, angle + 180.0 / M_PI * angleAtVertex );
220 : 0 : if ( orientation != QgsTransectAlgorithm::Both )
221 : 0 : pLeft = point;
222 : 0 : }
223 : :
224 : 0 : line.append( pLeft );
225 : 0 : line.append( pRight );
226 : :
227 : 0 : return QgsGeometry::fromPolyline( line );
228 : 0 : }
229 : :
230 : : ///@endcond
|
