Salome HOME
Corrections for the user's manual from the English language point of view
[modules/shaper.git] / src / FeaturesPlugin / doc / extrusionFuseFeature.rst
1
2 Extrusion Fuse
3 =============
4
5 Extrusion Fuse feature extrudes selected objects along their normals or the selected axis and fuses the result with other objects.
6
7 To perform Extrusion Fuse in the active part:
8
9 #. select in the Main Menu *Features - > Extrusion Fuse* item  or
10 #. click **Extrusion Fuse** button in the toolbar
11
12 .. image:: images/extrusion_fuse_btn.png
13    :align: center
14
15 .. centered::
16    **Extrusion Fuse** button
17
18 The following property panel will be opened:
19
20 .. image:: images/StartSketch.png
21   :align: center
22
23 .. centered::
24   Start sketch
25
26 There are two variants of the property panel for Extrusion Fuse depending on the chosen option:
27
28 .. image:: images/extrusion_by_sizes.png
29    :align: left
30 **By Sizes** extrudes objects by specifying sizes.
31
32 .. image:: images/extrusion_by_bounding_planes.png
33    :align: left
34 **By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
35
36
37 By sizes
38 --------
39
40 .. image:: images/ExtrusionFuse1.png
41   :align: center
42
43 .. centered::
44   Extrusion Fuse: definition by sizes
45
46 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
47 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
48 - **To size** - size for extrusion in the direction.
49 - **From size** - size for extrusion in the opposite direction.
50 - **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
51
52 **TUI Command**:  *model.addExtrusionFuse(part, objectsToExtrude, size, objectsToFuse);*
53
54 **Arguments**:   Part + list of objects for extrusion + size + list of objects to fuse with.
55
56 **TUI Command**:  *model.addExtrusionFuse(part, objects, direction, size, objectsToFuse);*
57
58 **Arguments**:   Part + list of objects for extrusion + direction + size + list of objects to fuse with.
59
60 **TUI Command**:  *model.addExtrusionFuse(part, objects, toSize, fromSize, objectsToFuse);*
61
62 **Arguments**:   Part + list of objects for extrusion + to size + from size + list of objects to fuse with.
63
64 **TUI Command**:  *model.addExtrusionFuse(part, objects, direction, toSize, fromSize, objectsToFuse);*
65
66 **Arguments**:   Part + list of objects for extrusion + direction + to size + from size + list of objects to fuse with.
67
68 Result
69 """"""
70
71 The Result of the operation will be an extruded shape:
72
73 .. image:: images/extrusion_fuse_by_sizes_result.png
74            :align: center
75
76 .. centered::
77    **Extrusion Fuse created**
78
79 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_sizes` operation.
80
81 By bounding planes
82 ------------------
83
84 .. image:: images/ExtrusionFuse2.png
85   :align: center
86
87 .. centered::
88   Extrusion Fuse: definition by bounding planes
89
90 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
91 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
92 - **To plane** - a planar face can be selected to bound extrusion from one side.
93 - **To offset** - offset for extrusion or for bounding plane, if selected.
94 - **From plane** - a planar face can be selected to bound extrusion from the other side.
95 - **From offset** - offset for extrusion or for bounding plane,  if selected.
96 - **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
97
98 **TUI Command**:  *model.addExtrusionFuse(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToFuse);*
99
100 **Arguments**:   Part + list of objects for extrusion + to object + to offset + from object + from offset + list of objects to fuse with.
101
102 **TUI Command**:  *model.addExtrusionFuse(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToFuse);*
103
104 **Arguments**:   Part + list of objects for extrusion + direction + to object + to offset + from object + from offset + list of objects to fuse with.
105
106 Result
107 """"""
108
109 The Result of the operation will be an extruded shape:
110
111 .. image:: images/extrusion_fuse_by_bounding_planes_result.png
112            :align: center
113
114 .. centered::
115    **Extrusion Fuse created**
116
117 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_bounding_planes` operation.