Salome HOME
Merge branch 'fbt/addAngleInCylPrimitive'
[modules/geom.git] / doc / salome / gui / GEOM / input / multi_translation_operation.doc
index 5bd20ff659fbf9f99ea6d08d11ba8d733632809c..785ca2cdbbd5079434df4248270993171d026ff3 100644 (file)
@@ -7,26 +7,64 @@ select <b>Operations - > Transformation - > Multi Translation</b>
 
 \n This operation makes several translations of a shape in \b one or \b
 two directions.
-\n The \b Result will be one or several \b GEOM_Objects (compound).
+\n The \b Result will be one \b GEOM_Object (compound). The total
+number of shape copies in the resulting compound will be equal to:
+- in case of \ref single_multi_translation "Simple multi translation":
+\a NbTimes (if \a NbTimes parameter is equal to 1, the result will
+contain only the initial non-translated shape). 
+- in case of \ref double_multi_translation "Double multi translation":
+\a NbTimes1 x \a NbTimes2 (if \a NbTimes1 and \a NbTimes2 parameters
+are both equal to 1, the result will contain a single non-translated
+initial shape). 
+
+\anchor single_multi_translation
+
+In case of  <b>Simple Multi Translation</b> the object is translated in one direction. 
+
+\image html mtrans1.png
+
+The following parameters and options can be defined in this dialog:
+- <b>Result Name</b>;
+- <b> Main Object </b> to be translated;
+- \b Vector of translation (DX by default). If a curve has been
+selected instead of the Vector, only its first and last vertices will
+be used to get the vector direction and the dialog preview will
+display the vector along which the object will be translated;
+- <b>Step</b> is the distance between the shape copies;
+- <b>Nb. Times</b> is the number of shape copies;
+- <b>Reverse Direction </b> checkbox allows changing the direction of translation;
+- \ref restore_presentation_parameters_page "Advanced options".
+
+\image html multi_translation_initialsn.png "The initial object"
+
+\image html multi_translation1dsn.png "The result of a simple multi-translation"
 
-\n To produce a <b>Simple Multi Translation</b> (in one direction) you
-need to indicate an \b Object to be translated, a \b Vector of
-translation, a \b Step of translation and a <b>Number of Times</b> the
-Object should be duplicated.
 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation1D(Shape, Dir,
 Step, NbTimes)</em>
 \n <b>Arguments:</b> Name + 1 shape + 1 vector (for direction) + 1
 step value + 1 value (repetition).
 
-\image html mtrans1.png
+\anchor double_multi_translation
 
-\image html multi_translation_initialsn.png
+In case of  <b>Double Multi Translation</b> the object is translated in two directions. 
 
-\image html multi_translation1dsn.png
+\image html mtrans2.png
+
+The following parameters and options can be defined in this dialog:
+- <b>Result Name</b>;
+- <b> Main Object </b> to be translated;
+- <b> Vector U/V</b> of translation (DX and DY by default). If a curve has been
+selected instead of the Vector, only its first and last vertices will
+be used to get the vector direction and the dialog preview will
+display the vector along which the object will be translated;
+- <b>Step U/V</b> is the distance between the shape copies;
+- <b>Nb. Times U/V</b> is the number of shape copies;
+- <b>Reverse U/V </b> checkbox allows changing the direction of translation;
+- \ref restore_presentation_parameters_page "Advanced options".
 
-\n To produce a <b>Double Multi Translation</b> (in two directions) you need to
-indicate an \b Object to be translated, and, for both axes, a \b
-Vector of translation, a \b Step of translation and a <b>Number of Times</b> the shape must be duplicated.
+\image html multi_translation_initialsn.png "The initial object"
+
+\image html multi_translation2dsn.png "The result of a double multi-translation"
 
 \n <b>TUI Command:</b> <em>geompy.MakeMultiTranslation2D(Shape, Dir1,
 Step1, NbTimes1, Dir2, Step2, NbTimes2),</em> where \em Shape is a shape
@@ -38,12 +76,6 @@ along \em Dir2.
 \n <b>Arguments:</b> Name + 1 shape + 2 vectors defining the direction
 + 2 step values + 2 values (repetitions).
 
-\image html mtrans2.png
-
-\image html multi_translation_initialsn.png
-
-\image html multi_translation2dsn.png
-
 Our <b>TUI Scripts</b> provide you with useful examples of the use of
 \ref tui_multi_translation "Transformation Operations".