QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
qgslinestringv2.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslinestringv2.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 #include "qgscurvev2.h"
22 #include "qgswkbptr.h"
23 #include <QPolygonF>
24 
25 /***************************************************************************
26  * This class is considered CRITICAL and any change MUST be accompanied with
27  * full unit tests in testqgsgeometry.cpp.
28  * See details in QEP #17
29  ****************************************************************************/
30 
36 class CORE_EXPORT QgsLineStringV2: public QgsCurveV2
37 {
38  public:
40  ~QgsLineStringV2();
41 
42  bool operator==( const QgsCurveV2& other ) const override;
43  bool operator!=( const QgsCurveV2& other ) const override;
44 
48  QgsPointV2 pointN( int i ) const;
49 
55  double xAt( int index ) const;
56 
62  double yAt( int index ) const;
63 
70  double zAt( int index ) const;
71 
78  double mAt( int index ) const;
79 
86  void setXAt( int index, double x );
87 
94  void setYAt( int index, double y );
95 
102  void setZAt( int index, double z );
103 
110  void setMAt( int index, double m );
111 
116  void setPoints( const QgsPointSequenceV2 &points );
117 
121  void append( const QgsLineStringV2* line );
122 
126  void addVertex( const QgsPointV2& pt );
127 
129  void close();
130 
133  QPolygonF asQPolygonF() const;
134 
137  QgsAbstractGeometryV2* toCurveType() const override;
138 
139  //reimplemented methods
140 
141  virtual QString geometryType() const override { return "LineString"; }
142  virtual int dimension() const override { return 1; }
143  virtual QgsLineStringV2* clone() const override;
144  virtual void clear() override;
145 
146  virtual bool fromWkb( QgsConstWkbPtr wkb ) override;
147  virtual bool fromWkt( const QString& wkt ) override;
148 
149  int wkbSize() const override;
150  unsigned char* asWkb( int& binarySize ) const override;
151  QString asWkt( int precision = 17 ) const override;
152  QDomElement asGML2( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const override;
153  QDomElement asGML3( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const override;
154  QString asJSON( int precision = 17 ) const override;
155 
156  //curve interface
157  virtual double length() const override;
158  virtual QgsPointV2 startPoint() const override;
159  virtual QgsPointV2 endPoint() const override;
164  virtual QgsLineStringV2* curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override;
165 
166  int numPoints() const override;
167  virtual int nCoordinates() const override { return mX.size(); }
168  void points( QgsPointSequenceV2 &pt ) const override;
169 
170  void draw( QPainter& p ) const override;
171 
173  bool transformZ = false ) override;
174  void transform( const QTransform& t ) override;
175 
176  void addToPainterPath( QPainterPath& path ) const override;
177  void drawAsPolygon( QPainter& p ) const override;
178 
179  virtual bool insertVertex( QgsVertexId position, const QgsPointV2& vertex ) override;
180  virtual bool moveVertex( QgsVertexId position, const QgsPointV2& newPos ) override;
181  virtual bool deleteVertex( QgsVertexId position ) override;
182 
183  virtual QgsLineStringV2* reversed() const override;
184 
185  double closestSegment( const QgsPointV2& pt, QgsPointV2& segmentPt, QgsVertexId& vertexAfter, bool* leftOf, double epsilon ) const override;
186  bool pointAt( int node, QgsPointV2& point, QgsVertexId::VertexType& type ) const override;
187 
188  virtual QgsPointV2 centroid() const override;
189 
190  void sumUpArea( double& sum ) const override;
191  double vertexAngle( QgsVertexId vertex ) const override;
192 
193  virtual bool addZValue( double zValue = 0 ) override;
194  virtual bool addMValue( double mValue = 0 ) override;
195 
196  virtual bool dropZValue() override;
197  virtual bool dropMValue() override;
198 
199  bool convertTo( QgsWKBTypes::Type type ) override;
200 
201  protected:
202 
203  virtual QgsRectangle calculateBoundingBox() const override;
204 
205  private:
206  QVector<double> mX;
207  QVector<double> mY;
208  QVector<double> mZ;
209  QVector<double> mM;
210 
211  void importVerticesFromWkb( const QgsConstWkbPtr& wkb );
212 
217  void fromWkbPoints( QgsWKBTypes::Type type, const QgsConstWkbPtr& wkb );
218 
219  friend class QgsPolygonV2;
220 
221 };
222 
223 #endif // QGSLINESTRINGV2_H
static unsigned index
A rectangle specified with double values.
Definition: qgsrectangle.h:35
virtual bool dropMValue()=0
Drops any measure values which exist in the geometry.
virtual bool operator==(const QgsCurveV2 &other) const =0
virtual QgsPointV2 centroid() const
Returns the centroid of the geometry.
virtual int dimension() const override
Returns the inherent dimension of the geometry.
virtual double length() const
Returns the length of the geometry.
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle...
TransformDirection
Enum used to indicate the direction (forward or inverse) of the transform.
virtual QString asJSON(int precision=17) const =0
Returns a GeoJSON representation of the geometry.
virtual void addToPainterPath(QPainterPath &path) const =0
Adds a curve to a painter path.
Abstract base class for all geometries.
virtual bool dropZValue()=0
Drops any z-dimensions which exist in the geometry.
virtual QgsCurveV2 * clone() const override=0
Clones the geometry by performing a deep copy.
virtual int wkbSize() const =0
Returns the size of the WKB representation of the geometry.
#define M_PI_2
Definition: util.cpp:45
virtual bool addMValue(double mValue=0)=0
Adds a measure to the geometry, initialized to a preset value.
virtual void clear()=0
Clears the geometry, ie reset it to a null geometry.
virtual int numPoints() const =0
Returns the number of points in the curve.
Polygon geometry type.
Definition: qgspolygonv2.h:29
virtual QgsCurveV2 * reversed() const =0
Returns a reversed copy of the curve, where the direction of the curve has been flipped.
Utility class for identifying a unique vertex within a geometry.
Line string geometry type, with support for z-dimension and m-values.
virtual QgsRectangle calculateBoundingBox() const
Default calculator for the minimal bounding box for the geometry.
virtual bool fromWkb(QgsConstWkbPtr wkb)=0
Sets the geometry from a WKB string.
Point geometry type, with support for z-dimension and m-values.
Definition: qgspointv2.h:34
virtual unsigned char * asWkb(int &binarySize) const =0
Returns a WKB representation of the geometry.
virtual bool addZValue(double zValue=0)=0
Adds a z-dimension to the geometry, initialized to a preset value.
virtual QString geometryType() const override
Returns a unique string representing the geometry type.
virtual QDomElement asGML3(QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
Returns a GML3 representation of the geometry.
virtual bool fromWkt(const QString &wkt)=0
Sets the geometry from a WKT string.
virtual bool pointAt(int node, QgsPointV2 &point, QgsVertexId::VertexType &type) const =0
Returns the point and vertex id of a point within the curve.
virtual void sumUpArea(double &sum) const =0
Calculates the area of the curve.
virtual bool convertTo(QgsWKBTypes::Type type)
Converts the geometry to a specified type.
virtual double vertexAngle(QgsVertexId vertex) const =0
Returns approximate angle at a vertex.
virtual QgsPointV2 endPoint() const =0
Returns the end point of the curve.
virtual bool deleteVertex(QgsVertexId position)=0
Deletes a vertex within the geometry.
virtual bool insertVertex(QgsVertexId position, const QgsPointV2 &vertex)=0
Inserts a vertex into the geometry.
virtual bool operator!=(const QgsCurveV2 &other) const =0
virtual QgsLineStringV2 * 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...
Class for doing transforms between two map coordinate systems.
virtual QString asWkt(int precision=17) const =0
Returns a WKT representation of the geometry.
virtual QgsPointV2 startPoint() const =0
Returns the starting point of the curve.
virtual void draw(QPainter &p) const =0
Draws the geometry using the specified QPainter.
virtual void drawAsPolygon(QPainter &p) const =0
Draws the curve as a polygon on the specified QPainter.
double ANALYSIS_EXPORT leftOf(Point3D *thepoint, Point3D *p1, Point3D *p2)
Returns whether &#39;thepoint&#39; is left or right of the line from &#39;p1&#39; to &#39;p2&#39;.
virtual QDomElement asGML2(QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
Returns a GML2 representation of the geometry.
Abstract base class for curved geometry type.
Definition: qgscurvev2.h:32
virtual bool moveVertex(QgsVertexId position, const QgsPointV2 &newPos)=0
Moves a vertex within the geometry.
virtual double closestSegment(const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon) const =0
Searches for the closest segment of the geometry to a given point.
virtual void points(QgsPointSequenceV2 &pt) const =0
Returns a list of points within the curve.
virtual void transform(const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false)=0
Transforms the geometry using a coordinate transform.
virtual int nCoordinates() const override
Returns the number of nodes contained in the geometry.
virtual QgsAbstractGeometryV2 * toCurveType() const
Returns the geometry converted to the more generic curve type.