Curve polygon geometry type. More...

#include <qgscurvepolygon.h>

Inheritance diagram for QgsCurvePolygon:

[legend]

Public Member Functions
	QgsCurvePolygon ()

	QgsCurvePolygon (const QgsCurvePolygon &p)

	~QgsCurvePolygon () override

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

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

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

QgsCurvePolygon *	clone () const override
	Clones the geometry by performing a deep copy. 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...

QgsCurvePolygon *	createEmptyWithSameType () const override
	Creates a new geometry with the same class and same WKB type as the original and transfers ownership. 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...

const QgsCurve *	exteriorRing () 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	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	fromWkb (QgsConstWkbPtr &wkb) override
	Sets the geometry from a WKB string. More...

bool	fromWkt (const QString &wkt) override
	Sets the geometry from a WKT string. More...

QString	geometryType () const override SIP_HOLDGIL
	Returns a unique string representing the geometry type. 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 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...

int	numInteriorRings () const SIP_HOLDGIL
	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 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...

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

virtual void	setExteriorRing (QgsCurve *ring)
	Sets the exterior ring of the polygon. 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...

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

void	swapXy () override
	Swaps the x and y coordinates from the geometry. More...

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

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

int	wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
	Returns the length of the QByteArray returned by asWkb() More...

Public Member Functions inherited from QgsSurface
QgsRectangle	boundingBox () const override
	Returns the minimal bounding box for the geometry. More...

bool	isValid (QString &error, int flags=0) 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...

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

