sipify

qgis · Jun 9, 2021 · 7c0f3a1 · 7c0f3a1
1 parent b9a6c0c
commit 7c0f3a1
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in
@@ -831,6 +831,28 @@ looping twice over the set of points.
    points whose z or m value is closest to the original x/y point, but only the first one found.
 
 
+.. versionadded:: 3.20
+%End
+
+    static bool transferFirstZOrMValueToPoint( const QgsAbstractGeometry::vertex_iterator &verticesBegin, const QgsAbstractGeometry::vertex_iterator &verticesEnd, QgsPoint &point );
+%Docstring
+A Z or M dimension is added to ``point`` if one of the points in the list
+``points`` contains Z or M value.
+
+This method is equivalent to successively calling Z and M but avoiding
+looping twice over the set of points.
+
+:param points: List of points in which a Z or M point is searched.
+:param point: The point to update with Z or M dimension and value.
+
+:return: ``True`` if the point is updated, ``False`` otherwise
+
+.. warning::
+
+   This method does not copy the z or m value of the coordinate from the
+   points whose z or m value is closest to the original x/y point, but only the first one found.
+
+
 .. versionadded:: 3.20
 %End