Salome HOME
d1b85f14c1403177664b6b3670cee436ced36fbc
[modules/shaper.git] / src / FeaturesPlugin / doc / extrusionFeature.rst
1 .. _featureExtrusion:
2
3 Extrusion
4 =========
5
6 Extrusion feature extrudes selected objects along their normals or selected axis.
7
8 To perform Extrusion in the active part:
9
10 #. select in the Main Menu *Features - > Extrusion* item  or
11 #. click **Extrusion** button in the toolbar
12
13 .. image:: images/extrusion_btn.png
14    :align: center
15
16 .. centered::
17    **Extrusion** button
18
19 The following property panel will be opened:
20
21 .. image:: images/StartSketch.png
22   :align: center
23
24 .. centered::
25   Start sketch
26
27 After selecting one of the options property panel for Extrusion will be opened with two variants:
28
29 .. image:: images/extrusion_by_sizes.png
30    :align: left
31 **By Sizes** extrudes objects by specifying sizes.
32
33 .. image:: images/extrusion_by_bounding_planes.png
34    :align: left
35 **By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
36
37
38 Simple
39 ------
40
41 .. image:: images/Extrusion1.png
42   :align: center
43
44 .. centered::
45   Extrusion: definition by sizes
46
47 - **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
48 - **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
49 - **To size** size for extrusion along direction.
50 - **From size** size for extrusion in opposite direction.
51
52 **TUI Command**:  *model.addExtrusion(part, objects, size);*
53
54 **Arguments**:   Part + list of objects + size.
55
56 **TUI Command**:  *model.addExtrusion(part, objects, direction, size);*
57
58 **Arguments**:   Part + list of objects + direction + size.
59
60 **TUI Command**:  *model.addExtrusion(part, objects, toSize, fromSize);*
61
62 **Arguments**:   Part + list of objects + to size + from size.
63
64 **TUI Command**:  *model.addExtrusion(part, objects, direction, toSize, fromSize);*
65
66 **Arguments**:   Part + list of objects + direction + to size + from size.
67
68 Result
69 """"""
70
71 The Result of the operation will be an extruded shape:
72
73 .. image:: images/extrusion_result.png
74            :align: center
75
76 .. centered::
77    **Extrusion created**
78
79 **See Also** a sample TUI Script of a :ref:`tui_create_extrusion` operation.
80
81
82
83
84 .. image:: images/Extrusion2.png
85   :align: center
86
87 .. centered::
88   Extrusion: definition by bounding planes