Salome HOME
Merge remote branch 'origin/V7_4_BR'
[modules/geom.git] / doc / salome / gui / GEOM / input / min_distance.doc
index b30a00e97aa25d6dbf77e70f853bfa5807e5d8f8..d4fa336b77bb3320a8461b055dce45df7b5c5472 100644 (file)
@@ -2,30 +2,26 @@
 
 \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 distance in
-the viewer.
-
-\note The query for minimum distance can find one or more
-solutions, or even an infinite set of solutions. All
-found solutions are listed in a dedicated combo-box. When one of the found solutions is selected, the presentation is displayed in the
-OCC viewer and fields "Length", "DX", "DY" and "DZ" are filled with the 
-corresponding values. If no solutions have been found, the message "No
-solution found" is shown.
-
-\note The currently used OCCT algorithm finds a finite number of
-solutions even if an infinite set of solutions exists.
+This operation returns the minimum distance between two geometrical objects.
 
 \image html distance.png
 
-\n On \b Apply or <b>Apply and Close</b> a set of closest
-points, corresponding to all found solutions is created.
+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 shapes between which the minimal
+\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".