Salome HOME
Implementation of shared faces inspection, bos #29568
[modules/shaper.git] / src / FeaturesPlugin / doc / checkSharedFaceFeature.rst
1 .. |shared_shapes.icon|    image:: images/shared_shapes.png
2
3 Check shared faces
4 ==================
5
6 The **Check shared faces** feature find the shared faces within a composolid or compound.
7
8 The result is a list of faces and a group that can be created with a specified name.
9
10 To check shared faces in the active part:
11
12 #. Select in the Main Menu *Inspection - > Check shared faces* item  or
13 #. Click |shared_shapes.icon| **Check shared faces** button in the toolbar
14
15 The property panel is shown below.
16
17 .. figure:: images/checkSharedFacesPropertyPanel.png
18    :align: center
19
20    Check shared faces
21
22
23 Input fields:
24
25 - **Object** contains composolid or compound selected in 3D OCC viewer or object browser.
26 - **Number of shared faces** indicate the number of found faces.
27 - **List of faces** the list of found faces.
28 - **Transparency** set the transparency of selected object.
29 - **Create group** check-box that allows the creation of the found faces group.
30 - **Group name**  specifies the name of the group created.
31
32
33 **TUI Command**:
34
35 .. py:function:: model.getSharedFaces(Part_doc, shape, nameGroup)
36
37     :param part: The current part object.
38     :param object: A composolid or compound in format *model.selection(TYPE, shape)*.
39     :param string: The name of group to create
40     :return: Created group.
41
42 Result
43 """"""
44
45 Result of **Check shared faces** where **Create group** is checked.
46
47 .. figure:: images/sharedFacesResult.png
48    :align: center
49
50    Shared faces
51
52 **See Also** a sample TUI Script of :ref:`tui_shared_faces` operation.