Polygon geometry type. More...

#include <qgspolygon.h>

Inheritance diagram for QgsPolygon:

Public Member Functions
	QgsPolygon ()

void	addInteriorRing (QgsCurve *ring) override
	Adds an interior ring to the geometry (takes ownership) More...

QByteArray	asWkb () const override
	Returns a WKB representation of the geometry. More...

QgsAbstractGeometry *	boundary () const override
	Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More...

const QgsPolygon *	cast (const QgsAbstractGeometry *geom) const
	Cast the geom to a QgsPolygonV2. More...

void	clear () override
	Clears the geometry, ie reset it to a null geometry. More...

QgsPolygon *	clone () const override
	Clones the geometry by performing a deep copy. More...

QgsPolygon *	createEmptyWithSameType () 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
	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...

QgsPolygon *	surfaceToPolygon () const override
	Gets a polygon representation of this surface. More...

QgsCurvePolygon *	toCurveType () const override
	Returns the geometry converted to the more generic curve type QgsCurvePolygon. 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
	Returns the 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...

QString	asJson (int precision=17) const override
	Returns a GeoJSON representation of the geometry. More...

QString	asWkt (int precision=17) const override
	Returns a WKT representation of the geometry. More...

const QgsCurvePolygon *	cast (const QgsAbstractGeometry *geom) const
	Cast the geom to a QgsCurvePolygon. 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
	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...

const QgsCurve *	exteriorRing () const
	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	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...

const QgsCurve *	interiorRing (int i) const
	Retrieves an interior ring from the curve polygon. More...

bool	isEmpty () const override
	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...

int	numInteriorRings () const
	Returns the number of interior rings contained with the curve polygon. More...

bool	operator!= (const QgsAbstractGeometry &other) const override

QgsCurvePolygon &	operator= (const QgsCurvePolygon &p)

bool	operator== (const QgsAbstractGeometry &other) const override

int	partCount () const override
	Returns count of parts contained in the geometry. More...

double	perimeter () const override
	Returns the 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
	Returns the number of rings of which this geometry is built. More...

QgsAbstractGeometry *	segmentize (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...

QgsCurvePolygon *	snappedToGrid (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 QgsPolygon *	toPolygon (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, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, 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...

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...

const QgsSurface *	cast (const QgsAbstractGeometry *geom) const
	Cast the geom to a QgsSurface. More...

Public Member Functions inherited from QgsAbstractGeometry
	QgsAbstractGeometry ()=default
	Constructor for QgsAbstractGeometry. More...

	QgsAbstractGeometry (const QgsAbstractGeometry &geom)

virtual	~QgsAbstractGeometry ()=default

virtual QgsPoint	centroid () const
	Returns the centroid of the 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
	Returns true if the geometry is 3D and contains a z-value. More...

bool	isMeasure () const
	Returns true if the geometry contains m values. More...

virtual double	length () const
	Returns the length of the geometry. More...

QgsAbstractGeometry &	operator= (const QgsAbstractGeometry &geom)

QgsGeometryConstPartIterator	parts () const
	Returns Java-style iterator for traversal of parts of the geometry. More...

QgsGeometryPartIterator	parts ()
	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...

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
	Returns the WKB type of the geometry. More...

QString	wktTypeStr () const
	Returns the WKT type string of the geometry. 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...

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...

QgsAbstractGeometry *	childGeometry (int index) const override
	Returns pointer to child geometry (for geometries with child geometries - i.e. 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...

Protected Attributes inherited from QgsCurvePolygon
std::unique_ptr< QgsCurve >	mExteriorRing

QVector< QgsCurve * >	mInteriorRings

Protected Attributes inherited from QgsSurface
QgsRectangle	mBoundingBox

Protected Attributes inherited from QgsAbstractGeometry
QgsWkbTypes::Type	mWkbType = QgsWkbTypes::Unknown

Detailed Description

Polygon geometry type.

Since: QGIS 2.10

Definition at line 31 of file qgspolygon.h.

Constructor & Destructor Documentation

QgsPolygon::QgsPolygon ( )

Definition at line 25 of file qgspolygon.cpp.

Member Function Documentation

void QgsPolygon::addInteriorRing ( QgsCurve * ring )

overridevirtual

Adds an interior ring to the geometry (takes ownership)

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 148 of file qgspolygon.cpp.

QByteArray QgsPolygon::asWkb ( ) const

overridevirtual

Returns a WKB representation of the geometry.

See also: asWkt; asGml2; asGml3; asJson()

Since: QGIS 3.0

Reimplemented from QgsCurvePolygon.

Definition at line 112 of file qgspolygon.cpp.

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 null for some geometry types.

Since: QGIS 3.0

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 214 of file qgspolygon.cpp.

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

inline

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 71 of file qgspolygon.h.

void QgsPolygon::clear ( )

overridevirtual

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

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 47 of file qgspolygon.cpp.

QgsPolygon * QgsPolygon::clone ( ) const

overridevirtual

Clones the geometry by performing a deep copy.

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 42 of file qgspolygon.cpp.

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 35 of file qgspolygon.cpp.

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 53 of file qgspolygon.cpp.

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 30 of file qgspolygon.cpp.

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 236 of file qgspolygon.cpp.

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

ring	new exterior ring. Ownership is transferred to the CurvePolygon.

See also: setInteriorRings(); exteriorRing()

Reimplemented from QgsCurvePolygon.

Reimplemented in QgsTriangle.

Definition at line 179 of file qgspolygon.cpp.

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 270 of file qgspolygon.cpp.

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 275 of file qgspolygon.cpp.

Friends And Related Function Documentation

friend class QgsCurvePolygon

friend

Definition at line 100 of file qgspolygon.h.

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

/build/qgis-3.4.15+24xenial/src/core/geometry/qgspolygon.h
/build/qgis-3.4.15+24xenial/src/core/geometry/qgspolygon.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation