QGIS API Documentation  3.0.2-Girona (307d082)
qgslinestring.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslinestring.h
3  -----------------
4  begin : September 2014
5  copyright : (C) 2014 by Marco Hugentobler
6  email : marco at sourcepole dot ch
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 #ifndef QGSLINESTRINGV2_H
19 #define QGSLINESTRINGV2_H
20 
21 
22 #include <QPolygonF>
23 
24 #include "qgis_core.h"
25 #include "qgis.h"
26 #include "qgscurve.h"
27 #include "qgscompoundcurve.h"
28 
29 /***************************************************************************
30  * This class is considered CRITICAL and any change MUST be accompanied with
31  * full unit tests in testqgsgeometry.cpp.
32  * See details in QEP #17
33  ****************************************************************************/
34 
41 class CORE_EXPORT QgsLineString: public QgsCurve
42 {
43  public:
44  QgsLineString();
45 
52  QgsLineString( const QVector<QgsPoint> &points );
53 
62  QgsLineString( const QVector<double> &x, const QVector<double> &y,
63  const QVector<double> &z = QVector<double>(),
64  const QVector<double> &m = QVector<double>() );
65 
72  QgsLineString( const QVector<QgsPointXY> &points );
73 
74  bool equals( const QgsCurve &other ) const override;
75 
80  QgsPoint pointN( int i ) const;
81 
82  double xAt( int index ) const override;
83  double yAt( int index ) const override;
84 
92  double zAt( int index ) const;
93 
101  double mAt( int index ) const;
102 
110  void setXAt( int index, double x );
111 
119  void setYAt( int index, double y );
120 
128  void setZAt( int index, double z );
129 
137  void setMAt( int index, double m );
138 
144  void setPoints( const QgsPointSequence &points );
145 
150  void append( const QgsLineString *line );
151 
156  void addVertex( const QgsPoint &pt );
157 
159  void close();
160 
164  QgsCompoundCurve *toCurveType() const override SIP_FACTORY;
165 
172  void extend( double startDistance, double endDistance );
173 
174  //reimplemented methods
175 
176  QString geometryType() const override;
177  int dimension() const override;
178  QgsLineString *clone() const override SIP_FACTORY;
179  void clear() override;
180  bool isEmpty() const override;
181  QgsLineString *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const override SIP_FACTORY;
182  bool removeDuplicateNodes( double epsilon = 4 * DBL_EPSILON, bool useZValues = false ) override;
183 
184  bool fromWkb( QgsConstWkbPtr &wkb ) override;
185  bool fromWkt( const QString &wkt ) override;
186 
187  QByteArray asWkb() const override;
188  QString asWkt( int precision = 17 ) const override;
189  QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const override;
190  QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const override;
191  QString asJson( int precision = 17 ) const override;
192 
193  //curve interface
194  double length() const override;
195  QgsPoint startPoint() const override;
196  QgsPoint endPoint() const override;
197 
203  QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
204 
205  int numPoints() const override;
206  int nCoordinates() const override;
207  void points( QgsPointSequence &pt SIP_OUT ) const override;
208 
209  void draw( QPainter &p ) const override;
210 
212  bool transformZ = false ) override;
213  void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
214 
215  void addToPainterPath( QPainterPath &path ) const override;
216  void drawAsPolygon( QPainter &p ) const override;
217 
218  bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
219  bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
220  bool deleteVertex( QgsVertexId position ) override;
221 
222  QgsLineString *reversed() const override SIP_FACTORY;
223 
224  double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = 4 * DBL_EPSILON ) const override;
225  bool pointAt( int node, QgsPoint &point, QgsVertexId::VertexType &type ) const override;
226 
227  QgsPoint centroid() const override;
228 
229  void sumUpArea( double &sum SIP_OUT ) const override;
230  double vertexAngle( QgsVertexId vertex ) const override;
231  double segmentLength( QgsVertexId startVertex ) const override;
232  bool addZValue( double zValue = 0 ) override;
233  bool addMValue( double mValue = 0 ) override;
234 
235  bool dropZValue() override;
236  bool dropMValue() override;
237 
238  bool convertTo( QgsWkbTypes::Type type ) override;
239 
240 #ifndef SIP_RUN
241 
249  inline const QgsLineString *cast( const QgsAbstractGeometry *geom ) const
250  {
251  if ( geom && QgsWkbTypes::flatType( geom->wkbType() ) == QgsWkbTypes::LineString )
252  return static_cast<const QgsLineString *>( geom );
253  return nullptr;
254  }
255 #endif
256 
258 
259  protected:
260 
261  QgsRectangle calculateBoundingBox() const override;
262 
263  private:
264  QVector<double> mX;
265  QVector<double> mY;
266  QVector<double> mZ;
267  QVector<double> mM;
268 
269  void importVerticesFromWkb( const QgsConstWkbPtr &wkb );
270 
276  void fromWkbPoints( QgsWkbTypes::Type type, const QgsConstWkbPtr &wkb );
277 
278  friend class QgsPolygon;
279  friend class QgsTriangle;
280 
281 };
282 
283 // clazy:excludeall=qstring-allocations
284 
285 #endif // QGSLINESTRINGV2_H
virtual QgsCurve * reversed() const =0
Returns a reversed copy of the curve, where the direction of the curve has been flipped.
virtual QString asWkt(int precision=17) const =0
Returns a WKT representation of the geometry.
A rectangle specified with double values.
Definition: qgsrectangle.h:39
virtual QgsAbstractGeometry * snappedToGrid(double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0) const =0
Makes a new geometry with all the points or vertices snapped to the closest point of the grid...
virtual bool isEmpty() const
Returns true if the geometry is empty.
virtual bool removeDuplicateNodes(double epsilon=4 *DBL_EPSILON, bool useZValues=false)=0
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerat...
virtual bool deleteVertex(QgsVertexId position)=0
Deletes a vertex within the geometry.
virtual QByteArray asWkb() const =0
Returns a WKB representation of the geometry.
virtual bool insertVertex(QgsVertexId position, const QgsPoint &vertex)=0
Inserts a vertex into the geometry.
TransformDirection
Enum used to indicate the direction (forward or inverse) of the transform.
virtual double vertexAngle(QgsVertexId vertex) const =0
Returns approximate angle at a vertex.
virtual bool addMValue(double mValue=0)=0
Adds a measure to the geometry, initialized to a preset value.
virtual void sumUpArea(double &sum) const =0
Sums up the area of the curve by iterating over the vertices (shoelace formula).
virtual QgsAbstractGeometry * createEmptyWithSameType() const =0
Creates a new geometry with the same class and same WKB type as the original and transfers ownership...
virtual QString asJson(int precision=17) const =0
Returns a GeoJSON representation of the geometry.
virtual double closestSegment(const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *DBL_EPSILON) const =0
Searches for the closest segment of the geometry to a given point.
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle...
virtual bool pointAt(int node, QgsPoint &point, QgsVertexId::VertexType &type) const =0
Returns the point and vertex id of a point within the curve.
virtual bool equals(const QgsCurve &other) const =0
Checks whether this curve exactly equals another curve.
Triangle geometry type.
Definition: qgstriangle.h:33
virtual void transform(const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false)=0
Transforms the geometry using a coordinate transform.
virtual QgsPoint centroid() const
Returns the centroid of the geometry.
virtual QgsPoint endPoint() const =0
Returns the end point of the curve.
virtual double length() const
Returns the length of the geometry.
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:67
virtual double segmentLength(QgsVertexId startVertex) const =0
Returns the length of the segment of the geometry which begins at startVertex.
Utility class for identifying a unique vertex within a geometry.
virtual double xAt(int index) const =0
Returns the x-coordinate of the specified node in the line string.
Abstract base class for curved geometry type.
Definition: qgscurve.h:35
#define SIP_FACTORY
Definition: qgis_sip.h:69
Abstract base class for all geometries.
virtual int dimension() const =0
Returns the inherent dimension of the geometry.
QgsWkbTypes::Type wkbType() const
Returns the WKB type of the geometry.
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
QVector< QgsPoint > QgsPointSequence
virtual void addToPainterPath(QPainterPath &path) const =0
Adds a curve to a painter path.
QgsCurve * toCurveType() const override
Returns the geometry converted to the more generic curve type.
Definition: qgscurve.cpp:177
virtual void clear()=0
Clears the geometry, ie reset it to a null geometry.
virtual QDomElement asGml2(QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
Returns a GML2 representation of the geometry.
virtual bool moveVertex(QgsVertexId position, const QgsPoint &newPos)=0
Moves a vertex within the geometry.
QgsCurve * clone() const override=0
Clones the geometry by performing a deep copy.
virtual void draw(QPainter &p) const =0
Draws the geometry using the specified QPainter.
#define SIP_OUT
Definition: qgis_sip.h:51
const QgsLineString * cast(const QgsAbstractGeometry *geom) const
Cast the geom to a QgsLineString.
virtual bool addZValue(double zValue=0)=0
Adds a z-dimension to the geometry, initialized to a preset value.
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:41
virtual QgsLineString * curveToLine(double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const =0
Returns a new line string geometry corresponding to a segmentized approximation of the curve...
virtual QgsRectangle calculateBoundingBox() const
Default calculator for the minimal bounding box for the geometry.
virtual double yAt(int index) const =0
Returns the y-coordinate of the specified node in the line string.
Class for doing transforms between two map coordinate systems.
virtual bool convertTo(QgsWkbTypes::Type type)
Converts the geometry to a specified type.
virtual QDomElement asGml3(QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
Returns a GML3 representation of the geometry.
Transform from source to destination CRS.
Compound curve geometry type.
virtual void drawAsPolygon(QPainter &p) const =0
Draws the curve as a polygon on the specified QPainter.
virtual bool dropMValue()=0
Drops any measure values which exist in the geometry.
virtual bool fromWkt(const QString &wkt)=0
Sets the geometry from a WKT string.
virtual QgsPoint startPoint() const =0
Returns the starting point of the curve.
Polygon geometry type.
Definition: qgspolygon.h:31
virtual int nCoordinates() const
Returns the number of nodes contained in the geometry.
static Type flatType(Type type)
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:427
virtual int numPoints() const =0
Returns the number of points in the curve.
double ANALYSIS_EXPORT leftOf(const QgsPoint &thepoint, const QgsPoint *p1, const QgsPoint *p2)
Returns whether &#39;thepoint&#39; is left or right of the line from &#39;p1&#39; to &#39;p2&#39;. Negativ values mean left a...
Definition: MathUtils.cpp:292
virtual bool dropZValue()=0
Drops any z-dimensions which exist in the geometry.
virtual void points(QgsPointSequence &pt) const =0
Returns a list of points within the curve.
virtual QString geometryType() const =0
Returns a unique string representing the geometry type.
virtual bool fromWkb(QgsConstWkbPtr &wkb)=0
Sets the geometry from a WKB string.