doc/salome/gui/GEOM/input/creating_extrusion.doc

   1 /*!
   2
   3 \page create_extrusion_page Extrusion
   4
   5 \b Extrusion is propagation of the selected base shape in a certain direction and by a certain distance.
   6 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell
   7 solid or compsolid).
   8
   9 <b>Examples:</b>
  10
  11 \image html prisms_basessn.png
  12 <center>Base Shape</center>
  13
  14 \image html prismssn.png
  15 <center>Resulting Prisms</center>
  16
  17 \n To generate an \b Extrusion on an object in the <b>Main Menu</b>
  18 select <b>New Entity - > Generation  - > Extrusion</b>
  19
  20 \image html extrusion1.png
  21
  22 The following parameters and options can be defined in this dialog
  23
  24 <ul>
  25 <li><b>Result name</b> of the created resulting shape.</li>
  26 <li><b>Base</b> - the extruded object. It is possible to select in GUI several Base Shapes to make
  27 several extrusions (using Shift button).</li>
  28 <li>Direction and distance can be defined in three different ways selectable with the radio buttons on top of the dialog box :
  29
  30 <ul>
  31 <li> By the \b Vector and the \b Height of extrusion.
  32 <b>TUI Command:</b> <em>geompy.MakePrismVecH(Base, Vector, Height, theScaleFactor = -1.0)</em>
  33 </li>
  34
  35 <li> By the \b Start and <b>End Point</b> of the \b Vector (in this way
  36 you don't need to create it in advance).
  37 <b>TUI Command:</b> <em>geompy.MakePrism(Base, Point1, Point2, theScaleFactor = -1.0)</em>
  38 \image html extrusion2.png
  39 </li>
  40
  41 <li> By \b DX, \b DY, and \b DZ coordinates of the Vector.
  42 <b>TUI Command:</b> <em>geompy.MakePrismDXDYDZ(Base, dx, dy, dz, theScaleFactor = -1.0)</em>
  43 \image html extrusion3.png
  44 </li>
  45 </ul>
  46 </li>
  47
  48 <li> <b>Both Directions </b> checkbox allows extruding the base shape both forward and backward. With this option scaling is not possible.</li>
  49 <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>
  50 <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>
  51 <li><b>Add thickness</b> checkbox and \b Thickess field allow adding thickness
  52 to the created prism (only when extruding an edge or wire).
  53 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.
  54 <b>TUI Command:</b> <em>geompy.Thicken(Shape, Thickness)</em>
  55 \image html prism_with_thickness.png
  56 </li>
  57
  58 <li><b>Advanced options:</b> \ref preview_anchor "Preview" - displays the resulting shape in the viewer before \b Apply command.   </li>
  59 </ul>
  60
  61 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  62 \ref tui_creation_prism "Complex Geometric Objects".
  63
  64 */