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 To create a 3D Sketch, select in the main menu <em>New Entity -> Basic -> 3D Sketch</em>.
   9
  10 \image html 3dsketch2.png
  11
  12 The first sketcher point can be defined by \b Absolute coordinates X, Y and Z.
  13 When the first point is defined, it is possible to add straight segments.
  14 Each segment will start at the end point of previous segment or at the
  15 sketcher first point, if there are no validated segments.
  16
  17 Segment can be defined by:
  18  - \b Absolute coordinates X, Y and Z of its second end,
  19  - \b Relative coordinates DX, DY and DZ of its second end with
  20    respect to the previous applied point,
  21  - \b Direction and \b Length of the segment. Direction is set by two
  22    \b Angles in selected coordinate system.
  23
  24 The way of segment construction can be selected by the <b>Coordinates Type</b>
  25 radio buttons.
  26
  27 To validate the segment and to proceed with the definition of the next
  28 segment, click <b>Apply</b> button. \b Undo and \b Redo buttons,
  29 respectively, remove or restore the last segment in the wire.
  30
  31 \n <b>"Sketch Validation"</b> button applies the wire, built by the
  32 user, "as is".
  33 \n <b>"Sketch Closure"</b> closes the Sketch by a straight line from
  34 the start to the end point and applies it.
  35
  36 <b>Example:</b>
  37
  38 \image html 3dsketch1.png
  39
  40 <b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em>
  41 This algorithm creates a wire from the list of real values, which
  42 define absolute XYZ coordinates of points. The Result of the operation
  43 will be a \b GEOM_Object.
  44
  45 \note To make a closed wire using this TUI command, the first and the
  46 last point should have the same coordinates.
  47
  48 \n Another way to create the 3D Sketcher in TUI is using Sketcher3D
  49 interface.
  50 <b>TUI Command:</b> <em>sk = geompy.Sketcher3D()</em>
  51 Returns an instance of Sketcher3D interface <i>sk</i>.
  52 Use the below examples and see the \ref gsketcher.Sketcher3D "Sketcher3D"
  53 interface documentation for more information.
  54
  55 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  56 \ref tui_3dsketcher_page "3D Sketcher".
  57 */