QGIS API Documentation  3.24.2-Tisler (13c1a02865)
Public Member Functions | Static Public Member Functions | Friends | List of all members
QgsPolygon Class Reference

Polygon geometry type. More...

#include <qgspolygon.h>

Inheritance diagram for QgsPolygon:
Inheritance graph
[legend]

Public Member Functions

 QgsPolygon () SIP_HOLDGIL
 Constructor for an empty polygon geometry. More...
 
 QgsPolygon (QgsLineString *exterior, const QList< QgsLineString * > &rings=QList< QgsLineString * >()) SIP_HOLDGIL
 Constructor for QgsPolygon, with the specified exterior ring and interior rings. More...
 
void addInteriorRing (QgsCurve *ring) override
 Adds an interior ring to the geometry (takes ownership) More...
 
QByteArray asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 
QgsAbstractGeometryboundary () const override
 Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More...
 
void clear () override
 Clears the geometry, ie reset it to a null geometry. More...
 
QgsPolygonclone () const override
 Clones the geometry by performing a deep copy. More...
 
QgsPolygoncreateEmptyWithSameType () const override
 Creates a new geometry with the same class and same WKB type as the original and transfers ownership. More...
 
bool fromWkb (QgsConstWkbPtr &wkb) override
 Sets the geometry from a WKB string. More...
 
QString geometryType () const override SIP_HOLDGIL
 Returns a unique string representing the geometry type. More...
 
double pointDistanceToBoundary (double x, double y) const
 Returns the distance from a point to the boundary of the polygon (either the exterior ring or any closer interior rings). More...
 
void setExteriorRing (QgsCurve *ring) override
 Sets the exterior ring of the polygon. More...
 
QgsPolygonsurfaceToPolygon () const override
 Gets a polygon representation of this surface. More...
 
QgsCurvePolygontoCurveType () const override
 Returns the geometry converted to the more generic curve type QgsCurvePolygon. More...
 
int wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 Returns the length of the QByteArray returned by asWkb() More...
 
- Public Member Functions inherited from QgsCurvePolygon
 QgsCurvePolygon ()
 
 QgsCurvePolygon (const QgsCurvePolygon &p)
 
 ~QgsCurvePolygon () override
 
bool addMValue (double mValue=0) override
 Adds a measure to the geometry, initialized to a preset value. More...
 
bool addZValue (double zValue=0) override
 Adds a z-dimension to the geometry, initialized to a preset value. More...
 
void adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override
 Returns the vertices adjacent to a specified vertex within a geometry. More...
 
double area () const override SIP_HOLDGIL
 Returns the planar, 2-dimensional area of the geometry. More...
 
QDomElement asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
 Returns a GML2 representation of the geometry. More...
 
QDomElement asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
 Returns a GML3 representation of the geometry. More...
 
json asJsonObject (int precision=17) const override
 Returns a json object representation of the geometry. More...
 
QString asKml (int precision=17) const override
 Returns a KML representation of the geometry. More...
 
QPainterPath asQPainterPath () const override
 Returns the geometry represented as a QPainterPath. More...
 
QByteArray asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 
QString asWkt (int precision=17) const override
 Returns a WKT representation of the geometry. More...
 
bool boundingBoxIntersects (const QgsRectangle &rectangle) const override SIP_HOLDGIL
 Returns true if the bounding box of this geometry intersects with a rectangle. More...
 
double closestSegment (const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *std::numeric_limits< double >::epsilon()) const override
 Searches for the closest segment of the geometry to a given point. More...
 
QgsCoordinateSequence coordinateSequence () const override
 Retrieves the sequence of geometries, rings and nodes. More...
 
bool deleteVertex (QgsVertexId position) override
 Deletes a vertex within the geometry. More...
 
int dimension () const override SIP_HOLDGIL
 Returns the inherent dimension of the geometry. More...
 
void draw (QPainter &p) const override
 Draws the geometry using the specified QPainter. More...
 
bool dropMValue () override
 Drops any measure values which exist in the geometry. More...
 
bool dropZValue () override
 Drops any z-dimensions which exist in the geometry. More...
 
QgsCurveexteriorRing ()
 Returns a non-const pointer to the curve polygon's exterior ring. More...
 
const QgsCurveexteriorRing () const SIP_HOLDGIL
 Returns the curve polygon's exterior ring. More...
 
void filterVertices (const std::function< bool(const QgsPoint &) > &filter) override
 Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. More...
 
void forceClockwise ()
 Forces the polygon to respect the exterior ring is clockwise, interior rings are counter-clockwise convention. More...
 
void forceCounterClockwise ()
 Forces the polygon to respect the exterior ring is counter-clockwise, interior rings are clockwise convention. More...
 
