]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Little correction of the documentation for multi-translation and multi-rotation opera...
authorvsr <vsr@opencascade.com>
Thu, 19 Apr 2012 06:17:56 +0000 (06:17 +0000)
committervsr <vsr@opencascade.com>
Thu, 19 Apr 2012 06:17:56 +0000 (06:17 +0000)
doc/salome/gui/GEOM/input/multi_rotation_operation.doc
doc/salome/gui/GEOM/input/multi_translation_operation.doc

index eff4bac5d7175a82e68b28529fdc01a2c08ab12b..3891dabb02360deb2954d6dc0da661cc7e2edc98 100644 (file)
@@ -12,7 +12,9 @@ or two dimensions basing on the initial geometrical object.
 \n To produce a <b>Simple Multi Rotation</b> (in one dimension) you
 need to define a \b Shape to be rotated, an \b Axis of rotation and a
 <b>Number of Times</b> the shape must be rotated. <b>Rotation Angle</b> will
-be 2*PI/NbTimes
+be 2 * \a PI / \a NbTimes. Number of shapes in resulting compound will be equal
+to \a NbTimes (if \a NbTimes = 1, the result will contain single initial
+non-transformed shape).
 \n <b>TUI Command:</b> <em>geompy.MultiRotate1D(Shape, Axis, NbTimes)</em>
 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 value
 (repetition).
@@ -32,7 +34,10 @@ the same way, but the Axis is defined  by direction and point.
 \b Object around the given \b Axis on the given \b Angle a given
 <b>Number of Times</b> and multi-translates each rotation
 result. Translation direction passes through the center of gravity of
-the rotated shape and its projection on the rotation axis.
+the rotated shape and its projection on the rotation axis. Number of
+shapes in resulting compound will be equal to \a NbTimes1 x \a NbTimes2 (if
+both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain
+single initial non-transformed shape).
 \b Reverse checkbox allows to set the direction of rotation.
 \n <b>TUI Command:</b> <em>geompy.MultiRotate2D(Shape, Axis, Angle, NbTimes1, Step, NbTimes2)</em>
 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 angle
index 7e6d64f461aa1d28a653fa6030f7fac8b2a6df72..9afaaffb03ff969752489ba6249c244bac5c1e38 100644 (file)
@@ -7,8 +7,18 @@ 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 or several \b GEOM_Objects
+(compound). The total number of shapes in the resulting compound (for
+the single initial selected shape) will be equal to:
+- in case of \ref single_multi_translation "Single multi translation":
+\a NbTimes (if \a NbTimes parameter is equal to 1, the result will
+contain single, non-translated initial 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 single, non-translated
+initial shape). 
 
+\anchor single_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
@@ -26,6 +36,7 @@ step value + 1 value (repetition).
 
 \image html multi_translation1dsn.png "The result of a simple multi-translation"
 
+\anchor double_multi_translation
 \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.