Salome HOME
Doc : Add an Angle option in the cylinder primitive in order to build portion of...
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_extrusion.doc
index 3f3435ca63af7db30460688b174d26850399e8c6..25e43145562a63a79cd8768d43f965285b578b84 100644 (file)
@@ -2,45 +2,61 @@
 
 \page create_extrusion_page Extrusion
 
-\n To generate an \b Extrusion on an object in the <b>Main Menu</b>
-select <b>New Entity - > Generation  - > Extrusion</b>
-
-\n There are 2 algorithms for creation of an \b Extrusion (Prism).
+\b Extrusion is propagation of the selected base shape in a certain direction and by a certain distance. 
 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell
 solid or compsolid).
 
-\n Firstly, you can define the <b>Base Shape</b> (a basis of the
-extrusion), the \b Vector (a direction of the extrusion) and the \b
-Height of extrusion.
-\n The \b Result of the operation will be a GEOM_Object (edge, face,
-shell, solid or compsolid).
-\n <b> Both Directions </b> checkbox allows extruiding the source
-object both forward and backward. 
-\n <b>TUI Command:</b> <em>geompy.MakePrismVecH(Base, Vector, Height)</em>
-\n <b>Arguments:</b> Name + 1 shape (vertex, edge, planar wire, face or
-shell) serving as base object + 1 vector (for direction of the
-extrusion) + 1 value (dimension).
+<b>Examples:</b>
+
+\image html prisms_basessn.png
+<center>Base Shape</center>
+
+\image html prismssn.png
+<center>Resulting Prisms</center>
+
+\n To generate an \b Extrusion on an object in the <b>Main Menu</b>
+select <b>New Entity - > Generation  - > Extrusion</b>
 
 \image html extrusion1.png
 
-\n Secondly, you can define the \b Extrusion by the <b>Base Shape</b>
-and the \b Start and <b>End Point</b> of the \b Vector (in this way
-you don't need to create it in advance).
-\n <b> Both Directions </b> checkbox allows extruiding the source
-object both forward and backward. 
-\n <b>TUI Command:</b> <em>geompy.MakePrism(Base, Point1, Point2)</em>
-\n <b>Arguments:</b> Name + 1 shape (vertex, edge, planar wire, face or
-shell) serving as base object + 2 vertices.
+The following parameters and options can be defined in this dialog
+
+<ul>
+<li><b>Result name</b> of the created resulting shape.</li>
+<li><b>Base</b> - the extruded object. It is possible to select in GUI several Base Shapes to make
+several extrusions (using Shift button).</li>
+<li>Direction and distance can be defined in three different ways selectable with the radio buttons on top of the dialog box :
+
+<ul> 
+<li> By the \b Vector and the \b Height of extrusion. 
+<b>TUI Command:</b> <em>geompy.MakePrismVecH(Base, Vector, Height, theScaleFactor = -1.0)</em>
+</li>
 
+<li> By the \b Start and <b>End Point</b> of the \b Vector (in this way
+you don't need to create it in advance).
+<b>TUI Command:</b> <em>geompy.MakePrism(Base, Point1, Point2, theScaleFactor = -1.0)</em>
 \image html extrusion2.png
+</li>
 
-<b>Examples:</b>
+<li> By \b DX, \b DY, and \b DZ coordinates of the Vector.
+<b>TUI Command:</b> <em>geompy.MakePrismDXDYDZ(Base, dx, dy, dz, theScaleFactor = -1.0)</em>
+\image html extrusion3.png
+</li>
+</ul>
+</li>
 
-\image html prisms_basessn.png
-<center>Base Shape</center>
+<li> <b>Both Directions </b> checkbox allows extruding the base shape both forward and backward. With this option scaling is not possible.</li>
+<li> <b>Reverse</b> checkbox reverts the direction of the scaling vector. It is usable only if the direction and distance are set via a \b Vector and a \b Height. </li>
+<li><b>Scale the face opposite to the base</b> checkbox and <b>Scale Factor</b> field allow building the extrusion with scaled opposite base. Scaling is possible only for 1D and 2D bases.</li>
+<li><b>Add thickness</b> checkbox and \b Thickess field allow adding thickness
+to the created prism (only when extruding an edge or wire).
+By default the material is added on the outside of the generated pipe, but it is possible to <b>Thicken towards the inside</b> using the corresponding checkbox. 
+<b>TUI Command:</b> <em>geompy.Thicken(Shape, Thickness)</em>
+\image html prism_with_thickness.png
+</li>
 
-\image html prismssn.png
-<center>Prisms</center>
+<li><b>Advanced options:</b> \ref preview_anchor "Preview" - displays the resulting shape in the viewer before \b Apply command.   </li>
+</ul>
 
 Our <b>TUI Scripts</b> provide you with useful examples of creation of
 \ref tui_creation_prism "Complex Geometric Objects".