QgsVectorLayerEditUtils Class Reference

Contains utility functions for editing vector layers. More...

#include <qgsvectorlayereditutils.h>

Public Member Functions
	QgsVectorLayerEditUtils (QgsVectorLayer *layer)
Qgis::GeometryOperationResult	addPart (const QgsPointSequence &ring, QgsFeatureId featureId)
	Adds a new part polygon to a multipart feature.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult	addPart (const QVector< QgsPointXY > &ring, QgsFeatureId featureId)
	Adds a new part polygon to a multipart feature.
Qgis::GeometryOperationResult	addPart (QgsCurve *ring, QgsFeatureId featureId)
	Adds a new part polygon to a multipart feature.
Qgis::GeometryOperationResult	addRing (const QgsPointSequence &ring, const QgsFeatureIds &targetFeatureIds=QgsFeatureIds(), QgsFeatureId *modifiedFeatureId=nullptr)
	Adds a ring to polygon/multipolygon features.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult	addRing (const QVector< QgsPointXY > &ring, const QgsFeatureIds &targetFeatureIds=QgsFeatureIds(), QgsFeatureId *modifiedFeatureId=nullptr)
	Adds a ring to polygon/multipolygon features.
Qgis::GeometryOperationResult	addRing (QgsCurve *ring, const QgsFeatureIds &targetFeatureIds=QgsFeatureIds(), QgsFeatureId *modifiedFeatureId=nullptr)
	Adds a ring to polygon/multipolygon features.
Qgis::GeometryOperationResult	addRingV2 (QgsCurve *ring, const QgsFeatureIds &targetFeatureIds=QgsFeatureIds(), QgsFeatureIds *modifiedFeatureIds=nullptr)
	Adds a ring to polygon/multipolygon features.
int	addTopologicalPoints (const QgsGeometry &geom)
	Adds topological points for every vertex of the geometry.
int	addTopologicalPoints (const QgsPoint &p)
	Adds a vertex to segments which intersect point p but don't already have a vertex there.
int	addTopologicalPoints (const QgsPointSequence &ps)
	Adds a vertex to segments which intersect point p but don't already have a vertex there.
int	addTopologicalPoints (const QgsPointXY &p)
	Adds a vertex to segments which intersect point p but don't already have a vertex there.
Qgis::VectorEditResult	deleteVertex (QgsFeatureId featureId, int vertex)
	Deletes a vertex from a feature.
bool	insertVertex (const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex)
	Inserts a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries.
bool	insertVertex (double x, double y, QgsFeatureId atFeatureId, int beforeVertex)
	Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries.
bool	mergeFeatures (const QgsFeatureId &targetFeatureId, const QgsFeatureIds &mergeFeatureIds, const QgsAttributes &mergeAttributes, const QgsGeometry &unionGeometry, QString &errorMessage)
	Merge features into a single one.
bool	moveVertex (const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex)
	Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates.
bool	moveVertex (double x, double y, QgsFeatureId atFeatureId, int atVertex)
	Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates.
Qgis::GeometryOperationResult	splitFeatures (const QgsCurve *curve, QgsPointSequence &topologyTestPoints, bool preserveCircular=false, bool topologicalEditing=false)
	Splits features cut by the given curve.