QgsAbstractGeometry &	operator= (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...

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

Static Public Member Functions inherited from QgsSurface
static const QgsSurface *	cast (const QgsAbstractGeometry *geom)
	Cast the geom to a QgsSurface. More...

Protected Member Functions
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
std::unique_ptr< QgsCurve >	mExteriorRing

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

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

Detailed Description

Curve polygon geometry type.

Since: QGIS 2.10

Definition at line 34 of file qgscurvepolygon.h.

Constructor & Destructor Documentation

◆ QgsCurvePolygon() [1/2]

QgsCurvePolygon::QgsCurvePolygon ( )

Definition at line 36 of file qgscurvepolygon.cpp.

◆ QgsCurvePolygon() [2/2]

QgsCurvePolygon::QgsCurvePolygon ( const QgsCurvePolygon & p )

Definition at line 63 of file qgscurvepolygon.cpp.

◆ ~QgsCurvePolygon()

QgsCurvePolygon::~QgsCurvePolygon ( )

override

Definition at line 41 of file qgscurvepolygon.cpp.

Member Function Documentation

◆ addInteriorRing()

void QgsCurvePolygon::addInteriorRing ( QgsCurve * ring )

virtual

Adds an interior ring to the geometry (takes ownership)

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 682 of file qgscurvepolygon.cpp.

◆ addMValue()

bool QgsCurvePolygon::addMValue ( double mValue = 0 )

overridevirtual

Adds a measure to the geometry, initialized to a preset value.

Parameters

mValue initial m-value for all nodes

Returns: true on success

See also: dropMValue(); addZValue()

Since: QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 1203 of file qgscurvepolygon.cpp.

◆ addZValue()

bool QgsCurvePolygon::addZValue ( double zValue = 0 )

overridevirtual

Adds a z-dimension to the geometry, initialized to a preset value.

Parameters

zValue initial z-value for all nodes

Returns: true on success

See also: dropZValue(); addMValue()

Since: QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 1186 of file qgscurvepolygon.cpp.

◆ adjacentVertices()

void QgsCurvePolygon::adjacentVertices	(	QgsVertexId	vertex,
		QgsVertexId &	previousVertex,
		QgsVertexId &	nextVertex
	)		const

overridevirtual

Returns the vertices adjacent to a specified vertex within a geometry.

Since: QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 1011 of file qgscurvepolygon.cpp.

◆ area()

double QgsCurvePolygon::area ( ) const

overridevirtual

Returns the planar, 2-dimensional area of the geometry.

Warning: QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the area returned by this method is calculated using strictly Cartesian mathematics. In contrast, the QgsDistanceArea class exposes methods for calculating the areas of geometries using geodesic calculations which account for the curvature of the Earth (or any other celestial body).

See also: length(); perimeter()

Reimplemented from QgsAbstractGeometry.

Definition at line 467 of file qgscurvepolygon.cpp.

◆ asGml2()

QDomElement QgsCurvePolygon::asGml2	(	QDomDocument &	doc,
		int	precision = `17`,
		const QString &	ns = `"gml"`,
		QgsAbstractGeometry::AxisOrder	axisOrder = `QgsAbstractGeometry::AxisOrder::XY`
	)		const

overridevirtual

Returns a GML2 representation of the geometry.

Parameters

doc	DOM document
precision	number of decimal places for coordinates
ns	XML namespace
axisOrder	Axis order for generated GML

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

Implements QgsAbstractGeometry.

Definition at line 363 of file qgscurvepolygon.cpp.

◆ asGml3()

QDomElement QgsCurvePolygon::asGml3	(	QDomDocument &	doc,
		int	precision = `17`,
		const QString &	ns = `"gml"`,
		QgsAbstractGeometry::AxisOrder	axisOrder = `QgsAbstractGeometry::AxisOrder::XY`
	)		const

overridevirtual

Returns a GML3 representation of the geometry.

Parameters

doc	DOM document
precision	number of decimal places for coordinates
ns	XML namespace
axisOrder	Axis order for generated GML

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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle.

Definition at line 390 of file qgscurvepolygon.cpp.

◆ asJsonObject()

json QgsCurvePolygon::asJsonObject ( int precision = 17 ) const

overridevirtual

Returns a json object representation of the geometry.

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

Note: not available in Python bindings

Since: QGIS 3.10

Reimplemented from QgsAbstractGeometry.

Definition at line 420 of file qgscurvepolygon.cpp.

◆ asKml()

QString QgsCurvePolygon::asKml ( int precision = 17 ) const

overridevirtual

Returns a KML representation of the geometry.

Since: QGIS 3.12

Implements QgsAbstractGeometry.

Definition at line 446 of file qgscurvepolygon.cpp.

◆ asQPainterPath()

QPainterPath QgsCurvePolygon::asQPainterPath ( ) const

overridevirtual

Returns the geometry represented as a QPainterPath.

Warning: not all geometry subclasses can be represented by a QPainterPath, e.g. points and multipoint geometries will return an empty path.

Since: QGIS 3.16

Implements QgsAbstractGeometry.

Definition at line 777 of file qgscurvepolygon.cpp.

◆ asWkb()

QByteArray QgsCurvePolygon::asWkb ( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const

override

Definition at line 306 of file qgscurvepolygon.cpp.

◆ asWkt()

QString QgsCurvePolygon::asWkt ( int precision = 17 ) const

overridevirtual

Returns a WKT representation of the geometry.

Parameters

precision number of decimal places for coordinates

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

Implements QgsAbstractGeometry.

Definition at line 325 of file qgscurvepolygon.cpp.

◆ boundary()

QgsAbstractGeometry * QgsCurvePolygon::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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 527 of file qgscurvepolygon.cpp.

◆ calculateBoundingBox()

QgsRectangle QgsCurvePolygon::calculateBoundingBox ( ) const

overrideprotectedvirtual

Default calculator for the minimal bounding box for the geometry.

Derived classes should override this method if a more efficient bounding box calculation is available.

Reimplemented from QgsAbstractGeometry.

Definition at line 283 of file qgscurvepolygon.cpp.

◆ cast()

static const QgsCurvePolygon* QgsCurvePolygon::cast ( const QgsAbstractGeometry * geom )

inlinestatic

Cast the geom to a QgsCurvePolygon.

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

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

Since: QGIS 3.0

Definition at line 277 of file qgscurvepolygon.h.

◆ childCount()

int QgsCurvePolygon::childCount ( ) const

overrideprotectedvirtual

Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e.

curve / point)

Note: used for vertex_iterator implementation

Since: QGIS 3.0

Reimplemented from QgsAbstractGeometry.

Definition at line 1321 of file qgscurvepolygon.cpp.

◆ childGeometry()

QgsAbstractGeometry * QgsCurvePolygon::childGeometry ( int index ) const

overrideprotectedvirtual

Returns pointer to child geometry (for geometries with child geometries - i.e.

geom. collection / polygon)

Note: used for vertex_iterator implementation

Since: QGIS 3.0

Reimplemented from QgsAbstractGeometry.

Definition at line 1326 of file qgscurvepolygon.cpp.

◆ clear()

void QgsCurvePolygon::clear ( )

overridevirtual

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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 145 of file qgscurvepolygon.cpp.

◆ clone()

QgsCurvePolygon * QgsCurvePolygon::clone ( ) const

overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 140 of file qgscurvepolygon.cpp.

◆ closestSegment()

double QgsCurvePolygon::closestSegment	(	const QgsPoint &	pt,
		QgsPoint &	segmentPt,
		QgsVertexId &	vertexAfter,
		int *	leftOf = `nullptr`,
		double	epsilon = `4 *std::numeric_limits< double >::epsilon()`
	)		const

overridevirtual

Searches for the closest segment of the geometry to a given point.

Parameters

pt	specifies the point to find closest segment to
segmentPt	storage for the closest point within the geometry
vertexAfter	storage for the ID of the vertex at the end of the closest segment
leftOf	indicates whether the point lies on the left side of the geometry (-1 if point is to the left of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not be determined, e.g. point exactly on a line) `false` if point is to right of segment)
epsilon	epsilon for segment snapping

