Salome HOME
Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.
[modules/shaper.git] / src / SketchPlugin / doc / angleFeature.rst
index 6db160c07a0ac8b6b18d4f47190726af77d2bc95..1a552c54d8e7dd9749fd7abfc62ee78e64abaddc 100644 (file)
@@ -1,3 +1,4 @@
+.. |angle_constr.icon|    image:: images/angle_constr.png
 
 Angle constraint
 ================
@@ -10,48 +11,33 @@ Angle constraint fixes the angle between two lines.
 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:
 
-.. image:: images/Angle_panel.png
+.. figure:: images/Angle_panel.png
    :align: center
 
+.. |angle_direct| image:: images/angle_direct.png
+.. |angle_complement| image:: images/angle_complementary.png
+.. |angle_backward| image:: images/angle_backward.png
+.. |loc_left| image:: images/location_left.png
+.. |loc_auto| image:: images/location_automatic.png
+.. |loc_right| image:: images/location_right.png
+
 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, 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 the least angle between two lines;
-
-   .. image:: images/angle_complementary.png
-      :align: left
-   **Complementary** is 180°- Direct angle between two lines;
-
-   .. image:: images/angle_backward.png
-      :align: left
-   **Backward** is 360°- Direct angle between two lines.
+   | |angle_direct| **Direct** is the least angle between two lines;
+   | |angle_complement| **Complementary** is 180°- Direct angle between two lines;
+   | |angle_backward| **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 to the left of the angle line;
-
-   .. image:: images/location_automatic.png
-      :align: 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.
+   | |loc_left| **Left** inserts text to the left of the angle line;
+   | |loc_auto| **Automatic** inserts text it the middle of the angle line if it has enough length, otherwise - to the left;
+   | |loc_right| **Right** inserts text to the right of the angle line.
 
 When both lines are selected, the angle value is displayed in the property panel and in the view.
 
@@ -60,29 +46,30 @@ When creating the constraint, after selection of two lines at the first time:
 - 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
+.. figure:: images/Angle_field_view.png
    :align: center
 
-.. 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
 """"""
 
 Created Angle appears in the view.
 
-.. image:: images/Angle_res.png
-          :align: center
+.. figure:: images/Angle_res.png
+   :align: center
 
-.. 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.