Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.

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

diff --git a/src/SketchPlugin/doc/arcFeature.rst b/src/SketchPlugin/doc/arcFeature.rst
index 9139ea4db9c7980ba2520635ec00bf43862c4150..1abd7ecd97e35360c967fafbd398b1b51463bb54 100644 (file)
--- a/src/SketchPlugin/doc/arcFeature.rst
+++ b/src/SketchPlugin/doc/arcFeature.rst
@@ -10,24 +10,38 @@ To add a new Arc to the Sketch:
 #. select in the Main Menu *Sketch - > Arc* item  or
 #. click |arc.icon| **Arc** button in Sketch toolbar:
 
-There are 3 algorithms for creation of an Arc:
+There are 4 algorithms for creation of an Arc:
 
-.. image:: images/arc_base_32x32.png
+.. figure:: images/arc_base_32x32.png
    :align: left
+   :height: 24px
+
 **By center and two points** creates an arc segment with the given center passing from the start point to the end point on the circle.
 
-.. image:: images/arc_3pt_32x32.png
+.. figure:: images/arc_3pt_32x32.png
    :align: left
+   :height: 24px
+
 **By three points** creates an arc segment passing from the start point to end point through another point on the circle.
 
-.. image:: images/arc_tang_32x32.png
+.. figure:: images/arc_tang_32x32.png
    :align: left
+   :height: 24px
+
 **By tangent point and end point** creates an arc segment with the tangent point and the end point.
 
+.. figure:: images/arc_perp_32x32.png
+   :align: left
+   :height: 24px
+
+**By point on perpendicular line and end point** creates an arc segment perpendicular to a straight line with the start point, connected with boundary of this line, and the end point.
+
+-------------------------------------------------------------------------------------------
+
 By center and two points
 """"""""""""""""""""""""
 
-.. image:: images/Arc_panel_base.png
+.. figure:: images/Arc_panel_base.png
    :align: center
 
 Click in the view once to set the center point, then move the mouse and click a second time to set the start point
@@ -53,7 +67,7 @@ and finally move the mouse and click a third time to set the last passed point.
 By three points
 """""""""""""""
 
-.. image:: images/Arc_panel_3pt.png
+.. figure:: images/Arc_panel_3pt.png
    :align: center
 
 Click in the view once to set the start point, then move the mouse and click a second time to set the end point
@@ -75,10 +89,10 @@ and finally move the mouse and click a third time to set the passed point.
     :param real: Passed Y.
     :return: Result object.
 
-By tangent point and point
-""""""""""""""""""""""""""
+By tangent point and end point
+""""""""""""""""""""""""""""""
 
-.. image:: images/Arc_panel_tang.png
+.. figure:: images/Arc_panel_tang.png
    :align: center
 
 Select a point on segment in the view to set the tangent point, then move the mouse and click to set the end point.
@@ -90,23 +104,46 @@ The tangent point by itself is a start point. The edge on which it lies will be
 
 **TUI Command**:
 
-.. py:function:: Sketch_1.addArc(TangetPoint, EndX, EndY, Inversed)
+.. py:function:: Sketch_1.addArc(TangentPoint, EndX, EndY, Inversed)
 
-    :param object: Tanget Point.
+    :param object: Tangent Point.
     :param real: End X.
     :param real: End Y.
     :param boolean: Is inversed.
     :return: Result object.
 
+By point on perpendicular line and end point
+""""""""""""""""""""""""""""""""""""""""""""
+
+.. figure:: images/Arc_panel_perp.png
+   :align: center
+
+Select a point on a straight segment in the view to set the start point, then move the mouse and click to set the end point.
+The edge on which the start point lies will be perpendicular to the arc (the center of the arc is lying on the edge).
+
+- When entering a start point by selecting a point on segment, a Perpendicular constraint is created.
+- When entering an end point by selecting a segment, a Coincident constraint is created.
+- When entering an end point, only segments are selectable.
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.addArc(StartPoint, EndX, EndY, Inversed, True)
+
+    :param object: Start Point.
+    :param real: End X.
+    :param real: End Y.
+    :param boolean: Is inversed.
+    :param boolean: Arc is perpendicular (always True).
+    :return: Result object.
+
 Result
 """"""
 
 Created arc appears in the view.
 
-.. image:: images/Arc_res.png
-          :align: center
+.. figure:: images/Arc_res.png
+   :align: center
 
-.. centered::
-   Circle created
+   Arc created
 
-**See Also** a sample TUI Script of :ref:`tui_create_arc` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_arc` operation.