doc/salome/gui/GEOM/input/translation_operation.doc

   1 /*!
   2
   3 \page translation_operation_page Translation
   4
   5 \n To produce a \b Translation in the <b>Main Menu</b> select
   6 <b>Operations - > Transformation - > Translation</b>
   7
   8 This Operation makes a translation of an \b Object. To translate a
   9 shape you need to define the base shape and the coordinates of the
  10 vector of translation.
  11 \n <b>Create a copy</b> checkbox allows to keep the initial object, otherwise it will be removed.
  12 \n \ref restore_presentation_parameters_page "Advanced options".
  13 \n The \b Result of all operations will be any \b GEOM_Object.
  14
  15 The \b Vector of translation can be defined in three different ways selectable using the radio buttons.
  16
  17 \n Firstly you can define the \b Vector by coordinates along the
  18 axes.
  19 \n <b>TUI Command:</b> <em>geompy.MakeTranslation(Shape, DX, DY,
  20 DZ),</em> where Shape is a shape to be translated, DX, DY, DZ are
  21 components of translation vector.
  22 \n <b>Arguments:</b> Name + one or several objects + 3 values (coordinates).
  23
  24 \image html transformation1.png
  25
  26 \n Secondly you can define the \b Vector by the start and the end points.
  27 \n <b>TUI Command:</b> <em>geompy.MakeTranslationTwoPoints(Object, Point1, Point2)</em>
  28 \n <b>Arguments:</b> Name + one or several objects + 2 vertices
  29
  30
  31 \image html transformation2.png
  32
  33 \n Finally you can define the \b Vector explicitely. The \b Object will be translated by the length of the vector.
  34 If a curve has been selected instead of the vector, only its first and last vertices will be used to get the vector direction and the dialog preview will display the vector along which the object will be translated.
  35 \n <b>Activate Distance</b> checkbox and <b>Distance</b> field allow defining a custom distance of translation.
  36
  37
  38 \n <b>TUI Command:</b> for translation by vector: <em>geompy.MakeTranslationVector(Object, Vector)</em>
  39 \n <b>TUI Command </b> for translation by vector and a custom distance: <em>geompy.MakeTranslationVectorDistance(Object, Vector, Distance)</em>
  40 \n <b>Arguments:</b> Name + one or several objects + 1 vector.
  41
  42 \image html transformation3.png
  43
  44 \n <b>Example:</b>
  45
  46 \image html translationsn1.png "The initial shape (grey)"
  47
  48 \image html translationsn2.png "The resulting shape (yellow)"
  49
  50 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  51 \ref tui_translation "Transformation Operations".
  52
  53 */