geom/doc/salome/gui/GEOM/input/min_distance.doc
2014-11-19 15:40:00 +03:00

34 lines
1.6 KiB
Plaintext

/*!
\page min_distance_page Minimum Distance
This operation returns the minimum distance between two geometrical objects.
\n The appropriate "local" selection is automatically switched on. If there are several entities of allowed types under the mouse cursor, first of them (top-level one) is highlighted.
Press <CTRL> button and scroll the mouse wheel to switch between different available shapes that are pointed by the mouse cursor. The corresponding entities are highlighted in the viewer.
Press left mouse button to select appropriate object to the dialog box.
\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".
*/