src/SketchPlugin/doc/translationFeature.rst

   1 .. |translate.icon|    image:: images/translate.png
   2
   3 Linear copy
   4 ===========
   5
   6 Linear copy operation creates one or multiple copies of the sketch entities along a vector defined by two points.
   7
   8 To create a Linear copy in the active Sketch:
   9
  10 #. select in the Main Menu *Sketch - > Linear copy* item  or
  11 #. click |translate.icon| **Linear copy** button in Sketch toolbar:
  12
  13 Property panel:
  14
  15 .. image:: images/Linear_panel.png
  16   :align: center
  17
  18 .. centered::
  19    Linear copy
  20
  21
  22 .. |single_value| image:: images/translate_32x32.png
  23 .. |full_value| image:: images/translate_full_32x32.png
  24
  25 Input fields:
  26
  27 - **Segments** is the list of segments (lines, circles, arcs) selected in the view.
  28 - **Single value/Full value** option:
  29    | |single_value| **Single value**: step of translation is equal to the distance between the start and the end point.
  30    | |full_value| **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point.
  31 - **Start point** is the initial point of translation vector.
  32 - **End point** is the terminal point of translation vector.
  33 - **Total number of objects** is the total number of objects including the original one.
  34
  35
  36 **TUI Command**:
  37
  38 .. py:function:: Sketch_1.addTranslation(Objects, Point1, Point2, NumberOfObjects, FullValue)
  39
  40     :param list: A list of objects.
  41     :param object: Start point.
  42     :param object: End point.
  43     :param integer: Number of objects.
  44     :param boolean: Full value flag.
  45     :return: Result object.
  46
  47 Result
  48 """"""
  49
  50 Created Linear copy appears in the view.
  51
  52 | The original and a linear copy objects are marked with a special sign.
  53 | Copy objects are drawn with a thinner line.
  54
  55 .. image:: images/Linear_res.png
  56            :align: center
  57
  58 .. centered::
  59    Linear copy created
  60
  61 **See Also** a sample TUI Script of :ref:`tui_create_translation` operation.