Salome HOME
Ameliorate help pages
[modules/shaper.git] / src / SketchPlugin / doc / angleFeature.rst
index 624e1220d1b6dd62892c835b180b11c2756b8192..0847e20061ef6ae47c674cae2fbf1d58c7864e5d 100644 (file)
@@ -1,23 +1,17 @@
+.. |angle_constr.icon|    image:: images/angle_constr.png
 
 Angle constraint
 ================
 
-Angle constraint fixes angle between two lines.
+Angle constraint fixes the angle between two lines.
 
-| Angle between two lines is thought of as an angle between two vectors.
-| So each line is treated as a vector with starting point equal to the line start point
-and terminal point equal to the line end point.
+| Angle between two lines is seen as an angle between two vectors.
+| Each line is treated as a vector with start and end points equal to those of the line.
 
-To create Angle constraint in the active Sketch:
+To create an Angle constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Angle* item  or
-#. click **Angle** button in Sketch toolbar:
-
-.. image:: images/angle_constr.png
-   :align: center
-
-.. centered::
-   **Angle** button
+#. click |angle_constr.icon| **Angle** button in Sketch toolbar:
 
 Property panel:
 
@@ -26,39 +20,39 @@ Property panel:
 
 Input fields:
 
-- **Line 1** is the first line selected in the view
-- **Line 2** is the second line selected in the view
-- **Value** is an angle between the lines, could be modified to set the desirable value
-- **Angle type** is a type of angle measurement
+- **Line 1** is the first line selected in the view;
+- **Line 2** is the second line selected in the view;
+- **Value** is an angle between the lines, can be modified to set the desirable value;
+- **Angle type** is a type of angle measurement:
    .. image:: images/angle_direct.png
       :align: left
-   **Direct** is an angle type measured directly between two lines.
+   **Direct** is the least angle between two lines;
 
    .. image:: images/angle_complementary.png
       :align: left
-   **Complementary** zzzzzzzz.
+   **Complementary** is 180°- Direct angle between two lines;
 
    .. image:: images/angle_backward.png
       :align: left
-   **Backward** zzzzzzzz.
-- **Text location** is a position of the angle value label relating to angle line (in the view)
+   **Backward** is 360°- Direct angle between two lines.
+- **Text location** is the position of the angle value label relatively to the angle line (in the view):
    .. image:: images/location_left.png
       :align: left
-   **Left** inserts text at the left of the angle line.
+   **Left** inserts text to the left of the angle line;
 
    .. image:: images/location_automatic.png
       :align: left
-   **Automatic** inserts text at the middle of the angle line if it has enough length, otherwise - to the left.
+   **Automatic** inserts text it the middle of the angle line if it has enough length, otherwise - to the left;
 
    .. image:: images/location_right.png
       :align: left
    **Right** inserts text to the right of the angle line.
 
-When both lines are selected angle value is displayed in the property panel and in the view.
+When both lines are selected, the angle value is displayed in the property panel and in the view.
 
 When creating the constraint, after selection of two lines at the first time:
 
-- drag the angle presentation in the view to the desired position (by move mouse and click once)
+- drag the angle presentation in the view to the desired position and click once;
 - set desirable angle value in the input field in the view and press **Enter** or just press **Enter** to keep the current angle
 
 .. image:: images/Angle_field_view.png
@@ -67,13 +61,16 @@ When creating the constraint, after selection of two lines at the first time:
 .. centered::
    Angle input in the view
 
-**TUI Command**:
+**TUI Commands**:
 
-- *Sketch_1.setAngle(Line1, Line2, Value)*
-- *Sketch_1.setAngleComplementary(Line1, Line2, Value)*
-- *Sketch_1.setAngleBackward(Line1, Line2, Value)*
+.. py:function:: Sketch_1.setAngle(Line1, Line2, Value)
+.. py:function:: Sketch_1.setAngleComplementary(Line1, Line2, Value)
+.. py:function:: Sketch_1.setAngleBackward(Line1, Line2, Value)
 
-**Arguments**:  2 lines + angle value
+    :param object: Line 1.
+    :param object: Line 2.
+    :param real: Value.
+    :return: Result object.
 
 Result
 """"""
@@ -86,4 +83,4 @@ Created Angle appears in the view.
 .. centered::
    Angle created
 
-**See Also** a sample TUI Script of :ref:`tui_create_angle` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_angle` operation.
\ No newline at end of file