Salome HOME
Fix bunch of issues for B-splines (#3155, #3156, #3157, #3159)
[modules/shaper.git] / src / SketchPlugin / doc / rotationFeature.rst
1 .. _sketchAngularCopy:
2 .. |rotate.icon|    image:: images/rotate.png
3
4 Angular copy
5 ============
6
7 Angular copy operation creates one or multiple copies of the sketch entities by rotation relative to a specified center point.
8
9 To create an Angular copy in the active Sketch:
10
11 #. select in the Main Menu *Sketch - > Angular copy* item  or
12 #. click |rotate.icon| **Angular copy** button in Sketch toolbar:
13
14 Property panel:
15
16 .. image:: images/Rotation_panel.png
17   :align: center
18
19 .. centered::
20    Angular copy
21
22 Input fields:
23
24 - **Segments** is the list of segments (lines, circles, arcs) selected in the view;
25 - **Center of rotation** is the center point selected in the view;
26 - **Full angle/Single angle** option:
27
28   .. image:: images/angle_up_full_32x32.png
29      :align: left
30   **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one).
31
32   .. image:: images/angle_up_full_32x32.png
33      :align: left
34   **Single angle**: angle step of rotation is equal to the defined angle.
35
36 - **Angle** is the angle of rotation.
37 - **Reversed** defines rotation direction. If checked - in a clockwise direction, otherwise - in a counterclockwise direction.
38 - **Total number of objects** is the total number of objects including the original one.
39
40
41 **TUI Command**:
42
43 .. py:function:: Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed)
44
45     :param list: A list of objects.
46     :param object: Center point.
47     :param real: Angle.
48     :param integer: Number of objects.
49     :param boolean: Full value flag.
50     :param boolean: Reversed flag.
51     :return: Result object.
52
53 Result
54 """"""
55
56 Created Angular copy appears in the view.
57
58 | The original and an angular copy objects are marked with a special sign.
59 | Copy objects are drawn with a thinner line.
60
61 .. image:: images/Rotation_res.png
62            :align: center
63
64 .. centered::
65    Created angular copy
66
67 **See Also** a sample TUI Script of :ref:`tui_create_rotation` operation.