+.. _featureTranslation:
+.. |translation_vector_32x32.icon| image:: images/translation_vector_32x32.png
+ :height: 16px
Translation
===========
-The feature **Translation** makes translation of a selected shape.
+**Translation** feature translates a selected shape.
-To create Translation in the active part:
+To create a Translation in the active part:
#. select in the Main Menu *Part - > Translation* item or
-#. click **Translation** button in the toolbar
+#. click |translation_vector_32x32.icon| **Translation** button in the toolbar
-.. image:: images/translation_vector_32x32.png
- :align: center
+The Vector of translation can be defined in three different ways:
-.. centered::
- **Translation** button
+.. image:: images/translation_vector_32x32.png
+ :align: left
+ :height: 24px
-The Vector of translation can be defined in three different ways:
+by by axis and distance
+
+.. image:: images/translation_dxyz_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/translation_vector_32x32.png
- :align: left
- by by axis and distance
+by vector
- .. image:: images/translation_dxyz_32x32.png
- :align: left
- by vector
+.. image:: images/translation_2pt_32x32.png
+ :align: left
+ :height: 24px
- .. image:: images/translation_2pt_32x32.png
- :align: left
- by two points
+by two points
+
+--------------------------------------------------------------------------------
Translation by axis and distance
--------------------------------
-.. image:: images/Translation1.png
+.. image:: images/Translation2.png
:align: center
.. centered::
Input fields:
-- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
-- **Axis** defines vector along which the object will be translated. Vector is edge, axis selected in 3D OCC viewer or object browser;
+- **Main objects** panel contains shapes to be translated. The shapes are selected in 3D OCC viewer or object browser;
+- **Axis** defines a vector along which the object will be translated. The vector is an edge or axis selected in 3D OCC viewer or object browser;
- **Distance** defines the distance along the **Vector of translation**.
-**TUI Command**: *model.addTranslation(Part_doc, [shape], axis, dist)*
+**TUI Command**:
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + axis in format *model.selection(TYPE, shape)*+ real (distance value).
+.. py:function:: model.addTranslation(Part_doc, [shape], axis, dist)
+
+ :param part: The current part object.
+ :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+ :param object: axis in format *model.selection(TYPE, shape)*.
+ :param real: Distance value.
+ :return: Result object.
Result
""""""
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
-.. image:: images/translation_vector.png
+.. image:: images/translation_XYZ.png
:align: center
.. centered::
Translation by vector
---------------------
-.. image:: images/Translation2.png
+.. image:: images/Translation1.png
:align: center
.. centered::
Input fields:
-- **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
+- **Main objects** panel contains shapes to be translated. The shapes are selected in 3D OCC viewer or object browser;
- **DX**, **DY**, **DZ** define vector using coordinates along the axis.
-**TUI Command**: *model.addTranslation(Part_1_doc, [shape], DX, DY, DZ)*
+**TUI Command**:
+
+.. py:function:: model.addTranslation(Part_1_doc, [shape], DX, DY, DZ)
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 3 real (coordinate values).
+ :param part: The current part object.
+ :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+ :param real: dX value.
+ :param real: dY value.
+ :param real: dZ value.
+ :return: Result object.
Result
""""""
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
.. image:: images/translation_vector.png
:align: center
.. centered::
Translation by vector
-**See Also** a sample TUI Script of a :ref:`tui_translation_DXDYDZ` operation.
+**See Also** a sample TUI Script of :ref:`tui_translation_DXDYDZ` operation.
Translation by two points
- **Start point** defines start vector point as point or vertex selected in 3D OCC viewer or object browser;
- **End point** defines end vector point as point or vertex selected in 3D OCC viewer or object browser;
-**TUI Command**: *model.addTranslation(Part_doc, [shape], point1, point2)*
+**TUI Command**:
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + 2 points in format *model.selection(TYPE, shape)*.
+.. py:function:: model.addTranslation(Part_doc, [shape], point1, point2)
+
+ :param part: The current part object.
+ :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+ :param object: A point in format *model.selection(TYPE, shape)*.
+ :param object: A point in format *model.selection(TYPE, shape)*.
+ :return: Result object.
Result
""""""
-Result of operation is shifted initial shape.
+The result of operation is a shifted initial shape.
-.. image:: images/translation_vector.png
+.. image:: images/translation_2points.png
:align: center
.. centered::
Translation by two points
-**See Also** a sample TUI Script of a :ref:`tui_translation_2points` operation.
+**See Also** a sample TUI Script of :ref:`tui_translation_2points` operation.
