Salome HOME
Change icons for chamfer
[modules/shaper.git] / 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 Input fields:
22
23 - **Segments** is the list of segments (lines, circles, arcs) selected in the view.
24 - **Single value/Full value** option:
25
26   .. image:: images/translate_32x32.png
27      :align: left
28   **Single value**: step of translation is equal to the distance between the start and the end point.
29
30   .. image:: images/translate_full_32x32.png
31      :align: left
32   **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point.
33 - **Start point** is the initial point of translation vector.
34 - **End point** is the terminal point of translation vector.
35 - **Total number of objects** is the total number of objects including the original one.
36
37
38 **TUI Command**:
39
40 .. py:function:: Sketch_1.addTranslation(Objects, Point1, Point2, NumberOfObjects, FullValue)
41
42     :param list: A list of objects.
43     :param object: Start point.
44     :param object: End point.
45     :param integer: Number of objects.
46     :param boolean: Full value flag.
47     :return: Result object.
48
49 Result
50 """"""
51
52 Created Linear copy appears in the view.
53
54 | The original and a linear copy objects are marked with a special sign.
55 | Copy objects are drawn with a thinner line.
56
57 .. image:: images/Linear_res.png
58            :align: center
59
60 .. centered::
61    Linear copy created
62
63 **See Also** a sample TUI Script of :ref:`tui_create_translation` operation.