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 .. |full_angle| image:: images/angle_up_full_32x32.png
  23 .. |single_angle| image:: images/angle_up_32x32.png
  24
  25 Input fields:
  26
  27 - **Segments** is the list of segments (lines, circles, arcs) selected in the view;
  28 - **Center of rotation** is the center point selected in the view;
  29 - **Full angle/Single angle** option:
  30    | |full_angle| **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one).
  31    | |single_angle| **Single angle**: angle step of rotation is equal to the defined angle.
  32 - **Angle** is the angle of rotation.
  33 - **Reversed** defines rotation direction. If checked - in a clockwise direction, otherwise - in a counterclockwise direction.
  34 - **Total number of objects** is the total number of objects including the original one.
  35
  36
  37 **TUI Command**:
  38
  39 .. py:function:: Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed)
  40
  41     :param list: A list of objects.
  42     :param object: Center point.
  43     :param real: Angle.
  44     :param integer: Number of objects.
  45     :param boolean: Full value flag.
  46     :param boolean: Reversed flag.
  47     :return: Result object.
  48
  49 Result
  50 """"""
  51
  52 Created Angular copy appears in the view.
  53
  54 | The original and an angular copy objects are marked with a special sign.
  55 | Copy objects are drawn with a thinner line.
  56
  57 .. image:: images/Rotation_res.png
  58            :align: center
  59
  60 .. centered::
  61    Created angular copy
  62
  63 **See Also** a sample TUI Script of :ref:`tui_create_rotation` operation.