src/FeaturesPlugin/doc/symmetryFeature.rst

   1 .. |symmetry.icon|    image:: images/symmetry.png
   2
   3 Symmetry
   4 ========
   5
   6 **Symmetry** feature makes a symmetrical copy of the selected shape.
   7
   8 To create a Symmetry in the active part:
   9
  10 #. select in the Main Menu *Part - > Symmetry* item  or
  11 #. click |symmetry.icon| **Symmetry** button in the toolbar
  12
  13 Symmetrical copy of an Object can be mirrored in three different ways:
  14
  15 .. image:: images/symmetry_point_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 through a Point of symmetry
  20
  21 .. image:: images/symmetry_axis_32x32.png
  22    :align: left
  23    :height: 24px
  24
  25 through an Axis of symmetry
  26
  27 .. image:: images/symmetry_plane_32x32.png
  28    :align: left
  29    :height: 24px
  30
  31 through a Plane of symmetry
  32
  33 --------------------------------------------------------------------------------
  34
  35 Symmetry through a Point of symmetry
  36 ------------------------------------
  37
  38 .. image:: images/symmetryPoint.png
  39   :align: center
  40
  41 .. centered::
  42   Symmetry through a Point of symmetry property panel
  43
  44 Input fields:
  45
  46 - **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
  47 - **Point**  defines a point of symmetry selected in 3D OCC viewer or object browser;
  48 - **Create a copy** checkbox preserves/removes the initial object.
  49
  50 **TUI Command**:
  51
  52 .. py:function:: model.addSymmetry(Part_doc, [shape], point, copy)
  53
  54     :param part: The current part object.
  55     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  56     :param object: A point in format *model.selection(TYPE, shape)*.
  57     :param boolean: A flag to create a copy.
  58     :return: Result object.
  59
  60 Result
  61 """"""
  62
  63 The result of operation is a mirrored initial shape with **Create a copy** = *True*.
  64
  65 .. image:: images/symmetryPointres.png
  66    :align: center
  67
  68 .. centered::
  69    Symmetry through a Point of symmetry
  70
  71 **See Also** a sample TUI Script of :ref:`tui_symmetry_point` operation.
  72
  73 Symmetry through an Axis of symmetry
  74 ------------------------------------
  75
  76 .. image:: images/symmetryAxis.png
  77   :align: center
  78
  79 .. centered::
  80   Symmetry through an Axis of symmetry property panel
  81
  82 Input fields:
  83
  84 - **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
  85 - **Axis**  defines an axis of symmetry selected in 3D OCC viewer or object browser;
  86 - **Create a copy** checkbox preserves/removes the initial object.
  87
  88 **TUI Command**:
  89
  90 .. py:function:: model.addSymmetry(Part_doc, [shape], axis, copy)
  91
  92     :param part: The current part object.
  93     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  94     :param object: An axis in format *model.selection(TYPE, shape)*.
  95     :param boolean: A flag to create a copy.
  96     :return: Result object.
  97
  98 Result
  99 """"""
 100
 101 The result of operation is a mirrored initial shape with **Create a copy** = *False*.
 102
 103 .. image:: images/symmetryAxisres.png
 104    :align: center
 105
 106 .. centered::
 107    Symmetry through an Axis of symmetry
 108
 109 **See Also** a sample TUI Script of :ref:`tui_symmetry_axis` operation.
 110
 111 Symmetry through a Plane of symmetry
 112 ------------------------------------
 113
 114 .. image:: images/symmetryPlane.png
 115   :align: center
 116
 117 .. centered::
 118   Symmetry through a Plane of symmetry property panel
 119
 120 Input fields:
 121
 122 - **Main objects** panel contains shapes to be translated. Shapes are selected in 3D OCC viewer or object browser;
 123 - **Plane**  defines a plane of symmetry selected in 3D OCC viewer or object browser;
 124 - **Create a copy** checkbox preserves/removes the initial object.
 125
 126 **TUI Command**:
 127
 128 .. py:function:: model.addSymmetry(Part_doc, [shape], plane, copy)
 129
 130     :param part: The current part object.
 131     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
 132     :param object: A plane in format *model.selection(TYPE, shape)*.
 133     :param boolean: A flag to create a copy.
 134     :return: Result object.
 135
 136 Result
 137 """"""
 138
 139 The result of operation is a mirrored initial shape with **Create a copy** = *False*.
 140
 141 .. image:: images/symmetryPlaneres.png
 142    :align: center
 143
 144 .. centered::
 145    Symmetry through a Plane of symmetry
 146
 147 **See Also** a sample TUI Script of :ref:`tui_symmetry_plane` operation.