Salome HOME
Initial implementation of geometrical naming in the selector.
[modules/shaper.git] / src / SketchPlugin / doc / radiusFeature.rst
1
2 Radius constraint
3 =================
4
5 Radius constraint fixes the radius of circle or arc.
6
7 To create a Radius constraint in the active Sketch:
8
9 #. select in the Main Menu *Sketch - > Radius* item  or
10 #. click **Radius** button in Sketch toolbar:
11
12 .. image:: images/radius_constr.png
13    :align: center
14
15 .. centered::
16    **Radius**  button
17
18 Property panel:
19
20 .. image:: images/Radius_panel.png
21    :align: center
22
23 Input fields:
24
25 - **Circle or Arc** is the circle or arc selected in the view; 
26 - **Value** is a radius of the selected object, could be modified to set the desirable value
27 - **Text location** is a position of the radius value label relating to extension line (in the view)
28    .. image:: images/location_left.png
29       :align: left
30    **Left** inserts text at the left of the radius extension line.
31
32    .. image:: images/location_automatic.png
33       :align: left
34    **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left.
35
36    .. image:: images/location_right.png
37       :align: left
38    **Right** inserts text to the right of the radius extension line.
39
40 When circle or arc is selected, the radius value is displayed in the property panel and in the view.
41
42 When creating the constraint, after selection of the circle or arc at the first time :
43
44 - drag the radius presentation in the view to the desired position and click once;
45 - set desirable radius value in the input field in the view and press **Enter** or just press **Enter** to keep the current radius.
46
47 .. image:: images/Radius_field_view.png
48    :align: center
49
50 .. centered::
51    Radius input in the view
52
53 **TUI Command**: *Sketch_1.setRadius(CircleOrArc, Value)*
54
55 **Arguments**:  circle or arc circumference object + radius value
56
57 Result
58 """"""
59
60 Created Radius appears in the view.
61
62 .. image:: images/Radius_res.png
63            :align: center
64
65 .. centered::
66    Radius created
67
68 **See Also** a sample TUI Script of :ref:`tui_create_radius` operation.