void forceRHR ()
 Forces the geometry to respect the Right-Hand-Rule, in which the area that is bounded by the polygon is to the right of the boundary. More...
 
bool fromWkt (const QString &wkt) override
 Sets the geometry from a WKT string. More...
 
bool hasCurvedSegments () const override
 Returns true if the geometry contains curved segments. More...
 
bool insertVertex (QgsVertexId position, const QgsPoint &vertex) override
 Inserts a vertex into the geometry. More...
 
QgsCurveinteriorRing (int i)
 Retrieves an interior ring from the curve polygon. More...
 
const QgsCurveinteriorRing (int i) const SIP_HOLDGIL
 Retrieves an interior ring from the curve polygon. More...
 
bool isEmpty () const override SIP_HOLDGIL
 Returns true if the geometry is empty. More...
 
bool moveVertex (QgsVertexId position, const QgsPoint &newPos) override
 Moves a vertex within the geometry. More...
 
int nCoordinates () const override
 Returns the number of nodes contained in the geometry. More...
 
bool nextVertex (QgsVertexId &id, QgsPoint &vertex) const override
 Returns next vertex id and coordinates. More...
 
void normalize () final SIP_HOLDGIL
 Reorganizes the geometry into a normalized form (or "canonical" form). More...
 
int numInteriorRings () const SIP_HOLDGIL
 Returns the number of interior rings contained with the curve polygon. More...
 
bool operator!= (const QgsAbstractGeometry &other) const override
 
QgsCurvePolygonoperator= (const QgsCurvePolygon &p)
 
bool operator== (const QgsAbstractGeometry &other) const override
 
int partCount () const override SIP_HOLDGIL
 Returns count of parts contained in the geometry. More...
 
double perimeter () const override SIP_HOLDGIL
 Returns the planar, 2-dimensional perimeter of the geometry. More...
 
bool removeDuplicateNodes (double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false) override
 Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry. More...
 
bool removeInteriorRing (int ringIndex)
 Removes an interior ring from the polygon. More...
 
void removeInteriorRings (double minimumAllowedArea=-1)
 Removes the interior rings from the polygon. More...
 
void removeInvalidRings ()
 Removes any interior rings which are not valid from the polygon. More...
 
int ringCount (int part=0) const override SIP_HOLDGIL
 Returns the number of rings of which this geometry is built. More...
 
double roundness () const
 Returns the roundness of the curve polygon. More...
 
QgsAbstractGeometrysegmentize (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override
 Returns a geometry without curves. More...
 
double segmentLength (QgsVertexId startVertex) const override
 Returns the length of the segment of the geometry which begins at startVertex. More...
 
void setInteriorRings (const QVector< QgsCurve * > &rings)
 Sets all interior rings (takes ownership) More...
 
QgsCurvePolygonsnappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0) const override
 Makes a new geometry with all the points or vertices snapped to the closest point of the grid. More...
 
void swapXy () override
 Swaps the x and y coordinates from the geometry. More...
 
virtual QgsPolygontoPolygon (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const
 Returns a new polygon geometry corresponding to a segmentized approximation of the curve. More...
 
void transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) override SIP_THROW(QgsCsException)
 Transforms the geometry using a coordinate transform. More...
 
void transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0) override
 Transforms the x and y components of the geometry using a QTransform object t. More...
 
bool transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr) override
 Transforms the vertices from the geometry in place, using the specified geometry transformer object. More...
 
void transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform) override
 Transforms the vertices from the geometry in place, applying the transform function to every vertex. More...
 
double vertexAngle (QgsVertexId vertex) const override
 Returns approximate rotation angle for a vertex. More...
 
QgsPoint vertexAt (QgsVertexId id) const override
 Returns the point corresponding to a specified vertex id. More...
 
int vertexCount (int part=0, int ring=0) const override
 Returns the number of vertices of which this geometry is built. More...
 
int vertexNumberFromVertexId (QgsVertexId id) const override
 Returns the vertex number corresponding to a vertex id. More...
 
- Public Member Functions inherited from QgsSurface
QgsRectangle boundingBox () const override
 Returns the minimal bounding box for the geometry. More...
 
bool isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override
 Checks validity of the geometry, and returns true if the geometry is valid. More...
 
- Public Member Functions inherited from QgsAbstractGeometry
 QgsAbstractGeometry ()=default
 Constructor for QgsAbstractGeometry. More...
 
 QgsAbstractGeometry (const QgsAbstractGeometry &geom)
 
virtual ~QgsAbstractGeometry ()=default
 
QString asJson (int precision=17)
 Returns a GeoJSON representation of the geometry as a QString. More...
 
virtual QByteArray asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
 Returns a WKB representation of the geometry. More...
 
virtual QgsPoint centroid () const
 Returns the centroid of the geometry. More...
 
