src/FeaturesPlugin/doc/angularCopyFeature.rst

   1 .. _featureAngularCopy:
   2 .. |multirotation.icon|    image:: images/multirotation.png
   3
   4 Angular copy
   5 ============
   6
   7 The feature **Angular copy** makes a compound of several rotated shapes basing on the initial shape.
   8
   9 To create an Angular copy in the active part:
  10
  11 #. select in the Main Menu *Part - > Angular copy* item  or
  12 #. click |multirotation.icon| **Angular copy** button in the toolbar
  13
  14 The following property panel appears.
  15
  16 .. image:: images/angularcopy.png
  17   :align: center
  18
  19 .. centered::
  20   Angular copy property panel
  21
  22 Input fields:
  23
  24 - **Main objects** panel contains shapes to be rotated. The shapes are selected in 3D OCC viewer or object browser;
  25 - **Vector of rotation**  defines the axis of rotation. The vector of rotation is an edge, axis selected in 3D OCC viewer or object browser;
  26 - **Angular Step** check-box turns on/off definition of the angle by which the object is rotated. By default (if the checkbox is not checked), **Angular Step** = 2 * PI / NbTimes;
  27 - **Nb. Copies** defines the number of rotated shape copies in the resulting compound. If **Nb. Copies** = 1, the result contains only the initial shape.
  28
  29 **TUI Command**:
  30
  31 .. py:function:: model.addMultiRotation(Part_doc, [shape], axis, step, Nb)*
  32
  33     :param part: The current part object
  34     :param list: A list of shapes in format *model.selection(TYPE, shape)*
  35     :param object: An axis in format *model.selection(TYPE, shape)*
  36     :param real: a step value
  37     :param integer: A number of copies
  38     :return: Created object
  39
  40 Result
  41 """"""
  42 Result of cylinder rotation is a compound.
  43
  44 .. image:: images/angularcopycyl.png
  45    :align: center
  46
  47 .. centered::
  48    Angular copy
  49
  50 **See Also** a sample TUI Script of :ref:`tui_create_angularcopy` operation.