address reviews

qgis · Jan 13, 2021 · a97ade0 · a97ade0
1 parent f85d551
commit a97ade0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/python/core/auto_generated/geometry/qgsbox3d.sip.in b/python/core/auto_generated/geometry/qgsbox3d.sip.in
@@ -219,9 +219,11 @@ If the point is a 2D point (no z-coordinate), then the containment test
 will be performed on the x/y extent of the box only.
 %End
 
-    float distanceFromPoint( double x, double y, double z );
+    float distanceFromPoint( double x, double y, double z ) const;
 %Docstring
-Returns shortest distance from the box to a point
+Returns shortest distance from the box to a point (returns 0 if the point is inside the box)
+
+.. versionadded:: 3.18
 %End
 
     QgsRectangle toRectangle() const;

diff --git a/src/core/geometry/qgsbox3d.h b/src/core/geometry/qgsbox3d.h
@@ -199,9 +199,10 @@ class CORE_EXPORT QgsBox3d
     bool contains( const QgsPoint &point ) const;
 
     /**
-     * Returns shortest distance from the box to a point
+     * Returns shortest distance from the box to a point (returns 0 if the point is inside the box)
+     * \since QGIS 3.18
      */
-    float distanceFromPoint( double x, double y, double z );
+    float distanceFromPoint( double x, double y, double z ) const;
 
     /**
      * Converts the box to a 2D rectangle.