X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2Fdoc%2FtransformationFeature.rst;h=7df424c4307f42041a033fef5a05459a69db4835;hb=79470833af46e5a11abc700ebd07a26ec3e2d5a0;hp=91629ac5cdca38cdb7e917bf5532d5ce2c864164;hpb=79391e042b19eb85c77fffab6735f8964e3eb7b3;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/doc/transformationFeature.rst b/src/FeaturesPlugin/doc/transformationFeature.rst index 91629ac5c..7df424c43 100644 --- a/src/FeaturesPlugin/doc/transformationFeature.rst +++ b/src/FeaturesPlugin/doc/transformationFeature.rst @@ -1,40 +1,40 @@ +.. |scale.icon| image:: images/scale.png Scale ===== -The feature **Scale** makes a scaled shape basing on the initial shape. +**Scale** feature makes a scaled shape basing on the initial shape. -To create Scale in the active part: +To create a Scale in the active part: #. select in the Main Menu *Features - > Scale* item or -#. click **Scale** button in the toolbar +#. click |scale.icon| **Scale** button in the toolbar -.. image:: images/scale.png - :align: center +Two Scale algorithms are: -.. centered:: - **Scale** button +.. figure:: images/scale_factor_32x32.png + :align: left + :height: 24px -Two Scale algorithms are: +by one common factor + +.. figure:: images/scale_dimensions_32x32.png + :align: left + :height: 24px - .. image:: images/scale_factor_32x32.png - :align: left - by one common factor +by different factors along axes - .. image:: images/scale_dimensions_32x32.png - :align: left - by different factors along axes +-------------------------------------------------------------------------------- Scale by one common factor -------------------------- Scale by one common factor scales the entire object without modification the geometry of the shape: dimensions change evenly in all three orthogonal directions. -.. image:: images/Scale1.png - :align: center +.. figure:: images/Scale1.png + :align: center -.. centered:: - Scale by one common factor property panel + Scale by one common factor property panel Input fields: @@ -42,33 +42,37 @@ Input fields: - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser; - **Scale factor** defines the multiplier of axial dimensions. If Scale Factor is negative, the object is mirrored through the Central Point. -**TUI Command**: *model.addScale(Part_doc, [shape], center, factor)* +**TUI Command**: + +.. py:function:: model.addScale(Part_doc, [shape], center, factor) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + center point in format *model.selection(TYPE, shape)*+ real (scale factor value). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A center point in format *model.selection(TYPE, shape)*. + :param real: Scale factor. + :return: Result object. Result """""" Result of operation is transformed initial shape shown in wireframe mode together with initial shape in shading mode. -.. image:: images/Scale_common_factor.png +.. figure:: images/Scale_common_factor.png :align: center -.. centered:: Scale by one common factor -**See Also** a sample TUI Script of a :ref:`tui_Scale_common_factor` operation. +**See Also** a sample TUI Script of :ref:`tui_Scale_common_factor` operation. Scale by different factors along axes ------------------------------------- Scale by different factors along axes is a general transformation, which can modify the geometry, for example, a sphere can be transformed into an ellipsoid. -.. image:: images/Scale2.png - :align: center +.. figure:: images/Scale2.png + :align: center -.. centered:: - Scale: define by different factors property panel + Scale: define by different factors property panel Input fields: @@ -76,19 +80,24 @@ Input fields: - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser; - **Scale factor in X**, **Scale factor in Y**, **Scale factor in Z** define the the multipliers of axial dimensions. If Scale Factor is negative, the object is mirrored through the Central Point. -**TUI Command**: *model.addScale(Part_doc, [shape], center, factors)* +**TUI Command**: + +.. py:function:: model.addScale(Part_doc, [shape], center, factors) -**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + center point in format *model.selection(TYPE, shape)*+ 3 reals (scale factor values along X. Y, Z axes). + :param part: The current part object. + :param list: A list of shapes in format *model.selection(TYPE, shape)*. + :param object: A center point in format *model.selection(TYPE, shape)*. + :param list: A list of three scale factor values along X. Y, Z axes. + :return: Result object. Result """""" Result of operation is transformed initial shape. -.. image:: images/Scale_XYZ.png +.. figure:: images/Scale_XYZ.png :align: center -.. centered:: Scale by different factors -**See Also** a sample TUI Script of a :ref:`tui_Scale_XYZ` operation. \ No newline at end of file +**See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation.