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