QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgsregularpolygon.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsregularpolygon.h
3  --------------
4  begin : May 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 *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17
18 #ifndef QGSREGULARPOLYGON_H
19 #define QGSREGULARPOLYGON_H
20
21 #include <QString>
22
23 #include "qgis_core.h"
24 #include "qgspoint.h"
25 #include "qgspolygon.h"
26 #include "qgslinestring.h"
27 #include "qgscircle.h"
28 #include "qgstriangle.h"
29
30
41 class CORE_EXPORT QgsRegularPolygon
42 {
43  public:
44
50  {
51  InscribedCircle, //<! Inscribed in a circle (the radius is the distance between the center and vertices)
52  CircumscribedCircle //<! Circumscribed about a circle (the radius is the distance from the center to the midpoints of the sides)
53  };
54
58  QgsRegularPolygon() = default;
59
68  QgsRegularPolygon( const QgsPoint &center, double radius, double azimuth, unsigned int numberSides, ConstructionOption circle );
69
77  QgsRegularPolygon( const QgsPoint &center, const QgsPoint &pt1, unsigned int numberSides, ConstructionOption circle );
78
85  QgsRegularPolygon( const QgsPoint &pt1, const QgsPoint &pt2, unsigned int numberSides );
86
87  bool operator ==( const QgsRegularPolygon &rp ) const;
88  bool operator !=( const QgsRegularPolygon &rp ) const;
89
91  bool isEmpty() const;
92
97  QgsPoint center() const { return mCenter; }
98
106
111  QgsPoint firstVertex() const { return mFirstVertex; }
112
118  double apothem() const { return mRadius * std::cos( M_PI / mNumberSides ); }
119
124  unsigned int numberSides() const { return mNumberSides; }
125
131  void setCenter( const QgsPoint &center );
132
139
145  void setFirstVertex( const QgsPoint &firstVertex );
146
152  void setNumberSides( unsigned int numberSides );
153
157  QgsPointSequence points() const;
158
163
167  QgsLineString *toLineString() const SIP_FACTORY;
168
173  QgsTriangle toTriangle() const;
174
179  QVector<QgsTriangle> triangulate() const;
180
184  QgsCircle inscribedCircle() const;
185
189  QgsCircle circumscribedCircle() const;
190
195  QString toString( int pointPrecision = 17, int radiusPrecision = 17, int anglePrecision = 2 ) const;
196
200  double interiorAngle() const;
201
205  double centralAngle() const;
206
211  double area() const;
212
217  double perimeter() const;
218
223  double length() const;
224
225  private:
226  QgsPoint mCenter;
227  QgsPoint mFirstVertex;
228  unsigned int mNumberSides = 0;
230
234  double apothemToRadius( double apothem, unsigned int numberSides ) const;
235
239  double interiorAngle( unsigned int nbSides ) const;
240
244  double centralAngle( unsigned int nbSides ) const;
245
246 };
247
248 #endif // QGSREGULARPOLYGON_H
qgspolygon.h
QgsCircle
Circle geometry type.
Definition: qgscircle.h:43
Definition: qgsregularpolygon.h:105
QgsPolygon
Polygon geometry type.
Definition: qgspolygon.h:33
qgslinestring.h
operator==
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
Definition: qgsfeatureiterator.h:399
QgsPoint
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
QgsRegularPolygon::numberSides
unsigned int numberSides() const
Returns the number of sides of the regular polygon.
Definition: qgsregularpolygon.h:124
QgsRegularPolygon::center
QgsPoint center() const
Returns the center point of the regular polygon.
Definition: qgsregularpolygon.h:97
QgsRegularPolygon::InscribedCircle
@ InscribedCircle
Definition: qgsregularpolygon.h:51
qgspoint.h
QgsLineString
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:43
operator!=
bool operator!=(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
Definition: qgsfeatureiterator.h:404
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsMeshUtils::toPolygon
CORE_EXPORT std::unique_ptr< QgsPolygon > toPolygon(const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
Returns face as polygon geometry, caller is responsible for delete.
Definition: qgstriangularmesh.cpp:509
qgscircle.h
qgstriangle.h
QgsRegularPolygon::ConstructionOption
ConstructionOption
A regular polygon can be constructed inscribed in a circle or circumscribed about a circle.
Definition: qgsregularpolygon.h:49
circle
This document describes what qgis_wms supports does not support use feature geometry circle
Definition: sld_capabilities.txt:21
QgsPointSequence
QVector< QgsPoint > QgsPointSequence
Definition: qgsabstractgeometry.h:44
QgsRegularPolygon
Regular Polygon geometry type.
Definition: qgsregularpolygon.h:41
QgsRegularPolygon::apothem
double apothem() const
Returns the apothem of the regular polygon.
Definition: qgsregularpolygon.h:118
QgsTriangle
Triangle geometry type.
Definition: qgstriangle.h:33
QgsRegularPolygon::firstVertex
QgsPoint firstVertex() const
Returns the first vertex (corner) of the regular polygon.
Definition: qgsregularpolygon.h:111