[EDF] (2023-T1) Sketch middle point constrain should create point if missing

[modules/shaper.git] / src / SketchPlugin / doc / middleFeature.rst

diff --git a/src/SketchPlugin/doc/middleFeature.rst b/src/SketchPlugin/doc/middleFeature.rst
index 70efffd9b7289b93d2cdf8d507181eb5b74fb822..a6d0142f81a810bb34152d9c8551e108e2a11abe 100644 (file)
--- a/src/SketchPlugin/doc/middleFeature.rst
+++ b/src/SketchPlugin/doc/middleFeature.rst
@@ -10,9 +10,27 @@ To create a Middle point in the active Sketch:
 #. select in the Main Menu *Sketch - > Middle point* item  or
 #. click |middlepoint.icon| **Middle point** button in Sketch toolbar:
 
+There are 2 algorithms for creation of a middle constraint:
+
+.. figure:: images/MiddlePoint.png
+   :align: left
+   :height: 24px
+
+**By object and point** create a middle constraint by object (segment or arc) and point
+
+.. figure:: images/MiddlePoint_obj.png
+   :align: left
+   :height: 24px
+
+**By object** create a middle point on the object (segment or arc)
+
+-------------------------------------------------------------------------------------------
+
+By object and point
+""""""""""""""""""""""""""
 Property panel:
 
-.. image:: images/Middlepoint_panel.png
+.. figure:: images/Middlepoint_obj_point_panel.png
    :align: center
 
 Input fields:
@@ -38,10 +56,40 @@ Result
 
 Created Middle point constraint appears in the view.
 
-.. image:: images/Middlepoint_res.png
-          :align: center
+.. figure:: images/Middlepoint_obj_point_res.png
+   :align: center
+
+   Created middle point constraint
+
+By object
+""""""""""""""""""""""""""
+Property panel:
+
+.. figure:: images/Middlepoint_obj_panel.png
+   :align: center
+
+Input fields:
+
+- **Object** is a line selected in the view.
+
+| After the object are selected, will be created auxiliary point on the middle of the line.
+| The middle points are marked with a special sign.
+
+**TUI Command**:
+
+.. py:function:: SketchPoint_1 = Sketch_1.setMiddlePoint(Line)
+
+    :param object: A line.
+    :return: Created middle point.
+
+Result
+""""""
+
+Created Middle point constraint appears in the view.
+
+.. figure:: images/Middlepoint_obj_res.png
+   :align: center
 
-.. centered::
    Created middle point constraint
 
 **See Also** a sample TUI Script of :ref:`tui_create_middle` operation.