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