Returns: squared distance to closest segment or negative value on error

Implements QgsAbstractGeometry.

Definition at line 927 of file qgscurvepolygon.cpp.

◆ coordinateSequence()

QgsCoordinateSequence QgsCurvePolygon::coordinateSequence ( ) const

overridevirtual

Retrieves the sequence of geometries, rings and nodes.

Returns: coordinate sequence

Implements QgsAbstractGeometry.

Definition at line 847 of file qgscurvepolygon.cpp.

◆ createEmptyWithSameType()

QgsCurvePolygon * QgsCurvePolygon::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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 46 of file qgscurvepolygon.cpp.

◆ deleteVertex()

bool QgsCurvePolygon::deleteVertex ( QgsVertexId position )

overridevirtual

Deletes a vertex within the geometry.

Parameters

position vertex id for vertex to delete

Returns: true if delete was successful

See also: insertVertex; moveVertex

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle.

Definition at line 1078 of file qgscurvepolygon.cpp.

◆ dimension()

int QgsCurvePolygon::dimension ( ) const

overridevirtual

Returns the inherent dimension of the geometry.

For example, this is 0 for a point geometry, 1 for a linestring and 2 for a polygon.

Implements QgsAbstractGeometry.

Definition at line 58 of file qgscurvepolygon.cpp.

◆ draw()

void QgsCurvePolygon::draw ( QPainter & p ) const

overridevirtual

Draws the geometry using the specified QPainter.

Parameters

p	destination QPainter

Implements QgsAbstractGeometry.

Definition at line 797 of file qgscurvepolygon.cpp.

◆ dropMValue()

bool QgsCurvePolygon::dropMValue ( )

overridevirtual

Drops any measure values which exist in the geometry.

Returns: true if m-values were present and have been removed

See also: addMValue(); dropZValue()

Since: QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 1236 of file qgscurvepolygon.cpp.

◆ dropZValue()

bool QgsCurvePolygon::dropZValue ( )

overridevirtual

Drops any z-dimensions which exist in the geometry.

Returns: true if Z values were present and have been removed

See also: addZValue(); dropMValue()

Since: QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 1220 of file qgscurvepolygon.cpp.

◆ exteriorRing()

const QgsCurve* QgsCurvePolygon::exteriorRing ( ) const

inline

Returns the curve polygon's exterior ring.

See also: interiorRing()

Definition at line 87 of file qgscurvepolygon.h.

◆ filterVertices()

void QgsCurvePolygon::filterVertices ( const std::function< bool(const QgsPoint &) > & filter )

overridevirtual

Filters the vertices from the geometry in place, removing any which do not return true for the filter function check.

Has no meaning when called on a single point geometry.

Depending on the filter used, this may result in an invalid geometry.

Note: Not available in Python bindings

Since: QGIS 3.2

Reimplemented from QgsAbstractGeometry.

Definition at line 1297 of file qgscurvepolygon.cpp.

◆ forceRHR()

void QgsCurvePolygon::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.

In particular, the exterior ring is oriented in a clockwise direction and the interior rings in a counter-clockwise direction.

Since: QGIS 3.6

Definition at line 750 of file qgscurvepolygon.cpp.

◆ fromWkb()

bool QgsCurvePolygon::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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 155 of file qgscurvepolygon.cpp.

◆ fromWkt()

bool QgsCurvePolygon::fromWkt ( const QString & wkt )

