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

   1 /*!
   2
   3 \page min_distance_page Min. 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 minimal distance searching task can have one or more
  10 solutions, and also it can have an infinite set of solutions. All
  11 found solutions are listed in dedicated combobox. When the user
  12 selects any one of found solutions, presentation is displayed in the
  13 OCC viewer and fields "Length", "DX", "DY" and "DZ" are filled with
  14 corresponding values. If there are no solutions found, text "No
  15 solution found" will be shown instead of solutions list; this could
  16 mean what the task has an infinite number of solutions.
  17
  18 \n \note Currently used OCCT functionality finds finite number of
  19 solutions even in cases, where an infinite set of solutions exists.
  20
  21 \n On \b Apply or <b>Apply and Close</b> it creates a set of closest
  22 points of the shapes, corresponding to all found solutions.
  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 \image html distance.png
  34
  35 */