virtual int compareTo (const QgsAbstractGeometry *other) const
 Comparator for sorting of geometry. More...
 
const_part_iterator const_parts_begin () const
 Returns STL-style iterator pointing to the const first part of the geometry. More...
 
const_part_iterator const_parts_end () const
 Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry. More...
 
virtual bool convertTo (QgsWkbTypes::Type type)
 Converts the geometry to a specified type. More...
 
bool is3D () const SIP_HOLDGIL
 Returns true if the geometry is 3D and contains a z-value. More...
 
bool isMeasure () const SIP_HOLDGIL
 Returns true if the geometry contains m values. More...
 
virtual double length () const
 Returns the planar, 2-dimensional length of the geometry. More...
 
QgsAbstractGeometryoperator= (const QgsAbstractGeometry &geom)
 
QgsGeometryPartIterator parts ()
 Returns Java-style iterator for traversal of parts of the geometry. More...
 
QgsGeometryConstPartIterator parts () const
 Returns Java-style iterator for traversal of parts of the geometry. More...
 
part_iterator parts_begin ()
 Returns STL-style iterator pointing to the first part of the geometry. More...
 
part_iterator parts_end ()
 Returns STL-style iterator pointing to the imaginary part after the last part of the geometry. More...
 
virtual const QgsAbstractGeometrysimplifiedTypeRef () const SIP_HOLDGIL
 Returns a reference to the simplest lossless representation of this geometry, e.g. More...
 
QgsVertexIterator vertices () const
 Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings. More...
 
vertex_iterator vertices_begin () const
 Returns STL-style iterator pointing to the first vertex of the geometry. More...
 
vertex_iterator vertices_end () const
 Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. More...
 
QgsWkbTypes::Type wkbType () const SIP_HOLDGIL
 Returns the WKB type of the geometry. More...
 
QString wktTypeStr () const
 Returns the WKT type string of the geometry. More...
 

Static Public Member Functions

static const QgsPolygoncast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsPolygonV2. More...
 
- Static Public Member Functions inherited from QgsCurvePolygon
static const QgsCurvePolygoncast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsCurvePolygon. More...
 
- Static Public Member Functions inherited from QgsSurface
static const QgsSurfacecast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsSurface. More...
 

Friends

class QgsCurvePolygon
 

Additional Inherited Members

- Public Types inherited from QgsAbstractGeometry
enum  AxisOrder { XY = 0 , YX }
 Axis order for GML generation. More...
 
enum  SegmentationToleranceType { MaximumAngle = 0 , MaximumDifference }
 Segmentation tolerance as maximum angle or maximum difference between approximation and circle. More...
 
enum  WkbFlag { FlagExportTrianglesAsPolygons = 1 << 0 }
 WKB export flags. More...
 
- Protected Member Functions inherited from QgsCurvePolygon
QgsRectangle calculateBoundingBox () const override
 Default calculator for the minimal bounding box for the geometry. More...
 
int childCount () const override
 Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. More...
 