overridevirtual

Sets the geometry from a WKT string.

See also: fromWkb

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle.

Definition at line 208 of file qgscurvepolygon.cpp.

◆ geometryType()

QString QgsCurvePolygon::geometryType ( ) const

overridevirtual

Returns a unique string representing the geometry type.

See also: wkbType; wktTypeStr

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 53 of file qgscurvepolygon.cpp.

◆ hasCurvedSegments()

bool QgsCurvePolygon::hasCurvedSegments ( ) const

overridevirtual

Returns true if the geometry contains curved segments.

Reimplemented from QgsAbstractGeometry.

Definition at line 1121 of file qgscurvepolygon.cpp.

◆ insertVertex()

bool QgsCurvePolygon::insertVertex	(	QgsVertexId	position,
		const QgsPoint &	vertex
	)

overridevirtual

Inserts a vertex into the geometry.

Parameters

position	vertex id for position of inserted vertex
vertex	vertex to insert

Returns: true if insert was successful

See also: moveVertex; deleteVertex

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle.

Definition at line 1030 of file qgscurvepolygon.cpp.

◆ interiorRing()

const QgsCurve* QgsCurvePolygon::interiorRing ( int i ) const

inline

Retrieves an interior ring from the curve polygon.

The first interior ring has index 0.

See also: numInteriorRings(); exteriorRing()

Definition at line 100 of file qgscurvepolygon.h.

◆ isEmpty()

bool QgsCurvePolygon::isEmpty ( ) const

overridevirtual

Returns true if the geometry is empty.

Reimplemented from QgsAbstractGeometry.

Definition at line 919 of file qgscurvepolygon.cpp.

◆ moveVertex()

bool QgsCurvePolygon::moveVertex	(	QgsVertexId	position,
		const QgsPoint &	newPos
	)

overridevirtual

Moves a vertex within the geometry.

Parameters

position	vertex id for vertex to move
newPos	new position of vertex

Returns: true if move was successful

See also: insertVertex; deleteVertex

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle.

Definition at line 1056 of file qgscurvepolygon.cpp.

◆ nCoordinates()

int QgsCurvePolygon::nCoordinates ( ) const

overridevirtual

Returns the number of nodes contained in the geometry.

Reimplemented from QgsAbstractGeometry.

Definition at line 867 of file qgscurvepolygon.cpp.

◆ nextVertex()

bool QgsCurvePolygon::nextVertex	(	QgsVertexId &	id,
		QgsPoint &	vertex
	)		const

overridevirtual

Returns next vertex id and coordinates.

Parameters

id	initial value should be the starting vertex id. The next vertex id will be stored in this variable if found.
vertex	container for found node

Returns: false if at end

Implements QgsAbstractGeometry.

Definition at line 939 of file qgscurvepolygon.cpp.

◆ numInteriorRings()

int QgsCurvePolygon::numInteriorRings ( ) const

inline

Returns the number of interior rings contained with the curve polygon.

See also: interiorRing()

Definition at line 77 of file qgscurvepolygon.h.

◆ operator!=()

bool QgsCurvePolygon::operator!= ( const QgsAbstractGeometry & other ) const

overridevirtual

Implements QgsAbstractGeometry.

Definition at line 135 of file qgscurvepolygon.cpp.

◆ operator=()

QgsCurvePolygon & QgsCurvePolygon::operator= ( const QgsCurvePolygon & p )

Definition at line 79 of file qgscurvepolygon.cpp.

◆ operator==()

bool QgsCurvePolygon::operator== ( const QgsAbstractGeometry & other ) const

overridevirtual

Implements QgsAbstractGeometry.

Definition at line 98 of file qgscurvepolygon.cpp.

◆ partCount()

int QgsCurvePolygon::partCount ( ) const

overridevirtual

Returns count of parts contained in the geometry.

See also: vertexCount; ringCount

Implements QgsAbstractGeometry.

Definition at line 1165 of file qgscurvepolygon.cpp.

◆ perimeter()

double QgsCurvePolygon::perimeter ( ) const

overridevirtual

Returns the planar, 2-dimensional perimeter of the geometry.

Warning: QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the perimeter returned by this method is calculated using strictly Cartesian mathematics. In contrast, the QgsDistanceArea class exposes methods for calculating the perimeters of geometries using geodesic calculations which account for the curvature of the Earth (or any other celestial body).

