Salome HOME
Fixes and unit-tests basing on the manual tests
[modules/shaper.git] / src / SketchPlugin / doc / angleFeature.rst
1
2 Angle constraint
3 ================
4
5 Angle constraint fixes the angle between two lines.
6
7 | Angle between two lines is seen as an angle between two vectors.
8 | Each line is treated as a vector with start and end points equal to those of the line.
9
10 To create an Angle constraint in the active Sketch:
11
12 #. select in the Main Menu *Sketch - > Angle* item  or
13 #. click **Angle** button in Sketch toolbar:
14
15 .. image:: images/angle_constr.png
16    :align: center
17
18 .. centered::
19    **Angle** button
20
21 Property panel:
22
23 .. image:: images/Angle_panel.png
24    :align: center
25
26 Input fields:
27
28 - **Line 1** is the first line selected in the view;
29 - **Line 2** is the second line selected in the view;
30 - **Value** is an angle between the lines, can be modified to set the desirable value;
31 - **Angle type** is a type of angle measurement:
32    .. image:: images/angle_direct.png
33       :align: left
34    **Direct** is the least angle between two lines;
35
36    .. image:: images/angle_complementary.png
37       :align: left
38    **Complementary** is 180°- Direct angle between two lines;
39
40    .. image:: images/angle_backward.png
41       :align: left
42    **Backward** is 360°- Direct angle between two lines.
43 - **Text location** is the position of the angle value label relatively to the angle line (in the view):
44    .. image:: images/location_left.png
45       :align: left
46    **Left** inserts text to the left of the angle line;
47
48    .. image:: images/location_automatic.png
49       :align: left
50    **Automatic** inserts text it the middle of the angle line if it has enough length, otherwise - to the left;
51
52    .. image:: images/location_right.png
53       :align: left
54    **Right** inserts text to the right of the angle line.
55
56 When both lines are selected, the angle value is displayed in the property panel and in the view.
57
58 When creating the constraint, after selection of two lines at the first time:
59
60 - drag the angle presentation in the view to the desired position and click once;
61 - set desirable angle value in the input field in the view and press **Enter** or just press **Enter** to keep the current angle
62
63 .. image:: images/Angle_field_view.png
64    :align: center
65
66 .. centered::
67    Angle input in the view
68
69 **TUI Command**:
70
71 - *Sketch_1.setAngle(Line1, Line2, Value)*
72 - *Sketch_1.setAngleComplementary(Line1, Line2, Value)*
73 - *Sketch_1.setAngleBackward(Line1, Line2, Value)*
74
75 **Arguments**:  2 lines + angle value
76
77 Result
78 """"""
79
80 Created Angle appears in the view.
81
82 .. image:: images/Angle_res.png
83            :align: center
84
85 .. centered::
86    Angle created
87
88 **See Also** a sample TUI Script of :ref:`tui_create_angle` operation.