src/FeaturesPlugin/doc/transformationFeature.rst

   1 .. |scale.icon|    image:: images/scale.png
   2
   3 Scale
   4 =====
   5
   6 **Scale** feature makes a scaled shape basing on the initial shape.
   7
   8 To create a Scale in the active part:
   9
  10 #. select in the Main Menu *Features - > Scale* item  or
  11 #. click |scale.icon| **Scale** button in the toolbar
  12
  13 Two Scale algorithms are:
  14
  15 .. figure:: images/scale_factor_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 by one common factor
  20
  21 .. figure:: images/scale_dimensions_32x32.png
  22    :align: left
  23    :height: 24px
  24
  25 by different factors along axes
  26
  27 --------------------------------------------------------------------------------
  28
  29 Scale by one common factor
  30 --------------------------
  31
  32 Scale by one common factor scales the entire object without modification the geometry of the shape: dimensions change evenly in all three orthogonal directions.
  33
  34 .. figure:: images/Scale1.png
  35    :align: center
  36
  37    Scale by one common factor property panel
  38
  39 Input fields:
  40
  41 - **Main objects** panel contains shapes to be scaled. Shapes are selected in 3D OCC viewer or object browser;
  42 - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser;
  43 - **Scale factor** defines the multiplier of axial dimensions. If Scale Factor is negative, the object is mirrored through the Central Point.
  44
  45 **TUI Command**:
  46
  47 .. py:function:: model.addScale(Part_doc, [shape], center, factor)
  48
  49     :param part: The current part object.
  50     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  51     :param object: A center point in format *model.selection(TYPE, shape)*.
  52     :param real: Scale factor.
  53     :return: Result object.
  54
  55 Result
  56 """"""
  57
  58 Result of operation is transformed initial shape shown in wireframe mode together  with initial shape in shading mode.
  59
  60 .. figure:: images/Scale_common_factor.png
  61    :align: center
  62
  63    Scale by one common factor
  64
  65 **See Also** a sample TUI Script of :ref:`tui_Scale_common_factor` operation.
  66
  67 Scale by different factors along axes
  68 -------------------------------------
  69
  70 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.
  71
  72 .. figure:: images/Scale2.png
  73    :align: center
  74
  75    Scale: define by different factors property panel
  76
  77 Input fields:
  78
  79 - **Main objects** panel contains shapes to be scaled. Shapes are selected in 3D OCC viewer or object browser;
  80 - **Center point** defines the point relatively to which the object is scaled. Point is selected in 3D OCC viewer or object browser;
  81 - **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.
  82
  83 **TUI Command**:
  84
  85 .. py:function:: model.addScale(Part_doc, [shape], center, factors)
  86
  87     :param part: The current part object.
  88     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  89     :param object: A center point in format *model.selection(TYPE, shape)*.
  90     :param list: A list of three scale factor values along X. Y, Z axes.
  91     :return: Result object.
  92
  93 Result
  94 """"""
  95
  96 Result of operation is transformed initial shape.
  97
  98 .. figure:: images/Scale_XYZ.png
  99    :align: center
 100
 101    Scale by different factors
 102
 103 **See Also** a sample TUI Script of :ref:`tui_Scale_XYZ` operation.