See also: area(); length()

Reimplemented from QgsAbstractGeometry.

Definition at line 495 of file qgscurvepolygon.cpp.

◆ removeDuplicateNodes()

bool QgsCurvePolygon::removeDuplicateNodes	(	double	epsilon = `4 *std::numeric_limits< double >::epsilon()`,
		bool	useZValues = `false`
	)

overridevirtual

Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry.

The epsilon parameter specifies the tolerance for coordinates when determining that vertices are identical.

By default, z values are not considered when detecting duplicate nodes. E.g. two nodes with the same x and y coordinate but different z values will still be considered duplicate and one will be removed. If useZValues is true, then the z values are also tested and nodes with the same x and y but different z will be maintained.

Note that duplicate nodes are not tested between different parts of a multipart geometry. E.g. a multipoint geometry with overlapping points will not be changed by this method.

The function will return true if nodes were removed, or false if no duplicate nodes were found.

Since: QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 584 of file qgscurvepolygon.cpp.

◆ removeInteriorRing()

bool QgsCurvePolygon::removeInteriorRing ( int ringIndex )

Removes an interior ring from the polygon.

The first interior ring has index 0. The corresponding ring is removed from the polygon and deleted. If a ring was successfully removed the function will return true. It is not possible to remove the exterior ring using this method.

See also: removeInteriorRings()

Definition at line 702 of file qgscurvepolygon.cpp.

◆ removeInteriorRings()

void QgsCurvePolygon::removeInteriorRings ( double minimumAllowedArea = -1 )

Removes the interior rings from the polygon.

If the minimumAllowedArea parameter is specified then only rings smaller than this minimum area will be removed.

See also: removeInteriorRing()

Since: QGIS 3.0

Definition at line 713 of file qgscurvepolygon.cpp.

◆ removeInvalidRings()

void QgsCurvePolygon::removeInvalidRings ( )

Removes any interior rings which are not valid from the polygon.

For example, this removes unclosed rings and rings with less than 4 vertices.

Since: QGIS 3.0

Definition at line 731 of file qgscurvepolygon.cpp.

◆ ringCount()

int QgsCurvePolygon::ringCount ( int part = 0 ) const

overridevirtual

Returns the number of rings of which this geometry is built.

Implements QgsAbstractGeometry.

Definition at line 1160 of file qgscurvepolygon.cpp.

◆ segmentize()

QgsAbstractGeometry * QgsCurvePolygon::segmentize	(	double	tolerance = `M_PI_2 / 90`,
		SegmentationToleranceType	toleranceType = `MaximumAngle`
	)		const

overridevirtual

Returns a geometry without curves.

Caller takes ownership

Parameters

tolerance	segmentation tolerance
toleranceType	maximum segmentation angle or maximum difference between approximation and curve

Reimplemented from QgsAbstractGeometry.

Definition at line 1138 of file qgscurvepolygon.cpp.

◆ segmentLength()

double QgsCurvePolygon::segmentLength ( QgsVertexId startVertex ) const

overridevirtual

Returns the length of the segment of the geometry which begins at startVertex.

Warning: QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the lengths returned by this method are calculated using strictly Cartesian mathematics.

Since: QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 1175 of file qgscurvepolygon.cpp.

◆ setExteriorRing()

void QgsCurvePolygon::setExteriorRing ( QgsCurve * ring )

virtual

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 in QgsTriangle, and QgsPolygon.

Definition at line 635 of file qgscurvepolygon.cpp.

◆ setInteriorRings()

void QgsCurvePolygon::setInteriorRings ( const QVector< QgsCurve * > & rings )

Sets all interior rings (takes ownership)

Definition at line 669 of file qgscurvepolygon.cpp.

◆ snappedToGrid()

QgsCurvePolygon * QgsCurvePolygon::snappedToGrid	(	double	hSpacing,
		double	vSpacing,
		double	dSpacing = `0`,
		double	mSpacing = `0`
	)		const

overridevirtual

Makes a new geometry with all the points or vertices snapped to the closest point of the grid.

Ownership is transferred to the caller.

If the gridified geometry could not be calculated nullptr will be returned. It may generate an invalid geometry (in some corner cases). It can also be thought as rounding the edges and it may be useful for removing errors.

Example:

geometry.snappedToGrid(1, 1)

