Salome HOME
Merge branch HELP_DOCUMENTATION_EDITING into master.
[modules/shaper.git] / src / SketchPlugin / doc / angleFeature.rst
index 004f80781de69525ba63f5b2f6926fb93d4ce9c4..624e1220d1b6dd62892c835b180b11c2756b8192 100644 (file)
@@ -2,9 +2,88 @@
 Angle constraint
 ================
 
+Angle constraint fixes angle between two lines.
 
-.. image:: images/Angle.png
-  :align: center
+| 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.
+
+To create 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
+
+Property panel:
+
+.. image:: images/Angle_panel.png
+   :align: center
+
+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
+   .. image:: images/angle_direct.png
+      :align: left
+   **Direct** is an angle type measured directly between two lines.
+
+   .. image:: images/angle_complementary.png
+      :align: left
+   **Complementary** zzzzzzzz.
+
+   .. 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)
+   .. image:: images/location_left.png
+      :align: left
+   **Left** inserts text at 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.
+
+   .. 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 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)
+- 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
+   :align: center
 
 .. centered::
-  Create an angle constraint
+   Angle input in the view
+
+**TUI Command**:
+
+- *Sketch_1.setAngle(Line1, Line2, Value)*
+- *Sketch_1.setAngleComplementary(Line1, Line2, Value)*
+- *Sketch_1.setAngleBackward(Line1, Line2, Value)*
+
+**Arguments**:  2 lines + angle value
+
+Result
+""""""
+
+Created Angle appears in the view.
+
+.. image:: images/Angle_res.png
+          :align: center
+
+.. centered::
+   Angle created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_angle` operation.
\ No newline at end of file