Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / SketchPlugin / doc / pointFeature.rst
1 .. |point.icon|    image:: images/Point.png
2
3 Point
4 =====
5
6 Point feature creates a point in the current Sketch.
7
8 To add a new Point to the Sketch:
9
10 #. select in the Main Menu *Sketch - > Point* item  or
11 #. click |point.icon| **Point** button in Sketch toolbar:
12
13 The following property panel appears:
14
15 .. image:: images/Point_panel.png
16   :align: center
17
18 .. centered::
19    Point
20
21 Clicking in the view creates a point preview. If an existing object is clicked, a constraint for
22 the point will be created automatically.
23
24 The point coordinates are displayed in the property panel.
25
26 **TUI Command**:
27
28 .. py:function:: Sketch_1.addPoint(X, Y)
29
30     :param real: X value.
31     :param real: Y value.
32     :return: Result object.
33
34 Result
35 """"""
36
37 Created point appears in the view.
38
39 .. image:: images/Point_res.png
40            :align: center
41
42 .. centered::
43    Point created
44
45 **See Also** a sample TUI Script of :ref:`tui_create_point` operation.