Salome HOME
2b8840a44d32a15932bfc53b956c88fdda85c2fa
[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 .. image:: images/Radius_panel.png
16    :align: center
17
18 Input fields:
19
20 - **Circle or Arc** is the circle or arc selected in the view; 
21 - **Value** is a radius of the selected object, could be modified to set the desirable value
22 - **Text location** is a position of the radius value label relating to extension line (in the view)
23    .. image:: images/location_left.png
24       :align: left
25    **Left** inserts text at the left of the radius extension line.
26
27    .. image:: images/location_automatic.png
28       :align: left
29    **Automatic** inserts text at the middle of the radius extension line if it has enough length, otherwise - to the left.
30
31    .. image:: images/location_right.png
32       :align: left
33    **Right** inserts text to the right of the radius extension line.
34
35 When circle or arc is selected, the radius value is displayed in the property panel and in the view.
36
37 When creating the constraint, after selection of the circle or arc at the first time :
38
39 - drag the radius presentation in the view to the desired position and click once;
40 - set desirable radius value in the input field in the view and press **Enter** or just press **Enter** to keep the current radius.
41
42 .. image:: images/Radius_field_view.png
43    :align: center
44
45 .. centered::
46    Radius input in the view
47
48 **TUI Command**:
49
50 .. py:function:: Sketch_1.setRadius(CircleOrArc, Value)
51
52     :param object: Circle or arc.
53     :param real: Radius.
54     :return: Result object.
55
56 Result
57 """"""
58
59 Created Radius appears in the view.
60
61 .. image:: images/Radius_res.png
62            :align: center
63
64 .. centered::
65    Radius created
66
67 **See Also** a sample TUI Script of :ref:`tui_create_radius` operation.