QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgscompoundcurve.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgscompoundcurve.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 QGSCOMPOUNDCURVE_H
19 #define QGSCOMPOUNDCURVE_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgscurve.h"
24 
31 class CORE_EXPORT QgsCompoundCurve: public QgsCurve
32 {
33  public:
35  QgsCompoundCurve( const QgsCompoundCurve &curve );
37  ~QgsCompoundCurve() override;
38 
39  bool equals( const QgsCurve &other ) const override;
40 
41  QString geometryType() const override SIP_HOLDGIL;
42  int dimension() const override SIP_HOLDGIL;
43  QgsCompoundCurve *clone() const override SIP_FACTORY;
44  void clear() override;
45 
46  bool fromWkb( QgsConstWkbPtr &wkb ) override;
47  bool fromWkt( const QString &wkt ) override;
48 
49  int wkbSize( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const override;
50  QByteArray asWkb( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const override;
51  QString asWkt( int precision = 17 ) const override;
52  QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
53  QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
54  json asJsonObject( int precision = 17 ) const override SIP_SKIP;
55 
56  //curve interface
57  double length() const override SIP_HOLDGIL;
58  QgsPoint startPoint() const override SIP_HOLDGIL;
59  QgsPoint endPoint() const override SIP_HOLDGIL;
60  void points( QgsPointSequence &pts SIP_OUT ) const override;
61  int numPoints() const override SIP_HOLDGIL;
62  bool isEmpty() const override SIP_HOLDGIL;
63 
70  QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
71 
72  QgsCompoundCurve *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const override SIP_FACTORY;
73  bool removeDuplicateNodes( double epsilon = 4 * std::numeric_limits<double>::epsilon(), bool useZValues = false ) override;
74 
78  int nCurves() const SIP_HOLDGIL { return mCurves.size(); }
79 
83  const QgsCurve *curveAt( int i ) const SIP_HOLDGIL;
84 
88  void addCurve( QgsCurve *c SIP_TRANSFER );
89 
94  void removeCurve( int i );
95 
99  void addVertex( const QgsPoint &pt );
100 
101  void draw( QPainter &p ) const override;
103  void transform( const QTransform &t, double zTranslate = 0.0, double zScale = 1.0, double mTranslate = 0.0, double mScale = 1.0 ) override;
104  void addToPainterPath( QPainterPath &path ) const override;
105  void drawAsPolygon( QPainter &p ) const override;
106  bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
107  bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
108  bool deleteVertex( QgsVertexId position ) override;
109  double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = 4 * std::numeric_limits<double>::epsilon() ) const override;
110  bool pointAt( int node, QgsPoint &point, QgsVertexId::VertexType &type ) const override;
111  void sumUpArea( double &sum SIP_OUT ) const override;
112 
114  void close();
115 
116  bool hasCurvedSegments() const override;
117  double vertexAngle( QgsVertexId vertex ) const override;
118  double segmentLength( QgsVertexId startVertex ) const override;
119  QgsCompoundCurve *reversed() const override SIP_FACTORY;
120  QgsPoint *interpolatePoint( double distance ) const override SIP_FACTORY;
121  QgsCompoundCurve *curveSubstring( double startDistance, double endDistance ) const override SIP_FACTORY;
122 
123  bool addZValue( double zValue = 0 ) override;
124  bool addMValue( double mValue = 0 ) override;
125 
126  bool dropZValue() override;
127  bool dropMValue() override;
128  void swapXy() override;
129 
130  double xAt( int index ) const override SIP_HOLDGIL;
131  double yAt( int index ) const override SIP_HOLDGIL;
132 
133 #ifndef SIP_RUN
134  void filterVertices( const std::function< bool( const QgsPoint & ) > &filter ) override;
135  void transformVertices( const std::function< QgsPoint( const QgsPoint & ) > &transform ) override;
136 
144  inline const QgsCompoundCurve *cast( const QgsAbstractGeometry *geom ) const
145  {
146  if ( geom && QgsWkbTypes::flatType( geom->wkbType() ) == QgsWkbTypes::CompoundCurve )
147  return static_cast<const QgsCompoundCurve *>( geom );
148  return nullptr;
149  }
150 #endif
151 
153 
154 #ifdef SIP_RUN
155  SIP_PYOBJECT __repr__();
156  % MethodCode
157  QString wkt = sipCpp->asWkt();
158  if ( wkt.length() > 1000 )
159  wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
160  QString str = QStringLiteral( "<QgsCompoundCurve: %1>" ).arg( wkt );
161  sipRes = PyUnicode_FromString( str.toUtf8().constData() );
162  % End
163 #endif
164 
165  protected:
166 
167  QgsRectangle calculateBoundingBox() const override;
168 
169  private:
170  QVector< QgsCurve * > mCurves;
171 
176  QVector< QPair<int, QgsVertexId> > curveVertexId( QgsVertexId id ) const;
177 
178 };
179 
180 // clazy:excludeall=qstring-allocations
181 
182 #endif // QGSCOMPOUNDCURVE_H
QgsCurve
Abstract base class for curved geometry type.
Definition: qgscurve.h:36
QgsAbstractGeometry::removeDuplicateNodes
virtual bool removeDuplicateNodes(double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false)=0
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerat...
QgsAbstractGeometry::fromWkt
virtual bool fromWkt(const QString &wkt)=0
Sets the geometry from a WKT string.
QgsCurve::startPoint
virtual QgsPoint startPoint() const =0
Returns the starting point of the curve.
QgsAbstractGeometry::asWkb
virtual QByteArray asWkb(WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
Returns a WKB representation of the geometry.
QgsPoint
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:38
QgsAbstractGeometry::snappedToGrid
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.
QgsAbstractGeometry::wkbSize
virtual int wkbSize(QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
Returns the length of the QByteArray returned by asWkb()
SIP_OUT
#define SIP_OUT
Definition: qgis_sip.h:58
QgsCompoundCurve::nCurves
int nCurves() const SIP_HOLDGIL
Returns the number of curves in the geometry.
Definition: qgscompoundcurve.h:78
QgsWkbTypes::flatType
static Type flatType(Type type) SIP_HOLDGIL
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:702
QgsAbstractGeometry::filterVertices
virtual void filterVertices(const std::function< bool(const QgsPoint &) > &filter)
Filters the vertices from the geometry in place, removing any which do not return true for the filter...
Definition: qgsabstractgeometry.cpp:250
QgsCoordinateTransform::TransformDirection
TransformDirection
Enum used to indicate the direction (forward or inverse) of the transform.
Definition: qgscoordinatetransform.h:59
QgsAbstractGeometry::asWkt
virtual QString asWkt(int precision=17) const =0
Returns a WKT representation of the geometry.
QgsAbstractGeometry::length
virtual double length() const
Returns the planar, 2-dimensional length of the geometry.
Definition: qgsabstractgeometry.cpp:132
QgsAbstractGeometry::SegmentationToleranceType
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle.
Definition: qgsabstractgeometry.h:115
QgsLineString
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:44
closestSegment
double closestSegment(const QgsPolylineXY &pl, const QgsPointXY &pt, int &vertexAfter, double epsilon)
Definition: qgstracer.cpp:68
QgsRectangle
A rectangle specified with double values.
Definition: qgsrectangle.h:42
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
MathUtils::leftOf
double ANALYSIS_EXPORT leftOf(const QgsPoint &thepoint, const QgsPoint *p1, const QgsPoint *p2)
Returns whether 'thepoint' is left or right of the line from 'p1' to 'p2'. Negative values mean left ...
Definition: MathUtils.cpp:292
precision
int precision
Definition: qgswfsgetfeature.cpp:49
QgsAbstractGeometry::dimension
virtual int dimension() const =0
Returns the inherent dimension of the geometry.
QgsCsException
Custom exception class for Coordinate Reference System related exceptions.
Definition: qgsexception.h:66
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
SIP_HOLDGIL
#define SIP_HOLDGIL
Definition: qgis_sip.h:157
SIP_THROW
#define SIP_THROW(name)
Definition: qgis_sip.h:189
QgsAbstractGeometry::wkbType
QgsWkbTypes::Type wkbType() const SIP_HOLDGIL
Returns the WKB type of the geometry.
Definition: qgsabstractgeometry.h:193
QgsCurve::endPoint
virtual QgsPoint endPoint() const =0
Returns the end point of the curve.
QgsAbstractGeometry::AxisOrder
AxisOrder
Axis order for GML generation.
Definition: qgsabstractgeometry.h:133
QgsAbstractGeometry::asJsonObject
virtual json asJsonObject(int precision=17) const
Returns a json object representation of the geometry.
Definition: qgsabstractgeometry.cpp:162
QgsConstWkbPtr
Definition: qgswkbptr.h:128
QgsCurve::equals
virtual bool equals(const QgsCurve &other) const =0
Checks whether this curve exactly equals another curve.
qgis_sip.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QgsAbstractGeometry::clear
virtual void clear()=0
Clears the geometry, ie reset it to a null geometry.
QgsAbstractGeometry::isEmpty
virtual bool isEmpty() const
Returns true if the geometry is empty.
Definition: qgsabstractgeometry.cpp:298
QgsAbstractGeometry::fromWkb
virtual bool fromWkb(QgsConstWkbPtr &wkb)=0
Sets the geometry from a WKB string.
QgsCompoundCurve::cast
const QgsCompoundCurve * cast(const QgsAbstractGeometry *geom) const
Cast the geom to a QgsCompoundCurve.
Definition: qgscompoundcurve.h:144
QgsAbstractGeometry
Abstract base class for all geometries.
Definition: qgsabstractgeometry.h:74
QgsCoordinateTransform::ForwardTransform
@ ForwardTransform
Transform from source to destination CRS.
Definition: qgscoordinatetransform.h:60
QgsAbstractGeometry::geometryType
virtual QString geometryType() const =0
Returns a unique string representing the geometry type.
QgsCurve::clone
QgsCurve * clone() const override=0
Clones the geometry by performing a deep copy.
QgsAbstractGeometry::createEmptyWithSameType
virtual QgsAbstractGeometry * createEmptyWithSameType() const =0
Creates a new geometry with the same class and same WKB type as the original and transfers ownership.
QgsAbstractGeometry::asGml3
virtual QDomElement asGml3(QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0
Returns a GML3 representation of the geometry.
QgsAbstractGeometry::operator=
QgsAbstractGeometry & operator=(const QgsAbstractGeometry &geom)
Definition: qgsabstractgeometry.cpp:33
QgsPointSequence
QVector< QgsPoint > QgsPointSequence
Definition: qgsabstractgeometry.h:46
qgscurve.h
c
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
Definition: porting_processing.dox:1
QgsAbstractGeometry::draw
virtual void draw(QPainter &p) const =0
Draws the geometry using the specified QPainter.
QgsVertexId
Utility class for identifying a unique vertex within a geometry.
Definition: qgsabstractgeometry.h:1059
QgsAbstractGeometry::transformVertices
virtual void transformVertices(const std::function< QgsPoint(const QgsPoint &) > &transform)
Transforms the vertices from the geometry in place, applying the transform function to every vertex.
Definition: qgsabstractgeometry.cpp:255
QgsCurve::points
virtual void points(QgsPointSequence &pt) const =0
Returns a list of points within the curve.
QgsCurve::numPoints
virtual int numPoints() const =0
Returns the number of points in the curve.
QgsCoordinateTransform
Class for doing transforms between two map coordinate systems.
Definition: qgscoordinatetransform.h:53
QgsAbstractGeometry::transform
virtual void transform(const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false) SIP_THROW(QgsCsException)=0
Transforms the geometry using a coordinate transform.
QgsCurve::curveToLine
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.
QgsAbstractGeometry::asGml2
virtual QDomElement asGml2(QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0
Returns a GML2 representation of the geometry.
QgsCompoundCurve
Compound curve geometry type.
Definition: qgscompoundcurve.h:32
QgsWkbTypes::CompoundCurve
@ CompoundCurve
Definition: qgswkbtypes.h:81
QgsAbstractGeometry::calculateBoundingBox
virtual QgsRectangle calculateBoundingBox() const
Default calculator for the minimal bounding box for the geometry.
Definition: qgsabstractgeometry.cpp:85