ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2024-11-15 18:18:35 +05:00
Code Issues Packages Projects Releases Wiki Activity

Little correction of the documentation for multi-translation and multi-rotation operations

Browse Source
This commit is contained in:
vsr 2012-04-19 06:17:56 +00:00
parent fd244b2bd2
commit 85083a7b82
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/salome/gui/GEOM/input/multi_rotation_operation.doc
View 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 \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 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 <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>TUI Command:</b> <em>geompy.MultiRotate1D(Shape, Axis, NbTimes)</em>
\n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 value \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 value
(repetition). (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 Object around the given \b Axis on the given \b Angle a given
<b>Number of Times</b> and multi-translates each rotation <b>Number of Times</b> and multi-translates each rotation
result. Translation direction passes through the center of gravity of 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. \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>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 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 angle

13
doc/salome/gui/GEOM/input/multi_translation_operation.doc
View 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 \n This operation makes several translations of a shape in \b one or \b
two directions. 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 \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 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 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" \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 \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 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. Vector of translation, a \b Step of translation and a <b>Number of Times</b> the shape must be duplicated.