QgsCoverageCleanParameters Class Reference

Encapsulates parameters for a coverage cleaning operation. More...

#include <qgsgeometry.h>

Public Member Functions
double	maximumGapWidth () const
	Returns the maximum gap width.
Qgis::CoverageCleanOverlapMergeStrategy	overlapMergeStrategy () const
	Returns the overlap merge strategy to use during cleaning.
void	setMaximumGapWidth (double width)
	Sets the maximum gap width.
void	setOverlapMergeStrategy (Qgis::CoverageCleanOverlapMergeStrategy strategy)
	Sets the overlap merge strategy to use during cleaning.
void	setSnappingDistance (double distance)
	Sets the snapping distance.
double	snappingDistance () const
	Returns the snapping distance.

Detailed Description

Encapsulates parameters for a coverage cleaning operation.

Since

QGIS 4.4

Definition at line 164 of file qgsgeometry.h.

Member Function Documentation

maximumGapWidth()

double QgsCoverageCleanParameters::maximumGapWidth ( ) const

inline

Returns the maximum gap width.

Gaps which are smaller than this distance are merged with an adjacent polygon.

Polygon width is determined as twice the radius of the maximum inscribed circle of the gap polygon.

Gaps are merged with the adjacent polygon depending on overlapMergeStrategy().

Empty holes in input polygons are treated as gaps, and may be filled in.

Gaps which are not fully enclosed ("inlets") are not removed.

The width of a gap is twice the radius of the Maximum Inscribed Circle in the gap polygon,

A width of zero prevents gaps from being merged.

See also

setMaximumGapWidth()

Definition at line 216 of file qgsgeometry.h.

overlapMergeStrategy()

Qgis::CoverageCleanOverlapMergeStrategy QgsCoverageCleanParameters::overlapMergeStrategy ( ) const

inline

Returns the overlap merge strategy to use during cleaning.

See also

setOverlapMergeStrategy()

Definition at line 230 of file qgsgeometry.h.

setMaximumGapWidth()

void QgsCoverageCleanParameters::setMaximumGapWidth ( double width )

inline

Sets the maximum gap width.

See also

maximumGapWidth()

Definition at line 223 of file qgsgeometry.h.

setOverlapMergeStrategy()

void QgsCoverageCleanParameters::setOverlapMergeStrategy ( Qgis::CoverageCleanOverlapMergeStrategy strategy )

inline

Sets the overlap merge strategy to use during cleaning.

See also

overlapMergeStrategy()

Definition at line 237 of file qgsgeometry.h.

setSnappingDistance()

void QgsCoverageCleanParameters::setSnappingDistance ( double distance )

inline

Sets the snapping distance.

See also

snappingDistance()

Definition at line 194 of file qgsgeometry.h.

snappingDistance()

double QgsCoverageCleanParameters::snappingDistance ( ) const

inline

Returns the snapping distance.

Snapping to nearby vertices and line segment snapping is used to improve noding robustness and eliminate small errors in an efficient way.

By default the snapping distance is -1, which means that the clean operation uses a very small snapping distance based on the extent of the input data.

The snapping distance may be specified explicitly.

This can reduce the number of overlaps and gaps that need to be merged, and reduce the risk of spikes formed by merging gaps. However, a large snapping distance may introduce undesirable data alteration.

A distance of zero prevents snapping from being used.

See also

setSnappingDistance()

Definition at line 187 of file qgsgeometry.h.

---

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

• /build/qgis-4.3.0+git20260711+58212645307+99sid/src/core/geometry/qgsgeometry.h