doc/salome/gui/GEOM/input/creating_3dsketcher.doc

   1 /*!
   2
   3 \page create_3dsketcher_page 3D Sketcher
   4
   5 3D Sketcher allows creating a closed or unclosed 3D wire, made of
   6 consequent straight segments.
   7
   8 <b>Example:</b>
   9
  10 \image html 3dsketch4.png
  11
  12 To create a 3D Sketch, select in the main menu <em>New Entity -> Basic -> 3D Sketch</em>.
  13
  14 \image html 3dsketch_dlg.png
  15
  16 The first point of a sketch can be defined by \b Absolute coordinates X, Y and Z.
  17 When the first point is defined, it is possible to add straight segments.
  18 Each segment will start at the end point of the previous segment or at the
  19 first point of the sketch, if there are no validated segments.
  20
  21 The way of segment construction can be selected by the <b>Coordinates Type</b>
  22 radio buttons.
  23
  24 To validate a segment and to proceed with the definition of the next
  25 one, click <b>Apply</b> button. \b Undo and \b Redo buttons,
  26 respectively, remove or restore the last segment in the wire.
  27
  28 \n <b>"Sketch Validation"</b> button applies the wire, built by the
  29 user, "as is".
  30 \n <b>"Sketch Closure"</b> closes the Sketch by a straight line from
  31 the start to the end point and applies it.
  32
  33 A segment can be defined by:
  34 - <b>Cartesian coordinates</b> of its second end, which can be either:
  35  - \b Absolute coordinates X, Y and Z, or
  36  - \b Relative coordinates DX, DY and DZ with
  37    respect to the previous applied point,
  38
  39 - <b>Angular coordinates</b> of its second end specified by:
  40 <ul>
  41  <li> the \b Length of the segment and an \b Angle in the chosen plane (OXY for example) in \b Relative mode.
  42    The angle is then relative to a local coordinate system with the last point of the sketch as origin. </li>
  43
  44    \image html 3dsketch_angle_rel.png
  45
  46  <li> the \b Radius (i.e. the distance from the origin) and an \b Angle in the chosen plane in \b Absolute mode </li>
  47
  48    \image html 3dsketch_angle_abs.png
  49
  50  In both angular modes you can additionally specify the following:
  51
  52  <li> the second \b Angle (latitude) </li>
  53
  54  \image html 3dsketch_2angles_rel.png
  55
  56  or
  57
  58  <li> the \b Height </li>
  59
  60  \image html 3dsketch_angle_height_rel.png
  61
  62
  63 </ul>
  64
  65 <b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em>
  66 This algorithm creates a wire from the list of real values, which
  67 define absolute XYZ coordinates of points. The Result of the operation
  68 will be a \b GEOM_Object.
  69
  70 \note To make a closed wire using this TUI command, the first and the
  71 last point should have the same coordinates.
  72
  73 \n Another way to create the 3D Sketcher in TUI is using Sketcher3D
  74 interface.
  75 <b>TUI Command:</b> <em>sk = geompy.Sketcher3D()</em>
  76 Returns an instance of Sketcher3D interface <i>sk</i>.
  77 Use the below examples and see the \ref gsketcher.Sketcher3D "Sketcher3D"
  78 interface documentation for more information.
  79
  80 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  81 \ref tui_3dsketcher_page "3D Sketcher".
  82 */