Class: QgsPolygon

class qgis.core.QgsPolygon

Bases: QgsCurvePolygon

Polygon geometry type.

Methods

addInteriorRing

param ring

asWkb

rtype

QByteArray

boundary

rtype

QgsAbstractGeometry

calculateBoundingBox

childCount

childGeometry

childPoint

clear

clearCache

clone

rtype

QgsPolygon

createEmptyWithSameType

rtype

QgsPolygon

fromWkb

param wkb

geometryType

rtype

str

hasChildGeometries

pointDistanceToBoundary

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

setExteriorRing

param ring

setZMTypeFromSubGeometry

surfaceToPolygon

rtype

QgsPolygon

toCurveType

Returns the geometry converted to the more generic curve type QgsCurvePolygon

addInteriorRing(self, ring: QgsCurve)
Parameters

ring (QgsCurve) –

asWkb(self) → QByteArray
Return type

QByteArray

boundary(self)QgsAbstractGeometry
Return type

QgsAbstractGeometry

calculateBoundingBox()
childCount()
childGeometry()
childPoint()
clear(self)
clearCache()
clone(self)QgsPolygon
Return type

QgsPolygon

createEmptyWithSameType(self)QgsPolygon
Return type

QgsPolygon

fromWkb(self, wkb: QgsConstWkbPtr) → bool
Parameters

wkb (QgsConstWkbPtr) –

Return type

bool

geometryType(self) → str
Return type

str

hasChildGeometries()
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

setExteriorRing(self, ring: QgsCurve)
Parameters

ring (QgsCurve) –

setZMTypeFromSubGeometry()
surfaceToPolygon(self)QgsPolygon
Return type

QgsPolygon

toCurveType(self)QgsCurvePolygon

Returns the geometry converted to the more generic curve type QgsCurvePolygon

Return type

QgsCurvePolygon

Returns

the converted geometry. Caller takes ownership*