Salome HOME
Merge branch 'master' of https://codev-tuleap.cea.fr/plugins/git/salome/shaper
[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 .. figure:: images/Vertex.png
16   :align: center
17
18   Create vertices
19
20 Select one or several vertices in the viewer. It is also possible to select a whole sketch result or feature 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.
21
22 **Apply** button creates vertices.
23
24 **Cancel** button cancels operation. 
25
26 **TUI Command**:
27
28 .. py:function:: model.addVertex(Part_doc, Shapes, Intersect)
29
30     :param part: The current part object.
31     :param list: A list of shapes.
32     :param bool: Intersect edges (applicable for sketch only). False by default.
33     :return: Result object.
34
35 Result
36 """"""
37
38 The result of the operation will be a set of vertices created from the selected shapes:
39
40 .. figure:: images/CreateVertex.png
41   :align: center
42
43   Result of the operation.
44
45 **See Also** a sample TUI Script of :ref:`tui_create_vertex` operation.