Salome HOME
Merge branch 'fbt/addAngleInCylPrimitive'
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_3dsketcher.doc
index bb914ea55ec7bc192dfd45b787f5abea9d5259c9..030912ad65ba002aab4d44b921d2e48d7043f6ab 100755 (executable)
@@ -2,30 +2,75 @@
 
 \page create_3dsketcher_page 3D Sketcher
 
-3D Sketcher allows creating a closed or unclosed 3D wire from a list of points.
+3D Sketcher allows creating a closed or unclosed 3D wire, made of
+consequent straight segments.
 
-To create a 3D Sketch, select in the main menu <em>New Entity -> 3D Sketch</em>.
+<b>Example:</b>
 
-\image html 3dsketch2.png
+\image html 3dsketch4.png
 
-The position of each coordinates can be defined by absolute coordinates X, Y, Z or
-by relative coordinates DX, DY, DZ with respect to the previous Applied point.
-Type of coordinates can be selected by the <b>Coordinates Type</b> radio buttons.
-\n <b>"Sketch Validation"</b> button applies the wire, only red part will be built by "Sketch Validation".
-\n <b>"Sketch Closure"</b> will close the Sketch by straight line from last red part and apply it. 
-To make a closed wire using the TUI command, the first and the last point shoul 
-have the same coordinates.
+To create a 3D Sketch, select in the main menu <em>New Entity -> Basic -> 3D Sketch</em>.
 
-The Result of the operation will be a \b GEOM_Object.
+\image html 3dsketch_dlg.png
 
-<b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em>
-This algorithm creates a wire, from the list of real values which define XYZ 
-coordinates of points.
+The first point of a sketch can be defined by \b Absolute coordinates X, Y and Z.
+After this, it is possible to add straight segments.
 
-<b>Example:</b>
+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.
+
+The second point of a segment can be defined in two different ways depending on the selected <b>Coordinates Type</b> radio buttons:
+
+By <b>Cartesian coordinates</b> , which can be either:
+- \b Absolute coordinates \b X, \b Y and \b Z, or
+- \b Relative coordinates \b DX, \b DY and \b DZ with respect to the previous applied point,
+By <b>Angular coordinates</b>, which include:
+- 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. </li>
+   
+\image html 3dsketch_angle_rel.png
+   
+- the \b Radius (i.e. the distance from the origin) and an \b Angle in the chosen plane in \b Absolute mode 
+   
+\image html 3dsketch_angle_abs.png
+
+In both angular modes you can additionally specify the following:
+- the second \b Angle (latitude)
+
+\image html 3dsketch_2angles_rel.png
+   
+- the \b Height
+\image html 3dsketch_angle_height_rel.png
+   
+To validate a segment and to proceed with the definition of the next
+one, click <b>Apply</b> button. \b Undo and \b Redo buttons,
+respectively, remove or restore the last segment in the wire.
+
+\n <b>Sketch Validation</b> button applies the wire, built by the
+user, "as is".
+\n <b>Sketch Closure</b> closes the Sketch by a straight line from
+the start to the end point and applies it. 
+
+<h2>TUI Commands</h2>
+
+<em>geompy.Make3DSketcher( [ PointsList ] )</em>
+This algorithm creates a wire from the list of real values, which
+define absolute XYZ coordinates of points. The Result of the operation
+will be a \b GEOM_Object.
+
+\note To make a closed wire using this TUI command, the first and the
+last point should have the same coordinates.
+
+\n Another way to create the 3D Sketcher in TUI is using Sketcher3D
+interface.
+
+<em>sk = geompy.Sketcher3D()</em>
+
+Returns an instance of Sketcher3D interface <em>sk</em>.
 
-\image html 3dsketch1.png
+Use the below examples and see the \ref gsketcher.Sketcher3D "Sketcher3D"
+interface documentation for more information.
 
-Our <b>TUI Scripts</b> provide you with useful examples of the use of
+<b>TUI Scripts</b> provide you with useful examples of the use of
 \ref tui_3dsketcher_page "3D Sketcher".
 */