QgsAbstractGeometrychildGeometry (int index) const override
 Returns pointer to child geometry (for geometries with child geometries - i.e. More...
 
int compareToSameClass (const QgsAbstractGeometry *other) const final
 Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries. More...
 
- Protected Member Functions inherited from QgsSurface
void clearCache () const override
 Clears any cached parameters associated with the geometry, e.g., bounding boxes. More...
 
- Protected Member Functions inherited from QgsAbstractGeometry
virtual QgsPoint childPoint (int index) const
 Returns point at index (for geometries without child geometries - i.e. More...
 
virtual bool hasChildGeometries () const
 Returns whether the geometry has any child geometries (false for point / curve, true otherwise) More...
 
void setZMTypeFromSubGeometry (const QgsAbstractGeometry *subggeom, QgsWkbTypes::Type baseGeomType)
 Updates the geometry type based on whether sub geometries contain z or m values. More...
 
int sortIndex () const
 Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types. More...
 
- Protected Attributes inherited from QgsCurvePolygon
std::unique_ptr< QgsCurvemExteriorRing
 
QVector< QgsCurve * > mInteriorRings
 
- Protected Attributes inherited from QgsSurface
QgsRectangle mBoundingBox
 
bool mHasCachedValidity = false
 
QString mValidityFailureReason
 
- Protected Attributes inherited from QgsAbstractGeometry
QgsWkbTypes::Type mWkbType = QgsWkbTypes::Unknown
 

Detailed Description

Polygon geometry type.

Since
QGIS 2.10

Definition at line 33 of file qgspolygon.h.

Constructor & Destructor Documentation

◆ QgsPolygon() [1/2]

QgsPolygon::QgsPolygon ( )

Constructor for an empty polygon geometry.

Definition at line 25 of file qgspolygon.cpp.

◆ QgsPolygon() [2/2]

QgsPolygon::QgsPolygon ( QgsLineString exterior,
const QList< QgsLineString * > &  rings = QList< QgsLineString * >() 
)

Constructor for QgsPolygon, with the specified exterior ring and interior rings.

Ownership of exterior and rings is transferred to the polygon.

Since
QGIS 3.14

Member Function Documentation

◆ addInteriorRing()

void QgsPolygon::addInteriorRing ( QgsCurve ring)
overridevirtual

Adds an interior ring to the geometry (takes ownership)

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 188 of file qgspolygon.cpp.

◆ asWkb()

QByteArray QgsPolygon::asWkb ( QgsAbstractGeometry::WkbFlags  flags = QgsAbstractGeometry::WkbFlags()) const
override

Definition at line 141 of file qgspolygon.cpp.

◆ boundary()

QgsAbstractGeometry * QgsPolygon::boundary ( ) const
overridevirtual

Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).

For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.

Returns
boundary for geometry. May be nullptr for some geometry types.
Since
QGIS 3.0

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 254 of file qgspolygon.cpp.

◆ cast()

static const QgsPolygon* QgsPolygon::cast ( const QgsAbstractGeometry geom)
inlinestatic

Cast the geom to a QgsPolygonV2.

Should be used by qgsgeometry_cast<QgsPolygon *>( geometry ).

Note
Not available in Python. Objects will be automatically be converted to the appropriate target type.
Since
QGIS 3.0

Definition at line 89 of file qgspolygon.h.

◆ clear()

void QgsPolygon::clear ( )
overridevirtual

Clears the geometry, ie reset it to a null geometry.

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 59 of file qgspolygon.cpp.

◆ clone()

QgsPolygon * QgsPolygon::clone ( ) const
overridevirtual

Clones the geometry by performing a deep copy.

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 54 of file qgspolygon.cpp.

◆ createEmptyWithSameType()

QgsPolygon * QgsPolygon::createEmptyWithSameType ( ) const
overridevirtual

Creates a new geometry with the same class and same WKB type as the original and transfers ownership.

To create it, the geometry is default constructed and then the WKB is changed.

See also
clone()
Since
3.0

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 47 of file qgspolygon.cpp.

◆ fromWkb()

bool QgsPolygon::fromWkb ( QgsConstWkbPtr wkb)
overridevirtual

Sets the geometry from a WKB string.

After successful read the wkb argument will be at the position where the reading has stopped.

See also
fromWkt

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 65 of file qgspolygon.cpp.

◆ geometryType()

QString QgsPolygon::geometryType ( ) const
overridevirtual

Returns a unique string representing the geometry type.

See also
wkbType
wktTypeStr

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 42 of file qgspolygon.cpp.

◆ pointDistanceToBoundary()

double QgsPolygon::pointDistanceToBoundary ( double  x,
double  y 
) const

Returns the distance from a point to the boundary of the polygon (either the exterior ring or any closer interior rings).

The returned distance will be negative if the point lies outside the polygon.

Since
QGIS 3.0

Definition at line 277 of file qgspolygon.cpp.

◆ setExteriorRing()

void QgsPolygon::setExteriorRing ( QgsCurve ring)
overridevirtual

Sets the exterior ring of the polygon.

The CurvePolygon type will be updated to match the dimensionality of the exterior ring. For instance, setting a 2D exterior ring on a 3D CurvePolygon will drop the z dimension from the CurvePolygon and all interior rings.

Parameters
ringnew exterior ring. Ownership is transferred to the CurvePolygon.
See also
setInteriorRings()
exteriorRing()

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 219 of file qgspolygon.cpp.

◆ surfaceToPolygon()

QgsPolygon * QgsPolygon::surfaceToPolygon ( ) const
overridevirtual

Gets a polygon representation of this surface.

Ownership is transferred to the caller.

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 311 of file qgspolygon.cpp.

◆ toCurveType()

QgsCurvePolygon * QgsPolygon::toCurveType ( ) const
overridevirtual

Returns the geometry converted to the more generic curve type QgsCurvePolygon.

Returns
the converted geometry. Caller takes ownership

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 316 of file qgspolygon.cpp.

◆ wkbSize()

int QgsPolygon::wkbSize ( QgsAbstractGeometry::WkbFlags  flags = QgsAbstractGeometry::WkbFlags()) const
overridevirtual

Returns the length of the QByteArray returned by asWkb()

The optional flags argument specifies flags controlling WKB export behavior

Since
QGIS 3.16

Reimplemented from QgsCurvePolygon.

Definition at line 124 of file qgspolygon.cpp.

Friends And Related Function Documentation

◆ QgsCurvePolygon

friend class QgsCurvePolygon
friend

Definition at line 118 of file qgspolygon.h.


The documentation for this class was generated from the following files: