QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
qgscircularstringv2.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgscircularstringv2.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 QGSCIRCULARSTRING_H
19 #define QGSCIRCULARSTRING_H
20 
21 #include "qgscurvev2.h"
22 #include <QVector>
23 
30 class CORE_EXPORT QgsCircularStringV2: public QgsCurveV2
31 {
32  public:
35 
36  virtual bool operator==( const QgsCurveV2& other ) const override;
37  virtual bool operator!=( const QgsCurveV2& other ) const override;
38 
39  virtual QString geometryType() const override { return "CircularString"; }
40  virtual int dimension() const override { return 1; }
41  virtual QgsCircularStringV2* clone() const override;
42  virtual void clear() override;
43 
44  virtual bool fromWkb( QgsConstWkbPtr wkb ) override;
45  virtual bool fromWkt( const QString& wkt ) override;
46 
47  int wkbSize() const override;
48  unsigned char* asWkb( int& binarySize ) const override;
49  QString asWkt( int precision = 17 ) const override;
50  QDomElement asGML2( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const override;
51  QDomElement asGML3( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const override;
52  QString asJSON( int precision = 17 ) const override;
53 
54  int numPoints() const override;
55 
58  QgsPointV2 pointN( int i ) const;
59 
63  void points( QgsPointSequenceV2 &pts ) const override;
64 
67  void setPoints( const QgsPointSequenceV2 &points );
68 
72  virtual double length() const override;
73 
77  virtual QgsPointV2 startPoint() const override;
81  virtual QgsPointV2 endPoint() const override;
86  virtual QgsLineStringV2* curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override;
87 
88  void draw( QPainter& p ) const override;
90  bool transformZ = false ) override;
91  void transform( const QTransform& t ) override;
92  void addToPainterPath( QPainterPath& path ) const override;
93 
97  void drawAsPolygon( QPainter& p ) const override;
98 
99  virtual bool insertVertex( QgsVertexId position, const QgsPointV2& vertex ) override;
100  virtual bool moveVertex( QgsVertexId position, const QgsPointV2& newPos ) override;
101  virtual bool deleteVertex( QgsVertexId position ) override;
102 
103  double closestSegment( const QgsPointV2& pt, QgsPointV2& segmentPt, QgsVertexId& vertexAfter, bool* leftOf, double epsilon ) const override;
107  bool pointAt( int node, QgsPointV2& point, QgsVertexId::VertexType& type ) const override;
108 
112  void sumUpArea( double& sum ) const override;
113 
117  bool hasCurvedSegments() const override { return true; }
118 
122  double vertexAngle( QgsVertexId vertex ) const override;
123 
124  virtual QgsCircularStringV2* reversed() const override;
125 
126  virtual bool addZValue( double zValue = 0 ) override;
127  virtual bool addMValue( double mValue = 0 ) override;
128 
129  virtual bool dropZValue() override;
130  virtual bool dropMValue() override;
131 
132  protected:
133 
134  virtual QgsRectangle calculateBoundingBox() const override;
135 
136  private:
137  QVector<double> mX;
138  QVector<double> mY;
139  QVector<double> mZ;
140  QVector<double> mM;
141 
142  //helper methods for curveToLine
143  void segmentize( const QgsPointV2& p1, const QgsPointV2& p2, const QgsPointV2& p3, QgsPointSequenceV2 &points, double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const;
144  int segmentSide( const QgsPointV2& pt1, const QgsPointV2& pt3, const QgsPointV2& pt2 ) const;
145  double interpolateArc( double angle, double a1, double a2, double a3, double zm1, double zm2, double zm3 ) const;
146  static void arcTo( QPainterPath& path, QPointF pt1, QPointF pt2, QPointF pt3 );
147  //bounding box of a single segment
148  static QgsRectangle segmentBoundingBox( const QgsPointV2& pt1, const QgsPointV2& pt2, const QgsPointV2& pt3 );
149  static QgsPointSequenceV2 compassPointsOnSegment( double p1Angle, double p2Angle, double p3Angle, double centerX, double centerY, double radius );
150  static double closestPointOnArc( double x1, double y1, double x2, double y2, double x3, double y3,
151  const QgsPointV2& pt, QgsPointV2& segmentPt, QgsVertexId& vertexAfter, bool* leftOf, double epsilon );
152  void insertVertexBetween( int after, int before, int pointOnCircle );
153  void deleteVertex( int i );
154 
155 };
156 
157 #endif // QGSCIRCULARSTRING_H
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
Circular string geometry type.
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.
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.
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 bool fromWkb(QgsConstWkbPtr wkb)=0
Sets the geometry from a WKB string.
QgsCurveV2 * segmentize(double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override
Returns a geometry without curves.
Definition: qgscurvev2.cpp:98
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 QDomElement asGML3(QDomDocument &doc, int precision=17, const QString &ns="gml") const =0
Returns a GML3 representation of the geometry.
virtual QString geometryType() const override
Returns a unique string representing the geometry type.
virtual bool fromWkt(const QString &wkt)=0
Sets the geometry from a WKT string.
double ANALYSIS_EXPORT angle(Point3D *p1, Point3D *p2, Point3D *p3, Point3D *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
virtual bool pointAt(int node, QgsPointV2 &point, QgsVertexId::VertexType &type) const =0
Returns the point and vertex id of a point within the curve.
bool hasCurvedSegments() const override
Returns true if the geometry contains curved segments.
virtual void sumUpArea(double &sum) const =0
Sums up the area of the curve by iterating over the vertices (shoelace formula).
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 int dimension() const override
Returns the inherent dimension of 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...
virtual double length() const
Returns the length of the geometry.
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 QgsRectangle calculateBoundingBox() const
Default calculator for the minimal bounding box for the geometry.
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.