Salome HOME
Merge remote-tracking branch 'remotes/origin/EDF_2020_Lot2'
[modules/shaper.git] / src / FeaturesPlugin / doc / fillet1dFeature.rst
1 .. |fillet1d.icon|    image:: images/fillet1d.png
2
3 .. _featureFillet1D:
4
5 1D-fillet
6 =========
7
8 **1D-fillet** feature creates fillets on the vertices of a wire. 
9 The fillet may be performed on sharp corners of a wire, which are shared exactly between 2 edges, and which are placed ona single plane. 
10
11 To create a 1D-fillet in the active part:
12
13 #. select in the Main Menu *Feature - > 1D-fillet* item  or
14 #. click |fillet1d.icon| **1D-fillet** button in the toolbar
15
16 There are 2 types of fillet:
17
18   .. image:: images/fillet1d_wire.png   
19     :align: left
20   fillet all sharp corners on a wire
21
22   .. image:: images/fillet1d_points.png   
23     :align: left
24   fillet only the specified corners
25
26 Fillet a wire
27 -------------
28
29 The property panel for this mode is shown below.
30
31 .. image:: images/Fillet1DPanel_Wire.png
32   :align: center
33
34 .. centered::
35   Property panel of an operation to fillet all sharp corners on a wire
36
37 Input fields:
38
39 - **Wires** panel contains the list of wires for the operation. The fillet will be performed to the applicable corners. If the wire has no such corner, the error message will be shown;
40 - **Radius** defines the fillet radius.
41
42 **TUI Command**:
43
44 .. py:function:: model.addFillet(Part_doc, [wires], radius)
45
46     :param part: The current part object.
47     :param list: A list of wires subject to fillet operation in format *model.selection(TYPE, shape)*.
48     :param number: Radius value.
49     :return: Created object.
50
51 Result
52 """"""
53
54 Result of **Fillet a wire** is shown below. In this case all vertices were sharp, thus, filleted.
55
56 .. image:: images/Fillet1DResult_Wire.png
57    :align: center
58
59 .. centered::
60    Result of filleting a wire
61
62 **See Also** a sample TUI Script of :ref:`tui_create_fillet1d_wire` operation.
63
64 Fillet the specified vertices on a wire
65 ---------------------------------------
66
67 Alternatively, there is a possibility to create a fillet on a special sharp corners of a wire.
68
69 .. image:: images/Fillet1DPanel_Vertices.png
70   :align: center
71
72 .. centered::
73   Property panel to fillet the specified vertices of a wire
74
75 Input fields:
76
77 - **Vertices** panel contains list of vertices on a wires applicable for fillet operation;
78 - **Radius** defines the fillet radius.
79
80 **TUI Command**:
81
82 .. py:function:: model.addFillet(Part_doc, [vertices], radius)
83
84     :param part: The current part object.
85     :param list: A list of vertices subject to fillet operation in format *model.selection(TYPE, shape)*.
86     :param number: Radius value.
87     :return: Created object.
88
89 Result
90 """"""
91
92 Result of **Fillet by vertices** is shown below. The only 2 corners of the wire become smooth.
93
94 .. image:: images/Fillet1DResult_Vertices.png
95    :align: center
96
97 .. centered::
98    Result of filleting the specified vertices of a wire
99
100 **See Also** a sample TUI Script of :ref:`tui_create_fillet1d_vertices` operation.