0022618: [CEA 1062] Define the transparency by default in the preferences

[modules/geom.git] / doc / salome / gui / GEOM / input / creating_3dsketcher.doc

diff --git a/doc/salome/gui/GEOM/input/creating_3dsketcher.doc b/doc/salome/gui/GEOM/input/creating_3dsketcher.doc
index 651ebc461f5d08852e90e26c624c1523d5f545d5..030912ad65ba002aab4d44b921d2e48d7043f6ab 100755 (executable)
--- a/doc/salome/gui/GEOM/input/creating_3dsketcher.doc
+++ b/doc/salome/gui/GEOM/input/creating_3dsketcher.doc
@@ -5,39 +5,55 @@
 3D Sketcher allows creating a closed or unclosed 3D wire, made of
 consequent straight segments.
 
 3D Sketcher allows creating a closed or unclosed 3D wire, made of
 consequent straight segments.
 

+<b>Example:</b>
+
+\image html 3dsketch4.png
+

 To create a 3D Sketch, select in the main menu <em>New Entity -> Basic -> 3D Sketch</em>.
 
 To create a 3D Sketch, select in the main menu <em>New Entity -> Basic -> 3D Sketch</em>.
 

-\image html 3dsketch2.png
+\image html 3dsketch_dlg.png
+
+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.
+
+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 first sketcher point can be defined by \b Absolute coordinates X, Y and Z.
-When the first point is defined, it is possible to add straight segments.
-Each segment will start at the end point of previous segment or at the
-sketcher first point, 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:

 
 

-Segment can be defined by:
- - \b Absolute coordinates X, Y and Z of its second end,
- - \b Relative coordinates DX, DY and DZ of its second end with
-   respect to the previous applied point,
- - \b Direction and \b Length of the segment. Direction is set by two
-   \b Angles in selected coordinate system.
+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

 
 

-The way of segment construction can be selected by the <b>Coordinates Type</b>
-radio buttons.
+In both angular modes you can additionally specify the following:
+- the second \b Angle (latitude)

 
 

-To validate the segment and to proceed with the definition of the next
-segment, click <b>Apply</b> button. \b Undo and \b Redo buttons,
+\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.
 
 respectively, remove or restore the last segment in the wire.
 

-\n <b>"Sketch Validation"</b> button applies the wire, built by the
+\n <b>Sketch Validation</b> button applies the wire, built by the

 user, "as is".
 user, "as is".

-\n <b>"Sketch Closure"</b> closes the Sketch by a straight line from
+\n <b>Sketch Closure</b> closes the Sketch by a straight line from

 the start to the end point and applies it. 
 
 the start to the end point and applies it. 
 

-<b>Example:</b>
-
-\image html 3dsketch1.png
+<h2>TUI Commands</h2>

 
 

-<b>TUI Command:</b> <em>geompy.Make3DSketcher( [ PointsList ] )</em>
+<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.
 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.


@@ -47,11 +63,14 @@ last point should have the same coordinates.
 
 \n Another way to create the 3D Sketcher in TUI is using Sketcher3D
 interface.
 
 \n Another way to create the 3D Sketcher in TUI is using Sketcher3D
 interface.

-<b>TUI Command:</b> <em>sk = geompy.Sketcher3D()</em>
-Returns an instance of Sketcher3D interface <i>sk</i>.
+
+<em>sk = geompy.Sketcher3D()</em>
+
+Returns an instance of Sketcher3D interface <em>sk</em>.
+

 Use the below examples and see the \ref gsketcher.Sketcher3D "Sketcher3D"
 interface documentation for more information.
 
 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".
 */
 \ref tui_3dsketcher_page "3D Sketcher".
 */