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

   1 /*!
   2
   3 \page create_extrusion_page Extrusion
   4
   5 \n To generate an \b Extrusion on an object in the <b>Main Menu</b>
   6 select <b>New Entity - > Generation  - > Extrusion</b>
   7
   8 \n There are 3 algorithms for creation of an \b Extrusion (Prism).
   9 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell
  10 solid or compsolid).
  11
  12 \n Firstly, you can define the <b>Base Shape</b> (a basis of the
  13 extrusion), the \b Vector (a direction of the extrusion) and the \b
  14 Height of extrusion. Optionally you can define the <b>Scale Factor</b> to
  15 build extrusion with scaled opposite base. Scaling is possible only
  16 with 1D and 2D bases.
  17 <br>It is possible to select in GUI several Base Shapes to make
  18 several extrusions (using Shift button).
  19 \n The \b Result of the operation will be a GEOM_Object (edge, face,
  20 shell, solid or compsolid).
  21 \n <b> Both Directions </b> checkbox allows extruding the source
  22 object both forward and backward. With this option scaling is not possible.
  23 \n <b>TUI Command:</b> <em>geompy.MakePrismVecH(Base, Vector, Height, theScaleFactor = -1.0)</em>
  24 \n <b>Arguments:</b> Name + one or several shapes (vertex, edge, planar wire, face or
  25 shell) serving as base objects + 1 vector (for direction of the
  26 extrusion) + 1 value (dimension) + 1 optional value (scale factor for
  27 the opposite base).
  28 \n<b>Advanced options</b> \ref preview_anchor "Preview"
  29
  30 \image html extrusion1.png
  31
  32 \n Secondly, you can define the \b Extrusion by the <b>Base Shape(s)</b>
  33 and the \b Start and <b>End Point</b> of the \b Vector (in this way
  34 you don't need to create it in advance). Optionally you can define the
  35 <b>Scale Factor</b> to build extrusion with scaled opposite
  36 base. Scaling is possible only with 1D and 2D bases.
  37 \n <b> Both Directions </b> checkbox allows extruding the source
  38 object both forward and backward.  With this option scaling is not possible.
  39 \n <b>TUI Command:</b> <em>geompy.MakePrism(Base, Point1, Point2, theScaleFactor = -1.0)</em>
  40 \n <b>Arguments:</b> Name + one or several shapes (vertex, edge, planar wire, face or
  41 shell) serving as base objects + 2 vertices + 1 optional value (scale factor for
  42 the opposite base).
  43
  44 \image html extrusion2.png
  45
  46 \n Finally, you can define the \b Extrusion by the <b>Base Shape(s)</b>
  47 and the <b>DX, DY, DZ</b> Vector. Optionally you can define the
  48 <b>Scale Factor</b> to build extrusion with scaled opposite
  49 base. Scaling is possible only with 1D and 2D bases.\n
  50 <b>Both Directions</b> checkbox allows extruding the
  51 source objects both forward and backward. With this option scaling is not possible.
  52 \n <b>TUI Command:</b> <em>geompy.MakePrismDXDYDZ(Base, dx, dy, dz, theScaleFactor = -1.0)</em>
  53 \n <b>Arguments:</b> Name + one or several shapes (vertex, edge, planar wire, face or
  54 shell) serving as base objects + 3 axis directions + 1 optional value (scale factor for
  55 the opposite base).
  56
  57 \image html extrusion3.png
  58
  59 <b>Examples:</b>
  60
  61 \image html prisms_basessn.png
  62 <center>Base Shape</center>
  63
  64 \image html prismssn.png
  65 <center>Prisms</center>
  66
  67 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  68 \ref tui_creation_prism "Complex Geometric Objects".
  69
  70 */