Qgis::GeometryOperationResult	splitFeatures (const QgsPointSequence &splitLine, bool topologicalEditing=false)
	Splits features cut by the given line.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult	splitFeatures (const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
	Splits features cut by the given line.
Qgis::GeometryOperationResult	splitParts (const QgsPointSequence &splitLine, bool topologicalEditing=false)
	Splits parts cut by the given line.
Q_DECL_DEPRECATED Qgis::GeometryOperationResult	splitParts (const QVector< QgsPointXY > &splitLine, bool topologicalEditing=false)
	Splits parts cut by the given line.
int	translateFeature (QgsFeatureId featureId, double dx, double dy)
	Translates feature by dx, dy.

Detailed Description

Contains utility functions for editing vector layers.

Definition at line 32 of file qgsvectorlayereditutils.h.

Constructor & Destructor Documentation

QgsVectorLayerEditUtils()

QgsVectorLayerEditUtils::QgsVectorLayerEditUtils

(

QgsVectorLayer *

layer

)

Definition at line 35 of file qgsvectorlayereditutils.cpp.

Member Function Documentation

addPart() [1/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::addPart	(	const QgsPointSequence &	ring,
		QgsFeatureId	featureId )

Adds a new part polygon to a multipart feature.

Returns

- QgsGeometry::Success

• QgsGeometry::AddPartSelectedGeometryNotFound
• QgsGeometry::AddPartNotMultiGeometry
• QgsGeometry::InvalidBaseGeometry
• QgsGeometry::InvalidInput

Note

available in python bindings as addPartV2

Definition at line 352 of file qgsvectorlayereditutils.cpp.

addPart() [2/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::addPart	(	const QVector< QgsPointXY > &	ring,
		QgsFeatureId	featureId )

Adds a new part polygon to a multipart feature.

Returns

- QgsGeometry::Success

• QgsGeometry::AddPartSelectedGeometryNotFound
• QgsGeometry::AddPartNotMultiGeometry
• QgsGeometry::InvalidBaseGeometry

• QgsGeometry::InvalidInput

  Deprecated

  QGIS 3.12. Will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.

Definition at line 342 of file qgsvectorlayereditutils.cpp.

addPart() [3/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::addPart	(	QgsCurve *	ring,
		QgsFeatureId	featureId )

Adds a new part polygon to a multipart feature.

Returns

- QgsGeometry::Success

• QgsGeometry::AddPartSelectedGeometryNotFound
• QgsGeometry::AddPartNotMultiGeometry
• QgsGeometry::InvalidBaseGeometry
• QgsGeometry::InvalidInput

Note

available in python bindings as addCurvedPart

Definition at line 387 of file qgsvectorlayereditutils.cpp.

addRing() [1/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::addRing	(	const QgsPointSequence &	ring,
		const QgsFeatureIds &	targetFeatureIds = QgsFeatureIds(),
		QgsFeatureId *	modifiedFeatureId = nullptr )

Adds a ring to polygon/multipolygon features.

Parameters

ring	ring to add
targetFeatureIds	if specified, only these features will be the candidates for adding a ring. Otherwise all intersecting features are tested and the ring is added to the first valid feature.
modifiedFeatureId	if specified, feature ID for feature that ring was added to will be stored in this parameter

Returns

OperationResult result code: success or reason of failure

Definition at line 313 of file qgsvectorlayereditutils.cpp.

addRing() [2/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::addRing	(	const QVector< QgsPointXY > &	ring,
		const QgsFeatureIds &	targetFeatureIds = QgsFeatureIds(),
		QgsFeatureId *	modifiedFeatureId = nullptr )

Adds a ring to polygon/multipolygon features.

Parameters

ring	ring to add
targetFeatureIds	if specified, only these features will be the candidates for adding a ring. Otherwise all intersecting features are tested and the ring is added to the first valid feature.
modifiedFeatureId	if specified, feature ID for feature that ring was added to will be stored in this parameter

Returns

OperationResult result code: success or reason of failure

Deprecated

QGIS 3.12. Will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.

Definition at line 303 of file qgsvectorlayereditutils.cpp.

addRing() [3/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::addRing	(	QgsCurve *	ring,
		const QgsFeatureIds &	targetFeatureIds = QgsFeatureIds(),
		QgsFeatureId *	modifiedFeatureId = nullptr )

Adds a ring to polygon/multipolygon features.

Parameters

ring	ring to add
targetFeatureIds	if specified, only these features will be the candidates for adding a ring. Otherwise all intersecting features are tested and the ring is added to the first valid feature.
modifiedFeatureId	if specified, feature ID for feature that ring was added to will be stored in this parameter

Returns

OperationResult result code: success or reason of failure

Note

available in python bindings as addCurvedRing

Definition at line 319 of file qgsvectorlayereditutils.cpp.

addRingV2()

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::addRingV2	(	QgsCurve *	ring,
		const QgsFeatureIds &	targetFeatureIds = QgsFeatureIds(),
		QgsFeatureIds *	modifiedFeatureIds = nullptr )

Adds a ring to polygon/multipolygon features.

Parameters

ring	ring to add (ownership is transferred)
targetFeatureIds	if specified, only these features will be the candidates for adding a ring. Otherwise all intersecting features are tested and the ring is added to all valid features.
modifiedFeatureIds	if specified, feature IDS for features that ring was added to will be stored in this parameter

Returns

OperationResult result code: success or reason of failure

Since

QGIS 3.28

Definition at line 333 of file qgsvectorlayereditutils.cpp.

addTopologicalPoints() [1/4]

int QgsVectorLayerEditUtils::addTopologicalPoints

(

const QgsGeometry &

geom

)

Adds topological points for every vertex of the geometry.

Parameters

geom	the geometry where each vertex is added to segments of other features

Returns

0 in case of success

1 in case of error

2 in case no vertices needed to be added

Note

geom is not going to be modified by the function

Definition at line 860 of file qgsvectorlayereditutils.cpp.

addTopologicalPoints() [2/4]

int QgsVectorLayerEditUtils::addTopologicalPoints

(

const QgsPoint &

p

)

Adds a vertex to segments which intersect point p but don't already have a vertex there.

If a feature already has a vertex at position p, no additional vertex is inserted. This method is useful for topological editing.

Returns

0 in case of success

1 in case of error

2 in case no vertices needed to be added

Since

QGIS 3.10

Definition at line 885 of file qgsvectorlayereditutils.cpp.

addTopologicalPoints() [3/4]

int QgsVectorLayerEditUtils::addTopologicalPoints

(

const QgsPointSequence &

ps

)

Adds a vertex to segments which intersect point p but don't already have a vertex there.

If a feature already has a vertex at position p, no additional vertex is inserted. This method is useful for topological editing.

Returns

0 in case of success

1 in case of error

2 in case vertex already exists or point does not intersect segment

Since

QGIS 3.16

Definition at line 918 of file qgsvectorlayereditutils.cpp.

addTopologicalPoints() [4/4]

int QgsVectorLayerEditUtils::addTopologicalPoints

(

const QgsPointXY &

p

)

Adds a vertex to segments which intersect point p but don't already have a vertex there.

If a feature already has a vertex at position p, no additional vertex is inserted. This method is useful for topological editing.

Returns

0 in case of success

1 in case of error

2 in case no vertices needed to be added

Definition at line 943 of file qgsvectorlayereditutils.cpp.

deleteVertex()

Qgis::VectorEditResult QgsVectorLayerEditUtils::deleteVertex	(	QgsFeatureId	featureId,
		int	vertex )

Deletes a vertex from a feature.

Parameters

featureId	ID of feature to remove vertex from
vertex	index of vertex to delete

Definition at line 111 of file qgsvectorlayereditutils.cpp.

insertVertex() [1/2]

bool QgsVectorLayerEditUtils::insertVertex	(	const QgsPoint &	point,
		QgsFeatureId	atFeatureId,
		int	beforeVertex )

Inserts a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries.

Definition at line 57 of file qgsvectorlayereditutils.cpp.

insertVertex() [2/2]

bool QgsVectorLayerEditUtils::insertVertex	(	double	x,
		double	y,
		QgsFeatureId	atFeatureId,
		int	beforeVertex )

Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries.

Definition at line 40 of file qgsvectorlayereditutils.cpp.

mergeFeatures()

bool QgsVectorLayerEditUtils::mergeFeatures	(	const QgsFeatureId &	targetFeatureId,
		const QgsFeatureIds &	mergeFeatureIds,
		const QgsAttributes &	mergeAttributes,
		const QgsGeometry &	unionGeometry,
		QString &	errorMessage )

Merge features into a single one.

Parameters

targetFeatureId	id of the target feature (will be updated)
mergeFeatureIds	id list of features to merge (will be deleted)
mergeAttributes	are the resulting attributes in the merged feature
unionGeometry	is the resulting geometry of the merged feature
errorMessage	will be set to a descriptive error message if any occurs

Returns

true if the merge was successful, or false if the operation failed.

Since

QGIS 3.30

Definition at line 948 of file qgsvectorlayereditutils.cpp.

moveVertex() [1/2]

bool QgsVectorLayerEditUtils::moveVertex	(	const QgsPoint &	p,
		QgsFeatureId	atFeatureId,
		int	atVertex )

Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates.

Note

available in Python bindings as moveVertexV2

Definition at line 80 of file qgsvectorlayereditutils.cpp.

moveVertex() [2/2]

bool QgsVectorLayerEditUtils::moveVertex	(	double	x,
		double	y,
		QgsFeatureId	atFeatureId,
		int	atVertex )

Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates.

Definition at line 74 of file qgsvectorlayereditutils.cpp.

splitFeatures() [1/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::splitFeatures	(	const QgsCurve *	curve,
		QgsPointSequence &	topologyTestPoints,
		bool	preserveCircular = false,
		bool	topologicalEditing = false )

Splits features cut by the given curve.

Parameters

	curve	line that splits the layer features
[out]	topologyTestPoints	topological points to be tested against other layers
	preserveCircular	whether circular strings are preserved after splitting
	topologicalEditing	true if topological editing is enabled

Returns

QgsGeometry::OperationResult

Since

QGIS 3.16

Definition at line 466 of file qgsvectorlayereditutils.cpp.

splitFeatures() [2/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::splitFeatures	(	const QgsPointSequence &	splitLine,
		bool	topologicalEditing = false )

Splits features cut by the given line.

Parameters

splitLine	line that splits the layer features
topologicalEditing	true if topological editing is enabled

Returns

QgsGeometry::OperationResult

Definition at line 458 of file qgsvectorlayereditutils.cpp.

splitFeatures() [3/3]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::splitFeatures	(	const QVector< QgsPointXY > &	splitLine,
		bool	topologicalEditing = false )

Splits features cut by the given line.

Parameters

splitLine	line that splits the layer features
topologicalEditing	true if topological editing is enabled

Returns

QgsGeometry::OperationResult

Deprecated

QGIS 3.12. Will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.

Definition at line 447 of file qgsvectorlayereditutils.cpp.

splitParts() [1/2]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::splitParts	(	const QgsPointSequence &	splitLine,
		bool	topologicalEditing = false )

Splits parts cut by the given line.

Parameters

splitLine	line that splits the layer feature parts
topologicalEditing	true if topological editing is enabled

Returns

- QgsGeometry::InvalidBaseGeometry

• QgsGeometry::Success
• QgsGeometry::InvalidInput
• QgsGeometry::NothingHappened if a selection is present but no feature has been split
• QgsGeometry::InvalidBaseGeometry
• QgsGeometry::GeometryEngineError
• QgsGeometry::SplitCannotSplitPoint

Definition at line 738 of file qgsvectorlayereditutils.cpp.

splitParts() [2/2]

Qgis::GeometryOperationResult QgsVectorLayerEditUtils::splitParts	(	const QVector< QgsPointXY > &	splitLine,
		bool	topologicalEditing = false )

Splits parts cut by the given line.

Parameters

splitLine	line that splits the layer feature parts
topologicalEditing	true if topological editing is enabled

Returns

- QgsGeometry::InvalidBaseGeometry

• QgsGeometry::Success
• QgsGeometry::InvalidInput
• QgsGeometry::NothingHappened if a selection is present but no feature has been split
• QgsGeometry::InvalidBaseGeometry
• QgsGeometry::GeometryEngineError

• QgsGeometry::SplitCannotSplitPoint

  Deprecated

  QGIS 3.12. Will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY.

Definition at line 728 of file qgsvectorlayereditutils.cpp.

translateFeature()

int QgsVectorLayerEditUtils::translateFeature	(	QgsFeatureId	featureId,
		double	dx,
		double	dy )

Translates feature by dx, dy.

Parameters

featureId	id of the feature to translate
dx	translation of x-coordinate
dy	translation of y-coordinate

Returns

0 in case of success

Definition at line 428 of file qgsvectorlayereditutils.cpp.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/vector/qgsvectorlayereditutils.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/vector/qgsvectorlayereditutils.cpp