From: vsr Date: Thu, 19 Apr 2012 06:17:56 +0000 (+0000) Subject: Little correction of the documentation for multi-translation and multi-rotation opera... X-Git-Tag: TRIPOLI_323~19 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=85083a7b82a0b14ca2ed4ea15ebb81eaa65266c0;p=modules%2Fgeom.git Little correction of the documentation for multi-translation and multi-rotation operations --- diff --git a/doc/salome/gui/GEOM/input/multi_rotation_operation.doc b/doc/salome/gui/GEOM/input/multi_rotation_operation.doc index eff4bac5d..3891dabb0 100644 --- a/doc/salome/gui/GEOM/input/multi_rotation_operation.doc +++ b/doc/salome/gui/GEOM/input/multi_rotation_operation.doc @@ -12,7 +12,9 @@ or two dimensions basing on the initial geometrical object. \n To produce a Simple Multi Rotation (in one dimension) you need to define a \b Shape to be rotated, an \b Axis of rotation and a Number of Times the shape must be rotated. Rotation Angle 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 TUI Command: geompy.MultiRotate1D(Shape, Axis, NbTimes) \n Arguments: 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 Number of Times 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 TUI Command: geompy.MultiRotate2D(Shape, Axis, Angle, NbTimes1, Step, NbTimes2) \n Arguments: Name + 1 shape + 1 vector for direction + 1 angle diff --git a/doc/salome/gui/GEOM/input/multi_translation_operation.doc b/doc/salome/gui/GEOM/input/multi_translation_operation.doc index 7e6d64f46..9afaaffb0 100644 --- a/doc/salome/gui/GEOM/input/multi_translation_operation.doc +++ b/doc/salome/gui/GEOM/input/multi_translation_operation.doc @@ -7,8 +7,18 @@ select Operations - > Transformation - > Multi Translation \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 Simple Multi Translation (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 Number of Times 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 Double Multi Translation (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 Number of Times the shape must be duplicated.