In this case we use a 2D grid of 1x1 to gridify. In this case, it can be thought like rounding the x and y of all the points/vertices to full units (remove all decimals).

Parameters

hSpacing	Horizontal spacing of the grid (x axis). 0 to disable.
vSpacing	Vertical spacing of the grid (y axis). 0 to disable.
dSpacing	Depth spacing of the grid (z axis). 0 (default) to disable.
mSpacing	Custom dimension spacing of the grid (m axis). 0 (default) to disable.

Since: 3.0

Implements QgsAbstractGeometry.

Definition at line 550 of file qgscurvepolygon.cpp.

◆ surfaceToPolygon()

QgsPolygon * QgsCurvePolygon::surfaceToPolygon ( ) const

overridevirtual

Gets a polygon representation of this surface.

Ownership is transferred to the caller.

Implements QgsSurface.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 509 of file qgscurvepolygon.cpp.

◆ swapXy()

void QgsCurvePolygon::swapXy ( )

overridevirtual

Swaps the x and y coordinates from the geometry.

This can be used to repair geometries which have accidentally had their latitude and longitude coordinates reversed.

Since: QGIS 3.2

Implements QgsAbstractGeometry.

Definition at line 1252 of file qgscurvepolygon.cpp.

◆ toCurveType()

QgsCurvePolygon * QgsCurvePolygon::toCurveType ( ) const

overridevirtual

Returns the geometry converted to the more generic curve type.

E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface

Returns: the converted geometry. Caller takes ownership

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangle, and QgsPolygon.

Definition at line 1263 of file qgscurvepolygon.cpp.

◆ toPolygon()

QgsPolygon * QgsCurvePolygon::toPolygon	(	double	tolerance = `M_PI_2 / 90`,
		SegmentationToleranceType	toleranceType = `MaximumAngle`
	)		const

virtual

Returns a new polygon geometry corresponding to a segmentized approximation of the curve.

Parameters

tolerance	segmentation tolerance
toleranceType	maximum segmentation angle or maximum difference between approximation and curve

Definition at line 615 of file qgscurvepolygon.cpp.

◆ transform() [1/3]

void QgsCurvePolygon::transform	(	const QgsCoordinateTransform &	ct,
		QgsCoordinateTransform::TransformDirection	d = `QgsCoordinateTransform::ForwardTransform`,
		bool	transformZ = `false`
	)

overridevirtual

Transforms the geometry using a coordinate transform.

Parameters

ct	coordinate transform
d	transformation direction
transformZ	set to `true` to also transform z coordinates. This requires that the z coordinates in the geometry represent height relative to the vertical datum of the source CRS (generally ellipsoidal heights) and are expressed in its vertical units (generally meters). If `false`, then z coordinates will not be changed by the transform.

Implements QgsAbstractGeometry.

Definition at line 819 of file qgscurvepolygon.cpp.

◆ transform() [2/3]

void QgsCurvePolygon::transform	(	const QTransform &	t,
		double	zTranslate = `0.0`,
		double	zScale = `1.0`,
		double	mTranslate = `0.0`,
		double	mScale = `1.0`
	)

overridevirtual

Transforms the x and y components of the geometry using a QTransform object t.

Optionally, the geometry's z values can be scaled via zScale and translated via zTranslate. Similarly, m-values can be scaled via mScale and translated via mTranslate.

Implements QgsAbstractGeometry.

Definition at line 833 of file qgscurvepolygon.cpp.

◆ transform() [3/3]

bool QgsCurvePolygon::transform	(	QgsAbstractGeometryTransformer *	transformer,
		QgsFeedback *	feedback = `nullptr`
	)

overridevirtual

Transforms the vertices from the geometry in place, using the specified geometry transformer object.

Depending on the transformer used, this may result in an invalid geometry.

The optional feedback argument can be used to cancel the transformation before it completes. If this is done, the geometry will be left in a semi-transformed state.

Returns: true if the geometry was successfully transformed.

Since: QGIS 3.18

Implements QgsAbstractGeometry.

Definition at line 1268 of file qgscurvepolygon.cpp.

◆ transformVertices()

void QgsCurvePolygon::transformVertices ( const std::function< QgsPoint(const QgsPoint &) > & transform )

overridevirtual

Transforms the vertices from the geometry in place, applying the transform function to every vertex.

Depending on the transform used, this may result in an invalid geometry.

