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. <b>Create a copy</b> checkbox allows to keep the
  11 initial object, otherwise it will be removed.
  12 \n The \b Result of all operations will be any \b GEOM_Object.
  13
  14 \n Firstly you can define an \b Object and the vector coordinates along the
  15 axes.
  16 \n <b>TUI Command:</b> <em>geompy.MakeTranslation(Shape, DX, DY,
  17 DZ),</em> where Shape is a shape to be translated, DX, DY, DZ are
  18 components of translation vector.
  19 \n <b>Arguments:</b> Name + one or several objects + 3 values (coordinates).
  20 \n <b>Advanced option:</b>
  21    \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
  22
  23 \image html transformation1.png
  24
  25 \n Secondly you can define an \b Object and the start and the end points
  26 of the vector.
  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 \n <b>Advanced option:</b>
  30    \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
  31
  32 \image html transformation2.png
  33
  34 \n Finally you can define an \b Object and a vector. The object will be translated by the length of the vector.
  35 If a curve has been selected instead of the vector, only its first and last vertices will be used to get the vector direction
  36 and the dialog preview will display the vector along which the object will be translated.
  37 \n <b>TUI Command:</b> <em>geompy.MakeTranslationVector(Object, Vector)</em>
  38 \n <b>Activate Distance</b> checkbox and <b>Distance</b> field allow defining the custom distance of translation.
  39 \n <b>TUI Command </b> for translation by vector and custom distance: <em>geompy.MakeTranslationVectorDistance(Object, Vector, Distance)</em>
  40 \n <b>Arguments:</b> Name + one or several objects + 1 vector.
  41 \n <b>Advanced option:</b>
  42    \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
  43
  44 \image html transformation3.png
  45
  46 \n <b>Example:</b>
  47
  48 \image html translationsn1.png "The initial shape (grey)"
  49
  50 \image html translationsn2.png "The resulting shape (yellow)"
  51
  52 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  53 \ref tui_translation "Transformation Operations".
  54
  55 */