X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2Fdoc%2FrotationFeature.rst;h=c97cd5fa894af400e0c58ea6c75d7a33ba6baaa0;hb=29ae5ac5706b94b3df50136a545649be524fd2a3;hp=592417d0403f562e57476db0c9e1812a17cebb9c;hpb=db1f629785c83f9691b1707b3fd11a26625c7a26;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/doc/rotationFeature.rst b/src/SketchPlugin/doc/rotationFeature.rst index 592417d04..c97cd5fa8 100644 --- a/src/SketchPlugin/doc/rotationFeature.rst +++ b/src/SketchPlugin/doc/rotationFeature.rst @@ -1,63 +1,61 @@ +.. _sketchAngularCopy: +.. |rotate.icon| image:: images/rotate.png Angular copy ============ -Angular copy operation creates one or multiple copies of the skecth entities by rotation relative to a specified center point. +Angular copy operation creates one or multiple copies of the sketch entities by rotation relative to a specified center point. -To create Angular copy in the active Sketch: +To create an Angular copy in the active Sketch: #. select in the Main Menu *Sketch - > Angular copy* item or -#. click **Angular copy** button in Sketch toolbar: - -.. image:: images/rotate.png - :align: center - -.. centered:: - **Angular copy** button +#. click |rotate.icon| **Angular copy** button in Sketch toolbar: Property panel: -.. image:: images/Rotation_panel.png - :align: center +.. figure:: images/Rotation_panel.png + :align: center -.. centered:: Angular copy +.. |full_angle| image:: images/angle_up_full_32x32.png +.. |single_angle| image:: images/angle_up_32x32.png + Input fields: -- **Segments** is the list of segments (lines, circles, arcs) selected in the view. -- **Center of rotation** is the center point selected in the view. +- **Segments** is the list of segments (lines, circles, arcs) selected in the view; +- **Center of rotation** is the center point selected in the view; - **Full angle/Single angle** option: - - .. image:: images/angle_up_full_32x32.png - :align: left - **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one). - - .. image:: images/angle_up_full_32x32.png - :align: left - **Single angle**: angle step of rotation is equal to the defined angle. - + | |full_angle| **Full angle**: angle step of rotation is equal to the defined angle divided by the number of copies (total number minus one). + | |single_angle| **Single angle**: angle step of rotation is equal to the defined angle. - **Angle** is the angle of rotation. -- **Reversed** defines rotation direction. If checked - in clockwise direction, otherwise - in a counterclockwise direction. +- **Reversed** defines rotation direction. If checked - in a clockwise direction, otherwise - in a counterclockwise direction. - **Total number of objects** is the total number of objects including the original one. -**TUI Command**: *Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed)* +**TUI Command**: -**Arguments**: list of objects + center point + angle + number of objects + full value flag + reversed flag +.. py:function:: Sketch_1.addRotation(Objects, CenterPoint, Angle, NumberOfObjects, FullValue, Reversed) + + :param list: A list of objects. + :param object: Center point. + :param real: Angle. + :param integer: Number of objects. + :param boolean: Full value flag. + :param boolean: Reversed flag. + :return: Result object. Result """""" Created Angular copy appears in the view. -| The original and an angular copy objects are marked with the special sign. +| The original and an angular copy objects are marked with a special sign. | Copy objects are drawn with a thinner line. -.. image:: images/Rotation_res.png - :align: center +.. figure:: images/Rotation_res.png + :align: center -.. centered:: - Angular copy created + Created angular copy -**See Also** a sample TUI Script of a :ref:`tui_create_rotation` operation. +**See Also** a sample TUI Script of :ref:`tui_create_rotation` operation.