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