doc/salome/gui/GEOM/input/multi_translation_operation.doc

   1 /*!
   2
   3 \page multi_translation_operation_page Multi Translation
   4
   5 \n To produce a <b>Multi Translation</b> in the <b>Main Menu</b>
   6 select <b>Operations - > Transformation - > Multi Translation</b>
   7
   8 \n This operation makes several translations of a shape in \b one or \b
   9 two directions.
  10 \n The \b Result will be one \b GEOM_Object (compound). The total
  11 number of shape copies in the resulting compound will be equal to:
  12 - in case of \ref single_multi_translation "Single multi translation":
  13 \a NbTimes (if \a NbTimes parameter is equal to 1, the result will
  14 contain only the initial non-translated shape).
  15 - in case of \ref double_multi_translation "Double multi translation":
  16 \a NbTimes1 x \a NbTimes2 (if \a NbTimes1 and \a NbTimes2 parameters
  17 are both equal to 1, the result will contain a single non-translated
  18 initial shape).
  19
  20 \anchor single_multi_translation
  21 \n To produce a <b>Simple Multi Translation</b> (in one direction) you
  22 need to indicate an \b Object to be translated, a \b Vector of
  23 translation (DX by default), a \b Step of translation and a <b>Number
  24 of Times</b> the Object should be duplicated. If a curve has been
  25 selected instead of the Vector, only its first and last vertices will
  26 be used to get the vector direction and the dialog preview will
  27 display the vector along which the object will be translated.
  28
  29 \image html mtrans1.png
  30
  31 \image html multi_translation_initialsn.png "The initial object"
  32
  33 \image html multi_translation1dsn.png "The result of a simple multi-translation"
  34
  35 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation1D(Shape, Dir,
  36 Step, NbTimes)</em>
  37 \n <b>Arguments:</b> Name + 1 shape + 1 vector (for direction) + 1
  38 step value + 1 value (repetition).
  39
  40 \anchor double_multi_translation
  41 \n To produce a <b>Double Multi Translation</b> (in two directions) you need to
  42 indicate an \b Object to be translated, and, for both axes, a \b
  43 Vector of translation (DX and DY by default), a \b Step of translation
  44 and a <b>Number of Times</b> the shape must be duplicated.
  45 If a curve has been selected instead of the Vector, only its first and
  46 last vertices will be used to get the vector direction and the dialog
  47 preview will display the vector along which the object will be
  48 translated.
  49
  50 \image html mtrans2.png
  51
  52 \image html multi_translation_initialsn.png "The initial object"
  53
  54 \image html multi_translation2dsn.png "The result of a double multi-translation"
  55
  56 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation2D(Shape, Dir1,
  57 Step1, NbTimes1, Dir2, Step2, NbTimes2),</em> where \em Shape is a shape
  58 to be translated, \em Dir1 is the first direction of translation, \em Step1 of
  59 the first translation, \em NbTimes1 is a number of translations to be done
  60 along \em Dir1, \em Dir2 is the second direction of translation, \em Step2 of the
  61 second translation, \em NbTimes2 is a number of translations to be done
  62 along \em Dir2.
  63 \n <b>Arguments:</b> Name + 1 shape + 2 vectors defining the direction
  64 + 2 step values + 2 values (repetitions).
  65
  66 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  67 \ref tui_multi_translation "Transformation Operations".
  68
  69 */