Salome HOME
Implementation of the "0020839: EDF 1370 DOC : Update of the TUI features documentati...
[modules/geom.git] / 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 from a list of points.
6
7 To create a 3D Sketch, select in the main menu <em>New Entity -> 3D Sketch</em>.
8
9 \image html 3dsketch2.png
10
11 In this dialog it is possible to define the coordinates of the points.
12
13 The position of each point can be defined by \b  Absolute coordinates X, Y, Z or
14 by \b Relative coordinates DX, DY, DZ with respect to the previous Applied point.
15 The type of coordinates can be selected by the <b>Coordinates Type</b>
16 radio buttons.
17
18 To add the point in the list of points and to proceed with the
19 definition of the next point, click <b>Apply</b> button. \b Undo and
20 \b Redo buttons, respectively, remove or restore the last point in the list.
21
22 \n <b>"Sketch Validation"</b> button applies the wire, built by the
23 user, "as is".
24 \n <b>"Sketch Closure"</b> closes the Sketch by a straight line from
25 the start to the end point and applies it. 
26
27 To make a closed wire using the TUI command, the first and the last point should 
28 have the same coordinates.
29
30 The Result of the operation will be a \b GEOM_Object.
31
32 <b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em>
33 This algorithm creates a wire from the list of real values, which define XYZ 
34 coordinates of points.
35
36 <b>Example:</b>
37
38 \image html 3dsketch1.png
39
40 Our <b>TUI Scripts</b> provide you with useful examples of the use of
41 \ref tui_3dsketcher_page "3D Sketcher".
42 */