doc/salome/gui/GEOM/input/min_distance.doc

   1 /*!
   2
   3 \page min_distance_page Minimum Distance
   4
   5 This operation returns the minimum distance between two geometrical objects.
   6
   7 \image html distance.png
   8
   9 The query for minimum distance can find one or more solutions, or even an infinite set of solutions.
  10 However, the currently used OCCT algorithm finds a finite number of
  11 solutions even if an infinite set of solutions exists.
  12
  13 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:
  14 - \b Length - the distance value;
  15 - \b DX, \b DY and \b DZ the vector coordinates.
  16
  17 Press \b Apply or <b>Apply and Close</b> button to create a set of closest
  18 points, corresponding to all found solutions.
  19
  20 \note This dialog supports navigation through the selectable objects (in OCC 3D viewer only):
  21 - Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when input focus is
  22 in the viewer to navigate between selectable objects.
  23 - Press left mouse button to select an appropriate object to the dialog box.
  24 .
  25 For more details, please refer to the \em "Functionality common for OCC and VTK viewers" chapter
  26 of the GUI module's documentation.
  27
  28 <b>TUI Commands:</b>
  29 - <em>aDist = geompy.MinDistance(Shape1, Shape2),</em>
  30 - <em>[aDist, DX, DY, DZ] = geompy.MinDistanceComponents(Shape1, Shape2),</em>
  31 - <em>[nbSols, (x11, y11, z11, x21, y21, z21, ...)] = geompy.ClosestPoints(Shape1, Shape2),</em>
  32 .
  33 where \em Shape1 and \em Shape2 are the shapes, between which the minimal
  34 distance is computed.
  35
  36 See also a \ref tui_min_distance_page "TUI example".
  37
  38 */