Salome HOME
Merge branch HELP_DOCUMENTATION_EDITING into master.
[modules/shaper.git] / src / SketchPlugin / doc / translationFeature.rst
1
2 Linear copy
3 ===========
4
5 Linear copy operation creates one or multiple copies of the skecth entities along a vector defined by two points.
6
7 To create Linear copy in the active Sketch:
8
9 #. select in the Main Menu *Sketch - > Linear copy* item  or
10 #. click **Linear copy** button in Sketch toolbar:
11
12 .. image:: images/translate.png
13    :align: center
14
15 .. centered::
16    **Linear copy**  button
17
18 Property panel:
19
20 .. image:: images/Linear_panel.png
21   :align: center
22
23 .. centered::
24    Linear copy
25
26 Input fields:
27
28 - **Segments** is the list of segments (lines, circles, arcs) selected in the view.
29 - **Single value/Full value** option:
30
31   .. image:: images/translate_32x32.png
32      :align: left
33   **Single value**: step of translation is equal to the distance between the start and the end point.
34
35   .. image:: images/translate_full_32x32.png
36      :align: left
37   **Full value**: distance from the originals to the farthest copies is equal to the distance between the start and the end point.
38 - **Start point** is the initial point of translation vector.
39 - **End point** is the terminal point of translation vector.
40 - **Total number of objects** is the total number of objects including the original one.
41
42
43 **TUI Command**: *Sketch_1.addTranslation(Objects, Point1, Point2, NumberOfObjects, FullValue)*
44
45 **Arguments**:   list of objects + start and end points + number of objects + full value flag
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 the 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 a :ref:`tui_create_translation` operation.