]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/doc/sewingFeature.rst
Salome HOME
* added missing tests and documentation
[modules/shaper.git] / src / FeaturesPlugin / doc / sewingFeature.rst
1 .. |sewing_btn.icon|    image:: images/sewing_btn.png
2
3 .. _featureSewing:
4
5 Sewing
6 ======
7
8 Sewing feature unites several faces (possibly contained in a shell, solid or compound)
9 into one shell. Geometrically coincident (within a specified tolerance) edges (or parts
10 of edges) of different faces are replaced by one edge thus producing a shell or faces
11 with shared boundaries.
12
13 To perform the Sewing in the active part:
14
15 #. select in the Main Menu *Features - > Sewing* item  or
16 #. click |sewing_btn.icon| **Sewing** button in the toolbar
17
18 The following property panel will be opened:
19
20 .. figure:: images/Sewing.png
21    :align: center
22
23    **Sewing feature**
24
25 Input fields:
26
27 - **Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be sewn.
28 - **Tolerance** defines the tolerance to use for the Sewing operation.
29 - **Allow Non-Manifold** allows to create non-manifold shapes, if checked.
30 - **Always create a result** allows to always create a result shape, even if there was nothing sewn.
31
32 **TUI Command**:
33
34 .. py:function:: model.addSewing(Part_doc, objects, tolerance, allowNonManifold, createResult)
35
36     :param part: The current part object.
37     :param list: A list of objects.
38     :param real: The tolerance value to be used for the sewing.
39     :param boolean: Defines whether to allow non-manifold results.
40     :param boolean: Defines whether to always create a result.
41     :return: Created object.
42
43 Result
44 """"""
45
46 The Result of the operation will be a shape with all coincident edges being united:
47
48
49 **See Also** a sample TUI Script of :ref:`tui_create_sewing` operation.