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 "Simple 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
  22 In case of  <b>Simple Multi Translation</b> the object is translated in one direction.
  23
  24 \image html mtrans1.png
  25
  26 The following parameters and options can be defined in this dialog:
  27 - <b>Result Name</b>;
  28 - <b> Main Object </b> to be translated;
  29 - \b Vector of translation (DX by default). If a curve has been
  30 selected instead of the Vector, only its first and last vertices will
  31 be used to get the vector direction and the dialog preview will
  32 display the vector along which the object will be translated;
  33 - <b>Step</b> is the distance between the shape copies;
  34 - <b>Nb. Times</b> is the number of shape copies;
  35 - <b>Reverse Direction </b> checkbox allows changing the direction of translation;
  36 - \ref restore_presentation_parameters_page "Advanced options".
  37
  38 \image html multi_translation_initialsn.png "The initial object"
  39
  40 \image html multi_translation1dsn.png "The result of a simple multi-translation"
  41
  42 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation1D(Shape, Dir,
  43 Step, NbTimes)</em>
  44 \n <b>Arguments:</b> Name + 1 shape + 1 vector (for direction) + 1
  45 step value + 1 value (repetition).
  46
  47 \anchor double_multi_translation
  48
  49 In case of  <b>Double Multi Translation</b> the object is translated in two directions.
  50
  51 \image html mtrans2.png
  52
  53 The following parameters and options can be defined in this dialog:
  54 - <b>Result Name</b>;
  55 - <b> Main Object </b> to be translated;
  56 - <b> Vector U/V</b> of translation (DX and DY by default). If a curve has been
  57 selected instead of the Vector, only its first and last vertices will
  58 be used to get the vector direction and the dialog preview will
  59 display the vector along which the object will be translated;
  60 - <b>Step U/V</b> is the distance between the shape copies;
  61 - <b>Nb. Times U/V</b> is the number of shape copies;
  62 - <b>Reverse U/V </b> checkbox allows changing the direction of translation;
  63 - \ref restore_presentation_parameters_page "Advanced options".
  64
  65 \image html multi_translation_initialsn.png "The initial object"
  66
  67 \image html multi_translation2dsn.png "The result of a double multi-translation"
  68
  69 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation2D(Shape, Dir1,
  70 Step1, NbTimes1, Dir2, Step2, NbTimes2),</em> where \em Shape is a shape
  71 to be translated, \em Dir1 is the first direction of translation, \em Step1 of
  72 the first translation, \em NbTimes1 is a number of translations to be done
  73 along \em Dir1, \em Dir2 is the second direction of translation, \em Step2 of the
  74 second translation, \em NbTimes2 is a number of translations to be done
  75 along \em Dir2.
  76 \n <b>Arguments:</b> Name + 1 shape + 2 vectors defining the direction
  77 + 2 step values + 2 values (repetitions).
  78
  79 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  80 \ref tui_multi_translation "Transformation Operations".
  81
  82 */