Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / SketchPlugin / doc / pointFeature.rst
index b344fcce0f9f09a54a41ef6805c97827e5baf46a..a7584fac8e004dff333b165184fd033fb48e3916 100644 (file)
@@ -1,10 +1,45 @@
+.. |point.icon|    image:: images/Point.png
 
 Point
 =====
 
+Point feature creates a point in the current Sketch.
 
-.. image:: images/Point.png
+To add a new Point to the Sketch:
+
+#. select in the Main Menu *Sketch - > Point* item  or
+#. click |point.icon| **Point** button in Sketch toolbar:
+
+The following property panel appears:
+
+.. image:: images/Point_panel.png
   :align: center
 
 .. centered::
-  Create a point
+   Point
+
+Clicking in the view creates a point preview. If an existing object is clicked, a constraint for
+the point will be created automatically.
+
+The point coordinates are displayed in the property panel.
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.addPoint(X, Y)
+
+    :param real: X value.
+    :param real: Y value.
+    :return: Result object.
+
+Result
+""""""
+
+Created point appears in the view.
+
+.. image:: images/Point_res.png
+          :align: center
+
+.. centered::
+   Point created
+
+**See Also** a sample TUI Script of :ref:`tui_create_point` operation.