Salome HOME
Revert "Synchronize adm files"
[modules/geom.git] / doc / salome / gui / GEOM / input / min_distance.doc
index 690a17f3aa86b69eeb64e4acae9c1f46191448be..d4fa336b77bb3320a8461b055dce45df7b5c5472 100644 (file)
@@ -1,16 +1,29 @@
 /*! 
 
-\page min_distance_page Min. Distance
+\page min_distance_page Minimum Distance
 
-Returns the minimum distance between two geometrical objects and
-the coordinates of the vector of distance and shows the vector in the viewer.
+This operation returns the minimum distance between two geometrical objects.
 
-<b>TUI Command:</b> <em>geompy.MinDistance(Shape1, Shape2),</em>
-where \em Shape1 and \em Shape2 are shapes between which the minimal
+\image html distance.png
+
+The query for minimum distance can find one or more solutions, or even an infinite set of solutions. 
+However, the currently used OCCT algorithm finds a finite number of
+solutions even if an infinite set of solutions exists.
+
+Select one of the found solutions in the \b Solution list to display it in the Viewer show values corresponding to this solution in the following fields:
+- \b Length - the distance value;
+- \b DX, \b DY and \b DZ the vector coordinates. 
+
+Press \b Apply or <b>Apply and Close</b> button to create a set of closest
+points, corresponding to all found solutions.
+
+<b>TUI Commands:</b>
+\n<em>aDist = geompy.MinDistance(Shape1, Shape2),</em>
+\n<em>[aDist, DX, DY, DZ] = geompy.MinDistanceComponents(Shape1, Shape2),</em>
+\n<em>[nbSols, (x11, y11, z11, x21, y21, z21, ...)] = geompy.ClosestPoints(Shape1, Shape2),</em>
+\n where \em Shape1 and \em Shape2 are the shapes, between which the minimal
 distance is computed.
 
 See also a \ref tui_min_distance_page "TUI example".
 
-\image html distance.png
-
-*/
\ No newline at end of file
+*/