Transform functions are not permitted to alter the dimensionality of vertices. If a transform which adds (or removes) z/m values is desired, first call the corresponding addZValue() or addMValue() function to change the geometry's dimensionality and then transform.

Note: Not available in Python bindings

Since: QGIS 3.4

Reimplemented from QgsAbstractGeometry.

Definition at line 1309 of file qgscurvepolygon.cpp.

◆ vertexAngle()

double QgsCurvePolygon::vertexAngle ( QgsVertexId vertex ) const

overridevirtual

Returns approximate rotation angle for a vertex.

Usually average angle between adjacent segments.

Parameters

vertex the vertex id

Returns: rotation in radians, clockwise from north

Implements QgsAbstractGeometry.

Definition at line 1143 of file qgscurvepolygon.cpp.

◆ vertexAt()

QgsPoint QgsCurvePolygon::vertexAt ( QgsVertexId id ) const

overridevirtual

Returns the point corresponding to a specified vertex id.

Implements QgsAbstractGeometry.

Definition at line 1170 of file qgscurvepolygon.cpp.

◆ vertexCount()

int QgsCurvePolygon::vertexCount	(	int	part = `0`,
		int	ring = `0`
	)		const

overridevirtual

Returns the number of vertices of which this geometry is built.

Implements QgsAbstractGeometry.

Definition at line 1155 of file qgscurvepolygon.cpp.

◆ vertexNumberFromVertexId()

int QgsCurvePolygon::vertexNumberFromVertexId ( QgsVertexId id ) const

overridevirtual

Returns the vertex number corresponding to a vertex id.

The vertex numbers start at 0, so a return value of 0 corresponds to the first vertex.

Returns -1 if a corresponding vertex could not be found.

Since: QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 884 of file qgscurvepolygon.cpp.

◆ wkbSize()

int QgsCurvePolygon::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

Implements QgsAbstractGeometry.

Reimplemented in QgsPolygon.

Definition at line 292 of file qgscurvepolygon.cpp.

Member Data Documentation

◆ mExteriorRing

std::unique_ptr< QgsCurve > QgsCurvePolygon::mExteriorRing

protected

Definition at line 311 of file qgscurvepolygon.h.

◆ mInteriorRings

QVector<QgsCurve *> QgsCurvePolygon::mInteriorRings

protected

Definition at line 312 of file qgscurvepolygon.h.

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

/build/qgis-3.18.1+99unstable/src/core/geometry/qgscurvepolygon.h
/build/qgis-3.18.1+99unstable/src/core/geometry/qgscurvepolygon.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsCurvePolygon() [1/2]

◆ QgsCurvePolygon() [2/2]

◆ ~QgsCurvePolygon()

Member Function Documentation

◆ addInteriorRing()

◆ addMValue()

◆ addZValue()

◆ adjacentVertices()

◆ area()

◆ asGml2()

◆ asGml3()

◆ asJsonObject()

◆ asKml()

◆ asQPainterPath()

◆ asWkb()

◆ asWkt()

◆ boundary()

◆ calculateBoundingBox()

◆ cast()

◆ childCount()

◆ childGeometry()

◆ clear()

◆ clone()

◆ closestSegment()

◆ coordinateSequence()

◆ createEmptyWithSameType()

◆ deleteVertex()

◆ dimension()

◆ draw()

◆ dropMValue()

◆ dropZValue()

◆ exteriorRing()

◆ filterVertices()

◆ forceRHR()

◆ fromWkb()

◆ fromWkt()

◆ geometryType()

◆ hasCurvedSegments()

◆ insertVertex()

◆ interiorRing()

◆ isEmpty()

◆ moveVertex()

◆ nCoordinates()

◆ nextVertex()

◆ numInteriorRings()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ partCount()

◆ perimeter()

◆ removeDuplicateNodes()

◆ removeInteriorRing()

◆ removeInteriorRings()

◆ removeInvalidRings()

◆ ringCount()

◆ segmentize()

◆ segmentLength()

◆ setExteriorRing()

◆ setInteriorRings()

◆ snappedToGrid()

◆ surfaceToPolygon()

◆ swapXy()

◆ toCurveType()

◆ toPolygon()

◆ transform() [1/3]

◆ transform() [2/3]

◆ transform() [3/3]

◆ transformVertices()

◆ vertexAngle()

◆ vertexAt()

◆ vertexCount()

◆ vertexNumberFromVertexId()

◆ wkbSize()