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

   1 /*!
   2
   3 \page min_distance_page Minimum Distance
   4
   5 Returns the minimum distance between two geometrical objects and
   6 the coordinates of the vector of distance and shows the distance in
   7 the viewer.
   8
   9 \note The query for minimum distance can find one or more
  10 solutions, or even an infinite set of solutions. All
  11 found solutions are listed in a dedicated combo-box. When one of the found solutions is selected, the presentation is displayed in the
  12 OCC viewer and fields "Length", "DX", "DY" and "DZ" are filled with the
  13 corresponding values. If no solutions have been found, the message "No
  14 solution found" is shown.
  15
  16 \note The currently used OCCT algorithm finds a finite number of
  17 solutions even if an infinite set of solutions exists.
  18
  19 \image html distance.png
  20
  21 \n On \b Apply or <b>Apply and Close</b> a set of closest
  22 points, corresponding to all found solutions is created.
  23
  24 <b>TUI Commands:</b>
  25 \n<em>aDist = geompy.MinDistance(Shape1, Shape2),</em>
  26 \n<em>[aDist, DX, DY, DZ] = geompy.MinDistanceComponents(Shape1, Shape2),</em>
  27 \n<em>[nbSols, (x11, y11, z11, x21, y21, z21, ...)] = geompy.ClosestPoints(Shape1, Shape2),</em>
  28 \n where \em Shape1 and \em Shape2 are shapes between which the minimal
  29 distance is computed.
  30
  31 See also a \ref tui_min_distance_page "TUI example".
  32
  33 */