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 After this, it is possible to add straight segments.
  18
  19 Each segment starts at the end point of the previous segment or at the first point of the sketch, if there are no validated segments.
  20
  21 The second point of a segment can be defined in two different ways depending on the selected <b>Coordinates Type</b> radio buttons:
  22
  23 By <b>Cartesian coordinates</b> , which can be either:
  24 - \b Absolute coordinates \b X, \b Y and \b Z, or
  25 - \b Relative coordinates \b DX, \b DY and \b DZ with respect to the previous applied point,
  26
  27 By <b>Angular coordinates</b>, which include:
  28 - the \b Length of the segment and an \b Angle in the chosen plane (OXY for example) in \b Relative mode. The angle is then relative to a local coordinate system with the last point of the sketch as origin.
  29
  30 \image html 3dsketch_angle_rel.png
  31
  32 - the \b Radius (i.e. the distance from the origin) and an \b Angle in the chosen plane in \b Absolute mode
  33
  34 \image html 3dsketch_angle_abs.png
  35
  36 In both angular modes you can additionally specify the following:
  37 - the second \b Angle (latitude)
  38
  39 \image html 3dsketch_2angles_rel.png
  40
  41 - the \b Height
  42
  43 \image html 3dsketch_angle_height_rel.png
  44
  45 To validate a segment and to proceed with the definition of the next
  46 one, click <b>Apply</b> button. \b Undo and \b Redo buttons,
  47 respectively, remove or restore the last segment in the wire.
  48
  49 \n <b>Sketch Validation</b> button applies the wire, built by the
  50 user, "as is".
  51 \n <b>Sketch Closure</b> closes the Sketch by a straight line from
  52 the start to the end point and applies it.
  53
  54 <h2>TUI Commands</h2>
  55
  56 <em>geompy.Make3DSketcher( [ PointsList ] )</em>
  57 This algorithm creates a wire from the list of real values, which
  58 define absolute XYZ coordinates of points. The Result of the operation
  59 will be a \b GEOM_Object.
  60
  61 \note To make a closed wire using this TUI command, the first and the
  62 last point should have the same coordinates.
  63
  64 \n Another way to create the 3D Sketcher in TUI is using Sketcher3D
  65 interface.
  66
  67 <em>sk = geompy.Sketcher3D()</em>
  68
  69 Returns an instance of Sketcher3D interface <em>sk</em>.
  70
  71 Use the below examples and see the \ref gsketcher.Sketcher3D "Sketcher3D"
  72 interface documentation for more information.
  73
  74 <b>TUI Scripts</b> provide you with useful examples of the use of
  75 \ref tui_3dsketcher_page "3D Sketcher".
  76 */