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