Class: QgsPolygon¶
- class qgis.core.QgsPolygon¶
Bases:
QgsCurvePolygon
Constructor for an empty polygon geometry.
QgsPolygon(exterior:
QgsLineString
, rings: Iterable[QgsLineString] = []) Constructor forQgsPolygon
, with the specifiedexterior
ring and interiorrings
.Ownership of
exterior
andrings
is transferred to the polygon.New in version 3.14.
QgsPolygon(
QgsPolygon
)Polygon geometry type.
Methods
- param ring
- param flags
- rtype
QgsAbstractGeometry
Returns point at index (for geometries without child geometries - i.e. curve / point).
- rtype
QgsPolygon
- rtype
QgsPolygon
- param wkb
- rtype
str
Returns whether the geometry has any child geometries (
False
for point / curve,True
otherwise)Returns the distance from a point to the boundary of the polygon (either the exterior ring or any closer interior rings).
- param ring
Updates the geometry type based on whether sub geometries contain z or m values.
- rtype
QgsPolygon
Returns the geometry converted to the more generic curve type
QgsCurvePolygon
- param flags
- asWkb(self, flags: Union[QgsAbstractGeometry.WkbFlags, QgsAbstractGeometry.WkbFlag] = QgsAbstractGeometry.WkbFlags()) → QByteArray¶
- Parameters
flags (Union[QgsAbstractGeometry.WkbFlags) –
- Return type
QByteArray
- boundary(self) → QgsAbstractGeometry¶
- Return type
- calculateBoundingBox(self) → QgsRectangle¶
- childCount(self) → int¶
- childGeometry(self, index: int) → QgsAbstractGeometry¶
- childPoint(self, index: int) → QgsPoint¶
Returns point at index (for geometries without child geometries - i.e. curve / point)
Note
used for vertex_iterator implementation
New in version 3.0.
- clear(self)¶
- clearCache(self)¶
- clone(self) → QgsPolygon¶
- Return type
- createEmptyWithSameType(self) → QgsPolygon¶
- Return type
- fromWkb(self, wkb: QgsConstWkbPtr) → bool¶
- Parameters
wkb (QgsConstWkbPtr) –
- Return type
bool
- geometryType(self) → str¶
- Return type
str
- hasChildGeometries(self) → bool¶
Returns whether the geometry has any child geometries (
False
for point / curve,True
otherwise)Note
used for vertex_iterator implementation
New in version 3.0.
- pointDistanceToBoundary(self, x: float, y: float) → float¶
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.
New in version 3.0.
- Parameters
x (float) –
y (float) –
- Return type
float
- setZMTypeFromSubGeometry(self, subggeom: QgsAbstractGeometry, baseGeomType: QgsWkbTypes.Type)¶
Updates the geometry type based on whether sub geometries contain z or m values.
- surfaceToPolygon(self) → QgsPolygon¶
- Return type
- toCurveType(self) → QgsCurvePolygon¶
Returns the geometry converted to the more generic curve type
QgsCurvePolygon
- Return type
- Returns
the converted geometry. Caller takes ownership
- wkbSize(self, flags: Union[QgsAbstractGeometry.WkbFlags, QgsAbstractGeometry.WkbFlag] = QgsAbstractGeometry.WkbFlags()) → int¶
- Parameters
flags (Union[QgsAbstractGeometry.WkbFlags) –
- Return type
int