X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fmin_distance.doc;h=d4fa336b77bb3320a8461b055dce45df7b5c5472;hb=97d9c2c6b1eb1b8c37b74e9409ebdb89c42c8c27;hp=9653e221092634574a1e2f824ec86465bdd59f19;hpb=465e84c52edb243fa36d581abc659b1c97156c64;p=modules%2Fgeom.git diff --git a/doc/salome/gui/GEOM/input/min_distance.doc b/doc/salome/gui/GEOM/input/min_distance.doc index 9653e2210..d4fa336b7 100644 --- a/doc/salome/gui/GEOM/input/min_distance.doc +++ b/doc/salome/gui/GEOM/input/min_distance.doc @@ -1,35 +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 distance in -the viewer. +This operation returns the minimum distance between two geometrical objects. -\note The minimal distance searching task can have one or more -solutions, and also it can have an infinite set of solutions. All -found solutions are listed in dedicated combobox. When the user -selects any one of found solutions, presentation is displayed in the -OCC viewer and fields "Length", "DX", "DY" and "DZ" are filled with -corresponding values. If there are no solutions found, text "No -solution found" will be shown instead of solutions list; this could -mean what the task has an infinite number of solutions. +\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. -\n \note Currently used OCCT functionality finds finite number of -solutions even in cases, where 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. -\n On \b Apply or Apply and Close it creates a set of closest -points of the shapes, corresponding to all found solutions. +Press \b Apply or Apply and Close button to create a set of closest +points, corresponding to all found solutions. TUI Commands: \naDist = geompy.MinDistance(Shape1, Shape2), \n[aDist, DX, DY, DZ] = geompy.MinDistanceComponents(Shape1, Shape2), \n[nbSols, (x11, y11, z11, x21, y21, z21, ...)] = geompy.ClosestPoints(Shape1, Shape2), -\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". -\image html distance.png - */