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 <b>Examples:</b>
   9
  10 \image html prisms_basessn.png
  11 Base Shape
  12
  13 \image html prismssn.png
  14 Prisms
  15
  16 \n There are 3 algorithms for creation of an \b Extrusion (Prism).
  17 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell
  18 solid or compsolid).
  19
  20 \n Firstly, you can define the <b>Base Shape</b> (a basis of the
  21 extrusion), the \b Vector (a direction of the extrusion) and the \b
  22 Height of extrusion. Optionally you can define the <b>Scale Factor</b> to
  23 build extrusion with scaled opposite base. Scaling is possible only
  24 with 1D and 2D bases.
  25 <br>It is possible to select in GUI several Base Shapes to make
  26 several extrusions (using Shift button).
  27 \n The \b Result of the operation will be a GEOM_Object (edge, face,
  28 shell, solid or compsolid).
  29 \n <b> Both Directions </b> checkbox allows extruding the source
  30 object both forward and backward. With this option scaling is not possible.
  31 \n <b>TUI Command:</b> <em>geompy.MakePrismVecH(Base, Vector, Height, theScaleFactor = -1.0)</em>
  32 \n <b>Arguments:</b> Name + one or several shapes (vertex, edge, planar wire, face or
  33 shell) serving as base objects + 1 vector (for direction of the
  34 extrusion) + 1 value (dimension) + 1 optional value (scale factor for
  35 the opposite base).
  36 \n<b>Advanced options</b> \ref preview_anchor "Preview"
  37
  38 \image html extrusion1.png
  39
  40 \n Secondly, you can define the \b Extrusion by the <b>Base Shape(s)</b>
  41 and the \b Start and <b>End Point</b> of the \b Vector (in this way
  42 you don't need to create it in advance). Optionally you can define the
  43 <b>Scale Factor</b> to build extrusion with scaled opposite
  44 base. Scaling is possible only with 1D and 2D bases.
  45 \n <b> Both Directions </b> checkbox allows extruding the source
  46 object both forward and backward.  With this option scaling is not possible.
  47 \n <b>TUI Command:</b> <em>geompy.MakePrism(Base, Point1, Point2, theScaleFactor = -1.0)</em>
  48 \n <b>Arguments:</b> Name + one or several shapes (vertex, edge, planar wire, face or
  49 shell) serving as base objects + 2 vertices + 1 optional value (scale factor for
  50 the opposite base).
  51
  52 \image html extrusion2.png
  53
  54 \n Finally, you can define the \b Extrusion by the <b>Base Shape(s)</b>
  55 and the <b>DX, DY, DZ</b> Vector. Optionally you can define the
  56 <b>Scale Factor</b> to build extrusion with scaled opposite
  57 base. Scaling is possible only with 1D and 2D bases.\n
  58 <b>Both Directions</b> checkbox allows extruding the
  59 source objects both forward and backward. With this option scaling is not possible.
  60 \n <b>TUI Command:</b> <em>geompy.MakePrismDXDYDZ(Base, dx, dy, dz, theScaleFactor = -1.0)</em>
  61 \n <b>Arguments:</b> Name + one or several shapes (vertex, edge, planar wire, face or
  62 shell) serving as base objects + 3 axis directions + 1 optional value (scale factor for
  63 the opposite base).
  64
  65 \image html extrusion3.png
  66
  67 <b> Add thickness </b>
  68
  69 \n For all three ways of creation of a prism it is possible to add a thickness
  70 to the created prism (only when extruding an edge or wire).
  71
  72 \image html prism_with_thickness.png
  73
  74 You can choose the \b Thickness and the direction of the thickening. By default the material is added on
  75 the outside of the generated pipe.
  76
  77 \image html extrusion4.png
  78
  79 \n <b>TUI Command:</b> <em>geompy.Thicken(Shape, Thickness)</em>
  80 \n <b>Arguments:</b> A shape (shell or face only) and a thickness
  81
  82 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  83 \ref tui_creation_prism "Complex Geometric Objects".
  84
  85 */