X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fmulti_rotation_operation.doc;h=33411d6c5533c68566a2b8cbea5963aa329e5012;hb=69b2ec02a2002731ceaf0597fa9f4dd9cd57dc91;hp=7ad469f890ca6cc92ba05669d52c56c5373bee3c;hpb=239f8109c64fa0c5a2e1d87a420bad5529b57f48;p=modules%2Fgeom.git diff --git a/doc/salome/gui/GEOM/input/multi_rotation_operation.doc b/doc/salome/gui/GEOM/input/multi_rotation_operation.doc index 7ad469f89..33411d6c5 100644 --- a/doc/salome/gui/GEOM/input/multi_rotation_operation.doc +++ b/doc/salome/gui/GEOM/input/multi_rotation_operation.doc @@ -5,50 +5,70 @@ \n To produce a Multi Rotation in the Main Menu select Operations - > Transformation - > Multi Rotation -\n This operation creates several geometrical objects rotated in one -or two dimensions basing on the initial geometrical object. -\n The \b Result will be one or several \b GEOM_Objects (compound). - -\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 -\n TUI Command: geompy.MultiRotate1D(Shape, Axis, NbTimes) -\n Arguments: Name + 1 shape + 1 vector for direction + 1 value -(repetition). +\n This operation creates a compound of several rotated shapes basing on the initial shape. + + +In case of Simple Multi Rotation the object is multiplied by rotation. + +\image html neo-mrot1.png + +The following parameters and options can be defined in this dialog: +- Result Name; +- Main Object to be rotated; +- \b Vector defines the axis of rotation (DZ by default); +- Angular step is the angle by which the object is rotated. By default +(if the checkbox is not checked), it is 2 * \a PI / \a NbTimes; +- Nb. Times is the number of rotated shape copies in the resulting compound. If \a NbTimes = 1, the result contains only the +initial shape; +- \ref restore_presentation_parameters_page "Advanced options". + +\n The \b Result will be a \b GEOM_Object (compound). + +\n TUI Commands: +\n geompy.MultiRotate1DNbTimes(Shape, Axis, NbTimes) +\n geompy.MultiRotate1DByStep(Shape, Axis, AngleStep, NbTimes) \b NB! There is another way to execute a Multi-rotation operation, which is currently accessible only via TUI commands: -geompy.MakeMultiRotation1D(Shape, Dir, Point, NbTimes) which works in -the same way, but the Axis is defined by direction and point. +geompy.MakeMultiRotation1DNbTimes(Shape, Dir, Point, NbTimes), +geompy.MakeMultiRotation1DByStep(Shape, Dir, Point, AngleStep, NbTimes), +which works in the same way, but the Axis is defined by direction and point. -\image html neo-mrot1.png +\image html multi_rotation1d1.png "The initial object" + +\image html multi_rotation1d2.png "The result of a simple multi-rotation" -\image html multi_rotation1d1.png +In case of Double Multi Rotation the object is multiplied by rotation and additionally translated several times in each direction. -\image html multi_rotation1d2.png +\image html neo-mrot2.png + +The following parameters and options can be defined in this dialog: +- Result Name; +- Main Object to be rotated; +- \b Vector defines the axis of rotation (DZ by default); +- Angular step is the angle by which the object is rotated. By default +(if the checkbox is not checked), it is 2 * \a PI / \a NbTimes; +- Nb. Times (\a NbTimes1) is the number of rotated shape copies in the resulting compound; +- \b Reverse checkbox allows changing the direction of translation; +- Radial step is the distance between the shape copies in the same direction. Translation direction passes through the center of gravity of the +initial shape and its projection on the rotation axis; +- Nb. Times (\a NbTimes2) is the number of shape copies in the same direction. If \a NbTimes2 = 1, the result is the same as for Simple Multi Rotation. If both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain only the initial non-transformed shape; +- \ref restore_presentation_parameters_page "Advanced options". -\n Double Multi Rotation (in two dimensions) rotates the given -\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. -\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 -+ 1 value (repetition) + 1 step value + 1 value (repetition). +\n TUI Commands: +\n geompy.MultiRotate2DNbTimes(Shape, Axis, NbTimes1, RadialStep, NbTimes2) +\n geompy.MultiRotate2DByStep(Shape, Axis, AngleStep, NbTimes1, RadialStep, NbTimes2) NB! There is another way to execute a Double Multi-rotation operation, which is currently accessible only via TUI commands: -geompy.MakeMultiRotation2D(Shape, Dir, Point, Angle, nbtimes1, Step,nbtimes2) -which works in the same way, -but the Axis is defined by direction and point. +geompy.MakeMultiRotation2DNbTimes(Shape, Dir, Point, NbTimes1, RadialStep, NbTimes2), +geompy.MakeMultiRotation2DByStep(Shape, Dir, Point, AngleStep, NbTimes1, RadialStep, NbTimes2), +which works in the same way, but the Axis is defined by direction and point. -\image html neo-mrot2.png -\image html multi_rotation2d1.png +\image html multi_rotation2d1.png "The initial object" -\image html multi_rotation2d2.png +\image html multi_rotation2d2.png "The result of a double multi-rotation" Our TUI Scripts provide you with useful examples of the use of \ref tui_multi_rotation "Transformation Operations".