Salome HOME
Added unit-tests for SHAPERSTUDY and SMESH check
[modules/shaper.git] / src / BuildPlugin / doc / vertexFeature.rst
1 .. |feature_vertex.icon|    image:: images/feature_vertex.png
2
3 Vertex
4 ======
5
6 Vertex feature creates one or several vertices using vertices already existing in other objects.
7
8 To create vertices in the active part:
9
10 #. select in the Main Menu *Build - > Vertex* item  or
11 #. click |feature_vertex.icon| **Vertex** button in the toolbar
12
13 The following property panel will be opened:
14
15 .. image:: images/Vertex.png
16   :align: center
17
18 .. centered::
19   Create vertices
20
21 Select one or several vertices in the viewer. It also allowed to select a whole sketch result in the object browser, then all start and end points of the sketch segments will be added into result. Checkbox **Compute intersections** forces to include intersection vertices of edges of the selected sketch.
22
23 **Apply** button creates vertices.
24
25 **Cancel** button cancels operation. 
26
27 **TUI Command**:
28
29 .. py:function:: model.addVertex(Part_doc, Shapes, Intersect)
30
31     :param part: The current part object.
32     :param list: A list of shapes.
33     :param bool: Intersect edges (applicable for sketch only). False by default.
34     :return: Result object.
35
36 Result
37 """"""
38
39 The result of the operation will be a set of vertices created from the selected shapes:
40
41 .. image:: images/CreateVertex.png
42   :align: center
43
44 .. centered::
45   Result of the operation.
46
47 **See Also** a sample TUI Script of :ref:`tui_create_vertex` operation.